Open History to see the last commit
1import { createKey, sleep } from '@tanstack/query-test-utils'
2import { renderHook } from '@testing-library/react'
3import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
4import { QueryClient, useQueries, useQuery } from '..'
5β
6class Placeholder {
7 constructor(readonly value: number) {}
8}
9β
10type Options = {
11 queryKey: ReadonlyArray<unknown>
12 queryFn: () => Promise<Placeholder>
13 placeholderData: Placeholder
14 select?: (data: Placeholder) => Placeholder | Set<number>
15}
16β
17function useMultiple(options: Options, client: QueryClient) {
18 return useQueries({ queries: [options] }, client)[0]
19}
20β
21const stable = { value: 1 }
22const selectSet = (data: Placeholder) => new Set([data.value])
23const selectError = () => {
24 throw new Error('selection failed')
25}
26β
27describe('placeholder updates', () => {
28 let client: QueryClient
29β
30 beforeEach(() => {
31 vi.useFakeTimers()
32 client = new QueryClient()
33 })
34β
35 afterEach(() => {
36 client.clear()
37 vi.useRealTimers()
38 })
39β
40 it.each([
41 [
42 'useQueries with a class',
43 useMultiple,
44 () => new Placeholder(1),
45 undefined,
46 ],
47 [
48 'useQueries with a changing object',
49 useMultiple,
50 (value: number) => ({ value }),
51 undefined,
52 ],
53 [
54 'useQueries with a Set selector',
55 useMultiple,
56 () => ({ value: 1 }),
57 selectSet,
58 ],
59 ['useQuery with a Set selector', useQuery, () => ({ value: 1 }), selectSet],
60 [
61 'useQueries with a throwing selector',
62 useMultiple,
63 () => stable,
64 selectError,
65 ],
66 ['useQuery with a throwing selector', useQuery, () => stable, selectError],
67 ] as const)(
68 '%s settles after a parent render',
69 async (_name, useResult, placeholder, select) => {
70 const key = createKey()
71 let renders = 0
72 const { result, rerender } = renderHook(() => {
73 if (++renders > 10) {
74 throw new Error('Repeated renders for an unresolved query')
75 }
76 const input = placeholder(renders)
77 const { data, error } = useResult(
78 {
79 queryKey: key,
80 queryFn: () => new Promise<Placeholder>(() => {}),
81 placeholderData: input,
82 select,
83 },
84 client,
85 )
86 return { data, error, input }
87 })
88 rerender()
89 await vi.advanceTimersByTimeAsync(50)
90 const { data, error, input } = result.current
91 const expected =
92 select === selectError
93 ? 'selection failed'
94 : select
95 ? new Set([input.value])
96 : input
97 expect(error?.message ?? data).toStrictEqual(expected)
98 },
99 )
100β
101 it('shows fetched data after the selection of a computed placeholder throws', async () => {
102 const queryKey = createKey()
103 const placeholderData = () => ({ value: 0 })
104 const select = ({ value }: { value: number }) => {
105 if (value === 0) throw new Error('selection failed')
106 return value
107 }
108 const queryFn = () => sleep(10).then(() => ({ value: 1 }))
109 const { result, rerender } = renderHook(() => {
110 const [{ data, error }] = useQueries(
111 { queries: [{ queryKey, queryFn, placeholderData, select }] },
112 client,
113 )
114 return { data, error }
115 })
116β
117 rerender()
118 await vi.advanceTimersByTimeAsync(1)
119 expect(result.current.error?.message).toBe('selection failed')
120β
121 await vi.advanceTimersByTimeAsync(20)
122 expect(result.current).toStrictEqual({ data: 1, error: null })
123 })
124})