-
Notifications
You must be signed in to change notification settings - Fork 946
Make backoff account for already-elapsed time. #1132
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 2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -31,6 +31,8 @@ const LOG_TAG = 'ExponentialBackoff'; | |
export class ExponentialBackoff { | ||
private currentBaseMs: number; | ||
private timerPromise: CancelablePromise<void> | null = null; | ||
/** The last backoff attempt, as epoch milliseconds. */ | ||
private lastAttemptTime = Date.now(); | ||
|
||
constructor( | ||
/** | ||
|
@@ -92,18 +94,39 @@ export class ExponentialBackoff { | |
|
||
// First schedule using the current base (which may be 0 and should be | ||
// honored as such). | ||
const delayWithJitterMs = this.currentBaseMs + this.jitterDelayMs(); | ||
const desiredDelayWithJitterMs = Math.floor( | ||
this.currentBaseMs + this.jitterDelayMs() | ||
); | ||
|
||
// Some time may have already elapsed so account for that. | ||
|
||
// Math.max(0, ...) to guard against lastAttemptTime being in the future due | ||
// to a clock change. | ||
const delaySoFarMs = Math.max(0, Date.now() - this.lastAttemptTime); | ||
|
||
// Math.max(0, ...) because the desired backoff may already be elapsed. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: I think the "Some time may have already elapsed" somewhat duplicates this line. Consider axing it. (also drop "Max.max ... because") There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
const remainingDelayMs = Math.max( | ||
0, | ||
desiredDelayWithJitterMs - delaySoFarMs | ||
); | ||
|
||
if (this.currentBaseMs > 0) { | ||
log.debug( | ||
LOG_TAG, | ||
`Backing off for ${delayWithJitterMs} ms ` + | ||
`(base delay: ${this.currentBaseMs} ms)` | ||
`Backing off for ${remainingDelayMs} ms ` + | ||
`(base delay: ${this.currentBaseMs} ms, ` + | ||
`delay with jitter: ${desiredDelayWithJitterMs} ms, ` + | ||
`last attempt: ${delaySoFarMs} ms ago)` | ||
); | ||
} | ||
|
||
this.timerPromise = this.queue.enqueueAfterDelay( | ||
this.timerId, | ||
delayWithJitterMs, | ||
op | ||
remainingDelayMs, | ||
() => { | ||
this.lastAttemptTime = Date.now(); | ||
return op(); | ||
} | ||
); | ||
|
||
// Apply backoff factor to determine next delay and ensure it is within | ||
|
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.
nit: rather than repeating the function you're calling, just describe what's happening, i.e.
// Guard against lastAttemptTime being in the future due to a clock change.
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.
SGTM, done.