Skip to content

test(react-query): use fakeTimers for useIsFetching.test.tsx #8982

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 3 commits into from
Apr 12, 2025
Merged

test(react-query): use fakeTimers for useIsFetching.test.tsx #8982

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fa0c33
test(react-query): use fakeTimers in useIsFetching.test.tsx
minseong0324 Apr 9, 2025
4cc493c
Merge branch 'main' into test/useIsFetching-fake-timers
minseong0324 Apr 10, 2025
1435acb
Merge branch 'main' into test/useIsFetching-fake-timers
minseong0324 Apr 12, 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
76 changes: 56 additions & 20 deletions packages/react-query/src/__tests__/useIsFetching.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
import { describe, expect, it } from 'vitest'
import { fireEvent, render, waitFor } from '@testing-library/react'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { fireEvent, render } from '@testing-library/react'
import * as React from 'react'
import { QueryCache, useIsFetching, useQuery } from '..'
import {
createQueryClient,
queryKey,
renderWithClient,
setActTimeout,
sleep,
} from './utils'

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

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

// See https://github.com/tannerlinsley/react-query/issues/105
it('should update as queries start and stop fetching', async () => {
const queryCache = new QueryCache()
Expand All @@ -28,7 +35,7 @@ describe('useIsFetching', () => {
useQuery({
queryKey: key,
queryFn: async () => {
await sleep(50)
await vi.advanceTimersByTimeAsync(50)
return 'test'
},
enabled: ready,
Expand All @@ -48,10 +55,19 @@ describe('useIsFetching', () => {

const { findByText, getByRole } = renderWithClient(queryClient, <Page />)

await findByText('isFetching: 0')
await vi.waitFor(() => {
findByText('isFetching: 0')
})

fireEvent.click(getByRole('button', { name: /setReady/i }))
await findByText('isFetching: 1')
await findByText('isFetching: 0')

await vi.waitFor(() => {
findByText('isFetching: 1')
})

await vi.waitFor(() => {
findByText('isFetching: 0')
})
})

it('should not update state while rendering', async () => {
Expand All @@ -73,7 +89,7 @@ describe('useIsFetching', () => {
useQuery({
queryKey: key1,
queryFn: async () => {
await sleep(100)
await vi.advanceTimersByTimeAsync(100)
return 'data'
},
})
Expand All @@ -84,7 +100,7 @@ describe('useIsFetching', () => {
useQuery({
queryKey: key2,
queryFn: async () => {
await sleep(100)
await vi.advanceTimersByTimeAsync(100)
return 'data'
},
})
Expand All @@ -110,7 +126,10 @@ describe('useIsFetching', () => {
}

renderWithClient(queryClient, <Page />)
await waitFor(() => expect(isFetchingArray).toEqual([0, 1, 1, 2, 1, 0]))

await vi.waitFor(() => {
expect(isFetchingArray).toEqual([0, 1, 1, 2, 1, 0])
})
})

it('should be able to filter', async () => {
Expand All @@ -124,7 +143,7 @@ describe('useIsFetching', () => {
useQuery({
queryKey: key1,
queryFn: async () => {
await sleep(10)
await vi.advanceTimersByTimeAsync(10)
return 'test'
},
})
Expand All @@ -135,7 +154,7 @@ describe('useIsFetching', () => {
useQuery({
queryKey: key2,
queryFn: async () => {
await sleep(20)
await vi.advanceTimersByTimeAsync(20)
return 'test'
},
})
Expand Down Expand Up @@ -164,10 +183,20 @@ describe('useIsFetching', () => {

const { findByText, getByRole } = renderWithClient(queryClient, <Page />)

await findByText('isFetching: 0')
await vi.waitFor(() => {
findByText('isFetching: 0')
})

fireEvent.click(getByRole('button', { name: /setStarted/i }))
await findByText('isFetching: 1')
await findByText('isFetching: 0')

await vi.waitFor(() => {
findByText('isFetching: 1')
})

await vi.waitFor(() => {
findByText('isFetching: 0')
})

// at no point should we have isFetching: 2
expect(isFetchingArray).toEqual(expect.not.arrayContaining([2]))
})
Expand All @@ -180,7 +209,7 @@ describe('useIsFetching', () => {
useQuery({
queryKey: key,
queryFn: async () => {
await sleep(10)
await vi.advanceTimersByTimeAsync(10)
return 'test'
},
})
Expand All @@ -196,8 +225,13 @@ describe('useIsFetching', () => {

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

await rendered.findByText('isFetching: 1')
await rendered.findByText('isFetching: 0')
await vi.waitFor(() => {
rendered.findByText('isFetching: 1')
})

await vi.waitFor(() => {
rendered.findByText('isFetching: 0')
})
})

it('should use provided custom queryClient', async () => {
Expand All @@ -209,7 +243,7 @@ describe('useIsFetching', () => {
{
queryKey: key,
queryFn: async () => {
await sleep(10)
await vi.advanceTimersByTimeAsync(10)
return 'test'
},
},
Expand All @@ -227,6 +261,8 @@ describe('useIsFetching', () => {

const rendered = render(<Page></Page>)

await waitFor(() => rendered.getByText('isFetching: 1'))
await vi.waitFor(() => {
rendered.getByText('isFetching: 1')
})
})
})
Loading