Skip to content

test(svelte-query/createQueries): add test for not fetching queries with different durations when 'isRestoring' is true#10387

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.

Sign up for GitHub

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
sukvvon merged 1 commit into from
Apr 5, 2026
Merged

test(svelte-query/createQueries): add test for not fetching queries with different durations when 'isRestoring' is true #10387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions packages/svelte-query/tests/createQueries/createQueries.svelte.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -969,4 +969,50 @@ describe('createQueries', () => {

vi.useRealTimers()
})

it('should not fetch queries with different durations for the duration of the restoring period when isRestoring is true', async () => {
vi.useFakeTimers()

const queryFn1 = vi.fn(() => sleep(10).then(() => 'data1'))
const queryFn2 = vi.fn(() => sleep(20).then(() => 'data2'))

const rendered = render(IsRestoringExample, {
props: { queryFn1, queryFn2 },
})

await vi.advanceTimersByTimeAsync(0)

expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)

await vi.advanceTimersByTimeAsync(11)

expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)

await vi.advanceTimersByTimeAsync(10)

expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)

vi.useRealTimers()
})
Comment on lines +974 to +1017

@coderabbitaicoderabbitaiBotApr 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Protect fake-timer cleanup with try/finally to avoid cross-test leakage.

If any assertion fails before Line 1016, fake timers stay enabled and may cascade failures into later tests. Wrap the body in try/finally and restore timers in finally.

Suggested fix
 it('should not fetch queries with different durations for the duration of the restoring period when isRestoring is true', async () => {
- vi.useFakeTimers()-- const queryFn1 = vi.fn(() => sleep(10).then(() => 'data1'))- const queryFn2 = vi.fn(() => sleep(20).then(() => 'data2'))-- const rendered = render(IsRestoringExample, {- props: { queryFn1, queryFn2 },- })-- await vi.advanceTimersByTimeAsync(0)-- expect(rendered.getByTestId('status1')).toHaveTextContent('pending')- expect(rendered.getByTestId('status2')).toHaveTextContent('pending')- expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')- expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')- expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')- expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')- expect(queryFn1).toHaveBeenCalledTimes(0)- expect(queryFn2).toHaveBeenCalledTimes(0)-- await vi.advanceTimersByTimeAsync(11)-- expect(rendered.getByTestId('status1')).toHaveTextContent('pending')- expect(rendered.getByTestId('status2')).toHaveTextContent('pending')- expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')- expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')- expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')- expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')- expect(queryFn1).toHaveBeenCalledTimes(0)- expect(queryFn2).toHaveBeenCalledTimes(0)-- await vi.advanceTimersByTimeAsync(10)-- expect(rendered.getByTestId('status1')).toHaveTextContent('pending')- expect(rendered.getByTestId('status2')).toHaveTextContent('pending')- expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')- expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')- expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')- expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')- expect(queryFn1).toHaveBeenCalledTimes(0)- expect(queryFn2).toHaveBeenCalledTimes(0)-- vi.useRealTimers()+ vi.useFakeTimers()+ try {+ const queryFn1 = vi.fn(() => sleep(10).then(() => 'data1'))+ const queryFn2 = vi.fn(() => sleep(20).then(() => 'data2'))++ const rendered = render(IsRestoringExample, {+ props: { queryFn1, queryFn2 },+ })++ await vi.advanceTimersByTimeAsync(0)++ expect(rendered.getByTestId('status1')).toHaveTextContent('pending')+ expect(rendered.getByTestId('status2')).toHaveTextContent('pending')+ expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')+ expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')+ expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')+ expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')+ expect(queryFn1).toHaveBeenCalledTimes(0)+ expect(queryFn2).toHaveBeenCalledTimes(0)++ await vi.advanceTimersByTimeAsync(11)++ expect(rendered.getByTestId('status1')).toHaveTextContent('pending')+ expect(rendered.getByTestId('status2')).toHaveTextContent('pending')+ expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')+ expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')+ expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')+ expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')+ expect(queryFn1).toHaveBeenCalledTimes(0)+ expect(queryFn2).toHaveBeenCalledTimes(0)++ await vi.advanceTimersByTimeAsync(10)++ expect(rendered.getByTestId('status1')).toHaveTextContent('pending')+ expect(rendered.getByTestId('status2')).toHaveTextContent('pending')+ expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')+ expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')+ expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')+ expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')+ expect(queryFn1).toHaveBeenCalledTimes(0)+ expect(queryFn2).toHaveBeenCalledTimes(0)+ } finally {+ vi.useRealTimers()+ }
})
📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
vi.useFakeTimers()
constqueryFn1=vi.fn(()=>sleep(10).then(()=>'data1'))
constqueryFn2=vi.fn(()=>sleep(20).then(()=>'data2'))
constrendered=render(IsRestoringExample,{
props: {queryFn1,queryFn2},
})
awaitvi.advanceTimersByTimeAsync(0)
expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)
awaitvi.advanceTimersByTimeAsync(11)
expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)
awaitvi.advanceTimersByTimeAsync(10)
expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)
vi.useRealTimers()
})
vi.useFakeTimers()
try{
constqueryFn1=vi.fn(()=>sleep(10).then(()=>'data1'))
constqueryFn2=vi.fn(()=>sleep(20).then(()=>'data2'))
constrendered=render(IsRestoringExample,{
props: {queryFn1,queryFn2},
})
awaitvi.advanceTimersByTimeAsync(0)
expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)
awaitvi.advanceTimersByTimeAsync(11)
expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)
awaitvi.advanceTimersByTimeAsync(10)
expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
expect(queryFn1).toHaveBeenCalledTimes(0)
expect(queryFn2).toHaveBeenCalledTimes(0)
}finally{
vi.useRealTimers()
}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/svelte-query/tests/createQueries/createQueries.svelte.test.ts`
around lines 974 - 1017, The test enables fake timers with vi.useFakeTimers()
but restores them unconditionally at the end, risking leakage if an assertion
throws; wrap the test body that uses vi.useFakeTimers(), the calls to
vi.advanceTimersByTimeAsync(...) and all assertions in a try block and call
vi.useRealTimers() in a finally block so timers are always restored; locate the
code around vi.useFakeTimers(), the advanceTimers calls and the final
vi.useRealTimers() to implement the try/finally.

})
Loading