Adding Trace ID header to request and response in middleware

.github/workflows/tests.yml

@@ -40,8 +40,3 @@ jobs:
 
       - name: Execute the tests
         run: vendor/bin/phpunit --testdox
-
-      - name: 'Qodana Scan'
-        uses: JetBrains/qodana-action@main
-        env:
-            QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

src/Middlewares/TreblleMiddleware.php

@@ -8,6 +8,7 @@
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
+use Illuminate\Support\Str;
 use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
 use Treblle\Exceptions\ConfigurationException;
 use Treblle\Exceptions\TreblleApiException;
@@ -43,7 +44,20 @@ public function handle(Request $request, Closure $next, string $projectId = null
         self::$start = microtime(true);
         self::$project = $projectId;
 
-        return $next($request);
+        if (! $request->headers->has('X-TREBLLE-TRACE-ID')) {
+            $request->headers->add([
+                'X-TREBLLE-TRACE-ID' => $id = Str::uuid(),
+            ]);
+        }
+
+        /** @var SymfonyResponse $response */
+        $response = $next($request);
+
+        $response->headers->add([
+            'X-TREBLLE-TRACE-ID' => $request->headers->get('X-TREBLLE-TRACE-ID'),
+        ]);
+
+        return $response;
     }
 
     /**

tests/Middleware/TreblleMiddlewareTest.php

@@ -11,6 +11,13 @@
 
 final class TreblleMiddlewareTest extends TestCase
 {
+    protected function newMiddleware(): TreblleMiddleware
+    {
+        return app()->make(
+            abstract: TreblleMiddleware::class,
+        );
+    }
+
     /**
      * @test
      * @return void
@@ -20,12 +27,7 @@ public function it_returns_a_response(): void
         $request = new Request();
         $response = new Response();
 
-        /**
-         * @var TreblleMiddleware $middleware
-         */
-        $middleware = app()->make(
-            abstract: TreblleMiddleware::class,
-        );
+        $middleware = $this->newMiddleware();
 
         $middlewareResponse = $middleware->handle(
             request: $request,
@@ -37,4 +39,23 @@ public function it_returns_a_response(): void
             actual: $middlewareResponse,
         );
     }
+
+    /** @test */
+    public function it_adds_trace_id_to_response(): void
+    {
+        $request = new Request();
+        $response = new Response();
+
+        $middleware = $this->newMiddleware();
+
+        $middlewareResponse = $middleware->handle(
+            request: $request,
+            next: fn () => $response,
+        );
+
+        $this->assertArrayHasKey(
+            key: 'x-treblle-trace-id',
+            array: $middlewareResponse->headers->all(),
+        );
+    }
 }