Skip to content

Fix pagination loop termination #7

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
cy13002997189cy-ship-it wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix pagination loop termination #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a99c50
Add pagination advancement guard
cy13002997189cy-ship-it Jun 26, 2026
45dd0a1
Add pagination loop regression test
cy13002997189cy-ship-it Jun 26, 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
8 changes: 8 additions & 0 deletions pkg/github/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ func (f *IssueFetcher) FetchIssues(ctx context.Context, owner, repo string, sinc
}

var allIssues []*github.Issue
seenPages := map[int]struct{}{opt.Page: {}}
for {
issues, resp, err := f.client.Issues.ListByRepository(ctx, owner, repo, opt)
if err != nil {
Expand All @@ -37,6 +38,13 @@ func (f *IssueFetcher) FetchIssues(ctx context.Context, owner, repo string, sinc
if resp.NextPage == 0 {
break
}
if resp.NextPage <= opt.Page {
return nil, fmt.Errorf("pagination did not advance: current page %d, next page %d", opt.Page, resp.NextPage)
}
if _, ok := seenPages[resp.NextPage]; ok {
return nil, fmt.Errorf("pagination loop detected at page %d", resp.NextPage)
}
seenPages[resp.NextPage] = struct{}{}
opt.Page = resp.NextPage
}
return allIssues, nil
Expand Down
46 changes: 43 additions & 3 deletions pkg/github/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ func TestFetchIssues_Pagination(t *testing.T) {
sinceTime := time.Now().Add(-24 * time.Hour).Truncate(time.Second)
sinceStr := sinceTime.Format(time.RFC3339)

server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var server *httptest.Server
server = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
q := r.URL.Query()
if q.Get("since") != sinceStr {
t.Errorf("expected since parameter %q, got %q", sinceStr, q.Get("since"))
Expand Down Expand Up @@ -96,7 +97,8 @@ func TestFetchIssues_Pagination(t *testing.T) {
}

func TestFetchIssues_RateLimit(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var server *httptest.Server
server = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-RateLimit-Limit", "60")
w.Header().Set("X-RateLimit-Remaining", "0")
w.Header().Set("X-RateLimit-Reset", strconv.FormatInt(time.Now().Add(1*time.Hour).Unix(), 10))
Expand All @@ -122,7 +124,8 @@ func TestFetchIssues_RateLimit(t *testing.T) {
}

func TestFetchIssues_EmptyPageWithNext(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var server *httptest.Server
server = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
q := r.URL.Query()
pageStr := q.Get("page")
page := 1
Expand Down Expand Up @@ -176,6 +179,43 @@ func TestFetchIssues_EmptyPageWithNext(t *testing.T) {
}
}

func TestFetchIssues_DetectsPaginationLoop(t *testing.T) {
requests := 0

var server *httptest.Server
server = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
requests++
if requests > 2 {
t.Fatal("pagination loop was not terminated")
}

issues := []*github.Issue{
{ID: github.Int64(1), Title: github.String("Issue 1")},
}

linkHeader := fmt.Sprintf("<%s?page=1>; rel=\"next\"", server.URL+r.URL.Path)
w.Header().Set("Link", linkHeader)
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(issues)
}))
defer server.Close()

httpClient := server.Client()
client := github.NewClient(httpClient)
baseURL, _ := url.Parse(server.URL + "/")
client.BaseURL = baseURL

fetcher := NewIssueFetcher(client)
_, err := fetcher.FetchIssues(context.Background(), "owner", "repo", time.Now(), 2)
if err == nil {
t.Fatal("expected pagination loop error, got nil")
}

if !strings.Contains(err.Error(), "pagination") {
t.Errorf("expected pagination loop error, got: %v", err)
}
}

func TestFetchIssues_Integration(t *testing.T) {
token := os.Getenv("GITHUB_TOKEN")
repoFullName := os.Getenv("GITHUB_REPOSITORY")
Expand Down