feat: correctly map problem-detail fields when using ProblemExceptionInterface (#7776)

* feat: use values from ProblemExceptionInterface

* Add test case to JsonProblemTest

* Apply change to State/ApiResource/Error.php as well

* Fix StrictParametersTest in line with detail of ParameterNotSupportedException

Author: bonroyage

src/Laravel/ApiResource/Error.php

@@ -136,6 +136,10 @@ public static function createFromException(\Exception|\Throwable $exception, int
     {
         $headers = ($exception instanceof SymfonyHttpExceptionInterface || $exception instanceof HttpExceptionInterface) ? $exception->getHeaders() : [];
 
+        if ($exception instanceof ProblemExceptionInterface) {
+            return new self($exception->getTitle(), $exception->getDetail(), $exception->getStatus(), $exception->getTrace(), $exception->getInstance(), $exception->getType(), $headers);
+        }
+
         return new self('An error occurred', $exception->getMessage(), $status, $exception->getTrace(), type: '/errors/'.$status, headers: $headers);
     }
 

src/Laravel/Tests/JsonProblemTest.php

@@ -85,6 +85,20 @@ public function testRetrieveErrorHtml(): void
 </html>', $response->getContent());
     }
 
+    public function testProblemExceptionInterface(): void
+    {
+        $response = $this->get('/api/teapot', headers: ['accept' => 'application/json']);
+        $response->assertStatus(418);
+        $response->assertHeader('content-type', 'application/problem+json; charset=utf-8');
+        $response->assertJsonFragment([
+            'type' => '/problem/teapot',
+            'title' => 'I\'m a teapot',
+            'status' => 418,
+            'detail' => 'No coffee here',
+            'instance' => '/teapot',
+        ]);
+    }
+
     /**
      * @return list<array{0: string, 1: string, 2: array<string, mixed>}>
      */

src/Laravel/workbench/app/ApiResource/ServiceProvider.php

@@ -16,7 +16,9 @@
 use ApiPlatform\Metadata\Get;
 use Workbench\App\State\CustomProvider;
 use Workbench\App\State\CustomProviderWithDependency;
+use Workbench\App\State\TeapotProvider;
 
+#[Get(uriTemplate: 'teapot', name: 'teapot', provider: TeapotProvider::class)]
 #[Get(uriTemplate: 'custom_service_provider', provider: CustomProvider::class)]
 #[Get(uriTemplate: 'custom_service_provider_with_dependency', provider: CustomProviderWithDependency::class)]
 class ServiceProvider

src/Laravel/workbench/app/Exceptions/TeapotException.php

@@ -0,0 +1,55 @@
+<?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 Workbench\App\Exceptions;
+
+use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
+use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
+
+class TeapotException extends \Exception implements ProblemExceptionInterface, HttpExceptionInterface
+{
+    public function getStatusCode(): int
+    {
+        return 418;
+    }
+
+    public function getHeaders(): array
+    {
+        return [];
+    }
+
+    public function getType(): string
+    {
+        return '/problem/teapot';
+    }
+
+    public function getTitle(): ?string
+    {
+        return 'I\'m a teapot';
+    }
+
+    public function getStatus(): ?int
+    {
+        return 418;
+    }
+
+    public function getDetail(): ?string
+    {
+        return 'No coffee here';
+    }
+
+    public function getInstance(): ?string
+    {
+        return '/teapot';
+    }
+}

src/Laravel/workbench/app/State/TeapotProvider.php

@@ -0,0 +1,30 @@
+<?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 Workbench\App\State;
+
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ProviderInterface;
+use Workbench\App\ApiResource\ServiceProvider;
+use Workbench\App\Exceptions\TeapotException;
+
+/**
+ * @implements ProviderInterface<ServiceProvider>
+ */
+class TeapotProvider implements ProviderInterface
+{
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
+    {
+        throw new TeapotException('I\'m boiling');
+    }
+}

src/State/ApiResource/Error.php

@@ -199,6 +199,10 @@ public static function createFromException(\Exception|\Throwable $exception, int
     {
         $headers = ($exception instanceof SymfonyHttpExceptionInterface || $exception instanceof HttpExceptionInterface) ? $exception->getHeaders() : [];
 
+        if ($exception instanceof ProblemExceptionInterface) {
+            return new self($exception->getTitle(), $exception->getDetail(), $exception->getStatus(), $exception->getTrace(), $exception->getInstance(), $exception->getType(), $headers);
+        }
+
         return new self('An error occurred', $exception->getMessage(), $status, $exception->getTrace(), type: "/errors/$status", headers: $headers, previous: $exception->getPrevious());
     }
 

tests/Functional/Parameters/StrictParametersTest.php

@@ -34,7 +34,7 @@ public static function getResources(): array
     public function testErrorAsParameterIsNotAllowed(): void
     {
         self::createClient()->request('GET', 'strict_query_parameters?bar=test');
-        $this->assertJsonContains(['detail' => 'Parameter not supported']);
+        $this->assertJsonContains(['detail' => 'Parameter "bar" not supported']);
         $this->assertResponseStatusCodeSame(400);
     }