Run a rule on CollectedDataNode every time when it does not call get()

Such a rule works with something other than the collected data, for
example a tool that it runs over the whole project. Its errors were
reused on every warm run.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

Author: 2 people

src/Analyser/AnalyserResultFinalizer.php

@@ -55,7 +55,8 @@ public function __construct(
 	 * @param Closure(): void|null $postRuleCallback called when the rule's processNode() has returned or thrown, before its errors are processed
 	 * @param array<string, CollectedDataRuleResult> $previousCollectedDataRuleResults the rule results of the
 	 *        previous run, from the result cache - a rule whose input did not change reuses its errors.
-	 *        Only with the reuseCollectedDataRuleErrors feature toggle, otherwise every rule runs.
+	 *        Only with the reuseCollectedDataRuleErrors feature toggle, otherwise every rule runs. A rule that
+	 *        does not call get() on the node always runs.
 	 */
 	public function finalize(
 		AnalyserResult $analyserResult,
@@ -179,7 +180,8 @@ public function finalize(
 				$errors[] = $this->ruleErrorTransformer->transform($ruleError, $scope, [], $ruleNode);
 			}
 
-			if ($this->reuseCollectedDataRuleErrors) {
+			// a rule that never asked for collected data works with something else, so it runs every time
+			if ($this->reuseCollectedDataRuleErrors && $reads->getCollectorTypes() !== []) {
 				$collectedDataRuleResults[$ruleKey] = $this->createRuleResult($reads, $onlyFiles, $hashCollector, $errors, $ruleValueDependencies);
 			}
 

src/Analyser/DependencyTracker.php

@@ -25,7 +25,8 @@
  * the result cache re-analyses the file when that changes - see ResultCacheValueExtension.
  * In a rule for CollectedDataNode, it tracks what the errors of the rule depend on: with the
  * reuseCollectedDataRuleErrors feature toggle, the result cache reuses the errors of such a rule
- * while its collected data and the tracked values stay the same.
+ * while its collected data and the tracked values stay the same. A rule that does not call get() on
+ * the node runs every time.
  *
  * Extensions that get no Scope because they describe a class - class reflection extensions - use
  * DeclarationDependencyTracker instead.

tests/PHPStan/Analyser/CollectedDataReuse/DescribedClassRule.php

@@ -34,6 +34,8 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$this->runs++;
 
+		// a rule that does not ask for collected data runs every time
+		$node->get(FirstCollector::class);
 		$contents = file_get_contents($this->file);
 
 		return [

tests/PHPStan/Analyser/CollectedDataReuse/NoCollectedDataRule.php

@@ -0,0 +1,60 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\CollectedDataReuse;
+
+use PhpParser\Node;
+use PHPStan\Analyser\DependencyTracker;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\CollectedDataNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use function file_get_contents;
+use function sprintf;
+
+/**
+ * Asks only whether the analysis is files-only, and reads a file, like a rule that runs a tool over
+ * the whole project. It tracks the file when told to.
+ *
+ * @implements Rule<CollectedDataNode>
+ */
+final class NoCollectedDataRule implements Rule
+{
+
+	public int $runs = 0;
+
+	public function __construct(private string $file, private bool $track)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return CollectedDataNode::class;
+	}
+
+	/**
+	 * @param Scope&DependencyTracker $scope
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$this->runs++;
+
+		if ($node->isOnlyFilesAnalysis()) {
+			return [];
+		}
+
+		if ($this->track) {
+			$scope->trackFileDependency($this->file);
+		}
+
+		$contents = file_get_contents($this->file);
+
+		return [
+			RuleErrorBuilder::message(sprintf('Tool says %s.', $contents === false ? 'nothing' : $contents))
+				->file(__FILE__)
+				->line(1)
+				->identifier('tests.noCollectedData')
+				->build(),
+		];
+	}
+
+}

tests/PHPStan/Analyser/CollectedDataReuse/OnlyFilesRule.php

@@ -25,6 +25,8 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$this->runs++;
 
+		// a rule that does not ask for collected data runs every time
+		$node->get(FirstCollector::class);
 		if ($node->isOnlyFilesAnalysis()) {
 			return [];
 		}

tests/PHPStan/Analyser/CollectedDataReuse/TrackingRule.php

@@ -41,6 +41,8 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$this->runs++;
 
+		// a rule that does not ask for collected data runs every time
+		$node->get(FirstCollector::class);
 		$scope->trackFileDependency($this->file);
 		$scope->trackDirectoryDependency($this->directory, '*.txt');
 		$scope->trackValueDependency(FileResultCacheValueExtension::class, $this->valueFile);

tests/PHPStan/Analyser/CollectedDataRuleReuseTest.php

@@ -5,6 +5,7 @@
 use PHPStan\Analyser\CollectedDataReuse\DescribedClassRule;
 use PHPStan\Analyser\CollectedDataReuse\EarlyReturnRule;
 use PHPStan\Analyser\CollectedDataReuse\FirstCollector;
+use PHPStan\Analyser\CollectedDataReuse\NoCollectedDataRule;
 use PHPStan\Analyser\CollectedDataReuse\OnlyFilesRule;
 use PHPStan\Analyser\CollectedDataReuse\SecondCollector;
 use PHPStan\Analyser\CollectedDataReuse\ThrowingRule;
@@ -118,6 +119,29 @@ public function testOnlyFilesAnalysis(): void
 		$this->assertSame([], $this->getMessages($result));
 	}
 
+	public function testRuleThatDoesNotAskForCollectedDataRunsEveryTime(): void
+	{
+		$file = sys_get_temp_dir() . '/phpstan-collected-data-reuse-' . uniqid() . '.txt';
+		file_put_contents($file, 'one');
+		$collectedData = [
+			self::A => [FirstCollector::class => ['a1']],
+		];
+
+		// tracking a value is not enough, the rule has to ask for collected data
+		foreach ([false, true] as $track) {
+			$rule = new NoCollectedDataRule($file, $track);
+			$result = $this->finalize([$rule], $collectedData, false, []);
+			$this->assertSame([], $result->getCollectedDataRuleResults());
+
+			$result = $this->finalize([$rule], $collectedData, false, $result->getCollectedDataRuleResults());
+			$this->assertSame(2, $rule->runs);
+			$this->assertSame(0, $result->getReusedRulesCount());
+			$this->assertSame(['Tool says one.'], $this->getMessages($result));
+		}
+
+		unlink($file);
+	}
+
 	public function testRuleThatThrowsIsNotReused(): void
 	{
 		$rule = new ThrowingRule();