Spaces:
Running
Running
File size: 12,539 Bytes
c2b7eb3 | 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 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 | import { trackForMutations } from '@internal/immutableStateInvariantMiddleware'
import { noop } from '@internal/listenerMiddleware/utils'
import type {
ImmutableStateInvariantMiddlewareOptions,
Middleware,
MiddlewareAPI,
Store,
} from '@reduxjs/toolkit'
import {
createImmutableStateInvariantMiddleware,
isImmutableDefault,
} from '@reduxjs/toolkit'
type MWNext = Parameters<ReturnType<Middleware>>[0]
describe('createImmutableStateInvariantMiddleware', () => {
let state: { foo: { bar: number[]; baz: string } }
const getState: Store['getState'] = () => state
function middleware(options: ImmutableStateInvariantMiddlewareOptions = {}) {
return createImmutableStateInvariantMiddleware(options)({
getState,
} as MiddlewareAPI)
}
beforeEach(() => {
state = { foo: { bar: [2, 3, 4], baz: 'baz' } }
})
it('sends the action through the middleware chain', () => {
const next: MWNext = vi.fn()
const dispatch = middleware()(next)
dispatch({ type: 'SOME_ACTION' })
expect(next).toHaveBeenCalledWith({
type: 'SOME_ACTION',
})
})
it('throws if mutating inside the dispatch', () => {
const next: MWNext = (action) => {
state.foo.bar.push(5)
return action
}
const dispatch = middleware()(next)
expect(() => {
dispatch({ type: 'SOME_ACTION' })
}).toThrow(new RegExp('foo\\.bar\\.3'))
})
it('throws if mutating between dispatches', () => {
const next: MWNext = (action) => action
const dispatch = middleware()(next)
dispatch({ type: 'SOME_ACTION' })
state.foo.bar.push(5)
expect(() => {
dispatch({ type: 'SOME_OTHER_ACTION' })
}).toThrow(new RegExp('foo\\.bar\\.3'))
})
it('does not throw if not mutating inside the dispatch', () => {
const next: MWNext = (action) => {
state = { ...state, foo: { ...state.foo, baz: 'changed!' } }
return action
}
const dispatch = middleware()(next)
expect(() => {
dispatch({ type: 'SOME_ACTION' })
}).not.toThrow()
})
it('does not throw if not mutating between dispatches', () => {
const next: MWNext = (action) => action
const dispatch = middleware()(next)
dispatch({ type: 'SOME_ACTION' })
state = { ...state, foo: { ...state.foo, baz: 'changed!' } }
expect(() => {
dispatch({ type: 'SOME_OTHER_ACTION' })
}).not.toThrow()
})
it('works correctly with circular references', () => {
const next: MWNext = (action) => action
const dispatch = middleware()(next)
let x: any = {}
let y: any = {}
x.y = y
y.x = x
expect(() => {
dispatch({ type: 'SOME_ACTION', x })
}).not.toThrow()
})
it('respects "isImmutable" option', function () {
const isImmutable = (value: any) => true
const next: MWNext = (action) => {
state.foo.bar.push(5)
return action
}
const dispatch = middleware({ isImmutable })(next)
expect(() => {
dispatch({ type: 'SOME_ACTION' })
}).not.toThrow()
})
it('respects "ignoredPaths" option', () => {
const next: MWNext = (action) => {
state.foo.bar.push(5)
return action
}
const dispatch1 = middleware({ ignoredPaths: ['foo.bar'] })(next)
expect(() => {
dispatch1({ type: 'SOME_ACTION' })
}).not.toThrow()
const dispatch2 = middleware({ ignoredPaths: [/^foo/] })(next)
expect(() => {
dispatch2({ type: 'SOME_ACTION' })
}).not.toThrow()
})
it('Should print a warning if execution takes too long', () => {
state.foo.bar = new Array(10000).fill({ value: 'more' })
const next: MWNext = (action) => action
const dispatch = middleware({ warnAfter: 4 })(next)
const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(noop)
try {
dispatch({ type: 'SOME_ACTION' })
expect(consoleWarnSpy).toHaveBeenCalledOnce()
expect(consoleWarnSpy).toHaveBeenLastCalledWith(
expect.stringMatching(
/^ImmutableStateInvariantMiddleware took \d*ms, which is more than the warning threshold of 4ms./,
),
)
} finally {
consoleWarnSpy.mockRestore()
}
})
it('Should not print a warning if "next" takes too long', () => {
const next: MWNext = (action) => {
const started = Date.now()
while (Date.now() - started < 8) {}
return action
}
const dispatch = middleware({ warnAfter: 4 })(next)
const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(noop)
try {
dispatch({ type: 'SOME_ACTION' })
expect(consoleWarnSpy).not.toHaveBeenCalled()
} finally {
consoleWarnSpy.mockRestore()
}
})
})
describe('trackForMutations', () => {
function testCasesForMutation(spec: any) {
it('returns true and the mutated path', () => {
const state = spec.getState()
const options = spec.middlewareOptions || {}
const { isImmutable = isImmutableDefault, ignoredPaths } = options
const tracker = trackForMutations(isImmutable, ignoredPaths, state)
const newState = spec.fn(state)
expect(tracker.detectMutations()).toEqual({
wasMutated: true,
path: spec.path.join('.'),
})
})
}
function testCasesForNonMutation(spec: any) {
it('returns false', () => {
const state = spec.getState()
const options = spec.middlewareOptions || {}
const { isImmutable = isImmutableDefault, ignoredPaths } = options
const tracker = trackForMutations(isImmutable, ignoredPaths, state)
const newState = spec.fn(state)
expect(tracker.detectMutations()).toEqual({ wasMutated: false })
})
}
interface TestConfig {
getState: Store['getState']
fn: (s: any) => typeof s | object
middlewareOptions?: ImmutableStateInvariantMiddlewareOptions
path?: string[]
}
const mutations: Record<string, TestConfig> = {
'adding to nested array': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
s.foo.bar.push(5)
return s
},
path: ['foo', 'bar', '3'],
},
'adding to nested array and setting new root object': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
s.foo.bar.push(5)
return { ...s }
},
path: ['foo', 'bar', '3'],
},
'changing nested string': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
s.foo.baz = 'changed!'
return s
},
path: ['foo', 'baz'],
},
'removing nested state': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
delete s.foo
return s
},
path: ['foo'],
},
'adding to array': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
s.stuff.push(1)
return s
},
path: ['stuff', '0'],
},
'adding object to array': {
getState: () => ({
stuff: [],
}),
fn: (s) => {
s.stuff.push({ foo: 1, bar: 2 })
return s
},
path: ['stuff', '0'],
},
'mutating previous state and returning new state': {
getState: () => ({ counter: 0 }),
fn: (s) => {
s.mutation = true
return { ...s, counter: s.counter + 1 }
},
path: ['mutation'],
},
'mutating previous state with non immutable type and returning new state': {
getState: () => ({ counter: 0 }),
fn: (s) => {
s.mutation = [1, 2, 3]
return { ...s, counter: s.counter + 1 }
},
path: ['mutation'],
},
'mutating previous state with non immutable type and returning new state without that property':
{
getState: () => ({ counter: 0 }),
fn: (s) => {
s.mutation = [1, 2, 3]
return { counter: s.counter + 1 }
},
path: ['mutation'],
},
'mutating previous state with non immutable type and returning new simple state':
{
getState: () => ({ counter: 0 }),
fn: (s) => {
s.mutation = [1, 2, 3]
return 1
},
path: ['mutation'],
},
'mutating previous state by deleting property and returning new state without that property':
{
getState: () => ({ counter: 0, toBeDeleted: true }),
fn: (s) => {
delete s.toBeDeleted
return { counter: s.counter + 1 }
},
path: ['toBeDeleted'],
},
'mutating previous state by deleting nested property': {
getState: () => ({ nested: { counter: 0, toBeDeleted: true }, foo: 1 }),
fn: (s) => {
delete s.nested.toBeDeleted
return { nested: { counter: s.counter + 1 } }
},
path: ['nested', 'toBeDeleted'],
},
'update reference': {
getState: () => ({ foo: {} }),
fn: (s) => {
s.foo = {}
return s
},
path: ['foo'],
},
'cannot ignore root state': {
getState: () => ({ foo: {} }),
fn: (s) => {
s.foo = {}
return s
},
middlewareOptions: {
ignoredPaths: [''],
},
path: ['foo'],
},
'catching state mutation in non-ignored branch': {
getState: () => ({
foo: {
bar: [1, 2],
},
boo: {
yah: [1, 2],
},
}),
fn: (s) => {
s.foo.bar.push(3)
s.boo.yah.push(3)
return s
},
middlewareOptions: {
ignoredPaths: ['foo'],
},
path: ['boo', 'yah', '2'],
},
}
Object.keys(mutations).forEach((mutationDesc) => {
describe(mutationDesc, () => {
testCasesForMutation(mutations[mutationDesc])
})
})
const nonMutations: Record<string, TestConfig> = {
'not doing anything': {
getState: () => ({ a: 1, b: 2 }),
fn: (s) => s,
},
'from undefined to something': {
getState: () => undefined,
fn: (s) => ({ foo: 'bar' }),
},
'returning same state': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => s,
},
'returning a new state object with nested new string': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
return { ...s, foo: { ...s.foo, baz: 'changed!' } }
},
},
'returning a new state object with nested new array': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
return { ...s, foo: { ...s.foo, bar: [...s.foo.bar, 5] } }
},
},
'removing nested state': {
getState: () => ({
foo: {
bar: [2, 3, 4],
baz: 'baz',
},
stuff: [],
}),
fn: (s) => {
return { ...s, foo: {} }
},
},
'having a NaN in the state': {
getState: () => ({ a: NaN, b: Number.NaN }),
fn: (s) => s,
},
'ignoring branches from mutation detection': {
getState: () => ({
foo: {
bar: 'bar',
},
}),
fn: (s) => {
s.foo.bar = 'baz'
return s
},
middlewareOptions: {
ignoredPaths: ['foo'],
},
},
'ignoring nested branches from mutation detection': {
getState: () => ({
foo: {
bar: [1, 2],
boo: {
yah: [1, 2],
},
},
}),
fn: (s) => {
s.foo.bar.push(3)
s.foo.boo.yah.push(3)
return s
},
middlewareOptions: {
ignoredPaths: ['foo.bar', 'foo.boo.yah'],
},
},
'ignoring nested array indices from mutation detection': {
getState: () => ({
stuff: [{ a: 1 }, { a: 2 }],
}),
fn: (s) => {
s.stuff[1].a = 3
return s
},
middlewareOptions: {
ignoredPaths: ['stuff.1'],
},
},
}
Object.keys(nonMutations).forEach((nonMutationDesc) => {
describe(nonMutationDesc, () => {
testCasesForNonMutation(nonMutations[nonMutationDesc])
})
})
})
|