Skip to content

test(lit-query/createMutationController): add tests for calling 'mutate' and 'mutateAsync' callbacks when the controller has no callbacks #11760

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
sukvvon merged 2 commits into from
Sep 30, 2026
Merged

test(lit-query/createMutationController): add tests for calling 'mutate' and 'mutateAsync' callbacks when the controller has no callbacks #11760

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85138a7
test(lit-query/createMutationController): add tests for calling 'muta…
sukvvon Sep 30, 2026
ff2defd
Merge branch 'main' into test/lit-query-create-mutation-controller-no…
sukvvon Sep 30, 2026
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
283 changes: 282 additions & 1 deletion packages/lit-query/src/__tests__/createMutationController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { QueryClient } from '@tanstack/query-core'
import { QueryClient, noop } from '@tanstack/query-core'
import { queryKey, sleep } from '@tanstack/query-test-utils'
import { LitElement, html } from 'lit'
import { QueryClientProvider } from '../QueryClientProvider.js'
Expand Down Expand Up @@ -222,6 +222,287 @@ describe('createMutationController', () => {
expect(mutation().data).toBeUndefined()
})

it('should call mutate callbacks when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (text: string) => sleep(10).then(() => text),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutate('todo', {
onSuccess: () => {
callbacks.push('mutate.onSuccess')
},
onSettled: () => {
callbacks.push('mutate.onSettled')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutate.onSuccess', 'mutate.onSettled'])
})

it('should call mutateAsync callbacks when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (text: string) => sleep(10).then(() => text),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutateAsync('todo', {
onSuccess: () => {
callbacks.push('mutateAsync.onSuccess')
},
onSettled: () => {
callbacks.push('mutateAsync.onSettled')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual([
'mutateAsync.onSuccess',
'mutateAsync.onSettled',
])
})

it('should call mutate error callbacks when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (_text: string) =>
sleep(10).then(() => {
throw new Error('oops')
}),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutate('todo', {
onError: () => {
callbacks.push('mutate.onError')
},
onSettled: () => {
callbacks.push('mutate.onSettled')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutate.onError', 'mutate.onSettled'])
})

it('should call mutateAsync error callbacks when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (_text: string) =>
sleep(10).then(() => {
throw new Error('oops')
}),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation
.mutateAsync('todo', {
onError: () => {
callbacks.push('mutateAsync.onError')
},
onSettled: () => {
callbacks.push('mutateAsync.onSettled')
},
})
.catch(noop)
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutateAsync.onError', 'mutateAsync.onSettled'])
})

it('should call only mutate onSuccess when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (text: string) => sleep(10).then(() => text),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutate('todo', {
onSuccess: () => {
callbacks.push('mutate.onSuccess')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutate.onSuccess'])
})

it('should call only mutate onError when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (_text: string) =>
sleep(10).then(() => {
throw new Error('oops')
}),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutate('todo', {
onError: () => {
callbacks.push('mutate.onError')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutate.onError'])
})

it('should call only mutate onSettled when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (text: string) => sleep(10).then(() => text),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutate('todo', {
onSettled: () => {
callbacks.push('mutate.onSettled')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutate.onSettled'])
})

it('should call only mutateAsync onSuccess when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (text: string) => sleep(10).then(() => text),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutateAsync('todo', {
onSuccess: () => {
callbacks.push('mutateAsync.onSuccess')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutateAsync.onSuccess'])
})

it('should call only mutateAsync onError when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (_text: string) =>
sleep(10).then(() => {
throw new Error('oops')
}),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation
.mutateAsync('todo', {
onError: () => {
callbacks.push('mutateAsync.onError')
},
})
.catch(noop)
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutateAsync.onError'])
})

it('should call only mutateAsync onSettled when createMutationController has no callbacks', async () => {
const callbacks: Array<string> = []

class Host extends LitElement {
readonly mutation = createMutationController(
this,
{
mutationFn: (text: string) => sleep(10).then(() => text),
},
queryClient,
)
}
customElements.define(generateElementName(), Host)
const host = new Host()
container.append(host)

host.mutation.mutateAsync('todo', {
onSettled: () => {
callbacks.push('mutateAsync.onSettled')
},
})
await vi.advanceTimersByTimeAsync(10)
expect(callbacks).toEqual(['mutateAsync.onSettled'])
})

it('should not throw from mutate while mutateAsync rejects on error', async () => {
class Host extends LitElement {
readonly mutation = createMutationController(
Expand Down
Loading