feat(graphql): partial pagination for page based pagination (#6120)

Co-authored-by: Xavier Leune <xleune@ccmbenchmark.com>

features/graphql/collection.feature

@@ -846,6 +846,7 @@ Feature: GraphQL collection support
           itemsPerPage
           lastPage
           totalCount
+          hasNextPage
         }
       }
     }
@@ -862,6 +863,7 @@ Feature: GraphQL collection support
     And the JSON node "data.fooDummies.paginationInfo.itemsPerPage" should be equal to the number 3
     And the JSON node "data.fooDummies.paginationInfo.lastPage" should be equal to the number 2
     And the JSON node "data.fooDummies.paginationInfo.totalCount" should be equal to the number 5
+    And the JSON node "data.fooDummies.paginationInfo.hasNextPage" should be true
     When I send the following GraphQL request:
     """
     {
@@ -970,6 +972,7 @@ Feature: GraphQL collection support
           itemsPerPage
           lastPage
           totalCount
+          hasNextPage
         }
       }
     }
@@ -986,3 +989,121 @@ Feature: GraphQL collection support
     And the JSON node "data.fooDummies.paginationInfo.itemsPerPage" should be equal to the number 3
     And the JSON node "data.fooDummies.paginationInfo.lastPage" should be equal to the number 2
     And the JSON node "data.fooDummies.paginationInfo.totalCount" should be equal to the number 5
+    And the JSON node "data.fooDummies.paginationInfo.hasNextPage" should be true
+    When I send the following GraphQL request:
+    """
+    {
+      fooDummies(page: 2) {
+        collection {
+          id
+          name
+          soManies(first: 2) {
+            edges {
+              node {
+                content
+              }
+              cursor
+            }
+            pageInfo {
+              startCursor
+              endCursor
+              hasNextPage
+              hasPreviousPage
+            }
+          }
+        }
+        paginationInfo {
+          itemsPerPage
+          lastPage
+          totalCount
+          hasNextPage
+        }
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the JSON node "data.fooDummies.collection" should have 2 elements
+    And the JSON node "data.fooDummies.collection[1].id" should exist
+    And the JSON node "data.fooDummies.collection[1].name" should exist
+    And the JSON node "data.fooDummies.collection[1].soManies" should exist
+    And the JSON node "data.fooDummies.collection[1].soManies.edges" should have 2 elements
+    And the JSON node "data.fooDummies.collection[1].soManies.edges[1].node.content" should be equal to "So many 1"
+    And the JSON node "data.fooDummies.collection[1].soManies.pageInfo.startCursor" should be equal to "MA=="
+    And the JSON node "data.fooDummies.paginationInfo.itemsPerPage" should be equal to the number 3
+    And the JSON node "data.fooDummies.paginationInfo.lastPage" should be equal to the number 2
+    And the JSON node "data.fooDummies.paginationInfo.totalCount" should be equal to the number 5
+    And the JSON node "data.fooDummies.paginationInfo.hasNextPage" should be false
+
+  @createSchema
+  Scenario: Retrieve paginated collections using only hasNextPage
+    Given there are 4 fooDummy objects with fake names
+    When I send the following GraphQL request:
+    """
+    {
+      fooDummies(page: 1, itemsPerPage: 2) {
+        collection {
+          id
+          name
+          soManies(first: 2) {
+            edges {
+              node {
+                content
+              }
+              cursor
+            }
+            pageInfo {
+              startCursor
+              endCursor
+              hasNextPage
+              hasPreviousPage
+            }
+          }
+        }
+        paginationInfo {
+          hasNextPage
+        }
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the JSON node "data.fooDummies.collection" should have 2 elements
+    And the JSON node "data.fooDummies.collection[1].id" should exist
+    And the JSON node "data.fooDummies.collection[1].name" should exist
+    And the JSON node "data.fooDummies.collection[1].soManies" should exist
+    And the JSON node "data.fooDummies.collection[1].soManies.edges" should have 2 elements
+    And the JSON node "data.fooDummies.collection[1].soManies.edges[1].node.content" should be equal to "So many 1"
+    And the JSON node "data.fooDummies.collection[1].soManies.pageInfo.startCursor" should be equal to "MA=="
+    And the JSON node "data.fooDummies.paginationInfo.hasNextPage" should be true
+    When I send the following GraphQL request:
+    """
+    {
+      fooDummies(page: 2) {
+        collection {
+          id
+          name
+          soManies(first: 2) {
+            edges {
+              node {
+                content
+              }
+              cursor
+            }
+            pageInfo {
+              startCursor
+              endCursor
+              hasNextPage
+              hasPreviousPage
+            }
+          }
+        }
+        paginationInfo {
+          hasNextPage
+        }
+      }
+    }
+    """
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the JSON node "data.fooDummies.paginationInfo.hasNextPage" should be false

src/Doctrine/Odm/Paginator.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Doctrine\Odm;
 
 use ApiPlatform\Metadata\Exception\InvalidArgumentException;
+use ApiPlatform\State\Pagination\HasNextPagePaginatorInterface;
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use Doctrine\ODM\MongoDB\Iterator\Iterator;
 use Doctrine\ODM\MongoDB\UnitOfWork;
@@ -24,7 +25,7 @@
  * @author Kévin Dunglas <dunglas@gmail.com>
  * @author Alan Poulain <contact@alanpoulain.eu>
  */
-final class Paginator implements \IteratorAggregate, PaginatorInterface
+final class Paginator implements \IteratorAggregate, PaginatorInterface, HasNextPagePaginatorInterface
 {
     public const LIMIT_ZERO_MARKER_FIELD = '___';
     public const LIMIT_ZERO_MARKER = 'limit0';
@@ -107,6 +108,14 @@ public function count(): int
         return is_countable($this->mongoDbOdmIterator->toArray()[0]['results']) ? \count($this->mongoDbOdmIterator->toArray()[0]['results']) : 0;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function hasNextPage(): bool
+    {
+        return $this->getLastPage() > $this->getCurrentPage();
+    }
+
     /**
      * @throws InvalidArgumentException
      */

src/Doctrine/Odm/Tests/PaginatorTest.php

@@ -31,13 +31,14 @@ class PaginatorTest extends TestCase
     /**
      * @dataProvider initializeProvider
      */
-    public function testInitialize(int $firstResult, int $maxResults, int $totalItems, int $currentPage, int $lastPage): void
+    public function testInitialize(int $firstResult, int $maxResults, int $totalItems, int $currentPage, int $lastPage, bool $hasNextPage): void
     {
         $paginator = $this->getPaginator($firstResult, $maxResults, $totalItems);
 
         $this->assertSame((float) $currentPage, $paginator->getCurrentPage());
         $this->assertSame((float) $lastPage, $paginator->getLastPage());
         $this->assertSame((float) $maxResults, $paginator->getItemsPerPage());
+        $this->assertSame($hasNextPage, $paginator->hasNextPage());
     }
 
     public function testInitializeWithFacetStageNotApplied(): void
@@ -203,8 +204,8 @@ private function getPaginatorWithNoCount($firstResult = 1, $maxResults = 15): Pa
     public static function initializeProvider(): array
     {
         return [
-            'First of three pages of 15 items each' => [0, 15, 42, 1, 3],
-            'Second of two pages of 10 items each' => [10, 10, 20, 2, 2],
+            'First of three pages of 15 items each' => [0, 15, 42, 1, 3, true],
+            'Second of two pages of 10 items each' => [10, 10, 20, 2, 2, false],
         ];
     }
 }

src/Doctrine/Orm/Extension/DoctrinePaginatorFactory.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Doctrine\Orm\Extension;
+
+use Doctrine\ORM\Tools\Pagination\Paginator;
+
+class DoctrinePaginatorFactory
+{
+    public function getPaginator($query, $fetchJoinCollection): Paginator
+    {
+        return new Paginator($query, $fetchJoinCollection);
+    }
+}

src/Doctrine/Orm/Paginator.php

@@ -13,17 +13,21 @@
 
 namespace ApiPlatform\Doctrine\Orm;
 
+use ApiPlatform\Doctrine\Orm\Extension\DoctrinePaginatorFactory;
+use ApiPlatform\State\Pagination\HasNextPagePaginatorInterface;
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use Doctrine\ORM\Query;
+use Doctrine\ORM\Tools\Pagination\Paginator as DoctrinePaginator;
 
 /**
  * Decorates the Doctrine ORM paginator.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-final class Paginator extends AbstractPaginator implements PaginatorInterface, QueryAwareInterface
+final class Paginator extends AbstractPaginator implements PaginatorInterface, QueryAwareInterface, HasNextPagePaginatorInterface
 {
     private ?int $totalItems = null;
+    private ?DoctrinePaginatorFactory $doctrinePaginatorFactory = null;
 
     /**
      * {@inheritdoc}
@@ -52,4 +56,40 @@ public function getQuery(): Query
     {
         return $this->paginator->getQuery();
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasNextPage(): bool
+    {
+        if (isset($this->totalItems)) {
+            return $this->totalItems > ($this->firstResult + $this->maxResults);
+        }
+
+        $cloneQuery = clone $this->paginator->getQuery();
+
+        $cloneQuery->setParameters(clone $this->paginator->getQuery()->getParameters());
+        $cloneQuery->setCacheable(false);
+
+        foreach ($this->paginator->getQuery()->getHints() as $name => $value) {
+            $cloneQuery->setHint($name, $value);
+        }
+
+        $cloneQuery
+            ->setFirstResult($this->paginator->getQuery()->getFirstResult() + $this->paginator->getQuery()->getMaxResults())
+            ->setMaxResults(1);
+
+        if (null !== $this->doctrinePaginatorFactory) {
+            $fakePaginator = $this->doctrinePaginatorFactory->getPaginator($cloneQuery, $this->paginator->getFetchJoinCollection());
+        } else {
+            $fakePaginator = new DoctrinePaginator($cloneQuery, $this->paginator->getFetchJoinCollection());
+        }
+
+        return iterator_count($fakePaginator->getIterator()) > 0;
+    }
+
+    public function setDoctrinePaginatorFactory(?DoctrinePaginatorFactory $doctrinePaginatorFactory = null): void
+    {
+        $this->doctrinePaginatorFactory = $doctrinePaginatorFactory;
+    }
 }

src/Doctrine/Orm/Tests/Fixtures/Query.php

@@ -13,6 +13,8 @@
 
 namespace ApiPlatform\Doctrine\Orm\Tests\Fixtures;
 
+use Doctrine\Common\Collections\ArrayCollection;
+
 /**
  * Replace Doctrine\ORM\Query in tests because it cannot be mocked.
  */
@@ -27,4 +29,43 @@ public function getMaxResults(): ?int
     {
         return null;
     }
+
+    public function setFirstResult($firstResult): self
+    {
+        return $this;
+    }
+
+    public function setMaxResults($maxResults): self
+    {
+        return $this;
+    }
+
+    public function setParameters($parameters): self
+    {
+        return $this;
+    }
+
+    public function getParameters()
+    {
+        return new ArrayCollection();
+    }
+
+    public function setCacheable($cacheable): self
+    {
+        return $this;
+    }
+
+    public function getHints()
+    {
+        return [];
+    }
+
+    public function getFetchJoinCollection()
+    {
+        return false;
+    }
+
+    public function getResult(): void
+    {
+    }
 }