Merge pull request #106 from foaly-nr1/exception-listener

Exception listener
kleijnweb · Nov 14, 2017 · fd313c1 · fd313c1
2 parents e9ab7ed + 87f83c8
commit fd313c1
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 14 deletions.
diff --git a/src/EventListener/ExceptionListener.php b/src/EventListener/ExceptionListener.php
@@ -14,6 +14,7 @@
 use KleijnWeb\SwaggerBundle\EventListener\Response\ErrorResponseFactoryInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
+use Symfony\Component\HttpKernel\Exception\HttpException;
 
 /**
  * @author John Kleijn <john@kleijnweb.nl>
@@ -55,11 +56,20 @@ public function __construct(
      */
     public function onKernelException(GetResponseForExceptionEvent $event)
     {
-        $error = new HttpError($event->getRequest(), $event->getException(), $this->logRefBuilder);
+        $request = $event->getRequest();
+        $exception = $event->getException();
+        if (!(
+            $request->attributes->has(RequestMeta::ATTRIBUTE_URI)
+            || $exception instanceof HttpException
+        )) {
+            return;
+        }
+
+        $error = new HttpError($request, $exception, $this->logRefBuilder);
 
         $this->logger->log(
             $error->getSeverity(),
-            "{$error->getMessage()} [logref {$error->getLogRef()}]: {$event->getException()}"
+            "{$error->getMessage()} [logref {$error->getLogRef()}]: {$exception}"
         );
 
         $event->setResponse($this->errorResponseFactory->create($error));

diff --git a/tests/unit/EventListener/ExceptionListenerTest.php b/tests/unit/EventListener/ExceptionListenerTest.php
@@ -16,6 +16,7 @@
 use Psr\Log\LogLevel;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * @author John Kleijn <john@kleijnweb.nl>
@@ -95,10 +96,65 @@ protected function setUp()
         $this->exceptionListener = new ExceptionListener($errorResponseFactory, $logRefBuilder, $this->logger);
     }
 
-    /**
-     * @test
-     */
-    public function willLogExceptionsWith4xxCodesAsBadRequestNotices()
+    public function testWillNotHandleIfNoDocumentUriInAttributesAndNotHttpException()
+    {
+        $event = $this
+            ->getMockBuilder(GetResponseForExceptionEvent::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getException', 'getRequest', 'setResponse'])
+            ->getMock();
+
+        $event
+            ->expects($this->any())
+            ->method('getException')
+            ->willReturn(new \Exception("Mary had a little lamb"))
+        ;
+
+        $event
+            ->expects($this->any())
+            ->method('getRequest')
+            ->willReturn(new Request())
+        ;
+
+        $event
+            ->expects($this->never())
+            ->method('setResponse')
+        ;
+
+        /** @var GetResponseForExceptionEvent $event */
+        $this->exceptionListener->onKernelException($event);
+    }
+
+    public function testWillHandleIfNoDocumentUriInAttributesButHttpException()
+    {
+        $event = $this
+            ->getMockBuilder(GetResponseForExceptionEvent::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getException', 'getRequest', 'setResponse'])
+            ->getMock();
+
+        $event
+            ->expects($this->any())
+            ->method('getException')
+            ->willReturn(new NotFoundHttpException())
+        ;
+
+        $event
+            ->expects($this->any())
+            ->method('getRequest')
+            ->willReturn(new Request())
+        ;
+
+        $event
+            ->expects($this->once())
+            ->method('setResponse')
+        ;
+
+        /** @var GetResponseForExceptionEvent $event */
+        $this->exceptionListener->onKernelException($event);
+    }
+
+    public function testWillLogExceptionsWith4xxCodesAsBadRequestNotices()
     {
         for ($i = 0; $i < 99; $i++) {
             $logger = $this->getMockForAbstractClass(LoggerInterface::class);
@@ -114,10 +170,7 @@ public function willLogExceptionsWith4xxCodesAsBadRequestNotices()
         }
     }
 
-    /**
-     * @test
-     */
-    public function willLogExceptionsWith5xxCodesAsRuntimeErrors()
+    public function testWillLogExceptionsWith5xxCodesAsRuntimeErrors()
     {
         for ($i = 0; $i < 99; $i++) {
             $logger = $this->getMockForAbstractClass(LoggerInterface::class);
@@ -133,10 +186,7 @@ public function willLogExceptionsWith5xxCodesAsRuntimeErrors()
         }
     }
 
-    /**
-     * @test
-     */
-    public function willLogExceptionsWithUnexpectedCodesAsCriticalErrors()
+    public function testWillLogExceptionsWithUnexpectedCodesAsCriticalErrors()
     {
         $sample = [4096, 777, 22, 5, 0];
         foreach ($sample as $code) {