65 lines
2.2 KiB
PHP
65 lines
2.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace GraphQL\Validator\Rules;
|
|
|
|
use GraphQL\Error\Error;
|
|
use GraphQL\Language\AST\NodeKind;
|
|
use GraphQL\Language\AST\OperationDefinitionNode;
|
|
use GraphQL\Language\AST\VariableDefinitionNode;
|
|
use GraphQL\Validator\ValidationContext;
|
|
use function sprintf;
|
|
|
|
/**
|
|
* A GraphQL operation is only valid if all variables encountered, both directly
|
|
* and via fragment spreads, are defined by that operation.
|
|
*/
|
|
class NoUndefinedVariables extends ValidationRule
|
|
{
|
|
public function getVisitor(ValidationContext $context)
|
|
{
|
|
$variableNameDefined = [];
|
|
|
|
return [
|
|
NodeKind::OPERATION_DEFINITION => [
|
|
'enter' => static function () use (&$variableNameDefined) : void {
|
|
$variableNameDefined = [];
|
|
},
|
|
'leave' => static function (OperationDefinitionNode $operation) use (&$variableNameDefined, $context) : void {
|
|
$usages = $context->getRecursiveVariableUsages($operation);
|
|
|
|
foreach ($usages as $usage) {
|
|
$node = $usage['node'];
|
|
$varName = $node->name->value;
|
|
|
|
if ($variableNameDefined[$varName] ?? false) {
|
|
continue;
|
|
}
|
|
|
|
$context->reportError(new Error(
|
|
self::undefinedVarMessage(
|
|
$varName,
|
|
$operation->name !== null
|
|
? $operation->name->value
|
|
: null
|
|
),
|
|
[$node, $operation]
|
|
));
|
|
}
|
|
},
|
|
],
|
|
NodeKind::VARIABLE_DEFINITION => static function (VariableDefinitionNode $def) use (&$variableNameDefined) : void {
|
|
$variableNameDefined[$def->variable->name->value] = true;
|
|
},
|
|
];
|
|
}
|
|
|
|
public static function undefinedVarMessage($varName, $opName = null)
|
|
{
|
|
return $opName
|
|
? sprintf('Variable "$%s" is not defined by operation "%s".', $varName, $opName)
|
|
: sprintf('Variable "$%s" is not defined.', $varName);
|
|
}
|
|
}
|