feat(mongodb): partial paginator (#7352)

Author: soyuka

src/Doctrine/Odm/AbstractPaginator.php

@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Odm;
+
+use ApiPlatform\State\Pagination\PartialPaginatorInterface;
+
+abstract class AbstractPaginator implements \IteratorAggregate, PartialPaginatorInterface
+{
+    protected int $firstResult;
+    protected int $maxResults;
+    protected \ArrayIterator $iterator;
+    protected int $count;
+
+    public function __construct(array $result)
+    {
+        $this->firstResult = $result['__api_first_result__'];
+        $this->maxResults = $result['__api_max_results__'];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getCurrentPage(): float
+    {
+        if (0 >= $this->maxResults) {
+            return 1.;
+        }
+
+        return floor($this->firstResult / $this->maxResults) + 1.;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getItemsPerPage(): float
+    {
+        return (float) $this->maxResults;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIterator(): \Traversable
+    {
+        return $this->iterator;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function count(): int
+    {
+        return $this->count;
+    }
+}

src/Doctrine/Odm/Extension/PaginationExtension.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Doctrine\Odm\Extension;
 
 use ApiPlatform\Doctrine\Odm\Paginator;
+use ApiPlatform\Doctrine\Odm\PartialPaginator;
 use ApiPlatform\Metadata\Exception\RuntimeException;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\Pagination\Pagination;
@@ -50,7 +51,9 @@ public function applyToCollection(Builder $aggregationBuilder, string $resourceC
             return;
         }
 
-        $context = $this->addCountToContext(clone $aggregationBuilder, $context);
+        if ($doesCount = !$this->pagination->isPartialEnabled($operation, $context)) {
+            $context = $this->addCountToContext(clone $aggregationBuilder, $context);
+        }
 
         [, $offset, $limit] = $this->pagination->getPagination($operation, $context);
 
@@ -76,7 +79,9 @@ public function applyToCollection(Builder $aggregationBuilder, string $resourceC
         }
 
         // Count the total number of items
-        $facet->field('count')->pipeline($repository->createAggregationBuilder()->count('count'));
+        if ($doesCount) {
+            $facet->field('count')->pipeline($repository->createAggregationBuilder()->count('count'));
+        }
 
         // Store pagination metadata, read by the Paginator
         // Using __ to avoid field names mapping
@@ -111,7 +116,13 @@ public function getResult(Builder $aggregationBuilder, string $resourceClass, ?O
         $attribute = $operation?->getExtraProperties()['doctrine_mongodb'] ?? [];
         $executeOptions = $attribute['execute_options'] ?? [];
 
-        return new Paginator($aggregationBuilder->getAggregation($executeOptions)->getIterator(), $manager->getUnitOfWork(), $resourceClass);
+        $iterator = $aggregationBuilder->getAggregation($executeOptions)->getIterator();
+
+        if ($this->pagination->isPartialEnabled($operation, $context)) {
+            return new PartialPaginator($iterator, $manager->getUnitOfWork(), $resourceClass);
+        }
+
+        return new Paginator($iterator, $manager->getUnitOfWork(), $resourceClass);
     }
 
     private function addCountToContext(Builder $aggregationBuilder, array $context): array

src/Doctrine/Odm/Paginator.php

@@ -25,18 +25,10 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Alan Poulain <[email protected]>
  */
-final class Paginator implements \IteratorAggregate, PaginatorInterface, HasNextPagePaginatorInterface
+final class Paginator extends AbstractPaginator implements PaginatorInterface, HasNextPagePaginatorInterface
 {
-    private readonly \ArrayIterator $iterator;
-
-    private readonly int $firstResult;
-
-    private readonly int $maxResults;
-
     private readonly int $totalItems;
 
-    private readonly int $count;
-
     public function __construct(Iterator $mongoDbOdmIterator, UnitOfWork $unitOfWork, string $resourceClass)
     {
         $result = $mongoDbOdmIterator->toArray()[0];
@@ -45,6 +37,8 @@ public function __construct(Iterator $mongoDbOdmIterator, UnitOfWork $unitOfWork
             throw new RuntimeException('The result of the query must contain only "__api_first_result__", "__api_max_results__", "results" and "count" fields.');
         }
 
+        parent::__construct($result);
+
         // The "count" facet contains the total number of documents,
         // it is not set when the query does not return any document
         $this->totalItems = $result['count'][0]['count'] ?? 0;
@@ -60,21 +54,6 @@ public function __construct(Iterator $mongoDbOdmIterator, UnitOfWork $unitOfWork
                 $result['results'],
             ));
         }
-
-        $this->firstResult = $result['__api_first_result__'];
-        $this->maxResults = $result['__api_max_results__'];
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getCurrentPage(): float
-    {
-        if (0 >= $this->maxResults) {
-            return 1.;
-        }
-
-        return floor($this->firstResult / $this->maxResults) + 1.;
     }
 
     /**
@@ -89,14 +68,6 @@ public function getLastPage(): float
         return ceil($this->totalItems / $this->maxResults) ?: 1.;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getItemsPerPage(): float
-    {
-        return (float) $this->maxResults;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -105,22 +76,6 @@ public function getTotalItems(): float
         return (float) $this->totalItems;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getIterator(): \Traversable
-    {
-        return $this->iterator;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function count(): int
-    {
-        return $this->count;
-    }
-
     /**
      * {@inheritdoc}
      */

src/Doctrine/Odm/PartialPaginator.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Odm;
+
+use ApiPlatform\Metadata\Exception\RuntimeException;
+use Doctrine\ODM\MongoDB\Iterator\Iterator;
+use Doctrine\ODM\MongoDB\UnitOfWork;
+
+final class PartialPaginator extends AbstractPaginator
+{
+    public function __construct(Iterator $mongoDbOdmIterator, UnitOfWork $unitOfWork, string $resourceClass)
+    {
+        $result = $mongoDbOdmIterator->toArray()[0];
+
+        if (array_diff_key(['results' => 1, '__api_first_result__' => 1, '__api_max_results__' => 1], $result)) {
+            throw new RuntimeException('The result of the query must contain only "__api_first_result__", "__api_max_results__" and "results" fields.');
+        }
+
+        parent::__construct($result);
+
+        // The "results" facet contains the returned documents
+        if ([] === $result['results']) {
+            $this->count = 0;
+            $this->iterator = new \ArrayIterator();
+        } else {
+            $this->count = \count($result['results']);
+            $this->iterator = new \ArrayIterator(array_map(
+                static fn ($result): object => $unitOfWork->getOrCreateDocument($resourceClass, $result),
+                $result['results'],
+            ));
+        }
+    }
+}

tests/Fixtures/TestBundle/Document/PartialPaginationDummy.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Tests\Fixtures\TestBundle\Document;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+#[ApiResource(
+    operations: [
+        new GetCollection(
+            normalizationContext: ['hydra_prefix' => false],
+            paginationPartial: true,
+            paginationItemsPerPage: 3
+        ),
+    ]
+)]
+#[ODM\Document]
+class PartialPaginationDummy
+{
+    #[ODM\Id(strategy: 'INCREMENT')]
+    private ?int $id = null;
+
+    #[ODM\Field(type: 'string')]
+    private ?string $name = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+}