feat: Allow blocking until primary rate limit is reset

[erezrokah]

Fixes#3114

Feedback very much welcomed, some notes:

1. I used the same approach as bypassRateLimitCheck with the exception that bypassRateLimitCheck is private, not sure if to use another dedicated exported requestContext type or also make bypassRateLimitCheck public for consistency
2. Checking req.Context().Value(SleepUntilPrimaryRateLimitResetWhenRateLimited) == true is also an option (instead of !=nil) and might be more readable, but that is not consistent with the bypassRateLimitCheck check
3. A possible improvement can be to add a log message/invoke a callback to consumers so they can show an indication the sleep is happening to avoid looking like something is stuck. If that makes sense it should be in a separate PR I think as that's would be a new API/interface for this module
4. If this approach makes send I will add tests for it

[codecov]

Codecov Report

Attention: Patch coverage is 90.90909% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 92.87%. Comparing base (2b8c7fa) to head (960ce81).
Report is 43 commits behind head on master.

❗ Current head 960ce81 differs from pull request most recent head ea82df3. Consider uploading reports for the commit ea82df3 to get more accurate results

Files	Patch %	Lines
github/github.go	90.90%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## master #3117 +/- ##
==========================================
- Coverage 97.72% 92.87% -4.85% 
==========================================
Files 153 170 +17 Lines 13390 11445 -1945 ==========================================
- Hits 13085 10630 -2455 - Misses 215 724 +509 - Partials 90 91 +1 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gmlewis]

It would also be nice to add one or more unit tests that would increase the code coverage for the new code.

[gmlewis]

Thank you, @erezrokah !
LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

[erezrokah]

Thank you, @erezrokah ! LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

Thanks for the quick review and feedback, I also added a 1 second buffer to the sleep time to avoid any edge cases

[gmlewis]

Thanks, @erezrokah .

Still awaiting second LGTM+Approval from any other contributor to this repo before merging.

All contributions, including code reviews, by other volunteers is greatly appreciated, as we have several outstanding PRs that need reviews. Thanks.

[erezrokah]

Hi @gmlewis I'm wondering if I should update the PR to take into account context cancellation, by changing sleepUntilResetWithBuffer to

timer:=time.NewTimer(time.Until(reset) +buffer)
select {
case<-ctx.Done():
if!timer.Stop() {
<-timer.C
}
returnnil, ctx.Err()
case<-timer.C:
}

[gmlewis]

Ah, that's an excellent idea, @erezrokah - I think you are right that this should be added.

[erezrokah]

Ah, that's an excellent idea, @erezrokah - I think you are right that this should be added.

Added 22eba4c. In one case I had to wrap the context error in a rate limit error. I can also refactor the code a bit to have checkRateLimitBeforeDo return an error instead of *RateLimitError, but thought it would be better to get some feedback first

[gmlewis]

Just a couple nits, otherwise LGTM.

[gmlewis]

Thank you, @erezrokah !
LGTM.

[be0x74a]

LGTM!

[gmlewis]

Thank you, @be0x74a !
Merging.

[erezrokah]

Thanks for the review(s) @be0x74a and @gmlewis, when can we expect a new release to be tagged with this commit?

[gmlewis]

Thanks for the review(s) @be0x74a and @gmlewis, when can we expect a new release to be tagged with this commit?

I'm away from Internet this week so the earliest will be this Friday.

[gmlewis]

This is now available here: https://github.com/google/go-github/releases/tag/v62.0.0