Spaces:
Running
Running
File size: 5,038 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 | // tests for "cleanup-after-unsubscribe" behavior
import React from 'react'
import { createListenerMiddleware } from '@reduxjs/toolkit'
import { createApi, QueryStatus } from '@reduxjs/toolkit/query/react'
import { act, render, screen, waitFor } from '@testing-library/react'
import { setupApiStore } from '../../tests/utils/helpers'
import type { SubscriptionSelectors } from '../core/buildMiddleware/types'
const api = createApi({
baseQuery: () => ({ data: 42 }),
endpoints: (build) => ({
a: build.query<unknown, void>({ query: () => '' }),
b: build.query<unknown, void>({ query: () => '' }),
}),
})
const storeRef = setupApiStore(api)
const getSubStateA = () => storeRef.store.getState().api.queries['a(undefined)']
const getSubStateB = () => storeRef.store.getState().api.queries['b(undefined)']
function UsingA() {
const { data } = api.endpoints.a.useQuery()
return <>Result: {data as React.ReactNode} </>
}
function UsingB() {
api.endpoints.b.useQuery()
return <></>
}
function UsingAB() {
api.endpoints.a.useQuery()
api.endpoints.b.useQuery()
return <></>
}
beforeAll(() => {
vi.useFakeTimers({ shouldAdvanceTime: true })
})
test('data stays in store when component stays rendered', async () => {
expect(getSubStateA()).toBeUndefined()
render(<UsingA />, { wrapper: storeRef.wrapper })
await waitFor(() =>
expect(getSubStateA()?.status).toBe(QueryStatus.fulfilled),
)
vi.advanceTimersByTime(120_000)
expect(getSubStateA()?.status).toBe(QueryStatus.fulfilled)
})
test('data is removed from store after 60 seconds', async () => {
expect(getSubStateA()).toBeUndefined()
const { unmount } = render(<UsingA />, { wrapper: storeRef.wrapper })
await waitFor(() =>
expect(getSubStateA()?.status).toBe(QueryStatus.fulfilled),
)
unmount()
vi.advanceTimersByTime(59_000)
expect(getSubStateA()?.status).toBe(QueryStatus.fulfilled)
vi.advanceTimersByTime(2000)
expect(getSubStateA()).toBeUndefined()
})
test('data stays in store when component stays rendered while data for another component is removed after it unmounted', async () => {
expect(getSubStateA()).toBeUndefined()
expect(getSubStateB()).toBeUndefined()
const { rerender } = render(
<>
<UsingA />
<UsingB />
</>,
{ wrapper: storeRef.wrapper },
)
await waitFor(() => {
expect(getSubStateA()?.status).toBe(QueryStatus.fulfilled)
expect(getSubStateB()?.status).toBe(QueryStatus.fulfilled)
})
const statusA = getSubStateA()
await act(async () => {
rerender(<UsingA />)
vi.advanceTimersByTime(10)
})
vi.advanceTimersByTime(120_000)
expect(getSubStateA()).toEqual(statusA)
expect(getSubStateB()).toBeUndefined()
})
test('data stays in store when one component requiring the data stays in the store', async () => {
expect(getSubStateA()).toBeUndefined()
expect(getSubStateB()).toBeUndefined()
const { rerender } = render(
<>
<UsingA key="a" />
<UsingAB key="ab" />
</>,
{ wrapper: storeRef.wrapper },
)
await waitFor(() => {
expect(getSubStateA()?.status).toBe(QueryStatus.fulfilled)
expect(getSubStateB()?.status).toBe(QueryStatus.fulfilled)
})
const statusA = getSubStateA()
const statusB = getSubStateB()
await act(async () => {
rerender(<UsingAB key="ab" />)
vi.advanceTimersByTime(10)
vi.runAllTimers()
})
await act(async () => {
vi.advanceTimersByTime(120000)
vi.runAllTimers()
})
expect(getSubStateA()).toEqual(statusA)
expect(getSubStateB()).toEqual(statusB)
})
test('Minimizes the number of subscription dispatches when multiple components ask for the same data', async () => {
const listenerMiddleware = createListenerMiddleware()
const storeRef = setupApiStore(api, undefined, {
middleware: {
concat: [listenerMiddleware.middleware],
},
withoutTestLifecycles: true,
})
const actionTypes: unknown[] = []
listenerMiddleware.startListening({
predicate: () => true,
effect: (action) => {
if (
action.type.includes('subscriptionsUpdated') ||
action.type.includes('internal_')
) {
return
}
actionTypes.push(action.type)
},
})
const { getSubscriptionCount } = storeRef.store.dispatch(
api.internalActions.internal_getRTKQSubscriptions(),
) as unknown as SubscriptionSelectors
const NUM_LIST_ITEMS = 1000
function ParentComponent() {
const listItems = Array.from({ length: NUM_LIST_ITEMS }).map((_, i) => (
<UsingA key={i} />
))
return <>{listItems}</>
}
render(<ParentComponent />, {
wrapper: storeRef.wrapper,
})
await act(async () => {
vi.advanceTimersByTime(10)
vi.runAllTimers()
})
await waitFor(() => {
return screen.getAllByText(/42/).length > 0
})
expect(getSubscriptionCount('a(undefined)')).toBe(NUM_LIST_ITEMS)
expect(actionTypes).toEqual([
'api/config/middlewareRegistered',
'api/executeQuery/pending',
'api/executeQuery/fulfilled',
])
}, 25_000)
|