Open History to see the last commit
1import React from 'react'
2import { render, waitFor } from '@testing-library/react'
3import { renderToString } from 'react-dom/server'
4β
5import { sleep, queryKey } from './utils'
6import {
7 QueryClient,
8 QueryClientProvider,
9 QueryCache,
10 useQuery,
11 useQueryClient,
12} from '../..'
13β
14describe('QueryClientProvider', () => {
15 test('sets a specific cache for all queries to use', async () => {
16 const key = queryKey()
17β
18 const queryCache = new QueryCache()
19 const queryClient = new QueryClient({ queryCache })
20β
21 function Page() {
22 const { data } = useQuery(key, async () => {
23 await sleep(10)
24 return 'test'
25 })
26β
27 return (
28 <div>
29 <h1>{data}</h1>
30 </div>
31 )
32 }
33β
34 const rendered = render(
35 <QueryClientProvider client={queryClient}>
36 <Page />
37 </QueryClientProvider>
38 )
39β
40 await waitFor(() => rendered.getByText('test'))
41β
42 expect(queryCache.find(key)).toBeDefined()
43 })
44β
45 test('allows multiple caches to be partitioned', async () => {
46 const key1 = queryKey()
47 const key2 = queryKey()
48β
49 const queryCache1 = new QueryCache()
50 const queryCache2 = new QueryCache()
51β
52 const queryClient1 = new QueryClient({ queryCache: queryCache1 })
53 const queryClient2 = new QueryClient({ queryCache: queryCache2 })
54β
55 function Page1() {
56 const { data } = useQuery(key1, async () => {
57 await sleep(10)
58 return 'test1'
59 })
60β
61 return (
62 <div>
63 <h1>{data}</h1>
64 </div>
65 )
66 }
67 function Page2() {
68 const { data } = useQuery(key2, async () => {
69 await sleep(10)
70 return 'test2'
71 })
72β
73 return (
74 <div>
75 <h1>{data}</h1>
76 </div>
77 )
78 }
79β
80 const rendered = render(
81 <>
82 <QueryClientProvider client={queryClient1}>
83 <Page1 />
84 </QueryClientProvider>
85 <QueryClientProvider client={queryClient2}>
86 <Page2 />
87 </QueryClientProvider>
88 </>
89 )
90β
91 await waitFor(() => rendered.getByText('test1'))
92 await waitFor(() => rendered.getByText('test2'))
93β
94 expect(queryCache1.find(key1)).toBeDefined()
95 expect(queryCache1.find(key2)).not.toBeDefined()
96 expect(queryCache2.find(key1)).not.toBeDefined()
97 expect(queryCache2.find(key2)).toBeDefined()
98 })
99β
100 test("uses defaultOptions for queries when they don't provide their own config", async () => {
101 const key = queryKey()
102β
103 const queryCache = new QueryCache()
104 const queryClient = new QueryClient({
105 queryCache,
106 defaultOptions: {
107 queries: {
108 cacheTime: Infinity,
109 },
110 },
111 })
112β
113 function Page() {
114 const { data } = useQuery(key, async () => {
115 await sleep(10)
116 return 'test'
117 })
118β
119 return (
120 <div>
121 <h1>{data}</h1>
122 </div>
123 )
124 }
125β
126 const rendered = render(
127 <QueryClientProvider client={queryClient}>
128 <Page />
129 </QueryClientProvider>
130 )
131β
132 await waitFor(() => rendered.getByText('test'))
133β
134 expect(queryCache.find(key)).toBeDefined()
135 expect(queryCache.find(key)?.options.cacheTime).toBe(Infinity)
136 })
137β
138 describe('useQueryClient', () => {
139 test('should throw an error if no query client has been set', () => {
140 const consoleMock = jest
141 .spyOn(console, 'error')
142 .mockImplementation(() => undefined)
143β
144 function Page() {
145 useQueryClient()
146 return null
147 }
148β
149 expect(() => render(<Page />)).toThrow(
150 'No QueryClient set, use QueryClientProvider to set one'
151 )
152β
153 consoleMock.mockRestore()
154 })
155β
156 test('should use window to get the context when contextSharing is true', () => {
157 const queryCache = new QueryCache()
158 const queryClient = new QueryClient({ queryCache })
159β
160 let queryClientFromHook: QueryClient | undefined
161 let queryClientFromWindow: QueryClient | undefined
162β
163 function Page() {
164 queryClientFromHook = useQueryClient()
165 queryClientFromWindow = React.useContext(
166 window.ReactQueryClientContext as React.Context<
167 QueryClient | undefined
168 >
169 )
170 return null
171 }
172β
173 render(
174 <QueryClientProvider client={queryClient} contextSharing={true}>
175 <Page />
176 </QueryClientProvider>
177 )
178β
179 expect(queryClientFromHook).toEqual(queryClient)
180 expect(queryClientFromWindow).toEqual(queryClient)
181 })
182β
183 test('should not use window to get the context when contextSharing is true and window does not exist', () => {
184 const queryCache = new QueryCache()
185 const queryClient = new QueryClient({ queryCache })
186β
187 // Mock a non web browser environment
188 const windowSpy = jest
189 .spyOn(window, 'window', 'get')
190 .mockImplementation(undefined)
191β
192 let queryClientFromHook: QueryClient | undefined
193β
194 function Page() {
195 queryClientFromHook = useQueryClient()
196 return null
197 }
198β
199 renderToString(
200 <QueryClientProvider client={queryClient} contextSharing={true}>
201 <Page />
202 </QueryClientProvider>
203 )
204β
205 expect(queryClientFromHook).toEqual(queryClient)
206β
207 windowSpy.mockRestore()
208 })
209 })
210})