Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT: Initial design of the rate limit handler #51

Merged
merged 30 commits into from Apr 24, 2024

Conversation

nickfloyd
Copy link
Contributor

@nickfloyd nickfloyd commented Mar 8, 2024

This PR adds rate-limiting awareness (of both primary and secondary rate limits) to the dotnet-sdk. It has been validated against local versions of github/github. Note that it does not change any abstractions used to access the SDK client as octokit/go-sdk#52 did. Coverlet gives unit testing coverage of 98% of lines and 83% of branches.


Before the change?

  • The dotnet SDK did not handle the rate limiting pattern returned from the REST API

After the change?

  • The SDK now handles primary and secondary rate limits.

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

@nickfloyd nickfloyd added the Type: Feature New feature or request label Mar 8, 2024
Copy link

github-actions bot commented Mar 8, 2024

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@nickfloyd nickfloyd marked this pull request as ready for review April 11, 2024 16:03
Copy link
Contributor Author

@nickfloyd nickfloyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot approve a PR that I am author on but I 100% ✅ this. Can't wait for it to land! Your test coverage is 🥇

Copy link
Member

@kfcampbell kfcampbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nick can't approve this PR since he initially proposed it, so I'm doing it instead!

@kfcampbell kfcampbell merged commit ad2f59e into main Apr 24, 2024
3 checks passed
@kfcampbell kfcampbell deleted the add-ratelimit-handler branch April 24, 2024 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants