feat(http): adds support for route in response object for late parsing. (#180)

Author: jcchavezs

src/Zipkin/Instrumentation/Http/Server/DefaultHttpServerParser.php

@@ -17,11 +17,11 @@
 class DefaultHttpServerParser implements HttpServerParser
 {
     /**
-     * spanName returns an appropiate span name based on the request,
+     * spanNameFromRequest returns an appropiate span name based on the request,
      * usually the HTTP method is enough (e.g GET or POST) but ideally
-     * the http.route is desired (e.g. /user/{user_id}).
+     * the verb+route is desired (e.g. GET /user/{user_id}).
      */
-    protected function spanName(Request $request): string
+    protected function spanNameFromRequest(Request $request): string
     {
         return $request->getMethod()
             . ($request->getRoute() === null ? '' : ' ' . $request->getRoute());
@@ -32,16 +32,41 @@ protected function spanName(Request $request): string
      */
     public function request(Request $request, TraceContext $context, SpanCustomizer $span): void
     {
-        $span->setName($this->spanName($request));
+        $span->setName($this->spanNameFromRequest($request));
         $span->tag(Tags\HTTP_METHOD, $request->getMethod());
         $span->tag(Tags\HTTP_PATH, $request->getPath() ?: '/');
     }
 
+    protected function spanName(Request $request): string
+    {
+        return $request->getMethod()
+            . ($request->getRoute() === null ? '' : ' ' . $request->getRoute());
+    }
+
+    /**
+     * spanNameFromResponse returns an appropiate span name based on the response's request,
+     * usually seeking for a better name than the HTTP method (e.g. GET /user/{user_id}).
+     */
+    protected function spanNameFromResponse(Response $response): ?string
+    {
+        if ($response->getRoute() === null || $response->getRequest() === null) {
+            return null;
+        }
+
+        return $response->getRequest()->getMethod() . ' ' . $response->getRoute();
+    }
+
+
     /**
      * {@inhertidoc}
      */
     public function response(Response $response, TraceContext $context, SpanCustomizer $span): void
     {
+        $spanName = $this->spanNameFromResponse($response);
+        if ($spanName !== null) {
+            $span->setName($spanName);
+        }
+
         $statusCode = $response->getStatusCode();
         if ($statusCode < 200 || $statusCode > 299) {
             $span->tag(Tags\HTTP_STATUS_CODE, (string) $statusCode);

src/Zipkin/Instrumentation/Http/Server/Psr15/Response.php

@@ -20,12 +20,19 @@ final class Response extends ServerResponse
      */
     private $request;
 
+    /**
+     * @var string|null
+     */
+    private $route;
+
     public function __construct(
         ResponseInterface $delegate,
-        ?Request $request = null
+        ?Request $request = null,
+        ?string $route = null
     ) {
         $this->delegate = $delegate;
         $this->request = $request;
+        $this->route = $route;
     }
 
     /**
@@ -44,6 +51,14 @@ public function getStatusCode(): int
         return $this->delegate->getStatusCode();
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getRoute(): ?string
+    {
+        return $this->route;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Zipkin/Instrumentation/Http/Server/Response.php

@@ -15,4 +15,13 @@ public function getRequest(): ?Request
     {
         return null;
     }
+
+    /**
+     * getRoute returns the route path, sometimes known by the response time
+     * e.g. /user/{user_id}
+     */
+    public function getRoute(): ?string
+    {
+        return null;
+    }
 }

tests/Unit/Instrumentation/Http/Server/BaseResponseTest.php

@@ -21,7 +21,8 @@ abstract public static function createResponse(
         int $statusCode,
         $headers = [],
         $body = null,
-        ?Request $request = null
+        ?Request $request = null,
+        ?string $route = null
     ): array;
 
     /**
@@ -37,9 +38,10 @@ public function testResponseIsCreatedSuccessfully(?Request $request): void
         /**
          * @var Response $response
          */
-        list($response, $delegateResponse) = static::createResponse(202, [], null, $request);
+        list($response, $delegateResponse, $_, $route) = static::createResponse(202, [], null, $request, "/things");
         $this->assertEquals(202, $response->getStatusCode());
         $this->assertSame($request, $response->getRequest());
         $this->assertSame($delegateResponse, $response->unwrap());
+        $this->assertSame($route, $response->getRoute());
     }
 }

tests/Unit/Instrumentation/Http/Server/Psr15/ResponseTest.php

@@ -20,11 +20,12 @@ public static function createResponse(
         int $statusCode,
         $headers = [],
         $body = null,
-        ?Request $request = null
+        ?Request $request = null,
+        ?string $route = null
     ): array {
         $delegateResponse = new Response($statusCode);
         $response = new Psr18Response($delegateResponse, $request);
-        return [$response, $delegateResponse, $request];
+        return [$response, $delegateResponse, $request, $route];
     }
 
     /**