Skip to content

test(react-query/QueryResetErrorBoundary): switch to fake timers and replace 'waitFor' with 'vi.waitFor' #9349

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
merged 2 commits into from
Jul 5, 2025
Merged

test(react-query/QueryResetErrorBoundary): switch to fake timers and replace 'waitFor' with 'vi.waitFor' #9349

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e76904
test(react-query/QueryResetErrorBoundary): switch to fake timers and …
sukvvon Jul 2, 2025
88e7e5f
Merge branch 'main' into test/react-query-QueryResetErrorBoundary-fak…
manudeli Jul 5, 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
93 changes: 51 additions & 42 deletions packages/react-query/src/__tests__/QueryResetErrorBoundary.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, expect, it, vi } from 'vitest'
import { fireEvent, waitFor } from '@testing-library/react'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { fireEvent } from '@testing-library/react'
import { ErrorBoundary } from 'react-error-boundary'
import * as React from 'react'
import { queryKey, sleep } from '@tanstack/query-test-utils'
Expand All @@ -15,6 +15,14 @@ import {
import { renderWithClient } from './utils'

describe('QueryErrorResetBoundary', () => {
beforeEach(() => {
vi.useFakeTimers()
})

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

const queryCache = new QueryCache()
const queryClient = new QueryClient({ queryCache })

Expand Down Expand Up @@ -69,15 +77,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -139,15 +147,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('status: error')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -211,15 +219,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -277,13 +285,13 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(
rendered.getByText('status: pending, fetchStatus: idle'),
).toBeInTheDocument(),
)
fireEvent.click(rendered.getByRole('button', { name: /refetch/i }))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -339,15 +347,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -405,15 +413,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -475,21 +483,21 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
shouldReset = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
succeed = true
shouldReset = false
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('error boundary'))
await vi.waitFor(() => rendered.getByText('error boundary'))
consoleMock.mockRestore()
})

Expand Down Expand Up @@ -540,13 +548,13 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await vi.waitFor(() => rendered.getByText('error boundary'))
await vi.waitFor(() => rendered.getByText('retry'))
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await vi.waitFor(() => rendered.getByText('error boundary'))
await vi.waitFor(() => rendered.getByText('retry'))
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('error boundary'))
await vi.waitFor(() => rendered.getByText('error boundary'))
expect(fetchCount).toBe(3)
consoleMock.mockRestore()
})
Expand Down Expand Up @@ -605,13 +613,13 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await vi.waitFor(() => rendered.getByText('error boundary'))
await vi.waitFor(() => rendered.getByText('retry'))
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('error boundary'))
await waitFor(() => rendered.getByText('retry'))
await vi.waitFor(() => rendered.getByText('error boundary'))
await vi.waitFor(() => rendered.getByText('retry'))
fireEvent.click(rendered.getByText('retry'))
await waitFor(() => rendered.getByText('data'))
await vi.waitFor(() => rendered.getByText('data'))
expect(fetchCount).toBe(3)
expect(renders).toBe(1)
consoleMock.mockRestore()
Expand Down Expand Up @@ -692,20 +700,21 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
})
})

describe('useQueries', () => {
it('should retry fetch if the reset error boundary has been reset', async () => {
const consoleMock = vi
Expand Down Expand Up @@ -762,15 +771,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down Expand Up @@ -832,15 +841,15 @@ describe('QueryErrorResetBoundary', () => {
</QueryErrorResetBoundary>,
)

await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('error boundary')).toBeInTheDocument(),
)
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('retry')).toBeInTheDocument(),
)
succeed = true
fireEvent.click(rendered.getByText('retry'))
await waitFor(() =>
await vi.waitFor(() =>
expect(rendered.getByText('data')).toBeInTheDocument(),
)
consoleMock.mockRestore()
Expand Down
Loading