Support DTO class on GraphQL (#2427)

* Support DTO class on GraphQL * Fix review * Add Behat tests * Fix CS * Fix left over * Handle false value as input_class/output_class * Fix review * Optimize imports * Revert optimize imports * Fix review
api-platform · Jan 7, 2019 · c3e631e · c3e631e
1 parent 009e86a
commit c3e631e
Show file tree

Hide file tree

Showing 10 changed files with 460 additions and 20 deletions.
diff --git a/features/bootstrap/FeatureContext.php b/features/bootstrap/FeatureContext.php
@@ -22,6 +22,8 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCarColor;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDate;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoNoInput;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoNoOutput;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyFriend;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyGroup;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyImmutableDate;
@@ -346,6 +348,38 @@ public function thereAreDummyObjectsWithRelatedDummy(int $nb)
         $this->manager->flush();
     }
 
+    /**
+     * @Given there are :nb dummyDtoNoInput objects
+     */
+    public function thereAreDummyDtoNoInputObjects(int $nb)
+    {
+        for ($i = 1; $i <= $nb; ++$i) {
+            $dummyDto = new DummyDtoNoInput();
+            $dummyDto->lorem = 'DummyDtoNoInput foo #'.$i;
+            $dummyDto->ipsum = round($i / 3, 2);
+
+            $this->manager->persist($dummyDto);
+        }
+
+        $this->manager->flush();
+    }
+
+    /**
+     * @Given there are :nb dummyDtoNoOutput objects
+     */
+    public function thereAreDummyDtoNoOutputObjects(int $nb)
+    {
+        for ($i = 1; $i <= $nb; ++$i) {
+            $dummyDto = new DummyDtoNoOutput();
+            $dummyDto->lorem = 'DummyDtoNoOutput foo #'.$i;
+            $dummyDto->ipsum = $i / 3;
+
+            $this->manager->persist($dummyDto);
+        }
+
+        $this->manager->flush();
+    }
+
     /**
      * @Given there are :nb dummy objects with JSON and array data
      */

diff --git a/features/graphql/mutation.feature b/features/graphql/mutation.feature
@@ -262,3 +262,72 @@ Feature: GraphQL mutation support
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json"
     And the JSON node "errors[0].message" should be equal to "name: This value should not be blank."
+
+  Scenario: Create an item using custom inputClass & disabled outputClass
+    Given there are 2 dummyDtoNoOutput objects
+    When I send the following GraphQL request:
+    """
+    mutation {
+      createDummyDtoNoOutput(input: {foo: "A new one", bar: 3, clientMutationId: "myId"}) {
+        clientMutationId
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON should be equal to:
+    """
+    {
+      "data": {
+        "createDummyDtoNoOutput": {
+          "clientMutationId": "myId"
+        }
+      }
+    }
+    """
+
+  Scenario: Cannot create an item using disabled inputClass
+    Given there are 2 dummyDtoNoInput objects
+    When I send the following GraphQL request:
+    """
+    mutation {
+      createDummyDtoNoInput(input: {foo: "A new one", bar: 3, clientMutationId: "myId"}) {
+        clientMutationId
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON should be equal to:
+    """
+    {
+      "errors": [
+        {
+          "message": "Field \"foo\" is not defined by type createDummyDtoNoInputInput.",
+          "extensions": {
+            "category": "graphql"
+          },
+          "locations": [
+            {
+              "line": 2,
+              "column": 33
+            }
+          ]
+        },
+        {
+          "message": "Field \"bar\" is not defined by type createDummyDtoNoInputInput.",
+          "extensions": {
+            "category": "graphql"
+          },
+          "locations": [
+            {
+              "line": 2,
+              "column": 51
+            }
+          ]
+        }
+      ]
+    }
+    """
diff --git a/features/graphql/query.feature b/features/graphql/query.feature
@@ -211,3 +211,75 @@ Feature: GraphQL query support
       }
     }
     """
+
+  Scenario: Use outputClass instead of resource class through a GraphQL query
+    Given there are 2 dummyDtoNoInput objects
+    When I send the following GraphQL request:
+    """
+    {
+      dummyDtoNoInputs {
+        edges {
+          node {
+            baz
+            bat
+          }
+        }
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON should be equal to:
+    """
+    {
+      "data": {
+        "dummyDtoNoInputs": {
+          "edges": [
+            {
+              "node": {
+                "baz": 0.33,
+                "bat": "DummyDtoNoInput foo #1"
+              }
+            },
+            {
+              "node": {
+                "baz": 0.67,
+                "bat": "DummyDtoNoInput foo #2"
+              }
+            }
+          ]
+        }
+      }
+    }
+    """
+
+  @createSchema
+  Scenario: Disable outputClass leads to an empty response through a GraphQL query
+    Given there are 2 dummyDtoNoOutput objects
+    When I send the following GraphQL request:
+    """
+    {
+      dummyDtoNoInputs {
+        edges {
+          node {
+            baz
+            bat
+          }
+        }
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/json"
+    And the JSON should be equal to:
+    """
+    {
+      "data": {
+        "dummyDtoNoInputs": {
+          "edges": []
+        }
+      }
+    }
+    """
diff --git a/src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php b/src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php
@@ -87,6 +87,9 @@ public function __invoke(string $resourceClass = null, string $rootClass = null,
 
             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
             $this->canAccess($this->resourceAccessChecker, $resourceMetadata, $resourceClass, $info, $item, $operationName);
+            if (false === $resourceClass = $resourceMetadata->getAttribute('input_class', $resourceClass)) {
+                return null;
+            }
 
             switch ($operationName) {
                 case 'create':

diff --git a/src/GraphQl/Type/SchemaBuilder.php b/src/GraphQl/Type/SchemaBuilder.php
@@ -381,7 +381,10 @@ private function convertType(Type $type, bool $input = false, string $mutationNa
                     return null;
                 }
 
-                $graphqlType = $this->getResourceObjectType($resourceClass, $resourceMetadata, $input, $mutationName, $depth);
+                if (false !== $dtoClass = $resourceMetadata->getAttribute($input ? 'input_class' : 'output_class', $resourceClass)) {
+                    $resourceClass = $dtoClass;
+                }
+                $graphqlType = $this->getResourceObjectType(false === $dtoClass ? null : $resourceClass, $resourceMetadata, $input, $mutationName, $depth);
                 break;
             default:
                 throw new InvalidTypeException(sprintf('The type "%s" is not supported.', $builtinType));
@@ -399,7 +402,7 @@ private function convertType(Type $type, bool $input = false, string $mutationNa
      *
      * @return ObjectType|InputObjectType
      */
-    private function getResourceObjectType(string $resourceClass, ResourceMetadata $resourceMetadata, bool $input = false, string $mutationName = null, int $depth = 0): GraphQLType
+    private function getResourceObjectType(?string $resourceClass, ResourceMetadata $resourceMetadata, bool $input = false, string $mutationName = null, int $depth = 0): GraphQLType
     {
         $shortName = $resourceMetadata->getShortName();
         if (null !== $mutationName) {
@@ -431,7 +434,7 @@ private function getResourceObjectType(string $resourceClass, ResourceMetadata $
     /**
      * Gets the fields of the type of the given resource.
      */
-    private function getResourceObjectTypeFields(string $resourceClass, ResourceMetadata $resourceMetadata, bool $input = false, string $mutationName = null, int $depth = 0): array
+    private function getResourceObjectTypeFields(?string $resourceClass, ResourceMetadata $resourceMetadata, bool $input = false, string $mutationName = null, int $depth = 0): array
     {
         $fields = [];
         $idField = ['type' => GraphQLType::nonNull(GraphQLType::id())];
@@ -448,25 +451,27 @@ private function getResourceObjectTypeFields(string $resourceClass, ResourceMeta
             $fields['id'] = $idField;
         }
 
-        foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
-            $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property, ['graphql_operation_name' => $mutationName ?? 'query']);
-            if (
-                null === ($propertyType = $propertyMetadata->getType())
-                || (!$input && null === $mutationName && false === $propertyMetadata->isReadable())
-                || (null !== $mutationName && false === $propertyMetadata->isWritable())
-            ) {
-                continue;
-            }
+        if (null !== $resourceClass) {
+            foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
+                $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property, ['graphql_operation_name' => $mutationName ?? 'query']);
+                if (
+                    null === ($propertyType = $propertyMetadata->getType())
+                    || (!$input && null === $mutationName && false === $propertyMetadata->isReadable())
+                    || (null !== $mutationName && false === $propertyMetadata->isWritable())
+                ) {
+                    continue;
+                }
 
-            $rootResource = $resourceClass;
-            if (null !== $propertyMetadata->getSubresource()) {
-                $resourceClass = $propertyMetadata->getSubresource()->getResourceClass();
-                $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
-            }
-            if ($fieldConfiguration = $this->getResourceFieldConfiguration($resourceClass, $resourceMetadata, $propertyMetadata->getDescription(), $propertyMetadata->getAttribute('deprecation_reason', ''), $propertyType, $rootResource, $input, $mutationName, ++$depth)) {
-                $fields['id' === $property ? '_id' : $property] = $fieldConfiguration;
+                $rootResource = $resourceClass;
+                if (null !== $propertyMetadata->getSubresource()) {
+                    $resourceClass = $propertyMetadata->getSubresource()->getResourceClass();
+                    $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
+                }
+                if ($fieldConfiguration = $this->getResourceFieldConfiguration($resourceClass, $resourceMetadata, $propertyMetadata->getDescription(), $propertyMetadata->getAttribute('deprecation_reason', ''), $propertyType, $rootResource, $input, $mutationName, ++$depth)) {
+                    $fields['id' === $property ? '_id' : $property] = $fieldConfiguration;
+                }
+                $resourceClass = $rootResource;
             }
-            $resourceClass = $rootResource;
         }
 
         if (null !== $mutationName) {

diff --git a/tests/Fixtures/TestBundle/DataPersister/DummyDtoNoOutputDataPersister.php b/tests/Fixtures/TestBundle/DataPersister/DummyDtoNoOutputDataPersister.php
@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\DataPersister;
+
+use ApiPlatform\Core\DataPersister\DataPersisterInterface;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDtoNoOutput;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\InputDto;
+use Doctrine\Common\Persistence\ManagerRegistry;
+
+class DummyDtoNoOutputDataPersister implements DataPersisterInterface
+{
+    private $registry;
+
+    public function __construct(ManagerRegistry $registry)
+    {
+        $this->registry = $registry;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($data): bool
+    {
+        return $data instanceof InputDto;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function persist($data)
+    {
+        $output = new DummyDtoNoOutput();
+        $output->lorem = $data->foo;
+        $output->ipsum = (string) $data->bar;
+
+        $em = $this->registry->getManagerForClass(DummyDtoNoOutput::class);
+        $em->persist($output);
+        $em->flush();
+
+        return $output;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function remove($data)
+    {
+        return null;
+    }
+}