File size: 8,434 Bytes
1e92f2d |
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 |
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { onScopeDispose, ref } from 'vue-demi'
import { sleep } from '@tanstack/query-test-utils'
import { useQueries } from '../useQueries'
import { useQueryClient } from '../useQueryClient'
import { QueryClient } from '../queryClient'
import type { MockedFunction } from 'vitest'
vi.mock('../useQueryClient')
describe('useQueries', () => {
beforeEach(() => {
vi.restoreAllMocks()
vi.useFakeTimers()
})
afterEach(() => {
vi.useRealTimers()
})
test('should return result for each query', () => {
const queries = [
{
queryKey: ['key1'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
{
queryKey: ['key2'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
]
const queriesState = useQueries({ queries })
expect(queriesState.value).toMatchObject([
{
status: 'pending',
isPending: true,
isFetching: true,
isStale: true,
},
{
status: 'pending',
isPending: true,
isFetching: true,
isStale: true,
},
])
})
test('should resolve to success and update reactive state', async () => {
const queries = [
{
queryKey: ['key11'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
{
queryKey: ['key12'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
]
const queriesState = useQueries({ queries })
await vi.advanceTimersByTimeAsync(0)
expect(queriesState.value).toMatchObject([
{
status: 'success',
isPending: false,
isFetching: false,
isStale: true,
},
{
status: 'success',
isPending: false,
isFetching: false,
isStale: true,
},
])
})
test('should reject one of the queries and update reactive state', async () => {
const queries = [
{
queryKey: ['key21'],
queryFn: () =>
sleep(0).then(() => Promise.reject(new Error('Some error'))),
},
{
queryKey: ['key22'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
]
const queriesState = useQueries({ queries })
await vi.advanceTimersByTimeAsync(0)
expect(queriesState.value).toMatchObject([
{
status: 'error',
isPending: false,
isFetching: false,
isStale: true,
},
{
status: 'success',
isPending: false,
isFetching: false,
isStale: true,
},
])
})
test('should return state for new queries', async () => {
const queries = ref([
{
queryKey: ['key31'],
queryFn: () => sleep(0).then(() => 'value31'),
},
{
queryKey: ['key32'],
queryFn: () => sleep(0).then(() => 'value32'),
},
{
queryKey: ['key33'],
queryFn: () => sleep(0).then(() => 'value33'),
},
])
const queriesState = useQueries({ queries })
await vi.advanceTimersByTimeAsync(0)
queries.value.splice(
0,
queries.value.length,
{
queryKey: ['key31'],
queryFn: () => sleep(0).then(() => 'value31'),
},
{
queryKey: ['key34'],
queryFn: () => sleep(0).then(() => 'value34'),
},
)
await vi.advanceTimersByTimeAsync(0)
await vi.advanceTimersByTimeAsync(0)
expect(queriesState.value.length).toEqual(2)
expect(queriesState.value).toMatchObject([
{
data: 'value31',
status: 'success',
isPending: false,
isFetching: false,
isStale: true,
},
{
data: 'value34',
status: 'success',
isPending: false,
isFetching: false,
isStale: true,
},
])
})
test('should stop listening to changes on onScopeDispose', async () => {
const onScopeDisposeMock = onScopeDispose as MockedFunction<
typeof onScopeDispose
>
onScopeDisposeMock.mockImplementationOnce((fn) => fn())
const queries = [
{
queryKey: ['key41'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
{
queryKey: ['key42'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
]
const queriesState = useQueries({ queries })
await vi.advanceTimersByTimeAsync(0)
expect(queriesState.value).toMatchObject([
{
status: 'pending',
isPending: true,
isFetching: true,
isStale: true,
},
{
status: 'pending',
isPending: true,
isFetching: true,
isStale: true,
},
])
})
test('should use queryClient provided via options', async () => {
const queryClient = new QueryClient()
const queries = [
{
queryKey: ['key41'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
{
queryKey: ['key42'],
queryFn: () => sleep(0).then(() => 'Some data'),
},
]
useQueries({ queries }, queryClient)
await vi.advanceTimersByTimeAsync(0)
expect(useQueryClient).toHaveBeenCalledTimes(0)
})
test('should combine queries', async () => {
const firstResult = 'first result'
const secondResult = 'second result'
const queryClient = new QueryClient()
const queries = [
{
queryKey: ['key41'],
queryFn: () => sleep(0).then(() => firstResult),
},
{
queryKey: ['key42'],
queryFn: () => sleep(0).then(() => secondResult),
},
]
const queriesResult = useQueries(
{
queries,
combine: (results) => {
return {
combined: true,
res: results.map((res) => res.data),
}
},
},
queryClient,
)
await vi.advanceTimersByTimeAsync(0)
expect(queriesResult.value).toMatchObject({
combined: true,
res: [firstResult, secondResult],
})
})
test('should be `enabled` to accept getter function', async () => {
const fetchFn = vi.fn()
const checked = ref(false)
useQueries({
queries: [
{
queryKey: ['enabled'],
queryFn: fetchFn,
enabled: () => checked.value,
},
],
})
expect(fetchFn).not.toHaveBeenCalled()
checked.value = true
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalled()
})
test('should allow getters for query keys', async () => {
const fetchFn = vi.fn()
const key1 = ref('key1')
const key2 = ref('key2')
useQueries({
queries: [
{
queryKey: ['key', () => key1.value, () => key2.value],
queryFn: fetchFn,
},
],
})
expect(fetchFn).toHaveBeenCalledTimes(1)
key1.value = 'key3'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(2)
key2.value = 'key4'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(3)
})
test('should allow arbitrarily nested getters for query keys', async () => {
const fetchFn = vi.fn()
const key1 = ref('key1')
const key2 = ref('key2')
const key3 = ref('key3')
const key4 = ref('key4')
const key5 = ref('key5')
useQueries({
queries: [
{
queryKey: [
'key',
key1,
() => key2.value,
{ key: () => key3.value },
[{ foo: { bar: () => key4.value } }],
() => ({
foo: {
bar: {
baz: () => key5.value,
},
},
}),
],
queryFn: fetchFn,
},
],
})
expect(fetchFn).toHaveBeenCalledTimes(1)
key1.value = 'key1-updated'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(2)
key2.value = 'key2-updated'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(3)
key3.value = 'key3-updated'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(4)
key4.value = 'key4-updated'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(5)
key5.value = 'key5-updated'
await vi.advanceTimersByTimeAsync(0)
expect(fetchFn).toHaveBeenCalledTimes(6)
})
})
|