fix(pkg): fixed pull request lister pagination support. #13
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,9 +4,12 @@ import ( | |
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "log" | ||
| "regexp" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/gofri/go-github-ratelimit/github_ratelimit" | ||
| "github.com/google/go-github/v28/github" | ||
| "golang.org/x/oauth2" | ||
| ) | ||
|
|
@@ -38,15 +41,21 @@ type Client struct { | |
|
|
||
| // NewClient ... | ||
| func NewClient(token string) *Client { | ||
| var client *github.Client | ||
| // Eventually create an authenticated client | ||
| if token != "" { | ||
| ts := oauth2.StaticTokenSource( | ||
| &oauth2.Token{AccessToken: token}, | ||
| ) | ||
| tc := oauth2.NewClient(context.Background(), ts) | ||
| client = github.NewClient(tc) | ||
| } else { | ||
| // Force use a rate limited client. It will be slow but should overcome rate limiting issues. | ||
| rateLimiter, err := github_ratelimit.NewRateLimitWaiterClient(nil) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| client = github.NewClient(rateLimiter) | ||
| } | ||
|
|
||
| return &Client{ | ||
|
|
@@ -63,16 +72,38 @@ func (c *Client) Get(org, repo, branch, milestone string) (ReleaseNotes, *Statis | |
| Sort: "updated", | ||
| Direction: "desc", | ||
| ListOptions: github.ListOptions{ | ||
| // https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests | ||
| // per_page integer | ||
| // | ||
| // The number of results per page (max 100). For more information, see "Using pagination in the REST API." | ||
| // Default: 30 | ||
| PerPage: 100, | ||
|
There was a problem hiding this comment. Adhere to github API limits for the List options. |
||
| }, | ||
| } | ||
|
|
||
| // https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests | ||
| // page integer | ||
| // | ||
| // The page number of the results to fetch. For more information, see "Using pagination in the REST API." | ||
| // Default: 1 | ||
| page := 1 | ||
| prs := make([]*github.PullRequest, 0) | ||
| for { | ||
|
There was a problem hiding this comment. Collect all PRs supporting pagination. |
||
| listingOpts.Page = page | ||
| pagedPrs, _, err := c.c.PullRequests.List(ctx, org, repo, listingOpts) | ||
| var rateLimitErr *github.RateLimitError | ||
| if errors.As(err, &rateLimitErr) { | ||
| return nil, nil, fmt.Errorf("hit rate limiting") | ||
| } | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| prs = append(prs, pagedPrs...) | ||
| if len(pagedPrs) < listingOpts.PerPage { | ||
| // We collected all prs! | ||
| break | ||
| } | ||
| page++ | ||
| } | ||
|
|
||
| var releaseNotes []ReleaseNote | ||
|
|
@@ -83,16 +114,7 @@ func (c *Client) Get(org, repo, branch, milestone string) (ReleaseNotes, *Statis | |
| } | ||
| for _, p := range prs { | ||
| num := p.GetNumber() | ||
| if p.GetMergedAt().Equal(time.Time{}) { | ||
|
There was a problem hiding this comment. Avoid a call to github API to retrieve the merged state. We use |
||
| continue | ||
| } | ||
| if p.GetMilestone().GetTitle() != milestone { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Force a rate limited github client when no token is passed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice