Skip to content

Improve GitHub branch listing pagination #102

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
HarshMN2345 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve GitHub branch listing pagination #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e71e384
Improve GitHub branch listing pagination
HarshMN2345 May 14, 2026
6c633f3
Use prefix search for GitHub branches
HarshMN2345 May 14, 2026
a13602d
Honor branch pagination in other adapters
HarshMN2345 May 14, 2026
abc7f7e
Preserve default branch listing behavior
HarshMN2345 May 14, 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
7 changes: 5 additions & 2 deletions src/VCS/Adapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,12 @@ abstract public function getRepositoryName(string $repositoryId): string;
*
* @param string $owner Owner name of the repository
* @param string $repositoryName Name of the repository
* @return array<string> List of branch names as array
* @param int $perPage Number of branches to fetch per page
* @param int|string|null $page Page number or cursor to start fetching from
* @param string $search Branch name prefix search query
* @return array<string>|array{items: array<string>, hasNext: bool, nextCursor?: string|null} List of branch names or branch names with pagination metadata
*/
abstract public function listBranches(string $owner, string $repositoryName): array;
abstract public function listBranches(string $owner, string $repositoryName, int $perPage = 100, int|string|null $page = 1, string $search = ''): array;

/**
* Updates status check of each commit
Expand Down
97 changes: 87 additions & 10 deletions src/VCS/Adapter/Git/GitHub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,27 +747,104 @@ public function getPullRequestFromBranch(string $owner, string $repositoryName,
* @param string $owner Owner name of the repository
* @param string $repositoryName Name of the GitHub repository
* @param int $perPage Number of branches to fetch per page
* @param int $page Page number to start fetching from
* @return array<string> List of branch names as array
* @param int|string|null $page Page number or GraphQL cursor to start fetching from
* @param string $search Branch name prefix search query
* @return array{items: array<string>, hasNext: bool, nextCursor: string|null} List of branch names and pagination metadata
*/
public function listBranches(string $owner, string $repositoryName, int $perPage = 100, int $page = 1): array
public function listBranches(string $owner, string $repositoryName, int $perPage = 100, int|string|null $page = 1, string $search = ''): array
{
$url = "/repos/$owner/$repositoryName/branches";
$perPage = min(max($perPage, 1), 100);
$cursor = is_string($page) ? $page : null;
$page = is_int($page) ? max($page, 1) : 1;
$result = [
'items' => [],
'hasNext' => false,
'nextCursor' => null,
];

for ($currentPage = 1; $currentPage <= $page; $currentPage++) {
$result = $this->listBranchesPage($owner, $repositoryName, $perPage, $cursor, $search);

if ($currentPage === $page) {
return $result;
}

if ($result['hasNext'] === false) {
return [
'items' => [],
'hasNext' => false,
'nextCursor' => null,
];
}

$cursor = $result['nextCursor'];
}

$response = $this->call(self::METHOD_GET, $url, ['Authorization' => "Bearer $this->accessToken"], [
'page' => $page,
'per_page' => $perPage,
return $result;
Comment thread
greptile-apps[bot] marked this conversation as resolved.
Comment thread
greptile-apps[bot] marked this conversation as resolved.
}

/**
* @return array{items: array<string>, hasNext: bool, nextCursor: string|null}
*/
private function listBranchesPage(string $owner, string $repositoryName, int $perPage, ?string $cursor, string $search): array
{
$refPrefix = 'refs/heads/' . $search;
$query = <<<'GRAPHQL'
query ListBranches($owner: String!, $name: String!, $refPrefix: String!, $first: Int!, $after: String) {
repository(owner: $owner, name: $name) {
refs(refPrefix: $refPrefix, first: $first, after: $after, orderBy: {field: ALPHABETICAL, direction: ASC}) {
nodes {
name
}
pageInfo {
hasNextPage
endCursor
}
}
}
}
GRAPHQL;

$response = $this->call(self::METHOD_POST, '/graphql', ['Authorization' => "Bearer $this->accessToken"], [
'query' => $query,
'variables' => [
'owner' => $owner,
'name' => $repositoryName,
'refPrefix' => $refPrefix,
'first' => $perPage,
'after' => $cursor,
],
]);

$statusCode = $response['headers']['status-code'] ?? 0;
$responseBody = $response['body'] ?? [];

if ($statusCode < 200 || $statusCode >= 300 || !is_array($responseBody)) {
return [];
if ($statusCode < 200 || $statusCode >= 300 || !is_array($responseBody) || array_key_exists('errors', $responseBody)) {
return [
'items' => [],
'hasNext' => false,
'nextCursor' => null,
];
}

$refs = $responseBody['data']['repository']['refs'] ?? null;

if (!is_array($refs)) {
return [
'items' => [],
'hasNext' => false,
'nextCursor' => null,
];
}

return array_values(array_map(fn ($branch) => $branch['name'] ?? '', $responseBody));
$pageInfo = $refs['pageInfo'] ?? [];
$hasNext = $pageInfo['hasNextPage'] ?? false;

return [
'items' => array_values(array_map(fn ($branch) => $branch['name'] ?? '', $refs['nodes'] ?? [])),
'hasNext' => $hasNext,
'nextCursor' => $hasNext ? ($pageInfo['endCursor'] ?? null) : null,
];
}

/**
Expand Down
20 changes: 15 additions & 5 deletions src/VCS/Adapter/Git/GitLab.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,15 +524,17 @@ public function getPullRequestFromBranch(string $owner, string $repositoryName,
throw new Exception("Not implemented");
}

public function listBranches(string $owner, string $repositoryName): array
public function listBranches(string $owner, string $repositoryName, int $perPage = 100, int|string|null $page = 1, string $search = ''): array
{
$ownerPath = $this->getOwnerPath($owner);
$projectPath = urlencode("{$ownerPath}/{$repositoryName}");
$perPage = min(max($perPage, 1), 100);
$requestedPage = is_int($page) ? max($page, 1) : 1;

$branches = [];
$page = 1;
$currentPage = 1;
do {
$pagedUrl = "/projects/{$projectPath}/repository/branches?per_page=100&page={$page}";
$pagedUrl = "/projects/{$projectPath}/repository/branches?per_page=100&page={$currentPage}";
$response = $this->call(self::METHOD_GET, $pagedUrl, ['PRIVATE-TOKEN' => $this->accessToken]);
$responseHeaders = $response['headers'] ?? [];
$responseHeadersStatusCode = $responseHeaders['status-code'] ?? 0;
Expand All @@ -546,10 +548,18 @@ public function listBranches(string $owner, string $repositoryName): array
foreach ($responseBody as $branch) {
$branches[] = $branch['name'] ?? '';
}
$page++;
$currentPage++;
} while (count($responseBody) === 100);

return $branches;
if ($search !== '') {
$branches = array_values(array_filter($branches, fn ($branch) => str_starts_with($branch, $search)));
}

if ($search === '' && $requestedPage === 1 && $perPage === 100) {
return $branches;
}

return array_slice($branches, ($requestedPage - 1) * $perPage, $perPage);
Comment thread
greptile-apps[bot] marked this conversation as resolved.
}

public function getCommit(string $owner, string $repositoryName, string $commitHash): array
Expand Down
20 changes: 15 additions & 5 deletions src/VCS/Adapter/Git/Gitea.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,14 +715,16 @@ public function getPullRequestFromBranch(string $owner, string $repositoryName,
* @param string $repositoryName Name of the repository
* @return array<string> Array of branch names
*/
public function listBranches(string $owner, string $repositoryName): array
public function listBranches(string $owner, string $repositoryName, int $perPage = 100, int|string|null $page = 1, string $search = ''): array
{
$allBranches = [];
$perPage = 50;
$requestedPerPage = min(max($perPage, 1), 100);
$requestedPage = is_int($page) ? max($page, 1) : 1;
$apiPerPage = 50;
$maxPages = 100;

for ($currentPage = 1; $currentPage <= $maxPages; $currentPage++) {
$url = "/repos/{$owner}/{$repositoryName}/branches?page={$currentPage}&limit={$perPage}";
$url = "/repos/{$owner}/{$repositoryName}/branches?page={$currentPage}&limit={$apiPerPage}";

$response = $this->call(self::METHOD_GET, $url, ['Authorization' => "token $this->accessToken"]);

Expand Down Expand Up @@ -754,12 +756,20 @@ public function listBranches(string $owner, string $repositoryName): array
}
}

if ($pageCount < $perPage) {
if ($pageCount < $apiPerPage) {
break;
}
}

return $allBranches;
if ($search !== '') {
$allBranches = array_values(array_filter($allBranches, fn ($branch) => str_starts_with($branch, $search)));
}

if ($search === '' && $requestedPage === 1 && $requestedPerPage === 100) {
return $allBranches;
}

return array_slice($allBranches, ($requestedPage - 1) * $requestedPerPage, $requestedPerPage);
}

/**
Expand Down
14 changes: 12 additions & 2 deletions src/VCS/Adapter/Git/Gogs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,8 +490,10 @@ public function getCommitStatuses(string $owner, string $repositoryName, string
*
* @return array<string>
*/
public function listBranches(string $owner, string $repositoryName): array
public function listBranches(string $owner, string $repositoryName, int $perPage = 100, int|string|null $page = 1, string $search = ''): array
{
$perPage = min(max($perPage, 1), 100);
$page = is_int($page) ? max($page, 1) : 1;
$url = "/repos/{$owner}/{$repositoryName}/branches";

$response = $this->call(self::METHOD_GET, $url, ['Authorization' => "token $this->accessToken"]);
Expand Down Expand Up @@ -520,6 +522,14 @@ public function listBranches(string $owner, string $repositoryName): array
}
}

return $branches;
if ($search !== '') {
$branches = array_values(array_filter($branches, fn ($branch) => str_starts_with($branch, $search)));
}

if ($search === '' && $page === 1 && $perPage === 100) {
return $branches;
}

return array_slice($branches, ($page - 1) * $perPage, $perPage);
}
}
63 changes: 53 additions & 10 deletions tests/VCS/Adapter/GitHubTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,11 +471,17 @@ public function testListBranches(): void
try {
$this->vcsAdapter->createFile(static::$owner, $repositoryName, 'README.md', '# Test');

$branches = $this->vcsAdapter->listBranches(static::$owner, $repositoryName);
/** @var GitHub $adapter */
$adapter = $this->vcsAdapter;
$branches = $adapter->listBranches(static::$owner, $repositoryName);

$this->assertIsArray($branches);
$this->assertNotEmpty($branches);
$this->assertContains(static::$defaultBranch, $branches);
$this->assertArrayHasKey('items', $branches);
$this->assertArrayHasKey('hasNext', $branches);
$this->assertNotEmpty($branches['items']);
$this->assertFalse($branches['hasNext']);
$this->assertNull($branches['nextCursor']);
$this->assertContains(static::$defaultBranch, $branches['items']);
} finally {
$this->vcsAdapter->deleteRepository(static::$owner, $repositoryName);
}
Expand Down Expand Up @@ -539,13 +545,42 @@ public function testListBranchesPagination(): void
$adapter = $this->vcsAdapter;

$page1 = $adapter->listBranches(static::$owner, $repositoryName, 1, 1);
$this->assertSame(['branch-a'], $page1);
$this->assertSame(['branch-a'], $page1['items']);
$this->assertTrue($page1['hasNext']);
$this->assertNotEmpty($page1['nextCursor']);

$page2 = $adapter->listBranches(static::$owner, $repositoryName, 1, 2);
$this->assertSame(['branch-b'], $page2);
$this->assertSame(['branch-b'], $page2['items']);
$this->assertTrue($page2['hasNext']);
$this->assertNotEmpty($page2['nextCursor']);

$cursorPage2 = $adapter->listBranches(static::$owner, $repositoryName, 1, $page1['nextCursor']);
$this->assertSame($page2, $cursorPage2);

$page3 = $adapter->listBranches(static::$owner, $repositoryName, 1, 3);
$this->assertSame([static::$defaultBranch], $page3['items']);
$this->assertFalse($page3['hasNext']);
$this->assertNull($page3['nextCursor']);

$all = $adapter->listBranches(static::$owner, $repositoryName, 100, 1);
$this->assertEqualsCanonicalizing([static::$defaultBranch, 'branch-a', 'branch-b'], $all);
$this->assertEqualsCanonicalizing([static::$defaultBranch, 'branch-a', 'branch-b'], $all['items']);
$this->assertFalse($all['hasNext']);
$this->assertNull($all['nextCursor']);

$searchPage1 = $adapter->listBranches(static::$owner, $repositoryName, 1, 1, 'branch');
$this->assertSame(['branch-a'], $searchPage1['items']);
$this->assertTrue($searchPage1['hasNext']);
$this->assertNotEmpty($searchPage1['nextCursor']);

$searchPage2 = $adapter->listBranches(static::$owner, $repositoryName, 1, $searchPage1['nextCursor'], 'branch');
$this->assertSame(['branch-b'], $searchPage2['items']);
$this->assertFalse($searchPage2['hasNext']);
$this->assertNull($searchPage2['nextCursor']);

$substringSearch = $adapter->listBranches(static::$owner, $repositoryName, 100, 1, 'ranch');
$this->assertSame([], $substringSearch['items']);
$this->assertFalse($substringSearch['hasNext']);
$this->assertNull($substringSearch['nextCursor']);
} finally {
$this->vcsAdapter->deleteRepository(static::$owner, $repositoryName);
}
Expand All @@ -557,21 +592,29 @@ public function testListBranchesEmptyRepository(): void
$this->vcsAdapter->createRepository(static::$owner, $repositoryName, false);

try {
$branches = $this->vcsAdapter->listBranches(static::$owner, $repositoryName);
/** @var GitHub $adapter */
$adapter = $this->vcsAdapter;
$branches = $adapter->listBranches(static::$owner, $repositoryName);

$this->assertIsArray($branches);
$this->assertEmpty($branches);
$this->assertSame([], $branches['items']);
$this->assertFalse($branches['hasNext']);
$this->assertNull($branches['nextCursor']);
} finally {
$this->vcsAdapter->deleteRepository(static::$owner, $repositoryName);
}
}

public function testListBranchesNonExistingRepository(): void
{
$branches = $this->vcsAdapter->listBranches(static::$owner, 'non-existing-repo-' . \uniqid());
/** @var GitHub $adapter */
$adapter = $this->vcsAdapter;
$branches = $adapter->listBranches(static::$owner, 'non-existing-repo-' . \uniqid());

$this->assertIsArray($branches);
$this->assertEmpty($branches);
$this->assertSame([], $branches['items']);
$this->assertFalse($branches['hasNext']);
$this->assertNull($branches['nextCursor']);
}

public function testGetLatestCommit(): void
Expand Down
11 changes: 11 additions & 0 deletions tests/VCS/Adapter/GitLabTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,17 @@ public function testListBranches(): void
$this->assertContains(static::$defaultBranch, $result);
$this->assertContains('feature-branch', $result);
$this->assertContains('another-branch', $result);

$page1 = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 1, 1);
$page2 = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 1, 2);
$this->assertSame([$result[0]], $page1);
$this->assertSame([$result[1]], $page2);

$searchResult = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 100, 1, 'feature');
$this->assertSame(['feature-branch'], $searchResult);

$substringSearch = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 100, 1, 'eature');
$this->assertSame([], $substringSearch);
} finally {
$this->vcsAdapter->deleteRepository(static::$owner, $repositoryName);
}
Expand Down
11 changes: 11 additions & 0 deletions tests/VCS/Adapter/GiteaTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1438,6 +1438,17 @@ public function testListBranches(): void
$this->assertContains('feature-1', $branches);
$this->assertContains('feature-2', $branches);
$this->assertGreaterThanOrEqual(3, count($branches));

$page1 = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 1, 1);
$page2 = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 1, 2);
$this->assertSame([$branches[0]], $page1);
$this->assertSame([$branches[1]], $page2);

$searchResult = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 100, 1, 'feature');
$this->assertEqualsCanonicalizing(['feature-1', 'feature-2'], $searchResult);

$substringSearch = $this->vcsAdapter->listBranches(static::$owner, $repositoryName, 100, 1, 'eature');
$this->assertSame([], $substringSearch);
} finally {
$this->vcsAdapter->deleteRepository(static::$owner, $repositoryName);
}
Expand Down
Loading