feat(elasticsearch): use TypeInfo type

src/Elasticsearch/Filter/AbstractFilter.php

@@ -19,8 +19,14 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
-use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+use Symfony\Component\TypeInfo\Type;
+use Symfony\Component\TypeInfo\Type\CollectionType;
+use Symfony\Component\TypeInfo\Type\CompositeTypeInterface;
+use Symfony\Component\TypeInfo\Type\ObjectType;
+use Symfony\Component\TypeInfo\Type\WrappingTypeInterface;
 
 /**
  * Abstract class with helpers for easing the implementation of a filter.
@@ -31,7 +37,9 @@
  */
 abstract class AbstractFilter implements FilterInterface
 {
-    use FieldDatatypeTrait { getNestedFieldPath as protected; }
+    use FieldDatatypeTrait {
+        getNestedFieldPath as protected;
+    }
 
     public function __construct(protected PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, protected ?NameConverterInterface $nameConverter = null, protected ?array $properties = null)
     {
@@ -70,8 +78,108 @@
      *   - is the decomposed given property an association?
      *   - the resource class of the decomposed given property
      *   - the property name of the decomposed given property
+     *
+     * @return array{0: ?Type, 1: ?bool, 2: ?class-string, 3: ?string}
      */
     protected function getMetadata(string $resourceClass, string $property): array
+    {
+        if (!method_exists(PropertyInfoExtractor::class, 'getType')) {
+            return $this->getLegacyMetadata($resourceClass, $property);
+        }
+
+        $noop = [null, null, null, null];
+
+        if (!$this->hasProperty($resourceClass, $property)) {
+            return $noop;
+        }
+
+        $properties = explode('.', $property);
+        $totalProperties = \count($properties);
+        $currentResourceClass = $resourceClass;
+        $hasAssociation = false;
+        $currentProperty = null;
+        $type = null;
+
+        foreach ($properties as $index => $currentProperty) {
+            try {
+                $propertyMetadata = $this->propertyMetadataFactory->create($currentResourceClass, $currentProperty);
+            } catch (PropertyNotFoundException) {
+                return $noop;
+            }
+
+            // check each type before deciding if it's noop or not
+            // e.g: maybe the first type is noop, but the second is valid
+            $isNoop = false;
+
+            ++$index;
+
+            $type = $propertyMetadata->getNativeType();
+
+            if (null === $type) {
+                return $noop;
+            }
+
+            foreach ($type instanceof CompositeTypeInterface ? $type->getTypes() : [$type] as $t) {
+                $builtinType = $t;
+
+                while ($builtinType instanceof WrappingTypeInterface) {
+                    $builtinType = $builtinType->getWrappedType();
+                }
+
+                if (!$builtinType instanceof ObjectType && !$t instanceof CollectionType) {
+                    if ($totalProperties === $index) {
+                        break 2;
+                    }
+
+                    $isNoop = true;
+
+                    continue;
+                }
+
+                if ($t instanceof CollectionType) {
+                    $t = $t->getCollectionValueType();
+                    $builtinType = $t;
+
+                    while ($builtinType instanceof WrappingTypeInterface) {
+                        $builtinType = $builtinType->getWrappedType();
+                    }
+
+                    if (!$builtinType instanceof ObjectType) {
+                        if ($totalProperties === $index) {
+                            break 2;
+                        }
+
+                        $isNoop = true;
+
+                        continue;
+                    }
+                }
+
+                $className = $builtinType->getClassName();
+
+                if ($isResourceClass = $this->resourceClassResolver->isResourceClass($className)) {
+                    $currentResourceClass = $className;
+                } elseif ($totalProperties !== $index) {
+                    $isNoop = true;
+
+                    continue;
+                }
+
+                $hasAssociation = $totalProperties === $index && $isResourceClass;
+                $isNoop = false;
+
+                break;
+            }
+        }
+
+        if ($isNoop) {
+            return $noop;
+        }
+
+        return [$type, $hasAssociation, $currentResourceClass, $currentProperty];
+    }
+
+    protected function getLegacyMetadata(string $resourceClass, string $property): array
     {
         $noop = [null, null, null, null];
 
@@ -108,7 +216,7 @@
             foreach ($types as $type) {
                 $builtinType = $type->getBuiltinType();
 
-                if (Type::BUILTIN_TYPE_OBJECT !== $builtinType && Type::BUILTIN_TYPE_ARRAY !== $builtinType) {
+                if (LegacyType::BUILTIN_TYPE_OBJECT !== $builtinType && LegacyType::BUILTIN_TYPE_ARRAY !== $builtinType) {
                     if ($totalProperties === $index) {
                         break 2;
                     }
@@ -124,7 +232,7 @@
                     continue;
                 }
 
-                if (Type::BUILTIN_TYPE_ARRAY === $builtinType && Type::BUILTIN_TYPE_OBJECT !== $type->getBuiltinType()) {
+                if (LegacyType::BUILTIN_TYPE_ARRAY === $builtinType && LegacyType::BUILTIN_TYPE_OBJECT !== $type->getBuiltinType()) {
                     if ($totalProperties === $index) {
                         break 2;
                     }

src/Elasticsearch/Filter/AbstractSearchFilter.php

@@ -21,8 +21,11 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
-use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\PropertyInfo\Type as LegacyType;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+use Symfony\Component\TypeInfo\Type;
+use Symfony\Component\TypeInfo\Type\WrappingTypeInterface;
+use Symfony\Component\TypeInfo\TypeIdentifier;
 
 /**
  * Abstract class with helpers for easing the implementation of a search filter like a term filter or a match filter.
@@ -109,27 +112,40 @@
      */
     abstract protected function getQuery(string $property, array $values, ?string $nestedPath): array;
 
-    /**
-     * Converts the given {@see Type} in PHP type.
-     */
-    protected function getPhpType(Type $type): string
+    protected function getPhpType(LegacyType|Type $type): string
     {
-        switch ($builtinType = $type->getBuiltinType()) {
-            case Type::BUILTIN_TYPE_ARRAY:
-            case Type::BUILTIN_TYPE_INT:
-            case Type::BUILTIN_TYPE_FLOAT:
-            case Type::BUILTIN_TYPE_BOOL:
-            case Type::BUILTIN_TYPE_STRING:
-                return $builtinType;
-            case Type::BUILTIN_TYPE_OBJECT:
-                if (null !== ($className = $type->getClassName()) && is_a($className, \DateTimeInterface::class, true)) {
-                    return \DateTimeInterface::class;
-                }
+        if ($type instanceof LegacyType) {
+            switch ($builtinType = $type->getBuiltinType()) {
+                case LegacyType::BUILTIN_TYPE_ARRAY:
+                case LegacyType::BUILTIN_TYPE_INT:
+                case LegacyType::BUILTIN_TYPE_FLOAT:
+                case LegacyType::BUILTIN_TYPE_BOOL:
+                case LegacyType::BUILTIN_TYPE_STRING:
+                    return $builtinType;
+                case LegacyType::BUILTIN_TYPE_OBJECT:
+                    if (null !== ($className = $type->getClassName()) && is_a($className, \DateTimeInterface::class, true)) {
+                        return \DateTimeInterface::class;
+                    }
+
+                    // no break
+                default:
+                    return 'string';
+            }
+        }
+
+        if ($type->isIdentifiedBy(TypeIdentifier::ARRAY, TypeIdentifier::INT, TypeIdentifier::FLOAT, TypeIdentifier::BOOL, TypeIdentifier::STRING)) {
+            while ($type instanceof WrappingTypeInterface) {
+                $type = $type->getWrappedType();
+            }
+
+            return (string) $type;
+        }
 
-                // no break
-            default:
-                return 'string';
+        if ($type->isIdentifiedBy(\DateTimeInterface::class)) {
+            return \DateTimeInterface::class;
         }
+
+        return 'string';
     }
 
     /**
@@ -164,15 +180,26 @@
         return $iri;
     }
 
-    /**
-     * Are the given values valid according to the given {@see Type}?
-     */
-    protected function hasValidValues(array $values, Type $type): bool
+    protected function hasValidValues(array $values, LegacyType|Type $type): bool
     {
+        if ($type instanceof LegacyType) {
+            foreach ($values as $value) {
+                if (
+                    null !== $value
+                    && LegacyType::BUILTIN_TYPE_INT === $type->getBuiltinType()
+                    && false === filter_var($value, \FILTER_VALIDATE_INT)
+                ) {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+
         foreach ($values as $value) {
             if (
                 null !== $value
-                && Type::BUILTIN_TYPE_INT === $type->getBuiltinType()
+                && $type->isIdentifiedBy(TypeIdentifier::INT)
                 && false === filter_var($value, \FILTER_VALIDATE_INT)
             ) {
                 return false;

src/Elasticsearch/Tests/Extension/SortExtensionTest.php

@@ -22,8 +22,8 @@
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
-use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+use Symfony\Component\TypeInfo\Type;
 
 class SortExtensionTest extends TestCase
 {
@@ -55,10 +55,10 @@
 
     public function testApplyToCollectionWithNestedProperty(): void
     {
-        $fooType = new Type(Type::BUILTIN_TYPE_ARRAY, false, Foo::class, true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_OBJECT, false, Foo::class));
+        $fooType = Type::list(Type::object(Foo::class));
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'foo')->willReturn((new ApiProperty())->withBuiltinTypes([$fooType]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'foo')->willReturn((new ApiProperty())->withNativeType($fooType))->shouldBeCalled();
 
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(Foo::class)->willReturn(true)->shouldBeCalled();

src/Elasticsearch/Tests/Filter/MatchFilterTest.php

@@ -27,8 +27,8 @@
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
-use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+use Symfony\Component\TypeInfo\Type;
 
 class MatchFilterTest extends TestCase
 {
@@ -55,8 +55,8 @@
         $propertyNameCollectionFactoryProphecy->create(Foo::class)->willReturn(new PropertyNameCollection(['id', 'name', 'bar']))->shouldBeCalled();
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'id')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_INT)]))->shouldBeCalled();
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'name')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_STRING)]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'id')->willReturn((new ApiProperty())->withNativeType(Type::int()))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'name')->willReturn((new ApiProperty())->withNativeType(Type::string()))->shouldBeCalled();
 
         $foo = new Foo();
         $foo->setName('Xavier');
@@ -89,12 +89,12 @@
 
     public function testApplyWithNestedArrayProperty(): void
     {
-        $fooType = new Type(Type::BUILTIN_TYPE_ARRAY, false, Foo::class, true, new Type(Type::BUILTIN_TYPE_INT), new Type(Type::BUILTIN_TYPE_OBJECT, false, Foo::class));
-        $barType = new Type(Type::BUILTIN_TYPE_STRING);
+        $fooType = Type::list(Type::object(Foo::class));
+        $barType = Type::string();
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'foo')->willReturn((new ApiProperty())->withBuiltinTypes([$fooType]))->shouldBeCalled();
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'bar')->willReturn((new ApiProperty())->withBuiltinTypes([$barType]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'foo')->willReturn((new ApiProperty())->withNativeType($fooType))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'bar')->willReturn((new ApiProperty())->withNativeType($barType))->shouldBeCalled();
 
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(Foo::class)->willReturn(true)->shouldBeCalled();
@@ -121,12 +121,12 @@
 
     public function testApplyWithNestedObjectProperty(): void
     {
-        $fooType = new Type(Type::BUILTIN_TYPE_OBJECT, false, Foo::class);
-        $barType = new Type(Type::BUILTIN_TYPE_STRING);
+        $fooType = Type::object(Foo::class);
+        $barType = Type::string();
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'foo')->willReturn((new ApiProperty())->withBuiltinTypes([$fooType]))->shouldBeCalled();
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'bar')->willReturn((new ApiProperty())->withBuiltinTypes([$barType]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'foo')->willReturn((new ApiProperty())->withNativeType($fooType))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'bar')->willReturn((new ApiProperty())->withNativeType($barType))->shouldBeCalled();
 
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(Foo::class)->willReturn(true)->shouldBeCalled();
@@ -156,7 +156,7 @@
         $propertyNameCollectionFactoryProphecy->create(Foo::class)->willReturn(new PropertyNameCollection(['id', 'bar']))->shouldBeCalled();
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'id')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_INT)]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'id')->willReturn((new ApiProperty())->withNativeType(Type::int()))->shouldBeCalled();
         $propertyMetadataFactoryProphecy->create(Foo::class, 'bar')->willReturn(new ApiProperty())->shouldBeCalled();
 
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
@@ -183,11 +183,11 @@
         $propertyNameCollectionFactoryProphecy->create(Foo::class)->willReturn(new PropertyNameCollection(['id', 'name', 'bar', 'date', 'weird']))->shouldBeCalled();
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'id')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_INT)]))->shouldBeCalled();
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'name')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_STRING)]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'id')->willReturn((new ApiProperty())->withNativeType(Type::int()))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'name')->willReturn((new ApiProperty())->withNativeType(Type::string()))->shouldBeCalled();
         $propertyMetadataFactoryProphecy->create(Foo::class, 'bar')->willReturn(new ApiProperty())->shouldBeCalled();
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'date')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_OBJECT, false, \DateTimeImmutable::class)]))->shouldBeCalled();
-        $propertyMetadataFactoryProphecy->create(Foo::class, 'weird')->willReturn((new ApiProperty())->withBuiltinTypes([new Type(Type::BUILTIN_TYPE_RESOURCE)]))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'date')->willReturn((new ApiProperty())->withNativeType(Type::object(\DateTimeImmutable::class)))->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Foo::class, 'weird')->willReturn((new ApiProperty())->withNativeType(Type::resource()))->shouldBeCalled();
 
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(\DateTimeImmutable::class)->willReturn(false)->shouldBeCalled();