Open History to see the last commit
1import { describe, expect, it, vi } from 'vitest'
2import { render, waitFor } from '@solidjs/testing-library'
3import { QueryCache } from '@tanstack/query-core'
4import { QueryClientProvider, createQuery, useQueryClient } from '..'
5import { createQueryClient, queryKey, sleep } from './utils'
6β
7describe('QueryClientProvider', () => {
8 it('sets a specific cache for all queries to use', async () => {
9 const key = queryKey()
10β
11 const queryCache = new QueryCache()
12 const queryClient = createQueryClient({ queryCache })
13β
14 function Page() {
15 const query = createQuery(() => ({
16 queryKey: key,
17 queryFn: async () => {
18 await sleep(10)
19 return 'test'
20 },
21 }))
22β
23 return (
24 <div>
25 <h1>{query.data}</h1>
26 </div>
27 )
28 }
29β
30 const rendered = render(() => (
31 <QueryClientProvider client={queryClient}>
32 <Page />
33 </QueryClientProvider>
34 ))
35β
36 await waitFor(() => {
37 return rendered.getByText('test')
38 })
39β
40 expect(queryCache.find({ queryKey: key })).toBeDefined()
41 })
42β
43 it('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 query = createQuery(() => ({
55 queryKey: key1,
56 queryFn: async () => {
57 await sleep(10)
58 return 'test1'
59 },
60 }))
61β
62 return (
63 <div>
64 <h1>{query.data}</h1>
65 </div>
66 )
67 }
68 function Page2() {
69 const query = createQuery(() => ({
70 queryKey: key2,
71 queryFn: async () => {
72 await sleep(10)
73 return 'test2'
74 },
75 }))
76β
77 return (
78 <div>
79 <h1>{query.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 it("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 query = createQuery(() => ({
119 queryKey: key,
120 queryFn: async () => {
121 await sleep(10)
122 return 'test'
123 },
124 }))
125β
126 return (
127 <div>
128 <h1>{query.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 it('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β
164 it('should not throw an error if user provides custom query client', () => {
165 const consoleMock = vi
166 .spyOn(console, 'error')
167 .mockImplementation(() => undefined)
168β
169 function Page() {
170 const client = createQueryClient()
171 useQueryClient(client)
172 return null
173 }
174β
175 render(() => <Page />)
176 expect(consoleMock).not.toHaveBeenCalled()
177β
178 consoleMock.mockRestore()
179 })
180})