[FrameworkBundle] enable ErrorHandler in prod

Author: nicolas-grekas

EventListener/DebugHandlersListener.php

@@ -14,8 +14,14 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Debug\ErrorHandler;
 use Symfony\Component\Debug\ExceptionHandler;
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\KernelEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleEvent;
+use Symfony\Component\Console\Output\ConsoleOutputInterface;
 
 /**
  * Configures errors and exceptions handlers.
@@ -28,6 +34,7 @@ class DebugHandlersListener implements EventSubscriberInterface
     private $logger;
     private $levels;
     private $debug;
+    private $fileLinkFormat;
 
     /**
      * @param callable             $exceptionHandler A handler that will be called on Exception
@@ -45,8 +52,20 @@ public function __construct($exceptionHandler, LoggerInterface $logger = null, $
         $this->fileLinkFormat = $fileLinkFormat ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
     }
 
-    public function configure()
+    /**
+     * Configures the error handler.
+     *
+     * @param Event|null                    $event           The triggering event
+     * @param string|null                   $eventName       The triggering event name
+     * @param EventDispatcherInterface|null $eventDispatcher The dispatcher used to trigger $event
+     */
+    public function configure(Event $event = null, $eventName = null, EventDispatcherInterface $eventDispatcher = null)
     {
+        if (null !== $eventDispatcher) {
+            foreach (array_keys(static::getSubscribedEvents()) as $name) {
+                $eventDispatcher->removeListener($name, array($this, 'configure'));
+            }
+        }
         if ($this->logger) {
             $handler = set_error_handler('var_dump', 0);
             $handler = is_array($handler) ? $handler[0] : null;
@@ -67,6 +86,19 @@ public function configure()
             }
             $this->logger = $this->levels = null;
         }
+        if (!$this->exceptionHandler) {
+            if ($event instanceof KernelEvent) {
+                $this->exceptionHandler = array($event->getKernel(), 'terminateWithException');
+            } elseif ($event instanceof ConsoleEvent && $app = $event->getCommand()->getApplication()) {
+                $output = $event->getOutput();
+                if ($output instanceof ConsoleOutputInterface) {
+                    $output = $output->getErrorOutput();
+                }
+                $this->exceptionHandler = function ($e) use ($app, $output) {
+                    $app->renderException($e, $output);
+                };
+            }
+        }
         if ($this->exceptionHandler) {
             $handler = set_exception_handler('var_dump');
             $handler = is_array($handler) ? $handler[0] : null;
@@ -86,6 +118,12 @@ public function configure()
 
     public static function getSubscribedEvents()
     {
-        return array(KernelEvents::REQUEST => array('configure', 2048));
+        $events = array(KernelEvents::REQUEST => array('configure', 2048));
+
+        if (defined('Symfony\Component\Console\ConsoleEvents::COMMAND')) {
+            $events[ConsoleEvents::COMMAND] = array('configure', 2048);
+        }
+
+        return $events;
     }
 }

Tests/EventListener/DebugHandlersListenerTest.php

@@ -12,9 +12,17 @@
 namespace Symfony\Component\HttpKernel\Tests\EventListener;
 
 use Psr\Log\LogLevel;
+use Symfony\Component\Console\Event\ConsoleEvent;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Helper\HelperSet;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Debug\ErrorHandler;
 use Symfony\Component\Debug\ExceptionHandler;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\HttpKernel\EventListener\DebugHandlersListener;
+use Symfony\Component\HttpKernel\KernelEvents;
 
 /**
  * DebugHandlersListenerTest
@@ -53,4 +61,48 @@ public function testConfigure()
         $this->assertArrayHasKey(E_DEPRECATED, $loggers);
         $this->assertSame(array($logger, LogLevel::INFO), $loggers[E_DEPRECATED]);
     }
+
+    public function testConsoleEvent()
+    {
+        $dispatcher = new EventDispatcher();
+        $listener = new DebugHandlersListener(null);
+        $app = $this->getMock('Symfony\Component\Console\Application');
+        $app->expects($this->once())->method('getHelperSet')->will($this->returnValue(new HelperSet()));
+        $command = new Command(__FUNCTION__);
+        $command->setApplication($app);
+        $event = new ConsoleEvent($command, new ArgvInput(), new ConsoleOutput());
+
+        $dispatcher->addSubscriber($listener);
+
+        $xListeners = array(
+            KernelEvents::REQUEST => array(array($listener, 'configure')),
+            ConsoleEvents::COMMAND => array(array($listener, 'configure')),
+        );
+        $this->assertSame($xListeners, $dispatcher->getListeners());
+
+        $exception = null;
+        $eHandler = new ErrorHandler();
+        set_error_handler(array($eHandler, 'handleError'));
+        set_exception_handler(array($eHandler, 'handleException'));
+        try {
+            $dispatcher->dispatch(ConsoleEvents::COMMAND, $event);
+        } catch (\Exception $exception) {
+        }
+        restore_exception_handler();
+        restore_error_handler();
+
+        if (null !== $exception) {
+            throw $exception;
+        }
+
+        $this->assertSame(array(), $dispatcher->getListeners());
+
+        $xHandler = $eHandler->setExceptionHandler('var_dump');
+        $this->assertInstanceOf('Closure', $xHandler);
+
+        $app->expects($this->once())
+            ->method('renderException');
+
+        $xHandler(new \Exception());
+    }
 }