Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useQueries.test.tsx

218 lines6.6 KB

1import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
2import { fireEvent, render } from '@solidjs/testing-library'
3import * as QueryCore from '@tanstack/query-core'
4import { createRenderEffect, createSignal } from 'solid-js'
5import { createKey, sleep } from '@tanstack/query-test-utils'
6import {
7 IsRestoringProvider,
8 QueriesObserver,
9 QueryCache,
10 QueryClient,
11 useQueries,
12} from '..'
13import { renderWithClient } from './utils'
14import type { UseQueryResult } from '..'
15​
16describe('useQueries', () => {
17 let queryCache: QueryCache
18 let queryClient: QueryClient
19​
20 beforeEach(() => {
21 vi.useFakeTimers()
22 queryCache = new QueryCache()
23 queryClient = new QueryClient({ queryCache })
24 })
25​
26 afterEach(() => {
27 queryClient.clear()
28 vi.useRealTimers()
29 })
30​
31 it('should return the correct states', async () => {
32 const key1 = createKey()
33 const key2 = createKey()
34 const results: Array<Array<UseQueryResult>> = []
35​
36 function Page() {
37 const result = useQueries(() => ({
38 queries: [
39 {
40 queryKey: key1,
41 queryFn: () => sleep(10).then(() => 1),
42 },
43 {
44 queryKey: key2,
45 queryFn: () => sleep(100).then(() => 2),
46 },
47 ],
48 }))
49​
50 createRenderEffect(() => {
51 results.push([{ ...result[0] }, { ...result[1] }])
52 })
53​
54 return (
55 <div>
56 <div>
57 data1: {String(result[0].data ?? 'null')}, data2:{' '}
58 {String(result[1].data ?? 'null')}
59 </div>
60 </div>
61 )
62 }
63​
64 const rendered = renderWithClient(queryClient, () => <Page />)
65​
66 await vi.advanceTimersByTimeAsync(100)
67 expect(rendered.getByText('data1: 1, data2: 2')).toBeInTheDocument()
68​
69 expect(results).toHaveLength(3)
70 expect(results[0]).toMatchObject([{ data: undefined }, { data: undefined }])
71 expect(results[1]).toMatchObject([{ data: 1 }, { data: undefined }])
72 expect(results[2]).toMatchObject([{ data: 1 }, { data: 2 }])
73 })
74​
75 it('should not change state if unmounted', async () => {
76 const states: Array<UseQueryResult['status']> = []
77 const key1 = createKey()
78​
79 // We have to mock the QueriesObserver to not unsubscribe
80 // the listener when the component is unmounted
81 class QueriesObserverMock extends QueriesObserver {
82 override subscribe(listener: any) {
83 super.subscribe(listener)
84 return () => void 0
85 }
86 }
87​
88 vi.spyOn(QueryCore, 'QueriesObserver').mockImplementation(function (
89 client: InstanceType<typeof QueryCore.QueryClient>,
90 queries: Array<QueryCore.QueryObserverOptions>,
91 ) {
92 return new QueriesObserverMock(client, queries)
93 })
94​
95 function Queries() {
96 const queries = useQueries(() => ({
97 queries: [
98 {
99 queryKey: key1,
100 queryFn: () => sleep(10).then(() => 1),
101 },
102 ],
103 }))
104 createRenderEffect(() => {
105 states.push(queries[0].status)
106 })
107​
108 return (
109 <div>
110 <span>queries</span>
111 </div>
112 )
113 }
114​
115 function Page() {
116 const [mounted, setMounted] = createSignal(true)
117​
118 return (
119 <div>
120 <button onClick={() => setMounted(false)}>unmount</button>
121 {mounted() && <Queries />}
122 </div>
123 )
124 }
125​
126 const rendered = renderWithClient(queryClient, () => <Page />)
127 expect(states).toStrictEqual(['pending'])
128​
129 fireEvent.click(rendered.getByText('unmount'))
130 expect(queryClient.getQueryState(key1)?.status).toBe('pending')
131​
132 await vi.advanceTimersByTimeAsync(20)
133 expect(queryClient.getQueryState(key1)?.status).toBe('success')
134 expect(states).toStrictEqual(['pending'])
135 })
136​
137 it('should use provided custom queryClient', async () => {
138 const key = createKey()
139 const queryFn = () => sleep(10).then(() => 'custom client')
140​
141 function Page() {
142 const queries = useQueries(
143 () => ({
144 queries: [
145 {
146 queryKey: key,
147 queryFn,
148 },
149 ],
150 }),
151 () => queryClient,
152 )
153​
154 return <div>data: {queries[0].data}</div>
155 }
156​
157 const rendered = render(() => <Page />)
158​
159 await vi.advanceTimersByTimeAsync(10)
160 expect(rendered.getByText('data: custom client')).toBeInTheDocument()
161 })
162​
163 it('should not fetch for the duration of the restoring period when isRestoring is true', async () => {
164 const key1 = createKey()
165 const key2 = createKey()
166 const queryFn1 = vi.fn<() => Promise<string>>(() =>
167 sleep(10).then(() => 'data1'),
168 )
169 const queryFn2 = vi.fn<() => Promise<string>>(() =>
170 sleep(10).then(() => 'data2'),
171 )
172​
173 function Page() {
174 const results = useQueries(() => ({
175 queries: [
176 { queryKey: key1, queryFn: queryFn1 },
177 { queryKey: key2, queryFn: queryFn2 },
178 ],
179 }))
180​
181 return (
182 <div>
183 <div data-testid="status1">{results[0].status}</div>
184 <div data-testid="status2">{results[1].status}</div>
185 <div data-testid="fetchStatus1">{results[0].fetchStatus}</div>
186 <div data-testid="fetchStatus2">{results[1].fetchStatus}</div>
187 <div data-testid="data1">{results[0].data ?? 'undefined'}</div>
188 <div data-testid="data2">{results[1].data ?? 'undefined'}</div>
189 </div>
190 )
191 }
192​
193 const rendered = renderWithClient(queryClient, () => (
194 <IsRestoringProvider value={() => true}>
195 <Page />
196 </IsRestoringProvider>
197 ))
198​
199 await vi.advanceTimersByTimeAsync(0)
200 expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
201 expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
202 expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
203 expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
204 expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
205 expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
206 expect(queryFn1).toHaveBeenCalledTimes(0)
207 expect(queryFn2).toHaveBeenCalledTimes(0)
208 await vi.advanceTimersByTimeAsync(10)
209 expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
210 expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
211 expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
212 expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
213 expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
214 expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
215 expect(queryFn1).toHaveBeenCalledTimes(0)
216 expect(queryFn2).toHaveBeenCalledTimes(0)
217 })
218})