Add configuration option parse_source_location

CHANGELOG.md

@@ -9,6 +9,10 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+### Added
+
+- Add configuration option `parse_source_location` https://github.com/nuwave/lighthouse/pull/2499
+
 ## v6.29.1
 
 ### Fixed

src/GraphQL.php

@@ -245,7 +245,7 @@ public function parse(string $query): DocumentNode
         $cacheConfig = $this->configRepository->get('lighthouse.query_cache');
 
         if (! $cacheConfig['enable']) {
-            return Parser::parse($query);
+            return $this->parseQuery($query);
         }
 
         $cacheFactory = Container::getInstance()->make(CacheFactory::class);
@@ -256,7 +256,7 @@ public function parse(string $query): DocumentNode
         return $store->remember(
             "lighthouse:query:{$sha256}",
             $cacheConfig['ttl'],
-            static fn (): DocumentNode => Parser::parse($query),
+            fn (): DocumentNode => $this->parseQuery($query),
         );
     }
 
@@ -353,4 +353,11 @@ protected function cleanUpAfterExecution(): void
         FieldValue::clear();
         $this->errorPool->clear();
     }
+
+    protected function parseQuery(string $query): DocumentNode
+    {
+        return Parser::parse($query, [
+            'noLocation' => ! $this->configRepository->get('lighthouse.parse_source_location'),
+        ]);
+    }
 }

src/WhereConditions/WhereConditionsHandler.php

@@ -95,7 +95,7 @@ public function handleHasCondition(
                             $builder->getModel(),
                         );
                     }
-                    : null,
+                : null,
                 $operator,
                 $amount,
             )

src/lighthouse.php

@@ -134,6 +134,19 @@
         'ttl' => env('LIGHTHOUSE_QUERY_CACHE_TTL', 24 * 60 * 60),
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Parse source location
+    |--------------------------------------------------------------------------
+    |
+    | Should the source location be included in the AST nodes resulting from query parsing?
+    | Setting this to `false` improves performance, but omits the key `locations` from errors,
+    | see https://spec.graphql.org/October2021/#sec-Errors.Error-result-format.
+    |
+    */
+
+    'parse_source_location' => true,
+
     /*
     |--------------------------------------------------------------------------
     | Namespaces

tests/Integration/ErrorTest.php

@@ -48,8 +48,12 @@ public function testRejectsInvalidQuery(): void
         );
     }
 
-    public function testReturnsFullGraphQLError(): void
+    /** @dataProvider parseSourceLocations */
+    public function testReturnsFullGraphQLError(bool $parseSourceLocations): void
     {
+        $config = $this->app->make(ConfigRepository::class);
+        $config->set('lighthouse.parse_source_location', $parseSourceLocations);
+
         $message = 'some error';
         $this->mockResolver(static fn (): Error => new Error($message));
 
@@ -59,7 +63,7 @@ public function testReturnsFullGraphQLError(): void
         }
         ';
 
-        $this
+        $response = $this
             ->graphQL(/** @lang GraphQL */ <<<'GRAPHQL'
             {
                 foo
@@ -74,15 +78,26 @@ public function testReturnsFullGraphQLError(): void
                     [
                         'message' => $message,
                         'path' => ['foo'],
-                        'locations' => [
-                            [
-                                'line' => 2,
-                                'column' => 5,
-                            ],
-                        ],
                     ],
                 ],
             ]);
+
+        $locationsJsonPath = 'errors.0.locations';
+        $parseSourceLocations
+            ? $response->json($locationsJsonPath) === [
+                [
+                    'line' => 2,
+                    'column' => 5,
+                ],
+            ]
+            : $response->assertJsonMissingPath($locationsJsonPath);
+    }
+
+    /** @return iterable<array{bool}> */
+    public static function parseSourceLocations(): iterable
+    {
+        yield [true];
+        yield [false];
     }
 
     public function testIgnoresInvalidJSONVariables(): void

tests/Integration/Validation/ValidationTest.php

@@ -90,6 +90,45 @@ public function testFullValidationError(): void
             ]);
     }
 
+    public function testFullValidationErrorWithoutLocationParse(): void
+    {
+        $config = $this->app->make(ConfigRepository::class);
+        $config->set('lighthouse.parse_source_location', false);
+
+        $this->schema = /** @lang GraphQL */ '
+        type Query {
+            foo(
+                bar: String @rules(apply: ["required"])
+            ): Int
+        }
+        ';
+
+        $this
+            ->graphQL(/** @lang GraphQL */ '
+            {
+                foo
+            }
+            ')
+            ->assertExactJson([
+                'errors' => [
+                    [
+                        'message' => 'Validation failed for the field [foo].',
+                        'extensions' => [
+                            ValidationException::KEY => [
+                                'bar' => [
+                                    'The bar field is required.',
+                                ],
+                            ],
+                        ],
+                        'path' => ['foo'],
+                    ],
+                ],
+                'data' => [
+                    'foo' => null,
+                ],
+            ]);
+    }
+
     public function testRunsOnNonRootFields(): void
     {
         $this->schema = /** @lang GraphQL */ '