GraphQl: Normalize id based on the origin resource

api-platform · Mar 15, 2019 · 3ae9ef3 · 3ae9ef3
1 parent e1d667f
commit 3ae9ef3
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 14 deletions.
diff --git a/features/main/input_output.feature b/features/main/input_output.feature
@@ -244,7 +244,7 @@ Feature: DTO input and output
     """
     {
       dummyDtoInputOutput(id: "/dummy_dto_input_outputs/1") {
-        baz
+        id, baz
       }
     }
     """
@@ -254,6 +254,7 @@ Feature: DTO input and output
     {
       "data": {
         "dummyDtoInputOutput": {
+          "id": "/dummy_dto_input_outputs/1",
           "baz": 1
         }
       }

diff --git a/src/Bridge/Symfony/Bundle/Resources/config/graphql.xml b/src/Bridge/Symfony/Bundle/Resources/config/graphql.xml
@@ -38,6 +38,7 @@
 
         <service id="api_platform.graphql.resolver.resource_field" class="ApiPlatform\Core\GraphQl\Resolver\ResourceFieldResolver" public="false">
             <argument type="service" id="api_platform.iri_converter" />
+            <argument type="service" id="api_platform.resource_class_resolver" />
         </service>
 
         <service id="api_platform.graphql.schema_builder" class="ApiPlatform\Core\GraphQl\Type\SchemaBuilder" public="false">

diff --git a/src/GraphQl/Resolver/ResourceFieldResolver.php b/src/GraphQl/Resolver/ResourceFieldResolver.php
@@ -14,7 +14,9 @@
 namespace ApiPlatform\Core\GraphQl\Resolver;
 
 use ApiPlatform\Core\Api\IriConverterInterface;
+use ApiPlatform\Core\Api\ResourceClassResolverInterface;
 use ApiPlatform\Core\GraphQl\Serializer\ItemNormalizer;
+use ApiPlatform\Core\Util\ClassInfoTrait;
 use GraphQL\Type\Definition\ResolveInfo;
 
 /**
@@ -26,18 +28,25 @@
  */
 final class ResourceFieldResolver
 {
+    use ClassInfoTrait;
+
     private $iriConverter;
+    private $resourceClassResolver;
 
-    public function __construct(IriConverterInterface $iriConverter)
+    public function __construct(IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver)
     {
         $this->iriConverter = $iriConverter;
+        $this->resourceClassResolver = $resourceClassResolver;
     }
 
     public function __invoke($source, $args, $context, ResolveInfo $info)
     {
         $property = null;
         if ('id' === $info->fieldName && isset($source[ItemNormalizer::ITEM_KEY])) {
-            return $this->iriConverter->getIriFromItem(unserialize($source[ItemNormalizer::ITEM_KEY]));
+            $object = unserialize($source[ItemNormalizer::ITEM_KEY]);
+            if ($this->resourceClassResolver->isResourceClass($this->getObjectClass($object))) {
+                return $this->iriConverter->getIriFromItem($object);
+            }
         }
 
         if ('_id' === $info->fieldName && isset($source['id'])) {

diff --git a/src/GraphQl/Serializer/ItemNormalizer.php b/src/GraphQl/Serializer/ItemNormalizer.php
@@ -54,6 +54,7 @@ public function normalize($object, $format = null, array $context = [])
 
             $context['api_normalize'] = true;
             $context['resource_class'] = $this->getObjectClass($transformed);
+            $context['origin_resource'] = $object;
 
             return $this->serializer->normalize($transformed, $format, $context);
         }
@@ -63,6 +64,11 @@ public function normalize($object, $format = null, array $context = [])
             throw new UnexpectedValueException('Expected data to be an array');
         }
 
+        if (($context['origin_resource'] ?? false) && isset($data['id'])) {
+            $data['id'] = $this->iriConverter->getIriFromItem($context['origin_resource']);
+            unset($context['origin_resource']);
+        }
+
         $data[self::ITEM_KEY] = serialize($object); // calling serialize prevent weird normalization process done by Webonyx's GraphQL PHP
 
         return $data;

diff --git a/src/GraphQl/Type/SchemaBuilder.php b/src/GraphQl/Type/SchemaBuilder.php
@@ -388,7 +388,7 @@ private function convertType(Type $type, bool $input = false, string $mutationNa
         }
 
         if ($this->isCollection($type)) {
-            return $this->paginationEnabled && !$input ? $this->getResourcePaginatedCollectionType($resourceClass, $graphqlType) : GraphQLType::listOf($graphqlType);
+            return $this->paginationEnabled && !$input && null !== $resourceClass ? $this->getResourcePaginatedCollectionType($resourceClass, $graphqlType) : GraphQLType::listOf($graphqlType);
         }
 
         return $type->isNullable() || (null !== $mutationName && 'update' === $mutationName) ? $graphqlType : GraphQLType::nonNull($graphqlType);
@@ -401,7 +401,15 @@ private function convertType(Type $type, bool $input = false, string $mutationNa
      */
     private function getResourceObjectType(?string $resourceClass, ResourceMetadata $resourceMetadata, bool $input = false, string $mutationName = null, int $depth = 0): GraphQLType
     {
-        $shortName = $resourceMetadata->getShortName();
+        $ioMetadata = $resourceMetadata->getAttribute($input ? 'input' : 'output');
+
+        if (null !== $ioMetadata && \array_key_exists('class', $ioMetadata) && null !== $ioMetadata['class']) {
+            $resourceClass = $ioMetadata['class'];
+            $shortName = $ioMetadata['name'];
+        } else {
+            $shortName = $resourceMetadata->getShortName();
+        }
+
         if (null !== $mutationName) {
             $shortName = $mutationName.ucfirst($shortName);
         }
@@ -415,12 +423,6 @@ private function getResourceObjectType(?string $resourceClass, ResourceMetadata
             return $this->graphqlTypes[$shortName];
         }
 
-        $ioMetadata = $resourceMetadata->getAttribute($input ? 'input' : 'output');
-
-        if (null !== $ioMetadata && \array_key_exists('class', $ioMetadata) && null !== $ioMetadata['class']) {
-            $resourceClass = $ioMetadata['class'];
-        }
-
         $configuration = [
             'name' => $shortName,
             'description' => $resourceMetadata->getDescription(),

diff --git a/tests/GraphQl/Resolver/ResourceFieldResolverTest.php b/tests/GraphQl/Resolver/ResourceFieldResolverTest.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\Tests\GraphQl\Resolver;
 
 use ApiPlatform\Core\Api\IriConverterInterface;
+use ApiPlatform\Core\Api\ResourceClassResolverInterface;
 use ApiPlatform\Core\GraphQl\Resolver\ResourceFieldResolver;
 use ApiPlatform\Core\GraphQl\Serializer\ItemNormalizer;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
@@ -28,33 +29,54 @@ public function testId()
     {
         $dummy = new Dummy();
 
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
+        $resourceClassResolverProphecy->isResourceClass(Dummy::class)->shouldBeCalled()->willReturn(true);
+
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
         $iriConverterProphecy->getIriFromItem($dummy)->willReturn('/dummies/1')->shouldBeCalled();
 
         $resolveInfo = new ResolveInfo('id', [], new ObjectType(['name' => '']), new ObjectType(['name' => '']), [], new Schema([]), [], null, null, []);
 
-        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal());
+        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal(), $resourceClassResolverProphecy->reveal());
         $this->assertEquals('/dummies/1', $resolver([ItemNormalizer::ITEM_KEY => serialize($dummy)], [], [], $resolveInfo));
     }
 
     public function testOriginalId()
     {
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
 
         $resolveInfo = new ResolveInfo('_id', [], new ObjectType(['name' => '']), new ObjectType(['name' => '']), [], new Schema([]), [], null, null, []);
 
-        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal());
+        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal(), $resourceClassResolverProphecy->reveal());
         $this->assertEquals(1, $resolver(['id' => 1], [], [], $resolveInfo));
     }
 
     public function testDirectAccess()
     {
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
 
         $resolveInfo = new ResolveInfo('foo', [], new ObjectType(['name' => '']), new ObjectType(['name' => '']), [], new Schema([]), [], null, null, []);
 
-        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal());
+        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal(), $resourceClassResolverProphecy->reveal());
         $this->assertEquals('bar', $resolver(['foo' => 'bar'], [], [], $resolveInfo));
         $this->assertEquals('bar', $resolver((object) ['foo' => 'bar'], [], [], $resolveInfo));
     }
+
+    public function testNonResource()
+    {
+        $dummy = new Dummy();
+
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
+        $resourceClassResolverProphecy->isResourceClass(Dummy::class)->shouldBeCalled()->willReturn(false);
+
+        $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
+        $iriConverterProphecy->getIriFromItem($dummy)->willReturn('/dummies/1')->shouldNotBeCalled();
+
+        $resolveInfo = new ResolveInfo('id', [], new ObjectType(['name' => '']), new ObjectType(['name' => '']), [], new Schema([]), [], null, null, []);
+
+        $resolver = new ResourceFieldResolver($iriConverterProphecy->reveal(), $resourceClassResolverProphecy->reveal());
+        $this->assertNull($resolver([ItemNormalizer::ITEM_KEY => serialize($dummy)], [], [], $resolveInfo));
+    }
 }