[9.x] Fix Precognition headers for Symfony responses (#44424)

* handle symfony responses for Vary header

* support symfony reponse for precognition header

Author: timacdonald

src/Illuminate/Foundation/Http/Middleware/HandlePrecognitiveRequests.php

@@ -45,7 +45,9 @@ public function handle($request, $next)
         $this->prepareForPrecognition($request);
 
         return tap($next($request), function ($response) use ($request) {
-            $this->appendVaryHeader($request, $response->header('Precognition', 'true'));
+            $response->headers->set('Precognition', 'true');
+
+            $this->appendVaryHeader($request, $response);
         });
     }
 
@@ -72,9 +74,9 @@ protected function prepareForPrecognition($request)
      */
     protected function appendVaryHeader($request, $response)
     {
-        return $response->header('Vary', implode(', ', array_filter([
+        return tap($response, fn () => $response->headers->set('Vary', implode(', ', array_filter([
             $response->headers->get('Vary'),
             'Precognition',
-        ])));
+        ]))));
     }
 }

tests/Integration/Routing/PrecognitionTest.php

@@ -743,6 +743,34 @@ public function testItDoesNotSetLastUrl()
         $response->assertOk();
         $this->assertSame('http://localhost/expected-route-2', session()->previousUrl());
     }
+
+    public function testItAppendsVaryHeaderToSymfonyResponse()
+    {
+        Route::get('test-route', function () {
+            return response()->streamDownload(function () {
+                echo 'foo';
+            }, null, ['Expected' => 'Header']);
+        })->middleware(HandlePrecognitiveRequests::class);
+
+        $response = $this->get('test-route');
+        $response->assertOk();
+        $response->assertHeader('Expected', 'Header');
+    }
+
+    public function testItAppendsPrecognitionHeaderToSymfonyResponse()
+    {
+        Route::get('test-route', function () {
+            //
+        })->middleware([
+            HandlePrecognitiveRequests::class,
+            MiddlewareReturningSymfonyResponse::class,
+        ]);
+
+        $response = $this->get('test-route', ['Precognition' => 'true']);
+        $response->assertOk();
+        $response->assertHeader('Expected', 'Header');
+        $response->assertHeader('Precognition', 'true');
+    }
 }
 
 class PrecognitionTestController
@@ -908,3 +936,13 @@ protected function prepareForPrecognition($request)
         app()->bind(ControllerDispatcherContract::class, fn ($app) => new ControllerDispatcher($app));
     }
 }
+
+class MiddlewareReturningSymfonyResponse
+{
+    public function handle($request, $next)
+    {
+        return response()->streamDownload(function () {
+            //
+        }, null, ['Expected' => 'Header']);
+    }
+}