Result cache - reanalyse all files with errors when new symbol appears

phpstan · Oct 20, 2022 · bc9301d · bc9301d
1 parent 4c0cb98
commit bc9301d
Show file tree

Hide file tree

Showing 15 changed files with 129 additions and 33 deletions.
diff --git a/src/Analyser/AnalyserResult.php b/src/Analyser/AnalyserResult.php
@@ -3,7 +3,7 @@
 namespace PHPStan\Analyser;
 
 use PHPStan\Collectors\CollectedData;
-use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 use function usort;
 
 class AnalyserResult
@@ -17,7 +17,7 @@ class AnalyserResult
 	 * @param CollectedData[] $collectedData
 	 * @param string[] $internalErrors
 	 * @param array<string, array<string>>|null $dependencies
-	 * @param array<string, array<ExportedNode>> $exportedNodes
+	 * @param array<string, array<RootExportedNode>> $exportedNodes
 	 */
 	public function __construct(
 		private array $errors,
@@ -85,7 +85,7 @@ public function getDependencies(): ?array
 	}
 
 	/**
-	 * @return array<string, array<ExportedNode>>
+	 * @return array<string, array<RootExportedNode>>
 	 */
 	public function getExportedNodes(): array
 	{

diff --git a/src/Analyser/FileAnalyserResult.php b/src/Analyser/FileAnalyserResult.php
@@ -3,7 +3,7 @@
 namespace PHPStan\Analyser;
 
 use PHPStan\Collectors\CollectedData;
-use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 
 class FileAnalyserResult
 {
@@ -12,7 +12,7 @@ class FileAnalyserResult
 	 * @param Error[] $errors
 	 * @param CollectedData[] $collectedData
 	 * @param array<int, string> $dependencies
-	 * @param array<int, ExportedNode> $exportedNodes
+	 * @param array<int, RootExportedNode> $exportedNodes
 	 */
 	public function __construct(
 		private array $errors,
@@ -48,7 +48,7 @@ public function getDependencies(): array
 	}
 
 	/**
-	 * @return array<int, ExportedNode>
+	 * @return array<int, RootExportedNode>
 	 */
 	public function getExportedNodes(): array
 	{

diff --git a/src/Analyser/ResultCache/ResultCache.php b/src/Analyser/ResultCache/ResultCache.php
@@ -4,7 +4,7 @@
 
 use PHPStan\Analyser\Error;
 use PHPStan\Collectors\CollectedData;
-use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 
 class ResultCache
 {
@@ -15,7 +15,7 @@ class ResultCache
 	 * @param array<string, array<Error>> $errors
 	 * @param array<string, array<CollectedData>> $collectedData
 	 * @param array<string, array<string>> $dependencies
-	 * @param array<string, array<ExportedNode>> $exportedNodes
+	 * @param array<string, array<RootExportedNode>> $exportedNodes
 	 */
 	public function __construct(
 		private array $filesToAnalyse,
@@ -81,7 +81,7 @@ public function getDependencies(): array
 	}
 
 	/**
-	 * @return array<string, array<ExportedNode>>
+	 * @return array<string, array<RootExportedNode>>
 	 */
 	public function getExportedNodes(): array
 	{

diff --git a/src/Analyser/ResultCache/ResultCacheManager.php b/src/Analyser/ResultCache/ResultCacheManager.php
@@ -8,8 +8,8 @@
 use PHPStan\Analyser\Error;
 use PHPStan\Collectors\CollectedData;
 use PHPStan\Command\Output;
-use PHPStan\Dependency\ExportedNode;
 use PHPStan\Dependency\ExportedNodeFetcher;
+use PHPStan\Dependency\RootExportedNode;
 use PHPStan\File\FileFinder;
 use PHPStan\File\FileReader;
 use PHPStan\File\FileWriter;
@@ -225,11 +225,13 @@ public function restore(array $allAnalysedFiles, bool $debug, bool $onlyFiles, ?
 			}
 
 			$cachedFileExportedNodes = $filteredExportedNodes[$analysedFile];
-			if (count($dependentFiles) === 0) {
+			$exportedNodesChanged = $this->exportedNodesChanged($analysedFile, $cachedFileExportedNodes);
+			if ($exportedNodesChanged === null) {
 				continue;
 			}
-			if (!$this->exportedNodesChanged($analysedFile, $cachedFileExportedNodes)) {
-				continue;
+
+			if ($exportedNodesChanged) {
+				$newFileAppeared = true;
 			}
 
 			foreach ($dependentFiles as $dependentFile) {
@@ -279,26 +281,42 @@ private function isMetaDifferent(array $cachedMeta, array $currentMeta): bool
 	}
 
 	/**
-	 * @param array<int, ExportedNode> $cachedFileExportedNodes
+	 * @param array<int, RootExportedNode> $cachedFileExportedNodes
+	 * @return bool|null null means nothing changed, true means new root symbol appeared, false means nested node changed
 	 */
-	private function exportedNodesChanged(string $analysedFile, array $cachedFileExportedNodes): bool
+	private function exportedNodesChanged(string $analysedFile, array $cachedFileExportedNodes): ?bool
 	{
 		if (array_key_exists($analysedFile, $this->fileReplacements)) {
 			$analysedFile = $this->fileReplacements[$analysedFile];
 		}
 		$fileExportedNodes = $this->exportedNodeFetcher->fetchNodes($analysedFile);
+
+		$cachedSymbols = [];
+		foreach ($cachedFileExportedNodes as $cachedFileExportedNode) {
+			$cachedSymbols[$cachedFileExportedNode->getType()][] = $cachedFileExportedNode->getName();
+		}
+
+		$fileSymbols = [];
+		foreach ($fileExportedNodes as $fileExportedNode) {
+			$fileSymbols[$fileExportedNode->getType()][] = $fileExportedNode->getName();
+		}
+
+		if ($cachedSymbols !== $fileSymbols) {
+			return true;
+		}
+
 		if (count($fileExportedNodes) !== count($cachedFileExportedNodes)) {
 			return true;
 		}
 
 		foreach ($fileExportedNodes as $i => $fileExportedNode) {
 			$cachedExportedNode = $cachedFileExportedNodes[$i];
 			if (!$cachedExportedNode->equals($fileExportedNode)) {
-				return true;
+				return false;
 			}
 		}
 
-		return false;
+		return null;
 	}
 
 	/**
@@ -487,8 +505,8 @@ private function mergeDependencies(ResultCache $resultCache, ?array $freshDepend
 	}
 
 	/**
-	 * @param array<string, array<ExportedNode>> $freshExportedNodes
-	 * @return array<string, array<ExportedNode>>
+	 * @param array<string, array<RootExportedNode>> $freshExportedNodes
+	 * @return array<string, array<RootExportedNode>>
 	 */
 	private function mergeExportedNodes(ResultCache $resultCache, array $freshExportedNodes): array
 	{
@@ -509,7 +527,7 @@ private function mergeExportedNodes(ResultCache $resultCache, array $freshExport
 	 * @param array<string, array<Error>> $errors
 	 * @param array<string, array<CollectedData>> $collectedData
 	 * @param array<string, array<string>> $dependencies
-	 * @param array<string, array<ExportedNode>> $exportedNodes
+	 * @param array<string, array<RootExportedNode>> $exportedNodes
 	 * @param mixed[] $meta
 	 */
 	private function save(

diff --git a/src/Dependency/ExportedNode/ExportedClassNode.php b/src/Dependency/ExportedNode/ExportedClassNode.php
@@ -4,12 +4,13 @@
 
 use JsonSerializable;
 use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 use PHPStan\ShouldNotHappenException;
 use ReturnTypeWillChange;
 use function array_map;
 use function count;
 
-class ExportedClassNode implements ExportedNode, JsonSerializable
+class ExportedClassNode implements RootExportedNode, JsonSerializable
 {
 
 	/**
@@ -170,4 +171,14 @@ public static function decode(array $data): ExportedNode
 		);
 	}
 
+	public function getType(): string
+	{
+		return self::TYPE_CLASS;
+	}
+
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
 }
diff --git a/src/Dependency/ExportedNode/ExportedEnumNode.php b/src/Dependency/ExportedNode/ExportedEnumNode.php
@@ -4,12 +4,13 @@
 
 use JsonSerializable;
 use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 use PHPStan\ShouldNotHappenException;
 use ReturnTypeWillChange;
 use function array_map;
 use function count;
 
-class ExportedEnumNode implements ExportedNode, JsonSerializable
+class ExportedEnumNode implements RootExportedNode, JsonSerializable
 {
 
 	/**
@@ -133,4 +134,14 @@ public static function decode(array $data): ExportedNode
 		);
 	}
 
+	public function getType(): string
+	{
+		return self::TYPE_ENUM;
+	}
+
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
 }
diff --git a/src/Dependency/ExportedNode/ExportedFunctionNode.php b/src/Dependency/ExportedNode/ExportedFunctionNode.php
@@ -4,12 +4,13 @@
 
 use JsonSerializable;
 use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 use PHPStan\ShouldNotHappenException;
 use ReturnTypeWillChange;
 use function array_map;
 use function count;
 
-class ExportedFunctionNode implements ExportedNode, JsonSerializable
+class ExportedFunctionNode implements RootExportedNode, JsonSerializable
 {
 
 	/**
@@ -132,4 +133,14 @@ public static function decode(array $data): ExportedNode
 		);
 	}
 
+	public function getType(): string
+	{
+		return self::TYPE_FUNCTION;
+	}
+
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
 }
diff --git a/src/Dependency/ExportedNode/ExportedInterfaceNode.php b/src/Dependency/ExportedNode/ExportedInterfaceNode.php
@@ -4,11 +4,12 @@
 
 use JsonSerializable;
 use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 use ReturnTypeWillChange;
 use function array_map;
 use function count;
 
-class ExportedInterfaceNode implements ExportedNode, JsonSerializable
+class ExportedInterfaceNode implements RootExportedNode, JsonSerializable
 {
 
 	/**
@@ -102,4 +103,14 @@ public static function decode(array $data): ExportedNode
 		);
 	}
 
+	public function getType(): string
+	{
+		return self::TYPE_INTERFACE;
+	}
+
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
 }
diff --git a/src/Dependency/ExportedNode/ExportedTraitNode.php b/src/Dependency/ExportedNode/ExportedTraitNode.php
@@ -4,9 +4,10 @@
 
 use JsonSerializable;
 use PHPStan\Dependency\ExportedNode;
+use PHPStan\Dependency\RootExportedNode;
 use ReturnTypeWillChange;
 
-class ExportedTraitNode implements ExportedNode, JsonSerializable
+class ExportedTraitNode implements RootExportedNode, JsonSerializable
 {
 
 	public function __construct(private string $traitName)
@@ -50,4 +51,14 @@ public function jsonSerialize()
 		];
 	}
 
+	public function getType(): string
+	{
+		return self::TYPE_TRAIT;
+	}
+
+	public function getName(): string
+	{
+		return $this->traitName;
+	}
+
 }
diff --git a/src/Dependency/ExportedNodeFetcher.php b/src/Dependency/ExportedNodeFetcher.php
@@ -18,7 +18,7 @@ public function __construct(
 	}
 
 	/**
-	 * @return ExportedNode[]
+	 * @return RootExportedNode[]
 	 */
 	public function fetchNodes(string $fileName): array
 	{

diff --git a/src/Dependency/ExportedNodeResolver.php b/src/Dependency/ExportedNodeResolver.php
@@ -35,7 +35,7 @@ public function __construct(private FileTypeMapper $fileTypeMapper, private Expr
 	{
 	}
 
-	public function resolve(string $fileName, Node $node): ?ExportedNode
+	public function resolve(string $fileName, Node $node): ?RootExportedNode
 	{
 		if ($node instanceof Class_ && isset($node->namespacedName)) {
 			$docComment = $node->getDocComment();

diff --git a/src/Dependency/ExportedNodeVisitor.php b/src/Dependency/ExportedNodeVisitor.php
@@ -12,7 +12,7 @@ class ExportedNodeVisitor extends NodeVisitorAbstract
 
 	private ?string $fileName = null;
 
-	/** @var ExportedNode[] */
+	/** @var RootExportedNode[] */
 	private array $currentNodes = [];
 
 	/**
@@ -30,7 +30,7 @@ public function reset(string $fileName): void
 	}
 
 	/**
-	 * @return ExportedNode[]
+	 * @return RootExportedNode[]
 	 */
 	public function getExportedNodes(): array
 	{

diff --git a/src/Dependency/NodeDependencies.php b/src/Dependency/NodeDependencies.php
@@ -16,7 +16,7 @@ class NodeDependencies
 	public function __construct(
 		private FileHelper $fileHelper,
 		private array $reflections,
-		private ?ExportedNode $exportedNode,
+		private ?RootExportedNode $exportedNode,
 	)
 	{
 	}
@@ -50,7 +50,7 @@ public function getFileDependencies(string $currentFile, array $analysedFiles):
 		return array_values($dependencies);
 	}
 
-	public function getExportedNode(): ?ExportedNode
+	public function getExportedNode(): ?RootExportedNode
 	{
 		return $this->exportedNode;
 	}

diff --git a/src/Dependency/RootExportedNode.php b/src/Dependency/RootExportedNode.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Dependency;
+
+interface RootExportedNode extends ExportedNode
+{
+
+	public const TYPE_CLASS = 'class';
+
+	public const TYPE_INTERFACE = 'interface';
+
+	public const TYPE_ENUM = 'enum';
+
+	public const TYPE_TRAIT = 'trait';
+
+	public const TYPE_FUNCTION = 'function';
+
+	/** @return self::TYPE_* */
+	public function getType(): string;
+
+	public function getName(): string;
+
+}