Skip to content

Allows API pagination to return blank pages #12475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 11 commits into from
Closed

Allows API pagination to return blank pages #12475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
66dde36
Allows API pagination to return blank pages
Nov 28, 2017
755556c
Revert "Allows API pagination to return blank pages"
Nov 29, 2017
f3209f2
Cosmetically fixes pagination in API
Nov 29, 2017
2030439
Avoid invalid total-count in API getItems() function
Dec 6, 2017
0fe56ef
simplifying current-page lookup
Dec 6, 2017
23ea39f
Merge remote-tracking branch 'origin/2.2-develop' into issue-8099
Dec 6, 2017
d7cfa68
Updates a test to remove the assumption that Page 2 of 1 would return…
Dec 7, 2017
a39d994
moves pagination changes from SearchResults.php to Collection.php
Dec 7, 2017
aab5ac1
simplifies the Address Repository Test
Dec 7, 2017
e75993b
adds Page-0 test to collections
Dec 7, 2017
2001091
reverts the format-test to use a single-quote instead of an apostroph…
Dec 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ests/integration/testsuite/Magento/Customer/Model/ResourceModel/AddressRepositoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ public function testSearchAddresses($filters, $filterGroup, $filterOrders, $expe
}

$searchBuilder->setPageSize(1);
$searchBuilder->setCurrentPage(2);
$searchBuilder->setCurrentPage(count($expectedResult));
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is necessary because some of the tests only expect 1 page back. This change ensures that tests that expect 1 page do not request the second page.


$searchCriteria = $searchBuilder->create();
$searchResults = $this->repository->getList($searchCriteria);
Expand Down
5 changes: 1 addition & 4 deletions lib/internal/Magento/Framework/Data/Collection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,8 @@ public function getCurPage($displacement = 0)
{
if ($this->_curPage + $displacement < 1) {
return 1;
} elseif ($this->_curPage + $displacement > $this->getLastPageNumber()) {
return $this->getLastPageNumber();
} else {
return $this->_curPage + $displacement;
}
return $this->_curPage + $displacement;
}

/**
Expand Down
9 changes: 9 additions & 0 deletions lib/internal/Magento/Framework/Data/Test/Unit/CollectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,15 @@ public function testFlag()
public function testGetCurPage()
{
$this->_model->setCurPage(10);
$this->assertEquals(10, $this->_model->getCurPage());

$this->_model->setCurPage(-10);
$this->assertEquals(1, $this->_model->getCurPage());

$this->_model->setCurPage(0);
$this->assertEquals(1, $this->_model->getCurPage());

$this->_model->setCurPage(1);
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change removes the assumption that Page 10 of 1 should return Page 1, but preserves the assumption that Pages < 1 return Page 1.

$this->assertEquals(1, $this->_model->getCurPage());
}

Expand Down