Spaces:
Sleeping
Sleeping
File size: 8,089 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 | import { createApi } from '@reduxjs/toolkit/query'
import type { QueryActionCreatorResult } from '@reduxjs/toolkit/query'
import { delay } from 'msw'
import { setupApiStore } from '../../tests/utils/helpers'
import type { SubscriptionSelectors } from '../core/buildMiddleware/types'
const mockBaseQuery = vi
.fn()
.mockImplementation((args: any) => ({ data: args }))
const api = createApi({
baseQuery: mockBaseQuery,
tagTypes: ['Posts'],
endpoints: (build) => ({
getPosts: build.query<unknown, number>({
query(pageNumber) {
return { url: 'posts', params: pageNumber }
},
providesTags: ['Posts'],
}),
}),
})
const { getPosts } = api.endpoints
const storeRef = setupApiStore(api)
let getSubscriptions: SubscriptionSelectors['getSubscriptions']
beforeEach(() => {
;({ getSubscriptions } = storeRef.store.dispatch(
api.internalActions.internal_getRTKQSubscriptions(),
) as unknown as SubscriptionSelectors)
const currentPolls = storeRef.store.dispatch({
type: `${api.reducerPath}/getPolling`,
}) as any
;(currentPolls as any).pollUpdateCounters = {}
})
const getSubscribersForQueryCacheKey = (queryCacheKey: string) =>
getSubscriptions().get(queryCacheKey) ?? new Map()
const createSubscriptionGetter = (queryCacheKey: string) => () =>
getSubscribersForQueryCacheKey(queryCacheKey)
describe('polling tests', () => {
it('clears intervals when seeing a resetApiState action', async () => {
await storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 10 },
subscribe: true,
}),
)
expect(mockBaseQuery).toHaveBeenCalledOnce()
storeRef.store.dispatch(api.util.resetApiState())
await delay(30)
expect(mockBaseQuery).toHaveBeenCalledOnce()
})
it('replaces polling interval when the subscription options are updated', async () => {
const { requestId, queryCacheKey, ...subscription } =
storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 10 },
subscribe: true,
}),
)
const getSubs = createSubscriptionGetter(queryCacheKey)
await delay(1)
expect(getSubs().size).toBe(1)
expect(getSubs()?.get(requestId)?.pollingInterval).toBe(10)
subscription.updateSubscriptionOptions({ pollingInterval: 20 })
await delay(1)
expect(getSubs().size).toBe(1)
expect(getSubs()?.get(requestId)?.pollingInterval).toBe(20)
})
it(`doesn't replace the interval when removing a shared query instance with a poll `, async () => {
const subscriptionOne = storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 10 },
subscribe: true,
}),
)
storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 10 },
subscribe: true,
}),
)
await delay(10)
const getSubs = createSubscriptionGetter(subscriptionOne.queryCacheKey)
expect(getSubs().size).toBe(2)
subscriptionOne.unsubscribe()
await delay(1)
expect(getSubs().size).toBe(1)
})
it('uses lowest specified interval when two components are mounted', async () => {
storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 30000 },
subscribe: true,
}),
)
storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 10 },
subscribe: true,
}),
)
await delay(20)
expect(mockBaseQuery.mock.calls.length).toBeGreaterThanOrEqual(2)
})
it('respects skipPollingIfUnfocused', async () => {
mockBaseQuery.mockClear()
storeRef.store.dispatch(
getPosts.initiate(2, {
subscriptionOptions: {
pollingInterval: 10,
skipPollingIfUnfocused: true,
},
subscribe: true,
}),
)
storeRef.store.dispatch(api.internalActions?.onFocusLost())
await delay(50)
const callsWithSkip = mockBaseQuery.mock.calls.length
storeRef.store.dispatch(
getPosts.initiate(2, {
subscriptionOptions: {
pollingInterval: 10,
skipPollingIfUnfocused: false,
},
subscribe: true,
}),
)
storeRef.store.dispatch(api.internalActions?.onFocus())
await delay(50)
const callsWithoutSkip = mockBaseQuery.mock.calls.length
expect(callsWithSkip).toBe(1)
expect(callsWithoutSkip).toBeGreaterThanOrEqual(2)
storeRef.store.dispatch(api.util.resetApiState())
})
it('respects skipPollingIfUnfocused if at least one subscription has it', async () => {
storeRef.store.dispatch(
getPosts.initiate(3, {
subscriptionOptions: {
pollingInterval: 10,
skipPollingIfUnfocused: false,
},
subscribe: true,
}),
)
await delay(50)
const callsWithoutSkip = mockBaseQuery.mock.calls.length
storeRef.store.dispatch(
getPosts.initiate(3, {
subscriptionOptions: {
pollingInterval: 15,
skipPollingIfUnfocused: true,
},
subscribe: true,
}),
)
storeRef.store.dispatch(
getPosts.initiate(3, {
subscriptionOptions: {
pollingInterval: 20,
skipPollingIfUnfocused: false,
},
subscribe: true,
}),
)
storeRef.store.dispatch(api.internalActions?.onFocusLost())
await delay(50)
const callsWithSkip = mockBaseQuery.mock.calls.length
expect(callsWithoutSkip).toBeGreaterThan(2)
expect(callsWithSkip).toBe(callsWithoutSkip + 1)
})
it('replaces skipPollingIfUnfocused when the subscription options are updated', async () => {
const { requestId, queryCacheKey, ...subscription } =
storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: {
pollingInterval: 10,
skipPollingIfUnfocused: false,
},
subscribe: true,
}),
)
const getSubs = createSubscriptionGetter(queryCacheKey)
await delay(1)
expect(getSubs().size).toBe(1)
expect(getSubs().get(requestId)?.skipPollingIfUnfocused).toBe(false)
subscription.updateSubscriptionOptions({
pollingInterval: 20,
skipPollingIfUnfocused: true,
})
await delay(1)
expect(getSubs().size).toBe(1)
expect(getSubs().get(requestId)?.skipPollingIfUnfocused).toBe(true)
})
it('should minimize polling recalculations when adding multiple subscribers', async () => {
// Reset any existing state
const storeRef = setupApiStore(api, undefined, {
withoutTestLifecycles: true,
})
const SUBSCRIBER_COUNT = 10
const subscriptions: QueryActionCreatorResult<any>[] = []
// Add 10 subscribers to the same endpoint with polling enabled
for (let i = 0; i < SUBSCRIBER_COUNT; i++) {
const subscription = storeRef.store.dispatch(
getPosts.initiate(1, {
subscriptionOptions: { pollingInterval: 1000 },
subscribe: true,
}),
)
subscriptions.push(subscription)
}
// Wait a bit for all subscriptions to be processed
await Promise.all(subscriptions)
// Wait for the poll update timer
await delay(25)
// Get the polling state using the secret "getPolling" action
const currentPolls = storeRef.store.dispatch({
type: `${api.reducerPath}/getPolling`,
}) as any
// Get the query cache key for our endpoint
const queryCacheKey = subscriptions[0].queryCacheKey
// Check the poll update counters
const pollUpdateCounters = currentPolls.pollUpdateCounters || {}
const updateCount = pollUpdateCounters[queryCacheKey] || 0
// With batching optimization, this should be much lower than SUBSCRIBER_COUNT
// Ideally 1, but could be slightly higher due to timing
expect(updateCount).toBeGreaterThanOrEqual(1)
expect(updateCount).toBeLessThanOrEqual(2)
// Clean up subscriptions
subscriptions.forEach((sub) => sub.unsubscribe())
})
})
|