[GraphQL] Resource with no operation should be available through relations (#3532)

Author: alanpoulain

features/bootstrap/DoctrineContext.php

@@ -71,7 +71,6 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\CompositeLabel;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\CompositePrimitiveItem;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\CompositeRelation;
-use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Container;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\ConvertedBoolean;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\ConvertedDate;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\ConvertedInteger;
@@ -107,7 +106,6 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Greeting;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\InternalUser;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\MaxDepthDummy;
-use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Node;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Order;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Person;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\PersonToPet;
@@ -1051,25 +1049,6 @@ public function thereIsAnAnswerToTheQuestion(string $a, string $q)
         $this->manager->clear();
     }
 
-    /**
-     * @Given there are :nb nodes in a container :uuid
-     */
-    public function thereAreNodesInAContainer(int $nb, string $uuid)
-    {
-        $container = new Container();
-        $container->setId($uuid);
-        $this->manager->persist($container);
-
-        for ($i = 0; $i < $nb; ++$i) {
-            $node = new Node();
-            $node->setContainer($container);
-            $node->setSerial($i);
-            $this->manager->persist($node);
-        }
-
-        $this->manager->flush();
-    }
-
     /**
      * @Then the password :password for user :user should be hashed
      */

features/graphql/introspection.feature

@@ -426,7 +426,7 @@ Feature: GraphQL introspection support
     And the JSON node "data.typeCreatePayloadData.fields[3].type.name" should be equal to "createDummyGroupNestedPayload"
     And the JSON node "data.typeCreateNestedPayload.fields[0].name" should be equal to "id"
 
-  Scenario: Retrieve an item through a GraphQL query
+  Scenario: Retrieve a type name through a GraphQL query
     Given there are 4 dummy objects with relatedDummy
     When I send the following GraphQL request:
     """
@@ -447,3 +447,28 @@ Feature: GraphQL introspection support
     And the JSON node "data.dummy.name" should be equal to "Dummy #3"
     And the JSON node "data.dummy.relatedDummy.name" should be equal to "RelatedDummy #3"
     And the JSON node "data.dummy.relatedDummy.__typename" should be equal to "RelatedDummy"
+
+  Scenario: Introspect a type available only through relations
+    When I send the following GraphQL request:
+    """
+    {
+      typeNotAvailable: __type(name: "VoDummyInspectionConnection") {
+        description
+      }
+      typeOwner: __type(name: "VoDummyCar") {
+        description,
+        fields {
+          name
+          type {
+            name
+          }
+        }
+      }
+    }
+    """
+    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 node "errors[0].debugMessage" should be equal to 'Type with id "VoDummyInspectionConnection" is not present in the types container'
+    And the JSON node "data.typeNotAvailable" should be null
+    And the JSON node "data.typeOwner.fields[3].type.name" should be equal to "VoDummyInspectionConnection"

src/GraphQl/Type/TypeConverter.php

@@ -105,9 +105,12 @@ private function getResourceType(Type $type, bool $input, ?string $queryName, ?s
 
         try {
             $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
-            if ([] === ($resourceMetadata->getGraphql() ?? [])) {
+            if (null === $resourceMetadata->getGraphql()) {
                 return null;
             }
+            if ('Node' === $resourceMetadata->getShortName()) {
+                throw new \UnexpectedValueException('A "Node" resource cannot be used with GraphQL because the type is already used by the Relay specification.');
+            }
         } catch (ResourceClassNotFoundException $e) {
             // Skip objects that are not resources for now
             return null;

tests/Fixtures/TestBundle/Document/VoDummyInspection.php

@@ -19,10 +19,13 @@
 use Symfony\Component\Serializer\Annotation\Groups;
 
 /**
- * @ApiResource(attributes={
- *     "normalization_context"={"groups"={"inspection_read"}},
- *     "denormalization_context"={"groups"={"inspection_write"}}
- * })
+ * @ApiResource(
+ *     attributes={
+ *         "normalization_context"={"groups"={"inspection_read"}},
+ *         "denormalization_context"={"groups"={"inspection_write"}}
+ *     },
+ *     graphql={}
+ * )
  * @ODM\Document
  */
 class VoDummyInspection

tests/Fixtures/TestBundle/Entity/Container.php

@@ -19,10 +19,13 @@
 use Symfony\Component\Serializer\Annotation\Groups;
 
 /**
- * @ApiResource(attributes={
- *     "normalization_context"={"groups"={"inspection_read"}},
- *     "denormalization_context"={"groups"={"inspection_write"}}
- * })
+ * @ApiResource(
+ *     attributes={
+ *         "normalization_context"={"groups"={"inspection_read"}},
+ *         "denormalization_context"={"groups"={"inspection_write"}}
+ *     },
+ *     graphql={}
+ * )
  * @ORM\Entity
  */
 class VoDummyInspection

tests/Fixtures/TestBundle/Entity/Node.php

@@ -96,6 +96,19 @@ public function testConvertTypeNoGraphQlResourceMetadata(): void
         $this->assertNull($graphqlType);
     }
 
+    public function testConvertTypeNodeResource(): void
+    {
+        $type = new Type(Type::BUILTIN_TYPE_OBJECT, false, 'node');
+
+        $this->typeBuilderProphecy->isCollection($type)->shouldBeCalled()->willReturn(false);
+        $this->resourceMetadataFactoryProphecy->create('node')->shouldBeCalled()->willReturn((new ResourceMetadata('Node'))->withGraphql(['test']));
+
+        $this->expectException(\UnexpectedValueException::class);
+        $this->expectExceptionMessage('A "Node" resource cannot be used with GraphQL because the type is already used by the Relay specification.');
+
+        $this->typeConverter->convertType($type, false, null, null, 'resourceClass', 'rootClass', null, 0);
+    }
+
     public function testConvertTypeResourceClassNotFound(): void
     {
         $type = new Type(Type::BUILTIN_TYPE_OBJECT, false, 'dummy');