Fix #161 (#163)

* Using the default formatError function from graphql-php

* Fix tests

* Passing errors through laravel's Error Handling mechanism

Author: living42

src/Rebing/GraphQL/GraphQL.php

@@ -1,12 +1,15 @@
 <?php namespace Rebing\GraphQL;
 
+use GraphQL\Error\Debug;
 use GraphQL\Error\Error;
 use Rebing\GraphQL\Error\ValidationError;
 use GraphQL\GraphQL as GraphQLBase;
 use GraphQL\Type\Schema;
+use GraphQL\Error\FormattedError;
 use GraphQL\Type\Definition\ObjectType;
 use Rebing\GraphQL\Exception\SchemaNotFound;
 use Rebing\GraphQL\Support\PaginationType;
+use Illuminate\Contracts\Debug\ExceptionHandler;
 
 class GraphQL {
     protected $app;
@@ -84,21 +87,7 @@ public function schema($schema = null)
      */
     public function query($query, $params = [], $opts = [])
     {
-        $executionResult = $this->queryAndReturnResult($query, $params, $opts);
-
-        $data = [
-            'data' => $executionResult->data,
-        ];
-
-        // Add errors
-        if( ! empty($executionResult->errors))
-        {
-            $errorFormatter = config('graphql.error_formatter', ['\Rebing\GraphQL', 'formatError']);
-
-            $data['errors'] = array_map($errorFormatter, $executionResult->errors);
-        }
-
-        return $data;
+        return $this->queryAndReturnResult($query, $params, $opts)->toArray();
     }
 
     public function queryAndReturnResult($query, $params = [], $opts = [])
@@ -109,7 +98,12 @@ public function queryAndReturnResult($query, $params = [], $opts = [])
 
         $schema = $this->schema($schemaName);
 
-        $result = GraphQLBase::executeQuery($schema, $query, null, $context, $params, $operationName);
+        $errorFormatter = config('graphql.error_formatter', [static::class, 'formatError']);
+        $errorsHandler = config('grahpql.errors_handler', [static::class, 'handleErrors']);
+
+        $result = GraphQLBase::executeQuery($schema, $query, null, $context, $params, $operationName)
+            ->setErrorsHandler($errorsHandler)
+            ->setErrorFormatter($errorFormatter);
         return $result;
     }
 
@@ -282,18 +276,9 @@ public function paginate($typeName, $customName = null)
 
     public static function formatError(Error $e)
     {
-        $error = [
-            'message' => $e->getMessage()
-        ];
-
-        $locations = $e->getLocations();
-        if(!empty($locations))
-        {
-            $error['locations'] = array_map(function($loc)
-            {
-                return $loc->toArray();
-            }, $locations);
-        }
+        $debug = config('app.debug') ? (Debug::INCLUDE_DEBUG_MESSAGE | Debug::INCLUDE_TRACE) : 0;
+        $formatter = FormattedError::prepareFormatter(null, $debug);
+        $error = $formatter($e);
 
         $previous = $e->getPrevious();
         if($previous && $previous instanceof ValidationError)
@@ -304,6 +289,20 @@ public static function formatError(Error $e)
         return $error;
     }
 
+    public static function handleErrors(array $errors, callable $formatter)
+    {
+        $handler = app()->make(ExceptionHandler::class);
+        foreach ($errors as $error) {
+            // Try to unwrap exception
+            $error = $error->getPrevious() ?: $error;
+            if ($error instanceof \GraphQL\Error\Error) {
+                continue;
+            }
+            $handler->report($error);
+        }
+        return array_map($formatter, $errors);
+    }
+
     /**
      * Check if the schema expects a nest URI name and return the formatted version
      * Eg. 'user/me'

src/config/config.php

@@ -133,6 +133,15 @@
     // ]
     'error_formatter' => ['\Rebing\GraphQL\GraphQL', 'formatError'],
 
+    /**
+     * Custom Error Handling
+     *
+     * Expected handler signature is: function (array $errors, callable $formatter): array
+     *
+     * The default handler will pass exceptions to laravel Error Handling mechanism
+     */
+    'errors_handler' => ['\Rebing\GraphQL\GraphQL', 'handleErrors'],
+
     // You can set the key, which will be used to retrieve the dynamic variables
     'params_key'    => 'variables',
 

tests/GraphQLQueryTest.php

@@ -96,15 +96,15 @@ public function testQueryAndReturnResultWithSchema()
     /**
      * Test query with error
      *
+     * If an error was encountered before execution begins, the data entry should not be present in the result.
+     *
      * @test
      */
     public function testQueryWithError()
     {
         $result = GraphQL::query($this->queries['examplesWithError']);
 
-        $this->assertArrayHasKey('data', $result);
         $this->assertArrayHasKey('errors', $result);
-        $this->assertNull($result['data']);
         $this->assertCount(1, $result['errors']);
         $this->assertArrayHasKey('message', $result['errors'][0]);
         $this->assertArrayHasKey('locations', $result['errors'][0]);

tests/GraphQLTest.php

@@ -183,6 +183,7 @@ public function testFormatError()
         $this->assertArrayHasKey('locations', $error);
         $this->assertEquals($error, [
             'message' => 'Cannot query field "examplesQueryNotFound" on type "Query".',
+            'category' => 'graphql',
             'locations' => [
                 [
                     'line' => 3,