IBX-8417: Added the ability to enable pagination for ezobjectrelationlist field

Author: Mateusz Dębiński

src/bundle/Resources/config/default_settings.yaml

@@ -1,5 +1,6 @@
 parameters:
   ibexa.graphql.schema.should.extend.ezurl: false
+  ibexa.graphql.schema.ezobjectrelationlist.enable_pagination: false
   ibexa.graphql.schema.content.field_name.override:
     id: id_
   ibexa.graphql.schema.content.mapping.field_definition_type:

src/bundle/Resources/config/graphql/Field.types.yaml

@@ -279,3 +279,13 @@ UrlFieldValue:
                 type: String
                 description: "The link's name or description"
                 resolve: "@=value.text"
+
+RelationsConnection:
+    type: relay-connection
+    config:
+        nodeType: Item
+        connectionFields:
+            sliceSize:
+                type: Int!
+            orderBy:
+                type: String

src/bundle/Resources/config/services/resolvers.yaml

@@ -49,6 +49,8 @@ services:
             - { name: overblog_graphql.resolver, alias: "ItemsOfTypeAsConnection", method: "resolveItemsOfTypeAsConnection" }
 
     Ibexa\GraphQL\Resolver\RelationFieldResolver:
+        arguments:
+            $enablePagination: '%ibexa.graphql.schema.ezobjectrelationlist.enable_pagination%'
         tags:
             - { name: overblog_graphql.resolver, alias: "RelationFieldValue", method: "resolveRelationFieldValue" }
 

src/bundle/Resources/config/services/schema.yaml

@@ -43,6 +43,7 @@ services:
         arguments:
             $contentTypeService: '@ibexa.siteaccessaware.service.content_type'
             $innerMapper: '@Ibexa\GraphQL\Schema\Domain\Content\Mapper\FieldDefinition\RelationFieldDefinitionMapper.inner'
+            $enablePagination: '%ibexa.graphql.schema.ezobjectrelationlist.enable_pagination%'
 
     Ibexa\GraphQL\Schema\Domain\Content\Mapper\FieldDefinition\SelectionFieldDefinitionMapper:
         decorates: Ibexa\Contracts\GraphQL\Schema\Domain\Content\Mapper\FieldDefinition\FieldDefinitionMapper

src/lib/Resolver/RelationFieldResolver.php

@@ -11,45 +11,86 @@
 use Ibexa\Core\FieldType;
 use Ibexa\GraphQL\DataLoader\ContentLoader;
 use Ibexa\GraphQL\ItemFactory;
+use Ibexa\GraphQL\Relay\PageAwareConnection;
 use Ibexa\GraphQL\Value\Field;
+use Overblog\GraphQLBundle\Definition\Argument;
+use Overblog\GraphQLBundle\Relay\Connection\Paginator;
 
 final class RelationFieldResolver
 {
-    /** @var \Ibexa\GraphQL\DataLoader\ContentLoader */
-    private $contentLoader;
+    public const DEFAULT_LIMIT = 25;
 
-    /** @var \Ibexa\GraphQL\ItemFactory */
-    private $itemFactory;
+    private ContentLoader $contentLoader;
 
-    public function __construct(ContentLoader $contentLoader, ItemFactory $relatedContentItemFactory)
-    {
+    private ItemFactory $itemFactory;
+
+    private bool $enablePagination;
+
+    public function __construct(
+        ContentLoader $contentLoader,
+        ItemFactory $relatedContentItemFactory,
+        bool $enablePagination
+    ) {
         $this->contentLoader = $contentLoader;
         $this->itemFactory = $relatedContentItemFactory;
+        $this->enablePagination = $enablePagination;
     }
 
-    public function resolveRelationFieldValue(Field $field, $multiple = false)
+    public function resolveRelationFieldValue(Field $field, $multiple = false, Argument $args)
     {
         $destinationContentIds = $this->getContentIds($field);
 
         if (empty($destinationContentIds) || array_key_exists(0, $destinationContentIds) && null === $destinationContentIds[0]) {
             return $multiple ? [] : null;
         }
 
-        $contentItems = $this->contentLoader->find(new Query(
+        $query = new Query(
             ['filter' => new Query\Criterion\ContentId($destinationContentIds)]
-        ));
+        );
 
         if ($multiple) {
-            return array_map(
-                function ($contentId) use ($contentItems) {
-                    return $this->itemFactory->fromContent(
-                        $contentItems[array_search($contentId, array_column($contentItems, 'id'))]
-                    );
-                },
-                $destinationContentIds
+            if (!$this->enablePagination) {
+                $contentItems = $this->contentLoader->find($query);
+
+                return array_map(
+                    function ($contentId) use ($contentItems) {
+                        return $this->itemFactory->fromContent(
+                            $contentItems[array_search($contentId, array_column($contentItems, 'id'))]
+                        );
+                    },
+                    $destinationContentIds
+                );
+            }
+
+            $paginator = new Paginator(function ($offset, $limit) use ($query) {
+                $query->offset = $offset;
+                $query->limit = $limit ?? self::DEFAULT_LIMIT;
+                $contentItems = $this->contentLoader->find($query);
+
+                return array_map(
+                    function ($content) {
+                        return $this->itemFactory->fromContent(
+                            $content
+                        );
+                    },
+                    $contentItems
+                );
+            });
+
+            return PageAwareConnection::fromConnection(
+                $paginator->auto(
+                    $args,
+                    function () use ($query) {
+                        return $this->contentLoader->count($query);
+                    }
+                ),
+                $args
             );
         }
 
+        $query->limit = 1;
+        $contentItems = $this->contentLoader->find($query);
+
         return $contentItems[0] ? $this->itemFactory->fromContent($contentItems[0]) : null;
     }
 

src/lib/Schema/Domain/Content/Mapper/FieldDefinition/RelationFieldDefinitionMapper.php

@@ -14,24 +14,22 @@
 
 class RelationFieldDefinitionMapper extends DecoratingFieldDefinitionMapper implements FieldDefinitionMapper
 {
-    /**
-     * @var \Ibexa\GraphQL\Schema\Domain\Content\NameHelper
-     */
-    private $nameHelper;
+    private NameHelper $nameHelper;
 
-    /**
-     * @var \Ibexa\Contracts\Core\Repository\ContentTypeService
-     */
-    private $contentTypeService;
+    private ContentTypeService $contentTypeService;
+
+    private bool $enablePagination;
 
     public function __construct(
         FieldDefinitionMapper $innerMapper,
         NameHelper $nameHelper,
-        ContentTypeService $contentTypeService
+        ContentTypeService $contentTypeService,
+        bool $enablePagination
     ) {
         parent::__construct($innerMapper);
         $this->nameHelper = $nameHelper;
         $this->contentTypeService = $contentTypeService;
+        $this->enablePagination = $enablePagination;
     }
 
     public function mapToFieldValueType(FieldDefinition $fieldDefinition): ?string
@@ -54,7 +52,18 @@ public function mapToFieldValueType(FieldDefinition $fieldDefinition): ?string
         }
 
         if ($this->isMultiple($fieldDefinition)) {
-            $type = "[$type]";
+            if ($this->enablePagination) {
+                $type = 'RelationsConnection';
+            } else {
+                @trigger_error(
+                    'Disable pagination for ezobjectrelationlist has been deprecated since version 4.6 ' .
+                    'and will be removed in version 5.0. To start receiving `RelationsConnection` instead of the deprecated ' .
+                    '`[' . $type . ']`, set the parameter `ibexa.graphql.schema.ezobjectrelationlist.enable_pagination` to `true`.',
+                    E_USER_DEPRECATED
+                );
+
+                $type = "[$type]";
+            }
         }
 
         return $type;
@@ -68,14 +77,27 @@ public function mapToFieldValueResolver(FieldDefinition $fieldDefinition): ?stri
 
         $isMultiple = $this->isMultiple($fieldDefinition) ? 'true' : 'false';
 
-        return sprintf('@=resolver("RelationFieldValue", [field, %s])', $isMultiple);
+        return sprintf('@=resolver("RelationFieldValue", [field, %s, args])', $isMultiple);
     }
 
     protected function canMap(FieldDefinition $fieldDefinition)
     {
         return in_array($fieldDefinition->fieldTypeIdentifier, ['ezobjectrelation', 'ezobjectrelationlist']);
     }
 
+    public function mapToFieldValueArgsBuilder(FieldDefinition $fieldDefinition): ?string
+    {
+        if (!$this->canMap($fieldDefinition)) {
+            return parent::mapToFieldValueArgsBuilder($fieldDefinition);
+        }
+
+        if ($this->isMultiple($fieldDefinition) && $this->enablePagination) {
+            return 'Relay::Connection';
+        }
+
+        return parent::mapToFieldValueArgsBuilder($fieldDefinition);
+    }
+
     /**
      * Not implemented since we don't use it (canMap is overridden).
      */