Repository navigation
fix(core): stop waitAndRetry polling once retries are exhausted #632
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
Open
afranzi
wants to merge
1
commit into
kibertoad:main
Choose a base branch
from
afranzi:fix/wait-and-retry-stops-after-max-retries
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+58
−0
Open
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import { setTimeout } from 'node:timers/promises' | ||
| import { describe, expect, it } from 'vitest' | ||
|
|
||
| import { waitAndRetry } from '../../lib/utils/waitUtils.ts' | ||
|
|
||
| describe('waitUtils', () => { | ||
| describe('waitAndRetry', () => { | ||
| it('resolves with the predicate result once it is truthy', async () => { | ||
| let calls = 0 | ||
|
|
||
| const result = await waitAndRetry(() => { | ||
| calls++ | ||
| return calls === 3 ? 'done' : undefined | ||
| }, 1) | ||
|
|
||
| expect(result).toBe('done') | ||
| expect(calls).toBe(3) | ||
| }) | ||
|
|
||
| it('stops polling after the retries are exhausted', async () => { | ||
| let calls = 0 | ||
|
|
||
| const result = await waitAndRetry( | ||
| () => { | ||
| calls++ | ||
| return false | ||
| }, | ||
| 1, | ||
| 3, | ||
| ) | ||
|
|
||
| expect(result).toBe(false) | ||
| // 4 checks that count as retries, plus the final check whose result is returned | ||
| expect(calls).toBe(5) | ||
|
|
||
| await setTimeout(50) | ||
| expect(calls).toBe(5) | ||
| }) | ||
|
|
||
| it('rejects when the final check after the retries are exhausted rejects', async () => { | ||
| let calls = 0 | ||
|
|
||
| const promise = waitAndRetry( | ||
| () => { | ||
| calls++ | ||
| return calls > 4 ? Promise.reject(new Error('unreachable')) : Promise.resolve(false) | ||
| }, | ||
| 1, | ||
| 3, | ||
| ) | ||
|
|
||
| await expect(promise).rejects.toThrow('unreachable') | ||
| await setTimeout(50) | ||
| expect(calls).toBe(5) | ||
| }) | ||
| }) | ||
| }) |
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.
predicateFn()runs synchronously here, inside asetTimeoutcallback and outside the promise chain. If it throws, the exception is uncaught and the returned promise never settles. Earlier checks only reachrejectbecause they run insidePromise.resolve().then().Example:
() => { if (!client) throw new Error('closed'); return client.ready }returnsfalseon every retry and then throws on the final check. Node raisesuncaughtException, Vitest reports an unhandled error, and the caller'sawaithangs. The new test only covers an async rejection, which goes throughresolve(promise)and is handled.