feat: union/intersect types (#5470)

* fix(metadata): handle union/intersect types * review * try to move SchemaFactory onto SchemaPropertyMetadataFactory * complete property schema on SchemaFactory * Apply suggestions from code review Co-authored-by: Antoine Bluchet <soyuka@users.noreply.github.com> * fix: review * fix: cs * fix: phpunit * fix: cs * fix: tests about maker * fix: JsonSchema::SchemaFactory * fix: behat tests * fix deprec * tests --------- Co-authored-by: Antoine Bluchet <soyuka@users.noreply.github.com>
api-platform · Jul 6, 2023 · d793ffb · d793ffb
1 parent 6babb3d
commit d793ffb
Show file tree

Hide file tree

Showing 52 changed files with 1,548 additions and 484 deletions.
diff --git a/features/main/union_intersect_types.feature b/features/main/union_intersect_types.feature
@@ -0,0 +1,121 @@
+Feature: Union/Intersect types
+
+  Scenario Outline: Create a resource with union type
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I add "Accept" header equal to "application/ld+json"
+    And I send a "POST" request to "/issue-5452/books" with body:
+    """
+    {
+      "number": <number>,
+      "isbn": "978-3-16-148410-0"
+    }
+    """
+    Then the response status code should be 201
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be valid according to this schema:
+    """
+    {
+      "type": "object",
+      "properties": {
+        "@type": {
+          "type": "string",
+          "pattern": "^Book$"
+        },
+        "@context": {
+          "type": "string",
+          "pattern": "^/contexts/Book$"
+        },
+        "@id": {
+          "type": "string",
+          "pattern": "^/.well-known/genid/.+$"
+        },
+        "number": {
+          "type": "<type>"
+        },
+        "isbn": {
+          "type": "string",
+          "pattern": "^978-3-16-148410-0$"
+        }
+      },
+      "required": [
+        "@type",
+        "@context",
+        "@id",
+        "number",
+        "isbn"
+      ]
+    }
+    """
+    Examples:
+    | number | type    |
+    | "1"    | string  |
+    | 1      | integer |
+
+  Scenario: Create a resource with valid intersect type
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "POST" request to "/issue-5452/books" with body:
+    """
+    {
+      "number": 1,
+      "isbn": "978-3-16-148410-0",
+      "author": "/issue-5452/authors/1"
+    }
+    """
+    Then the response status code should be 201
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be valid according to this schema:
+    """
+    {
+      "type": "object",
+      "properties": {
+        "@type": {
+          "type": "string",
+          "pattern": "^Book$"
+        },
+        "@context": {
+          "type": "string",
+          "pattern": "^/contexts/Book$"
+        },
+        "@id": {
+          "type": "string",
+          "pattern": "^/.well-known/genid/.+$"
+        },
+        "number": {
+          "type": "integer"
+        },
+        "isbn": {
+          "type": "string",
+          "pattern": "^978-3-16-148410-0$"
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^/issue-5452/authors/1$"
+        }
+      },
+      "required": [
+        "@type",
+        "@context",
+        "@id",
+        "number",
+        "isbn",
+        "author"
+      ]
+    }
+    """
+
+  Scenario: Create a resource with invalid intersect type
+    When I add "Content-Type" header equal to "application/ld+json"
+    And I send a "POST" request to "/issue-5452/books" with body:
+    """
+    {
+      "number": 1,
+      "isbn": "978-3-16-148410-0",
+      "library": "/issue-5452/libraries/1"
+    }
+    """
+    Then the response status code should be 400
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON node "hydra:description" should be equal to 'Could not denormalize object of type "ApiPlatform\Tests\Fixtures\TestBundle\ApiResource\Issue5452\ActivableInterface", no supporting normalizer found.'
diff --git a/features/openapi/docs.feature b/features/openapi/docs.feature
@@ -86,19 +86,19 @@ Feature: Documentation support
     {
       "default": "male",
       "example": "male",
-      "type": "string",
+      "type": ["string", "null"],
       "enum": [
           "male",
           "female",
           null
-      ],
-      "nullable": true
+      ]
     }
     """
     And the "playMode" property exists for the OpenAPI class "VideoGame"
     And the "playMode" property for the OpenAPI class "VideoGame" should be equal to:
     """
     {
+      "owl:maxCardinality": 1,
       "type": "string",
       "format": "iri-reference"
     }
@@ -238,8 +238,7 @@ Feature: Documentation support
                                         "type": "string"
                                     },
                                     "property": {
-                                        "type": "string",
-                                        "nullable": true
+                                        "type": ["string", "null"]
                                     },
                                     "required": {
                                         "type": "boolean"
@@ -310,12 +309,15 @@ Feature: Documentation support
     And the "resourceRelated" property for the OpenAPI class "Resource" should be equal to:
     """
     {
-      "readOnly":true,
-      "anyOf":[
+      "owl:maxCardinality": 1,
+      "readOnly": true,
+      "anyOf": [
+        {
+          "$ref": "#/components/schemas/ResourceRelated"
+        },
         {
-          "$ref":"#/components/schemas/ResourceRelated"
+          "type": "null"
         }
-      ],
-      "nullable":true
+      ]
     }
     """
diff --git a/src/Elasticsearch/Filter/AbstractFilter.php b/src/Elasticsearch/Filter/AbstractFilter.php
@@ -93,46 +93,70 @@ protected function getMetadata(string $resourceClass, string $property): array
                 return $noop;
             }
 
-            $type = $propertyMetadata->getBuiltinTypes()[0] ?? null;
+            $types = $propertyMetadata->getBuiltinTypes();
 
-            if (null === $type) {
+            if (null === $types) {
                 return $noop;
             }
 
             ++$index;
-            $builtinType = $type->getBuiltinType();
 
-            if (Type::BUILTIN_TYPE_OBJECT !== $builtinType && Type::BUILTIN_TYPE_ARRAY !== $builtinType) {
-                if ($totalProperties === $index) {
-                    break;
+            // 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;
+
+            foreach ($types as $type) {
+                $builtinType = $type->getBuiltinType();
+
+                if (Type::BUILTIN_TYPE_OBJECT !== $builtinType && Type::BUILTIN_TYPE_ARRAY !== $builtinType) {
+                    if ($totalProperties === $index) {
+                        break 2;
+                    }
+
+                    $isNoop = true;
+
+                    continue;
                 }
 
-                return $noop;
-            }
+                if ($type->isCollection() && null === $type = $type->getCollectionValueTypes()[0] ?? null) {
+                    $isNoop = true;
 
-            if ($type->isCollection() && null === $type = $type->getCollectionValueTypes()[0] ?? null) {
-                return $noop;
-            }
+                    continue;
+                }
+
+                if (Type::BUILTIN_TYPE_ARRAY === $builtinType && Type::BUILTIN_TYPE_OBJECT !== $type->getBuiltinType()) {
+                    if ($totalProperties === $index) {
+                        break 2;
+                    }
+
+                    $isNoop = true;
 
-            if (Type::BUILTIN_TYPE_ARRAY === $builtinType && Type::BUILTIN_TYPE_OBJECT !== $type->getBuiltinType()) {
-                if ($totalProperties === $index) {
-                    break;
+                    continue;
                 }
 
-                return $noop;
-            }
+                if (null === $className = $type->getClassName()) {
+                    $isNoop = true;
 
-            if (null === $className = $type->getClassName()) {
-                return $noop;
+                    continue;
+                }
+
+                if ($isResourceClass = $this->resourceClassResolver->isResourceClass($className)) {
+                    $currentResourceClass = $className;
+                } elseif ($totalProperties !== $index) {
+                    $isNoop = true;
+
+                    continue;
+                }
+
+                $hasAssociation = $totalProperties === $index && $isResourceClass;
+                $isNoop = false;
+
+                break;
             }
 
-            if ($isResourceClass = $this->resourceClassResolver->isResourceClass($className)) {
-                $currentResourceClass = $className;
-            } elseif ($totalProperties !== $index) {
+            if ($isNoop) {
                 return $noop;
             }
-
-            $hasAssociation = $totalProperties === $index && $isResourceClass;
         }
 
         return [$type, $hasAssociation, $currentResourceClass, $currentProperty];

diff --git a/src/Elasticsearch/Util/FieldDatatypeTrait.php b/src/Elasticsearch/Util/FieldDatatypeTrait.php
@@ -59,30 +59,27 @@ private function getNestedFieldPath(string $resourceClass, string $property): ?s
             return null;
         }
 
-        // TODO: 3.0 allow multiple types
-        $type = $propertyMetadata->getBuiltinTypes()[0] ?? null;
-
-        if (null === $type) {
-            return null;
-        }
-
-        if (
-            Type::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()
-            && null !== ($nextResourceClass = $type->getClassName())
-            && $this->resourceClassResolver->isResourceClass($nextResourceClass)
-        ) {
-            $nestedPath = $this->getNestedFieldPath($nextResourceClass, implode('.', $properties));
-
-            return null === $nestedPath ? $nestedPath : "$currentProperty.$nestedPath";
-        }
-
-        if (
-            null !== ($type = $type->getCollectionValueTypes()[0] ?? null)
-            && Type::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()
-            && null !== ($className = $type->getClassName())
-            && $this->resourceClassResolver->isResourceClass($className)
-        ) {
-            return $currentProperty;
+        $types = $propertyMetadata->getBuiltinTypes() ?? [];
+
+        foreach ($types as $type) {
+            if (
+                Type::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()
+                && null !== ($nextResourceClass = $type->getClassName())
+                && $this->resourceClassResolver->isResourceClass($nextResourceClass)
+            ) {
+                $nestedPath = $this->getNestedFieldPath($nextResourceClass, implode('.', $properties));
+
+                return null === $nestedPath ? $nestedPath : "$currentProperty.$nestedPath";
+            }
+
+            if (
+                null !== ($type = $type->getCollectionValueTypes()[0] ?? null)
+                && Type::BUILTIN_TYPE_OBJECT === $type->getBuiltinType()
+                && null !== ($className = $type->getClassName())
+                && $this->resourceClassResolver->isResourceClass($className)
+            ) {
+                return $currentProperty;
+            }
         }
 
         return null;

diff --git a/src/GraphQl/Type/FieldsBuilder.php b/src/GraphQl/Type/FieldsBuilder.php
@@ -213,17 +213,23 @@ public function getResourceObjectTypeFields(?string $resourceClass, Operation $o
                     'denormalization_groups' => $operation->getDenormalizationContext()['groups'] ?? null,
                 ];
                 $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property, $context);
+                $propertyTypes = $propertyMetadata->getBuiltinTypes();
 
                 if (
-                    null === ($propertyType = $propertyMetadata->getBuiltinTypes()[0] ?? null)
+                    !$propertyTypes
                     || (!$input && false === $propertyMetadata->isReadable())
                     || ($input && $operation instanceof Mutation && false === $propertyMetadata->isWritable())
                 ) {
                     continue;
                 }
 
-                if ($fieldConfiguration = $this->getResourceFieldConfiguration($property, $propertyMetadata->getDescription(), $propertyMetadata->getDeprecationReason(), $propertyType, $resourceClass, $input, $operation, $depth, null !== $propertyMetadata->getSecurity())) {
-                    $fields['id' === $property ? '_id' : $this->normalizePropertyName($property, $resourceClass)] = $fieldConfiguration;
+                // guess union/intersect types: check each type until finding a valid one
+                foreach ($propertyTypes as $propertyType) {
+                    if ($fieldConfiguration = $this->getResourceFieldConfiguration($property, $propertyMetadata->getDescription(), $propertyMetadata->getDeprecationReason(), $propertyType, $resourceClass, $input, $operation, $depth, null !== $propertyMetadata->getSecurity())) {
+                        $fields['id' === $property ? '_id' : $this->normalizePropertyName($property, $resourceClass)] = $fieldConfiguration;
+                        // stop at the first valid type
+                        break;
+                    }
                 }
             }
         }