fix(#2502): replace property-info type with type-info

composer.json

@@ -80,6 +80,7 @@
         "symfony/security-csrf": "For using csrf protection tokens in forms.",
         "symfony/serializer": "For describing your models.",
         "symfony/twig-bundle": "For using the Swagger UI.",
+        "symfony/type-info": "For extracting type information from PHP elements like properties, arguments and return types.",
         "symfony/validator": "For describing the validation constraints in your models.",
         "willdurand/hateoas-bundle": "For extracting HATEOAS metadata."
     },

phpstan-baseline.neon

@@ -29,3 +29,8 @@ parameters:
 			message: "#^Call to function is_callable\\(\\) with array\\{string, mixed\\} will always evaluate to false\\.$#"
 			count: 1
 			path: src/RouteDescriber/FosRestDescriber.php
+
+		-
+			message: "#^Unable to resolve the template type T in call to method static method Symfony\\\\Component\\\\TypeInfo\\\\Type\\:\\:collection\\(\\)$#"
+			count: 1
+			path: src/Util/LegacyTypeConverter.php

phpunit-ignore.txt

@@ -0,0 +1,2 @@
+# Ignoring deprecations from Nelmio\ApiDocBundle 5.6.0, Deprecation of Symfony PropertyInfo\Type
+/^Since nelmio\/api-doc-bundle 5\.X\: Using Symfony\\Component\\PropertyInfo\\Type as type in Nelmio\\ApiDocBundle\\Model\\Model\:\:\_\_construct is deprecated, use Symfony\\Component\\TypeInfo\\Type instead\./

src/Model/Model.php

@@ -11,7 +11,9 @@
 
 namespace Nelmio\ApiDocBundle\Model;
 
-use Symfony\Component\PropertyInfo\Type;
+use Nelmio\ApiDocBundle\Util\LegacyTypeConverter;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
+use Symfony\Component\TypeInfo\Type;
 
 final class Model
 {
@@ -22,22 +24,53 @@ final class Model
      * @param non-empty-string|null $name                 An optional custom name for the generated schema
      */
     public function __construct(
-        private Type $type,
+        private LegacyType|Type $type,
         ?array $groups = null,
         private array $options = [],
         private array $serializationContext = [],
         public readonly ?string $name = null,
     ) {
+        if ($type instanceof LegacyType) {
+            trigger_deprecation(
+                'nelmio/api-doc-bundle',
+                '5.X', // TODO
+                'Using Symfony\Component\PropertyInfo\Type as type in %s is deprecated, use Symfony\Component\TypeInfo\Type instead.',
+                __METHOD__
+            );
+        }
+
         if (null !== $groups) {
             $this->serializationContext['groups'] = $groups;
         }
     }
 
-    public function getType(): Type
+    /**
+     * @deprecated use {@see getTypeInfo()} instead
+     */
+    public function getType(): LegacyType
     {
+        if ($this->type instanceof Type) {
+            return LegacyTypeConverter::toLegacyType($this->type);
+        }
+
         return $this->type;
     }
 
+    public function getTypeInfo(): Type
+    {
+        if ($this->type instanceof Type) {
+            return $this->type;
+        }
+
+        $converted = LegacyTypeConverter::toTypeInfoType([$this->type]);
+
+        if (null === $converted) {
+            throw new \LogicException('Could not convert legacy type to TypeInfo type.');
+        }
+
+        return $converted;
+    }
+
     /**
      * @return string[]|null
      */
@@ -56,7 +89,11 @@ public function getSerializationContext(): array
 
     public function getHash(): string
     {
-        return md5(serialize([$this->type, $this->getSerializationContext(), $this->name]));
+        $type = class_exists(Type::class)
+            ? $this->getTypeInfo()->__toString()
+            : $this->getType();
+
+        return md5(serialize([$type, $this->getSerializationContext(), $this->name]));
     }
 
     /**

src/Model/ModelRegistry.php

@@ -14,10 +14,12 @@
 use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
 use Nelmio\ApiDocBundle\ModelDescriber\ModelDescriberInterface;
 use Nelmio\ApiDocBundle\OpenApiPhp\Util;
+use Nelmio\ApiDocBundle\Util\LegacyTypeConverter;
 use OpenApi\Annotations as OA;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;
-use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
+use Symfony\Component\TypeInfo\Type;
 
 final class ModelRegistry
 {
@@ -74,7 +76,7 @@ public function __construct($modelDescribers, OA\OpenApi $api, array $alternativ
 
         foreach ($alternativeNames as $alternativeName => $criteria) {
             $model = new Model(
-                new Type('object', false, $criteria['type']),
+                LegacyTypeConverter::createType($criteria['type']),
                 $criteria['groups'],
                 $criteria['options'] ?? [],
                 $criteria['serializationContext'] ?? [],
@@ -170,9 +172,13 @@ public function registerSchemas(): void
                 $schema = $this->describeSchema($model, $name);
 
                 if (null === $schema) {
-                    $errorMessage = \sprintf('Schema of type "%s" can\'t be generated, no describer supports it.', $this->typeToString($model->getType()));
-                    if (Type::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType() && !class_exists($className = $model->getType()->getClassName())) {
-                        $errorMessage .= \sprintf(' Class "\\%s" does not exist, did you forget a use statement, or typed it wrong?', $className);
+                    $type = class_exists(Type::class)
+                        ? $model->getTypeInfo()
+                        : $model->getType();
+
+                    $errorMessage = \sprintf('Schema of type "%s" can\'t be generated, no describer supports it.', $this->typeToString($type));
+                    if (method_exists($type, 'getClassName') && null !== $type->getClassName() && !class_exists($className = $type->getClassName())) {
+                        $errorMessage .= \sprintf(' Class "%s" does not exist, did you forget a use statement, or typed it wrong?', $className);
                     }
                     throw new \LogicException($errorMessage);
                 }
@@ -194,8 +200,12 @@ private function determineModelName(Model $model): string
             return $model->name;
         }
 
+        $type = class_exists(Type::class)
+            ? $model->getTypeInfo()
+            : $model->getType();
+
         // 3. Generate from the type
-        return $this->getTypeShortName($model->getType());
+        return $this->getTypeShortName($type);
     }
 
     private function generateUniqueModelName(Model $model): string
@@ -225,32 +235,49 @@ private function generateUniqueModelName(Model $model): string
      */
     private function modelToArray(Model $model): array
     {
-        $getType = function (Type $type) use (&$getType): array {
-            return [
-                'class' => $type->getClassName(),
-                'built_in_type' => $type->getBuiltinType(),
-                'nullable' => $type->isNullable(),
-                'collection' => $type->isCollection(),
-                'collection_key_types' => $type->isCollection() ? array_map($getType, $type->getCollectionKeyTypes()) : null,
-                'collection_value_types' => $type->isCollection() ? array_map($getType, $type->getCollectionValueTypes()) : null,
-            ];
-        };
+        $type = class_exists(Type::class)
+            ? $model->getTypeInfo()
+            : $model->getType();
+
+        $dataType = $this->typeToString($type);
 
         return [
-            'type' => $getType($model->getType()),
+            'type' => $dataType,
             'options' => $model->getOptions(),
             'groups' => $model->getGroups(),
             'serialization_context' => $model->getSerializationContext(),
         ];
     }
 
-    private function getTypeShortName(Type $type): string
+    private function getTypeShortName(LegacyType|Type $type): string
     {
-        if (null !== $collectionType = $this->getCollectionValueType($type)) {
+        if ($type instanceof Type) {
+            if ($type instanceof Type\CollectionType) {
+                return $this->getTypeShortName($type->getCollectionValueType()).'[]';
+            }
+
+            if ($type instanceof Type\ObjectType) {
+                $parts = explode('\\', $type->getClassName());
+
+                return end($parts);
+            }
+
+            if ($type instanceof Type\NullableType) {
+                return $this->getTypeShortName($type->getWrappedType());
+            }
+
+            if ($type instanceof Type\UnionType && method_exists($type, 'asNonNullable')) {
+                return $this->getTypeShortName($type->asNonNullable());
+            }
+
+            return $type->__toString();
+        }
+
+        if (null !== $collectionType = ($type->getCollectionValueTypes()[0] ?? null)) {
             return $this->getTypeShortName($collectionType).'[]';
         }
 
-        if (Type::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()) {
+        if (LegacyType::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()) {
             $parts = explode('\\', $type->getClassName());
 
             return end($parts);
@@ -259,23 +286,22 @@ private function getTypeShortName(Type $type): string
         return $type->getBuiltinType();
     }
 
-    private function typeToString(Type $type): string
+    private function typeToString(LegacyType|Type $type): string
     {
-        if (Type::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()) {
-            return '\\'.$type->getClassName();
+        if ($type instanceof Type) {
+            return $type->__toString();
+        }
+
+        if (LegacyType::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()) {
+            return $type->getClassName();
         } elseif ($type->isCollection()) {
-            if (null !== $collectionType = $this->getCollectionValueType($type)) {
+            if (null !== $collectionType = ($type->getCollectionValueTypes()[0] ?? null)) {
                 return $this->typeToString($collectionType).'[]';
             } else {
                 return 'mixed[]';
             }
-        } else {
-            return $type->getBuiltinType();
         }
-    }
 
-    private function getCollectionValueType(Type $type): ?Type
-    {
-        return $type->getCollectionValueTypes()[0] ?? null;
+        return $type->getBuiltinType();
     }
 }

src/ModelDescriber/ApplyOpenApiDiscriminatorTrait.php

@@ -14,8 +14,8 @@
 use Nelmio\ApiDocBundle\Model\Model;
 use Nelmio\ApiDocBundle\Model\ModelRegistry;
 use Nelmio\ApiDocBundle\OpenApiPhp\Util;
+use Nelmio\ApiDocBundle\Util\LegacyTypeConverter;
 use OpenApi\Annotations as OA;
-use Symfony\Component\PropertyInfo\Type;
 
 /**
  * Contains helper methods that add `discriminator` and `oneOf` values to
@@ -52,7 +52,7 @@ protected function applyOpenApiDiscriminator(
         foreach ($typeMap as $propertyValue => $className) {
             $oneOfSchema = new OA\Schema(['_context' => $weakContext]);
             $oneOfSchema->ref = $modelRegistry->register(new Model(
-                new Type(Type::BUILTIN_TYPE_OBJECT, false, $className),
+                LegacyTypeConverter::createType($className),
                 $model->getGroups(),
                 $model->getOptions(),
                 $model->getSerializationContext()

src/ModelDescriber/BazingaHateoasModelDescriber.php

@@ -21,6 +21,8 @@
 use Nelmio\ApiDocBundle\Model\ModelRegistry;
 use Nelmio\ApiDocBundle\OpenApiPhp\Util;
 use OpenApi\Annotations as OA;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
+use Symfony\Component\TypeInfo\Type\ObjectType;
 
 class BazingaHateoasModelDescriber implements ModelDescriberInterface, ModelRegistryAwareInterface
 {
@@ -87,8 +89,13 @@ public function describe(Model $model, OA\Schema $schema): void
 
     private function getHateoasMetadata(Model $model): ?object
     {
+        /** @var ObjectType|LegacyType $type */
+        $type = class_exists(\Symfony\Component\TypeInfo\Type::class)
+            ? $model->getTypeInfo()
+            : $model->getType();
+
         try {
-            return $this->factory->getMetadataForClass($model->getType()->getClassName());
+            return $this->factory->getMetadataForClass($type->getClassName());
         } catch (\ReflectionException $e) {
         }
 

src/ModelDescriber/EnumModelDescriber.php

@@ -13,15 +13,20 @@
 
 use Nelmio\ApiDocBundle\Model\Model;
 use OpenApi\Annotations\Schema;
-use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
+use Symfony\Component\TypeInfo\Type\ObjectType;
 
 class EnumModelDescriber implements ModelDescriberInterface
 {
     public const FORCE_NAMES = '_nelmio_enum_force_names';
 
     public function describe(Model $model, Schema $schema): void
     {
-        $enumClass = $model->getType()->getClassName();
+        /** @var ObjectType|LegacyType $type */
+        $type = class_exists(\Symfony\Component\TypeInfo\Type::class)
+            ? $model->getTypeInfo()
+            : $model->getType();
+        $enumClass = $type->getClassName();
         $forceName = isset($model->getSerializationContext()[self::FORCE_NAMES]) && true === $model->getSerializationContext()[self::FORCE_NAMES];
 
         $enums = [];
@@ -40,7 +45,13 @@ public function describe(Model $model, Schema $schema): void
 
     public function supports(Model $model): bool
     {
-        return Type::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType()
+        if (class_exists(\Symfony\Component\TypeInfo\Type::class)) {
+            return $model->getTypeInfo() instanceof ObjectType
+                && enum_exists($model->getTypeInfo()->getClassName())
+                && is_subclass_of($model->getTypeInfo()->getClassName(), \BackedEnum::class);
+        }
+
+        return LegacyType::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType()
             && enum_exists($model->getType()->getClassName())
             && is_subclass_of($model->getType()->getClassName(), \BackedEnum::class);
     }

src/ModelDescriber/FallbackObjectModelDescriber.php

@@ -13,7 +13,8 @@
 
 use Nelmio\ApiDocBundle\Model\Model;
 use OpenApi\Annotations as OA;
-use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
+use Symfony\Component\TypeInfo\Type\ObjectType;
 
 class FallbackObjectModelDescriber implements ModelDescriberInterface
 {
@@ -23,6 +24,10 @@ public function describe(Model $model, OA\Schema $schema): void
 
     public function supports(Model $model): bool
     {
-        return Type::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType();
+        if (class_exists(\Symfony\Component\TypeInfo\Type::class)) {
+            return $model->getTypeInfo() instanceof ObjectType;
+        }
+
+        return LegacyType::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType();
     }
 }