-
Notifications
You must be signed in to change notification settings - Fork 307
feat: add retry logic to external signer #2004
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /** | ||
| * Thrown in `retryPromise()` | ||
| * | ||
| * @prettier | ||
| */ | ||
|
|
||
| export class ErrorMaxRetriesExceededError extends Error { | ||
| constructor(maxTries: number) { | ||
| super(`giving up after reaching max retry limit of ${maxTries}`); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Retries a promise (like a request) if it returns with 'ECONNREFUSED'. Retries are delayed with an exponential backoff. | ||
| * @param {Function} func - Promise to execute. When it throws an error, it is called and passed to onError | ||
| * @param {Function} onError - Error handler. Called with error as argument. | ||
| * If an error should not be retried, the handler should re-throw the passed error. | ||
| * @param params | ||
| * @param {Number} params.retryLimit - the maximum number of retries to attempt before giving up. | ||
| */ | ||
| export async function retryPromise<T>( | ||
| func: () => Promise<T>, | ||
| onError: (err: Error, tryCount: number) => void = () => ({}), | ||
| params: { retryLimit: number } = { retryLimit: 3 } | ||
| ): Promise<T> { | ||
| let tryCount = 0; | ||
|
|
||
| while (tryCount < params.retryLimit) { | ||
| tryCount += 1; | ||
| try { | ||
| return await func(); | ||
| } catch (err) { | ||
| if (err.code === 'ECONNREFUSED') { | ||
| onError(err, tryCount); | ||
| } else { | ||
| throw new Error(err); | ||
| } | ||
| } | ||
|
|
||
| // if we are going to make another attempt, delay first with exponential backoff | ||
| if (tryCount < params.retryLimit) { | ||
| const secondsToWait = 2 ** (tryCount - 1) + Math.random(); | ||
| await new Promise((res) => setTimeout(res, Math.round(secondsToWait * 1000))); | ||
| } | ||
| } | ||
|
|
||
| throw new ErrorMaxRetriesExceededError(params.retryLimit); | ||
| } |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's make this a debug instead and make it a little more informative
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added to #1989