Skip to content

test(react-query/mutationOptions): switch to fake timers, remove 'vi.waitFor', and add 'advanceTimersByTimeAsync' #9397

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 11, 2025
Merged

test(react-query/mutationOptions): switch to fake timers, remove 'vi.waitFor', and add 'advanceTimersByTimeAsync' #9397

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1b4d3d
test(react-query/mutationOptions): switch to fake timers, remove 'vi.…
sukvvon Jul 9, 2025
755ec55
Merge branch 'main' into test/react-query-mutationOptions-add-advance…
manudeli Jul 11, 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
39 changes: 24 additions & 15 deletions packages/react-query/src/__tests__/mutationOptions.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expect, it, vi } from 'vitest'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { QueryClient } from '@tanstack/query-core'
import { sleep } from '@tanstack/query-test-utils'
import { fireEvent } from '@testing-library/react'
Expand All @@ -8,6 +8,14 @@ import { renderWithClient } from './utils'
import type { MutationState } from '@tanstack/query-core'

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

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

it('should return the object received as a parameter without any modification.', () => {
const object = {
mutationKey: ['key'],
Expand Down Expand Up @@ -54,12 +62,12 @@ describe('mutationOptions', () => {
const rendered = renderWithClient(queryClient, <Page />)
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await vi.waitFor(() => expect(isMutatingArray[0]).toEqual(0))
await vi.waitFor(() => expect(isMutatingArray[1]).toEqual(1))
await vi.waitFor(() => expect(isMutatingArray[2]).toEqual(0))
await vi.waitFor(() =>
expect(isMutatingArray[isMutatingArray.length - 1]).toEqual(0),
)
expect(isMutatingArray[0]).toEqual(0)
await vi.advanceTimersByTimeAsync(0)
expect(isMutatingArray[1]).toEqual(1)
await vi.advanceTimersByTimeAsync(51)
expect(isMutatingArray[2]).toEqual(0)
expect(isMutatingArray[isMutatingArray.length - 1]).toEqual(0)
})

it('should return the number of fetching mutations when used with queryClient.isMutating', async () => {
Expand All @@ -86,12 +94,12 @@ describe('mutationOptions', () => {
const rendered = renderWithClient(queryClient, <Mutation />)
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await vi.waitFor(() => expect(isMutatingArray[0]).toEqual(0))
await vi.waitFor(() => expect(isMutatingArray[1]).toEqual(1))
await vi.waitFor(() => expect(isMutatingArray[2]).toEqual(0))
await vi.waitFor(() =>
expect(isMutatingArray[isMutatingArray.length - 1]).toEqual(0),
)
expect(isMutatingArray[0]).toEqual(0)
await vi.advanceTimersByTimeAsync(0)
expect(isMutatingArray[1]).toEqual(1)
await vi.advanceTimersByTimeAsync(501)
expect(isMutatingArray[2]).toEqual(0)
expect(isMutatingArray[isMutatingArray.length - 1]).toEqual(0)
})

it('should return the number of fetching mutations when used with useMutationState', async () => {
Expand Down Expand Up @@ -122,7 +130,8 @@ describe('mutationOptions', () => {
const rendered = renderWithClient(queryClient, <Mutation />)
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await vi.waitFor(() => expect(mutationStateArray.length).toEqual(1))
await vi.waitFor(() => expect(mutationStateArray[0]?.data).toEqual('data'))
await vi.advanceTimersByTimeAsync(0)
expect(mutationStateArray.length).toEqual(1)
expect(mutationStateArray[0]?.data).toEqual('data')
})
})
Loading