Open History to see the last commit
1import { createKey, sleep } from '@tanstack/query-test-utils'
2import { render } from '@testing-library/react'
3import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
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 it('should set a specific cache for all queries to use', async () => {
22 const key = createKey()
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 })?.state.data).toBe('test')
50 })
51β
52 it('should allow multiple caches to be partitioned', async () => {
53 const key1 = createKey()
54 const key2 = createKey()
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 })?.state.data).toBe('test1')
103 expect(queryCache1.find({ queryKey: key2 })).toBeUndefined()
104 expect(queryCache2.find({ queryKey: key1 })).toBeUndefined()
105 expect(queryCache2.find({ queryKey: key2 })?.state.data).toBe('test2')
106 })
107β
108 it("should use defaultOptions for queries when they don't provide their own config", async () => {
109 const key = createKey()
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 })?.options.gcTime).toBe(Infinity)
144 })
145β
146 describe('useQueryClient', () => {
147 it('should throw an error if no query client has been set', () => {
148 vi.spyOn(console, 'error').mockReturnValue(undefined)
149β
150 function Page() {
151 useQueryClient()
152 return null
153 }
154β
155 expect(() => render(<Page />)).toThrow(
156 'No QueryClient set, use QueryClientProvider to set one',
157 )
158 })
159 })
160})