Extend config interface to support setting retryServerErrors
#439
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
hashi-derek
reviewed
Jun 21, 2022
brandonc
reviewed
Jun 21, 2022
sebasslash
force-pushed
the
sebasslash/retry-ping-request
branch
from
3f564e7
to
dfaa6f1
Compare
brandonc
requested changes
Jun 22, 2022
The client exposes a receiver method called RetryServerErrors which toggles a flag, c.retryServerErrors, that enables/disables the retry logic in the http client. This means however, you could only enable the retry logic once the client was created, meaning any failed metadata request in `NewClient()` would not be retried. We've extended the interface of the client config object to allow enabling `c.retryServerErrors` during client init `NewClient()`.
sebasslash
force-pushed
the
sebasslash/retry-ping-request
branch
from
dfaa6f1
to
fe750da
Compare
brandonc
requested changes
Jun 23, 2022
sebasslash
changed the title
retryServerErrors
annawinkler
previously approved these changes
Jun 23, 2022
Updated! 👍 |
brandonc
previously approved these changes
Jun 23, 2022
brandonc
reviewed
Jun 23, 2022
| @@ -66,17 +66,21 @@ type Config struct { | |||
|
|
|||
| // RetryLogHook is invoked each time a request is retried. | |||
| RetryLogHook RetryLogHook | |||
|
|
|||
| // RetryServerErrors enables the retry logic in the client. | |||
There was a problem hiding this comment.
I think we should be specific about which errors are retried here and in the CHANGELOG. I think it's just 500 and 429?
brandonc
approved these changes
Jun 23, 2022
|
Reminder to the contributor that merged this PR: if your changes have added important functionality or fixed a relevant bug, open a follow-up PR to update CHANGELOG.md with a note on your changes. |
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.
Description
There were instances where users would experience a network failure during the metadata or
/pingrequest when callingNewClient().This PR adds a new field
RetryServerErrorsto theConfigobject, which sets the value forc.retryServerErrorsduring client initialization and has a default value offalse. In short, the client exposes a receiver methodRetryServerErrors(bool)which allows you to set the value ofc.retryServerErrorswhich toggles the retry logic, however it requires an initialized client. This became a problem due to the network request made inNewClient()that wouldn't be retried should it fail -- there was no way for the user to enable the retry logic before callingNewClient()!Making it an option in the client's configuration process will circumvent this issue.