Open History to see the last commit
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 { queryKey, 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 = queryKey()
33 const key2 = queryKey()
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.length).toBe(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 // oxlint-disable-next-line vitest/expect-expect
76 it('should not change state if unmounted', async () => {
77 const key1 = queryKey()
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 const QueriesObserverSpy = vi
89 .spyOn(QueryCore, 'QueriesObserver')
90 .mockImplementation(function (
91 client: InstanceType<typeof QueryCore.QueryClient>,
92 queries: Array<QueryCore.QueryObserverOptions>,
93 ) {
94 return new QueriesObserverMock(client, queries)
95 })
96β
97 function Queries() {
98 useQueries(() => ({
99 queries: [
100 {
101 queryKey: key1,
102 queryFn: () => sleep(10).then(() => 1),
103 },
104 ],
105 }))
106β
107 return (
108 <div>
109 <span>queries</span>
110 </div>
111 )
112 }
113β
114 function Page() {
115 const [mounted, setMounted] = createSignal(true)
116β
117 return (
118 <div>
119 <button onClick={() => setMounted(false)}>unmount</button>
120 {mounted() && <Queries />}
121 </div>
122 )
123 }
124β
125 const rendered = renderWithClient(queryClient, () => <Page />)
126β
127 fireEvent.click(rendered.getByText('unmount'))
128β
129 // Should not display the console error
130 // "Warning: Can't perform a React state update on an unmounted component"
131β
132 await vi.advanceTimersByTimeAsync(20)
133 QueriesObserverSpy.mockRestore()
134 })
135β
136 it('should use provided custom queryClient', async () => {
137 const key = queryKey()
138 const queryFn = () => sleep(10).then(() => 'custom client')
139β
140 function Page() {
141 const queries = useQueries(
142 () => ({
143 queries: [
144 {
145 queryKey: key,
146 queryFn,
147 },
148 ],
149 }),
150 () => queryClient,
151 )
152β
153 return <div>data: {queries[0].data}</div>
154 }
155β
156 const rendered = render(() => <Page />)
157β
158 await vi.advanceTimersByTimeAsync(10)
159 expect(rendered.getByText('data: custom client')).toBeInTheDocument()
160 })
161β
162 it('should not fetch for the duration of the restoring period when isRestoring is true', async () => {
163 const key1 = queryKey()
164 const key2 = queryKey()
165 const queryFn1 = vi.fn(() => sleep(10).then(() => 'data1'))
166 const queryFn2 = vi.fn(() => sleep(10).then(() => 'data2'))
167β
168 function Page() {
169 const results = useQueries(() => ({
170 queries: [
171 { queryKey: key1, queryFn: queryFn1 },
172 { queryKey: key2, queryFn: queryFn2 },
173 ],
174 }))
175β
176 return (
177 <div>
178 <div data-testid="status1">{results[0].status}</div>
179 <div data-testid="status2">{results[1].status}</div>
180 <div data-testid="fetchStatus1">{results[0].fetchStatus}</div>
181 <div data-testid="fetchStatus2">{results[1].fetchStatus}</div>
182 <div data-testid="data1">{results[0].data ?? 'undefined'}</div>
183 <div data-testid="data2">{results[1].data ?? 'undefined'}</div>
184 </div>
185 )
186 }
187β
188 const rendered = renderWithClient(queryClient, () => (
189 <IsRestoringProvider value={() => true}>
190 <Page />
191 </IsRestoringProvider>
192 ))
193β
194 await vi.advanceTimersByTimeAsync(0)
195 expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
196 expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
197 expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
198 expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
199 expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
200 expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
201 expect(queryFn1).toHaveBeenCalledTimes(0)
202 expect(queryFn2).toHaveBeenCalledTimes(0)
203 await vi.advanceTimersByTimeAsync(10)
204 expect(rendered.getByTestId('status1')).toHaveTextContent('pending')
205 expect(rendered.getByTestId('status2')).toHaveTextContent('pending')
206 expect(rendered.getByTestId('fetchStatus1')).toHaveTextContent('idle')
207 expect(rendered.getByTestId('fetchStatus2')).toHaveTextContent('idle')
208 expect(rendered.getByTestId('data1')).toHaveTextContent('undefined')
209 expect(rendered.getByTestId('data2')).toHaveTextContent('undefined')
210 expect(queryFn1).toHaveBeenCalledTimes(0)
211 expect(queryFn2).toHaveBeenCalledTimes(0)
212 })
213})