Include rate limit data in ApiLimitExceededException #327
Conversation
This file contains 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.
Overview
A 429 (api limit exceeded) response includes headers reflecting the state of the rate limit. This state can be exposed by
DigitalOceanV2\Exception\ApiLimitExceededException. Doing so allows callers to more easily access the rate limit state and act accordingly.BC Concerns
This change adds a new third argument to the
ApiLimitExceededExceptionconstructor. The new constructor argument is nullable and defaults to null to allow any existing calls to the constructor that may be present in consumers of this package to continue to work.Tests
A new test has been added to verify that an instance of
ApiLimitExceededExceptioncreated viaExceptionThrower::handleRequest()contains the relevant rate limit state.