Support defaultIndexMethod on AutowireLocator/AutowireIterator attribute (#161)

Author: ruudk

composer.json

@@ -16,6 +16,8 @@
         "phpstan/phpstan": "^2.1.7"
     },
     "require-dev": {
+        "composer-runtime-api": "^2.0",
+        "composer/semver": "^3.4",
         "doctrine/orm": "^2.19 || ^3.0",
         "editorconfig-checker/editorconfig-checker": "^10.6.0",
         "ergebnis/composer-normalize": "^2.45.0",
@@ -32,6 +34,7 @@
         "shipmonk/phpstan-rules": "^4.1.0",
         "slevomat/coding-standard": "^8.16.0",
         "symfony/contracts": "^2.5 || ^3.0",
+        "symfony/dependency-injection": "^5.4 || ^6.0 || ^7.0",
         "symfony/event-dispatcher": "^5.4 || ^6.0 || ^7.0",
         "symfony/http-kernel": "^5.4 || ^6.0 || ^7.0",
         "symfony/routing": "^5.4 || ^6.0 || ^7.0"

composer.lock

@@ -14,6 +14,7 @@
 use PHPStan\BetterReflection\Reflector\Exception\IdentifierNotFound;
 use PHPStan\DependencyInjection\Container;
 use PHPStan\DependencyInjection\ParameterNotFoundException;
+use PHPStan\Node\InClassMethodNode;
 use PHPStan\Node\InClassNode;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
@@ -26,6 +27,7 @@
 use ShipMonk\PHPStan\DeadCode\Graph\ClassConstantUsage;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodRef;
 use ShipMonk\PHPStan\DeadCode\Graph\ClassMethodUsage;
+use ShipMonk\PHPStan\DeadCode\Graph\UsageOriginDetector;
 use SimpleXMLElement;
 use SplFileInfo;
 use UnexpectedValueException;
@@ -62,12 +64,16 @@ class SymfonyUsageProvider implements MemberUsageProvider
      */
     private array $dicConstants = [];
 
+    private UsageOriginDetector $usageOriginDetector;
+
     public function __construct(
         Container $container,
+        UsageOriginDetector $usageOriginDetector,
         ?bool $enabled,
         ?string $configDir
     )
     {
+        $this->usageOriginDetector = $usageOriginDetector;
         $this->enabled = $enabled ?? $this->isSymfonyInstalled();
         $resolvedConfigDir = $configDir ?? $this->autodetectConfigDir();
         $containerXmlPath = $this->getContainerXmlPath($container);
@@ -97,6 +103,13 @@ public function getUsages(Node $node, Scope $scope): array
             ];
         }
 
+        if ($node instanceof InClassMethodNode) { // @phpstan-ignore phpstanApi.instanceofAssumption
+            $usages = [
+                ...$usages,
+                ...$this->getMethodUsagesFromAttributeReflection($node, $scope),
+            ];
+        }
+
         if ($node instanceof Return_) {
             $usages = [
                 ...$usages,
@@ -216,6 +229,75 @@ private function getMethodUsagesFromReflection(InClassNode $node): array
         return $usages;
     }
 
+    /**
+     * @return list<ClassMethodUsage>
+     */
+    private function getMethodUsagesFromAttributeReflection(InClassMethodNode $node, Scope $scope): array
+    {
+        $usages = [];
+
+        foreach ($node->getMethodReflection()->getParameters() as $parameter) {
+            foreach ($parameter->getAttributes() as $attributeReflection) {
+                if ($attributeReflection->getName() === 'Symfony\Component\DependencyInjection\Attribute\AutowireLocator') {
+                    $arguments = $attributeReflection->getArgumentTypes();
+
+                    if (!isset($arguments['services']) || !isset($arguments['defaultIndexMethod'])) {
+                        continue;
+                    }
+
+                    if ($arguments['services']->isArray()->yes()) {
+                        $classNames = $arguments['services']->getIterableValueType()->getConstantStrings();
+                    } else {
+                        $classNames = $arguments['services']->getConstantStrings();
+                    }
+
+                    $defaultIndexMethod = $arguments['defaultIndexMethod']->getConstantStrings();
+
+                    if ($classNames === [] || !isset($defaultIndexMethod[0])) {
+                        continue;
+                    }
+
+                    foreach ($classNames as $className) {
+                        $usages[] = new ClassMethodUsage(
+                            $this->usageOriginDetector->detectOrigin($scope),
+                            new ClassMethodRef(
+                                $className->getValue(),
+                                $defaultIndexMethod[0]->getValue(),
+                                true,
+                            ),
+                        );
+                    }
+                } elseif ($attributeReflection->getName() === 'Symfony\Component\DependencyInjection\Attribute\AutowireIterator') {
+                    $arguments = $attributeReflection->getArgumentTypes();
+
+                    if (!isset($arguments['tag']) || !isset($arguments['defaultIndexMethod'])) {
+                        continue;
+                    }
+
+                    $classNames = $arguments['tag']->getConstantStrings();
+                    $defaultIndexMethod = $arguments['defaultIndexMethod']->getConstantStrings();
+
+                    if ($classNames === [] || !isset($defaultIndexMethod[0])) {
+                        continue;
+                    }
+
+                    foreach ($classNames as $className) {
+                        $usages[] = new ClassMethodUsage(
+                            $this->usageOriginDetector->detectOrigin($scope),
+                            new ClassMethodRef(
+                                $className->getValue(),
+                                $defaultIndexMethod[0]->getValue(),
+                                true,
+                            ),
+                        );
+                    }
+                }
+            }
+        }
+
+        return $usages;
+    }
+
     protected function shouldMarkAsUsed(ReflectionMethod $method): bool
     {
         return $this->isBundleConstructor($method)
@@ -395,7 +477,8 @@ private function isSymfonyInstalled(): bool
             || InstalledVersions::isInstalled('symfony/routing')
             || InstalledVersions::isInstalled('symfony/contracts')
             || InstalledVersions::isInstalled('symfony/console')
-            || InstalledVersions::isInstalled('symfony/http-kernel');
+            || InstalledVersions::isInstalled('symfony/http-kernel')
+            || InstalledVersions::isInstalled('symfony/dependency-injection');
     }
 
     private function createUsage(ExtendedMethodReflection $methodReflection): ClassMethodUsage

src/Provider/SymfonyUsageProvider.php

@@ -2,6 +2,8 @@
 
 namespace ShipMonk\PHPStan\DeadCode\Rule;
 
+use Composer\InstalledVersions;
+use Composer\Semver\VersionParser;
 use PhpParser\Node;
 use PHPStan\Analyser\Error;
 use PHPStan\Analyser\Scope;
@@ -391,6 +393,11 @@ public static function provideFiles(): iterable
         yield 'provider-vendor' => [__DIR__ . '/data/providers/vendor.php'];
         yield 'provider-reflection' => [__DIR__ . '/data/providers/reflection.php', 8_01_00];
         yield 'provider-symfony' => [__DIR__ . '/data/providers/symfony.php', 8_00_00];
+
+        if (InstalledVersions::satisfies(new VersionParser(), 'symfony/dependency-injection', '^7.1')) {
+            yield 'provider-symfony-7.1' => [__DIR__ . '/data/providers/symfony-gte71.php', 8_00_00];
+        }
+
         yield 'provider-phpunit' => [__DIR__ . '/data/providers/phpunit.php', 8_00_00];
         yield 'provider-doctrine' => [__DIR__ . '/data/providers/doctrine.php', 8_00_00];
         yield 'provider-phpstan' => [__DIR__ . '/data/providers/phpstan.php'];
@@ -478,6 +485,7 @@ public function shouldMarkMethodAsUsed(ReflectionMethod $method): bool
             ),
             new SymfonyUsageProvider(
                 $this->createContainerMockWithSymfonyConfig(),
+                new UsageOriginDetector(),
                 true,
                 __DIR__ . '/data/providers/symfony/',
             ),