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

QueryClientProvider.test.tsx

160 lines3.8 KB

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