Let Project::listNames() handle pagination

kbsali · Jul 4, 2024 · 4e0dec6 · 4e0dec6
1 parent 352a8dc
commit 4e0dec6
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 8 deletions.
diff --git a/src/Redmine/Api/Project.php b/src/Redmine/Api/Project.php
@@ -59,13 +59,26 @@ final public function listNames(): array
 
         $this->projectNames = [];
 
-        $list = $this->list();
+        $limit = 100;
+        $offset = 0;
 
-        if (array_key_exists('projects', $list)) {
-            foreach ($list['projects'] as $issueStatus) {
-                $this->projectNames[(int) $issueStatus['id']] = (string) $issueStatus['name'];
+        do {
+            $list = $this->list([
+                'limit' => $limit,
+                'offset' => $offset,
+            ]);
+
+            $listCount = 0;
+            $offset += $limit;
+
+            if (array_key_exists('projects', $list)) {
+                $listCount = count($list['projects']);
+
+                foreach ($list['projects'] as $issueStatus) {
+                    $this->projectNames[(int) $issueStatus['id']] = (string) $issueStatus['name'];
+                }
             }
-        }
+        } while ($listCount === $limit);
 
         return $this->projectNames;
     }

diff --git a/tests/Behat/Bootstrap/ProjectContextTrait.php b/tests/Behat/Bootstrap/ProjectContextTrait.php
@@ -43,6 +43,18 @@ public function iCreateAProjectWithTheFollowingData(TableNode $table)
         );
     }
 
+    /**
+     * @Given I create :count projects
+     */
+    public function iCreateProjects(int $count)
+    {
+        while ($count > 0) {
+            $this->iCreateAProjectWithNameAndIdentifier('Test Project ' . $count, 'test-project-' . $count);
+
+            $count--;
+        }
+    }
+
     /**
      * @When I list all projects
      */

diff --git a/tests/Behat/features/projects.feature b/tests/Behat/features/projects.feature
@@ -163,6 +163,14 @@ Feature: Interacting with the REST API for projects
             | 1                 | Test Project B       |
             | 2                 | Test Project A       |
 
+    Scenario: Listing of multiple project names
+        Given I have a "NativeCurlClient" client
+        And I create "108" projects
+        When I list all project names
+        Then the response has the status code "200"
+        And the response has the content type "application/json"
+        And the returned data contains "108" items
+
     Scenario: Updating a project
         Given I have a "NativeCurlClient" client
         And I create a project with name "Test Project" and identifier "test-project"

diff --git a/tests/Unit/Api/Project/ListNamesTest.php b/tests/Unit/Api/Project/ListNamesTest.php
@@ -43,7 +43,7 @@ public static function getListNamesData(): array
     {
         return [
             'test without projects' => [
-                '/projects.json',
+                '/projects.json?limit=100&offset=0',
                 201,
                 <<<JSON
                 {
@@ -53,7 +53,7 @@ public static function getListNamesData(): array
                 [],
             ],
             'test with multiple projects' => [
-                '/projects.json',
+                '/projects.json?limit=100&offset=0',
                 201,
                 <<<JSON
                 {
@@ -73,13 +73,72 @@ public static function getListNamesData(): array
         ];
     }
 
+    public function testListNamesWithALotOfProjectsHandlesPagination()
+    {
+        $assertData = [];
+        $projectsRequest1 = [];
+        $projectsRequest2 = [];
+        $projectsRequest3 = [];
+
+        for ($i = 1; $i <= 100; $i++) {
+            $name = 'Project ' . $i;
+
+            $assertData[$i] = $name;
+            $projectsRequest1[] = ['id' => $i, 'name' => $name];
+        }
+
+        for ($i = 101; $i <= 200; $i++) {
+            $name = 'Project ' . $i;
+
+            $assertData[$i] = $name;
+            $projectsRequest2[] = ['id' => $i, 'name' => $name];
+        }
+
+        $client = AssertingHttpClient::create(
+            $this,
+            [
+                'GET',
+                '/projects.json?limit=100&offset=0',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                json_encode(['projects' => $projectsRequest1]),
+            ],
+            [
+                'GET',
+                '/projects.json?limit=100&offset=100',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                json_encode(['projects' => $projectsRequest2]),
+            ],
+            [
+                'GET',
+                '/projects.json?limit=100&offset=200',
+                'application/json',
+                '',
+                200,
+                'application/json',
+                json_encode(['projects' => $projectsRequest3]),
+            ],
+        );
+
+        // Create the object under test
+        $api = new Project($client);
+
+        // Perform the tests
+        $this->assertSame($assertData, $api->listNames());
+    }
+
     public function testListNamesCallsHttpClientOnlyOnce()
     {
         $client = AssertingHttpClient::create(
             $this,
             [
                 'GET',
-                '/projects.json',
+                '/projects.json?limit=100&offset=0',
                 'application/json',
                 '',
                 200,