Merge pull request #23 from bilfeldt/features/correlation-id-middleware

Add CorrelationIdMiddleware

Author: bilfeldt

CHANGELOG.md

@@ -10,6 +10,10 @@ No breaking changes. The only changes are to the development dependencies used f
 
 ## Changes
 
+### 2.2.0 - 2023-08-29
+
+- Add middleware for adding 'Correlation-ID' header to responses
+
 ### 2.1.0 - 2023-07-24
 
 - Add support for PHP 8.1

src/Middleware/CorrelationIdMiddleware.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Bilfeldt\RequestLogger\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+
+class CorrelationIdMiddleware
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        $correlationId = $this->getCorrelationId($request);
+
+        $request->headers->set('Correlation-ID', $correlationId, true);
+
+        $response = $next($request);
+
+        $response->headers->set('Correlation-ID', $correlationId, true); // This is available on all Response types whereas $response->header() is only available in \Illuminate\Http\Response
+
+        return $response;
+    }
+
+    private function getCorrelationId(Request $request): string
+    {
+        return $request->getUniqueId();
+    }
+}

src/Middleware/LogRequestMiddleware.php

@@ -30,7 +30,7 @@ public function handle(Request $request, Closure $next, string ...$drivers)
         $response = $next($request);
 
         if ($header = config('request-logger.header')) {
-            $response->headers->set($header, $requestId, true); // This is available on all Response types whereas $request->header() is only available in \Illuminate\Http\Response
+            $response->headers->set($header, $requestId, true); // This is available on all Response types whereas $response->header() is only available in \Illuminate\Http\Response
         }
 
         return $response;

tests/Unit/CorrelationIdMiddlewareTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Bilfeldt\RequestLogger\Tests\Unit;
+
+use Bilfeldt\RequestLogger\Middleware\CorrelationIdMiddleware;
+use Bilfeldt\RequestLogger\Tests\TestCase;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+
+class CorrelationIdMiddlewareTest extends TestCase
+{
+    public function test_adds_request_header(): void
+    {
+        $request = new Request();
+
+        (new CorrelationIdMiddleware())->handle($request, function ($request) {
+            $this->assertTrue($request->headers->has('Correlation-ID'));
+            $this->assertEquals($request->getUniqueId(), $request->header('Correlation-ID'));
+
+            return new Response();
+        });
+    }
+
+    public function test_adds_response_header(): void
+    {
+        $request = new Request();
+
+        $response = (new CorrelationIdMiddleware())->handle($request, function ($request) {
+            return new Response();
+        });
+
+        $this->assertTrue($response->headers->has('Correlation-ID'));
+        $this->assertEquals($request->getUniqueId(), $request->header('Correlation-ID'));
+    }
+}