fix(jsonapi): normalize flatten exceptions through the problem normalizer

Author: soyuka

src/JsonApi/Serializer/ErrorNormalizer.php

@@ -25,7 +25,7 @@ final class ErrorNormalizer implements NormalizerInterface
 {
     public const FORMAT = 'jsonapi';
 
-    public function __construct(private ?NormalizerInterface $itemNormalizer = null)
+    public function __construct(private ?NormalizerInterface $itemNormalizer = null, private ?NormalizerInterface $problemNormalizer = null)
     {
     }
 
@@ -35,7 +35,7 @@ public function __construct(private ?NormalizerInterface $itemNormalizer = null)
     public function normalize(mixed $data, ?string $format = null, array $context = []): array
     {
         if ($data instanceof FlattenException) {
-            $error = $this->flattenExceptionToError($data, $context);
+            $error = $this->flattenExceptionToError($data, $format, $context);
         } else {
             $jsonApiObject = $this->itemNormalizer->normalize($data, $format, $context);
             $error = $jsonApiObject['data']['attributes'] ?? [];
@@ -77,17 +77,19 @@ public function normalize(mixed $data, ?string $format = null, array $context =
         return ['errors' => $errors];
     }
 
-    private function flattenExceptionToError(FlattenException $exception, array $context): array
+    private function flattenExceptionToError(FlattenException $exception, ?string $format, array $context): array
     {
-        $status = $exception->getStatusCode();
+        $type = \sprintf('/errors/%d', $exception->getStatusCode());
+        unset($context['exception']);
+        $problem = $this->problemNormalizer->normalize($exception, $format, ['type' => $type] + $context);
 
         return [
-            'id' => "/errors/$status",
-            'title' => 'An error occurred',
-            'detail' => ($context['debug'] ?? false) ? $exception->getMessage() : $exception->getStatusText(),
-            'status' => $status,
-            'type' => "/errors/$status",
-            'code' => (string) $status,
+            'id' => $problem['type'],
+            'title' => $problem['title'],
+            'detail' => $problem['detail'],
+            'status' => $problem['status'],
+            'type' => $problem['type'],
+            'code' => (string) $problem['status'],
         ];
     }
 
@@ -96,7 +98,7 @@ private function flattenExceptionToError(FlattenException $exception, array $con
      */
     public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
     {
-        return self::FORMAT === $format && ($data instanceof \Exception || $data instanceof FlattenException);
+        return self::FORMAT === $format && ($data instanceof \Exception || ($data instanceof FlattenException && null !== $this->problemNormalizer));
     }
 
     /**
@@ -107,7 +109,7 @@ public function getSupportedTypes(?string $format): array
         if (self::FORMAT === $format) {
             return [
                 \Exception::class => true,
-                FlattenException::class => true,
+                FlattenException::class => null !== $this->problemNormalizer,
             ];
         }
 

src/Symfony/Bundle/Resources/config/jsonapi.php

@@ -119,6 +119,6 @@
         ->tag('serializer.normalizer', ['priority' => -780]);
 
     $services->set('api_platform.jsonapi.normalizer.error', ErrorNormalizer::class)
-        ->args([service('api_platform.jsonapi.normalizer.item')])
+        ->args([service('api_platform.jsonapi.normalizer.item'), service('serializer.normalizer.problem')->nullOnInvalid()])
         ->tag('serializer.normalizer', ['priority' => -790]);
 };