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

QueryClientProvider.test.tsx

165 lines3.9 KB

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