feat: add rate limiting retry middleware#533
Open
adityakrmishra wants to merge 1 commit intopalantir:developfrom
Open
feat: add rate limiting retry middleware#533adityakrmishra wants to merge 1 commit intopalantir:developfrom
adityakrmishra wants to merge 1 commit intopalantir:developfrom
Conversation
Generate changelog in
|
This file contains hidden or 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
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.
Addresses #45
Hi team,
This PR introduces an opt-in middleware to automatically wait and retry requests when hitting GitHub's rate limits or secondary abuse limits (HTTP 403), as requested in #45.
To address the concerns about indefinite blocking and race conditions, this feature is completely opt-in and requires a strict
maxWaitthreshold.Implementation Details:
WithRateLimitRetry(maxWait)as aClientOption.RateLimitMaxWaittoConfig(configurable via YAML/JSON orGITHUB_RATE_LIMIT_MAX_WAITenv var).Retry-After(seconds) andX-RateLimit-Reset(epoch timestamp), prioritizingRetry-Afteras per GitHub API docs.maxWait, it returns the 403 response immediately.select { case <-ctx.Done() ... }) to prevent goroutine leaks if the caller cancels the request.Testing:
Added comprehensive table-driven tests in
middleware_retry_test.gocovering both header types, edge cases (wait > maxWait, no headers), and zero-config scenarios.Let me know if you would like any changes to the default behavior or parsing logic!