Add deprecation warning to show HttpKernel::handle() will catch throwables

Author: Nyholm

CHANGELOG.md

@@ -7,6 +7,7 @@ CHANGELOG
 * Deprecate the `Symfony\Component\Serializer\Normalizer\ObjectNormalizer` and
   `Symfony\Component\Serializer\Normalizer\PropertyNormalizer` autowiring aliases, type-hint against
   `Symfony\Component\Serializer\Normalizer\NormalizerInterface` or implement `NormalizerAwareInterface` instead
+ * Add option `framework.catch_all_throwables` to allow `Symfony\Component\HttpKernel\HttpKernel` to catch all kinds of `Throwable`
 
 6.1
 ---

DependencyInjection/Configuration.php

@@ -133,6 +133,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('error_controller')
                     ->defaultValue('error_controller')
                 ->end()
+                ->booleanNode('catch_all_throwables')->defaultFalse()->info('HttpKernel will catch all kinds of \Throwable')->end()
             ->end()
         ;
 

DependencyInjection/FrameworkExtension.php

@@ -320,6 +320,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->getDefinition('locale_listener')->replaceArgument(3, $config['set_locale_from_accept_language']);
         $container->getDefinition('response_listener')->replaceArgument(1, $config['set_content_language_from_locale']);
+        $container->getDefinition('http_kernel')->replaceArgument(4, $config['catch_all_throwables']);
 
         // If the slugger is used but the String component is not available, we should throw an error
         if (!ContainerBuilder::willBeAvailable('symfony/string', SluggerInterface::class, ['symfony/framework-bundle'])) {

Resources/config/services.php

@@ -85,6 +85,7 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
                 service('controller_resolver'),
                 service('request_stack'),
                 service('argument_resolver'),
+                false,
             ])
             ->tag('container.hot_path')
             ->tag('container.preload', ['class' => HttpKernelRunner::class])

Test/ExceptionSubscriber.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Test;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * This event subscriber allows you to inspect all exceptions thrown by the application.
+ * This is useful since the HttpKernel catches all throwables and turns them into
+ * an HTTP response.
+ *
+ * This class should only be used in tests.
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class ExceptionSubscriber implements EventSubscriberInterface
+{
+    /**
+     * @var list<\Throwable>
+     */
+    private static array $exceptions = [];
+
+    public function onKernelException(ExceptionEvent $event)
+    {
+        self::$exceptions[] = $event->getThrowable();
+    }
+
+    /**
+     * @return list<\Throwable>
+     */
+    public static function shiftAll(): array
+    {
+        $exceptions = self::$exceptions;
+        self::$exceptions = [];
+
+        return $exceptions;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::EXCEPTION => 'onKernelException',
+        ];
+    }
+}

Tests/DependencyInjection/ConfigurationTest.php

@@ -656,6 +656,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'sanitizers' => [],
             ],
             'exceptions' => [],
+            'catch_all_throwables' => false,
         ];
     }
 }

Tests/Functional/UidTest.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
 
+use Symfony\Bundle\FrameworkBundle\Test\ExceptionSubscriber;
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\UidController;
 use Symfony\Component\Uid\Ulid;
 use Symfony\Component\Uid\UuidV1;
@@ -31,12 +32,16 @@ protected function setUp(): void
 
     public function testArgumentValueResolverDisabled()
     {
-        $this->expectException(\TypeError::class);
-        $this->expectExceptionMessage('Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\UidController::anyFormat(): Argument #1 ($userId) must be of type Symfony\Component\Uid\UuidV1, string given');
-
         $client = $this->createClient(['test_case' => 'Uid', 'root_config' => 'config_disabled.yml']);
 
         $client->request('GET', '/1/uuid-v1/'.new UuidV1());
+        $this->assertSame(500, $client->getResponse()->getStatusCode());
+        $exceptions = ExceptionSubscriber::shiftAll();
+        $this->assertCount(1, $exceptions);
+        $exception = reset($exceptions);
+
+        $this->assertInstanceOf(\TypeError::class, $exception);
+        $this->assertStringContainsString('Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\UidController::anyFormat(): Argument #1 ($userId) must be of type Symfony\Component\Uid\UuidV1, string given', $exception->getMessage());
     }
 
     public function testArgumentValueResolverEnabled()

Tests/Functional/app/Uid/config_disabled.yml

@@ -5,3 +5,8 @@ framework:
     http_method_override: false
     uid:
         enabled: false
+
+services:
+    Symfony\Bundle\FrameworkBundle\Test\ExceptionSubscriber:
+        tags:
+            - { name: kernel.event_subscriber }

Tests/Functional/app/config/framework.yml

@@ -11,6 +11,7 @@ framework:
     enabled_locales: ['en', 'fr']
     session:
         storage_factory_id: session.storage.factory.mock_file
+    catch_all_throwables: true
 
 services:
     logger: { class: Psr\Log\NullLogger }

Tests/Kernel/ConcreteMicroKernel.php

@@ -86,6 +86,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             'http_method_override' => false,
             'secret' => '$ecret',
             'router' => ['utf8' => true],
+            'catch_all_throwables' => true,
         ]);
 
         $c->setParameter('halloween', 'Have a great day!');