feature symfony#59804 [TypeInfo] Add type alias support (mtarld)

nicolas-grekas · nicolas-grekas · commit 77b8358f6a0e · 2025-02-19T17:26:21.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [TypeInfo] Add type alias support | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | | License | MIT Add type aliasing support in `TypeContext` and `StringTypeResolver`, which enables the read of ``@phpstan`-type` and ``@phpstan`-import-type`. With this PR, the following code will be properly understood by TypeInfo (before, it used to throw an `UnhandledException`): ```php /** * `@phpstan`-type TypeAlias = array<string, list<bool>> */ final class Dummy { /** * `@var` TypeAlias */ public mixed $aliasedType; } ``` Commits ------- d0d85af [TypeInfo] Add type alias support
diff --git a/src/Symfony/Component/TypeInfo/CHANGELOG.md b/src/Symfony/Component/TypeInfo/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * Add `TypeFactoryTrait::fromValue()` method
  * Deprecate constructing a `CollectionType` instance as a list that is not an array
  * Deprecate the third `$asList` argument of `TypeFactoryTrait::iterable()`, use `TypeFactoryTrait::list()` instead
+ * Add type alias support in `TypeContext` and `StringTypeResolver`
 
 7.2
 ---
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/AbstractDummy.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/AbstractDummy.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 abstract class AbstractDummy
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/Dummy.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/Dummy.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 final class Dummy extends AbstractDummy
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyBackedEnum.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyBackedEnum.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 enum DummyBackedEnum: string
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyCollection.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyCollection.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 final class DummyCollection implements \IteratorAggregate
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyEnum.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyEnum.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 enum DummyEnum
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyExtendingStdClass.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyExtendingStdClass.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 final class DummyExtendingStdClass extends \stdClass
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithPhpDoc.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithPhpDoc.php
@@ -1,14 +1,32 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
+/**
+ * @phpstan-type CustomInt = int
+ * @psalm-type PsalmCustomInt = int
+ */
 final class DummyWithPhpDoc
 {
     /**
      * @var array<Dummy>
      */
     public mixed $arrayOfDummies = [];
 
+    /**
+     * @var CustomInt
+     */
+    public mixed $aliasedInt;
+
     /**
      * @param bool $promoted
      */
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithTemplates.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithTemplates.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 /**
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithTypeAliases.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithTypeAliases.php
@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\TypeInfo\Tests\Fixtures;
+
+/**
+ * @phpstan-type CustomString = string
+ * @phpstan-import-type CustomInt from DummyWithPhpDoc
+ * @phpstan-import-type CustomInt from DummyWithPhpDoc as AliasedCustomInt
+ *
+ * @psalm-type PsalmCustomString = string
+ * @psalm-import-type PsalmCustomInt from DummyWithPhpDoc
+ * @psalm-import-type PsalmCustomInt from DummyWithPhpDoc as PsalmAliasedCustomInt
+ */
+final class DummyWithTypeAliases
+{
+    /**
+     * @var CustomString
+     */
+    public mixed $localAlias;
+
+    /**
+     * @var CustomInt
+     */
+    public mixed $externalAlias;
+
+    /**
+     * @var AliasedCustomInt
+     */
+    public mixed $aliasedExternalAlias;
+
+    /**
+     * @var PsalmCustomString
+     */
+    public mixed $psalmLocalAlias;
+
+    /**
+     * @var PsalmCustomInt
+     */
+    public mixed $psalmExternalAlias;
+
+    /**
+     * @var PsalmAliasedCustomInt
+     */
+    public mixed $psalmOtherAliasedExternalAlias;
+}
+
+/**
+ * @phpstan-import-type Invalid from DummyWithTypeAliases
+ */
+final class DummyWithInvalidTypeAliasImport
+{
+}
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithUses.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithUses.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 use Symfony\Component\TypeInfo\Type;
diff --git a/src/Symfony/Component/TypeInfo/Tests/Fixtures/ReflectionExtractableDummy.php b/src/Symfony/Component/TypeInfo/Tests/Fixtures/ReflectionExtractableDummy.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Component\TypeInfo\Tests\Fixtures;
 
 final class ReflectionExtractableDummy extends AbstractDummy
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeContext/TypeContextFactoryTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeContext/TypeContextFactoryTest.php
@@ -12,9 +12,12 @@
 namespace Symfony\Component\TypeInfo\Tests\TypeContext;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\TypeInfo\Exception\LogicException;
 use Symfony\Component\TypeInfo\Tests\Fixtures\AbstractDummy;
 use Symfony\Component\TypeInfo\Tests\Fixtures\Dummy;
+use Symfony\Component\TypeInfo\Tests\Fixtures\DummyWithInvalidTypeAliasImport;
 use Symfony\Component\TypeInfo\Tests\Fixtures\DummyWithTemplates;
+use Symfony\Component\TypeInfo\Tests\Fixtures\DummyWithTypeAliases;
 use Symfony\Component\TypeInfo\Tests\Fixtures\DummyWithUses;
 use Symfony\Component\TypeInfo\Type;
 use Symfony\Component\TypeInfo\TypeContext\TypeContextFactory;
@@ -119,4 +122,49 @@ public function testDoNotCollectTemplatesWhenToStringTypeResolver()
 
         $this->assertEquals([], $typeContextFactory->createFromClassName(DummyWithTemplates::class)->templates);
     }
+
+    public function testCollectTypeAliases()
+    {
+        $this->assertEquals([
+            'CustomString' => Type::string(),
+            'CustomInt' => Type::int(),
+            'AliasedCustomInt' => Type::int(),
+            'PsalmCustomString' => Type::string(),
+            'PsalmCustomInt' => Type::int(),
+            'PsalmAliasedCustomInt' => Type::int(),
+        ], $this->typeContextFactory->createFromClassName(DummyWithTypeAliases::class)->typeAliases);
+
+        $this->assertEquals([
+            'CustomString' => Type::string(),
+            'CustomInt' => Type::int(),
+            'AliasedCustomInt' => Type::int(),
+            'PsalmCustomString' => Type::string(),
+            'PsalmCustomInt' => Type::int(),
+            'PsalmAliasedCustomInt' => Type::int(),
+        ], $this->typeContextFactory->createFromReflection(new \ReflectionClass(DummyWithTypeAliases::class))->typeAliases);
+
+        $this->assertEquals([
+            'CustomString' => Type::string(),
+            'CustomInt' => Type::int(),
+            'AliasedCustomInt' => Type::int(),
+            'PsalmCustomString' => Type::string(),
+            'PsalmCustomInt' => Type::int(),
+            'PsalmAliasedCustomInt' => Type::int(),
+        ], $this->typeContextFactory->createFromReflection(new \ReflectionProperty(DummyWithTypeAliases::class, 'localAlias'))->typeAliases);
+    }
+
+    public function testDoNotCollectTypeAliasesWhenToStringTypeResolver()
+    {
+        $typeContextFactory = new TypeContextFactory();
+
+        $this->assertEquals([], $typeContextFactory->createFromClassName(DummyWithTypeAliases::class)->typeAliases);
+    }
+
+    public function testThrowWhenImportingInvalidAlias()
+    {
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage(\sprintf('Cannot find any "Invalid" type alias in "%s".', DummyWithTypeAliases::class));
+
+        $this->typeContextFactory->createFromClassName(DummyWithInvalidTypeAliasImport::class);
+    }
 }
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/PhpDocAwareReflectionTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/PhpDocAwareReflectionTypeResolverTest.php
@@ -22,15 +22,28 @@
 
 class PhpDocAwareReflectionTypeResolverTest extends TestCase
 {
-    public function testReadPhpDoc()
+    /**
+     * @dataProvider readPhpDocDataProvider
+     */
+    public function testReadPhpDoc(Type $expected, \Reflector $reflector)
+    {
+        $resolver = new PhpDocAwareReflectionTypeResolver(TypeResolver::create(), new StringTypeResolver(), new TypeContextFactory(new StringTypeResolver()));
+
+        $this->assertEquals($expected, $resolver->resolve($reflector));
+    }
+
+    /**
+     * @return iterable<array{0: Type, 1: \Reflector}>
+     */
+    public static function readPhpDocDataProvider(): iterable
     {
-        $resolver = new PhpDocAwareReflectionTypeResolver(TypeResolver::create(), new StringTypeResolver(), new TypeContextFactory());
         $reflection = new \ReflectionClass(DummyWithPhpDoc::class);
 
-        $this->assertEquals(Type::array(Type::object(Dummy::class)), $resolver->resolve($reflection->getProperty('arrayOfDummies')));
-        $this->assertEquals(Type::bool(), $resolver->resolve($reflection->getProperty('promoted')));
-        $this->assertEquals(Type::object(Dummy::class), $resolver->resolve($reflection->getMethod('getNextDummy')));
-        $this->assertEquals(Type::object(Dummy::class), $resolver->resolve($reflection->getMethod('getNextDummy')->getParameters()[0]));
+        yield [Type::array(Type::object(Dummy::class)), $reflection->getProperty('arrayOfDummies')];
+        yield [Type::bool(), $reflection->getProperty('promoted')];
+        yield [Type::object(Dummy::class), $reflection->getMethod('getNextDummy')];
+        yield [Type::object(Dummy::class), $reflection->getMethod('getNextDummy')->getParameters()[0]];
+        yield [Type::int(), $reflection->getProperty('aliasedInt')];
     }
 
     public function testFallbackWhenNoPhpDoc()
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php
@@ -20,6 +20,7 @@
 use Symfony\Component\TypeInfo\Tests\Fixtures\DummyCollection;
 use Symfony\Component\TypeInfo\Tests\Fixtures\DummyEnum;
 use Symfony\Component\TypeInfo\Tests\Fixtures\DummyWithTemplates;
+use Symfony\Component\TypeInfo\Tests\Fixtures\DummyWithTypeAliases;
 use Symfony\Component\TypeInfo\Type;
 use Symfony\Component\TypeInfo\TypeContext\TypeContext;
 use Symfony\Component\TypeInfo\TypeContext\TypeContextFactory;
@@ -175,6 +176,10 @@ public static function resolveDataProvider(): iterable
         yield [Type::collection(Type::object(\IteratorAggregate::class), Type::string()), \IteratorAggregate::class.'<string>'];
         yield [Type::collection(Type::object(\IteratorAggregate::class), Type::bool(), Type::string()), \IteratorAggregate::class.'<string, bool>'];
         yield [Type::collection(Type::object(DummyCollection::class), Type::bool(), Type::string()), DummyCollection::class.'<string, bool>'];
+
+        // type aliases
+        yield [Type::int(), 'CustomInt', $typeContextFactory->createFromClassName(DummyWithTypeAliases::class)];
+        yield [Type::string(), 'CustomString', $typeContextFactory->createFromClassName(DummyWithTypeAliases::class)];
     }
 
     public function testCannotResolveNonStringType()
diff --git a/src/Symfony/Component/TypeInfo/TypeContext/TypeContext.php b/src/Symfony/Component/TypeInfo/TypeContext/TypeContext.php
@@ -33,13 +33,15 @@ final class TypeContext
     /**
      * @param array<string, string> $uses
      * @param array<string, Type>   $templates
+     * @param array<string, Type>   $typeAliases
      */
     public function __construct(
         public readonly string $calledClassName,
         public readonly string $declaringClassName,
         public readonly ?string $namespace = null,
         public readonly array $uses = [],
         public readonly array $templates = [],
+        public readonly array $typeAliases = [],
     ) {
     }
 
diff --git a/src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php b/src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php
