Merge pull request #81 from jcchavezs/fixes_span_name

fix: fixes the span name by accepting the route on response time.

composer.json

@@ -7,7 +7,7 @@
         "symfony/http-kernel": "^4.4|^5.0",
         "symfony/routing": "^4.4|^5.0",
         "symfony/dependency-injection": "^4.4|^5.0",
-        "openzipkin/zipkin": "2.0.0"
+        "openzipkin/zipkin": "^2.0.1"
     },
     "require-dev": {
         "jcchavezs/httptest": "~0.2",
@@ -39,4 +39,4 @@
         "lint": "./vendor/bin/phpcs --standard=ZEND --standard=PSR2 --ignore=*/vendor/* --ignore=*/tests/E2E/test-app/* ./",
         "fix-lint": "./vendor/bin/phpcbf --standard=ZEND --standard=PSR2 --ignore=*/vendor/* --ignore=*/tests/Integration/test-app/* ./"
     }
-}
+}

src/ZipkinBundle/KernelListener.php

@@ -223,7 +223,7 @@ private function finishSpan(HttpFoundationRequest $request, ?HttpFoundationRespo
         $routePath = $this->routeMapper->mapToPath($request);
         if ($response != null) {
             $this->parser->response(
-                new Response($response, new Request($request, $routePath)),
+                new Response($response, new Request($request), $routePath),
                 $span->getContext(),
                 $request->attributes->get(self::SPAN_CUSTOMIZER_KEY)
             );

src/ZipkinBundle/Response.php

@@ -18,12 +18,19 @@ final class Response extends ServerResponse
      */
     private $request;
 
+    /**
+     * @var string|null
+     */
+    private $route;
+
     public function __construct(
         HttpFoundationResponse $delegate,
-        ?Request $request
+        ?Request $request,
+        string $route = null
     ) {
         $this->delegate = $delegate;
         $this->request = $request;
+        $this->route = $route;
     }
 
     public function getRequest(): ?ServerRequest
@@ -36,6 +43,11 @@ public function getStatusCode(): int
         return $this->delegate->getStatusCode();
     }
 
+    public function getRoute(): ?string
+    {
+        return $this->route;
+    }
+
     public function unwrap(): HttpFoundationResponse
     {
         return $this->delegate;

tests/E2E/Makefile

@@ -13,6 +13,7 @@ run-app: ## Runs symfony app
 
 run-zipkin: ## Runs zipkin server
 	docker run -d -p 9411:9411 openzipkin/zipkin
+	@echo "\nCheck your traces at http://localhost:9411/zipkin/\n"
 
 clean: ## Cleans build
 	rm -rf test-app

tests/E2E/test.sh

@@ -46,6 +46,9 @@ TRACES=$(curl -s $ZIPKIN_SERVER_HOSTPORT/api/v2/traces)
 test $(echo "$TRACES" | jq '.[0] | length') -eq 1
 
 # makes sure the trace does not contain errors
-test $(echo "$TRACES" | jq -c '.[0][0].tags.error') = "null"
+test "$(echo "$TRACES" | jq -c '.[0][0].tags.error')" = "null"
+
+# makes sure the server span has the right name
+test "$(echo "$TRACES" | jq -cr ".[0][0].name")" = "get /_health"
 
 exit $?

tests/Unit/ResponseTest.php

@@ -18,10 +18,11 @@ public static function createResponse(
         int $statusCode,
         $headers = [],
         $body = null,
-        ServerRequest $request = null
+        ServerRequest $request = null,
+        string $route = null
     ): array {
         $delegateResponse = new HttpFoundationResponse($body, $statusCode, $headers);
-        $response = new Response($delegateResponse, $request);
+        $response = new Response($delegateResponse, $request, $route);
         return [$response, $delegateResponse, $request];
     }