[9.x] Pass thrown exception to $sleepMilliseconds closure in retry helper #42532
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.
What does this pull request implement?
This pull requests implement a backwards-compatible change to the
retry
helper. Theretry
helper accepts either anint
or aClosure
. When passing aClosure
object, the$attempts
parameter would be passed, allowed users to implement their own backoff algorithm.In some cases, however, it would be desirable to implement a backoff strategy based on the exception that was thrown, for example in the case of an API client that returns a specific exception in the case of a
HTTP 429
. In such cases, the exception thrown could potentially hold information as to how long a user has to wait before a new attempt will be excepted.This pull request allows you to access the thrown exception instance in the
$sleepMilliseconds
closure to implement a dynamic backoff strategy.Example use case
Imagine an API library that throws the following exception in the case of a HTTP 429:
Using the above information, we would be able to implement a dynamic backoff strategy as follows: