feat: update error formatting to return HttpError object with status and headers

Author: jenky

composer.json

@@ -23,7 +23,7 @@
         "friendsofphp/php-cs-fixer": "^3.10",
         "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "^10.0",
-        "symfony/http-kernel": "^6.1|^7.2"
+        "symfony/http-foundation": "^6.1|^7.2"
     },
     "autoload": {
         "psr-4": {

src/Formatter/AbstractErrorFormatter.php

@@ -5,12 +5,11 @@
 namespace Jenky\ApiError\Formatter;
 
 use Jenky\ApiError\DebuggableProblem;
+use Jenky\ApiError\HttpError;
 use Jenky\ApiError\Problem;
 use Jenky\ApiError\Transformer\ExceptionTransformer;
+use Symfony\Component\ErrorHandler\Exception\FlattenException;
 
-/**
- * @template T of array-key
- */
 abstract class AbstractErrorFormatter implements ErrorFormatter
 {
     public function __construct(
@@ -20,16 +19,13 @@ public function __construct(
     }
 
     /**
-     * @return array<T, mixed> $format
+     * @return array<string, mixed> $format
      */
     abstract protected function getFormat(): array;
 
     abstract protected function createProblem(\Throwable $exception): Problem;
 
-    /**
-     * @return array<T, mixed>
-     */
-    public function format(\Throwable $exception): array
+    public function format(\Throwable $exception): HttpError
     {
         $format = $this->getFormat();
 
@@ -47,9 +43,17 @@ public function format(\Throwable $exception): array
             ? $problem->debugContext()
             : $problem->context();
 
+        $status = 500;
+        $headers = [];
+
+        if ($problem instanceof FlattenException) {
+            $status = $problem->getStatusCode();
+            $headers = $problem->getHeaders();
+        }
+
         \array_walk_recursive($format, $this->replacePlaceHolder(...), $context);
 
-        return $this->removeEmptyPlaceHolders($format);
+        return new HttpError($this->removeEmptyPlaceHolders($format), $status, $headers);
     }
 
     /**
@@ -92,7 +96,7 @@ function (array $matches) use ($context, &$cache) {
     /**
      * @param  array<array-key, mixed> $input
      *
-     * @return array<T, mixed>
+     * @return array<string, mixed>
      */
     private function removeEmptyPlaceHolders(array $input): array
     {

src/Formatter/ErrorFormatter.php

@@ -4,7 +4,9 @@
 
 namespace Jenky\ApiError\Formatter;
 
+use Jenky\ApiError\HttpError;
+
 interface ErrorFormatter
 {
-    public function format(\Throwable $exception): mixed;
+    public function format(\Throwable $exception): HttpError;
 }

src/Formatter/GenericErrorFormatter.php

@@ -7,9 +7,6 @@
 use Jenky\ApiError\GenericProblem;
 use Jenky\ApiError\Problem;
 
-/**
- * @extends AbstractErrorFormatter<string>
- */
 final class GenericErrorFormatter extends AbstractErrorFormatter
 {
     protected function createProblem(\Throwable $exception): Problem

src/Formatter/Rfc7807ErrorFormatter.php

@@ -7,9 +7,6 @@
 use Jenky\ApiError\Problem;
 use Jenky\ApiError\Rfc7807Problem;
 
-/**
- * @extends AbstractErrorFormatter<string>
- */
 final class Rfc7807ErrorFormatter extends AbstractErrorFormatter
 {
     protected function createProblem(\Throwable $exception): Problem

src/Handler/Symfony/JsonResponseHandler.php

@@ -8,7 +8,6 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 
 if (! class_exists(Request::class) || ! class_exists(Response::class)) {
     throw new \LogicException('You cannot use the "Jenky\ApiError\Handler\Symfony\JsonResponseHandler" as the "symfony/http-foundation" package is not installed. Try running "composer require symfony/http-foundation".');
@@ -31,18 +30,12 @@ public function render(\Throwable $exception, Request $request): ?JsonResponse
             return null;
         }
 
-        $status = 500;
-        $headers = [];
-
-        if (interface_exists(HttpExceptionInterface::class) && $exception instanceof HttpExceptionInterface) {
-            $status = $exception->getStatusCode();
-            $headers = $exception->getHeaders();
-        }
+        $data = $this->formatter->format($exception);
 
         return new JsonResponse(
-            $this->formatter->format($exception),
-            $status,
-            \array_merge(['Content-Type' => $this->contentType], $headers)
+            $data,
+            $data->statusCode,
+            \array_merge(['Content-Type' => $this->contentType], $data->headers)
         );
     }
 

src/HttpError.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Jenky\ApiError;
+
+final class HttpError implements \JsonSerializable
+{
+    /**
+     * @param  array<string, mixed> $headers
+     */
+    public function __construct(
+        public readonly mixed $data,
+        public readonly int $statusCode = 500,
+        public readonly array $headers = [],
+    ) {
+    }
+
+    public function jsonSerialize(): mixed
+    {
+        return $this->data;
+    }
+}

tests/ErrorFormatterTest.php

@@ -16,7 +16,7 @@ public function test_generic_error_formatter(\Throwable $exception, bool $debug)
     {
         $formatter = new GenericErrorFormatter($debug);
 
-        $data = $formatter->format($exception);
+        $data = $formatter->format($exception)->data;
 
         $this->assertIsArray($data);
         $this->assertArrayHasKey('message', $data);
@@ -39,7 +39,7 @@ public function test_rfc7808_error_formatter(\Throwable $exception, bool $debug)
     {
         $formatter = new Rfc7807ErrorFormatter($debug);
 
-        $data = $formatter->format($exception);
+        $data = $formatter->format($exception)->data;
 
         $this->assertIsArray($data);
         $this->assertArrayHasKey('type', $data);