feat: Add rate limit handling for GitHub client #5226
+68
−3
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
lukaspj
requested review from
jamengual,
lukemassa and
nitrocode
and removed request for
a team
dosubot
bot
added
feature
Signed-off-by: Lukas Peter Aldershaab <[email protected]>
Signed-off-by: Lukas Peter Aldershaab <[email protected]>
lukaspj
force-pushed
the
feat/github-rate-limit-handling
branch
from
db27064 to
b56cb64
Compare
|
For the record, we have tested this out on our setup which runs hundreds of Atlantis jobs simultaneously and it greatly improved our experience |
chenrui333
previously approved these changes
Jan 9, 2025
|
Sounds like a good idea, @lukaspj is it configurable? |
|
I can make it configurable for sure, the original PR had discussions on this as well. I’m indifferent towards configuration options because the current default seems very stable for us and we had rate limiting problems constantly before |
anryko
reviewed
Jan 16, 2025
server/events/vcs/github_client.go
Outdated
| @@ -124,23 +125,28 @@ func NewGithubClient(hostname string, credentials GithubCredentials, config Gith | |||
| return nil, errors.Wrap(err, "error initializing github authentication transport") | |||
| } | |||
|
|
|||
| transportWithRateLimit, err := github_ratelimit.NewRateLimitWaiterClient(transport.Transport, github_ratelimit.WithTotalSleepLimit(time.Minute, nil)) | |||
There was a problem hiding this comment.
Should there be a callback function passed to report the event of rate limit being exceeded via error log?
There was a problem hiding this comment.
I added one now with a simple warning, what do you think of that one?
Signed-off-by: Lukas Peter Aldershaab <[email protected]>
jamengual
added
waiting-on-review
|
What response is this waiting on? Anything I need to do? |
jamengual
added
waiting-on-review
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.
This is a recreation of #4926 as that one seems abandoned by the author
What
Why
Implementation
Testing
References
go-github README
go-github-ratelimit library