fix(symfony): disable symfony error handling by default

Author: soyuka

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -232,6 +232,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
         $container->setParameter('api_platform.collection.pagination.items_per_page_parameter_name', $config['defaults']['pagination_items_per_page_parameter_name'] ?? $config['collection']['pagination']['items_per_page_parameter_name']);
         $container->setParameter('api_platform.collection.pagination.partial_parameter_name', $config['defaults']['pagination_partial_parameter_name'] ?? $config['collection']['pagination']['partial_parameter_name']);
         $container->setParameter('api_platform.collection.pagination', $this->getPaginationDefaults($config['defaults'] ?? [], $config['collection']['pagination']));
+        $container->setParameter('api_platform.handle_symfony_errors', $config['handle_symfony_errors'] ?? false);
         $container->setParameter('api_platform.http_cache.etag', $config['defaults']['cache_headers']['etag'] ?? true);
         $container->setParameter('api_platform.http_cache.max_age', $config['defaults']['cache_headers']['max_age'] ?? null);
         $container->setParameter('api_platform.http_cache.shared_max_age', $config['defaults']['cache_headers']['shared_max_age'] ?? null);

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -103,6 +103,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->booleanNode('force_eager')->defaultTrue()->info('Force join on every relation. If disabled, it will only join relations having the EAGER fetch mode.')->end()
                     ->end()
                 ->end()
+                ->booleanNode('handle_symfony_errors')->defaultFalse()->info('Allows to handle symfony exceptions.')->end()
                 ->booleanNode('enable_swagger')->defaultTrue()->info('Enable the Swagger documentation and export.')->end()
                 ->booleanNode('enable_swagger_ui')->defaultValue(class_exists(TwigBundle::class))->info('Enable Swagger UI')->end()
                 ->booleanNode('enable_re_doc')->defaultValue(class_exists(TwigBundle::class))->info('Enable ReDoc')->end()

src/Symfony/Bundle/Resources/config/symfony/events.xml

@@ -6,6 +6,7 @@
     <services>
         <service id="api_platform.listener.exception" class="ApiPlatform\Symfony\EventListener\ExceptionListener">
             <argument type="service" id="api_platform.error_listener" on-invalid="null" />
+            <argument>%api_platform.handle_symfony_errors%</argument>
 
             <tag name="kernel.event_listener" event="kernel.exception" method="onKernelException" priority="-96" />
             <tag name="monolog.logger" channel="request" />

src/Symfony/EventListener/ExceptionListener.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Symfony\EventListener;
 
 use ApiPlatform\Metadata\Error;
+use ApiPlatform\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\EventListener\ErrorListener;
 
@@ -25,13 +26,22 @@
  */
 final class ExceptionListener
 {
-    public function __construct(private readonly ErrorListener $errorListener)
+    public function __construct(private readonly ErrorListener $errorListener, public bool $handleSymfonyErrors = false)
     {
     }
 
     public function onKernelException(ExceptionEvent $event): void
     {
         $request = $event->getRequest();
+
+        // Normalize exceptions only for routes managed by API Platform
+        if (
+            false === $this->handleSymfonyErrors &&
+            !((RequestAttributesExtractor::extractAttributes($request)['respond'] ?? $request->attributes->getBoolean('_api_respond', false)) || $request->attributes->getBoolean('_graphql', false))
+        ) {
+            return;
+        }
+
         // Don't loop on errors leave it to Symfony as we could not handle this properly
         if (($operation = $request->attributes->get('_api_operation')) && $operation instanceof Error) {
             return;

tests/Fixtures/app/config/config_common.yml

@@ -73,6 +73,7 @@ api_platform:
         Symfony\Component\Serializer\Exception\ExceptionInterface: !php/const Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST
         ApiPlatform\Exception\InvalidArgumentException: !php/const Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST
         ApiPlatform\Exception\FilterValidationException: !php/const Symfony\Component\HttpFoundation\Response::HTTP_BAD_REQUEST
+    handle_symfony_errors: true
     http_cache:
         invalidation:
             enabled: true