Documentation
¶
Index ¶
- Constants
- Variables
- func HasSecondaryRateLimitSuffix(documentation_url string) bool
- func WithOverrideConfig(ctx context.Context, opts ...Option) context.Context
- type CallbackContext
- type Config
- type ConfigOverridesKey
- type OnLimitDetected
- type OnSingleLimitExceeded
- type OnTotalLimitExceeded
- type Option
- func GetConfigOverrides(ctx context.Context) []Option
- func WithLimitDetectedCallback(callback OnLimitDetected) Option
- func WithNoSleep(callback OnSingleLimitExceeded) Option
- func WithSingleSleepLimit(limit time.Duration, callback OnSingleLimitExceeded) Option
- func WithTotalSleepLimit(limit time.Duration, callback OnTotalLimitExceeded) Option
- type SecondaryRateLimitBody
- type SecondaryRateLimiter
Constants ¶
const ( HeaderRetryAfter = "retry-after" HeaderXRateLimitReset = "x-ratelimit-reset" HeaderXRateLimitRemaining = "x-ratelimit-remaining" )
const (
SecondaryRateLimitMessage = `You have exceeded a secondary rate limit`
)
Variables ¶
var DocumentationSuffixes = []string{
`secondary-rate-limits`,
`#abuse-rate-limits`,
}
var LimitStatusCodes = []int{ http.StatusForbidden, http.StatusTooManyRequests, }
Functions ¶
Types ¶
type CallbackContext ¶
type CallbackContext struct {
RoundTripper *SecondaryRateLimiter
ResetTime *time.Time
TotalSleepTime *time.Duration
Request *http.Request
Response *http.Response
}
CallbackContext is passed to all callbacks. Fields might be nillable, depending on the specific callback and field.
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
Config is the config for the secondary rate limit waiter. Use the options to set the config.
func (*Config) ApplyOptions ¶
ApplyOptions applies the options to the config.
func (*Config) IsAboveSingleSleepLimit ¶
IsAboveSingleSleepLimit returns true if the single sleep duration is above the limit.
type ConfigOverridesKey ¶
type ConfigOverridesKey struct{}
type OnLimitDetected ¶
type OnLimitDetected func(*CallbackContext)
OnLimitDetected is a callback to be called when a new rate limit is detected (before the sleep). The totalSleepTime includes the sleep duration for the upcoming sleep. Note: called while holding the lock.
type OnSingleLimitExceeded ¶
type OnSingleLimitExceeded func(*CallbackContext)
OnSingleLimitPassed is a callback to be called when a rate limit is exceeding the limit for a single sleep. The ResetTime represents the end of sleep duration if the limit was not exceeded. The totalSleepTime does not include the sleep (that is not going to happen). Note: called while holding the lock.
type OnTotalLimitExceeded ¶
type OnTotalLimitExceeded func(*CallbackContext)
OnTotalLimitExceeded is a callback to be called when a rate limit is exceeding the limit for the total sleep. The ResetTime represents the end of sleep duration if the limit was not exceeded. The totalSleepTime does not include the sleep (that is not going to happen). Note: called while holding the lock.
type Option ¶
type Option func(*Config)
func GetConfigOverrides ¶
GetConfigOverrides returns the config overrides from the context, if any.
func WithLimitDetectedCallback ¶
func WithLimitDetectedCallback(callback OnLimitDetected) Option
WithLimitDetectedCallback adds a callback to be called when a new active rate limit is detected.
func WithNoSleep ¶
func WithNoSleep(callback OnSingleLimitExceeded) Option
WithNoSleep avoid sleeping during secondary rate limits. it can be used to detect the limit but handle it out-of-band. It is a helper function around WithSingleSleepLimit. The callback parameter is nillable.
func WithSingleSleepLimit ¶
func WithSingleSleepLimit(limit time.Duration, callback OnSingleLimitExceeded) Option
WithSingleSleepLimit adds a limit to the duration allowed to wait for a single sleep (rate limit). The callback parameter is nillable.
func WithTotalSleepLimit ¶
func WithTotalSleepLimit(limit time.Duration, callback OnTotalLimitExceeded) Option
WithTotalSleepLimit adds a limit to the accumulated duration allowed to wait for all sleeps (one or more rate limits). The callback parameter is nillable.
type SecondaryRateLimitBody ¶
type SecondaryRateLimitBody struct {
Message string `json:"message"`
DocumentURL string `json:"documentation_url"`
}
func (SecondaryRateLimitBody) IsSecondaryRateLimit ¶
func (s SecondaryRateLimitBody) IsSecondaryRateLimit() bool
IsSecondaryRateLimit checks whether the response is a legitimate secondary rate limit. It checks the prefix of the message and the suffix of the documentation URL in the response body in case the message or documentation URL is modified in the future. https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits
type SecondaryRateLimiter ¶
type SecondaryRateLimiter struct {
Base http.RoundTripper
// contains filtered or unexported fields
}
SecondaryRateLimiter is a RoundTripper for handling GitHub secondary rate limits.
func New ¶
func New(base http.RoundTripper, opts ...Option) *SecondaryRateLimiter
New creates a new SecondaryRateLimiter with the given base RoundTripper and options. see optins.go for available options. see RoundTrip() for the actual rate limit handling.
func (*SecondaryRateLimiter) RoundTrip ¶
RoundTrip handles the secondary rate limit by waiting for it to finish before issuing new requests. If a request got a secondary rate limit error as a response, we retry the request after waiting. Issuing more requests during a secondary rate limit may cause a ban from the server side, so we want to prevent these requests, not just for the sake of cpu/network utilization. Nonetheless, there is no way to prevent subtle race conditions without completely serializing the requests, so we prefer to let some slip in case of a race condition, i.e., after a retry-after response is received and before it is processed, a few other (concurrent) requests may be issued.
Source Files