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

QueryClientProvider.test.tsx

189 lines4.6 KB

1import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
2import { render } from '@solidjs/testing-library'
3import { QueryCache } from '@tanstack/query-core'
4import { queryKey, sleep } from '@tanstack/query-test-utils'
5import { QueryClient, QueryClientProvider, useQuery, useQueryClient } from '..'
6​
7describe('QueryClientProvider', () => {
8 beforeEach(() => {
9 vi.useFakeTimers()
10 })
11​
12 afterEach(() => {
13 vi.useRealTimers()
14 })
15​
16 it('sets a specific cache for all queries to use', async () => {
17 const key = queryKey()
18​
19 const queryCache = new QueryCache()
20 const queryClient = new QueryClient({ queryCache })
21​
22 function Page() {
23 const query = useQuery(() => ({
24 queryKey: key,
25 queryFn: async () => {
26 await sleep(10)
27 return 'test'
28 },
29 }))
30​
31 return (
32 <div>
33 <h1>{query.data}</h1>
34 </div>
35 )
36 }
37​
38 const rendered = render(() => (
39 <QueryClientProvider client={queryClient}>
40 <Page />
41 </QueryClientProvider>
42 ))
43​
44 await vi.advanceTimersByTimeAsync(10)
45 expect(rendered.getByText('test')).toBeInTheDocument()
46​
47 expect(queryCache.find({ queryKey: key })).toBeDefined()
48 })
49​
50 it('allows multiple caches to be partitioned', async () => {
51 const key1 = queryKey()
52 const key2 = queryKey()
53​
54 const queryCache1 = new QueryCache()
55 const queryCache2 = new QueryCache()
56​
57 const queryClient1 = new QueryClient({ queryCache: queryCache1 })
58 const queryClient2 = new QueryClient({ queryCache: queryCache2 })
59​
60 function Page1() {
61 const query = useQuery(() => ({
62 queryKey: key1,
63 queryFn: async () => {
64 await sleep(10)
65 return 'test1'
66 },
67 }))
68​
69 return (
70 <div>
71 <h1>{query.data}</h1>
72 </div>
73 )
74 }
75 function Page2() {
76 const query = useQuery(() => ({
77 queryKey: key2,
78 queryFn: async () => {
79 await sleep(10)
80 return 'test2'
81 },
82 }))
83​
84 return (
85 <div>
86 <h1>{query.data}</h1>
87 </div>
88 )
89 }
90​
91 const rendered = render(() => (
92 <>
93 <QueryClientProvider client={queryClient1}>
94 <Page1 />
95 </QueryClientProvider>
96 <QueryClientProvider client={queryClient2}>
97 <Page2 />
98 </QueryClientProvider>
99 </>
100 ))
101​
102 await vi.advanceTimersByTimeAsync(10)
103 expect(rendered.getByText('test1')).toBeInTheDocument()
104 expect(rendered.getByText('test2')).toBeInTheDocument()
105​
106 expect(queryCache1.find({ queryKey: key1 })).toBeDefined()
107 expect(queryCache1.find({ queryKey: key2 })).not.toBeDefined()
108 expect(queryCache2.find({ queryKey: key1 })).not.toBeDefined()
109 expect(queryCache2.find({ queryKey: key2 })).toBeDefined()
110 })
111​
112 it("uses defaultOptions for queries when they don't provide their own config", async () => {
113 const key = queryKey()
114​
115 const queryCache = new QueryCache()
116 const queryClient = new QueryClient({
117 queryCache,
118 defaultOptions: {
119 queries: {
120 gcTime: Infinity,
121 },
122 },
123 })
124​
125 function Page() {
126 const query = useQuery(() => ({
127 queryKey: key,
128 queryFn: async () => {
129 await sleep(10)
130 return 'test'
131 },
132 }))
133​
134 return (
135 <div>
136 <h1>{query.data}</h1>
137 </div>
138 )
139 }
140​
141 const rendered = render(() => (
142 <QueryClientProvider client={queryClient}>
143 <Page />
144 </QueryClientProvider>
145 ))
146​
147 await vi.advanceTimersByTimeAsync(10)
148 expect(rendered.getByText('test')).toBeInTheDocument()
149​
150 expect(queryCache.find({ queryKey: key })).toBeDefined()
151 expect(queryCache.find({ queryKey: key })?.options.gcTime).toBe(Infinity)
152 })
153​
154 describe('useQueryClient', () => {
155 it('should throw an error if no query client has been set', () => {
156 const consoleMock = vi
157 .spyOn(console, 'error')
158 .mockImplementation(() => undefined)
159​
160 function Page() {
161 useQueryClient()
162 return null
163 }
164​
165 expect(() => render(() => <Page />)).toThrow(
166 'No QueryClient set, use QueryClientProvider to set one',
167 )
168​
169 consoleMock.mockRestore()
170 })
171 })
172​
173 it('should not throw an error if user provides custom query client', () => {
174 const consoleMock = vi
175 .spyOn(console, 'error')
176 .mockImplementation(() => undefined)
177​
178 function Page() {
179 const client = new QueryClient()
180 useQueryClient(client)
181 return null
182 }
183​
184 render(() => <Page />)
185 expect(consoleMock).not.toHaveBeenCalled()
186​
187 consoleMock.mockRestore()
188 })
189})