Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to detect unused variables #660

Merged
merged 13 commits into from
Apr 14, 2021
22 changes: 22 additions & 0 deletions src/GraphQL.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use GraphQL\Error\FormattedError;
use GraphQL\Executor\ExecutionResult;
use GraphQL\GraphQL as GraphQLBase;
use GraphQL\Language\AST\OperationDefinitionNode;
use GraphQL\Language\Parser;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Schema;
Expand Down Expand Up @@ -144,6 +146,26 @@ public function queryAndReturnResult(string $query, ?array $params = [], array $
$errorFormatter = config('graphql.error_formatter', [static::class, 'formatError']);
$errorsHandler = config('graphql.errors_handler', [static::class, 'handleErrors']);
$defaultFieldResolver = config('graphql.defaultFieldResolver', null);
$detectUnusedVariables = config('graphql.detect_unused_variables', false);

if ($params && $detectUnusedVariables) {
$unusedVariables = $params;
$query = Parser::parse($query);
mfn marked this conversation as resolved.
Show resolved Hide resolved
foreach ($query->definitions as $definition) {
if ($definition instanceof OperationDefinitionNode) {
foreach ($definition->variableDefinitions as $variableDefinition) {
unset($unusedVariables[$variableDefinition->variable->name->value]);
}
}
}

if ($unusedVariables) {
$msg = sprintf('The following variables were provided but not consumed: %s',
implode(', ', array_keys($unusedVariables))
);
return new ExecutionResult(null, [new Error($msg)]);
}
}

$result = GraphQLBase::executeQuery($schema, $query, $rootValue, $context, $params, $operationName, $defaultFieldResolver)
->setErrorsHandler($errorsHandler)
Expand Down