prepare guide

Author: soyuka

.github/workflows/ci.yml

@@ -204,7 +204,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: latest
+          php-version: ${{ matrix.php }}
           tools: pecl, composer
           extensions: intl, bcmath, curl, openssl, mbstring, pdo_sqlite, mongodb
           ini-values: memory_limit=-1

src/Action/ExceptionAction.php

@@ -81,6 +81,8 @@ public function __invoke(FlattenException $exception, Request $request): Respons
             $error = $error->getConstraintViolationList();
         } elseif (method_exists($error, 'getViolations') && $error->getViolations() instanceof ConstraintViolationListInterface) {
             $error = $error->getViolations();
+        } else {
+            $error = $exception;
         }
 
         $serializerFormat = $format['key'];

src/Hydra/Serializer/ErrorNormalizer.php

@@ -64,7 +64,7 @@ public function normalize(mixed $object, string $format = null, array $context =
      */
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
-        if ($data instanceof Error) {
+        if ($context['api_error_resource'] ?? false) {
             return false;
         }
 

src/Metadata/ErrorResource.php

@@ -92,7 +92,7 @@ public function __construct(
             shortName: $shortName,
             description: $description,
             types: $types,
-            operations: $operations ?? [new Get()],
+            operations: $operations ?? [new Error()],
             formats: $formats,
             inputFormats: $inputFormats,
             outputFormats: $outputFormats,

src/Metadata/Exception/HttpExceptionInterface.php

@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Metadata\Exception;
 
-interface HttpExceptionInterface extends \Throwable
+interface HttpExceptionInterface
 {
     /**
      * Returns the status code.

src/Metadata/Exception/ProblemExceptionInterface.php

@@ -28,8 +28,6 @@ public function getTitle(): ?string;
 
     public function getStatus(): ?int;
 
-    public function setStatus(int $status): void;
-
     public function getDetail(): ?string;
 
     public function getInstance(): ?string;

src/Problem/Serializer/ErrorNormalizer.php

@@ -65,7 +65,7 @@ public function normalize(mixed $object, string $format = null, array $context =
      */
     public function supportsNormalization(mixed $data, string $format = null, array $context = []): bool
     {
-        if ($data instanceof Error) {
+        if ($context['api_error_resource'] ?? false) {
             return false;
         }
 

src/State/ErrorProvider.php

@@ -15,23 +15,28 @@
 
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
+use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\State\ApiResource\Error;
 
 /**
  * @internal
  */
 final class ErrorProvider implements ProviderInterface
 {
-    public function __construct(private readonly bool $debug = false)
+    public function __construct(private readonly bool $debug = false, private ?ResourceClassResolverInterface $resourceClassResolver = null)
     {
     }
 
-    public function provide(Operation $operation, array $uriVariables = [], array $context = []): Error
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object
     {
         if (!($request = $context['request'] ?? null) || !$operation instanceof HttpOperation || null === ($exception = $request->attributes->get('exception'))) {
             throw new \RuntimeException('Not an HTTP request');
         }
 
+        if ($this->resourceClassResolver?->isResourceClass($exception::class)) {
+            return $exception;
+        }
+
         $status = $operation->getStatus() ?? 500;
         $error = Error::createFromException($exception, $status);
         if (!$this->debug && $status >= 500) {

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -169,8 +169,8 @@ public function getConfigTreeBuilder(): TreeBuilder
             'html' => ['mime_types' => ['text/html']],
         ]);
         $this->addFormatSection($rootNode, 'error_formats', [
-            'jsonproblem' => ['mime_types' => ['application/problem+json']],
             'jsonld' => ['mime_types' => ['application/ld+json']],
+            'jsonproblem' => ['mime_types' => ['application/problem+json']],
             'json' => ['mime_types' => ['application/problem+json', 'application/json']],
         ]);
 

src/Symfony/Bundle/Resources/config/api.xml

@@ -203,6 +203,7 @@
 
         <service id="api_platform.state.error_provider" class="ApiPlatform\State\ErrorProvider">
             <argument key="$debug">%kernel.debug%</argument>
+            <argument type="service" key="$resourceClassResolver" id="api_platform.resource_class_resolver" />
             <tag name="api_platform.state_provider" key="api_platform.state.error_provider" />
         </service>
 

src/Symfony/EventListener/ErrorListener.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Api\IdentifiersExtractorInterface as LegacyIdentifiersExtractorInterface;
 use ApiPlatform\Api\ResourceClassResolverInterface as LegacyResourceClassResolverInterface;
 use ApiPlatform\Metadata\Error as ErrorOperation;
+use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
 use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\IdentifiersExtractorInterface;
@@ -32,6 +33,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\EventListener\ErrorListener as SymfonyErrorListener;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
+use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
 
 /**
  * This error listener extends the Symfony one in order to add
@@ -71,6 +73,11 @@ protected function duplicateRequest(\Throwable $exception, Request $request): Re
         $request->setRequestFormat($format);
         $apiOperation = $this->initializeOperation($request);
 
+        // TODO: add configuration flag to:
+        //   - always use symfony error handler (skips this listener)
+        //   - use symfony error handler if it's not an api error, ie apiOperation is null
+        //   - use api platform to handle errors (the default behavior we handle firewall errors for example but they're out of our scope)
+
         // Let the error handler take this we don't handle HTML nor non-api platform requests
         if ('html' === $format) {
             $this->controller = 'error_controller';
@@ -139,6 +146,17 @@ protected function duplicateRequest(\Throwable $exception, Request $request): Re
             $operation = $operation->withProvider('api_platform.state.error_provider');
         }
 
+        $normalizationContext = $operation->getNormalizationContext() ?? [];
+        if (!($normalizationContext['_api_error_resource'] ?? false)) {
+            $normalizationContext = $normalizationContext + ['api_error_resource' => true];
+        }
+
+        if (!isset($normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES])) {
+            $normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES] = ['trace', 'file', 'line', 'code', 'message', 'traceAsString'];
+        }
+
+        $operation = $operation->withNormalizationContext($normalizationContext);
+
         $dup->attributes->set('_api_resource_class', $operation->getClass());
         $dup->attributes->set('_api_previous_operation', $apiOperation);
         $dup->attributes->set('_api_operation', $operation);
@@ -192,6 +210,14 @@ private function getStatusCode(?HttpOperation $apiOperation, Request $request, ?
             return $exception->getStatusCode();
         }
 
+        if ($exception instanceof ProblemExceptionInterface && $status = $exception->getStatus()) {
+            return $status;
+        }
+
+        if ($exception instanceof HttpExceptionInterface) {
+            return $exception->getStatusCode();
+        }
+
         if ($exception instanceof RequestExceptionInterface) {
             return 400;
         }

src/Symfony/EventListener/SerializeListener.php

@@ -48,6 +48,7 @@ public function __construct(
         private readonly SerializerContextBuilderInterface $serializerContextBuilder,
         ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory = null,
         private readonly array $errorFormats = [],
+        // @phpstan-ignore-next-line we don't need this anymore
         private readonly bool $debug = false,
     ) {
         $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -96,6 +96,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm
             'error_formats' => [
                 'jsonproblem' => ['mime_types' => ['application/problem+json']],
                 'jsonld' => ['mime_types' => ['application/ld+json']],
+                'json' => ['mime_types' => ['application/problem+json', 'application/json']],
             ],
             'exception_to_status' => [
                 ExceptionInterface::class => Response::HTTP_BAD_REQUEST,

tests/Symfony/EventListener/ErrorListenerTest.php

@@ -103,6 +103,20 @@ public function testDuplicateExceptionWithErrorResource(): void
             $this->assertTrue($request->attributes->has('_api_previous_operation'));
             $this->assertEquals('_api_errors_hydra', $request->attributes->get('_api_operation_name'));
 
+            $operation = $request->attributes->get('_api_operation');
+            $this->assertEquals($operation->getNormalizationContext(), [
+                // this flag is for bc layer on error normalizers
+                'api_error_resource' => true,
+                'ignored_attributes' => [
+                    'trace',
+                    'file',
+                    'line',
+                    'code',
+                    'message',
+                    'traceAsString',
+                ],
+            ]);
+
             return true;
         }), HttpKernelInterface::SUB_REQUEST, false)->willReturn(new Response());
         $request = Request::create('/');