[HttpKernel] Fix missing Request in RequestStack for StreamedResponse

Ismail Turan · Ismail Turan · commit ecad2c4f746a · 2023-07-28T09:51:45.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/StreamedResponse.php b/src/Symfony/Component/HttpFoundation/StreamedResponse.php
@@ -56,11 +56,17 @@ public function setCallback(callable $callback): static
         return $this;
     }
 
+    /**
+     * Decorates the PHP callback associated with this Response.
+     */
+    public function getCallback(): callable
+    {
+        return $this->callback;
+    }
+
     /**
      * This method only sends the headers once.
      *
-     * @param null|positive-int $statusCode The status code to use, override the statusCode property if set and not null
-     *
      * @return $this
      */
     public function sendHeaders(/* int $statusCode = null */): static
diff --git a/src/Symfony/Component/HttpKernel/HttpKernel.php b/src/Symfony/Component/HttpKernel/HttpKernel.php
@@ -15,6 +15,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
@@ -70,8 +71,12 @@ public function handle(Request $request, int $type = HttpKernelInterface::MAIN_R
         $request->headers->set('X-Php-Ob-Level', (string) ob_get_level());
 
         $this->requestStack->push($request);
+        $response = null;
         try {
-            return $this->handleRaw($request, $type);
+            $response = $this->handleRaw($request, $type);
+            $response = $this->decorateWhenStreamedResponse($response);
+
+            return $response;
         } catch (\Throwable $e) {
             if ($e instanceof \Error && !$this->handleAllThrowables) {
                 throw $e;
@@ -88,7 +93,9 @@ public function handle(Request $request, int $type = HttpKernelInterface::MAIN_R
 
             return $this->handleThrowable($e, $request, $type);
         } finally {
-            $this->requestStack->pop();
+            if (!$response instanceof StreamedResponse) {
+                $this->requestStack->pop();
+            }
         }
     }
 
@@ -257,6 +264,22 @@ private function handleThrowable(\Throwable $e, Request $request, int $type): Re
         }
     }
 
+    private function decorateWhenStreamedResponse(Response $response): Response
+    {
+        if ($response instanceof StreamedResponse) {
+            $streamedResponseCallback = $response->getCallback();
+            $response->setCallback(function () use ($streamedResponseCallback) {
+                try {
+                    $streamedResponseCallback();
+                } finally {
+                    $this->requestStack->pop();
+                }
+            });
+        }
+
+        return $response;
+    }
+
     /**
      * Returns a human-readable string for the specified variable.
      */
diff --git a/src/Symfony/Component/HttpKernel/Tests/HttpKernelTest.php b/src/Symfony/Component/HttpKernel/Tests/HttpKernelTest.php
@@ -18,6 +18,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
@@ -457,6 +458,34 @@ public function testVerifyRequestStackPushPopDuringHandle()
         $kernel->handle($request, HttpKernelInterface::MAIN_REQUEST);
     }
 
+    public function testVerifyRequestStackPushPopCallOrderDuringHandle()
+    {
+        $request = new Request();
+        $stack = new RequestStack();
+        $dispatcher = new EventDispatcher();
+        $kernel = $this->getHttpKernel($dispatcher, null, $stack);
+
+        $response = $kernel->handle($request, HttpKernelInterface::MAIN_REQUEST);
+        self::assertNull($stack->getMainRequest());
+        $response->send();
+        self::assertNull($stack->getMainRequest());
+    }
+
+    public function testVerifyRequestStackPushPopWithStreamedResponse()
+    {
+        $request = new Request();
+        $stack = new RequestStack();
+        $dispatcher = new EventDispatcher();
+        $kernel = $this->getHttpKernel($dispatcher, [new TestController(), 'streamedResponseController'], $stack);
+
+        $response = $kernel->handle($request, HttpKernelInterface::MAIN_REQUEST);
+        self::assertNotNull($stack->getMainRequest());
+        ob_start();
+        $response->send();
+        self::assertSame('foo', ob_get_clean());
+        self::assertNull($stack->getMainRequest());
+    }
+
     public function testInconsistentClientIpsOnMainRequests()
     {
         $this->expectException(BadRequestHttpException::class);
@@ -515,6 +544,13 @@ public function controller()
         return new Response('foo');
     }
 
+    public function streamedResponseController()
+    {
+        return new StreamedResponse(function () {
+            echo 'foo';
+        });
+    }
+
     public static function staticController()
     {
         return new Response('foo');
