[GraphQL] Adding custom error format support (#3063)

* Adding GraphQL custom error format support

* Use error normalizers

* Changing error format to follow GraphQL spec


Co-authored-by: Alan Poulain <[email protected]>

Author: mahmoodbazdar

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 2.6.x-dev
 
 * MongoDB: Possibility to add execute options (aggregate command fields) for a resource, like `allowDiskUse` (#3144)
+* GraphQL: Allow to format GraphQL errors based on exceptions (#3063)
 
 ## 2.5.1
 

features/graphql/authorization.feature

@@ -18,6 +18,8 @@ Feature: Authorization checking
     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].extensions.status" should be equal to 403
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "Access Denied."
 
   Scenario: An anonymous user tries to retrieve a secured collection
@@ -38,6 +40,8 @@ Feature: Authorization checking
     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].extensions.status" should be equal to 403
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "Access Denied."
 
   Scenario: An admin can retrieve a secured collection
@@ -79,6 +83,8 @@ Feature: Authorization checking
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json"
     And the JSON node "data.securedDummies" should be null
+    And the JSON node "errors[0].extensions.status" should be equal to 403
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "Access Denied."
 
   Scenario: An anonymous user tries to create a resource they are not allowed to
@@ -96,6 +102,8 @@ Feature: Authorization checking
     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].extensions.status" should be equal to 403
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "Only admins can create a secured dummy."
 
   @createSchema
@@ -151,6 +159,8 @@ Feature: Authorization checking
     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].extensions.status" should be equal to 403
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "Access Denied."
 
   Scenario: A user can retrieve an item they owns
@@ -186,6 +196,8 @@ Feature: Authorization checking
     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].extensions.status" should be equal to 403
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "Access Denied."
 
   Scenario: A user can update an item they owns and transfer it

features/graphql/introspection.feature

@@ -3,9 +3,11 @@ Feature: GraphQL introspection support
   @createSchema
   Scenario: Execute an empty GraphQL query
     When I send a "GET" request to "/graphql"
-    Then the response status code should be 400
+    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].extensions.status" should be equal to 400
+    And the JSON node "errors[0].extensions.category" should be equal to user
     And the JSON node "errors[0].message" should be equal to "GraphQL query is not valid."
 
   Scenario: Introspect the GraphQL schema

features/graphql/mutation.feature

@@ -674,7 +674,11 @@ 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].extensions.status" should be equal to "400"
     And the JSON node "errors[0].message" should be equal to "name: This value should not be blank."
+    And the JSON node "errors[0].extensions.violations" should exist
+    And the JSON node "errors[0].extensions.violations[0].path" should be equal to "name"
+    And the JSON node "errors[0].extensions.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/Resources/config/graphql.xml

@@ -167,6 +167,7 @@
             <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="serializer" />
             <argument>%kernel.debug%</argument>
             <argument>%api_platform.graphql.graphiql.enabled%</argument>
             <argument>%api_platform.graphql.graphql_playground.enabled%</argument>
@@ -217,6 +218,22 @@
             <tag name="serializer.normalizer" priority="-995" />
         </service>
 
+        <service id="api_platform.graphql.normalizer.error" class="ApiPlatform\Core\GraphQl\Serializer\Exception\ErrorNormalizer">
+            <tag name="serializer.normalizer" priority="-790" />
+        </service>
+
+        <service id="api_platform.graphql.normalizer.validation_exception" class="ApiPlatform\Core\GraphQl\Serializer\Exception\ValidationExceptionNormalizer">
+            <tag name="serializer.normalizer" priority="-780" />
+        </service>
+
+        <service id="api_platform.graphql.normalizer.http_exception" class="ApiPlatform\Core\GraphQl\Serializer\Exception\HttpExceptionNormalizer">
+            <tag name="serializer.normalizer" priority="-780" />
+        </service>
+
+        <service id="api_platform.graphql.normalizer.runtime_exception" class="ApiPlatform\Core\GraphQl\Serializer\Exception\RuntimeExceptionNormalizer">
+            <tag name="serializer.normalizer" priority="-780" />
+        </service>
+
         <service id="api_platform.graphql.serializer.context_builder" class="ApiPlatform\Core\GraphQl\Serializer\SerializerContextBuilder" public="false">
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />

src/GraphQl/Action/EntrypointAction.php

@@ -17,16 +17,18 @@
 use ApiPlatform\Core\GraphQl\Type\SchemaBuilderInterface;
 use GraphQL\Error\Debug;
 use GraphQL\Error\Error;
-use GraphQL\Error\UserError;
 use GraphQL\Executor\ExecutionResult;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * GraphQL API entrypoint.
  *
+ * @experimental
+ *
  * @author Alan Poulain <[email protected]>
  */
 final class EntrypointAction
@@ -35,17 +37,19 @@ final class EntrypointAction
     private $executor;
     private $graphiQlAction;
     private $graphQlPlaygroundAction;
+    private $normalizer;
     private $debug;
     private $graphiqlEnabled;
     private $graphQlPlaygroundEnabled;
     private $defaultIde;
 
-    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, NormalizerInterface $normalizer, bool $debug = false, bool $graphiqlEnabled = false, bool $graphQlPlaygroundEnabled = false, $defaultIde = false)
     {
         $this->schemaBuilder = $schemaBuilder;
         $this->executor = $executor;
         $this->graphiQlAction = $graphiQlAction;
         $this->graphQlPlaygroundAction = $graphQlPlaygroundAction;
+        $this->normalizer = $normalizer;
         $this->debug = $debug ? Debug::INCLUDE_DEBUG_MESSAGE | Debug::INCLUDE_TRACE : false;
         $this->graphiqlEnabled = $graphiqlEnabled;
         $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
@@ -54,29 +58,28 @@ public function __construct(SchemaBuilderInterface $schemaBuilder, ExecutorInter
 
     public function __invoke(Request $request): Response
     {
-        if ($request->isMethod('GET') && 'html' === $request->getRequestFormat()) {
-            if ('graphiql' === $this->defaultIde && $this->graphiqlEnabled) {
-                return ($this->graphiQlAction)($request);
-            }
+        try {
+            if ($request->isMethod('GET') && 'html' === $request->getRequestFormat()) {
+                if ('graphiql' === $this->defaultIde && $this->graphiqlEnabled) {
+                    return ($this->graphiQlAction)($request);
+                }
 
-            if ('graphql-playground' === $this->defaultIde && $this->graphQlPlaygroundEnabled) {
-                return ($this->graphQlPlaygroundAction)($request);
+                if ('graphql-playground' === $this->defaultIde && $this->graphQlPlaygroundEnabled) {
+                    return ($this->graphQlPlaygroundAction)($request);
+                }
             }
-        }
 
-        try {
             [$query, $operation, $variables] = $this->parseRequest($request);
             if (null === $query) {
                 throw new BadRequestHttpException('GraphQL query is not valid.');
             }
 
-            $executionResult = $this->executor->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operation);
-        } catch (BadRequestHttpException $e) {
-            $exception = new UserError($e->getMessage(), 0, $e);
-
-            return $this->buildExceptionResponse($exception, Response::HTTP_BAD_REQUEST);
-        } catch (\Exception $e) {
-            return $this->buildExceptionResponse($e, Response::HTTP_OK);
+            $executionResult = $this->executor
+                ->executeQuery($this->schemaBuilder->getSchema(), $query, null, null, $variables, $operation)
+                ->setErrorFormatter([$this->normalizer, 'normalize']);
+        } catch (\Exception $exception) {
+            $executionResult = (new ExecutionResult(null, [new Error($exception->getMessage(), null, null, null, null, $exception)]))
+                ->setErrorFormatter([$this->normalizer, 'normalize']);
         }
 
         return new JsonResponse($executionResult->toArray($this->debug));
@@ -207,11 +210,4 @@ private function decodeVariables(string $variables): array
 
         return $variables;
     }
-
-    private function buildExceptionResponse(\Exception $e, int $statusCode): JsonResponse
-    {
-        $executionResult = new ExecutionResult(null, [new Error($e->getMessage(), null, null, null, null, $e)]);
-
-        return new JsonResponse($executionResult->toArray($this->debug), $statusCode);
-    }
 }

src/GraphQl/Action/GraphQlPlaygroundAction.php

@@ -22,6 +22,8 @@
 /**
  * GraphQL Playground entrypoint.
  *
+ * @experimental
+ *
  * @author Alan Poulain <[email protected]>
  */
 final class GraphQlPlaygroundAction

src/GraphQl/Action/GraphiQlAction.php

@@ -22,6 +22,8 @@
 /**
  * GraphiQL entrypoint.
  *
+ * @experimental
+ *
  * @author Alan Poulain <[email protected]>
  */
 final class GraphiQlAction

src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php

@@ -24,7 +24,6 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Util\ClassInfoTrait;
 use ApiPlatform\Core\Util\CloneTrait;
-use GraphQL\Error\Error;
 use GraphQL\Type\Definition\ResolveInfo;
 use Psr\Container\ContainerInterface;
 
@@ -106,7 +105,7 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
                 $mutationResolver = $this->mutationResolverLocator->get($mutationResolverId);
                 $item = $mutationResolver($item, $resolverContext);
                 if (null !== $item && $resourceClass !== $itemClass = $this->getObjectClass($item)) {
-                    throw Error::createLocatedError(sprintf('Custom mutation resolver "%s" has to return an item of class %s but returned an item of class %s.', $mutationResolverId, $resourceMetadata->getShortName(), (new \ReflectionClass($itemClass))->getShortName()), $info->fieldNodes, $info->path);
+                    throw new \LogicException(sprintf('Custom mutation resolver "%s" has to return an item of class %s but returned an item of class %s.', $mutationResolverId, $resourceMetadata->getShortName(), (new \ReflectionClass($itemClass))->getShortName()));
                 }
             }
 

src/GraphQl/Resolver/Factory/ItemResolverFactory.php

@@ -21,7 +21,6 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Util\ClassInfoTrait;
 use ApiPlatform\Core\Util\CloneTrait;
-use GraphQL\Error\Error;
 use GraphQL\Type\Definition\ResolveInfo;
 use Psr\Container\ContainerInterface;
 
@@ -72,15 +71,15 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
                 throw new \LogicException('Item from read stage should be a nullable object.');
             }
 
-            $resourceClass = $this->getResourceClass($item, $resourceClass, $info);
+            $resourceClass = $this->getResourceClass($item, $resourceClass);
             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
 
             $queryResolverId = $resourceMetadata->getGraphqlAttribute($operationName, 'item_query');
             if (null !== $queryResolverId) {
                 /** @var QueryItemResolverInterface $queryResolver */
                 $queryResolver = $this->queryResolverLocator->get($queryResolverId);
                 $item = $queryResolver($item, $resolverContext);
-                $resourceClass = $this->getResourceClass($item, $resourceClass, $info, sprintf('Custom query resolver "%s"', $queryResolverId).' has to return an item of class %s but returned an item of class %s.');
+                $resourceClass = $this->getResourceClass($item, $resourceClass, sprintf('Custom query resolver "%s"', $queryResolverId).' has to return an item of class %s but returned an item of class %s.');
             }
 
             ($this->securityStage)($resourceClass, $operationName, $resolverContext + [
@@ -102,13 +101,13 @@ public function __invoke(?string $resourceClass = null, ?string $rootClass = nul
     /**
      * @param object|null $item
      *
-     * @throws Error
+     * @throws \UnexpectedValueException
      */
-    private function getResourceClass($item, ?string $resourceClass, ResolveInfo $info, string $errorMessage = 'Resolver only handles items of class %s but retrieved item is of class %s.'): string
+    private function getResourceClass($item, ?string $resourceClass, string $errorMessage = 'Resolver only handles items of class %s but retrieved item is of class %s.'): string
     {
         if (null === $item) {
             if (null === $resourceClass) {
-                throw Error::createLocatedError('Resource class cannot be determined.', $info->fieldNodes, $info->path);
+                throw new \UnexpectedValueException('Resource class cannot be determined.');
             }
 
             return $resourceClass;
@@ -121,7 +120,7 @@ private function getResourceClass($item, ?string $resourceClass, ResolveInfo $in
         }
 
         if ($resourceClass !== $itemClass) {
-            throw Error::createLocatedError(sprintf($errorMessage, (new \ReflectionClass($resourceClass))->getShortName(), (new \ReflectionClass($itemClass))->getShortName()), $info->fieldNodes, $info->path);
+            throw new \UnexpectedValueException(sprintf($errorMessage, (new \ReflectionClass($resourceClass))->getShortName(), (new \ReflectionClass($itemClass))->getShortName()));
         }
 
         return $resourceClass;