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

HypeMC · 2023-02-07T08:53:20Z

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().

symfony/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

Lines 92 to 96 in 3e79a27

    
           public function boot() 
        
           { 
        
               ErrorHandler::register(null, false)->throwAt($this->container->getParameter('debug.error_handler.throw_at'), true); 
        
               if ($this->container->getParameter('kernel.http_method_override')) {

symfony/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php

Lines 70 to 144 in 3e79a27

    
           public function configure(object $event = null) 
        
           { 
        
               if ($event instanceof ConsoleEvent && !\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) { 
        
                   return; 
        
               } 
        
               if (!$event instanceof KernelEvent ? !$this->firstCall : !$event->isMainRequest()) { 
        
                   return; 
        
               } 
        
               $this->firstCall = $this->hasTerminatedWithException = false; 
        
               $handler = set_exception_handler('is_int'); 
        
               $handler = \is_array($handler) ? $handler[0] : null; 
        
               restore_exception_handler(); 
        
               if (!$handler instanceof ErrorHandler) { 
        
                   $handler = $this->earlyHandler; 
        
               } 
        
               if ($handler instanceof ErrorHandler) { 
        
                   if ($this->logger || $this->deprecationLogger) { 
        
                       $this->setDefaultLoggers($handler); 
        
                       if (\is_array($this->levels)) { 
        
                           $levels = 0; 
        
                           foreach ($this->levels as $type => $log) { 
        
                               $levels |= $type; 
        
                           } 
        
                       } else { 
        
                           $levels = $this->levels; 
        
                       } 
        
                       if ($this->scream) { 
        
                           $handler->screamAt($levels); 
        
                       } 
        
                       if ($this->scope) { 
        
                           $handler->scopeAt($levels & ~\E_USER_DEPRECATED & ~\E_DEPRECATED); 
        
                       } else { 
        
                           $handler->scopeAt(0, true); 
        
                       } 
        
                       $this->logger = $this->deprecationLogger = $this->levels = null; 
        
                   } 
        
                   if (null !== $this->throwAt) { 
        
                       $handler->throwAt($this->throwAt, true); 
        
                   } 
        
               } 
        
               if (!$this->exceptionHandler) { 
        
                   if ($event instanceof KernelEvent) { 
        
                       if (method_exists($kernel = $event->getKernel(), 'terminateWithException')) { 
        
                           $request = $event->getRequest(); 
        
                           $hasRun = &$this->hasTerminatedWithException; 
        
                           $this->exceptionHandler = static function (\Throwable $e) use ($kernel, $request, &$hasRun) { 
        
                               if ($hasRun) { 
        
                                   throw $e; 
        
                               } 
        
                               $hasRun = true; 
        
                               $kernel->terminateWithException($e, $request); 
        
                           }; 
        
                       } 
        
                   } elseif ($event instanceof ConsoleEvent && $app = $event->getCommand()->getApplication()) { 
        
                       $output = $event->getOutput(); 
        
                       if ($output instanceof ConsoleOutputInterface) { 
        
                           $output = $output->getErrorOutput(); 
        
                       } 
        
                       $this->exceptionHandler = static function (\Throwable $e) use ($app, $output) { 
        
                           $app->renderThrowable($e, $output); 
        
                       }; 
        
                   } 
        
               } 
        
               if ($this->exceptionHandler) { 
        
                   if ($handler instanceof ErrorHandler) { 
        
                       $handler->setExceptionHandler($this->exceptionHandler); 
        
                   } 
        
                   $this->exceptionHandler = null; 
        
               } 
        
           }

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. If you're using Sentry with Monolog 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.

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().

nicolas-grekas

LGTM thanks, I just have some minor comments

nicolas-grekas · 2023-02-21T14:36:43Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/debug_prod.php

            ->tag('monolog.logger', ['channel' => 'php'])

+        ->set('debug.debug_handlers_listener', DebugHandlersListener::class)
+            ->args([
+                null, // Exception handler


abstract arg?

As far as I can tell, this is actually never set anywhere, it remains null. Maybe it'd be best to remove it?

yes, let's remove it from this file (but keep the arg in the class just in case)

src/Symfony/Component/HttpKernel/CHANGELOG.md

src/Symfony/Component/HttpKernel/Tests/Debug/ErrorHandlerConfiguratorTest.php

nicolas-grekas · 2023-02-21T15:37:14Z

Thank you @HypeMC.

carsonbot added Status: Needs Review Feature FrameworkBundle HttpKernel labels Feb 7, 2023

carsonbot added this to the 6.3 milestone Feb 7, 2023

HypeMC force-pushed the error-handler-configuration branch from 9ee0a03 to d38ad05 Compare February 7, 2023 09:34

HypeMC force-pushed the error-handler-configuration branch from d38ad05 to aba5dbb Compare February 14, 2023 19:57

nicolas-grekas reviewed Feb 21, 2023

View reviewed changes

HypeMC force-pushed the error-handler-configuration branch from aba5dbb to 21b00ce Compare February 21, 2023 15:27

[FrameworkBundle][HttpKernel] Configure ErrorHandler on boot

26e6a56

HypeMC force-pushed the error-handler-configuration branch from 21b00ce to 26e6a56 Compare February 21, 2023 15:33

nicolas-grekas mentioned this pull request Feb 21, 2023

[FrameworkBundle][HttpKernel] Configure ErrorHandler on boot symfony/symfony-docs#17949

Closed

nicolas-grekas merged commit a736d6a into symfony:6.3 Feb 21, 2023

HypeMC deleted the error-handler-configuration branch February 21, 2023 15:38

jdreesen mentioned this pull request Feb 26, 2023

[Feature]: fully integrate Symfony's ErrorHandler pimcore/pimcore#14331

Merged

fabpot mentioned this pull request May 1, 2023

Release v6.3.0-BETA1 #50199

Merged

MatTheCat mentioned this pull request Oct 9, 2023

[ErrorHandler] Loggers can only be Monolog’s #51910

Closed

HypeMC mentioned this pull request Oct 12, 2023

[FrameworkBundle] Fix merge error with ErrorLoggerCompilerPass #52023

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

HypeMC commented Feb 7, 2023

nicolas-grekas left a comment

nicolas-grekas Feb 21, 2023

HypeMC Feb 21, 2023

nicolas-grekas Feb 21, 2023

HypeMC Feb 21, 2023

nicolas-grekas commented Feb 21, 2023

	public function boot()
	{
	ErrorHandler::register(null, false)->throwAt($this->container->getParameter('debug.error_handler.throw_at'), true);

	if ($this->container->getParameter('kernel.http_method_override')) {

	public function configure(object $event = null)
	{
	if ($event instanceof ConsoleEvent && !\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) {
	return;
	}
	if (!$event instanceof KernelEvent ? !$this->firstCall : !$event->isMainRequest()) {
	return;
	}
	$this->firstCall = $this->hasTerminatedWithException = false;

	$handler = set_exception_handler('is_int');
	$handler = \is_array($handler) ? $handler[0] : null;
	restore_exception_handler();

	if (!$handler instanceof ErrorHandler) {
	$handler = $this->earlyHandler;
	}

	if ($handler instanceof ErrorHandler) {
	if ($this->logger \|\| $this->deprecationLogger) {
	$this->setDefaultLoggers($handler);
	if (\is_array($this->levels)) {
	$levels = 0;
	foreach ($this->levels as $type => $log) {
	$levels \|= $type;
	}
	} else {
	$levels = $this->levels;
	}

	if ($this->scream) {
	$handler->screamAt($levels);
	}
	if ($this->scope) {
	$handler->scopeAt($levels & ~\E_USER_DEPRECATED & ~\E_DEPRECATED);
	} else {
	$handler->scopeAt(0, true);
	}
	$this->logger = $this->deprecationLogger = $this->levels = null;
	}
	if (null !== $this->throwAt) {
	$handler->throwAt($this->throwAt, true);
	}
	}
	if (!$this->exceptionHandler) {
	if ($event instanceof KernelEvent) {
	if (method_exists($kernel = $event->getKernel(), 'terminateWithException')) {
	$request = $event->getRequest();
	$hasRun = &$this->hasTerminatedWithException;
	$this->exceptionHandler = static function (\Throwable $e) use ($kernel, $request, &$hasRun) {
	if ($hasRun) {
	throw $e;
	}

	$hasRun = true;
	$kernel->terminateWithException($e, $request);
	};
	}
	} elseif ($event instanceof ConsoleEvent && $app = $event->getCommand()->getApplication()) {
	$output = $event->getOutput();
	if ($output instanceof ConsoleOutputInterface) {
	$output = $output->getErrorOutput();
	}
	$this->exceptionHandler = static function (\Throwable $e) use ($app, $output) {
	$app->renderThrowable($e, $output);
	};
	}
	}
	if ($this->exceptionHandler) {
	if ($handler instanceof ErrorHandler) {
	$handler->setExceptionHandler($this->exceptionHandler);
	}
	$this->exceptionHandler = null;
	}
	}

[FrameworkBundle][HttpKernel] Configure ErrorHandler on boot #49275

[FrameworkBundle][HttpKernel] Configure ErrorHandler on boot #49275

Conversation

HypeMC commented Feb 7, 2023

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas Feb 21, 2023

Choose a reason for hiding this comment

HypeMC Feb 21, 2023

Choose a reason for hiding this comment

nicolas-grekas Feb 21, 2023

Choose a reason for hiding this comment

HypeMC Feb 21, 2023

Choose a reason for hiding this comment

nicolas-grekas commented Feb 21, 2023

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

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