[PropertyAccessor] Fix unexpected collection when generics

mtarld · mtarld · commit e31aeebbba2b · 2024-04-18T14:57:14.000+02:00
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php
@@ -428,6 +428,11 @@ public function testUnknownPseudoType()
         $this->assertEquals([new Type(Type::BUILTIN_TYPE_OBJECT, false, 'scalar')], $this->extractor->getTypes(PseudoTypeDummy::class, 'unknownPseudoType'));
     }
 
+    public function testGenericInterface()
+    {
+        $this->assertNull($this->extractor->getTypes(Dummy::class, 'genericInterface'));
+    }
+
     protected static function isPhpDocumentorV5()
     {
         if (class_exists(InvalidTag::class)) {
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpStanExtractorTest.php
@@ -388,7 +388,7 @@ public static function unionTypesProvider(): array
             ['b', [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [new Type(Type::BUILTIN_TYPE_INT)], [new Type(Type::BUILTIN_TYPE_STRING), new Type(Type::BUILTIN_TYPE_INT)])]],
             ['c', [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [], [new Type(Type::BUILTIN_TYPE_STRING), new Type(Type::BUILTIN_TYPE_INT)])]],
             ['d', [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [new Type(Type::BUILTIN_TYPE_STRING), new Type(Type::BUILTIN_TYPE_INT)], [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [], [new Type(Type::BUILTIN_TYPE_STRING)])])]],
-            ['e', [new Type(Type::BUILTIN_TYPE_OBJECT, true, Dummy::class, true, [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [], [new Type(Type::BUILTIN_TYPE_STRING)])], [new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [new Type(Type::BUILTIN_TYPE_INT)], [new Type(Type::BUILTIN_TYPE_STRING, false, null, true, [], [new Type(Type::BUILTIN_TYPE_OBJECT, false, DefaultValue::class)])])]), new Type(Type::BUILTIN_TYPE_OBJECT, false, ParentDummy::class)]],
+            ['e', [new Type(Type::BUILTIN_TYPE_OBJECT, true, Dummy::class, false, [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [], [new Type(Type::BUILTIN_TYPE_STRING)])], [new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [new Type(Type::BUILTIN_TYPE_INT)], [new Type(Type::BUILTIN_TYPE_OBJECT, false, \Traversable::class, true, [], [new Type(Type::BUILTIN_TYPE_OBJECT, false, DefaultValue::class)])])]), new Type(Type::BUILTIN_TYPE_OBJECT, false, ParentDummy::class)]],
             ['f', null],
             ['g', [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, [], [new Type(Type::BUILTIN_TYPE_STRING), new Type(Type::BUILTIN_TYPE_INT)])]],
         ];
@@ -427,6 +427,11 @@ public static function intRangeTypeProvider(): array
             ['c', [new Type(Type::BUILTIN_TYPE_INT)]],
         ];
     }
+
+    public function testGenericInterface()
+    {
+        $this->assertNull($this->extractor->getTypes(Dummy::class, 'genericInterface'));
+    }
 }
 
 class PhpStanOmittedParamTagTypeDocBlock
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/ReflectionExtractorTest.php
@@ -73,6 +73,7 @@ public function testGetProperties()
                 'arrayOfMixed',
                 'listOfStrings',
                 'parentAnnotation',
+                'genericInterface',
                 'foo',
                 'foo2',
                 'foo3',
@@ -137,6 +138,7 @@ public function testGetPropertiesWithCustomPrefixes()
                 'arrayOfMixed',
                 'listOfStrings',
                 'parentAnnotation',
+                'genericInterface',
                 'foo',
                 'foo2',
                 'foo3',
@@ -190,6 +192,7 @@ public function testGetPropertiesWithNoPrefixes()
                 'arrayOfMixed',
                 'listOfStrings',
                 'parentAnnotation',
+                'genericInterface',
                 'foo',
                 'foo2',
                 'foo3',
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/Dummy.php
@@ -165,6 +165,11 @@ class Dummy extends ParentDummy
      */
     public $parentAnnotation;
 
+    /**
+     * @var \BackedEnum<string>
+     */
+    public $genericInterface;
+
     public static function getStatic()
     {
     }
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Fixtures/DummyUnionType.php b/src/Symfony/Component/PropertyInfo/Tests/Fixtures/DummyUnionType.php
@@ -40,7 +40,7 @@ class DummyUnionType
     public $d;
 
     /**
-     * @var (Dummy<array<mixed, string>, (int | (string<DefaultValue>)[])> | ParentDummy | null)
+     * @var (Dummy<array<mixed, string>, (int | (\Traversable<DefaultValue>)[])> | ParentDummy | null)
      */
     public $e;
 
diff --git a/src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php b/src/Symfony/Component/PropertyInfo/Util/PhpDocTypeHelper.php
@@ -102,9 +102,9 @@ public function getTypes(DocType $varType): array
     /**
      * Creates a {@see Type} from a PHPDoc type.
      */
-    private function createType(DocType $type, bool $nullable, ?string $docType = null): ?Type
+    private function createType(DocType $type, bool $nullable): ?Type
     {
-        $docType = $docType ?? (string) $type;
+        $docType = (string) $type;
 
         if ($type instanceof Collection) {
             $fqsen = $type->getFqsen();
@@ -115,10 +115,17 @@ private function createType(DocType $type, bool $nullable, ?string $docType = nu
 
             [$phpType, $class] = $this->getPhpTypeAndClass((string) $fqsen);
 
+            $collection = \is_a($class, \Traversable::class, true) || \is_a($class, \ArrayAccess::class, true);
+
+            // it's safer to fall back to other extractors if the generic type is too abstract
+            if (!$collection && !class_exists($class)) {
+                return null;
+            }
+
             $keys = $this->getTypes($type->getKeyType());
             $values = $this->getTypes($type->getValueType());
 
-            return new Type($phpType, $nullable, $class, true, $keys, $values);
+            return new Type($phpType, $nullable, $class, $collection, $keys, $values);
         }
 
         // Cannot guess
diff --git a/src/Symfony/Component/PropertyInfo/Util/PhpStanTypeHelper.php b/src/Symfony/Component/PropertyInfo/Util/PhpStanTypeHelper.php
@@ -121,6 +121,13 @@ private function extractTypes(TypeNode $node, NameScope $nameScope): array
                 return [$mainType];
             }
 
+            $collection = $mainType->isCollection() || \in_array($mainType->getClassName(), [\Traversable::class, \Iterator::class, \IteratorAggregate::class, \ArrayAccess::class, \Generator::class], true);
+
+            // it's safer to fall back to other extractors if the generic type is too abstract
+            if (!$collection && !class_exists($mainType->getClassName())) {
+                return [];
+            }
+
             $collectionKeyTypes = $mainType->getCollectionKeyTypes();
             $collectionKeyValues = [];
             if (1 === \count($node->genericTypes)) {
@@ -136,7 +143,7 @@ private function extractTypes(TypeNode $node, NameScope $nameScope): array
                 }
             }
 
-            return [new Type($mainType->getBuiltinType(), $mainType->isNullable(), $mainType->getClassName(), true, $collectionKeyTypes, $collectionKeyValues)];
+            return [new Type($mainType->getBuiltinType(), $mainType->isNullable(), $mainType->getClassName(), $collection, $collectionKeyTypes, $collectionKeyValues)];
         }
         if ($node instanceof ArrayShapeNode) {
             return [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true)];
diff --git a/src/Symfony/Component/Serializer/Tests/DeserializeNestedArrayOfObjectsTest.php b/src/Symfony/Component/Serializer/Tests/DeserializeNestedArrayOfObjectsTest.php
@@ -156,7 +156,7 @@ class ZooWithKeyTypes
     public $animalsString = [];
     /** @var array<int|string, Animal> */
     public $animalsUnion = [];
-    /** @var \stdClass<Animal> */
+    /** @var \Traversable<Animal> */
     public $animalsGenerics = [];
 }
 

Original file line number	Diff line number	Diff line change
`@@ -428,6 +428,11 @@ public function testUnknownPseudoType()`
`428`	`428`	`$this->assertEquals([new Type(Type::BUILTIN_TYPE_OBJECT, false, 'scalar')], $this->extractor->getTypes(PseudoTypeDummy::class, 'unknownPseudoType'));`
`429`	`429`	`}`
`430`	`430`
	`431`	`+ public function testGenericInterface()`
	`432`	`+ {`
	`433`	`+ $this->assertNull($this->extractor->getTypes(Dummy::class, 'genericInterface'));`
	`434`	`+ }`
	`435`	`+`
`431`	`436`	`protected static function isPhpDocumentorV5()`
`432`	`437`	`{`
`433`	`438`	`if (class_exists(InvalidTag::class)) {`
Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,11 @@ class Dummy extends ParentDummy`
`165`	`165`	`*/`
`166`	`166`	`public $parentAnnotation;`
`167`	`167`
	`168`	`+ /**`
	`169`	`+ * @var \BackedEnum<string>`
	`170`	`+ */`
	`171`	`+ public $genericInterface;`
	`172`	`+`
`168`	`173`	`public static function getStatic()`
`169`	`174`	`{`
`170`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,13 @@ private function extractTypes(TypeNode $node, NameScope $nameScope): array`
`121`	`121`	`return [$mainType];`
`122`	`122`	`}`
`123`	`123`
	`124`	`+ $collection = $mainType->isCollection() \|\| \in_array($mainType->getClassName(), [\Traversable::class, \Iterator::class, \IteratorAggregate::class, \ArrayAccess::class, \Generator::class], true);`
	`125`	`+`
	`126`	`+ // it's safer to fall back to other extractors if the generic type is too abstract`
	`127`	`+ if (!$collection && !class_exists($mainType->getClassName())) {`
	`128`	`+ return [];`
	`129`	`+ }`
	`130`	`+`
`124`	`131`	`$collectionKeyTypes = $mainType->getCollectionKeyTypes();`
`125`	`132`	`$collectionKeyValues = [];`
`126`	`133`	`if (1 === \count($node->genericTypes)) {`
`@@ -136,7 +143,7 @@ private function extractTypes(TypeNode $node, NameScope $nameScope): array`
`136`	`143`	`}`
`137`	`144`	`}`
`138`	`145`
`139`		`- return [new Type($mainType->getBuiltinType(), $mainType->isNullable(), $mainType->getClassName(), true, $collectionKeyTypes, $collectionKeyValues)];`
	`146`	`+ return [new Type($mainType->getBuiltinType(), $mainType->isNullable(), $mainType->getClassName(), $collection, $collectionKeyTypes, $collectionKeyValues)];`
`140`	`147`	`}`
`141`	`148`	`if ($node instanceof ArrayShapeNode) {`
`142`	`149`	`return [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true)];`
Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ class ZooWithKeyTypes`
`156`	`156`	`public $animalsString = [];`
`157`	`157`	`/** @var array<int\|string, Animal> */`
`158`	`158`	`public $animalsUnion = [];`
`159`		`- /** @var \stdClass<Animal> */`
	`159`	`+ /** @var \Traversable<Animal> */`
`160`	`160`	`public $animalsGenerics = [];`
`161`	`161`	`}`
`162`	`162`