Spaces:
Running
Running
File size: 12,971 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 | import { createApi } from '@reduxjs/toolkit/query/react'
import {
act,
getByTestId,
render,
screen,
waitFor,
} from '@testing-library/react'
import { delay } from 'msw'
import { vi } from 'vitest'
import { setupApiStore } from '../../tests/utils/helpers'
describe('fixedCacheKey', () => {
const onNewCacheEntry = vi.fn()
const api = createApi({
async baseQuery(arg: string | Promise<string>) {
return { data: await arg }
},
endpoints: (build) => ({
send: build.mutation<string, string | Promise<string>>({
query: (arg) => arg,
}),
}),
})
const storeRef = setupApiStore(api)
function Component({
name,
fixedCacheKey,
value = name,
}: {
name: string
fixedCacheKey?: string
value?: string | Promise<string>
}) {
const [trigger, result] = api.endpoints.send.useMutation({ fixedCacheKey })
return (
<div data-testid={name}>
<div data-testid="status">{result.status}</div>
<div data-testid="data">{result.data}</div>
<div data-testid="originalArgs">{String(result.originalArgs)}</div>
<button data-testid="trigger" onClick={() => trigger(value)}>
trigger
</button>
<button data-testid="reset" onClick={result.reset}>
reset
</button>
</div>
)
}
test('two mutations without `fixedCacheKey` do not influence each other', async () => {
render(
<>
<Component name="C1" />
<Component name="C2" />
</>,
{ wrapper: storeRef.wrapper },
)
const c1 = screen.getByTestId('C1')
const c2 = screen.getByTestId('C2')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
act(() => {
getByTestId(c1, 'trigger').click()
})
await waitFor(() =>
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled'),
)
expect(getByTestId(c1, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
})
test('two mutations with the same `fixedCacheKey` do influence each other', async () => {
render(
<>
<Component name="C1" fixedCacheKey="test" />
<Component name="C2" fixedCacheKey="test" />
</>,
{ wrapper: storeRef.wrapper },
)
const c1 = screen.getByTestId('C1')
const c2 = screen.getByTestId('C2')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
act(() => {
getByTestId(c1, 'trigger').click()
})
await waitFor(() => {
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c1, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c2, 'data').textContent).toBe('C1')
})
// test reset from the other component
act(() => {
getByTestId(c2, 'reset').click()
})
await waitFor(() => {
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c1, 'data').textContent).toBe('')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'data').textContent).toBe('')
})
})
test('resetting from the component that triggered the mutation resets for each shared result', async () => {
render(
<>
<Component name="C1" fixedCacheKey="test-A" />
<Component name="C2" fixedCacheKey="test-A" />
<Component name="C3" fixedCacheKey="test-B" />
<Component name="C4" fixedCacheKey="test-B" />
</>,
{ wrapper: storeRef.wrapper },
)
const c1 = screen.getByTestId('C1')
const c2 = screen.getByTestId('C2')
const c3 = screen.getByTestId('C3')
const c4 = screen.getByTestId('C4')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c3, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c4, 'status').textContent).toBe('uninitialized')
// trigger with a component using the first cache key
act(() => {
getByTestId(c1, 'trigger').click()
})
await waitFor(() =>
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled'),
)
// the components with the first cache key should be affected
expect(getByTestId(c1, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c2, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('fulfilled')
// the components with the second cache key should be unaffected
expect(getByTestId(c3, 'data').textContent).toBe('')
expect(getByTestId(c3, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c4, 'data').textContent).toBe('')
expect(getByTestId(c4, 'status').textContent).toBe('uninitialized')
// trigger with a component using the second cache key
act(() => {
getByTestId(c3, 'trigger').click()
})
await waitFor(() =>
expect(getByTestId(c3, 'status').textContent).toBe('fulfilled'),
)
// the components with the first cache key should be unaffected
await waitFor(() => {
expect(getByTestId(c1, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c2, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('fulfilled')
// the component with the second cache key should be affected
expect(getByTestId(c3, 'data').textContent).toBe('C3')
expect(getByTestId(c3, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c4, 'data').textContent).toBe('C3')
expect(getByTestId(c4, 'status').textContent).toBe('fulfilled')
})
// test reset from the component that triggered the mutation for the first cache key
act(() => {
getByTestId(c1, 'reset').click()
})
await waitFor(() => {
// the components with the first cache key should be affected
expect(getByTestId(c1, 'data').textContent).toBe('')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'data').textContent).toBe('')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
// the components with the second cache key should be unaffected
expect(getByTestId(c3, 'data').textContent).toBe('C3')
expect(getByTestId(c3, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c4, 'data').textContent).toBe('C3')
expect(getByTestId(c4, 'status').textContent).toBe('fulfilled')
})
})
test('two mutations with different `fixedCacheKey` do not influence each other', async () => {
render(
<>
<Component name="C1" fixedCacheKey="test" />
<Component name="C2" fixedCacheKey="toast" />
</>,
{ wrapper: storeRef.wrapper },
)
const c1 = screen.getByTestId('C1')
const c2 = screen.getByTestId('C2')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
act(() => {
getByTestId(c1, 'trigger').click()
})
await waitFor(() =>
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled'),
)
expect(getByTestId(c1, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
})
test('unmounting and remounting keeps data intact', async () => {
const { rerender } = render(<Component name="C1" fixedCacheKey="test" />, {
wrapper: storeRef.wrapper,
})
let c1 = screen.getByTestId('C1')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
act(() => {
getByTestId(c1, 'trigger').click()
})
await waitFor(() =>
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled'),
)
expect(getByTestId(c1, 'data').textContent).toBe('C1')
rerender(<div />)
expect(screen.queryByTestId('C1')).toBe(null)
rerender(<Component name="C1" fixedCacheKey="test" />)
c1 = screen.getByTestId('C1')
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c1, 'data').textContent).toBe('C1')
})
test('(limitation) mutations using `fixedCacheKey` do not return `originalArgs`', async () => {
render(
<>
<Component name="C1" fixedCacheKey="test" />
<Component name="C2" fixedCacheKey="test" />
</>,
{ wrapper: storeRef.wrapper },
)
const c1 = screen.getByTestId('C1')
const c2 = screen.getByTestId('C2')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
act(() => {
getByTestId(c1, 'trigger').click()
})
await waitFor(() =>
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled'),
)
expect(getByTestId(c1, 'data').textContent).toBe('C1')
expect(getByTestId(c2, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c2, 'data').textContent).toBe('C1')
})
test('a component without `fixedCacheKey` has `originalArgs`', async () => {
render(<Component name="C1" />, {
wrapper: storeRef.wrapper,
})
let c1 = screen.getByTestId('C1')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c1, 'originalArgs').textContent).toBe('undefined')
await act(async () => {
getByTestId(c1, 'trigger').click()
await Promise.resolve()
})
expect(getByTestId(c1, 'originalArgs').textContent).toBe('C1')
})
test('a component with `fixedCacheKey` does never have `originalArgs`', async () => {
render(<Component name="C1" fixedCacheKey="test" />, {
wrapper: storeRef.wrapper,
})
let c1 = screen.getByTestId('C1')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c1, 'originalArgs').textContent).toBe('undefined')
await act(async () => {
getByTestId(c1, 'trigger').click()
})
expect(getByTestId(c1, 'originalArgs').textContent).toBe('undefined')
})
test('using `fixedCacheKey` will always use the latest dispatched thunk, prevent races', async () => {
let resolve1: (str: string) => void, resolve2: (str: string) => void
const p1 = new Promise<string>((resolve) => {
resolve1 = resolve
})
const p2 = new Promise<string>((resolve) => {
resolve2 = resolve
})
render(
<>
<Component name="C1" fixedCacheKey="test" value={p1} />
<Component name="C2" fixedCacheKey="test" value={p2} />
</>,
{ wrapper: storeRef.wrapper },
)
const c1 = screen.getByTestId('C1')
const c2 = screen.getByTestId('C2')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c2, 'status').textContent).toBe('uninitialized')
await act(async () => {
getByTestId(c1, 'trigger').click()
await Promise.resolve()
})
expect(getByTestId(c1, 'status').textContent).toBe('pending')
expect(getByTestId(c1, 'data').textContent).toBe('')
act(() => {
getByTestId(c2, 'trigger').click()
})
expect(getByTestId(c1, 'status').textContent).toBe('pending')
expect(getByTestId(c1, 'data').textContent).toBe('')
await act(async () => {
resolve1!('this should not show up any more')
await Promise.resolve()
})
await delay(150)
expect(getByTestId(c1, 'status').textContent).toBe('pending')
expect(getByTestId(c1, 'data').textContent).toBe('')
await act(async () => {
resolve2!('this should be visible')
await Promise.resolve()
})
await delay(150)
expect(getByTestId(c1, 'status').textContent).toBe('fulfilled')
expect(getByTestId(c1, 'data').textContent).toBe('this should be visible')
})
test('using fixedCacheKey should create a new cache entry', async () => {
api.enhanceEndpoints({
endpoints: {
send: {
onCacheEntryAdded: (arg) => onNewCacheEntry(arg),
},
},
})
render(<Component name="C1" fixedCacheKey={'testKey'} />, {
wrapper: storeRef.wrapper,
})
let c1 = screen.getByTestId('C1')
expect(getByTestId(c1, 'status').textContent).toBe('uninitialized')
expect(getByTestId(c1, 'originalArgs').textContent).toBe('undefined')
await act(async () => {
getByTestId(c1, 'trigger').click()
await Promise.resolve()
})
expect(onNewCacheEntry).toHaveBeenCalledWith('C1')
api.enhanceEndpoints({
endpoints: {
send: {
onCacheEntryAdded: undefined,
},
},
})
})
})
|