fix(EntityLoad): Return NULL on NULL entity IDs when composing entity…

… load (drupal-graphql#1174)
klausi · Sep 21, 2023 · 65f997c · 65f997c
1 parent beef2fe
commit 65f997c
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 3 deletions.
diff --git a/src/Plugin/GraphQL/DataProducer/Entity/EntityLoad.php b/src/Plugin/GraphQL/DataProducer/Entity/EntityLoad.php
@@ -133,17 +133,23 @@ public function __construct(
    * Resolver.
    *
    * @param string $type
-   * @param string $id
+   * @param string|int|null $id
    * @param string|null $language
    * @param array|null $bundles
    * @param bool|null $access
    * @param \Drupal\Core\Session\AccountInterface|null $accessUser
    * @param string|null $accessOperation
    * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
    *
-   * @return \GraphQL\Deferred
+   * @return \GraphQL\Deferred|null
    */
-  public function resolve($type, $id, ?string $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
+  public function resolve($type, $id, ?string $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context): ?Deferred {
+    // If this data producer was composed to a field (entity reference) and
+    // there is no ID then we can return immediately.
+    if ($id === NULL) {
+      return NULL;
+    }
+
     $resolver = $this->entityBuffer->add($type, $id);
 
     return new Deferred(function () use ($type, $language, $bundles, $resolver, $context, $access, $accessUser, $accessOperation) {

diff --git a/src/Plugin/GraphQL/DataProducer/Entity/EntityLoadMultiple.php b/src/Plugin/GraphQL/DataProducer/Entity/EntityLoadMultiple.php
@@ -144,6 +144,9 @@ public function __construct(
    * @return \GraphQL\Deferred
    */
   public function resolve($type, array $ids, ?string $language, ?array $bundles, bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
+    // Remove any NULL IDs.
+    $ids = array_filter($ids);
+
     $resolver = $this->entityBuffer->add($type, $ids);
 
     return new Deferred(function () use ($type, $language, $bundles, $resolver, $context, $access, $accessUser, $accessOperation) {

diff --git a/tests/src/Kernel/DataProducer/EntityMultipleTest.php b/tests/src/Kernel/DataProducer/EntityMultipleTest.php
@@ -111,4 +111,18 @@ public function testResolveEntityLoadMultiple(): void {
     ], $nids);
   }
 
+  /**
+   * Make sure that passing a NULL id does not produce any warnings.
+   */
+  public function testResolveEntityLoadWithNullId(): void {
+    $result = $this->executeDataProducer('entity_load_multiple', [
+      'type' => $this->node1->getEntityTypeId(),
+      'ids' => [NULL],
+      'access' => TRUE,
+      'access_operation' => 'view',
+    ]);
+
+    $this->assertSame([], $result);
+  }
+
 }
diff --git a/tests/src/Kernel/DataProducer/EntityTest.php b/tests/src/Kernel/DataProducer/EntityTest.php
@@ -366,6 +366,18 @@ public function testResolveTranslatedEntityLoad(): void {
     $this->assertEquals('sit amet fr', $result->getTitle());
   }
 
+  /**
+   * Make sure that passing a NULL id does not produce any warnings.
+   */
+  public function testResolveEntityLoadWithNullId(): void {
+    $result = $this->executeDataProducer('entity_load', [
+      'type' => $this->node->getEntityTypeId(),
+      'id' => NULL,
+    ]);
+
+    $this->assertNull($result);
+  }
+
   /**
    * @covers \Drupal\graphql\Plugin\GraphQL\DataProducer\Entity\EntityLoad::resolve
    */