suggest another approach

Author: soyuka

features/jsonapi/errors.feature

@@ -61,13 +61,3 @@ Feature: JSON API error handling
     And the JSON node "errors[0].status" should be equal to 404
     And the JSON node "errors[0].detail" should exist
     And the JSON node "errors[0].type" should exist
-
-  Scenario: Get a proper error when ItemNotFoundException is thrown from a provider
-    When I send a "GET" request to "/jsonapi_error_test/nonexistent"
-    Then the response status code should be 404
-    And the response should be in JSON
-    And the header "Content-Type" should be equal to "application/vnd.api+json; charset=utf-8"
-    And the JSON node "errors" should exist
-    And the JSON node "errors[0].status" should exist
-    And the JSON node "errors[0].title" should exist
-    And the JSON node "errors[0].id" should exist

src/JsonApi/Serializer/ErrorNormalizer.php

@@ -35,16 +35,7 @@ public function __construct(private ?NormalizerInterface $itemNormalizer = null)
     public function normalize(mixed $object, ?string $format = null, array $context = []): array
     {
         $jsonApiObject = $this->itemNormalizer->normalize($object, $format, $context);
-
-        if (!isset($jsonApiObject['data']['attributes'])) {
-            return ['errors' => [[
-                'id' => $jsonApiObject['data']['id'] ?? uniqid('error_', true),
-                'status' => (string) (method_exists($object, 'getStatusCode') ? $object->getStatusCode() : 500),
-                'title' => method_exists($object, 'getMessage') ? $object->getMessage() : 'An error occurred',
-            ]]];
-        }
-
-        $error = $jsonApiObject['data']['attributes'];
+        $error = $jsonApiObject['data']['attributes'] ?? [];
         $error['id'] = $jsonApiObject['data']['id'];
         if (isset($error['type'])) {
             $error['links'] = ['type' => $error['type']];
@@ -54,6 +45,10 @@ public function normalize(mixed $object, ?string $format = null, array $context
             $error['code'] = $object->getId();
         }
 
+        if (isset($error['status'])) {
+            $error['status'] = (string) $error['status'];
+        }
+
         if (!isset($error['violations'])) {
             return ['errors' => [$error]];
         }

tests/Fixtures/TestBundle/ApiResource/JsonApiErrorTestResource.php

@@ -13,24 +13,32 @@
 
 namespace ApiPlatform\Tests\Fixtures\TestBundle\ApiResource;
 
-use ApiPlatform\Metadata\ApiProperty;
-use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Exception\ItemNotFoundException;
 use ApiPlatform\Metadata\Get;
-use ApiPlatform\Tests\Fixtures\TestBundle\State\JsonApiErrorTestProvider;
-
-#[ApiResource(
-    operations: [
-        new Get(
-            uriTemplate: '/jsonapi_error_test/{id}',
-            provider: JsonApiErrorTestProvider::class,
-        ),
-    ],
+use ApiPlatform\Metadata\Operation;
+
+#[Get(
+    uriTemplate: '/jsonapi_error_test/{id}',
+    provider: [self::class, 'provide'],
     formats: ['jsonapi' => ['application/vnd.api+json']],
 )]
 class JsonApiErrorTestResource
 {
-    #[ApiProperty(identifier: true)]
     public string $id;
-
     public string $name;
+
+    public static function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
+    {
+        $id = $uriVariables['id'] ?? null;
+
+        if ('existing' === $id) {
+            $resource = new self();
+            $resource->id = $id;
+            $resource->name = 'Existing Resource';
+
+            return $resource;
+        }
+
+        throw new ItemNotFoundException(\sprintf('Resource "%s" not found.', $id));
+    }
 }

tests/Fixtures/TestBundle/State/JsonApiErrorTestProvider.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Functional;
+
+use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
+use ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\JsonApiErrorTestResource;
+use ApiPlatform\Tests\SetupClassResourcesTrait;
+
+class JsonApiTest extends ApiTestCase
+{
+    use SetupClassResourcesTrait;
+    protected static ?bool $alwaysBootKernel = false;
+
+    /**
+     * @return class-string[]
+     */
+    public static function getResources(): array
+    {
+        return [
+            JsonApiErrorTestResource::class,
+        ];
+    }
+
+    public function testError(): void
+    {
+        self::createClient()->request('GET', '/jsonapi_error_test/nonexistent', [
+            'headers' => ['accept' => 'application/vnd.api+json'],
+        ]);
+
+        $this->assertResponseStatusCodeSame(400);
+        $this->assertResponseHeaderSame('content-type', 'application/vnd.api+json; charset=utf-8');
+        $this->assertJsonContains([
+            'errors' => [
+                [
+                    'status' => '400',
+                    'detail' => 'Resource "nonexistent" not found.',
+                ],
+            ],
+        ]);
+    }
+}