Result cache: dependencies on values declared through $scope->valueDependency()

A rule or a dynamic return type extension that reads something the result
cache does not know about - a DI container, a config file - declares it with
$scope->valueDependency(SomeValueExtension::class, $key). The extension, a
ResultCacheValueExtension, returns the value for the key. The value is stored
in the result cache, and when it's different on the next run, the files that
asked for it are re-analysed.

The same value declared more times, by one or several rules and extensions,
is recorded once. When it's declared outside the walk of the analysed file,
like when a private property type is inferred from the constructor, it is the
file of the scope that depends on it, together with the files depending on
that file.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdwtgiEHwkF5BTz73jgHQQ

Author: ondrejmirtes

.github/workflows/e2e-tests.yml

@@ -442,6 +442,71 @@ jobs:
               echo "$INFO"
               ../bashunit -a equals 'true' "$(echo "$INFO" | jq --raw-output '.resultCacheUsed')"
               ../bashunit -a equals '1' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+          - script: |
+              cd e2e/result-cache-value-dependency
+              composer install
+              OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
+              echo "$OUTPUT"
+              ../bashunit -a contains 'UsesCache.php:7:Service cache does not exist.' "$OUTPUT"
+              ../bashunit -a contains "UsesLocale.php:10:Function ResultCacheE2EValueDependency\usesLocale() should return 'none' but returns 'cs'." "$OUTPUT"
+              ../bashunit -a contains "UsesLocaleToo.php:10:Function ResultCacheE2EValueDependency\usesLocaleToo() should return 'none' but returns 'cs'." "$OUTPUT"
+              ../bashunit -a contains 'Holder.php:17:Method ResultCacheE2EValueDependency\Holder::isDebug() should return int but returns string.' "$OUTPUT"
+              ../bashunit -a contains 'UsesHolder.php:9:Function ResultCacheE2EValueDependency\usesHolder() should return int but returns string.' "$OUTPUT"
+              ../bashunit -a not_contains 'UsesMailer.php' "$OUTPUT"
+              # The extensions read container.json, which the result cache knows nothing about. A rule and a
+              # dynamic return type extension both declare the service they ask about - it is recorded once.
+              # A change of its value re-analyses only the file asking about it.
+              php -r '$c = json_decode(file_get_contents("container.json"), true); $c["services"]["mailer"] = "ResultCacheE2EValueDependency\\Logger"; file_put_contents("container.json", json_encode($c, JSON_PRETTY_PRINT));'
+              INFO=$(../../bin/phpstan result-cache-info --json)
+              echo "$INFO"
+              ../bashunit -a equals '1' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+              OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
+              echo "$OUTPUT"
+              ../bashunit -a contains 'UsesMailer.php:7:Call to an undefined method ResultCacheE2EValueDependency\Logger::send().' "$OUTPUT"
+              # Values nobody asked about do not re-analyse anything.
+              php -r '$c = json_decode(file_get_contents("container.json"), true); $c["parameters"]["timezone"] = "UTC"; $c["services"]["router"] = "ResultCacheE2EValueDependency\\Logger"; file_put_contents("container.json", json_encode($c, JSON_PRETTY_PRINT));'
+              INFO=$(../../bin/phpstan result-cache-info --json)
+              echo "$INFO"
+              ../bashunit -a equals '0' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+              # A value that was missing is watched too.
+              php -r '$c = json_decode(file_get_contents("container.json"), true); $c["services"]["cache"] = "ResultCacheE2EValueDependency\\Logger"; file_put_contents("container.json", json_encode($c, JSON_PRETTY_PRINT));'
+              INFO=$(../../bin/phpstan result-cache-info --json)
+              echo "$INFO"
+              ../bashunit -a equals '1' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+              OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
+              echo "$OUTPUT"
+              ../bashunit -a not_contains 'Service cache does not exist.' "$OUTPUT"
+              # Every file asking about the same value is re-analysed.
+              php -r '$c = json_decode(file_get_contents("container.json"), true); $c["parameters"]["locale"] = "en"; file_put_contents("container.json", json_encode($c, JSON_PRETTY_PRINT));'
+              INFO=$(../../bin/phpstan result-cache-info --json)
+              echo "$INFO"
+              ../bashunit -a equals '2' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+              OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
+              echo "$OUTPUT"
+              ../bashunit -a contains "UsesLocale.php:10:Function ResultCacheE2EValueDependency\usesLocale() should return 'none' but returns 'en'." "$OUTPUT"
+              ../bashunit -a contains "UsesLocaleToo.php:10:Function ResultCacheE2EValueDependency\usesLocaleToo() should return 'none' but returns 'en'." "$OUTPUT"
+              # Scope::getFile() is not the file to re-analyse when the extension runs outside the walk of the
+              # analysed file: the type of Holder::$debug is inferred from the constructor on a scope of
+              # src/Holder.php, whenever the property is first needed, and it is cached. So it is what
+              # src/Holder.php declares that depends on the value: a change of it re-analyses src/Holder.php and
+              # the files depending on it.
+              php -r '$c = json_decode(file_get_contents("container.json"), true); $c["parameters"]["debug"] = "1"; file_put_contents("container.json", json_encode($c, JSON_PRETTY_PRINT));'
+              INFO=$(../../bin/phpstan result-cache-info --json)
+              echo "$INFO"
+              ../bashunit -a equals '2' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+              OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
+              echo "$OUTPUT"
+              ../bashunit -a not_contains 'Holder.php' "$OUTPUT"
+              # Inside a trait, the value is asked about in the analysis of the class using it - that's the
+              # file re-analysed, and the error is reported in the trait.
+              php -r '$c = json_decode(file_get_contents("container.json"), true); $c["services"]["logger"] = "ResultCacheE2EValueDependency\\Mailer"; file_put_contents("container.json", json_encode($c, JSON_PRETTY_PRINT));'
+              INFO=$(../../bin/phpstan result-cache-info --json)
+              echo "$INFO"
+              ../bashunit -a equals '2' "$(echo "$INFO" | jq --raw-output '.filesToAnalyseCount')"
+              OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
+              echo "$OUTPUT"
+              ../bashunit -a contains 'UsesLogger.php:7:Call to an undefined method ResultCacheE2EValueDependency\Mailer::log().' "$OUTPUT"
+              ../bashunit -a contains 'LoggerTrait.php (in context of class ResultCacheE2EValueDependency\UsesLoggerTrait):10:Call to an undefined method ResultCacheE2EValueDependency\Mailer::log().' "$OUTPUT"
           - script: |
               cd e2e/result-cache-scanned-trait
               ../../bin/phpstan analyse

e2e/result-cache-value-dependency/.gitignore

@@ -0,0 +1 @@
+/vendor

e2e/result-cache-value-dependency/composer.json

@@ -0,0 +1,5 @@
+{
+	"autoload-dev": {
+		"classmap": ["extension/"]
+	}
+}

e2e/result-cache-value-dependency/composer.lock

@@ -0,0 +1,11 @@
+{
+	"services": {
+		"mailer": "ResultCacheE2EValueDependency\\Mailer",
+		"logger": "ResultCacheE2EValueDependency\\Logger"
+	},
+	"parameters": {
+		"locale": "cs",
+		"timezone": "Europe/Prague",
+		"debug": "yes"
+	}
+}

e2e/result-cache-value-dependency/container.json

@@ -0,0 +1,33 @@
+<?php declare(strict_types = 1);
+
+namespace ResultCacheE2EValueDependency;
+
+/**
+ * Stands for a compiled DI container the analysed code gets its services and parameters from.
+ */
+final class Container
+{
+
+	public static function getService(string $id): ?string
+	{
+		return self::read()['services'][$id] ?? null;
+	}
+
+	public static function getParameter(string $name): ?string
+	{
+		return self::read()['parameters'][$name] ?? null;
+	}
+
+	/**
+	 * @return array{services: array<string, string>, parameters: array<string, string>}
+	 */
+	private static function read(): array
+	{
+		$contents = file_get_contents(dirname(__DIR__) . '/container.json');
+		/** @var array{services: array<string, string>, parameters: array<string, string>} $container */
+		$container = json_decode($contents === false ? '{}' : $contents, true);
+
+		return $container;
+	}
+
+}

e2e/result-cache-value-dependency/extension/Container.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types = 1);
+
+namespace ResultCacheE2EValueDependency;
+
+use PHPStan\Analyser\ResultCache\ResultCacheValueExtension;
+
+final class HasServiceValueExtension implements ResultCacheValueExtension
+{
+
+	public function getValue(string $key): string
+	{
+		return Container::getService($key) ?? 'missing';
+	}
+
+	public function keyToResultCache(string $key): string
+	{
+		return $key;
+	}
+
+	public function keyFromResultCache(string $storedKey): string
+	{
+		return $storedKey;
+	}
+
+}

e2e/result-cache-value-dependency/extension/HasServiceValueExtension.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types = 1);
+
+namespace ResultCacheE2EValueDependency;
+
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\DependencyEmitter;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Type\Constant\ConstantIntegerType;
+use PHPStan\Type\Constant\ConstantStringType;
+use PHPStan\Type\DynamicFunctionReturnTypeExtension;
+use PHPStan\Type\Type;
+
+final class ParameterReturnTypeExtension implements DynamicFunctionReturnTypeExtension
+{
+
+	public function isFunctionSupported(FunctionReflection $functionReflection): bool
+	{
+		return $functionReflection->getName() === 'ResultCacheE2EValueDependency\parameter';
+	}
+
+	/**
+	 * @param Scope&DependencyEmitter $scope
+	 */
+	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type
+	{
+		$arg = $functionCall->getArgs()[0]->value ?? null;
+		if (!$arg instanceof String_) {
+			return null;
+		}
+
+		$scope->valueDependency(ParameterValueExtension::class, $arg->value);
+		$value = Container::getParameter($arg->value);
+		if ($value === null) {
+			return null;
+		}
+
+		return is_numeric($value) ? new ConstantIntegerType((int) $value) : new ConstantStringType($value);
+	}
+
+}

e2e/result-cache-value-dependency/extension/ParameterReturnTypeExtension.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types = 1);
+
+namespace ResultCacheE2EValueDependency;
+
+use PHPStan\Analyser\ResultCache\ResultCacheValueExtension;
+
+final class ParameterValueExtension implements ResultCacheValueExtension
+{
+
+	public function getValue(string $key): string
+	{
+		return Container::getParameter($key) ?? 'missing';
+	}
+
+	public function keyToResultCache(string $key): string
+	{
+		return $key;
+	}
+
+	public function keyFromResultCache(string $storedKey): string
+	{
+		return $storedKey;
+	}
+
+}

e2e/result-cache-value-dependency/extension/ParameterValueExtension.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types = 1);
+
+namespace ResultCacheE2EValueDependency;
+
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\DependencyEmitter;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Type\DynamicFunctionReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+
+final class ServiceReturnTypeExtension implements DynamicFunctionReturnTypeExtension
+{
+
+	public function isFunctionSupported(FunctionReflection $functionReflection): bool
+	{
+		return $functionReflection->getName() === 'ResultCacheE2EValueDependency\service';
+	}
+
+	/**
+	 * @param Scope&DependencyEmitter $scope
+	 */
+	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type
+	{
+		$arg = $functionCall->getArgs()[0]->value ?? null;
+		if (!$arg instanceof String_) {
+			return null;
+		}
+
+		// the same value ServiceRule declares - recorded once
+		$scope->valueDependency(HasServiceValueExtension::class, $arg->value);
+		$class = Container::getService($arg->value);
+
+		return $class !== null ? new ObjectType($class) : null;
+	}
+
+}