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

QueryClientProvider.test.tsx

163 lines3.9 KB

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