Expose query complexity score in BuildExtensionsResponse

CHANGELOG.md

@@ -9,6 +9,12 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+## v6.52.0
+
+### Added
+
+- Expose query complexity score in lifecycle event `BuildExtensionsResponse` https://github.com/nuwave/lighthouse/pull/2637
+
 ## v6.51.2
 
 ### Fixed

docs/6/api-reference/events.md

@@ -175,31 +175,35 @@ class StartExecution
 ### BuildExtensionsResponse
 
 ```php
+use GraphQL\Executor\ExecutionResult;
+
 /**
  * Fires after a query was resolved.
  *
  * Listeners may return a @see \Nuwave\Lighthouse\Execution\ExtensionsResponse
  * to include in the response.
  */
-class BuildExtensionsResponse {}
+class BuildExtensionsResponse
+{
+    public function __construct(
+        /** The result of resolving a single operation. */
+        public ExecutionResult $result,
+        /** The calculated query complexity score of the operation, only available if the validation rule is enabled. */
+        public ?int $queryComplexity,
+    ) {}
+}
 ```
 
 ```php
 namespace Nuwave\Lighthouse\Execution;
 
-/**
- * May be returned from listeners of @see \Nuwave\Lighthouse\Events\BuildExtensionsResponse.
- */
+/** May be returned from listeners of @see \Nuwave\Lighthouse\Events\BuildExtensionsResponse. */
 class ExtensionsResponse
 {
     public function __construct(
-        /**
-         * Will be used as the key in the response map.
-         */
+        /** Will be used as the key in the response map. */
         public string $key,
-        /**
-         * JSON-encodable content of the extension.
-         */
+        /** JSON-encodable content of the extension. */
         public mixed $content,
     ) {}
 }

docs/master/api-reference/events.md

@@ -175,31 +175,35 @@ class StartExecution
 ### BuildExtensionsResponse
 
 ```php
+use GraphQL\Executor\ExecutionResult;
+
 /**
  * Fires after a query was resolved.
  *
  * Listeners may return a @see \Nuwave\Lighthouse\Execution\ExtensionsResponse
  * to include in the response.
  */
-class BuildExtensionsResponse {}
+class BuildExtensionsResponse
+{
+    public function __construct(
+        /** The result of resolving a single operation. */
+        public ExecutionResult $result,
+        /** The calculated query complexity score of the operation, only available if the validation rule is enabled. */
+        public ?int $queryComplexity,
+    ) {}
+}
 ```
 
 ```php
 namespace Nuwave\Lighthouse\Execution;
 
-/**
- * May be returned from listeners of @see \Nuwave\Lighthouse\Events\BuildExtensionsResponse.
- */
+/** May be returned from listeners of @see \Nuwave\Lighthouse\Events\BuildExtensionsResponse. */
 class ExtensionsResponse
 {
     public function __construct(
-        /**
-         * Will be used as the key in the response map.
-         */
+        /** Will be used as the key in the response map. */
         public string $key,
-        /**
-         * JSON-encodable content of the extension.
-         */
+        /** JSON-encodable content of the extension. */
         public mixed $content,
     ) {}
 }

src/Events/BuildExtensionsResponse.php

@@ -15,5 +15,7 @@ class BuildExtensionsResponse
     public function __construct(
         /** The result of resolving a single operation. */
         public ExecutionResult $result,
+        /** The calculated query complexity score of the operation, only available if the validation rule is enabled. */
+        public ?int $queryComplexity,
     ) {}
 }

src/Execution/ExtensionsResponse.php

@@ -2,19 +2,13 @@
 
 namespace Nuwave\Lighthouse\Execution;
 
-/**
- * May be returned from listeners of @see \Nuwave\Lighthouse\Events\BuildExtensionsResponse.
- */
+/** May be returned from listeners of @see \Nuwave\Lighthouse\Events\BuildExtensionsResponse. */
 class ExtensionsResponse
 {
     public function __construct(
-        /**
-         * Will be used as the key in the response map.
-         */
+        /** Will be used as the key in the response map. */
         public string $key,
-        /**
-         * JSON-encodable content of the extension.
-         */
+        /** JSON-encodable content of the extension. */
         public mixed $content,
     ) {}
 }

src/GraphQL.php

@@ -137,14 +137,16 @@ public function executeParsedQueryRaw(
         );
 
         if ($this->providesValidationRules instanceof CacheableValidationRulesProvider) {
-            $validationRules = $this->providesValidationRules->cacheableValidationRules();
+            $cacheableValidationRules = $this->providesValidationRules->cacheableValidationRules();
 
-            $errors = $this->validateCacheableRules($validationRules, $schema, $this->schemaBuilder->schemaHash(), $query, $queryHash);
+            $errors = $this->validateCacheableRules($cacheableValidationRules, $schema, $this->schemaBuilder->schemaHash(), $query, $queryHash);
             if ($errors !== []) {
                 return new ExecutionResult(null, $errors);
             }
         }
 
+        $validationRules = $this->providesValidationRules->validationRules();
+
         $result = GraphQLBase::executeQuery(
             $schema,
             $query,
@@ -153,12 +155,19 @@ public function executeParsedQueryRaw(
             $variables,
             $operationName,
             null,
-            $this->providesValidationRules->validationRules(),
+            $validationRules,
         );
 
+        $queryComplexityRule = $validationRules[QueryComplexity::class] ?? null;
+        $queryComplexity = $queryComplexityRule instanceof QueryComplexity
+            // TODO remove this check when updating the required version of webonyx/graphql-php
+            && method_exists($queryComplexityRule, 'getQueryComplexity')
+            ? $queryComplexityRule->getQueryComplexity()
+            : null;
+
         /** @var array<\Nuwave\Lighthouse\Execution\ExtensionsResponse|null> $extensionsResponses */
         $extensionsResponses = (array) $this->eventDispatcher->dispatch(
-            new BuildExtensionsResponse($result),
+            new BuildExtensionsResponse($result, $queryComplexity),
         );
 
         foreach ($extensionsResponses as $extensionsResponse) {

tests/Unit/Schema/Directives/ComplexityDirectiveTest.php

@@ -4,6 +4,8 @@
 
 use GraphQL\Validator\Rules\QueryComplexity;
 use Illuminate\Contracts\Config\Repository as ConfigRepository;
+use Illuminate\Contracts\Events\Dispatcher as EventsDispatcher;
+use Nuwave\Lighthouse\Events\BuildExtensionsResponse;
 use Tests\TestCase;
 use Tests\Utils\Queries\Foo;
 
@@ -13,6 +15,14 @@ final class ComplexityDirectiveTest extends TestCase
 
     public function testDefaultComplexity(): void
     {
+        $eventsDispatcher = $this->app->make(EventsDispatcher::class);
+
+        /** @var array<int, BuildExtensionsResponse> $events */
+        $events = [];
+        $eventsDispatcher->listen(BuildExtensionsResponse::class, static function (BuildExtensionsResponse $event) use (&$events): void {
+            $events[] = $event;
+        });
+
         $max = 1;
         $this->setMaxQueryComplexity($max);
 
@@ -33,6 +43,14 @@ public function testDefaultComplexity(): void
             }
         }
         ')->assertGraphQLErrorMessage(QueryComplexity::maxQueryComplexityErrorMessage($max, 2));
+
+        $this->assertCount(1, $events);
+
+        // TODO remove this check when updating the required version of webonyx/graphql-php
+        if (method_exists(QueryComplexity::class, 'getQueryComplexity')) {
+            $event = $events[0];
+            $this->assertSame(2, $event->queryComplexity);
+        }
     }
 
     public function testKnowsPagination(): void