GraphQl: parse input&messenger metadata

Author: soyuka

features/main/input_output.feature

@@ -287,3 +287,29 @@ Feature: DTO input and output
       "data": 123
     }
     """
+
+  @!mongodb
+  Scenario: Use messenger with graphql and an input where the handler gives a synchronous result
+    When I send the following GraphQL request:
+    """
+    mutation {
+      createMessengerWithInput(input: {var: "test"}) {
+        messengerWithInput { id, name }
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the JSON should be equal to:
+    """
+    {
+      "data": {
+        "createMessengerWithInput": {
+          "messengerWithInput": {
+              "id": "/messenger_with_inputs/1",
+              "name": "test"
+          }
+        }
+      }
+    }
+    """

src/Bridge/Symfony/Messenger/DataPersister.php

@@ -63,6 +63,10 @@ public function supports($data, array $context = []): bool
             );
         }
 
+        if (isset($context['graphql_operation_name'])) {
+            return false !== $resourceMetadata->getGraphqlAttribute($context['graphql_operation_name'], 'messenger', false, true);
+        }
+
         return false !== $resourceMetadata->getAttribute('messenger', false);
     }
 

src/Bridge/Symfony/Messenger/DataTransformer.php

@@ -55,6 +55,10 @@ public function supportsTransformation($data, string $to, array $context = []):
 
         $metadata = $this->resourceMetadataFactory->create($context['resource_class'] ?? $to);
 
+        if (isset($context['graphql_operation_name'])) {
+            return 'input' === $metadata->getGraphqlAttribute($context['graphql_operation_name'], 'messenger', null, true);
+        }
+
         if (!isset($context['operation_type'])) {
             return 'input' === $metadata->getAttribute('messenger');
         }

src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php

@@ -94,19 +94,27 @@ public function __invoke(string $resourceClass = null, string $rootClass = null,
 
             $this->canAccess($this->resourceAccessChecker, $resourceMetadata, $resourceClass, $info, $item, $operationName);
 
-            $inputMetadata = $resourceMetadata->getAttribute('input', ['class' => $resourceClass]);
-            if (null === $resourceClass = $inputMetadata['class'] ?? null) {
-                return $data;
+            $inputMetadata = $resourceMetadata->getGraphqlAttribute($operationName, 'input', null, true);
+            $inputClass = null;
+            if (\is_array($inputMetadata) && \array_key_exists('class', $inputMetadata)) {
+                if (null === $inputMetadata['class']) {
+                    return $data;
+                }
+
+                $inputClass = $inputMetadata['class'];
             }
 
             switch ($operationName) {
                 case 'create':
                 case 'update':
-                    $context = null === $item ? ['resource_class' => $resourceClass] : ['resource_class' => $resourceClass, 'object_to_populate' => $item];
+                    $context = ['resource_class' => $resourceClass, 'graphql_operation_name' => $operationName];
+                    if (null !== $item) {
+                        $context['object_to_populate'] = $item;
+                    }
                     $context += $resourceMetadata->getGraphqlAttribute($operationName, 'denormalization_context', [], true);
-                    $item = $this->normalizer->denormalize($args['input'], $resourceClass, ItemNormalizer::FORMAT, $context);
+                    $item = $this->normalizer->denormalize($args['input'], $inputClass ?: $resourceClass, ItemNormalizer::FORMAT, $context);
                     $this->validate($item, $info, $resourceMetadata, $operationName);
-                    $persistResult = $this->dataPersister->persist($item);
+                    $persistResult = $this->dataPersister->persist($item, $context);
 
                     if (null === $persistResult) {
                         @trigger_error(sprintf('Returning void from %s::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3, an object should always be returned.', DataPersisterInterface::class), E_USER_DEPRECATED);

src/GraphQl/Type/SchemaBuilder.php

@@ -419,8 +419,7 @@ private function getResourceObjectType(?string $resourceClass, ResourceMetadata
             return $this->graphqlTypes[$shortName];
         }
 
-        $ioMetadata = $resourceMetadata->getAttribute($input ? 'input' : 'output');
-
+        $ioMetadata = $resourceMetadata->getGraphqlAttribute(null === $mutationName ? 'query' : $mutationName, $input ? 'input' : 'output', null, true);
         if (null !== $ioMetadata && \array_key_exists('class', $ioMetadata) && null !== $ioMetadata['class']) {
             $resourceClass = $ioMetadata['class'];
         }

src/Metadata/Resource/Factory/InputOutputResourceMetadataFactory.php

@@ -48,6 +48,10 @@ public function create(string $resourceClass): ResourceMetadata
             $resourceMetadata = $resourceMetadata->withItemOperations($this->getTransformedOperations($itemOperations, $attributes));
         }
 
+        if (null !== $graphQlAttributes = $resourceMetadata->getGraphql()) {
+            $resourceMetadata = $resourceMetadata->withGraphql($this->getTransformedOperations($graphQlAttributes, $attributes));
+        }
+
         return $resourceMetadata->withAttributes($attributes);
     }
 

tests/Bridge/Symfony/Messenger/DataPersisterTest.php

@@ -85,4 +85,13 @@ public function testHandle()
         $dataPersister = new DataPersister($this->prophesize(ResourceMetadataFactoryInterface::class)->reveal(), $messageBus->reveal());
         $this->assertSame($dummy, $dataPersister->persist($dummy));
     }
+
+    public function testSupportWithGraphqlContext()
+    {
+        $metadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $metadataFactoryProphecy->create(Dummy::class)->willReturn((new ResourceMetadata(null, null, null, null, null, []))->withGraphQl(['create' => ['messenger' => 'input']]));
+
+        $dataPersister = new DataPersister($metadataFactoryProphecy->reveal(), $this->prophesize(MessageBusInterface::class)->reveal());
+        $this->assertTrue($dataPersister->supports(new DummyCar(), ['resource_class' => Dummy::class, 'graphql_operation_name' => 'create']));
+    }
 }

tests/Bridge/Symfony/Messenger/DataTransformerTest.php

@@ -86,4 +86,12 @@ public function testTransform()
         $dataTransformer = new DataTransformer($metadataFactoryProphecy->reveal());
         $this->assertSame($dummy, $dataTransformer->transform($dummy, Dummy::class));
     }
+
+    public function testSupportWithGraphqlContext()
+    {
+        $metadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $metadataFactoryProphecy->create(Dummy::class)->willReturn((new ResourceMetadata(null, null, null, null, null, []))->withGraphQl(['create' => ['messenger' => 'input']]));
+        $dataTransformer = new DataTransformer($metadataFactoryProphecy->reveal());
+        $this->assertTrue($dataTransformer->supportsTransformation([], Dummy::class, ['input' => ['class' => 'smth'], 'graphql_operation_name' => 'create']));
+    }
 }

tests/Fixtures/TestBundle/Entity/MessengerWithInput.php

@@ -18,7 +18,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Dto\MessengerInput;
 
 /**
- * @ApiResource(messenger="input", input=MessengerInput::class)
+ * @ApiResource(messenger="input", input=MessengerInput::class, graphql={"create"={"input"=MessengerInput::class, "messenger"="input"}})
  */
 class MessengerWithInput
 {

tests/Metadata/Resource/Factory/InputOutputResourceMetadataFactoryTest.php

@@ -24,9 +24,9 @@ class InputOutputResourceMetadataFactoryTest extends TestCase
     /**
      * @dataProvider getAttributes
      */
-    public function testExistingDescription($attributes, $expected)
+    public function testInputOutputMetadata($attributes, $expected)
     {
-        $resourceMetadata = (new ResourceMetadata(null, 'My desc'))->withAttributes($attributes);
+        $resourceMetadata = (new ResourceMetadata(null))->withAttributes($attributes);
         $decoratedProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $decoratedProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
         $decorated = $decoratedProphecy->reveal();
@@ -35,6 +35,20 @@ public function testExistingDescription($attributes, $expected)
         $this->assertSame($expected, $factory->create('Foo')->getAttributes()['input']);
     }
 
+    /**
+     * @dataProvider getAttributes
+     */
+    public function testInputOutputViaGraphQlMetadata($attributes, $expected)
+    {
+        $resourceMetadata = (new ResourceMetadata(null))->withGraphQl(['create' => $attributes]);
+        $decoratedProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $decoratedProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
+        $decorated = $decoratedProphecy->reveal();
+
+        $factory = new InputOutputResourceMetadataFactory($decorated);
+        $this->assertSame($expected, $factory->create('Foo')->getGraphqlAttribute('create', 'input'));
+    }
+
     public function getAttributes(): array
     {
         return [