Adding GraphQL custom error format support

Author: mahmoodbazdar

features/graphql/mutation.feature

@@ -332,7 +332,12 @@ Feature: GraphQL mutation support
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json"
-    And the JSON node "errors[0].message" should be equal to "name: This value should not be blank."
+    And the JSON node "errors[0].status" should be equal to "400"
+    And the JSON node "errors[0].message" should be equal to "Validation Exception"
+    And the JSON node "errors[0].violations" should exist
+    And the JSON node "errors[0].violations[0].path" should be equal to "name"
+    And the JSON node "errors[0].violations[0].message" should be equal to "This value should not be blank."
+
 
   Scenario: Execute a custom mutation
     Given there are 1 dummyCustomMutation objects

src/Bridge/Symfony/Bundle/ApiPlatformBundle.php

@@ -17,12 +17,12 @@
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\DataProviderPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\ElasticsearchClientPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\FilterPass;
+use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\GraphQlExceptionFormatterPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\GraphQlMutationResolverPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\GraphQlQueryResolverPass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\GraphQlTypePass;
 use ApiPlatform\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler\MetadataAwareNameConverterPass;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
-use Symfony\Component\DependencyInjection\Compiler\ResolveInstanceofConditionalsPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -48,6 +48,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new GraphQlTypePass());
         $container->addCompilerPass(new GraphQlQueryResolverPass());
         $container->addCompilerPass(new GraphQlMutationResolverPass());
+        $container->addCompilerPass(new GraphQlExceptionFormatterPass());
         $container->addCompilerPass(new MetadataAwareNameConverterPass());
     }
 }

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -28,6 +28,7 @@
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
 use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
 use ApiPlatform\Core\DataTransformer\DataTransformerInterface;
+use ApiPlatform\Core\GraphQl\Exception\ExceptionFormatterInterface;
 use ApiPlatform\Core\GraphQl\Resolver\MutationResolverInterface;
 use ApiPlatform\Core\GraphQl\Resolver\QueryCollectionResolverInterface;
 use ApiPlatform\Core\GraphQl\Resolver\QueryItemResolverInterface;
@@ -395,6 +396,8 @@ private function registerGraphQlConfiguration(ContainerBuilder $container, array
             ->addTag('api_platform.graphql.mutation_resolver');
         $container->registerForAutoconfiguration(GraphQlTypeInterface::class)
             ->addTag('api_platform.graphql.type');
+        $container->registerForAutoconfiguration(ExceptionFormatterInterface::class)
+            ->addTag('api_platform.graphql.exception_formatter');
     }
 
     private function registerLegacyBundlesConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader): void

src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/GraphQlExceptionFormatterPass.php

@@ -0,0 +1,47 @@
+<?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\Core\Bridge\Symfony\Bundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * Injects GraphQL Exception formatters.
+ *
+ * @internal
+ *
+ * @author Mahmood Bazdar <[email protected]>
+ */
+class GraphQlExceptionFormatterPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->getParameter('api_platform.graphql.enabled')) {
+            return;
+        }
+
+        $formatters = [];
+        foreach ($container->findTaggedServiceIds('api_platform.graphql.exception_formatter', true) as $serviceId => $tags) {
+            foreach ($tags as $tag) {
+                $formatters[$tag['id'] ?? $serviceId] = new Reference($serviceId);
+            }
+        }
+        $container->getDefinition('api_platform.graphql.exception_formatter_locator')->addArgument($formatters);
+        $container->getDefinition('api_platform.graphql.exception_formatter_factory')->addArgument(array_keys($formatters));
+    }
+}

src/Bridge/Symfony/Bundle/Resources/config/graphql.xml

@@ -152,14 +152,26 @@
             <argument type="service" id="api_platform.graphql.types_container" />
             <argument type="service" id="api_platform.graphql.fields_builder" />
         </service>
+        <!-- Exception formatter -->
+        <service id="api_platform.graphql.validation_exception_formatter" class="ApiPlatform\Core\GraphQl\Exception\Formatter\ValidationExceptionFormatter">
+            <tag name="api_platform.graphql.exception_formatter" />
+        </service>
 
+        <service id="api_platform.graphql.exception_formatter_locator" class="Symfony\Component\DependencyInjection\ServiceLocator">
+            <tag name="container.service_locator" />
+        </service>
+
+        <service id="api_platform.graphql.exception_formatter_factory" class="ApiPlatform\Core\GraphQl\Exception\ExceptionFormatterFactory">
+            <argument type="service" id="api_platform.graphql.exception_formatter_locator" />
+        </service>
         <!-- Action -->
 
         <service id="api_platform.graphql.action.entrypoint" class="ApiPlatform\Core\GraphQl\Action\EntrypointAction" public="true">
             <argument type="service" id="api_platform.graphql.schema_builder" />
             <argument type="service" id="api_platform.graphql.executor" />
             <argument type="service" id="api_platform.graphql.action.graphiql" />
             <argument type="service" id="api_platform.graphql.action.graphql_playground" />
+            <argument type="service" id="api_platform.graphql.exception_formatter_factory" />
             <argument>%kernel.debug%</argument>
             <argument>%api_platform.graphql.graphiql.enabled%</argument>
             <argument>%api_platform.graphql.graphql_playground.enabled%</argument>

src/GraphQl/Action/EntrypointAction.php

@@ -13,10 +13,13 @@
 
 namespace ApiPlatform\Core\GraphQl\Action;
 
+use ApiPlatform\Core\GraphQl\Exception\ExceptionFormatterFactory;
+use ApiPlatform\Core\GraphQl\Exception\ExceptionFormatterInterface;
 use ApiPlatform\Core\GraphQl\ExecutorInterface;
 use ApiPlatform\Core\GraphQl\Type\SchemaBuilderInterface;
 use GraphQL\Error\Debug;
 use GraphQL\Error\Error;
+use GraphQL\Error\FormattedError;
 use GraphQL\Executor\ExecutionResult;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -37,8 +40,9 @@ final class EntrypointAction
     private $graphiqlEnabled;
     private $graphQlPlaygroundEnabled;
     private $defaultIde;
+    private $exceptionFormatterFactory;
 
-    public function __construct(SchemaBuilderInterface $schemaBuilder, ExecutorInterface $executor, GraphiQlAction $graphiQlAction, GraphQlPlaygroundAction $graphQlPlaygroundAction, bool $debug = false, bool $graphiqlEnabled = false, bool $graphQlPlaygroundEnabled = false, $defaultIde = false)
+    public function __construct(SchemaBuilderInterface $schemaBuilder, ExecutorInterface $executor, GraphiQlAction $graphiQlAction, GraphQlPlaygroundAction $graphQlPlaygroundAction, ExceptionFormatterFactory $exceptionFormatterFactory, bool $debug = false, bool $graphiqlEnabled = false, bool $graphQlPlaygroundEnabled = false, $defaultIde = false)
     {
         $this->schemaBuilder = $schemaBuilder;
         $this->executor = $executor;
@@ -48,6 +52,7 @@ public function __construct(SchemaBuilderInterface $schemaBuilder, ExecutorInter
         $this->graphiqlEnabled = $graphiqlEnabled;
         $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
         $this->defaultIde = $defaultIde;
+        $this->exceptionFormatterFactory = $exceptionFormatterFactory;
     }
 
     public function __invoke(Request $request): Response
@@ -73,7 +78,30 @@ public function __invoke(Request $request): Response
         }
 
         try {
-            $executionResult = $this->executor->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operation);
+            $executionResult = $this->executor->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operation)
+              ->setErrorFormatter(function (Error $error) {
+                  $formatters = $this->exceptionFormatterFactory->getExceptionFormatters();
+                  usort($formatters, function ($a, $b) {
+                      /**
+                       * @var ExceptionFormatterInterface
+                       * @var ExceptionFormatterInterface $b
+                       */
+                      if ($a->getPriority() == $b->getPriority()) {
+                          return 0;
+                      }
+
+                      return ($a->getPriority() > $b->getPriority()) ? -1 : 1;
+                  });
+                  /** @var ExceptionFormatterInterface $exceptionFormatter */
+                  foreach ($formatters as $exceptionFormatter) {
+                      if (null !== $error->getPrevious() && $exceptionFormatter->supports($error->getPrevious())) {
+                          return $exceptionFormatter->format($error);
+                      }
+                  }
+
+                  // falling back to default GraphQL error formatter
+                  return FormattedError::createFromException($error);
+              });
         } catch (\Exception $e) {
             $executionResult = new ExecutionResult(null, [new Error($e->getMessage(), null, null, null, null, $e)]);
         }

src/GraphQl/Exception/ExceptionFormatterFactory.php

@@ -0,0 +1,50 @@
+<?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\Core\GraphQl\Exception;
+
+use ApiPlatform\Core\GraphQl\Type\Definition\TypeInterface;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Get the registered services corresponding to GraphQL exception formatters.
+ *
+ * @author Mahmood Bazdar <[email protected]>
+ */
+class ExceptionFormatterFactory implements ExceptionFormatterFactoryInterface
+{
+    private $exceptionFormatterLocator;
+    private $exceptionFormatterIds;
+
+    /**
+     * @param string[] $exceptionFormatterIds
+     */
+    public function __construct(ContainerInterface $exceptionFormatterLocator, array $exceptionFormatterIds)
+    {
+        $this->exceptionFormatterLocator = $exceptionFormatterLocator;
+        $this->exceptionFormatterIds = $exceptionFormatterIds;
+    }
+
+    public function getExceptionFormatters(): array
+    {
+        $exceptionFormatters = [];
+
+        foreach ($this->exceptionFormatterIds as $exceptionFormatterId) {
+            /** @var TypeInterface $exceptionFormatter */
+            $exceptionFormatter = $this->exceptionFormatterLocator->get($exceptionFormatterId);
+            $exceptionFormatters[$exceptionFormatterId] = $exceptionFormatter;
+        }
+
+        return $exceptionFormatters;
+    }
+}

src/GraphQl/Exception/ExceptionFormatterFactoryInterface.php

@@ -0,0 +1,24 @@
+<?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\Core\GraphQl\Exception;
+
+/**
+ * Get Exception formatters.
+ *
+ * @author Mahmood Bazdar <[email protected]>
+ */
+interface ExceptionFormatterFactoryInterface
+{
+    public function getExceptionFormatters(): array;
+}

src/GraphQl/Exception/ExceptionFormatterInterface.php

@@ -0,0 +1,39 @@
+<?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\Core\GraphQl\Exception;
+
+use GraphQL\Error\Error;
+
+/**
+ * @expremintal
+ *
+ * @author Mahmood Bazdar <[email protected]>
+ */
+interface ExceptionFormatterInterface
+{
+    /**
+     * Formats the exception and returns the formatted array.
+     */
+    public function format(Error $error): array;
+
+    /**
+     * Check the exception, return true if you can format the exception.
+     */
+    public function supports(\Throwable $exception): bool;
+
+    /**
+     * Priority of your formatter in container. Higher number will be called sooner.
+     */
+    public function getPriority(): int;
+}

src/GraphQl/Exception/Formatter/ValidationExceptionFormatter.php

@@ -0,0 +1,71 @@
+<?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\Core\GraphQl\Exception\Formatter;
+
+use ApiPlatform\Core\Bridge\Symfony\Validator\Exception\ValidationException;
+use ApiPlatform\Core\GraphQl\Exception\ExceptionFormatterInterface;
+use GraphQL\Error\Error;
+use GraphQL\Error\FormattedError;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Validator\ConstraintViolation;
+
+/**
+ * Formats Validation exception.
+ *
+ * @author Mahmood Bazdar <[email protected]>
+ */
+class ValidationExceptionFormatter implements ExceptionFormatterInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function format(Error $error): array
+    {
+        /**
+         * @var ValidationException
+         */
+        $validationException = $error->getPrevious();
+        $error = FormattedError::createFromException($error);
+        $error['message'] = $validationException->getMessage();
+        $error['status'] = Response::HTTP_BAD_REQUEST;
+        $error['extensions']['category'] = Error::CATEGORY_GRAPHQL;
+        $error['violations'] = [];
+
+        /** @var ConstraintViolation $violation */
+        foreach ($validationException->getConstraintViolationList() as $violation) {
+            $error['violations'][] = [
+                'path' => $violation->getPropertyPath(),
+                'message' => $violation->getMessage(),
+            ];
+        }
+
+        return $error;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports(\Throwable $exception): bool
+    {
+        return $exception instanceof ValidationException;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPriority(): int
+    {
+        return -100;
+    }
+}