[HttpKernel] Add support for configuring log level, and status code by exception class

Author: lyrixx

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * Deprecate `AbstractTestSessionListener::getSession` inject a session in the request instead
  * Deprecate the `fileLinkFormat` parameter of `DebugHandlersListener`
+ * Add support for configuring log level, and status code by exception class
 
 5.3
 ---

EventListener/ErrorListener.php

@@ -32,19 +32,30 @@ class ErrorListener implements EventSubscriberInterface
     protected $controller;
     protected $logger;
     protected $debug;
+    protected $exceptionsMapping;
 
-    public function __construct($controller, LoggerInterface $logger = null, bool $debug = false)
+    public function __construct($controller, LoggerInterface $logger = null, bool $debug = false, array $exceptionsMapping = [])
     {
         $this->controller = $controller;
         $this->logger = $logger;
         $this->debug = $debug;
+        $this->exceptionsMapping = $exceptionsMapping;
     }
 
     public function logKernelException(ExceptionEvent $event)
     {
-        $e = FlattenException::createFromThrowable($event->getThrowable());
+        $throwable = $event->getThrowable();
+        $logLevel = null;
+        foreach ($this->exceptionsMapping as $class => $config) {
+            if ($throwable instanceof $class && $config['log_level']) {
+                $logLevel = $config['log_level'];
+                break;
+            }
+        }
+
+        $e = FlattenException::createFromThrowable($throwable);
 
-        $this->logException($event->getThrowable(), sprintf('Uncaught PHP Exception %s: "%s" at %s line %s', $e->getClass(), $e->getMessage(), $e->getFile(), $e->getLine()));
+        $this->logException($throwable, sprintf('Uncaught PHP Exception %s: "%s" at %s line %s', $e->getClass(), $e->getMessage(), $e->getFile(), $e->getLine()), $logLevel);
     }
 
     public function onKernelException(ExceptionEvent $event)
@@ -53,8 +64,8 @@ public function onKernelException(ExceptionEvent $event)
             return;
         }
 
-        $exception = $event->getThrowable();
-        $request = $this->duplicateRequest($exception, $event->getRequest());
+        $throwable = $event->getThrowable();
+        $request = $this->duplicateRequest($throwable, $event->getRequest());
 
         try {
             $response = $event->getKernel()->handle($request, HttpKernelInterface::SUB_REQUEST, false);
@@ -65,18 +76,25 @@ public function onKernelException(ExceptionEvent $event)
 
             $prev = $e;
             do {
-                if ($exception === $wrapper = $prev) {
+                if ($throwable === $wrapper = $prev) {
                     throw $e;
                 }
             } while ($prev = $wrapper->getPrevious());
 
             $prev = new \ReflectionProperty($wrapper instanceof \Exception ? \Exception::class : \Error::class, 'previous');
             $prev->setAccessible(true);
-            $prev->setValue($wrapper, $exception);
+            $prev->setValue($wrapper, $throwable);
 
             throw $e;
         }
 
+        foreach ($this->exceptionsMapping as $exception => $config) {
+            if ($throwable instanceof $exception && $config['status_code']) {
+                $response->setStatusCode($config['status_code']);
+                break;
+            }
+        }
+
         $event->setResponse($response);
 
         if ($this->debug) {
@@ -124,10 +142,12 @@ public static function getSubscribedEvents(): array
     /**
      * Logs an exception.
      */
-    protected function logException(\Throwable $exception, string $message): void
+    protected function logException(\Throwable $exception, string $message, string $logLevel = null): void
     {
         if (null !== $this->logger) {
-            if (!$exception instanceof HttpExceptionInterface || $exception->getStatusCode() >= 500) {
+            if (null !== $logLevel) {
+                $this->logger->log($logLevel, $message, ['exception' => $exception]);
+            } elseif (!$exception instanceof HttpExceptionInterface || $exception->getStatusCode() >= 500) {
                 $this->logger->critical($message, ['exception' => $exception]);
             } else {
                 $this->logger->error($message, ['exception' => $exception]);

Tests/EventListener/ErrorListenerTest.php

@@ -97,6 +97,27 @@ public function testHandleWithLogger($event, $event2)
         $this->assertCount(3, $logger->getLogs('critical'));
     }
 
+    public function testHandleWithLoggerAndCustomConfiguration()
+    {
+        $request = new Request();
+        $event = new ExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MAIN_REQUEST, new \RuntimeException('bar'));
+        $logger = new TestLogger();
+        $l = new ErrorListener('not used', $logger, false, [
+            \RuntimeException::class => [
+                'log_level' => 'warning',
+                'status_code' => 401,
+            ],
+        ]);
+        $l->logKernelException($event);
+        $l->onKernelException($event);
+
+        $this->assertEquals(new Response('foo', 401), $event->getResponse());
+
+        $this->assertEquals(0, $logger->countErrors());
+        $this->assertCount(0, $logger->getLogs('critical'));
+        $this->assertCount(1, $logger->getLogs('warning'));
+    }
+
     public function provider()
     {
         if (!class_exists(Request::class)) {