fix(pkg): fixed pull request lister pagination support. #13
Conversation
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
FedeDP
commented
Jan 8, 2024
go.mod
Outdated
FedeDP
commented
Jan 8, 2024
go.sum
Outdated
FedeDP
commented
Jan 8, 2024
| // 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) |
There was a problem hiding this comment.
Force a rate limited github client when no token is passed.
FedeDP
commented
Jan 8, 2024
| // | ||
| // 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.
FedeDP
commented
Jan 8, 2024
| // Default: 1 | ||
| page := 1 | ||
| prs := make([]*github.PullRequest, 0) | ||
| for { |
There was a problem hiding this comment.
Collect all PRs supporting pagination.
FedeDP
commented
Jan 8, 2024
| } | ||
| if !isMerged { | ||
| // It means PR has been closed but not merged in | ||
| if p.GetMergedAt().Equal(time.Time{}) { |
There was a problem hiding this comment.
Avoid a call to github API to retrieve the merged state.
Note: p.GetMerged() always returns false because merged is always empty since github API does not provide it anymore.
See https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests schema:
"required": [
"_links",
"assignee",
"labels",
"base",
"body",
"closed_at",
"comments_url",
"commits_url",
"created_at",
"diff_url",
"head",
"html_url",
"id",
"node_id",
"issue_url",
"merge_commit_sha",
"merged_at",
"milestone",
"number",
"patch_url",
"review_comment_url",
"review_comments_url",
"statuses_url",
"state",
"locked",
"title",
"updated_at",
"url",
"user",
"author_association",
"auto_merge"
]
We use merged_at now.
Moreover, properly adhere to github API pr lister limits (100 per-page). Plus, avoid a second call to github API to check if PR was merged, since the info is already present in the pull request list return schema. Finally, when no token is passed, properly enforce a github rate limiting client, so that we should never get rate limited. Also, bumped go module deps versions. Signed-off-by: Federico Di Pierro <[email protected]>
|
cc @leodido (sorry for the ping!) |
leodido
approved these changes
Jan 11, 2024
| // 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) |
This was referenced Jan 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Moreover, properly adhere to github API pr lister limits (100 per-page). Plus, avoid a second call to github API to check if PR was merged, since the info is already present in the pull request list return schema.
Finally, when no token is passed, properly enforce a github rate limiting client, so that we should never get rate limited.
Also, bumped go module deps versions.