NoUndefinedVariables.php — WooCommerce 10.9.3

woocommerce / lib / packages / GraphQL / Validator / Rules / NoUndefinedVariables.php

woocommerce / lib / packages / GraphQL / Validator / Rules Last commit date

NoUndefinedVariables.php

61 lines

1	<?php declare(strict_types=1);
2
3	namespace Automattic\WooCommerce\Vendor\GraphQL\Validator\Rules;
4
5	use Automattic\WooCommerce\Vendor\GraphQL\Error\Error;
6	use Automattic\WooCommerce\Vendor\GraphQL\Language\AST\NodeKind;
7	use Automattic\WooCommerce\Vendor\GraphQL\Language\AST\OperationDefinitionNode;
8	use Automattic\WooCommerce\Vendor\GraphQL\Language\AST\VariableDefinitionNode;
9	use Automattic\WooCommerce\Vendor\GraphQL\Validator\QueryValidationContext;
10
11	/**
12	* A Automattic\WooCommerce\Vendor\GraphQL operation is only valid if all variables encountered, both directly
13	* and via fragment spreads, are defined by that operation.
14	*/
15	class NoUndefinedVariables extends ValidationRule
16	{
17	public function getVisitor(QueryValidationContext $context): array
18	{
19	/** @var array<string, true> $variableNameDefined */
20	$variableNameDefined = [];
21
22	return [
23	NodeKind::OPERATION_DEFINITION => [
24	'enter' => static function () use (&$variableNameDefined): void {
25	$variableNameDefined = [];
26	},
27	'leave' => static function (OperationDefinitionNode $operation) use (&$variableNameDefined, $context): void {
28	$usages = $context->getRecursiveVariableUsages($operation);
29
30	foreach ($usages as $usage) {
31	$node = $usage['node'];
32	$varName = $node->name->value;
33
34	if (! isset($variableNameDefined[$varName])) {
35	$context->reportError(new Error(
36	static::undefinedVarMessage(
37	$varName,
38	$operation->name !== null
39	? $operation->name->value
40	: null
41	),
42	[$node, $operation]
43	));
44	}
45	}
46	},
47	],
48	NodeKind::VARIABLE_DEFINITION => static function (VariableDefinitionNode $def) use (&$variableNameDefined): void {
49	$variableNameDefined[$def->variable->name->value] = true;
50	},
51	];
52	}
53
54	public static function undefinedVarMessage(string $varName, ?string $opName): string
55	{
56	return $opName === null
57	? "Variable \"\${$varName}\" is not defined by operation \"{$opName}\"."
58	: "Variable \"\${$varName}\" is not defined.";
59	}
60	}
61