Skip to content

fix(pagination): keep the cursor and filters when fetching the next page #134

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

Open
pjcdawkins wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(pagination): keep the cursor and filters when fetching the next page #134

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3b0b46
fix(pagination): keep the cursor and filters when fetching the next page
pjcdawkins Jul 29, 2026
941f9d4
docs(organization:subscription:list): clarify what --page overrides
pjcdawkins Jul 29, 2026
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
11 changes: 8 additions & 3 deletions legacy/src/Command/Organization/OrganizationCommandBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use Symfony\Contracts\Service\Attribute\Required;
use Platformsh\Cli\Command\CommandBase;
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\Organization\Member;
use Platformsh\Client\Model\Organization\Organization;
use Symfony\Component\Console\Exception\InvalidArgumentException;
Expand Down Expand Up @@ -90,11 +91,15 @@ protected function chooseMember(Organization $organization): Member
$progress = new ProgressMessage($this->stdErr);
$progress->showIfOutputDecorated('Loading users...');
try {
do {
while (true) {
$result = Member::getCollectionWithParent($url, $httpClient, $options);
$members = array_merge($members, $result['items']);
$url = $result['collection']->getNextPageUrl();
} while (!empty($url));
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null) {
break;
}
[$url, $options['query']] = $nextPage;
}
} finally {
$progress->done();
}
Expand Down
52 changes: 33 additions & 19 deletions legacy/src/Command/Organization/OrganizationSubscriptionListCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Platformsh\Cli\Service\Config;
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Service\Table;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\Subscription;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputInterface;
Expand All @@ -18,6 +19,9 @@
#[AsCommand(name: 'organization:subscription:list', description: 'List subscriptions within an organization', aliases: ['org:subs'])]
class OrganizationSubscriptionListCommand extends OrganizationCommandBase
{
/** The maximum page size allowed by the API. */
public const MAX_COUNT = 100;

/** @var array<string, string> */
private array $tableHeader = [
'id' => 'Subscription ID',
Expand All @@ -40,7 +44,7 @@ protected function configure(): void
{
$this->setHiddenAliases(['organization:subscriptions'])
->addOption('page', null, InputOption::VALUE_REQUIRED, 'Page number. This enables pagination, despite configuration or --count.')
->addOption('count', 'c', InputOption::VALUE_REQUIRED, 'The number of items to display per page. Use 0 to disable pagination. Ignored if --page is specified.');
->addOption('count', 'c', InputOption::VALUE_REQUIRED, 'The number of items to display per page (max: ' . self::MAX_COUNT . '). Use 0 to disable pagination.');
Comment thread
pjcdawkins marked this conversation as resolved.
Outdated
$this->selector->addOrganizationOptions($this->getDefinition(), true);
$this->addCompleter($this->selector);
Table::configureInput($this->getDefinition(), $this->tableHeader, $this->defaultColumns);
Expand All @@ -59,48 +63,58 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$count = $input->getOption('count');
$itemsPerPage = $this->config->getInt('pagination.count');
if ($count !== null && $count !== '0') {
if (!\is_numeric($count) || $count > 50) {
$this->stdErr->writeln('The --count must be a number between 1 and 50, or 0 to disable pagination.');
if (!\is_numeric($count) || $count < 1 || $count > self::MAX_COUNT) {
$this->stdErr->writeln('The --count must be a number between 1 and ' . self::MAX_COUNT . ', or 0 to disable pagination.');
return 1;
}
$itemsPerPage = $count;
$itemsPerPage = (int) $count;
}
$options['query']['range'] = $itemsPerPage;

$fetchAllPages = !$this->config->getBool('pagination.enabled');
if ($count === '0') {
$fetchAllPages = true;
$itemsPerPage = self::MAX_COUNT;
}
$options['query']['page[size]'] = $itemsPerPage;

$pageNumber = $input->getOption('page');
if ($pageNumber === null) {
$pageNumber = 1;
} else {
$requestedPage = 1;
if (($pageOption = $input->getOption('page')) !== null) {
if (!\is_numeric($pageOption) || $pageOption < 1) {
$this->stdErr->writeln('The --page must be a number greater than 0.');
return 1;
}
$requestedPage = (int) $pageOption;
$fetchAllPages = false;
}
$options['query']['page'] = $pageNumber;

$organization = $this->selector->selectOrganization($input);

$httpClient = $this->api->getHttpClient();
$subscriptions = [];
$url = $organization->getUri() . '/subscriptions';
$pageNumber = 1;
$hasNextPage = false;
$progress = new ProgressMessage($output);
while (true) {
$progress->showIfOutputDecorated(\sprintf('Loading subscriptions (page %d)...', $pageNumber));
$collection = Subscription::getPagedCollection($url, $httpClient, $options);
$progress->done();
$subscriptions = \array_merge($subscriptions, $collection['items']);
if ($fetchAllPages && count($collection['items']) > 0 && isset($collection['next']) && $collection['next'] !== $url) {
$url = $collection['next'];
$pageNumber++;
continue;
// The API paginates with a cursor, so pages before the requested
// one have to be fetched, and discarded, to reach it.
if ($pageNumber >= $requestedPage) {
$subscriptions = \array_merge($subscriptions, $collection['items']);
}
$nextPage = PaginationUtil::nextPage($collection['next'], $url, $options['query']);

@upsun-dispatch upsun-dispatch Bot Jul 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Warning — Emits a spurious PHP warning on the last page in verbose mode where the key was previously isset-guarded.

$collection['next'] is now read unconditionally, whereas the previous code guarded every access with isset($collection['next']) (both in the loop and the display block). On the last page getPagedCollection() does not populate next, so PHP raises Undefined array key "next". Under -v the application sets error_reporting(E_ALL & ~E_DEPRECATED) with display_errors = stderr (Application.php), so this warning is printed to stderr on the final page of every subscription listing — the same verbose mode used to verify this PR.

$hasNextPage = $nextPage !== null;
if (!$hasNextPage || (!$fetchAllPages && $pageNumber >= $requestedPage)) {
break;
}
break;
[$url, $options['query']] = $nextPage;
$pageNumber++;
}

if (empty($subscriptions)) {
if ($pageNumber > 1) {
if ($requestedPage > 1) {
$this->stdErr->writeln('No subscriptions were found on this page.');
return 0;
}
Expand All @@ -116,15 +130,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int

if (!$this->table->formatIsMachineReadable()) {
$title = \sprintf('Subscriptions belonging to the organization <info>%s</info>', $this->api->getOrganizationLabel($organization));
if (($pageNumber > 1 || isset($collection['next'])) && !$fetchAllPages) {
if (($pageNumber > 1 || $hasNextPage) && !$fetchAllPages) {
$title .= \sprintf(' (page %d)', $pageNumber);
}
$this->stdErr->writeln($title);
}

$this->table->render($rows, $this->tableHeader, $this->defaultColumns);

if (!$this->table->formatIsMachineReadable() && isset($collection['next'])) {
if (!$this->table->formatIsMachineReadable() && $hasNextPage) {
$this->stdErr->writeln(\sprintf('More subscriptions are available on the next page (<info>--page %d</info>)', $pageNumber + 1));
$this->stdErr->writeln('List all items with: <info>--count 0</info> (<info>-c0</info>)');
}
Expand Down
11 changes: 8 additions & 3 deletions legacy/src/Command/Organization/User/OrganizationUserListCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Service\PropertyFormatter;
use Platformsh\Cli\Service\Table;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\Organization\Member;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputInterface;
Expand Down Expand Up @@ -97,11 +98,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$progress = new ProgressMessage($output);
$progress->showIfOutputDecorated('Loading users...');
try {
do {
while (true) {
$result = Member::getCollectionWithParent($url, $httpClient, $options);
$members = array_merge($members, $result['items']);
$url = $result['collection']->getNextPageUrl();
} while (!empty($url) && $fetchAllPages);
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null || !$fetchAllPages) {
break;
}
[$url, $options['query']] = $nextPage;
}
} finally {
$progress->done();
}
Expand Down
11 changes: 6 additions & 5 deletions legacy/src/Command/Organization/User/OrganizationUserProjectsCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Platformsh\Cli\Service\PropertyFormatter;
use Platformsh\Cli\Service\Table;
use Platformsh\Cli\Util\OsUtil;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\CentralizedPermissions\UserExtendedAccess;
use Platformsh\Client\Model\Ref\UserRef;
use Symfony\Component\Console\Attribute\AsCommand;
Expand Down Expand Up @@ -118,12 +119,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$collection = UserExtendedAccess::getPagedCollection($url, $httpClient, $options);
$progress->done();
$items = \array_merge($items, $collection['items']);
if (count($collection['items']) > 0 && isset($collection['next']) && $collection['next'] !== $url) {
$url = $collection['next'];
$pageNumber++;
continue;
$nextPage = PaginationUtil::nextPage($collection['next'], $url, $options['query']);

@upsun-dispatch upsun-dispatch Bot Jul 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Warning — Same last-page warning regression on the user-projects listing.

Same unguarded read as in the subscription list: PaginationUtil::nextPage($collection['next'], ...) replaces the prior isset($collection['next']) guard. When getPagedCollection() returns no next key on the final page, PHP emits Undefined array key "next", which is shown on stderr in verbose mode. Pass the key defensively (e.g. $collection['next'] ?? null).

if ($nextPage === null) {
break;
}
break;
[$url, $options['query']] = $nextPage;
$pageNumber++;
}

if (empty($items)) {
Expand Down
9 changes: 7 additions & 2 deletions legacy/src/Command/Team/Project/TeamProjectAddCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Platformsh\Cli\Command\Team\TeamCommandBase;
use Platformsh\Cli\Console\ArrayArgument;
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Exception\ApiResponseException;
use Platformsh\Client\Model\Organization\Project as OrgProject;
use Platformsh\Client\Model\Team\Team;
Expand Down Expand Up @@ -229,14 +230,18 @@ private function loadOrgProjects(Team $team): array
$options = [];
$options['query']['filter[status][in]'] = 'active,suspended';
$progress = new ProgressMessage($this->stdErr);
while ($url !== null) {
while (true) {
if ($pageNumber > 1) {
$progress->showIfOutputDecorated(sprintf('Loading projects (page %d)...', $pageNumber));
}
$result = OrgProject::getCollectionWithParent($url, $httpClient, $options);
$progress->done();
$projects = array_merge($projects, $result['items']);
$url = $result['collection']->getNextPageUrl();
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null) {
break;
}
[$url, $options['query']] = $nextPage;
$pageNumber++;
}
return $projects;
Expand Down
18 changes: 12 additions & 6 deletions legacy/src/Command/Team/Project/TeamProjectListCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Service\PropertyFormatter;
use Platformsh\Cli\Service\Table;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\Team\TeamProjectAccess;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputInterface;
Expand Down Expand Up @@ -58,18 +59,19 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$count = $input->getOption('count');
$itemsPerPage = $this->config->getInt('pagination.count');
if ($count !== null && $count !== '0') {
if (!\is_numeric($count) || $count > self::MAX_COUNT) {
if (!\is_numeric($count) || $count < 1 || $count > self::MAX_COUNT) {
$this->stdErr->writeln('The --count must be a number between 1 and ' . self::MAX_COUNT . ', or 0 to disable pagination.');
return 1;
}
$itemsPerPage = $count;
$itemsPerPage = (int) $count;
}
$options['query']['range'] = $itemsPerPage;

$fetchAllPages = !$this->config->getBool('pagination.enabled');
if ($count === '0') {
$fetchAllPages = true;
$itemsPerPage = self::MAX_COUNT;
}
$options['query']['page[size]'] = $itemsPerPage;

$team = $this->validateTeamInput($input);
if (!$team) {
Expand All @@ -82,16 +84,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$url = $team->getUri() . '/project-access';
$progress = new ProgressMessage($output);
$pageNumber = 1;
do {
while (true) {
if ($pageNumber > 1) {
$progress->showIfOutputDecorated(sprintf('Loading projects (page %d)...', $pageNumber));
}
$result = TeamProjectAccess::getCollectionWithParent($url, $httpClient, $options);
$progress->done();
$projects = \array_merge($projects, $result['items']);
$url = $result['collection']->getNextPageUrl();
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null || !$fetchAllPages) {
break;
}
[$url, $options['query']] = $nextPage;
$pageNumber++;
} while ($url && $fetchAllPages);
}

if (empty($projects)) {
$this->stdErr->writeln(\sprintf('No projects were found in the team %s.', $this->getTeamLabel($team)));
Expand Down
19 changes: 14 additions & 5 deletions legacy/src/Command/Team/TeamCommandBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Platformsh\Cli\Command\CommandBase;
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Exception\NoOrganizationsException;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\Organization\Organization;
use Platformsh\Client\Model\Team\Team;
use Platformsh\Client\Model\Team\TeamProjectAccess;
Expand Down Expand Up @@ -168,16 +169,20 @@ protected function loadTeams(Organization $organization, bool $fetchAllPages = t
$teams = [];
$progress = new ProgressMessage($this->stdErr);
$pageNumber = 1;
do {
while (true) {
if ($pageNumber > 1) {
$progress->showIfOutputDecorated(sprintf('Loading teams (page %d)...', $pageNumber));
}
$result = Team::getCollectionWithParent($url, $httpClient, $options);
$progress->done();
$teams = array_merge($teams, $result['items']);
$url = $result['collection']->getNextPageUrl();
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null || !$fetchAllPages) {
break;
}
[$url, $options['query']] = $nextPage;
$pageNumber++;
} while ($url && $fetchAllPages);
}
return $teams;
}

Expand Down Expand Up @@ -215,14 +220,18 @@ protected function loadTeamProjects(Team $team): array
$url = $team->getUri() . '/project-access';
$progress = new ProgressMessage($this->stdErr);
$pageNumber = 1;
while ($url !== null) {
while (true) {
if ($pageNumber > 1) {
$progress->showIfOutputDecorated(sprintf('Loading team projects (page %d)...', $pageNumber));
}
$result = TeamProjectAccess::getCollectionWithParent($url, $httpClient, $options);
$progress->done();
$projects = \array_merge($projects, $result['items']);
$url = $result['collection']->getNextPageUrl();
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null) {
break;
}
[$url, $options['query']] = $nextPage;
$pageNumber++;
}
return $projects;
Expand Down
9 changes: 7 additions & 2 deletions legacy/src/Command/Team/TeamCreateCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use GuzzleHttp\Exception\BadResponseException;
use Platformsh\Cli\Console\ArrayArgument;
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Cli\Util\Wildcard;
use Platformsh\Client\Exception\ApiResponseException;
use Platformsh\Client\Model\Team\Team;
Expand Down Expand Up @@ -81,7 +82,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$url = '/teams';
$pageNumber = 1;
$progress = new ProgressMessage($this->stdErr);
while ($url) {
while (true) {
if ($pageNumber > 1) {
$progress->showIfOutputDecorated(sprintf('Loading teams (page %d)...', $pageNumber));
}
Expand All @@ -94,7 +95,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
return 1;
}
}
$url = $result['collection']->getNextPageUrl();
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null) {
break;
}
[$url, $options['query']] = $nextPage;
$pageNumber++;
}
}
Expand Down
11 changes: 8 additions & 3 deletions legacy/src/Command/Team/User/TeamUserListCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Platformsh\Cli\Console\ProgressMessage;
use Platformsh\Cli\Service\PropertyFormatter;
use Platformsh\Cli\Service\Table;
use Platformsh\Cli\Util\PaginationUtil;
use Platformsh\Client\Model\Team\TeamMember;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputInterface;
Expand Down Expand Up @@ -78,16 +79,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$url = $team->getUri() . '/members';
$progress = new ProgressMessage($output);
$pageNumber = 1;
do {
while (true) {
if ($pageNumber > 1) {
$progress->showIfOutputDecorated(sprintf('Loading users (page %d)...', $pageNumber));
}
$result = TeamMember::getCollectionWithParent($url, $httpClient, $options);
$progress->done();
$members = \array_merge($members, $result['items']);
$url = $result['collection']->getNextPageUrl();
$nextPage = PaginationUtil::nextPage($result['collection']->getNextPageUrl(), $url, $options['query']);
if ($nextPage === null || !$fetchAllPages) {
break;
}
[$url, $options['query']] = $nextPage;
$pageNumber++;
} while ($url && $fetchAllPages);
}

if (empty($members)) {
$this->stdErr->writeln(\sprintf('No users were found in the team %s.', $this->getTeamLabel($team)));
Expand Down
Loading