Merge branch 'fix-exception-handling' into 'master'

Fix response status code in ExceptionListener for Symfony HTTP exceptions

See merge request undabot/json-api-symfony!45

Author: penovic

src/Exception/EventSubscriber/ExceptionListener.php

@@ -6,6 +6,7 @@
 
 use Symfony\Component\Debug\Exception\FlattenException;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use Undabot\JsonApi\Definition\Encoding\DocumentToPhpArrayEncoderInterface;
 use Undabot\JsonApi\Definition\Exception\Request\ClientGeneratedIdIsNotAllowedException;
 use Undabot\JsonApi\Definition\Exception\Request\RequestException;
@@ -74,6 +75,18 @@ public function onKernelException(ExceptionEvent $event): void
             return;
         }
 
+        if ($exception instanceof HttpExceptionInterface) {
+            $errorCollection = new ErrorCollection([
+                $this->buildError($exception),
+            ]);
+            $document = new Document(null, $errorCollection);
+            $data = $this->documentToPhpArrayEncoderInterface->encode($document);
+            $response = JsonApiHttpResponse::fromSymfonyHttpException($data, $exception);
+            $event->setResponse($response);
+
+            return;
+        }
+
         if ($exception instanceof \Exception) {
             $errorCollection = new ErrorCollection([
                 $this->buildError($exception),
@@ -87,14 +100,14 @@ public function onKernelException(ExceptionEvent $event): void
         }
     }
 
-    private function buildError(\Exception $exception): Error
+    private function buildError(\Throwable $exception): Error
     {
         if (class_exists('\Symfony\Component\ErrorHandler\Exception\FlattenException')) {
             /** @var callable $callable */
-            $callable = ['Symfony\Component\ErrorHandler\Exception\FlattenException', 'create'];
+            $callable = ['Symfony\Component\ErrorHandler\Exception\FlattenException', 'createFromThrowable'];
             $e = \call_user_func($callable, $exception);
         } else {
-            $e = FlattenException::create($exception);
+            $e = FlattenException::createFromThrowable($exception);
         }
 
         return new Error(

src/Http/Model/Response/JsonApiHttpResponse.php

@@ -5,6 +5,7 @@
 namespace Undabot\SymfonyJsonApi\Http\Model\Response;
 
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 
 class JsonApiHttpResponse extends Response
 {
@@ -110,4 +111,22 @@ public static function serverError(array $data): self
             ]
         );
     }
+
+    /**
+     * @param array<string, mixed> $data
+     *
+     * @throws \JsonException
+     */
+    public static function fromSymfonyHttpException(array $data, HttpExceptionInterface $exception): self
+    {
+        $content = json_encode($data, JSON_THROW_ON_ERROR);
+
+        return new self(
+            $content ?: null,
+            $exception->getStatusCode(),
+            [
+                'Content-Type' => self::CONTENT_TYPE,
+            ]
+        );
+    }
 }

tests/Unit/Exception/EventSubscriber/ExceptionListenerTest.php

@@ -8,6 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Validator\ConstraintViolationList;
 use Undabot\JsonApi\Definition\Encoding\DocumentToPhpArrayEncoderInterface;
@@ -79,7 +80,7 @@ public function exceptionProvider(): \Generator
 
     public function testOnKernelExceptionWillSetCorrectEventResponseGivenGivenExceptionIsSupportedAndEventHaveThrowableMethod(): void
     {
-        $event = new DummyThrowableEvent(
+        $event = new ExceptionEvent(
             $this->createMock(KernelInterface::class),
             $this->createMock(Request::class),
             KernelInterface::MASTER_REQUEST,
@@ -93,22 +94,41 @@ public function testOnKernelExceptionWillSetCorrectEventResponseGivenGivenExcept
 
         $this->exceptionListener->onKernelException($event);
         static::assertEquals(
-            $event->getResponse(),
             new JsonApiHttpResponse(
                 json_encode($data),
                 500,
                 [
                     'Content-Type' => 'application/vnd.api+json',
                 ],
-            )
+            ),
+            $event->getResponse()
         );
     }
-}
 
-class DummyThrowableEvent extends ExceptionEvent
-{
-    public function getThrowable(): \Throwable
+    public function testOnKernelExceptionWillSetCorrectEventResponseGivenGivenSymfonyHttpException(): void
     {
-        return new \LogicException();
+        $event = new ExceptionEvent(
+            $this->createMock(KernelInterface::class),
+            $this->createMock(Request::class),
+            KernelInterface::MASTER_REQUEST,
+            $e = new AccessDeniedHttpException()
+        );
+        $data = [];
+        $this->documentToPhpArrayEncoderInterfaceMock
+            ->expects(static::once())
+            ->method('encode')
+            ->willReturn($data);
+
+        $this->exceptionListener->onKernelException($event);
+        static::assertEquals(
+            new JsonApiHttpResponse(
+                json_encode($data),
+                $e->getStatusCode(),
+                [
+                    'Content-Type' => 'application/vnd.api+json',
+                ],
+            ),
+            $event->getResponse()
+        );
     }
 }