116 lines
3.7 KiB
PHP
116 lines
3.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace GraphQL\Validator\Rules;
|
|
|
|
use GraphQL\Error\Error;
|
|
use GraphQL\Language\AST\DirectiveDefinitionNode;
|
|
use GraphQL\Language\AST\DirectiveNode;
|
|
use GraphQL\Language\AST\InputValueDefinitionNode;
|
|
use GraphQL\Language\AST\NodeKind;
|
|
use GraphQL\Language\Visitor;
|
|
use GraphQL\Language\VisitorOperation;
|
|
use GraphQL\Type\Definition\Directive;
|
|
use GraphQL\Type\Definition\FieldArgument;
|
|
use GraphQL\Utils\Utils;
|
|
use GraphQL\Validator\ASTValidationContext;
|
|
use GraphQL\Validator\SDLValidationContext;
|
|
use GraphQL\Validator\ValidationContext;
|
|
use function array_map;
|
|
use function in_array;
|
|
use function sprintf;
|
|
|
|
/**
|
|
* Known argument names on directives
|
|
*
|
|
* A GraphQL directive is only valid if all supplied arguments are defined by
|
|
* that field.
|
|
*/
|
|
class KnownArgumentNamesOnDirectives extends ValidationRule
|
|
{
|
|
/**
|
|
* @param string[] $suggestedArgs
|
|
*/
|
|
public static function unknownDirectiveArgMessage($argName, $directiveName, array $suggestedArgs)
|
|
{
|
|
$message = sprintf('Unknown argument "%s" on directive "@%s".', $argName, $directiveName);
|
|
if (isset($suggestedArgs[0])) {
|
|
$message .= sprintf(' Did you mean %s?', Utils::quotedOrList($suggestedArgs));
|
|
}
|
|
|
|
return $message;
|
|
}
|
|
|
|
public function getSDLVisitor(SDLValidationContext $context)
|
|
{
|
|
return $this->getASTVisitor($context);
|
|
}
|
|
|
|
public function getVisitor(ValidationContext $context)
|
|
{
|
|
return $this->getASTVisitor($context);
|
|
}
|
|
|
|
public function getASTVisitor(ASTValidationContext $context)
|
|
{
|
|
$directiveArgs = [];
|
|
$schema = $context->getSchema();
|
|
$definedDirectives = $schema !== null ? $schema->getDirectives() : Directive::getInternalDirectives();
|
|
|
|
foreach ($definedDirectives as $directive) {
|
|
$directiveArgs[$directive->name] = array_map(
|
|
static function (FieldArgument $arg) : string {
|
|
return $arg->name;
|
|
},
|
|
$directive->args
|
|
);
|
|
}
|
|
|
|
$astDefinitions = $context->getDocument()->definitions;
|
|
foreach ($astDefinitions as $def) {
|
|
if (! ($def instanceof DirectiveDefinitionNode)) {
|
|
continue;
|
|
}
|
|
|
|
$name = $def->name->value;
|
|
if ($def->arguments !== null) {
|
|
$directiveArgs[$name] = Utils::map(
|
|
$def->arguments ?? [],
|
|
static function (InputValueDefinitionNode $arg) : string {
|
|
return $arg->name->value;
|
|
}
|
|
);
|
|
} else {
|
|
$directiveArgs[$name] = [];
|
|
}
|
|
}
|
|
|
|
return [
|
|
NodeKind::DIRECTIVE => static function (DirectiveNode $directiveNode) use ($directiveArgs, $context) : VisitorOperation {
|
|
$directiveName = $directiveNode->name->value;
|
|
$knownArgs = $directiveArgs[$directiveName] ?? null;
|
|
|
|
if ($directiveNode->arguments === null || $knownArgs === null) {
|
|
return Visitor::skipNode();
|
|
}
|
|
|
|
foreach ($directiveNode->arguments as $argNode) {
|
|
$argName = $argNode->name->value;
|
|
if (in_array($argName, $knownArgs, true)) {
|
|
continue;
|
|
}
|
|
|
|
$suggestions = Utils::suggestionList($argName, $knownArgs);
|
|
$context->reportError(new Error(
|
|
self::unknownDirectiveArgMessage($argName, $directiveName, $suggestions),
|
|
[$argNode]
|
|
));
|
|
}
|
|
|
|
return Visitor::skipNode();
|
|
},
|
|
];
|
|
}
|
|
}
|