fix: adapt useMutationWithToast to react-query v5 callback signatures
This commit is contained in:
@@ -21,47 +21,49 @@ describe('useMutationWithToast', () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('shows success notification on success with successMessage', async () => {
|
it('shows success notification on success with successMessage', async () => {
|
||||||
const mutationFn = vi.fn().mockResolvedValue({ ok: true })
|
const mutationFn = (): Promise<{ ok: boolean }> => Promise.resolve({ ok: true })
|
||||||
const { result } = renderHook(() => useMutationWithToast({ mutationFn, successMessage: 'Done!' }), {
|
const { result } = renderHook(() => useMutationWithToast({ mutationFn, successMessage: 'Done!' }), {
|
||||||
wrapper: createWrapper(),
|
wrapper: createWrapper(),
|
||||||
})
|
})
|
||||||
result.current.mutate()
|
;(result.current.mutate as () => void)()
|
||||||
await waitFor(() => expect(result.current.isSuccess).toBe(true))
|
await waitFor(() => expect(result.current.isSuccess).toBe(true))
|
||||||
expect(addNotification).toHaveBeenCalledWith({ type: 'success', message: 'Done!' })
|
expect(addNotification).toHaveBeenCalledWith({ type: 'success', message: 'Done!' })
|
||||||
})
|
})
|
||||||
|
|
||||||
it('does NOT show success notification without successMessage', async () => {
|
it('does NOT show success notification without successMessage', async () => {
|
||||||
const mutationFn = vi.fn().mockResolvedValue({ ok: true })
|
const mutationFn = (): Promise<{ ok: boolean }> => Promise.resolve({ ok: true })
|
||||||
const { result } = renderHook(() => useMutationWithToast({ mutationFn }), { wrapper: createWrapper() })
|
const { result } = renderHook(() => useMutationWithToast({ mutationFn }), { wrapper: createWrapper() })
|
||||||
result.current.mutate()
|
;(result.current.mutate as () => void)()
|
||||||
await waitFor(() => expect(result.current.isSuccess).toBe(true))
|
await waitFor(() => expect(result.current.isSuccess).toBe(true))
|
||||||
expect(addNotification).not.toHaveBeenCalled()
|
expect(addNotification).not.toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('shows error notification on mutation error', async () => {
|
it('shows error notification on mutation error', async () => {
|
||||||
const mutationFn = vi.fn().mockRejectedValue(new Error('Boom'))
|
const err = new Error('Boom')
|
||||||
|
const mutationFn = (): Promise<never> => Promise.reject(err)
|
||||||
const { result } = renderHook(() => useMutationWithToast({ mutationFn }), { wrapper: createWrapper() })
|
const { result } = renderHook(() => useMutationWithToast({ mutationFn }), { wrapper: createWrapper() })
|
||||||
result.current.mutate()
|
;(result.current.mutate as () => void)()
|
||||||
await waitFor(() => expect(result.current.isError).toBe(true))
|
await waitFor(() => expect(result.current.isError).toBe(true))
|
||||||
expect(addNotification).toHaveBeenCalledWith({ type: 'error', message: 'Boom' })
|
expect(addNotification).toHaveBeenCalledWith({ type: 'error', message: 'Boom' })
|
||||||
})
|
})
|
||||||
|
|
||||||
it('calls user-provided onSuccess callback', async () => {
|
it('calls user-provided onSuccess callback', async () => {
|
||||||
const onSuccess = vi.fn()
|
const onSuccess: (data: { ok: boolean }, variables: void, onMutateResult: unknown, mutationContext: unknown) => void = vi.fn()
|
||||||
const mutationFn = vi.fn().mockResolvedValue({ ok: true })
|
const mutationFn = (): Promise<{ ok: boolean }> => Promise.resolve({ ok: true })
|
||||||
const { result } = renderHook(() => useMutationWithToast({ mutationFn, onSuccess, successMessage: 'OK' }), {
|
const { result } = renderHook(() => useMutationWithToast({ mutationFn, onSuccess, successMessage: 'OK' }), {
|
||||||
wrapper: createWrapper(),
|
wrapper: createWrapper(),
|
||||||
})
|
})
|
||||||
result.current.mutate()
|
;(result.current.mutate as () => void)()
|
||||||
await waitFor(() => expect(result.current.isSuccess).toBe(true))
|
await waitFor(() => expect(result.current.isSuccess).toBe(true))
|
||||||
expect(onSuccess).toHaveBeenCalled()
|
expect(onSuccess).toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('calls user-provided onError callback', async () => {
|
it('calls user-provided onError callback', async () => {
|
||||||
const onError = vi.fn()
|
const onError: (error: Error, variables: void, onMutateResult: unknown, mutationContext: unknown) => void = vi.fn()
|
||||||
const mutationFn = vi.fn().mockRejectedValue(new Error('fail'))
|
const err = new Error('fail')
|
||||||
|
const mutationFn = (): Promise<never> => Promise.reject(err)
|
||||||
const { result } = renderHook(() => useMutationWithToast({ mutationFn, onError }), { wrapper: createWrapper() })
|
const { result } = renderHook(() => useMutationWithToast({ mutationFn, onError }), { wrapper: createWrapper() })
|
||||||
result.current.mutate()
|
;(result.current.mutate as () => void)()
|
||||||
await waitFor(() => expect(result.current.isError).toBe(true))
|
await waitFor(() => expect(result.current.isError).toBe(true))
|
||||||
expect(onError).toHaveBeenCalled()
|
expect(onError).toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,32 +1,32 @@
|
|||||||
import { useMutation, type UseMutationOptions } from '@tanstack/react-query'
|
import { useMutation, type MutationFunctionContext, type UseMutationOptions } from '@tanstack/react-query'
|
||||||
import { addNotification } from '../model/notification'
|
import { addNotification } from '../model/notification'
|
||||||
import { getApiErrorMessage } from './get-api-error-message'
|
import { getApiErrorMessage } from './get-api-error-message'
|
||||||
|
|
||||||
type MutationWithToastOptions<TData, TError, TVariables, TContext> = UseMutationOptions<
|
type MutationWithToastOptions<TData, TError, TVariables, TOnMutateResult> = UseMutationOptions<
|
||||||
TData,
|
TData,
|
||||||
TError,
|
TError,
|
||||||
TVariables,
|
TVariables,
|
||||||
TContext
|
TOnMutateResult
|
||||||
> & {
|
> & {
|
||||||
successMessage?: string
|
successMessage?: string
|
||||||
}
|
}
|
||||||
|
|
||||||
export function useMutationWithToast<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(
|
export function useMutationWithToast<TData = unknown, TError = unknown, TVariables = void, TOnMutateResult = unknown>(
|
||||||
options: MutationWithToastOptions<TData, TError, TVariables, TContext>,
|
options: MutationWithToastOptions<TData, TError, TVariables, TOnMutateResult>,
|
||||||
) {
|
) {
|
||||||
const { successMessage, onSuccess, onError, ...mutationOptions } = options
|
const { successMessage, onSuccess, onError, ...mutationOptions } = options
|
||||||
|
|
||||||
return useMutation({
|
return useMutation({
|
||||||
...mutationOptions,
|
...mutationOptions,
|
||||||
onSuccess: (data, variables, context) => {
|
onSuccess: (data: TData, variables: TVariables, onMutateResult: TOnMutateResult, mutationContext: MutationFunctionContext) => {
|
||||||
if (successMessage) {
|
if (successMessage) {
|
||||||
addNotification({ type: 'success', message: successMessage })
|
addNotification({ type: 'success', message: successMessage })
|
||||||
}
|
}
|
||||||
onSuccess?.(data, variables, context)
|
onSuccess?.(data, variables, onMutateResult, mutationContext)
|
||||||
},
|
},
|
||||||
onError: (error, variables, context) => {
|
onError: (error: TError, variables: TVariables, onMutateResult: TOnMutateResult | undefined, mutationContext: MutationFunctionContext) => {
|
||||||
addNotification({ type: 'error', message: getApiErrorMessage(error) })
|
addNotification({ type: 'error', message: getApiErrorMessage(error) })
|
||||||
onError?.(error, variables, context)
|
onError?.(error, variables, onMutateResult, mutationContext)
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user