File size: 13,189 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
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: `
<button (click)="mutate()"></button>
<span>{{ mutation.data() }}</span>
`,
standalone: true,
})
class FakeComponent {
name = input.required<string>()
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: `
<button (click)="mutate()"></button>
<span>{{ mutation.data() }}</span>
`,
standalone: true,
})
class FakeComponent {
name = input.required<string>()
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()
})
})
})
|