SymfonyContainerResultCacheMetaExtension optimization (#488)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: xificurk

extension.neon

@@ -312,5 +312,8 @@ services:
 
 	-
 		class: PHPStan\Symfony\SymfonyContainerResultCacheMetaExtension
+		arguments:
+			tmpDir: %tmpDir%
+			containerXmlPath: %symfony.containerXmlPath%
 		tags:
 			- phpstan.resultCacheMetaExtension

src/Symfony/SymfonyContainerResultCacheMetaExtension.php

@@ -4,9 +4,14 @@
 
 use PHPStan\Analyser\ResultCache\ResultCacheMetaExtension;
 use function array_map;
+use function basename;
+use function file_get_contents;
+use function file_put_contents;
 use function hash;
+use function hash_file;
 use function ksort;
 use function sort;
+use function sprintf;
 use function var_export;
 
 final class SymfonyContainerResultCacheMetaExtension implements ResultCacheMetaExtension
@@ -16,10 +21,16 @@ final class SymfonyContainerResultCacheMetaExtension implements ResultCacheMetaE
 
 	private ServiceMap $serviceMap;
 
-	public function __construct(ParameterMap $parameterMap, ServiceMap $serviceMap)
+	private string $tmpDir;
+
+	private ?string $containerXmlPath;
+
+	public function __construct(ParameterMap $parameterMap, ServiceMap $serviceMap, string $tmpDir, ?string $containerXmlPath)
 	{
 		$this->parameterMap = $parameterMap;
 		$this->serviceMap = $serviceMap;
+		$this->tmpDir = $tmpDir;
+		$this->containerXmlPath = $containerXmlPath;
 	}
 
 	public function getKey(): string
@@ -28,6 +39,33 @@ public function getKey(): string
 	}
 
 	public function getHash(): string
+	{
+		if ($this->containerXmlPath !== null) {
+			$xmlHash = hash_file('sha256', $this->containerXmlPath);
+			if ($xmlHash === false) {
+				throw new XmlContainerNotExistsException(sprintf('Container %s does not exist', $this->containerXmlPath));
+			}
+			$xmlHashFile = sprintf('%s/%s-%s.hash', $this->tmpDir, $this->getKey(), basename($this->containerXmlPath));
+			$storedXmlHash = @file_get_contents($xmlHashFile);
+
+			$hashForResultCacheFile = sprintf('%s/%s-%s-result-cache-meta.hash', $this->tmpDir, $this->getKey(), basename($this->containerXmlPath));
+			$storedHashForResultCache = @file_get_contents($hashForResultCacheFile);
+			if ($storedXmlHash === $xmlHash && $storedHashForResultCache !== false) {
+				return $storedHashForResultCache;
+			}
+		}
+
+		$hashForResultCache = $this->calculateHash();
+
+		if ($this->containerXmlPath !== null) {
+			file_put_contents($hashForResultCacheFile, $hashForResultCache);
+			file_put_contents($xmlHashFile, $xmlHash);
+		}
+
+		return $hashForResultCache;
+	}
+
+	private function calculateHash(): string
 	{
 		$services = $parameters = [];
 

tests/Symfony/SymfonyContainerResultCacheMetaExtensionTest.php

@@ -4,13 +4,83 @@
 
 use PHPStan\Testing\PHPStanTestCase;
 use function count;
+use function file_get_contents;
+use function file_put_contents;
+use function glob;
+use function mkdir;
+use function rmdir;
+use function sprintf;
+use function sys_get_temp_dir;
+use function uniqid;
+use function unlink;
 
 /**
  * @phpstan-type ContainerContents array{parameters?: ParameterMap, services?: ServiceMap}
  */
 final class SymfonyContainerResultCacheMetaExtensionTest extends PHPStanTestCase
 {
 
+	private string $tmpDir;
+
+	protected function setUp(): void
+	{
+		parent::setUp();
+		$this->tmpDir = sys_get_temp_dir() . '/phpstan-symfony-test-' . uniqid('', true);
+		mkdir($this->tmpDir, 0777, true);
+	}
+
+	protected function tearDown(): void
+	{
+		$cacheFiles = glob($this->tmpDir . '/*.hash');
+		if ($cacheFiles !== false) {
+			foreach ($cacheFiles as $file) {
+				unlink($file);
+			}
+		}
+		rmdir($this->tmpDir);
+		parent::tearDown();
+	}
+
+	public function testHashIsCalculatedAndWrittenToCacheFileOnCacheMiss(): void
+	{
+		$containerXmlPath = __DIR__ . '/container.xml';
+
+		$extension = new SymfonyContainerResultCacheMetaExtension(
+			new DefaultParameterMap([]),
+			new DefaultServiceMap([]),
+			$this->tmpDir,
+			$containerXmlPath,
+		);
+
+		$hash = $extension->getHash();
+
+		$resultCacheHashFile = sprintf('%s/symfonyDiContainer-container.xml-result-cache-meta.hash', $this->tmpDir);
+		self::assertFileExists($resultCacheHashFile);
+		self::assertSame($hash, file_get_contents($resultCacheHashFile));
+
+		$xmlHashFile = sprintf('%s/symfonyDiContainer-container.xml.hash', $this->tmpDir);
+		self::assertFileExists($xmlHashFile);
+		self::assertSame('c55d6ac45b535d6ecc9402cbb93825c38ec7b11b03f66577d0d3549b3d9ef75f', file_get_contents($xmlHashFile));
+	}
+
+	public function testCachedHashIsReturnedOnCacheHit(): void
+	{
+		$containerXmlPath = __DIR__ . '/container.xml';
+		$xmlHashFile = sprintf('%s/symfonyDiContainer-container.xml.hash', $this->tmpDir);
+		file_put_contents($xmlHashFile, 'c55d6ac45b535d6ecc9402cbb93825c38ec7b11b03f66577d0d3549b3d9ef75f');
+		$resultCacheHashFile = sprintf('%s/symfonyDiContainer-container.xml-result-cache-meta.hash', $this->tmpDir);
+		file_put_contents($resultCacheHashFile, 'pre-computed-hash');
+
+		$extension = new SymfonyContainerResultCacheMetaExtension(
+			new DefaultParameterMap([]),
+			new DefaultServiceMap([]),
+			$this->tmpDir,
+			$containerXmlPath,
+		);
+
+		self::assertSame('pre-computed-hash', $extension->getHash());
+	}
+
 	/**
 	 * @param list<ContainerContents> $sameHashContents
 	 * @param ContainerContents $invalidatingContent
@@ -30,6 +100,8 @@ public function testContainerHashIsCalculatedCorrectly(
 			$currentHash = (new SymfonyContainerResultCacheMetaExtension(
 				$content['parameters'] ?? new DefaultParameterMap([]),
 				$content['services'] ?? new DefaultServiceMap([]),
+				__DIR__ . '/../../tmp',
+				null,
 			))->getHash();
 
 			if ($hash === null) {
@@ -44,6 +116,8 @@ public function testContainerHashIsCalculatedCorrectly(
 			(new SymfonyContainerResultCacheMetaExtension(
 				$invalidatingContent['parameters'] ?? new DefaultParameterMap([]),
 				$invalidatingContent['services'] ?? new DefaultServiceMap([]),
+				__DIR__ . '/../../tmp',
+				null,
 			))->getHash(),
 		);
 	}