feature #33271 Added new ErrorController + Preview and enabling there the error renderer mechanism (yceruto)

This PR was merged into the 4.4 branch.

Discussion
----------

Added new ErrorController + Preview and enabling there the error renderer mechanism

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes (deps=high failure is normal)
| Fixed tickets | -
| License       | MIT
| Doc PR        | TODO

After deprecating the `ExceptionController` in TwigBundle (refs symfony/symfony#31398) the `twig.exception_controller` config key becomes useless as feature provided by TwigBundle, while the preview controller is taking more relevance for the error renderer mechanish.

**Proposal**
 * Deprecate the `twig.exception_controller` config key in favor of `framework.error_controller` with default `ErrorController` that activates the error renderer mechanism through the current `ExceptionListener`, meaning also that `DebugHandlersListener::onKernelException` method becomes useless too.
 * Deprecate the `PreviewErrorController` from TwigBundle in favor of similar in FrameworkBundle.

So you no longer need to install TwigBundle to create a custom error controller or check the preview output of an error renderer (included `TwigHtmlErrorRenderer`).

Btw this would fix symfony/symfony#31398 (comment), removing here workaround in SecurityBundle.

TODO:
- [x] Update CHANGELOG & UPGRADE files
- [x] Add tests

WDYT?

Commits
-------

b79532ab0e Add ErrorController to preview and render errors

Author: fabpot

CHANGELOG.md

@@ -14,7 +14,8 @@ CHANGELOG
  * Deprecated `routing.loader.service`, use `routing.loader.container` instead.
  * Not tagging service route loaders with `routing.route_loader` has been deprecated.
  * Overriding the methods `KernelTestCase::tearDown()` and `WebTestCase::tearDown()` without the `void` return-type is deprecated.
- 
+ * Added new `error_controller` configuration to handle system exceptions
+
 4.3.0
 -----
 

DependencyInjection/Configuration.php

@@ -28,7 +28,6 @@
 use Symfony\Component\Mailer\Mailer;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
-use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Translation\Translator;
 use Symfony\Component\Validator\Validation;
@@ -84,6 +83,9 @@ public function getConfigTreeBuilder()
                     ->beforeNormalization()->ifString()->then(function ($v) { return [$v]; })->end()
                     ->prototype('scalar')->end()
                 ->end()
+                ->scalarNode('error_controller')
+                    ->defaultValue('error_controller')
+                ->end()
             ->end()
         ;
 

DependencyInjection/FrameworkExtension.php

@@ -212,6 +212,7 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('kernel.http_method_override', $config['http_method_override']);
         $container->setParameter('kernel.trusted_hosts', $config['trusted_hosts']);
         $container->setParameter('kernel.default_locale', $config['default_locale']);
+        $container->setParameter('kernel.error_controller', $config['error_controller']);
 
         if (!$container->hasParameter('debug.file_link_format')) {
             if (!$container->hasParameter('templating.helper.code.file_link_format')) {

Resources/config/debug_prod.xml

@@ -21,8 +21,6 @@
             <argument>%kernel.debug%</argument>
             <argument type="service" id="debug.file_link_formatter" />
             <argument>%kernel.debug%</argument>
-            <argument>%kernel.charset%</argument>
-            <argument type="service" id="error_renderer" on-invalid="null" />
         </service>
 
         <service id="debug.file_link_formatter" class="Symfony\Component\HttpKernel\Debug\FileLinkFormatter">

Resources/config/routing/errors.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<routes xmlns="http://symfony.com/schema/routing"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/routing https://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <route id="_preview_error" path="/{code}.{_format}">
+        <default key="_controller">error_controller::preview</default>
+        <default key="_format">html</default>
+        <requirement key="code">\d+</requirement>
+    </route>
+</routes>

Resources/config/schema/symfony-1.0.xsd

@@ -41,6 +41,7 @@
         <xsd:attribute name="secret" type="xsd:string" />
         <xsd:attribute name="default-locale" type="xsd:string" />
         <xsd:attribute name="test" type="xsd:boolean" />
+        <xsd:attribute name="error-controller" type="xsd:string" />
     </xsd:complexType>
 
     <xsd:complexType name="form">

Resources/config/web.xml

@@ -88,5 +88,19 @@
         <service id="disallow_search_engine_index_response_listener" class="Symfony\Component\HttpKernel\EventListener\DisallowRobotsIndexingListener">
             <tag name="kernel.event_subscriber" />
         </service>
+
+        <service id="error_controller" class="Symfony\Component\HttpKernel\Controller\ErrorController" public="true">
+            <argument type="service" id="http_kernel" />
+            <argument>%kernel.error_controller%</argument>
+            <argument type="service" id="error_renderer" />
+        </service>
+
+        <service id="exception_listener" class="Symfony\Component\HttpKernel\EventListener\ExceptionListener">
+            <tag name="kernel.event_subscriber" />
+            <tag name="monolog.logger" channel="request" />
+            <argument>%kernel.error_controller%</argument>
+            <argument type="service" id="logger" on-invalid="null" />
+            <argument>%kernel.debug%</argument>
+        </service>
     </services>
 </container>

Tests/Command/CacheClearCommand/Fixture/TestAppKernel.php

@@ -38,7 +38,7 @@ public function registerContainerConfiguration(LoaderInterface $loader)
 
     public function setAnnotatedClassCache(array $annotatedClasses)
     {
-        $annotatedClasses = array_diff($annotatedClasses, ['Symfony\Bundle\WebProfilerBundle\Controller\ExceptionController', 'Symfony\Bundle\TwigBundle\Controller\ExceptionController']);
+        $annotatedClasses = array_diff($annotatedClasses, ['Symfony\Bundle\WebProfilerBundle\Controller\ExceptionController', 'Symfony\Bundle\TwigBundle\Controller\ExceptionController', 'Symfony\Bundle\TwigBundle\Controller\PreviewErrorController']);
 
         parent::setAnnotatedClassCache($annotatedClasses);
     }

Tests/DependencyInjection/ConfigurationTest.php

@@ -373,6 +373,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'transports' => [],
                 'enabled' => !class_exists(FullStack::class) && class_exists(Mailer::class),
             ],
+            'error_controller' => 'error_controller',
         ];
     }
 }

Tests/Functional/app/BundlePaths/config.yml

@@ -8,4 +8,4 @@ framework:
 
 twig:
     strict_variables: '%kernel.debug%'
-    exception_controller: ~
+    exception_controller: null # to be removed in 5.0