Skip to content

test(solid-query/useMutation): remove 'vi.waitFor', replace 'findByText' with 'getByText', and add 'advanceTimersByTimeAsync', 'expect' #9409

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(solid-query/useMutation): remove 'vi.waitFor', replace 'findByText' with 'getByText', and add 'advanceTimersByTimeAsync', 'expect' #9409

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee5f320
test(solid-query/useMutation): remove 'vi.waitFor', replace 'findByTe…
sukvvon Jul 11, 2025
96b8d43
Merge branch 'main' into test/solid-query-useMutation-add-advanceTime…
sukvvon 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
191 changes: 73 additions & 118 deletions packages/solid-query/src/__tests__/useMutation.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,10 @@ describe('useMutation', () => {
expect(rendered.getByRole('heading').textContent).toBe('empty')

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await vi.waitFor(() => {
expect(rendered.getByRole('heading').textContent).toBe('mutation')
})
await vi.advanceTimersByTimeAsync(0)
expect(rendered.getByRole('heading').textContent).toBe('mutation')

fireEvent.click(rendered.getByRole('button', { name: /reset/i }))

await vi.waitFor(() => {})
expect(rendered.getByRole('heading').textContent).toBe('empty')
})

Expand Down Expand Up @@ -97,18 +93,13 @@ describe('useMutation', () => {
expect(rendered.queryByRole('heading')).toBeNull()

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await vi.waitFor(() => {
expect(rendered.getByRole('heading').textContent).toBe(
'Expected mock error. All is well!',
)
})
await vi.advanceTimersByTimeAsync(0)
expect(rendered.getByRole('heading').textContent).toBe(
'Expected mock error. All is well!',
)

fireEvent.click(rendered.getByRole('button', { name: /reset/i }))

await vi.waitFor(() => {
expect(rendered.queryByRole('heading')).toBeNull()
})
expect(rendered.queryByRole('heading')).toBeNull()

consoleMock.mockRestore()
})
Expand Down Expand Up @@ -155,22 +146,16 @@ describe('useMutation', () => {
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
await vi.advanceTimersByTimeAsync(0)
expect(rendered.getByRole('heading').textContent).toBe('3')

await vi.waitFor(() => {
expect(rendered.getByRole('heading').textContent).toBe('3')
})

await vi.waitFor(() => {
expect(onSuccessMock).toHaveBeenCalledTimes(3)
})
expect(onSuccessMock).toHaveBeenCalledTimes(3)

expect(onSuccessMock).toHaveBeenCalledWith(1)
expect(onSuccessMock).toHaveBeenCalledWith(2)
expect(onSuccessMock).toHaveBeenCalledWith(3)

await vi.waitFor(() => {
expect(onSettledMock).toHaveBeenCalledTimes(3)
})
expect(onSettledMock).toHaveBeenCalledTimes(3)

expect(onSettledMock).toHaveBeenCalledWith(1)
expect(onSettledMock).toHaveBeenCalledWith(2)
Expand Down Expand Up @@ -222,34 +207,21 @@ describe('useMutation', () => {

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
expect(rendered.getByText('Data')).toBeInTheDocument()
await vi.waitFor(() =>
expect(rendered.getByText('Status error')).toBeInTheDocument(),
)
await vi.waitFor(() =>
expect(rendered.getByText('Failed 1 times')).toBeInTheDocument(),
)
await vi.waitFor(() =>
expect(
rendered.getByText('Failed because Error test Jonas'),
).toBeInTheDocument(),
)
await vi.advanceTimersByTimeAsync(0)
expect(rendered.getByText('Status error')).toBeInTheDocument()
expect(rendered.getByText('Failed 1 times')).toBeInTheDocument()
expect(
rendered.getByText('Failed because Error test Jonas'),
).toBeInTheDocument()

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
await vi.waitFor(() =>
expect(rendered.getByText('Status pending')).toBeInTheDocument(),
)
await vi.waitFor(() =>
expect(rendered.getByText('Status success')).toBeInTheDocument(),
)
await vi.waitFor(() =>
expect(rendered.getByText('Data 2')).toBeInTheDocument(),
)
await vi.waitFor(() =>
expect(rendered.getByText('Failed 0 times')).toBeInTheDocument(),
)
await vi.waitFor(() =>
expect(rendered.getByText('Failed because null')).toBeInTheDocument(),
)
await vi.advanceTimersByTimeAsync(0)
expect(rendered.getByText('Status pending')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(10)
expect(rendered.getByText('Status success')).toBeInTheDocument()
expect(rendered.getByText('Data 2')).toBeInTheDocument()
expect(rendered.getByText('Failed 0 times')).toBeInTheDocument()
expect(rendered.getByText('Failed because null')).toBeInTheDocument()
})

it('should be able to call `onError` and `onSettled` after each failed mutate', async () => {
Expand Down Expand Up @@ -300,14 +272,10 @@ describe('useMutation', () => {
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
await vi.advanceTimersByTimeAsync(0)
expect(rendered.getByRole('heading').textContent).toBe('3')

await vi.waitFor(() => {
expect(rendered.getByRole('heading').textContent).toBe('3')
})

await vi.waitFor(() => {
expect(onErrorMock).toHaveBeenCalledTimes(3)
})
expect(onErrorMock).toHaveBeenCalledTimes(3)
expect(onErrorMock).toHaveBeenCalledWith(
'Expected mock error. All is well! 1',
)
Expand All @@ -318,9 +286,7 @@ describe('useMutation', () => {
'Expected mock error. All is well! 3',
)

await vi.waitFor(() => {
expect(onSettledMock).toHaveBeenCalledTimes(3)
})
expect(onSettledMock).toHaveBeenCalledTimes(3)
expect(onSettledMock).toHaveBeenCalledWith(
'Expected mock error. All is well! 1',
)
Expand Down Expand Up @@ -604,13 +570,17 @@ describe('useMutation', () => {
</QueryClientProvider>
))

await rendered.findByText('data: null, status: idle, isPaused: false')
expect(
rendered.getByText('data: null, status: idle, isPaused: false'),
).toBeInTheDocument()

window.dispatchEvent(new Event('offline'))

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await rendered.findByText('data: null, status: pending, isPaused: true')
await vi.advanceTimersByTimeAsync(0)
expect(
rendered.getByText('data: null, status: pending, isPaused: true'),
).toBeInTheDocument()

expect(onMutate).toHaveBeenCalledTimes(1)
expect(onMutate).toHaveBeenCalledWith('todo')
Expand All @@ -619,7 +589,9 @@ describe('useMutation', () => {
window.dispatchEvent(new Event('online'))

await vi.advanceTimersByTimeAsync(10)
await rendered.findByText('data: 1, status: success, isPaused: false')
expect(
rendered.getByText('data: 1, status: success, isPaused: false'),
).toBeInTheDocument()

expect(onMutate).toHaveBeenCalledTimes(1)
expect(count).toBe(1)
Expand Down Expand Up @@ -660,11 +632,11 @@ describe('useMutation', () => {
</QueryClientProvider>
))

await rendered.findByText('data: null, status: idle, isPaused: false')

rendered.getByText('data: null, status: idle, isPaused: false')
fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await rendered.findByText('data: null, status: pending, isPaused: true')
expect(
rendered.getByText('data: null, status: pending, isPaused: true'),
).toBeInTheDocument()

// no intermediate 'pending, false' state is expected because we don't start mutating!
expect(states[0]).toBe('idle, false')
Expand All @@ -674,7 +646,9 @@ describe('useMutation', () => {
window.dispatchEvent(new Event('online'))

await vi.advanceTimersByTimeAsync(10)
await rendered.findByText('data: 1, status: success, isPaused: false')
expect(
rendered.getByText('data: 1, status: success, isPaused: false'),
).toBeInTheDocument()

onlineMock.mockRestore()
})
Expand Down Expand Up @@ -831,10 +805,8 @@ describe('useMutation', () => {
))

fireEvent.click(rendered.getByText('mutate'))

await vi.waitFor(() => {
expect(rendered.queryByText('error')).not.toBeNull()
})
await vi.advanceTimersByTimeAsync(0)
expect(rendered.queryByText('error')).not.toBeNull()

consoleMock.mockRestore()
})
Expand Down Expand Up @@ -882,15 +854,13 @@ describe('useMutation', () => {

// first error goes to component
fireEvent.click(rendered.getByText('mutate'))
await vi.waitFor(() => {
expect(rendered.queryByText('mock error')).not.toBeNull()
})
await vi.advanceTimersByTimeAsync(0)
expect(rendered.queryByText('mock error')).not.toBeNull()

// second error goes to boundary
fireEvent.click(rendered.getByText('mutate'))
await vi.waitFor(() => {
expect(rendered.queryByText('error boundary')).not.toBeNull()
})
await vi.advanceTimersByTimeAsync(0)
expect(rendered.queryByText('error boundary')).not.toBeNull()

consoleMock.mockRestore()
})
Expand Down Expand Up @@ -943,14 +913,13 @@ describe('useMutation', () => {

fireEvent.click(rendered.getByText('succeed'))
fireEvent.click(rendered.getByText('error'))

await vi.waitFor(() => {
expect(rendered.queryByText('successTest')).not.toBeNull()
expect(rendered.queryByText('errorTest')).not.toBeNull()
})
await vi.advanceTimersByTimeAsync(0)
expect(rendered.queryByText('successTest')).not.toBeNull()
expect(rendered.queryByText('errorTest')).not.toBeNull()

expect(successMock).toHaveBeenCalledTimes(1)
expect(successMock).toHaveBeenCalledWith(metaSuccessMessage)

expect(errorMock).toHaveBeenCalledTimes(1)
expect(errorMock).toHaveBeenCalledWith(metaErrorMessage)
})
Expand Down Expand Up @@ -1016,13 +985,10 @@ describe('useMutation', () => {

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))
fireEvent.click(rendered.getByRole('button', { name: /hide/i }))

await vi.waitFor(() => {
expect(
queryClient.getMutationCache().findAll({ mutationKey: mutationKey }),
).toHaveLength(0)
})

await vi.advanceTimersByTimeAsync(10)
expect(
queryClient.getMutationCache().findAll({ mutationKey: mutationKey }),
).toHaveLength(0)
expect(count).toBe(1)

expect(onSuccess).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -1166,20 +1132,14 @@ describe('useMutation', () => {
</QueryClientProvider>
))

await vi.waitFor(() =>
expect(
rendered.getByText('error: null, status: idle'),
).toBeInTheDocument(),
)
await vi.advanceTimersByTimeAsync(10)
expect(rendered.getByText('error: null, status: idle')).toBeInTheDocument()

rendered.getByRole('button', { name: /mutate/i }).click()

await vi.advanceTimersByTimeAsync(10)
await vi.waitFor(() =>
expect(
rendered.getByText('error: mutateFnError, status: error'),
).toBeInTheDocument(),
)
expect(
rendered.getByText('error: mutateFnError, status: error'),
).toBeInTheDocument()
})

it('should go to error state if onSettled callback errors', async () => {
Expand Down Expand Up @@ -1215,12 +1175,13 @@ describe('useMutation', () => {
</QueryClientProvider>
))

await rendered.findByText('error: null, status: idle')
expect(rendered.getByText('error: null, status: idle')).toBeInTheDocument()

rendered.getByRole('button', { name: /mutate/i }).click()

await vi.advanceTimersByTimeAsync(10)
await rendered.findByText('error: mutateFnError, status: error')
expect(
rendered.getByText('error: mutateFnError, status: error'),
).toBeInTheDocument()

expect(onError).toHaveBeenCalledWith(mutateFnError, 'todo', undefined)
})
Expand Down Expand Up @@ -1250,18 +1211,12 @@ describe('useMutation', () => {

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

await vi.waitFor(() =>
expect(
rendered.getByText('data: null, status: idle'),
).toBeInTheDocument(),
)
expect(rendered.getByText('data: null, status: idle')).toBeInTheDocument()

fireEvent.click(rendered.getByRole('button', { name: /mutate/i }))

await vi.waitFor(() =>
expect(
rendered.getByText('data: custom client, status: success'),
).toBeInTheDocument(),
)
await vi.advanceTimersByTimeAsync(0)
expect(
rendered.getByText('data: custom client, status: success'),
).toBeInTheDocument()
})
})
Loading