Result cache for everyone!

Author: ondrejmirtes

build.xml

@@ -259,6 +259,18 @@
 				destFile="${phpstan.config}"
 				text=" ]"
 		></append>
+		<exec
+			executable="php"
+			logoutput="true"
+			passthru="true"
+			checkreturn="true"
+		>
+			<arg path="bin/phpstan"/>
+			<arg value="clear-result-cache"/>
+			<arg value="-c"/>
+			<arg path="${phpstan.config}"/>
+			<arg value="-q"/>
+		</exec>
 		<exec
 				executable="php"
 				logoutput="true"
@@ -300,6 +312,18 @@
 			destFile="${phpstan.config}"
 			text=" ]"
 		></append>
+		<exec
+			executable="php"
+			logoutput="true"
+			passthru="true"
+			checkreturn="true"
+		>
+			<arg path="bin/phpstan"/>
+			<arg value="clear-result-cache"/>
+			<arg value="-c"/>
+			<arg path="${phpstan.config}"/>
+			<arg value="-q"/>
+		</exec>
 		<exec
 			executable="php"
 			logoutput="true"
@@ -337,10 +361,6 @@
 				></append>
 			</then>
 		</if>
-		<append
-			destFile="${phpstan.config}"
-			text=", result-cache.neon"
-		></append>
 		<append
 			destFile="${phpstan.config}"
 			text=" ]"

build/phpstan.neon

@@ -18,7 +18,6 @@ parameters:
 		- %rootDir%/tests/PHPStan/Generics/functions.php
 	featureToggles:
 		staticReflectionForPhpParser: false
-		resultCache: false
 	ignoreErrors:
 		- '#^Dynamic call to static method PHPUnit\\Framework\\\S+\(\)\.$#'
 		- '#should be contravariant with parameter \$node \(PhpParser\\Node\) of method PHPStan\\Rules\\Rule<PhpParser\\Node>::processNode\(\)$#'

build/result-cache.neon

@@ -2,5 +2,4 @@ parameters:
 	featureToggles:
 		closureUsesThis: true
 		randomIntParameters: true
-		resultCache: true
 		nullCoalesce: true

conf/bleedingEdge.neon

@@ -10,7 +10,6 @@ parameters:
 		staticReflectionForPhpParser: true
 		disableRuntimeReflectionProvider: false
 		enableScanningPaths: false
-		resultCache: false
 		closureUsesThis: false
 		randomIntParameters: false
 		nullCoalesce: false
@@ -134,7 +133,6 @@ parametersSchema:
 		staticReflectionForPhpParser: bool(),
 		disableRuntimeReflectionProvider: bool(),
 		enableScanningPaths: bool(),
-		resultCache: bool(),
 		closureUsesThis: bool(),
 		randomIntParameters: bool(),
 		nullCoalesce: bool()
@@ -333,7 +331,6 @@ services:
 	-
 		class: PHPStan\Analyser\ResultCache\ResultCacheManager
 		arguments:
-			enabled: %featureToggles.resultCache%
 			cacheFilePath: %tmpDir%/resultCache.php
 			allCustomConfigFiles: %allCustomConfigFiles%
 			analysedPaths: %analysedPaths%

conf/config.neon

@@ -14,9 +14,6 @@ class ResultCacheManager
 
 	private const CACHE_VERSION = 'v1';
 
-	/** @var bool */
-	private $enabled;
-
 	/** @var string */
 	private $cacheFilePath;
 
@@ -36,7 +33,6 @@ class ResultCacheManager
 	private $usedLevel;
 
 	/**
-	 * @param bool $enabled
 	 * @param string $cacheFilePath
 	 * @param string[] $allCustomConfigFiles
 	 * @param string[] $analysedPaths
@@ -45,7 +41,6 @@ class ResultCacheManager
 	 * @param string $usedLevel
 	 */
 	public function __construct(
-		bool $enabled,
 		string $cacheFilePath,
 		array $allCustomConfigFiles,
 		array $analysedPaths,
@@ -54,7 +49,6 @@ public function __construct(
 		string $usedLevel
 	)
 	{
-		$this->enabled = $enabled;
 		$this->cacheFilePath = $cacheFilePath;
 		$this->allCustomConfigFiles = $allCustomConfigFiles;
 		$this->analysedPaths = $analysedPaths;
@@ -70,10 +64,6 @@ public function __construct(
 	 */
 	public function restore(array $allAnalysedFiles, bool $debug): ResultCache
 	{
-		if (!$this->enabled) {
-			return new ResultCache($allAnalysedFiles, true, time(), [], []);
-		}
-
 		if ($debug) {
 			return new ResultCache($allAnalysedFiles, true, time(), [], []);
 		}
@@ -407,16 +397,14 @@ private function getStubFiles(): array
 
 	public function clear(): string
 	{
+		$dir = dirname($this->cacheFilePath);
 		if (!is_file($this->cacheFilePath)) {
-			return dirname($this->cacheFilePath);
+			return $dir;
 		}
 
 		@unlink($this->cacheFilePath);
-		if (is_file($this->cacheFilePath)) {
-			throw new \PHPStan\ShouldNotHappenException('File still exists.');
-		}
 
-		return dirname($this->cacheFilePath);
+		return $dir;
 	}
 
 }

src/Analyser/ResultCache/ResultCacheManager.php

@@ -42,6 +42,10 @@ public function testLevels(
 
 		foreach (range(0, 8) as $level) {
 			unset($outputLines);
+			exec(sprintf('%s %s clear-result-cache %s 2>&1', escapeshellarg(PHP_BINARY), $command, $configPath !== null ? '--configuration ' . escapeshellarg($configPath) : ''), $clearResultCacheOutputLines, $clearResultCacheExitCode);
+			if ($clearResultCacheExitCode !== 0) {
+				throw new \PHPStan\ShouldNotHappenException('Could not clear result cache: ' . implode("\n", $clearResultCacheOutputLines));
+			}
 			exec(sprintf('%s %s analyse --no-progress --error-format=prettyJson --level=%d %s --autoload-file %s %s', escapeshellarg(PHP_BINARY), $command, $level, $configPath !== null ? '--configuration ' . escapeshellarg($configPath) : '', escapeshellarg($file), escapeshellarg($file)), $outputLines);
 
 			$output = implode("\n", $outputLines);

src/Testing/LevelsTestCase.php

@@ -111,6 +111,11 @@ public function testCachingIssue(
 	private function runPhpStan(): array
 	{
 		$phpstanBinPath = __DIR__ . '/../../../../bin/phpstan';
+		exec(sprintf('%s %s clear-result-cache --configuration %s', escapeshellarg(PHP_BINARY), $phpstanBinPath, escapeshellarg(__DIR__ . '/phpstan.neon')), $clearResultCacheOutputLines, $clearResultCacheExitCode);
+		if ($clearResultCacheExitCode !== 0) {
+			throw new \PHPStan\ShouldNotHappenException('Could not clear result cache.');
+		}
+
 		exec(
 			sprintf(
 				'%s %s analyse --no-progress --level 8 --configuration %s --error-format json %s',

tests/PHPStan/Analyser/traitsCachingIssue/TraitsCachingIssueIntegrationTest.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Command;
 
+use PHPStan\Analyser\ResultCache\ResultCacheManager;
 use PHPStan\Command\ErrorFormatter\TableErrorFormatter;
 use PHPStan\Command\Symfony\SymfonyOutput;
 use PHPStan\File\FuzzyRelativePathHelper;
@@ -37,6 +38,7 @@ public function testExecuteOnAFileWithErrors(): void
 
 	private function runPath(string $path, int $expectedStatusCode): string
 	{
+		self::getContainer()->getByType(ResultCacheManager::class)->clear();
 		$analyserApplication = self::getContainer()->getByType(AnalyseApplication::class);
 		$resource = fopen('php://memory', 'w', false);
 		if ($resource === false) {

tests/PHPStan/Command/AnalyseApplicationIntegrationTest.php

@@ -59,6 +59,11 @@ private function runPhpStan(
 			throw new \PHPStan\ShouldNotHappenException();
 		}
 		chdir(__DIR__ . '/../../../..');
+		exec(sprintf('%s %s clear-result-cache %s', escapeshellarg(PHP_BINARY), 'bin/phpstan', $configFile !== null ? '--configuration ' . escapeshellarg($configFile) : ''), $clearResultCacheOutputLines, $clearResultCacheExitCode);
+		if ($clearResultCacheExitCode !== 0) {
+			throw new \PHPStan\ShouldNotHappenException('Could not clear result cache.');
+		}
+
 		exec(sprintf('%s %s analyse --no-progress --error-format=%s --level=7 %s %s', escapeshellarg(PHP_BINARY), 'bin/phpstan', $errorFormatter, $configFile !== null ? '--configuration ' . escapeshellarg($configFile) : '', escapeshellarg($analysedPath)), $outputLines);
 		chdir($originalDir);
 

tests/PHPStan/Command/ErrorFormatter/BaselineNeonErrorFormatterIntegrationTest.php

@@ -22,6 +22,11 @@ public function dataRun(): array
 	 */
 	public function testRun(string $command): void
 	{
+		exec(sprintf('%s %s clear-result-cache --configuration %s', escapeshellarg(PHP_BINARY), escapeshellarg(__DIR__ . '/../../../bin/phpstan'), escapeshellarg(__DIR__ . '/parallel-analyser.neon')), $clearResultCacheOutputLines, $clearResultCacheExitCode);
+		if ($clearResultCacheExitCode !== 0) {
+			throw new \PHPStan\ShouldNotHappenException('Could not clear result cache.');
+		}
+
 		exec(sprintf(
 			'%s %s %s -l 8 -c %s --error-format json %s',
 			escapeshellarg(PHP_BINARY),

tests/PHPStan/Parallel/ParallelAnalyserIntegrationTest.php

@@ -2,6 +2,4 @@ includes:
 	- baseline.neon
 
 parameters:
-	featureToggles:
-		resultCache: true
 	tmpDir: tmp