Skip to content

test(react-query/suspense): remove 'waitFor' and add 'advanceTimersByTime' #9350

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
60 changes: 22 additions & 38 deletions packages/react-query/src/__tests__/suspense.test.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
import { act, render, waitFor } from '@testing-library/react'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { act, render } from '@testing-library/react'
import { Suspense } from 'react'
import {
afterAll,
beforeAll,
beforeEach,
describe,
expect,
it,
vi,
} from 'vitest'
import { queryKey } from '@tanstack/query-test-utils'
import { QueryClient, QueryClientProvider, useSuspenseQuery } from '..'
import type { QueryKey } from '..'
Expand Down Expand Up @@ -43,15 +35,8 @@ describe('Suspense Timer Tests', () => {
let queryClient: QueryClient
let fetchCount: { count: number }

beforeAll(() => {
vi.useFakeTimers({ shouldAdvanceTime: true })
})

afterAll(() => {
vi.useRealTimers()
})

beforeEach(() => {
vi.useFakeTimers()
queryClient = new QueryClient({
defaultOptions: {
queries: {
Expand All @@ -62,6 +47,10 @@ describe('Suspense Timer Tests', () => {
fetchCount = { count: 0 }
})

afterEach(() => {
vi.useRealTimers()
})

it('should enforce minimum staleTime of 1000ms when using suspense with number', async () => {
const TestComponent = createTestQuery({
fetchCount,
Expand All @@ -71,7 +60,8 @@ describe('Suspense Timer Tests', () => {

const rendered = renderWithSuspense(queryClient, <TestComponent />)

await waitFor(() => rendered.getByText('data: data'))
await act(() => vi.advanceTimersByTime(0))
rendered.getByText('data: data')

rendered.rerender(
<QueryClientProvider client={queryClient}>
Expand All @@ -81,9 +71,7 @@ describe('Suspense Timer Tests', () => {
</QueryClientProvider>,
)

act(() => {
vi.advanceTimersByTime(100)
})
await act(() => vi.advanceTimersByTime(100))

expect(fetchCount.count).toBe(1)
})
Expand All @@ -97,7 +85,8 @@ describe('Suspense Timer Tests', () => {

const rendered = renderWithSuspense(queryClient, <TestComponent />)

await waitFor(() => rendered.getByText('data: data'))
await act(() => vi.advanceTimersByTime(0))
rendered.getByText('data: data')

rendered.rerender(
<QueryClientProvider client={queryClient}>
Expand All @@ -107,9 +96,7 @@ describe('Suspense Timer Tests', () => {
</QueryClientProvider>,
)

act(() => {
vi.advanceTimersByTime(100)
})
await act(() => vi.advanceTimersByTime(100))

expect(fetchCount.count).toBe(1)
})
Expand All @@ -123,7 +110,8 @@ describe('Suspense Timer Tests', () => {

const rendered = renderWithSuspense(queryClient, <TestComponent />)

await waitFor(() => rendered.getByText('data: data'))
await act(() => vi.advanceTimersByTime(0))
rendered.getByText('data: data')

rendered.rerender(
<QueryClientProvider client={queryClient}>
Expand All @@ -133,9 +121,7 @@ describe('Suspense Timer Tests', () => {
</QueryClientProvider>,
)

act(() => {
vi.advanceTimersByTime(1500)
})
await act(() => vi.advanceTimersByTime(1500))

expect(fetchCount.count).toBe(1)
})
Expand All @@ -149,7 +135,8 @@ describe('Suspense Timer Tests', () => {

const rendered = renderWithSuspense(queryClient, <TestComponent />)

await waitFor(() => rendered.getByText('data: data'))
await act(() => vi.advanceTimersByTime(0))
rendered.getByText('data: data')

rendered.rerender(
<QueryClientProvider client={queryClient}>
Expand All @@ -159,9 +146,7 @@ describe('Suspense Timer Tests', () => {
</QueryClientProvider>,
)

act(() => {
vi.advanceTimersByTime(500)
})
await act(() => vi.advanceTimersByTime(500))

expect(fetchCount.count).toBe(1)
})
Expand All @@ -175,7 +160,8 @@ describe('Suspense Timer Tests', () => {

const rendered = renderWithSuspense(queryClient, <TestComponent />)

await waitFor(() => rendered.getByText('data: data'))
await act(() => vi.advanceTimersByTime(0))
rendered.getByText('data: data')

rendered.rerender(
<QueryClientProvider client={queryClient}>
Expand All @@ -185,9 +171,7 @@ describe('Suspense Timer Tests', () => {
</QueryClientProvider>,
)

act(() => {
vi.advanceTimersByTime(2000)
})
await act(() => vi.advanceTimersByTime(2000))

expect(fetchCount.count).toBe(1)
})
Expand Down
Loading