PromoteParameterRule - deduplicate already reported errors

Author: ondrejmirtes

src/Rules/Playground/PromoteParameterRule.php

@@ -4,10 +4,15 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\Container;
+use PHPStan\DependencyInjection\MissingServiceException;
 use PHPStan\Rules\FixableNodeRuleError;
+use PHPStan\Rules\LazyRegistry;
 use PHPStan\Rules\LineRuleError;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use function count;
+use function get_class;
 use function sprintf;
 
 /**
@@ -17,12 +22,16 @@
 final class PromoteParameterRule implements Rule
 {
 
+	/** @var Rule<TNodeType>|false|null */
+	private Rule|false|null $originalRule = null;
+
 	/**
 	 * @param Rule<TNodeType> $rule
 	 * @param class-string<TNodeType>  $nodeType
 	 */
 	public function __construct(
 		private Rule $rule,
+		private Container $container,
 		private string $nodeType,
 		private bool $parameterValue,
 		private string $parameterName,
@@ -35,6 +44,49 @@ public function getNodeType(): string
 		return $this->nodeType;
 	}
 
+	/**
+	 * @return Rule<TNodeType>|null
+	 */
+	private function getOriginalRule(): ?Rule
+	{
+		if ($this->originalRule === false) {
+			return null;
+		}
+
+		if ($this->originalRule !== null) {
+			return $this->originalRule;
+		}
+
+		$originalRule = null;
+		try {
+			/** @var Rule<TNodeType> $originalRule */
+			$originalRule = $this->container->getByType(get_class($this->rule));
+			$taggedRules = $this->container->getServicesByTag(LazyRegistry::RULE_TAG);
+			$found = false;
+			foreach ($taggedRules as $rule) {
+				if ($originalRule !== $rule) {
+					continue;
+				}
+
+				$found = true;
+				break;
+			}
+
+			if (!$found) {
+				$originalRule = null;
+			}
+		} catch (MissingServiceException) {
+			// pass
+		}
+
+		if ($originalRule === null) {
+			$this->originalRule = false;
+			return null;
+		}
+
+		return $this->originalRule = $originalRule;
+	}
+
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if ($this->parameterValue) {
@@ -45,6 +97,14 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
+		$originalRule = $this->getOriginalRule();
+		if ($originalRule !== null) {
+			$originalRuleErrors = $originalRule->processNode($node, $scope);
+			if (count($originalRuleErrors) > 0) {
+				return [];
+			}
+		}
+
 		$errors = [];
 		foreach ($this->rule->processNode($node, $scope) as $error) {
 			$builder = RuleErrorBuilder::message($error->getMessage())

tests/PHPStan/Rules/Playground/PromoteParameterRuleTest.php

@@ -21,6 +21,7 @@ protected function getRule(): Rule
 				self::getContainer(),
 				[],
 			)),
+			self::getContainer(),
 			ClassPropertiesNode::class,
 			false,
 			'checkUninitializedProperties',

tests/PHPStan/Rules/Playground/PromoteParameterRuleWithOriginalRuleTest.php

@@ -0,0 +1,51 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Playground;
+
+use PHPStan\Node\InClassMethodNode;
+use PHPStan\Php\PhpVersion;
+use PHPStan\Reflection\Php\PhpClassReflectionExtension;
+use PHPStan\Rules\Methods\MethodParameterComparisonHelper;
+use PHPStan\Rules\Methods\MethodSignatureRule;
+use PHPStan\Rules\Methods\MethodVisibilityComparisonHelper;
+use PHPStan\Rules\Methods\OverridingMethodRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<PromoteParameterRule<InClassMethodNode>>
+ */
+class PromoteParameterRuleWithOriginalRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new PromoteParameterRule(
+			new OverridingMethodRule(
+				self::getContainer()->getByType(PhpVersion::class),
+				self::getContainer()->getByType(MethodSignatureRule::class),
+				true,
+				self::getContainer()->getByType(MethodParameterComparisonHelper::class),
+				self::getContainer()->getByType(MethodVisibilityComparisonHelper::class),
+				self::getContainer()->getByType(PhpClassReflectionExtension::class),
+				true,
+			),
+			self::getContainer(),
+			InClassMethodNode::class,
+			false,
+			'checkMissingOverrideMethodAttribute',
+		);
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/promote-missing-override.php'], [
+			[
+				'Method PromoteMissingOverride\Bar::doFoo() overrides method PromoteMissingOverride\Foo::doFoo() but is missing the #[\Override] attribute.',
+				18,
+				'This error would be reported if the <fg=cyan>checkMissingOverrideMethodAttribute: true</> parameter was enabled in your <fg=cyan>%configurationFile%</>.',
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Playground/data/promote-missing-override.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace PromoteMissingOverride;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+
+	}
+
+}
+
+class Bar extends Foo
+{
+
+	public function doFoo(): void
+	{
+
+	}
+
+
+	public function doBar(): void
+	{
+
+	}
+
+	#[\Override]
+	public function doBaz(): void
+	{
+	}
+
+}