Skip to content

test(react-query/usePrefetchQuery): remove 'vi.waitFor' and add 'advanceTimersByTimeAsync' #9355

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

test(react-query/usePrefetchQuery): remove 'vi.waitFor' and add 'advanceTimersByTimeAsync' #9355

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f266491
test(react-query/usePrefetchQuery): remove 'vi.waitFor' and add 'adva…
sukvvon Jul 4, 2025
801cc2b
Merge branch 'main' into test/react-query-usePrefetchQuery-add-advanc…
manudeli Jul 5, 2025
17b12fe
test(react-query/usePrefetchQuery): replace 'advanceTimersByTimeAsync…
sukvvon Jul 7, 2025
2375c23
Merge branch 'main' into test/react-query-usePrefetchQuery-add-advanc…
sukvvon Jul 7, 2025
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
51 changes: 25 additions & 26 deletions packages/react-query/src/__tests__/usePrefetchQuery.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import React from 'react'
import { fireEvent } from '@testing-library/react'
import { act, fireEvent } from '@testing-library/react'
import { ErrorBoundary } from 'react-error-boundary'
import { queryKey } from '@tanstack/query-test-utils'
import { queryKey, sleep } from '@tanstack/query-test-utils'
import {
QueryCache,
QueryClient,
Expand All @@ -18,7 +18,7 @@ const generateQueryFn = (data: string) =>
vi
.fn<(...args: Array<any>) => Promise<string>>()
.mockImplementation(async () => {
await vi.advanceTimersByTimeAsync(10)
await sleep(10)

return data
})
Expand Down Expand Up @@ -72,7 +72,8 @@ describe('usePrefetchQuery', () => {

const rendered = renderWithClient(queryClient, <App />)

await vi.waitFor(() => rendered.getByText('data: prefetchQuery'))
await act(() => vi.advanceTimersByTimeAsync(11))
rendered.getByText('data: prefetchQuery')
expect(queryOpts.queryFn).toHaveBeenCalledTimes(1)
})

Expand All @@ -92,14 +93,13 @@ describe('usePrefetchQuery', () => {
)
}

await queryClient.fetchQuery(queryOpts)
queryClient.fetchQuery(queryOpts)
await vi.advanceTimersByTimeAsync(10)
queryOpts.queryFn.mockClear()
const rendered = renderWithClient(queryClient, <App />)

expect(rendered.queryByText('fetching: true')).not.toBeInTheDocument()
await vi.waitFor(() =>
rendered.getByText('data: The usePrefetchQuery hook is smart!'),
)
rendered.getByText('data: The usePrefetchQuery hook is smart!')
expect(queryOpts.queryFn).not.toHaveBeenCalled()
})

Expand All @@ -114,7 +114,7 @@ describe('usePrefetchQuery', () => {
}

queryFn.mockImplementationOnce(async () => {
await vi.advanceTimersByTimeAsync(10)
await sleep(10)

throw new Error('Oops! Server error!')
})
Expand All @@ -131,11 +131,12 @@ describe('usePrefetchQuery', () => {
)
}

await queryClient.prefetchQuery(queryOpts)
queryClient.prefetchQuery(queryOpts)
await vi.advanceTimersByTimeAsync(10)
queryFn.mockClear()
const rendered = renderWithClient(queryClient, <App />)

await vi.waitFor(() => rendered.getByText('Oops!'))
rendered.getByText('Oops!')
expect(rendered.queryByText('data: Not an error')).not.toBeInTheDocument()
expect(queryOpts.queryFn).not.toHaveBeenCalled()

Expand Down Expand Up @@ -166,7 +167,8 @@ describe('usePrefetchQuery', () => {
}

const rendered = renderWithClient(queryClient, <App />)
await vi.waitFor(() => rendered.getByText('data: prefetchedQuery'))
await act(() => vi.advanceTimersByTimeAsync(11))
rendered.getByText('data: prefetchedQuery')
expect(queryOpts.queryFn).toHaveBeenCalledTimes(1)
})

Expand All @@ -181,7 +183,7 @@ describe('usePrefetchQuery', () => {
}

queryFn.mockImplementationOnce(async () => {
await vi.advanceTimersByTimeAsync(10)
await sleep(10)

throw new Error('Oops! Server error!')
})
Expand All @@ -207,16 +209,16 @@ describe('usePrefetchQuery', () => {
)
}

await queryClient.prefetchQuery(queryOpts)
queryClient.prefetchQuery(queryOpts)
await vi.advanceTimersByTimeAsync(10)
queryFn.mockClear()

const rendered = renderWithClient(queryClient, <App />)

await vi.waitFor(() => rendered.getByText('Oops!'))
rendered.getByText('Oops!')
fireEvent.click(rendered.getByText('Try again'))
await vi.waitFor(() =>
rendered.getByText('data: This is fine :dog: :fire:'),
)
await act(() => vi.advanceTimersByTimeAsync(11))
rendered.getByText('data: This is fine :dog: :fire:')
expect(queryOpts.queryFn).toHaveBeenCalledTimes(1)
consoleMock.mockRestore()
})
Expand Down Expand Up @@ -265,14 +267,11 @@ describe('usePrefetchQuery', () => {
expect(
queryClient.getQueryState(thirdQueryOpts.queryKey)?.fetchStatus,
).toBe('fetching')
await vi.waitFor(() => rendered.getByText('Loading...'))
await vi.waitFor(() => rendered.getByText('data: Prefetch is nice!'))
await vi.waitFor(() =>
rendered.getByText('data: Prefetch is really nice!!'),
)
await vi.waitFor(() =>
rendered.getByText('data: Prefetch does not create waterfalls!!'),
)
rendered.getByText('Loading...')
await act(() => vi.advanceTimersByTimeAsync(11))
rendered.getByText('data: Prefetch is nice!')
rendered.getByText('data: Prefetch is really nice!!')
rendered.getByText('data: Prefetch does not create waterfalls!!')
expect(Fallback).toHaveBeenCalledTimes(1)
expect(firstQueryOpts.queryFn).toHaveBeenCalledTimes(1)
expect(secondQueryOpts.queryFn).toHaveBeenCalledTimes(1)
Expand Down
Loading