Add support for result cache meta extensions

Author: Wirone

.github/workflows/e2e-tests.yml

@@ -233,6 +233,15 @@ jobs:
               cd e2e/bug-11857
               composer install
               ../../bin/phpstan
+          - script: |
+              cd e2e/result-cache-meta-extension
+              ../../bin/phpstan -vvv
+              ../../bin/phpstan -vvv --fail-without-result-cache
+              echo 'modified-hash' > hash.txt
+              OUTPUT=$(../bashunit -a exit_code "2" "../../bin/phpstan -vvv --fail-without-result-cache")
+              echo "$OUTPUT"
+              ../bashunit -a matches "Note: Using configuration file .+phpstan.neon." "$OUTPUT"
+              ../bashunit -a contains 'Result cache not used because the metadata do not match: metaExtensions' "$OUTPUT"
 
     steps:
       - name: "Checkout"

composer.json

@@ -140,6 +140,9 @@
 		"classmap": [
 			"tests/e2e",
 			"tests/PHPStan"
+		],
+		"files": [
+			"e2e/result-cache-meta-extension/src/DummyResultCacheMetaExtension.php"
 		]
 	},
 	"repositories": [

e2e/result-cache-meta-extension/hash.txt

@@ -0,0 +1 @@
+initial-hash

e2e/result-cache-meta-extension/phpstan.neon

@@ -0,0 +1,10 @@
+parameters:
+	level: 8
+	paths:
+		- src
+
+services:
+	-
+		class: ResultCacheE2E\MetaExtension\DummyResultCacheMetaExtension
+		tags:
+			- phpstan.resultCacheMetaExtension

e2e/result-cache-meta-extension/src/DummyResultCacheMetaExtension.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ResultCacheE2E\MetaExtension;
+
+use PHPStan\Analyser\ResultCache\ResultCacheMetaExtension;
+
+final class DummyResultCacheMetaExtension implements ResultCacheMetaExtension
+{
+	public function getKey(): string
+	{
+		return 'e2e-dummy-result-cache-meta-extension';
+	}
+
+	public function getHash(): string
+	{
+		// @phpstan-ignore argument.type (the file is always present so this won't pass `false` as an argument)
+		return trim(file_get_contents(__DIR__ . '/../hash.txt'));
+	}
+}

src/Analyser/ResultCache/ResultCacheManager.php

@@ -10,6 +10,7 @@
 use PHPStan\Command\Output;
 use PHPStan\Dependency\ExportedNodeFetcher;
 use PHPStan\Dependency\RootExportedNode;
+use PHPStan\DependencyInjection\Container;
 use PHPStan\DependencyInjection\ProjectConfigHelper;
 use PHPStan\File\CouldNotReadFileException;
 use PHPStan\File\FileFinder;
@@ -66,6 +67,7 @@ final class ResultCacheManager
 	 * @param string[] $scanDirectories
 	 */
 	public function __construct(
+		private Container $container,
 		private ExportedNodeFetcher $exportedNodeFetcher,
 		private FileFinder $scanFileFinder,
 		private ReflectionProvider $reflectionProvider,
@@ -904,6 +906,7 @@ private function getMeta(array $allAnalysedFiles, ?array $projectConfigArray): a
 		return [
 			'cacheVersion' => self::CACHE_VERSION,
 			'phpstanVersion' => ComposerHelper::getPhpStanVersion(),
+			'metaExtensions' => $this->getMetaFromPhpStanExtensions(),
 			'phpVersion' => PHP_VERSION_ID,
 			'projectConfig' => $projectConfigArray,
 			'analysedPaths' => $this->analysedPaths,
@@ -1036,4 +1039,29 @@ private function getStubFiles(): array
 		return $stubFiles;
 	}
 
+	/**
+	 * @return array<string, string>
+	 * @throws ShouldNotHappenException
+	 */
+	private function getMetaFromPhpStanExtensions(): array
+	{
+		$meta = [];
+
+		/** @var ResultCacheMetaExtension $extension */
+		foreach ($this->container->getServicesByTag(ResultCacheMetaExtension::EXTENSION_TAG) as $extension) {
+			if (array_key_exists($extension->getKey(), $meta)) {
+				throw new ShouldNotHappenException(sprintf(
+					'Duplicate ResultCacheMetaExtension with key "%s" found.',
+					$extension->getKey(),
+				));
+			}
+
+			$meta[$extension->getKey()] = $extension->getHash();
+		}
+
+		ksort($meta);
+
+		return $meta;
+	}
+
 }

src/Analyser/ResultCache/ResultCacheMetaExtension.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\ResultCache;
+
+/**
+ * ResultCacheMetaExtension can be used for extending PHPStan's built-in mechanism that is used for
+ * calculating metadata for result cache. Using this extension you may add additional metadata that will
+ * be used for determining if analysis must be run again, or can be re-used from result cache.
+ *
+ * @see https://github.com/phpstan/phpstan-symfony/issues/255 for the context.
+ *
+ * To register it in the configuration file use the `phpstan.resultCacheMetaExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.resultCacheMetaExtension
+ * ```
+ *
+ * @api
+ */
+interface ResultCacheMetaExtension
+{
+
+	public const EXTENSION_TAG = 'phpstan.resultCacheMetaExtension';
+
+	/**
+	 * Returns unique key for this result cache meta entry. This describes the source of the metadata.
+	 */
+	public function getKey(): string;
+
+	/**
+	 * Returns hash of the result cache meta entry. This represents the current state of the additional meta source.
+	 */
+	public function getHash(): string;
+
+}

src/DependencyInjection/ConditionalTagsExtension.php

@@ -5,6 +5,7 @@
 use Nette;
 use Nette\DI\CompilerExtension;
 use Nette\Schema\Expect;
+use PHPStan\Analyser\ResultCache\ResultCacheMetaExtension;
 use PHPStan\Analyser\TypeSpecifierFactory;
 use PHPStan\Broker\BrokerFactory;
 use PHPStan\Collectors\RegistryFactory as CollectorRegistryFactory;
@@ -59,6 +60,7 @@ public function getConfigSchema(): Nette\Schema\Schema
 			LazyParameterOutTypeExtensionProvider::METHOD_TAG => $bool,
 			LazyParameterOutTypeExtensionProvider::STATIC_METHOD_TAG => $bool,
 			DiagnoseExtension::EXTENSION_TAG => $bool,
+			ResultCacheMetaExtension::EXTENSION_TAG => $bool,
 		])->min(1));
 	}