Rule for checking of usage of obsolete parent/next/previous node attributes

Author: ondrejmirtes

conf/bleedingEdge.neon

@@ -7,5 +7,6 @@ parameters:
 		arrayFilter: true
 		arrayUnpacking: true
 		nodeConnectingVisitorCompatibility: false
+		nodeConnectingVisitorRule: true
 		disableRuntimeReflectionProvider: true
 		illegalConstructorMethodCall: true

conf/config.level0.neon

@@ -2,6 +2,8 @@ parameters:
 	customRulesetUsed: false
 
 conditionalTags:
+	PHPStan\Rules\Api\NodeConnectingVisitorAttributesRule:
+		phpstan.rules.rule: %featureToggles.nodeConnectingVisitorRule%
 	PHPStan\Rules\Properties\UninitializedPropertyRule:
 		phpstan.rules.rule: %checkUninitializedProperties%
 
@@ -67,6 +69,8 @@ rules:
 	- PHPStan\Rules\Whitespace\FileWhitespaceRule
 
 services:
+	-
+		class: PHPStan\Rules\Api\NodeConnectingVisitorAttributesRule
 	-
 		class: PHPStan\Rules\Classes\ExistingClassInClassExtendsRule
 		tags:

conf/config.neon

@@ -32,6 +32,7 @@ parameters:
 		arrayFilter: false
 		arrayUnpacking: false
 		nodeConnectingVisitorCompatibility: true
+		nodeConnectingVisitorRule: false
 		illegalConstructorMethodCall: false
 	fileExtensions:
 		- php
@@ -220,6 +221,7 @@ parametersSchema:
 		arrayFilter: bool(),
 		arrayUnpacking: bool(),
 		nodeConnectingVisitorCompatibility: bool(),
+		nodeConnectingVisitorRule: bool(),
 		illegalConstructorMethodCall: bool(),
 	])
 	fileExtensions: listOf(string())

src/Rules/Api/NodeConnectingVisitorAttributesRule.php

@@ -0,0 +1,97 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Api;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\NodeVisitor\NodeConnectingVisitor;
+use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\Container;
+use PHPStan\Parser\RichParser;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\Constant\ConstantStringType;
+use PHPStan\Type\ObjectType;
+use function array_keys;
+use function in_array;
+use function sprintf;
+use function strpos;
+
+/**
+ * @implements Rule<MethodCall>
+ */
+class NodeConnectingVisitorAttributesRule implements Rule
+{
+
+	public function __construct(private Container $container)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return MethodCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->name instanceof Node\Identifier) {
+			return [];
+		}
+		if ($node->name->toLowerString() !== 'getattribute') {
+			return [];
+		}
+		$calledOnType = $scope->getType($node->var);
+		if (!(new ObjectType(Node::class))->isSuperTypeOf($calledOnType)->yes()) {
+			return [];
+		}
+		$args = $node->getArgs();
+		if (!isset($args[0])) {
+			return [];
+		}
+		$argType = $scope->getType($args[0]->value);
+		if (!$argType instanceof ConstantStringType) {
+			return [];
+		}
+		if (!in_array($argType->getValue(), ['parent', 'previous', 'next'], true)) {
+			return [];
+		}
+		if (!$scope->isInClass()) {
+			return [];
+		}
+
+		$classReflection = $scope->getClassReflection();
+		$hasPhpStanInterface = false;
+		foreach (array_keys($classReflection->getInterfaces()) as $interfaceName) {
+			if (strpos($interfaceName, 'PHPStan\\') !== 0) {
+				continue;
+			}
+
+			$hasPhpStanInterface = true;
+		}
+
+		if (!$hasPhpStanInterface) {
+			return [];
+		}
+
+		$isVisitorRegistered = false;
+		foreach ($this->container->getServicesByTag(RichParser::VISITOR_SERVICE_TAG) as $service) {
+			if ($service::class !== NodeConnectingVisitor::class) {
+				continue;
+			}
+
+			$isVisitorRegistered = true;
+			break;
+		}
+
+		if ($isVisitorRegistered) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message(sprintf('Node attribute \'%s\' is no longer available.', $argType->getValue()))
+				->tip('See: https://phpstan.org/blog/preprocessing-ast-for-custom-rules')
+				->build(),
+		];
+	}
+
+}

tests/PHPStan/Rules/Api/NodeConnectingVisitorAttributesRuleTest.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Api;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<NodeConnectingVisitorAttributesRule>
+ */
+class NodeConnectingVisitorAttributesRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new NodeConnectingVisitorAttributesRule(self::getContainer());
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/node-connecting-visitor.php'], [
+			[
+				'Node attribute \'parent\' is no longer available.',
+				18,
+				'See: https://phpstan.org/blog/preprocessing-ast-for-custom-rules'
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Api/NodeConnectingVisitorAttributesRuleWithVisitorRegisteredTest.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Api;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use function array_merge;
+
+/**
+ * @extends RuleTestCase<NodeConnectingVisitorAttributesRule>
+ */
+class NodeConnectingVisitorAttributesRuleWithVisitorRegisteredTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new NodeConnectingVisitorAttributesRule(self::getContainer());
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/node-connecting-visitor.php'], []);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return array_merge(parent::getAdditionalConfigFiles(), [
+			__DIR__ . '/nodeConnectingVisitorCompatibility.neon',
+		]);
+	}
+
+}

tests/PHPStan/Rules/Api/data/node-connecting-visitor.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace NodeConnectingVisitorRule;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+
+class MyRule implements Rule
+{
+	public function getNodeType(): string
+	{
+		return Node::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$parent = $node->getAttribute("parent");
+		$custom = $node->getAttribute("myCustomAttribute");
+
+		return [];
+	}
+
+}
+
+class Foo
+{
+
+	public function doFoo(Node $node): void
+	{
+		$parent = $node->getAttribute("parent");
+	}
+
+}

tests/PHPStan/Rules/Api/nodeConnectingVisitorCompatibility.neon

@@ -0,0 +1,3 @@
+conditionalTags:
+	PhpParser\NodeVisitor\NodeConnectingVisitor:
+		phpstan.parser.richParserNodeVisitor: true