core: Change the RetryPolicy trait to allow waiting on arbitrary things. #1035
Conversation
This file contains hidden or 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
Previously the only thing that that a retry would wait for was a period of time, i.e. `Duration`. This adds another function to the `RetryPolicy` trait that allows the implementer to wait on any condition they like. The default implementation of the new method provides backward compatibility by just sleeping for a period of time.
rylev
reviewed
Aug 22, 2022
| @@ -20,6 +20,13 @@ pub trait RetryPolicy { | |||
| fn is_expired(&self, duration_since_start: Duration, retry_count: u32) -> bool; | |||
| /// Determine how long before the next retry should be attempted. | |||
| fn sleep_duration(&self, retry_count: u32) -> Duration; | |||
There was a problem hiding this comment.
If we have the wait method, do we need sleep_duration any more?
There was a problem hiding this comment.
It is a convenience for the simpler cases, but I don't think it is strictly required and it may not always be implemented.
rylev
approved these changes
Aug 22, 2022
…sed on the type of error encountered.
rylev
reviewed
Aug 22, 2022
rylev
suggested changes
Aug 22, 2022
Co-authored-by: Ryan Levick <[email protected]>
rylev
approved these changes
Aug 22, 2022
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.
Previously the only thing that that a retry would wait for was a period
of time, i.e.
Duration. This adds another function to theRetryPolicytraitthat allows the implementer to wait on any condition they like. The
default implementation of the new method provides backward compatibility
by just sleeping for a period of time.
A real world example of this is flow control. If you are consistently getting errors from the service is too busy, you may want to slow send less requests across multiple threads. Long term it might be better to add a custom policy for this so that you have access to the exact error, but it would also need to be aware of retries that had occurred, and probably sit later in the
Pipeline. Another option would be to pass the error into this new function.