Spaces:
Running
Running
File size: 4,179 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 | import type { TagDescription } from '@reduxjs/toolkit/query'
import { createApi, fakeBaseQuery } from '@reduxjs/toolkit/query'
import { waitFor } from '@testing-library/react'
import { delay } from 'msw'
import { setupApiStore } from '../../tests/utils/helpers'
const tagTypes = [
'apple',
'pear',
'banana',
'tomato',
'cat',
'dog',
'giraffe',
] as const
type TagTypes = (typeof tagTypes)[number]
type ProvidedTags = TagDescription<TagTypes>[]
type InvalidatesTags = (ProvidedTags[number] | null | undefined)[]
/** providesTags, invalidatesTags, shouldInvalidate */
const caseMatrix: [ProvidedTags, InvalidatesTags, boolean][] = [
// *****************************
// basic invalidation behavior
// *****************************
// string
[['apple'], ['apple'], true],
[['apple'], ['pear'], false],
// string and type only behave identical
[[{ type: 'apple' }], ['apple'], true],
[[{ type: 'apple' }], ['pear'], false],
[['apple'], [{ type: 'apple' }], true],
[['apple'], [{ type: 'pear' }], false],
// type only invalidates type + id
[[{ type: 'apple', id: 1 }], [{ type: 'apple' }], true],
[[{ type: 'pear', id: 1 }], ['apple'], false],
// type + id never invalidates type only
[['apple'], [{ type: 'apple', id: 1 }], false],
[['pear'], [{ type: 'apple', id: 1 }], false],
// type + id invalidates type + id
[[{ type: 'apple', id: 1 }], [{ type: 'apple', id: 1 }], true],
[[{ type: 'apple', id: 1 }], [{ type: 'apple', id: 2 }], false],
// null and undefined
[['apple'], [null], false],
[['apple'], [undefined], false],
[['apple'], [null, 'apple'], true],
[['apple'], [undefined, 'apple'], true],
// *****************************
// test multiple values in array
// *****************************
[['apple', 'banana', 'tomato'], ['apple'], true],
[['apple'], ['pear', 'banana', 'tomato'], false],
[
[
{ type: 'apple', id: 1 },
{ type: 'apple', id: 3 },
{ type: 'apple', id: 4 },
],
[{ type: 'apple', id: 1 }],
true,
],
[
[{ type: 'apple', id: 1 }],
[
{ type: 'apple', id: 2 },
{ type: 'apple', id: 3 },
{ type: 'apple', id: 4 },
],
false,
],
]
test.each(caseMatrix)(
'\tprovidesTags: %O,\n\tinvalidatesTags: %O,\n\tshould invalidate: %s',
async (providesTags, invalidatesTags, shouldInvalidate) => {
let queryCount = 0
const {
store,
api,
api: {
endpoints: { invalidating, providing, unrelated },
},
} = setupApiStore(
createApi({
baseQuery: fakeBaseQuery(),
tagTypes,
endpoints: (build) => ({
providing: build.query<unknown, void>({
queryFn() {
queryCount++
return { data: {} }
},
providesTags,
}),
unrelated: build.query<unknown, void>({
queryFn() {
return { data: {} }
},
providesTags: ['cat', 'dog', { type: 'giraffe', id: 8 }],
}),
invalidating: build.mutation<unknown, void>({
queryFn() {
return { data: {} }
},
invalidatesTags,
}),
}),
}),
undefined,
{ withoutTestLifecycles: true },
)
store.dispatch(providing.initiate())
store.dispatch(unrelated.initiate())
expect(queryCount).toBe(1)
await waitFor(() => {
expect(api.endpoints.providing.select()(store.getState()).status).toBe(
'fulfilled',
)
expect(api.endpoints.unrelated.select()(store.getState()).status).toBe(
'fulfilled',
)
})
const toInvalidate = api.util.selectInvalidatedBy(
store.getState(),
invalidatesTags,
)
if (shouldInvalidate) {
expect(toInvalidate).toEqual([
{
queryCacheKey: 'providing(undefined)',
endpointName: 'providing',
originalArgs: undefined,
},
])
} else {
expect(toInvalidate).toEqual([])
}
store.dispatch(invalidating.initiate())
expect(queryCount).toBe(1)
await delay(2)
expect(queryCount).toBe(shouldInvalidate ? 2 : 1)
},
)
|