Add LaravelContainerMakeTypeExtension to fill Container->make() return type (#6)

Author: TomasVotruba

composer.json

@@ -8,6 +8,7 @@
         "phpstan/phpstan": "^1.10"
     },
     "require-dev": {
+        "illuminate/container": "^10.23",
         "php-parallel-lint/php-parallel-lint": "^1.3",
         "phpstan/extension-installer": "^1.2",
         "phpunit/phpunit": "^10.3",

config/config.neon

@@ -2,6 +2,10 @@ includes:
     - symplify.error_formatter.neon
 
 services:
+    -
+        class: Symplify\PHPStanExtensions\TypeExtension\MethodCall\LaravelContainerMakeTypeExtension
+        tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+
     # Symfony Container::get($1) => $1 type
     -
         class: Symplify\PHPStanExtensions\TypeExtension\MethodCall\ContainerGetReturnTypeExtension

src/TypeExtension/MethodCall/LaravelContainerMakeTypeExtension.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanExtensions\TypeExtension\MethodCall;
+
+use Illuminate\Container\Container;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\Type;
+use Symplify\PHPStanExtensions\TypeResolver\ClassConstFetchReturnTypeResolver;
+
+/**
+ * Helps to check Container->make() return type
+ */
+final class LaravelContainerMakeTypeExtension implements DynamicMethodReturnTypeExtension
+{
+    public function __construct(
+        private readonly ClassConstFetchReturnTypeResolver $classConstFetchReturnTypeResolver
+    ) {
+    }
+
+    public function getClass(): string
+    {
+        return Container::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection): bool
+    {
+        return in_array($methodReflection->getName(), ['make', 'get'], true);
+    }
+
+    public function getTypeFromMethodCall(
+        MethodReflection $methodReflection,
+        MethodCall $methodCall,
+        Scope $scope
+    ): Type {
+        return $this->classConstFetchReturnTypeResolver->resolve($methodReflection, $methodCall);
+    }
+}

tests/TypeExtension/MethodCall/LaravelContainerMakeTypeExtension/ContainerGetReturnTypeExtensionTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanExtensions\Tests\TypeExtension\MethodCall\LaravelContainerMakeTypeExtension;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class ContainerGetReturnTypeExtensionTest extends TypeInferenceTestCase
+{
+    public function testAsserts(): void
+    {
+        foreach ($this->gatherAssertTypes(__DIR__ . '/data/fixture.php') as [$assertType, $file, $expectedType, $actualType, $line]) {
+            $this->assertFileAsserts($assertType, $file, ...[$expectedType, $actualType, $line]);
+        }
+    }
+
+    /**
+     * @return string[]
+     */
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [__DIR__ . '/config/config.neon'];
+    }
+}

tests/TypeExtension/MethodCall/LaravelContainerMakeTypeExtension/Source/ExternalService.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanExtensions\Tests\TypeExtension\MethodCall\LaravelContainerMakeTypeExtension\Source;
+
+final class ExternalService
+{
+}

tests/TypeExtension/MethodCall/LaravelContainerMakeTypeExtension/config/config.neon

@@ -0,0 +1,6 @@
+services:
+    - Symplify\PHPStanExtensions\TypeResolver\ClassConstFetchReturnTypeResolver
+
+    -
+        class: Symplify\PHPStanExtensions\TypeExtension\MethodCall\LaravelContainerMakeTypeExtension
+        tags: [phpstan.broker.dynamicMethodReturnTypeExtension]

tests/TypeExtension/MethodCall/LaravelContainerMakeTypeExtension/data/fixture.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Container\Container;
+use Symplify\PHPStanExtensions\Tests\TypeExtension\MethodCall\ContainerGetReturnTypeExtension\Source\ExternalService;
+use function PHPStan\Testing\assertType;
+
+final class SomeClass
+{
+    public function run(Container $container): void
+    {
+        $services = $container->make(ExternalService::class);
+        assertType(ExternalService::class, $services);
+
+        $services = $container->get(ExternalService::class);
+        assertType(ExternalService::class, $services);
+    }
+}