fix(jsonapi)!: drop non-spec type member from error objects (#8732)

* fix(jsonapi)!: drop non-spec type member from error objects

JSON:API 1.1 forbids additional members on objects it defines, error
objects only define links.type. The problem type URI was already
exposed there, the top-level copy is removed.

Refs #8704

* test(laravel): drop top-level type from json:api error expectation

Author: soyuka

src/JsonApi/Serializer/ErrorNormalizer.php

@@ -39,6 +39,7 @@ public function normalize(mixed $data, ?string $format = null, array $context =
         $error['id'] = $jsonApiObject['data']['id'];
         if (isset($error['type'])) {
             $error['links'] = ['type' => $error['type']];
+            unset($error['type']);
         }
 
         if (!isset($error['code']) && method_exists($data, 'getId')) {

src/JsonApi/Tests/Serializer/ErrorNormalizerTest.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * 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\JsonApi\Tests\Serializer;
+
+use ApiPlatform\JsonApi\Serializer\ErrorNormalizer;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class ErrorNormalizerTest extends TestCase
+{
+    public function testTypeIsOnlyExposedUnderLinks(): void
+    {
+        $itemNormalizer = $this->createStub(NormalizerInterface::class);
+        $itemNormalizer->method('normalize')->willReturn(['data' => [
+            'id' => '/errors/500',
+            'attributes' => ['type' => '/errors/500', 'title' => 'An error occurred', 'status' => 500],
+        ]]);
+
+        $errors = (new ErrorNormalizer($itemNormalizer))->normalize(new \Exception('boom'), 'jsonapi')['errors'];
+
+        $this->assertCount(1, $errors);
+        $this->assertArrayNotHasKey('type', $errors[0]);
+        $this->assertSame(['type' => '/errors/500'], $errors[0]['links']);
+        $this->assertSame('500', $errors[0]['status']);
+    }
+
+    public function testViolationsAreExposedWithoutTopLevelType(): void
+    {
+        $itemNormalizer = $this->createStub(NormalizerInterface::class);
+        $itemNormalizer->method('normalize')->willReturn(['data' => [
+            'id' => '/validation_errors/abc',
+            'attributes' => [
+                'type' => '/validation_errors/abc',
+                'title' => 'Validation Failed',
+                'status' => 422,
+                'violations' => [['propertyPath' => 'name', 'message' => 'This value should not be blank.']],
+            ],
+        ]]);
+
+        $errors = (new ErrorNormalizer($itemNormalizer))->normalize(new \Exception('boom'), 'jsonapi')['errors'];
+
+        $this->assertCount(1, $errors);
+        $this->assertArrayNotHasKey('type', $errors[0]);
+        $this->assertArrayNotHasKey('violations', $errors[0]);
+        $this->assertSame(['type' => '/validation_errors/abc/name'], $errors[0]['links']);
+        $this->assertSame('This value should not be blank.', $errors[0]['detail']);
+    }
+}

src/Laravel/Tests/JsonApiTest.php

@@ -266,6 +266,7 @@ public function testValidateJsonApi(): void
 
         $this->assertArrayHasKey('id', $json['errors'][0]);
         $this->assertArrayHasKey('links', $json['errors'][0]);
+        $this->assertArrayNotHasKey('type', $json['errors'][0]);
         $this->assertArrayHasKey('type', $json['errors'][0]['links']);
 
         $response = $this->postJson(

src/Laravel/Tests/JsonProblemTest.php

@@ -113,7 +113,6 @@ public static function formatsProvider(): array
                         [
                             'id' => '401',
                             'detail' => 'Unauthorized',
-                            'type' => 'about:blank',
                             'title' => 'Error 401',
                             'status' => 401,
                             'code' => '401',

tests/Functional/JsonApi/ErrorTest.php

@@ -92,7 +92,8 @@ public function testRfc7807ErrorRendersJsonApiFormat(): void
         $this->assertSame('An error occurred', $body['errors'][0]['title']);
         $this->assertSame('400', $body['errors'][0]['status']);
         $this->assertArrayHasKey('detail', $body['errors'][0]);
-        $this->assertArrayHasKey('type', $body['errors'][0]);
+        $this->assertArrayNotHasKey('type', $body['errors'][0]);
+        $this->assertArrayHasKey('type', $body['errors'][0]['links']);
     }
 
     public function testNotFoundRouteRendersJsonApiFormat(): void
@@ -111,6 +112,7 @@ public function testNotFoundRouteRendersJsonApiFormat(): void
         $this->assertSame('An error occurred', $body['errors'][0]['title']);
         $this->assertSame('404', $body['errors'][0]['status']);
         $this->assertArrayHasKey('detail', $body['errors'][0]);
-        $this->assertArrayHasKey('type', $body['errors'][0]);
+        $this->assertArrayNotHasKey('type', $body['errors'][0]);
+        $this->assertArrayHasKey('type', $body['errors'][0]['links']);
     }
 }