Add basic rate limit checker #706
Conversation
This is a stripped down rate limit checking implmentation that handles the infrastructure of deciding how to get rate limit information and leaves it to other implementers to decided what kind of checks they want to do and how long they want to wait. The implmentation supports checkers that sleep less than the full time until the rate limit is expected to reset, allowing for polling and notifying clients of why their query is not returning. A basic checker which sleeps until the rate limit is expected to reset is included as working example..
bitwiseman
force-pushed
the
task/guard
branch
2 times, most recently
from
e9e690e to
3affedd
Compare
Whenever I submit a PR and then start looking at it as a reviewer, I immediately find a bunch of things that need changing.
bitwiseman
force-pushed
the
task/guard
branch
from
3affedd to
158a31e
Compare
| // // 4897 is just the what the limit was when the snapshot was taken | ||
| // previousLimit = GHRateLimit | ||
| // .fromHeaderRecord(new GHRateLimit.Record(5000, 4897, System.currentTimeMillis() / 1000L)); |
There was a problem hiding this comment.
Looks like this can be removed entirely.
| * {@link RateLimitHandler#onError(IOException, HttpURLConnection)} will be called. | ||
| * </p> | ||
| * <p> | ||
| * NOTE: GitHub treats clients that exceed their rate limit very harshly. If possible, clients should avoid |
There was a problem hiding this comment.
Is there an official source out there that expresses this?
There was a problem hiding this comment.
There was a problem hiding this comment.
So then "GitHub treats clients ... harshly" refers to the further abuse rate limit apart from the regular rate limit?
My understanding is that the abuse rate limit is intended to limit something entirely different (too fast/concurrent calls/expensive calls vs exceeding total allowed calls per minute/hour).
There was a problem hiding this comment.
Ah sorry, it is this:
https://docs.github.com/en/rest/guides/best-practices-for-integrators#dealing-with-rate-limits
If you hit a rate limit, it's expected that you back off from making requests and try again later when you're permitted to do so. Failure to do so may result in the banning of your app.
This is a stripped down rate limit checking implementation that handles the infrastructure
of deciding how to get rate limit information and leaves it to other implementers to
decided what kind of checks they want to do and how long they want to wait.
The implementation supports checkers that sleep less than the full time until the
rate limit is expected to reset, allowing for polling and notifying clients of why their query
is not returning.
A basic checker which sleeps until the rate limit is expected to reset is included as working example..
Description
** Describe your change here**
Before submitting a PR:
We love getting PRs, but we hate asking people for the same basic changes every time.
master. Create your PR from that branch.mvn -D enable-ci clean install sitelocally. This may reformat your code, commit those changes. If this command doesn't succeed, your change will not pass CI.