-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
fix: respect maxElapsed in ExponentialBackoff.execute #3760
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
Closed
nikhil-shukl
wants to merge
1
commit into
triggerdotdev:main
from
nikhil-shukl:codex/fix-backoff-max-elapsed
+40
−1
Closed
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@trigger.dev/core": patch | ||
| --- | ||
|
|
||
| Stop `ExponentialBackoff.execute()` retries when callback execution time pushes the run past `maxElapsed`. |
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,27 @@ | ||
| import { describe, expect, it } from "vitest"; | ||
| import { ExponentialBackoff } from "../src/v3/apps/backoff.js"; | ||
|
|
||
| describe("ExponentialBackoff", () => { | ||
| it("stops execute retries when callback time exceeds maxElapsed", async () => { | ||
| const backoff = new ExponentialBackoff("NoJitter", { | ||
| factor: 0, | ||
| maxElapsed: 0.01, | ||
| maxRetries: 5, | ||
| }); | ||
| const error = new Error("retryable"); | ||
| let attempts = 0; | ||
|
|
||
| const result = await backoff.execute(async () => { | ||
| attempts++; | ||
| await new Promise((resolve) => setTimeout(resolve, 25)); | ||
| throw error; | ||
| }); | ||
|
|
||
| expect(result).toEqual({ | ||
| success: false, | ||
| cause: "Timeout", | ||
| error, | ||
| }); | ||
| expect(attempts).toBe(1); | ||
| }); | ||
| }); |
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.
🟡
maxElapsedwall-clock check is bypassed when callback throwsAttemptTimeoutThe new
maxElapsedcheck at line 343 is placed after thetry/catch/finallyblock. When the callback throws anAttemptTimeout(line 335-337), thecontinuestatement skips all code after thetry/catch/finally, including the newmaxElapsedcheck. Although thefinallyblock still executes and correctly updateselapsedMs, the actual check is never evaluated.This means if a caller uses both
attemptTimeoutMsandmaxElapsed, and every attempt times out, the loop will never exit early due tomaxElapsed. It will only stop whenretryAsync's delay-based check (which doesn't account for callback execution time,packages/core/src/v3/apps/backoff.ts:127-130) ormaxRetriesterminates the generator. For example, withmaxElapsed: 10(seconds),attemptTimeoutMs: 3000, andmaxRetries: 100, the loop could run for up to ~300 seconds instead of stopping after 10.(Refers to lines 335-337)
Was this helpful? React with 👍 or 👎 to provide feedback.