fix(symfony): unset item_uri_template when serializing an error

fixes #6718
api-platform · Nov 22, 2024 · 4af28b9 · 4af28b9
1 parent d64ba84
commit 4af28b9
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 2 deletions.
diff --git a/src/Symfony/EventListener/ErrorListener.php b/src/Symfony/EventListener/ErrorListener.php
@@ -115,6 +115,10 @@ protected function duplicateRequest(\Throwable $exception, Request $request): Re
             $normalizationContext += ['api_error_resource' => true];
         }
 
+        if (isset($normalizationContext['item_uri_template'])) {
+            unset($normalizationContext['item_uri_template']);
+        }
+
         if (!isset($normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES])) {
             $normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES] = ['trace', 'file', 'line', 'code', 'message', 'traceAsString'];
         }

diff --git a/tests/Fixtures/TestBundle/ApiResource/Issue6718/Organization.php b/tests/Fixtures/TestBundle/ApiResource/Issue6718/Organization.php
@@ -0,0 +1,56 @@
+<?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\Fixtures\TestBundle\ApiResource\Issue6718;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Operation;
+
+#[ApiResource(
+    shortName: 'OrganisationIssue6718',
+    extraProperties: ['rfc_7807_compliant_errors' => true],
+    operations: [
+        new Get(
+            uriTemplate: '/6718_organisations/{id}',
+            provider: [self::class, 'itemProvider'],
+        ),
+        new Get(
+            uriTemplate: '/6718_users/{userId}/organisation',
+            uriVariables: [
+                'userId',
+            ],
+            normalizationContext: [
+                'item_uri_template' => '/6718_organisations/{id}',
+                'hydra_prefix' => false,
+            ],
+            provider: [self::class, 'userOrganizationItemProvider']
+        ),
+    ],
+)]
+class Organization
+{
+    public function __construct(public readonly string $id)
+    {
+    }
+
+    public static function itemProvider(Operation $operation, array $uriVariables = []): ?self
+    {
+        return new self($uriVariables['id']);
+    }
+
+    public static function userOrganizationItemProvider(): ?self
+    {
+        return null;
+    }
+}
diff --git a/tests/Fixtures/app/AppKernel.php b/tests/Fixtures/app/AppKernel.php
@@ -119,7 +119,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
                 'session' => class_exists(SessionFactory::class) ? ['storage_factory_id' => 'session.storage.factory.mock_file'] + $cookie : ['storage_id' => 'session.storage.mock_file'] + $cookie,
                 'profiler' => [
                     'enabled' => true,
-                    'collect' => false,
+                    'collect' => true,
                 ],
                 'php_errors' => ['log' => true],
                 'messenger' => $messengerConfig,
@@ -138,7 +138,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
                 'session' => class_exists(SessionFactory::class) ? ['storage_factory_id' => 'session.storage.factory.mock_file'] : ['storage_id' => 'session.storage.mock_file'],
                 'profiler' => [
                     'enabled' => true,
-                    'collect' => false,
+                    'collect' => true,
                 ],
                 'messenger' => $messengerConfig,
                 'router' => ['utf8' => true],

diff --git a/tests/Functional/ItemUriTemplateTest.php b/tests/Functional/ItemUriTemplateTest.php
@@ -0,0 +1,28 @@
+<?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;
+
+class ItemUriTemplateTest extends ApiTestCase
+{
+    public function testIssue6718(): void
+    {
+        self::createClient()->request('GET', '/6718_users/1/organisation', [
+            'headers' => ['accept' => 'application/ld+json'],
+        ]);
+        $this->assertResponseStatusCodeSame(404);
+        $this->assertJsonContains(['description' => 'Not Found']);
+    }
+}