Add result cache meta extension for DI container

Author: Wirone

composer.json

@@ -15,7 +15,7 @@
   "require": {
     "php": "^7.4 || ^8.0",
     "ext-simplexml": "*",
-    "phpstan/phpstan": "^2.0"
+    "phpstan/phpstan": "^2.1.2"
   },
   "conflict": {
     "symfony/framework-bundle": "<3.0"

extension.neon

@@ -363,3 +363,8 @@ services:
 	-
 		factory: PHPStan\Type\Symfony\ExtensionGetConfigurationReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+
+	-
+		class: PHPStan\Symfony\SymfonyContainerResultCacheMetaExtension
+		tags:
+			- phpstan.resultCacheMetaExtension

src/Symfony/SymfonyContainerResultCacheMetaExtension.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+use PHPStan\Analyser\ResultCache\ResultCacheMetaExtension;
+use function array_map;
+use function hash;
+use function ksort;
+use function sort;
+use function var_export;
+
+final class SymfonyContainerResultCacheMetaExtension implements ResultCacheMetaExtension
+{
+
+	private ParameterMap $parameterMap;
+
+	private ServiceMap $serviceMap;
+
+	public function __construct(ParameterMap $parameterMap, ServiceMap $serviceMap)
+	{
+		$this->parameterMap = $parameterMap;
+		$this->serviceMap = $serviceMap;
+	}
+
+	public function getKey(): string
+	{
+		return 'symfonyDiContainer';
+	}
+
+	public function getHash(): string
+	{
+		$services = $parameters = [];
+
+		foreach ($this->parameterMap->getParameters() as $parameter) {
+			$parameters[$parameter->getKey()] = $parameter->getValue();
+		}
+		ksort($parameters);
+
+		foreach ($this->serviceMap->getServices() as $service) {
+			$serviceTags = array_map(
+				static fn (ServiceTag $tag) => [
+					'name' => $tag->getName(),
+					'attributes' => $tag->getAttributes(),
+				],
+				$service->getTags(),
+			);
+			sort($serviceTags);
+
+			$services[$service->getId()] = [
+				'class' => $service->getClass(),
+				'public' => $service->isPublic() ? 'yes' : 'no',
+				'synthetic' => $service->isSynthetic() ? 'yes' : 'no',
+				'alias' => $service->getAlias(),
+				'tags' => $serviceTags,
+			];
+		}
+		ksort($services);
+
+		return hash('sha256', var_export(['parameters' => $parameters, 'services' => $services], true));
+	}
+
+}

src/Symfony/XmlParameterMapFactory.php

@@ -6,8 +6,10 @@
 use PHPStan\ShouldNotHappenException;
 use SimpleXMLElement;
 use function base64_decode;
+use function count;
 use function file_get_contents;
 use function is_numeric;
+use function ksort;
 use function simplexml_load_string;
 use function sprintf;
 use function strpos;
@@ -40,18 +42,23 @@ public function create(): ParameterMap
 
 		/** @var Parameter[] $parameters */
 		$parameters = [];
-		foreach ($xml->parameters->parameter as $def) {
-			/** @var SimpleXMLElement $attrs */
-			$attrs = $def->attributes();
 
-			$parameter = new Parameter(
-				(string) $attrs->key,
-				$this->getNodeValue($def),
-			);
+		if (count($xml->parameters) > 0) {
+			foreach ($xml->parameters->parameter as $def) {
+				/** @var SimpleXMLElement $attrs */
+				$attrs = $def->attributes();
 
-			$parameters[$parameter->getKey()] = $parameter;
+				$parameter = new Parameter(
+					(string) $attrs->key,
+					$this->getNodeValue($def),
+				);
+
+				$parameters[$parameter->getKey()] = $parameter;
+			}
 		}
 
+		ksort($parameters);
+
 		return new DefaultParameterMap($parameters);
 	}
 

src/Symfony/XmlServiceMapFactory.php

@@ -3,7 +3,9 @@
 namespace PHPStan\Symfony;
 
 use SimpleXMLElement;
+use function count;
 use function file_get_contents;
+use function ksort;
 use function simplexml_load_string;
 use function sprintf;
 use function strpos;
@@ -39,35 +41,38 @@ public function create(): ServiceMap
 		$services = [];
 		/** @var Service[] $aliases */
 		$aliases = [];
-		foreach ($xml->services->service as $def) {
-			/** @var SimpleXMLElement $attrs */
-			$attrs = $def->attributes();
-			if (!isset($attrs->id)) {
-				continue;
-			}
-
-			$serviceTags = [];
-			foreach ($def->tag as $tag) {
-				$tagAttrs = ((array) $tag->attributes())['@attributes'] ?? [];
-				$tagName = $tagAttrs['name'];
-				unset($tagAttrs['name']);
-
-				$serviceTags[] = new ServiceTag($tagName, $tagAttrs);
-			}
-
-			$service = new Service(
-				$this->cleanServiceId((string) $attrs->id),
-				isset($attrs->class) ? (string) $attrs->class : null,
-				isset($attrs->public) && (string) $attrs->public === 'true',
-				isset($attrs->synthetic) && (string) $attrs->synthetic === 'true',
-				isset($attrs->alias) ? $this->cleanServiceId((string) $attrs->alias) : null,
-				$serviceTags,
-			);
 
-			if ($service->getAlias() !== null) {
-				$aliases[] = $service;
-			} else {
-				$services[$service->getId()] = $service;
+		if (count($xml->services) > 0) {
+			foreach ($xml->services->service as $def) {
+				/** @var SimpleXMLElement $attrs */
+				$attrs = $def->attributes();
+				if (!isset($attrs->id)) {
+					continue;
+				}
+
+				$serviceTags = [];
+				foreach ($def->tag as $tag) {
+					$tagAttrs = ((array) $tag->attributes())['@attributes'] ?? [];
+					$tagName = $tagAttrs['name'];
+					unset($tagAttrs['name']);
+
+					$serviceTags[] = new ServiceTag($tagName, $tagAttrs);
+				}
+
+				$service = new Service(
+					$this->cleanServiceId((string) $attrs->id),
+					isset($attrs->class) ? (string) $attrs->class : null,
+					isset($attrs->public) && (string) $attrs->public === 'true',
+					isset($attrs->synthetic) && (string) $attrs->synthetic === 'true',
+					isset($attrs->alias) ? $this->cleanServiceId((string) $attrs->alias) : null,
+					$serviceTags,
+				);
+
+				if ($service->getAlias() !== null) {
+					$aliases[] = $service;
+				} else {
+					$services[$service->getId()] = $service;
+				}
 			}
 		}
 		foreach ($aliases as $service) {
@@ -85,6 +90,8 @@ public function create(): ServiceMap
 			);
 		}
 
+		ksort($services);
+
 		return new DefaultServiceMap($services);
 	}