Move handling of unmatched ignored errors from FileAnalyser to Analys…

…erResultFinalizer
phpstan · Apr 20, 2024 · 38a2734 · 38a2734
1 parent 52036a5
commit 38a2734
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 39 deletions.
diff --git a/conf/config.neon b/conf/config.neon
@@ -478,12 +478,13 @@ services:
 
 	-
 		class: PHPStan\Analyser\AnalyserResultFinalizer
+		arguments:
+			reportUnmatchedIgnoredErrors: %reportUnmatchedIgnoredErrors%
 
 	-
 		class: PHPStan\Analyser\FileAnalyser
 		arguments:
 			parser: @defaultAnalysisParser
-			reportUnmatchedIgnoredErrors: %reportUnmatchedIgnoredErrors%
 
 	-
 		class: PHPStan\Analyser\LocalIgnoresProcessor

diff --git a/src/Analyser/AnalyserResultFinalizer.php b/src/Analyser/AnalyserResultFinalizer.php
@@ -18,19 +18,20 @@ public function __construct(
 		private RuleRegistry $ruleRegistry,
 		private RuleErrorTransformer $ruleErrorTransformer,
 		private ScopeFactory $scopeFactory,
+		private bool $reportUnmatchedIgnoredErrors,
 	)
 	{
 	}
 
 	public function finalize(AnalyserResult $analyserResult, bool $onlyFiles): AnalyserResult
 	{
 		if (count($analyserResult->getCollectedData()) === 0) {
-			return $analyserResult;
+			return $this->addUnmatchedIgnoredErrors($analyserResult);
 		}
 
 		$hasInternalErrors = count($analyserResult->getInternalErrors()) > 0 || $analyserResult->hasReachedInternalErrorsCountLimit();
 		if ($hasInternalErrors) {
-			return $analyserResult;
+			return $this->addUnmatchedIgnoredErrors($analyserResult);
 		}
 
 		$nodeType = CollectedDataNode::class;
@@ -58,6 +59,58 @@ public function finalize(AnalyserResult $analyserResult, bool $onlyFiles): Analy
 			}
 		}
 
+		return $this->addUnmatchedIgnoredErrors(new AnalyserResult(
+			$errors,
+			$analyserResult->getLocallyIgnoredErrors(),
+			$analyserResult->getLinesToIgnore(),
+			$analyserResult->getUnmatchedLineIgnores(),
+			$analyserResult->getInternalErrors(),
+			$analyserResult->getCollectedData(),
+			$analyserResult->getDependencies(),
+			$analyserResult->getExportedNodes(),
+			$analyserResult->hasReachedInternalErrorsCountLimit(),
+			$analyserResult->getPeakMemoryUsageBytes(),
+		));
+	}
+
+	private function addUnmatchedIgnoredErrors(AnalyserResult $analyserResult): AnalyserResult
+	{
+		if (!$this->reportUnmatchedIgnoredErrors) {
+			return $analyserResult;
+		}
+
+		$errors = $analyserResult->getUnorderedErrors();
+		foreach ($analyserResult->getUnmatchedLineIgnores() as $file => $data) {
+			foreach ($data as $ignoredFile => $lines) {
+				if ($ignoredFile !== $file) {
+					continue;
+				}
+
+				foreach ($lines as $line => $identifiers) {
+					if ($identifiers === null) {
+						$errors[] = (new Error(
+							sprintf('No error to ignore is reported on line %d.', $line),
+							$file,
+							$line,
+							false,
+							$file,
+						))->withIdentifier('ignore.unmatchedLine');
+						continue;
+					}
+
+					foreach ($identifiers as $identifier) {
+						$errors[] = (new Error(
+							sprintf('No error with identifier %s is reported on line %d.', $identifier, $line),
+							$file,
+							$line,
+							false,
+							$file,
+						))->withIdentifier('ignore.unmatchedIdentifier');
+					}
+				}
+			}
+		}
+
 		return new AnalyserResult(
 			$errors,
 			$analyserResult->getLocallyIgnoredErrors(),

diff --git a/src/Analyser/FileAnalyser.php b/src/Analyser/FileAnalyser.php
@@ -42,7 +42,6 @@ public function __construct(
 		private DependencyResolver $dependencyResolver,
 		private RuleErrorTransformer $ruleErrorTransformer,
 		private LocalIgnoresProcessor $localIgnoresProcessor,
-		private bool $reportUnmatchedIgnoredErrors,
 	)
 	{
 	}
@@ -189,37 +188,6 @@ public function analyseFile(
 				}
 				$linesToIgnore = $localIgnoresProcessorResult->getLinesToIgnore();
 				$unmatchedLineIgnores = $localIgnoresProcessorResult->getUnmatchedLineIgnores();
-
-				if ($this->reportUnmatchedIgnoredErrors) {
-					foreach ($unmatchedLineIgnores as $ignoredFile => $lines) {
-						if ($ignoredFile !== $file) {
-							continue;
-						}
-
-						foreach ($lines as $line => $identifiers) {
-							if ($identifiers === null) {
-								$fileErrors[] = (new Error(
-									sprintf('No error to ignore is reported on line %d.', $line),
-									$file,
-									$line,
-									false,
-									$file,
-								))->withIdentifier('ignore.unmatchedLine');
-								continue;
-							}
-
-							foreach ($identifiers as $identifier) {
-								$fileErrors[] = (new Error(
-									sprintf('No error with identifier %s is reported on line %d.', $identifier, $line),
-									$file,
-									$line,
-									false,
-									$file,
-								))->withIdentifier('ignore.unmatchedIdentifier');
-							}
-						}
-					}
-				}
 			} catch (\PhpParser\Error $e) {
 				$fileErrors[] = (new Error($e->getMessage(), $file, $e->getStartLine() !== -1 ? $e->getStartLine() : null, $e))->withIdentifier('phpstan.parse');
 			} catch (ParserErrorsException $e) {

diff --git a/src/Analyser/ResultCache/ResultCacheManager.php b/src/Analyser/ResultCache/ResultCacheManager.php
@@ -867,6 +867,7 @@ private function getMeta(array $allAnalysedFiles, ?array $projectConfigArray): a
 			unset($projectConfigArray['parameters']['editorUrlTitle']);
 			unset($projectConfigArray['parameters']['errorFormat']);
 			unset($projectConfigArray['parameters']['ignoreErrors']);
+			unset($projectConfigArray['parameters']['reportUnmatchedIgnoredErrors']);
 			unset($projectConfigArray['parameters']['tipsOfTheDay']);
 			unset($projectConfigArray['parameters']['parallel']);
 			unset($projectConfigArray['parameters']['internalErrorsCountLimit']);

diff --git a/src/Testing/RuleTestCase.php b/src/Testing/RuleTestCase.php
@@ -112,7 +112,6 @@ private function getAnalyser(): Analyser
 				self::getContainer()->getByType(DependencyResolver::class),
 				new RuleErrorTransformer(),
 				new LocalIgnoresProcessor(),
-				true,
 			);
 			$this->analyser = new Analyser(
 				$fileAnalyser,
@@ -184,6 +183,7 @@ public function gatherAnalyserErrors(array $files): array
 			]),
 			new RuleErrorTransformer(),
 			$this->createScopeFactory($this->createReflectionProvider(), $this->getTypeSpecifier()),
+			true,
 		);
 
 		return $finalizer->finalize($analyserResult, false)->getUnorderedErrors();

diff --git a/tests/PHPStan/Analyser/AnalyserTest.php b/tests/PHPStan/Analyser/AnalyserTest.php
@@ -628,7 +628,7 @@ private function runAnalyser(
 		bool $enableIgnoreErrorsWithinPhpDocs = true,
 	): array
 	{
-		$analyser = $this->createAnalyser($reportUnmatchedIgnoredErrors, $enableIgnoreErrorsWithinPhpDocs);
+		$analyser = $this->createAnalyser($enableIgnoreErrorsWithinPhpDocs);
 
 		if (is_string($filePaths)) {
 			$filePaths = [$filePaths];
@@ -648,6 +648,17 @@ private function runAnalyser(
 
 		$analyserResult = $analyser->analyse($normalizedFilePaths);
 
+		$finalizer = new AnalyserResultFinalizer(
+			new DirectRuleRegistry([]),
+			new RuleErrorTransformer(),
+			$this->createScopeFactory(
+				$this->createReflectionProvider(),
+				self::getContainer()->getService('typeSpecifier'),
+			),
+			$reportUnmatchedIgnoredErrors,
+		);
+		$analyserResult = $finalizer->finalize($analyserResult, $onlyFiles);
+
 		$ignoredErrorHelperProcessedResult = $ignoredErrorHelperResult->process($analyserResult->getErrors(), $onlyFiles, $normalizedFilePaths, $analyserResult->hasReachedInternalErrorsCountLimit());
 		$errors = $ignoredErrorHelperProcessedResult->getNotIgnoredErrors();
 		$errors = array_merge($errors, $ignoredErrorHelperProcessedResult->getOtherIgnoreMessages());
@@ -661,7 +672,7 @@ private function runAnalyser(
 		);
 	}
 
-	private function createAnalyser(bool $reportUnmatchedIgnoredErrors, bool $enableIgnoreErrorsWithinPhpDocs): Analyser
+	private function createAnalyser(bool $enableIgnoreErrorsWithinPhpDocs): Analyser
 	{
 		$ruleRegistry = new DirectRuleRegistry([
 			new AlwaysFailRule(),
@@ -716,7 +727,6 @@ private function createAnalyser(bool $reportUnmatchedIgnoredErrors, bool $enable
 			new DependencyResolver($fileHelper, $reflectionProvider, new ExportedNodeResolver($fileTypeMapper, new ExprPrinter(new Printer())), $fileTypeMapper),
 			new RuleErrorTransformer(),
 			new LocalIgnoresProcessor(),
-			$reportUnmatchedIgnoredErrors,
 		);
 
 		return new Analyser(