import { Component, Injector, input, provideZonelessChangeDetection, signal, } from '@angular/core' import { TestBed } from '@angular/core/testing' import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest' import { By } from '@angular/platform-browser' import { sleep } from '@tanstack/query-test-utils' import { QueryClient, injectMutation, provideTanStackQuery } from '..' import { expectSignals, setFixtureSignalInputs } from './test-utils' describe('injectMutation', () => { let queryClient: QueryClient beforeEach(() => { queryClient = new QueryClient() vi.useFakeTimers() TestBed.configureTestingModule({ providers: [ provideZonelessChangeDetection(), provideTanStackQuery(queryClient), ], }) }) afterEach(() => { vi.useRealTimers() }) test('should be in idle state initially', () => { const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params) => sleep(0).then(() => params), })) }) expectSignals(mutation, { isIdle: true, isPending: false, isError: false, isSuccess: false, }) }) test('should change state after invoking mutate', async () => { const result = 'Mock data' const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), })) }) TestBed.tick() mutation.mutate(result) await vi.advanceTimersByTimeAsync(0) expectSignals(mutation, { isIdle: false, isPending: true, isError: false, isSuccess: false, data: undefined, error: null, }) }) test('should return error when request fails', async () => { const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: () => sleep(10).then(() => Promise.reject(new Error('Some error'))), })) }) mutation.mutate() await vi.advanceTimersByTimeAsync(11) expectSignals(mutation, { isIdle: false, isPending: false, isError: true, isSuccess: false, data: undefined, error: Error('Some error'), }) }) test('should return data when request succeeds', async () => { const result = 'Mock data' const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), })) }) mutation.mutate(result) await vi.advanceTimersByTimeAsync(11) expectSignals(mutation, { isIdle: false, isPending: false, isError: false, isSuccess: true, data: result, error: null, }) }) test('reactive options should update mutation', () => { const mutationCache = queryClient.getMutationCache() // Signal will be updated before the mutation is called // this test confirms that the mutation uses the updated value const mutationKey = signal(['1']) const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationKey: mutationKey(), mutationFn: (params: string) => sleep(0).then(() => params), })) }) mutationKey.set(['2']) mutation.mutate('xyz') const mutations = mutationCache.find({ mutationKey: ['2'] }) expect(mutations?.options.mutationKey).toEqual(['2']) }) test('should reset state after invoking mutation.reset', async () => { const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: () => sleep(10).then(() => Promise.reject(new Error('Some error'))), })) }) mutation.mutate() await vi.advanceTimersByTimeAsync(11) expect(mutation.isError()).toBe(true) mutation.reset() await vi.advanceTimersByTimeAsync(0) expectSignals(mutation, { isIdle: true, isPending: false, isError: false, isSuccess: false, data: undefined, error: null, }) }) describe('side effects', () => { beforeEach(() => { vi.clearAllMocks() }) test('should call onMutate when passed as an option', async () => { const onMutate = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), onMutate, })) }) mutation.mutate('') await vi.advanceTimersByTimeAsync(0) expect(onMutate).toHaveBeenCalledTimes(1) }) test('should call onError when passed as an option', async () => { const onError = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (_params: string) => sleep(10).then(() => Promise.reject(new Error('Some error'))), onError, })) }) mutation.mutate('') await vi.advanceTimersByTimeAsync(11) expect(onError).toHaveBeenCalledTimes(1) }) test('should call onSuccess when passed as an option', async () => { const onSuccess = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), onSuccess, })) }) mutation.mutate('') await vi.advanceTimersByTimeAsync(11) expect(onSuccess).toHaveBeenCalledTimes(1) }) test('should call onSettled when passed as an option', async () => { const onSettled = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), onSettled, })) }) mutation.mutate('') await vi.advanceTimersByTimeAsync(11) expect(onSettled).toHaveBeenCalledTimes(1) }) test('should call onError when passed as an argument of mutate function', async () => { const onError = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (_params: string) => sleep(10).then(() => Promise.reject(new Error('Some error'))), })) }) mutation.mutate('', { onError }) await vi.advanceTimersByTimeAsync(11) expect(onError).toHaveBeenCalledTimes(1) }) test('should call onSuccess when passed as an argument of mutate function', async () => { const onSuccess = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), })) }) mutation.mutate('', { onSuccess }) await vi.advanceTimersByTimeAsync(11) expect(onSuccess).toHaveBeenCalledTimes(1) }) test('should call onSettled when passed as an argument of mutate function', async () => { const onSettled = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), })) }) mutation.mutate('', { onSettled }) await vi.advanceTimersByTimeAsync(11) expect(onSettled).toHaveBeenCalledTimes(1) }) test('should fire both onSettled functions', async () => { const onSettled = vi.fn() const onSettledOnFunction = vi.fn() const mutation = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationFn: (params: string) => sleep(10).then(() => params), onSettled, })) }) mutation.mutate('', { onSettled: onSettledOnFunction }) await vi.advanceTimersByTimeAsync(11) expect(onSettled).toHaveBeenCalledTimes(1) expect(onSettledOnFunction).toHaveBeenCalledTimes(1) }) }) test('should support required signal inputs', async () => { const mutationCache = queryClient.getMutationCache() @Component({ selector: 'app-fake', template: ` {{ mutation.data() }} `, standalone: true, }) class FakeComponent { name = input.required() mutation = injectMutation(() => ({ mutationKey: ['fake', this.name()], mutationFn: () => sleep(10).then(() => this.name()), })) mutate(): void { this.mutation.mutate() } } const fixture = TestBed.createComponent(FakeComponent) const { debugElement } = fixture setFixtureSignalInputs(fixture, { name: 'value' }) const button = debugElement.query(By.css('button')) button.triggerEventHandler('click') await vi.advanceTimersByTimeAsync(11) fixture.detectChanges() const text = debugElement.query(By.css('span')).nativeElement.textContent expect(text).toEqual('value') const mutation = mutationCache.find({ mutationKey: ['fake', 'value'] }) expect(mutation).toBeDefined() expect(mutation!.options.mutationKey).toStrictEqual(['fake', 'value']) }) test('should update options on required signal input change', async () => { const mutationCache = queryClient.getMutationCache() @Component({ selector: 'app-fake', template: ` {{ mutation.data() }} `, standalone: true, }) class FakeComponent { name = input.required() mutation = injectMutation(() => ({ mutationKey: ['fake', this.name()], mutationFn: () => sleep(10).then(() => this.name()), })) mutate(): void { this.mutation.mutate() } } const fixture = TestBed.createComponent(FakeComponent) const { debugElement } = fixture setFixtureSignalInputs(fixture, { name: 'value' }) const button = debugElement.query(By.css('button')) const span = debugElement.query(By.css('span')) button.triggerEventHandler('click') await vi.advanceTimersByTimeAsync(11) fixture.detectChanges() expect(span.nativeElement.textContent).toEqual('value') setFixtureSignalInputs(fixture, { name: 'updatedValue' }) button.triggerEventHandler('click') await vi.advanceTimersByTimeAsync(11) fixture.detectChanges() expect(span.nativeElement.textContent).toEqual('updatedValue') const mutations = mutationCache.findAll() expect(mutations.length).toBe(2) const [mutation1, mutation2] = mutations expect(mutation1!.options.mutationKey).toEqual(['fake', 'value']) expect(mutation2!.options.mutationKey).toEqual(['fake', 'updatedValue']) }) describe('throwOnError', () => { test('should evaluate throwOnError when mutation is expected to throw', async () => { const err = new Error('Expected mock error. All is well!') const boundaryFn = vi.fn() const { mutate } = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationKey: ['fake'], mutationFn: () => { return Promise.reject(err) }, throwOnError: boundaryFn, })) }) TestBed.tick() mutate() await vi.advanceTimersByTimeAsync(0) expect(boundaryFn).toHaveBeenCalledTimes(1) expect(boundaryFn).toHaveBeenCalledWith(err) }) }) test('should throw when throwOnError is true', async () => { const err = new Error('Expected mock error. All is well!') const { mutateAsync } = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationKey: ['fake'], mutationFn: () => { return Promise.reject(err) }, throwOnError: true, })) }) await expect(() => mutateAsync()).rejects.toThrowError(err) }) test('should throw when throwOnError function returns true', async () => { const err = new Error('Expected mock error. All is well!') const { mutateAsync } = TestBed.runInInjectionContext(() => { return injectMutation(() => ({ mutationKey: ['fake'], mutationFn: () => { return Promise.reject(err) }, throwOnError: () => true, })) }) await expect(() => mutateAsync()).rejects.toThrowError(err) }) describe('injection context', () => { test('throws NG0203 with descriptive error outside injection context', () => { expect(() => { injectMutation(() => ({ mutationKey: ['injectionContextError'], mutationFn: () => Promise.resolve(), })) }).toThrowError(/NG0203(.*?)injectMutation/) }) test('can be used outside injection context when passing an injector', () => { expect(() => { injectMutation( () => ({ mutationKey: ['injectionContextError'], mutationFn: () => Promise.resolve(), }), { injector: TestBed.inject(Injector), }, ) }).not.toThrow() }) }) })