NoUnusedVariables.php — WooCommerce 10.9.3

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

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

NoUnusedVariables.php

62 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	class NoUnusedVariables extends ValidationRule
12	{
13	/** @var array<int, VariableDefinitionNode> */
14	protected array $variableDefs;
15
16	public function getVisitor(QueryValidationContext $context): array
17	{
18	$this->variableDefs = [];
19
20	return [
21	NodeKind::OPERATION_DEFINITION => [
22	'enter' => function (): void {
23	$this->variableDefs = [];
24	},
25	'leave' => function (OperationDefinitionNode $operation) use ($context): void {
26	$variableNameUsed = [];
27	$usages = $context->getRecursiveVariableUsages($operation);
28	$opName = $operation->name !== null
29	? $operation->name->value
30	: null;
31
32	foreach ($usages as $usage) {
33	$node = $usage['node'];
34	$variableNameUsed[$node->name->value] = true;
35	}
36
37	foreach ($this->variableDefs as $variableDef) {
38	$variableName = $variableDef->variable->name->value;
39
40	if (! isset($variableNameUsed[$variableName])) {
41	$context->reportError(new Error(
42	static::unusedVariableMessage($variableName, $opName),
43	[$variableDef]
44	));
45	}
46	}
47	},
48	],
49	NodeKind::VARIABLE_DEFINITION => function ($def): void {
50	$this->variableDefs[] = $def;
51	},
52	];
53	}
54
55	public static function unusedVariableMessage(string $varName, ?string $opName = null): string
56	{
57	return $opName !== null
58	? "Variable \"\${$varName}\" is never used in operation \"{$opName}\"."
59	: "Variable \"\${$varName}\" is never used.";
60	}
61	}
62