Curler: pass number of entities retrieved so far to getPage()

Author: lkrms

src/Toolkit/Contract/Curler/CurlerPagerInterface.php

@@ -35,6 +35,8 @@ public function getFirstRequest(
      *
      * @param mixed $data
      * @param TPage $previousPage
+     * @param int|null $previousEntities The number of entities returned from
+     * the endpoint via previous pages.
      * @param mixed[]|null $query The query applied to `$request` or returned by
      * {@see CurlerPageRequestInterface::getQuery()}, if applicable.
      * @return (TPage is null ? CurlerPageInterface : TPage)
@@ -45,6 +47,7 @@ public function getPage(
         ResponseInterface $response,
         CurlerInterface $curler,
         ?CurlerPageInterface $previousPage = null,
+        ?int $previousEntities = null,
         ?array $query = null
     ): CurlerPageInterface;
 }

src/Toolkit/Curler/Curler.php

@@ -382,7 +382,7 @@ private function process(string $method, ?array $query, $data = false)
         }
         $result = $this->getResponseBody($response);
         if ($pager) {
-            $page = $pager->getPage($result, $request, $response, $this, null, $query);
+            $page = $pager->getPage($result, $request, $response, $this, null, null, $query);
             return Arr::unwrap($page->getEntities(), 1);
         }
         return $result;
@@ -444,16 +444,18 @@ private function paginate(string $method, ?array $query, $data = false): iterabl
         $request = $this->createRequest($method, $query, $data);
         $request = $pager->getFirstRequest($request, $this, $query);
         $prev = null;
+        $yielded = 0;
         do {
             if ($request instanceof CurlerPageRequestInterface) {
                 $query = $request->getQuery() ?? $query;
                 $request = $request->getRequest();
             }
             $response = $this->doSendRequest($request);
             $result = $this->getResponseBody($response);
-            $page = $pager->getPage($result, $request, $response, $this, $prev, $query);
+            $page = $pager->getPage($result, $request, $response, $this, $prev, $prev ? $yielded : null, $query);
             // Use `yield` instead of `yield from` so entities get unique keys
             foreach ($page->getEntities() as $entity) {
+                $yielded++;
                 yield $entity;
             }
             if (!$page->hasNextRequest()) {

src/Toolkit/Curler/Pager/LinkPager.php

@@ -75,6 +75,7 @@ public function getPage(
         ResponseInterface $response,
         CurlerInterface $curler,
         ?CurlerPageInterface $previousPage = null,
+        ?int $previousEntities = null,
         ?array $query = null
     ): CurlerPageInterface {
         $data = ($this->EntitySelector)($data);

src/Toolkit/Curler/Pager/ODataPager.php

@@ -66,6 +66,7 @@ public function getPage(
         ResponseInterface $response,
         CurlerInterface $curler,
         ?CurlerPageInterface $previousPage = null,
+        ?int $previousEntities = null,
         ?array $query = null
     ): CurlerPageInterface {
         if (!is_array($data)) {

src/Toolkit/Curler/Pager/QueryPager.php

@@ -73,6 +73,7 @@ public function getPage(
         ResponseInterface $response,
         CurlerInterface $curler,
         ?CurlerPageInterface $previousPage = null,
+        ?int $previousEntities = null,
         ?array $query = null
     ): CurlerPageInterface {
         $data = ($this->EntitySelector)($data);

tests/fixtures/Toolkit/Sync/Provider/MockoonPager.php

@@ -33,6 +33,7 @@ public function getPage(
         ResponseInterface $response,
         CurlerInterface $curler,
         ?CurlerPageInterface $previousPage = null,
+        ?int $previousEntities = null,
         ?array $query = null
     ): CurlerPageInterface {
         /** @var array<mixed[]> $data */

tests/unit/Toolkit/Curler/CurlerTest.php

@@ -214,6 +214,7 @@ function (
                     ResponseInterface $response,
                     CurlerInterface $curler,
                     ?CurlerPageInterface $previousPage = null,
+                    ?int $previousEntities = null,
                     ?array $query = null
                 ) use ($server, &$output): CurlerPage {
                     $output[] = $server->getNewOutput();