[HttpKernel] Add request attribute _handle_all_throwables to allow HttpKernel to handle thrown Error in addition to Exception

Author: nicolas-grekas

CHANGELOG.md

@@ -4,7 +4,7 @@ CHANGELOG
 6.2
 ---
 
- * Add constructor argument `bool $catchThrowable` to `HttpKernel`
+ * Add constructor argument `bool $handleAllThrowable` to `HttpKernel`
  * Add `ControllerEvent::getAttributes()` to handle attributes on controllers
  * Add `#[Cache]` to describe the default HTTP cache headers on controllers
  * Add `absolute_uri` option to surrogate fragment renderers

HttpKernel.php

@@ -54,18 +54,15 @@ class HttpKernel implements HttpKernelInterface, TerminableInterface
     protected $resolver;
     protected $requestStack;
     private ArgumentResolverInterface $argumentResolver;
-    private bool $catchThrowable;
+    private bool $handleAllThrowables;
 
-    public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, RequestStack $requestStack = null, ArgumentResolverInterface $argumentResolver = null, bool $catchThrowable = false)
+    public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver, RequestStack $requestStack = null, ArgumentResolverInterface $argumentResolver = null, bool $handleAllThrowables = false)
     {
         $this->dispatcher = $dispatcher;
         $this->resolver = $resolver;
         $this->requestStack = $requestStack ?? new RequestStack();
         $this->argumentResolver = $argumentResolver ?? new ArgumentResolver();
-        $this->catchThrowable = $catchThrowable;
-        if (!$catchThrowable) {
-            trigger_deprecation('symfony/http-kernel', '6.2', 'Starting from 7.0, "%s::handle()" will catch \Throwable exceptions and convert them to HttpFoundation responses. Pass $catchThrowable=true to adapt to this behavior now.', self::class);
-        }
+        $this->handleAllThrowables = $handleAllThrowables;
     }
 
     public function handle(Request $request, int $type = HttpKernelInterface::MAIN_REQUEST, bool $catch = true): Response
@@ -76,7 +73,7 @@ public function handle(Request $request, int $type = HttpKernelInterface::MAIN_R
         try {
             return $this->handleRaw($request, $type);
         } catch (\Throwable $e) {
-            if (!$this->catchThrowable && !$e instanceof \Exception) {
+            if ($e instanceof \Error && !$this->handleAllThrowables) {
                 throw $e;
             }
 
@@ -217,8 +214,6 @@ private function finishRequest(Request $request, int $type)
 
     /**
      * Handles a throwable by trying to convert it to a Response.
-     *
-     * @throws \Throwable
      */
     private function handleThrowable(\Throwable $e, Request $request, int $type): Response
     {
@@ -251,7 +246,7 @@ private function handleThrowable(\Throwable $e, Request $request, int $type): Re
         try {
             return $this->filterResponse($response, $request, $type);
         } catch (\Throwable $e) {
-            if (!$this->catchThrowable && !$e instanceof \Exception) {
+            if ($e instanceof \Error && !$this->handleAllThrowables) {
                 throw $e;
             }
 

Tests/DataCollector/RequestDataCollectorTest.php

@@ -396,7 +396,7 @@ protected function createResponse()
     protected function injectController($collector, $controller, $request)
     {
         $resolver = $this->createMock(ControllerResolverInterface::class);
-        $httpKernel = new HttpKernel(new EventDispatcher(), $resolver, null, $this->createMock(ArgumentResolverInterface::class), true);
+        $httpKernel = new HttpKernel(new EventDispatcher(), $resolver, null, $this->createMock(ArgumentResolverInterface::class));
         $event = new ControllerEvent($httpKernel, $controller, $request, HttpKernelInterface::MAIN_REQUEST);
         $collector->onKernelController($event);
     }

Tests/Debug/TraceableEventDispatcherTest.php

@@ -119,6 +119,6 @@ protected function getHttpKernel($dispatcher)
         $argumentResolver = $this->createMock(ArgumentResolverInterface::class);
         $argumentResolver->expects($this->once())->method('getArguments')->willReturn([]);
 
-        return new HttpKernel($dispatcher, $controllerResolver, new RequestStack(), $argumentResolver, true);
+        return new HttpKernel($dispatcher, $controllerResolver, new RequestStack(), $argumentResolver);
     }
 }

Tests/EventListener/RouterListenerTest.php

@@ -173,7 +173,7 @@ public function testWithBadRequest()
             return new Response('Exception handled', 400);
         }));
 
-        $kernel = new HttpKernel($dispatcher, new ControllerResolver(), $requestStack, new ArgumentResolver(), true);
+        $kernel = new HttpKernel($dispatcher, new ControllerResolver(), $requestStack, new ArgumentResolver());
 
         $request = Request::create('http://localhost/');
         $request->headers->set('host', '###');
@@ -195,7 +195,7 @@ public function testNoRoutingConfigurationResponse()
         $dispatcher = new EventDispatcher();
         $dispatcher->addSubscriber(new RouterListener($requestMatcher, $requestStack, new RequestContext()));
 
-        $kernel = new HttpKernel($dispatcher, new ControllerResolver(), $requestStack, new ArgumentResolver(), true);
+        $kernel = new HttpKernel($dispatcher, new ControllerResolver(), $requestStack, new ArgumentResolver());
 
         $request = Request::create('http://localhost/');
         $response = $kernel->handle($request);

Tests/Fragment/InlineFragmentRendererTest.php

@@ -142,7 +142,7 @@ public function testExceptionInSubRequestsDoesNotMangleOutputBuffers()
             ->willReturn([])
         ;
 
-        $kernel = new HttpKernel(new EventDispatcher(), $controllerResolver, new RequestStack(), $argumentResolver, true);
+        $kernel = new HttpKernel(new EventDispatcher(), $controllerResolver, new RequestStack(), $argumentResolver);
         $renderer = new InlineFragmentRenderer($kernel);
 
         // simulate a main request with output buffering

Tests/HttpCache/TestHttpKernel.php

@@ -36,7 +36,7 @@ public function __construct($body, $status, $headers, \Closure $customizer = nul
         $this->headers = $headers;
         $this->customizer = $customizer;
 
-        parent::__construct($eventDispatcher ?? new EventDispatcher(), $this, null, $this, true);
+        parent::__construct($eventDispatcher ?? new EventDispatcher(), $this, null, $this);
     }
 
     public function assert(\Closure $callback)

Tests/HttpCache/TestMultipleHttpKernel.php

@@ -35,7 +35,7 @@ public function __construct($responses)
             $this->headers[] = $response['headers'];
         }
 
-        parent::__construct(new EventDispatcher(), $this, null, $this, true);
+        parent::__construct(new EventDispatcher(), $this, null, $this);
     }
 
     public function getBackendRequest()

Tests/HttpKernelTest.php

@@ -128,7 +128,7 @@ public function testHandleWhenControllerThrowsAThrowableAndCatchIsTrueWithAHandl
             $event->setResponse(new Response($event->getThrowable()->getMessage()));
         });
 
-        $kernel = $this->getHttpKernel($dispatcher, function () { throw new \TypeError('foo'); });
+        $kernel = $this->getHttpKernel($dispatcher, function () { throw new \TypeError('foo'); }, handleAllThrowables: true);
         $response = $kernel->handle(new Request(), HttpKernelInterface::MAIN_REQUEST, true);
 
         $this->assertEquals('500', $response->getStatusCode());
@@ -147,7 +147,7 @@ public function testHandleWhenControllerThrowsAThrowableAndCatchIsFalseWithAHand
             $event->setResponse(new Response($event->getThrowable()->getMessage()));
         });
 
-        $kernel = $this->getHttpKernel($dispatcher, function () { throw new \TypeError('foo'); });
+        $kernel = $this->getHttpKernel($dispatcher, function () { throw new \TypeError('foo'); }, handleAllThrowables: true);
         $this->expectException(\TypeError::class);
         $kernel->handle(new Request(), HttpKernelInterface::MAIN_REQUEST, false);
     }
@@ -156,8 +156,6 @@ public function testHandleWhenControllerThrowsAThrowableAndCatchIsFalseWithAHand
      * Catch exceptions: true
      * Throwable type: TypeError
      * Listener: true.
-     *
-     * @group legacy
      */
     public function testHandleWhenControllerThrowsAThrowableAndCatchIsTrueNotHandlingThrowables()
     {
@@ -178,7 +176,7 @@ public function testHandleWhenControllerThrowsAThrowableAndCatchIsTrueNotHandlin
             ->method('getArguments')
             ->willReturn([]);
 
-        $kernel = new HttpKernel($dispatcher, $controllerResolver, null, $argumentResolver, false);
+        $kernel = new HttpKernel($dispatcher, $controllerResolver, null, $argumentResolver);
 
         $this->expectException(\TypeError::class);
         $kernel->handle(new Request(), HttpKernelInterface::MAIN_REQUEST, true);
@@ -479,7 +477,7 @@ public function testInconsistentClientIpsOnMainRequests()
         Request::setTrustedProxies([], -1);
     }
 
-    private function getHttpKernel(EventDispatcherInterface $eventDispatcher, $controller = null, RequestStack $requestStack = null, array $arguments = [])
+    private function getHttpKernel(EventDispatcherInterface $eventDispatcher, $controller = null, RequestStack $requestStack = null, array $arguments = [], bool $handleAllThrowables = false)
     {
         if (null === $controller) {
             $controller = function () { return new Response('Hello'); };
@@ -497,7 +495,7 @@ private function getHttpKernel(EventDispatcherInterface $eventDispatcher, $contr
             ->method('getArguments')
             ->willReturn($arguments);
 
-        return new HttpKernel($eventDispatcher, $controllerResolver, $requestStack, $argumentResolver, true);
+        return new HttpKernel($eventDispatcher, $controllerResolver, $requestStack, $argumentResolver, $handleAllThrowables);
     }
 
     private function assertResponseEquals(Response $expected, Response $actual)

Tests/TestHttpKernel.php

@@ -22,7 +22,7 @@ class TestHttpKernel extends HttpKernel implements ControllerResolverInterface,
 {
     public function __construct()
     {
-        parent::__construct(new EventDispatcher(), $this, null, $this, true);
+        parent::__construct(new EventDispatcher(), $this, null, $this);
     }
 
     public function getController(Request $request): callable|false