feature #49275 [FrameworkBundle][HttpKernel] Configure ErrorHandler on boot (HypeMC)

This PR was merged into the 6.3 branch.

Discussion
----------

[FrameworkBundle][HttpKernel] Configure `ErrorHandler` on boot

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        | -

Currently the `ErrorHandler` is somewhat configured in `FrameworkBundle::boot()` and then later fully in `DebugHandlersListener::configure()`.

https://github.com/symfony/symfony/blob/3e79a276ecdad009bd36b85c7c8745f5bc2b525a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php#L92-L96
https://github.com/symfony/symfony/blob/3e79a276ecdad009bd36b85c7c8745f5bc2b525a/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php#L70-L144

However, I've noticed that there are some edge case when the handler doesn't get configured in time/at all.

One such example is when using the Sentry bundle. The bundle has its own error handler which gets registered when the [Sentry client is instantiated](https://github.com/getsentry/sentry-php/blob/6402930e7fde5198a07fb126786d1ed6c3fbe281/src/Client.php#L105). If you're using [Sentry with Monolog](https://docs.sentry.io/platforms/php/guides/symfony/#monolog-integration) the client gets instantiated when a Monolog logger is used. Since the `http_kernel` service requires a logger, the client gets instantiated before the `kernel.request` event and, as a result, when the `DebugHandlersListener` is trigger both `$handler` and `$this->earlyHandler` are `null` and the error handler is never configured properly.

Another example when the handler is not configured in time is when an error occurs in a `kernel.request` listener that has a higher priority then the `DebugHandlersListener`. In such cases the error handler's loggers are not yet configured and the errors are not logged properly.

These cases were tested with `APP_DEBUG=0` since the error handler is registered [earlier when debug is enabled](https://github.com/symfony/symfony/blob/3e79a276ecdad009bd36b85c7c8745f5bc2b525a/src/Symfony/Component/Runtime/GenericRuntime.php#L71-L81).

The idea of this PR is to configure the error handler as early as possible to prevent such edge cases from ever being able to happen. The error handler is now fully configured in `FrameworkBundle::boot()`.

Commits
-------

26e6a56694 [FrameworkBundle][HttpKernel] Configure ErrorHandler on boot

Author: nicolas-grekas

CHANGELOG.md

@@ -13,6 +13,7 @@ CHANGELOG
  * Deprecate the `notifier.logger_notification_listener` service, use the `notifier.notification_logger_listener` service instead
  * Allow setting private services with the test container
  * Register alias for argument for workflow services with workflow name only
+ * Configure the `ErrorHandler` on `FrameworkBundle::boot()`
 
 6.2
 ---

DependencyInjection/FrameworkExtension.php

@@ -1095,12 +1095,12 @@ private function registerDebugConfiguration(array $config, ContainerBuilder $con
             $loader->load('debug.php');
         }
 
-        $definition = $container->findDefinition('debug.debug_handlers_listener');
+        $definition = $container->findDefinition('debug.error_handler_configurator');
 
         if (false === $config['log']) {
-            $definition->replaceArgument(1, null);
+            $definition->replaceArgument(0, null);
         } elseif (true !== $config['log']) {
-            $definition->replaceArgument(2, $config['log']);
+            $definition->replaceArgument(1, $config['log']);
         }
 
         if (!$config['throw']) {

FrameworkBundle.php

@@ -94,7 +94,8 @@ class FrameworkBundle extends Bundle
      */
     public function boot()
     {
-        ErrorHandler::register(null, false)->throwAt($this->container->getParameter('debug.error_handler.throw_at'), true);
+        $handler = ErrorHandler::register(null, false);
+        $this->container->get('debug.error_handler_configurator')->configure($handler);
 
         if ($this->container->getParameter('kernel.http_method_override')) {
             Request::enableHttpMethodParameterOverride();

Resources/config/debug_prod.php

@@ -11,26 +11,29 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Symfony\Component\HttpKernel\Debug\ErrorHandlerConfigurator;
 use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Symfony\Component\HttpKernel\EventListener\DebugHandlersListener;
 
 return static function (ContainerConfigurator $container) {
     $container->parameters()->set('debug.error_handler.throw_at', -1);
 
     $container->services()
-        ->set('debug.debug_handlers_listener', DebugHandlersListener::class)
+        ->set('debug.error_handler_configurator', ErrorHandlerConfigurator::class)
+            ->public()
             ->args([
-                null, // Exception handler
                 service('monolog.logger.php')->nullOnInvalid(),
                 null, // Log levels map for enabled error levels
                 param('debug.error_handler.throw_at'),
                 param('kernel.debug'),
                 param('kernel.debug'),
                 service('monolog.logger.deprecation')->nullOnInvalid(),
             ])
-            ->tag('kernel.event_subscriber')
             ->tag('monolog.logger', ['channel' => 'php'])
 
+        ->set('debug.debug_handlers_listener', DebugHandlersListener::class)
+            ->tag('kernel.event_subscriber')
+
         ->set('debug.file_link_formatter', FileLinkFormatter::class)
             ->args([param('debug.file_link_format')])
 

Tests/DependencyInjection/FrameworkExtensionTestCase.php

@@ -541,41 +541,41 @@ public function testEnabledPhpErrorsConfig()
     {
         $container = $this->createContainerFromFile('php_errors_enabled');
 
-        $definition = $container->getDefinition('debug.debug_handlers_listener');
-        $this->assertEquals(new Reference('monolog.logger.php', ContainerInterface::NULL_ON_INVALID_REFERENCE), $definition->getArgument(1));
-        $this->assertNull($definition->getArgument(2));
+        $definition = $container->getDefinition('debug.error_handler_configurator');
+        $this->assertEquals(new Reference('monolog.logger.php', ContainerInterface::NULL_ON_INVALID_REFERENCE), $definition->getArgument(0));
+        $this->assertNull($definition->getArgument(1));
         $this->assertSame(-1, $container->getParameter('debug.error_handler.throw_at'));
     }
 
     public function testDisabledPhpErrorsConfig()
     {
         $container = $this->createContainerFromFile('php_errors_disabled');
 
-        $definition = $container->getDefinition('debug.debug_handlers_listener');
+        $definition = $container->getDefinition('debug.error_handler_configurator');
+        $this->assertNull($definition->getArgument(0));
         $this->assertNull($definition->getArgument(1));
-        $this->assertNull($definition->getArgument(2));
         $this->assertSame(0, $container->getParameter('debug.error_handler.throw_at'));
     }
 
     public function testPhpErrorsWithLogLevel()
     {
         $container = $this->createContainerFromFile('php_errors_log_level');
 
-        $definition = $container->getDefinition('debug.debug_handlers_listener');
-        $this->assertEquals(new Reference('monolog.logger.php', ContainerInterface::NULL_ON_INVALID_REFERENCE), $definition->getArgument(1));
-        $this->assertSame(8, $definition->getArgument(2));
+        $definition = $container->getDefinition('debug.error_handler_configurator');
+        $this->assertEquals(new Reference('monolog.logger.php', ContainerInterface::NULL_ON_INVALID_REFERENCE), $definition->getArgument(0));
+        $this->assertSame(8, $definition->getArgument(1));
     }
 
     public function testPhpErrorsWithLogLevels()
     {
         $container = $this->createContainerFromFile('php_errors_log_levels');
 
-        $definition = $container->getDefinition('debug.debug_handlers_listener');
-        $this->assertEquals(new Reference('monolog.logger.php', ContainerInterface::NULL_ON_INVALID_REFERENCE), $definition->getArgument(1));
+        $definition = $container->getDefinition('debug.error_handler_configurator');
+        $this->assertEquals(new Reference('monolog.logger.php', ContainerInterface::NULL_ON_INVALID_REFERENCE), $definition->getArgument(0));
         $this->assertSame([
             \E_NOTICE => \Psr\Log\LogLevel::ERROR,
             \E_WARNING => \Psr\Log\LogLevel::ERROR,
-        ], $definition->getArgument(2));
+        ], $definition->getArgument(1));
     }
 
     public function testExceptionsConfig()

composer.json

@@ -26,7 +26,7 @@
         "symfony/error-handler": "^6.1",
         "symfony/event-dispatcher": "^5.4|^6.0",
         "symfony/http-foundation": "^6.2",
-        "symfony/http-kernel": "^6.2.1",
+        "symfony/http-kernel": "^6.3",
         "symfony/polyfill-mbstring": "~1.0",
         "symfony/filesystem": "^5.4|^6.0",
         "symfony/finder": "^5.4|^6.0",