Merge pull request #5 from bilfeldt/fixes/binary-files

Fix binary file response issue

Author: bilfeldt

src/Middleware/ClientRequestIdMiddleware.php

@@ -13,11 +13,15 @@ class ClientRequestIdMiddleware
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse)  $next
-     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
+     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
+     * @return \Symfony\Component\HttpFoundation\Response
      */
     public function handle(Request $request, Closure $next): Response
     {
-        return $next($request)->header(CorrelationIdServiceProvider::getClientRequestIdHeaderName(), $request->getClientRequestId());
+        $response = $next($request);
+
+        $response->headers->set(CorrelationIdServiceProvider::getClientRequestIdHeaderName(), $request->getClientRequestId());
+
+        return $response;
     }
 }

src/Middleware/CorrelationIdMiddleware.php

@@ -14,16 +14,20 @@ class CorrelationIdMiddleware
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse)  $next
-     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
+     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
+     * @return \Symfony\Component\HttpFoundation\Response
      */
     public function handle(Request $request, Closure $next): Response
     {
         if ($this->shouldOverride($request) || ! $request->hasHeader(CorrelationIdServiceProvider::getCorrelationIdHeaderName())) {
             $request->headers->set(CorrelationIdServiceProvider::getCorrelationIdHeaderName(), $this->generateCorrelationId($request));
         }
 
-        return $next($request)->header(CorrelationIdServiceProvider::getCorrelationIdHeaderName(), $request->getCorrelationId());
+        $response = $next($request);
+
+        $response->headers->set(CorrelationIdServiceProvider::getCorrelationIdHeaderName(), $request->getCorrelationId());
+
+        return $response;
     }
 
     protected function generateCorrelationId(Request $request): string

tests/Feature/ClientRequestIdMiddlewareTest.php

@@ -7,6 +7,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Support\Str;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
 
 class ClientRequestIdMiddlewareTest extends TestCase
 {
@@ -24,4 +25,18 @@ public function test_adds_request_id_to_response_header(): void
         $this->assertTrue($response->headers->has('Request-ID'));
         $this->assertEquals($uuid, $response->headers->get('Request-ID'));
     }
+
+    public function test_works_with_binary_file_response(): void
+    {
+        $uuid = Str::orderedUuid();
+
+        $request = new Request();
+        $request->headers->set('Request-ID', $uuid);
+        $response = (new ClientRequestIdMiddleware())->handle($request, function ($request) {
+            return new BinaryFileResponse(__DIR__.'/../fixtures/dummy.pdf');
+        });
+
+        $this->assertTrue($response->headers->has('Request-ID'));
+        $this->assertEquals($uuid, $response->headers->get('Request-ID'));
+    }
 }

tests/Feature/CorrelationIdMiddlewareTest.php

@@ -7,6 +7,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
 use Illuminate\Support\Str;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
 
 class CorrelationIdMiddlewareTest extends TestCase
 {
@@ -36,4 +37,16 @@ public function test_adds_response_correlation_id_header(): void
         $this->assertTrue($response->headers->has('Correlation-ID'));
         $this->assertEquals($response->headers->get('Correlation-ID'), $request->header('Correlation-ID'));
     }
+
+    public function test_works_with_binary_file_response(): void
+    {
+        $request = new Request();
+
+        $response = (new CorrelationIdMiddleware())->handle($request, function ($request) {
+            return new BinaryFileResponse(__DIR__.'/../fixtures/dummy.pdf');
+        });
+
+        $this->assertTrue($response->headers->has('Correlation-ID'));
+        $this->assertEquals($response->headers->get('Correlation-ID'), $request->header('Correlation-ID'));
+    }
 }