Open History to see the last commit
1import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
2import { streamedQuery } from '../streamedQuery'
3import { QueryObserver } from '..'
4import { createQueryClient, queryKey, sleep } from './utils'
5import type { QueryClient } from '..'
6β
7describe('streamedQuery', () => {
8 let queryClient: QueryClient
9β
10 beforeEach(() => {
11 vi.useFakeTimers()
12 queryClient = createQueryClient()
13 queryClient.mount()
14 })
15β
16 afterEach(() => {
17 queryClient.clear()
18 vi.useRealTimers()
19 })
20β
21 function createAsyncNumberGenerator(amount: number) {
22 return {
23 async *[Symbol.asyncIterator]() {
24 let num = 0
25 while (num < amount) {
26 await sleep(50)
27 yield num++
28 }
29 },
30 }
31 }
32β
33 test('should stream data from an AsyncIterable', async () => {
34 const key = queryKey()
35 const observer = new QueryObserver(queryClient, {
36 queryKey: key,
37 queryFn: streamedQuery({
38 queryFn: () => createAsyncNumberGenerator(3),
39 }),
40 })
41β
42 const unsubscribe = observer.subscribe(vi.fn())
43β
44 expect(observer.getCurrentResult()).toMatchObject({
45 status: 'pending',
46 fetchStatus: 'fetching',
47 data: undefined,
48 })
49β
50 await vi.advanceTimersByTimeAsync(50)
51β
52 expect(observer.getCurrentResult()).toMatchObject({
53 status: 'success',
54 fetchStatus: 'fetching',
55 data: [0],
56 })
57β
58 await vi.advanceTimersByTimeAsync(50)
59β
60 expect(observer.getCurrentResult()).toMatchObject({
61 status: 'success',
62 fetchStatus: 'fetching',
63 data: [0, 1],
64 })
65β
66 await vi.advanceTimersByTimeAsync(50)
67β
68 expect(observer.getCurrentResult()).toMatchObject({
69 status: 'success',
70 fetchStatus: 'idle',
71 data: [0, 1, 2],
72 })
73β
74 unsubscribe()
75 })
76β
77 test('should replace on refetch', async () => {
78 const key = queryKey()
79 const observer = new QueryObserver(queryClient, {
80 queryKey: key,
81 queryFn: streamedQuery({
82 queryFn: () => createAsyncNumberGenerator(2),
83 }),
84 })
85β
86 const unsubscribe = observer.subscribe(vi.fn())
87β
88 expect(observer.getCurrentResult()).toMatchObject({
89 status: 'pending',
90 fetchStatus: 'fetching',
91 data: undefined,
92 })
93β
94 await vi.advanceTimersByTimeAsync(100)
95β
96 expect(observer.getCurrentResult()).toMatchObject({
97 status: 'success',
98 fetchStatus: 'idle',
99 data: [0, 1],
100 })
101β
102 void observer.refetch()
103β
104 await vi.advanceTimersByTimeAsync(10)
105β
106 expect(observer.getCurrentResult()).toMatchObject({
107 status: 'pending',
108 fetchStatus: 'fetching',
109 data: undefined,
110 })
111β
112 await vi.advanceTimersByTimeAsync(40)
113β
114 expect(observer.getCurrentResult()).toMatchObject({
115 status: 'success',
116 fetchStatus: 'fetching',
117 data: [0],
118 })
119β
120 await vi.advanceTimersByTimeAsync(50)
121β
122 expect(observer.getCurrentResult()).toMatchObject({
123 status: 'success',
124 fetchStatus: 'idle',
125 data: [0, 1],
126 })
127β
128 unsubscribe()
129 })
130β
131 test('should support refetchMode append', async () => {
132 const key = queryKey()
133 const observer = new QueryObserver(queryClient, {
134 queryKey: key,
135 queryFn: streamedQuery({
136 queryFn: () => createAsyncNumberGenerator(2),
137 refetchMode: 'append',
138 }),
139 })
140β
141 const unsubscribe = observer.subscribe(vi.fn())
142β
143 expect(observer.getCurrentResult()).toMatchObject({
144 status: 'pending',
145 fetchStatus: 'fetching',
146 data: undefined,
147 })
148β
149 await vi.advanceTimersByTimeAsync(100)
150β
151 expect(observer.getCurrentResult()).toMatchObject({
152 status: 'success',
153 fetchStatus: 'idle',
154 data: [0, 1],
155 })
156β
157 void observer.refetch()
158β
159 await vi.advanceTimersByTimeAsync(10)
160β
161 expect(observer.getCurrentResult()).toMatchObject({
162 status: 'success',
163 fetchStatus: 'fetching',
164 data: [0, 1],
165 })
166β
167 await vi.advanceTimersByTimeAsync(40)
168β
169 expect(observer.getCurrentResult()).toMatchObject({
170 status: 'success',
171 fetchStatus: 'fetching',
172 data: [0, 1, 0],
173 })
174β
175 await vi.advanceTimersByTimeAsync(50)
176β
177 expect(observer.getCurrentResult()).toMatchObject({
178 status: 'success',
179 fetchStatus: 'idle',
180 data: [0, 1, 0, 1],
181 })
182β
183 unsubscribe()
184 })
185β
186 test('should abort ongoing stream when refetch happens', async () => {
187 const key = queryKey()
188 const observer = new QueryObserver(queryClient, {
189 queryKey: key,
190 queryFn: streamedQuery({
191 queryFn: () => createAsyncNumberGenerator(3),
192 refetchMode: 'append',
193 }),
194 })
195β
196 const unsubscribe = observer.subscribe(vi.fn())
197β
198 expect(observer.getCurrentResult()).toMatchObject({
199 status: 'pending',
200 fetchStatus: 'fetching',
201 data: undefined,
202 })
203β
204 await vi.advanceTimersByTimeAsync(100)
205β
206 expect(observer.getCurrentResult()).toMatchObject({
207 status: 'success',
208 fetchStatus: 'fetching',
209 data: [0, 1],
210 })
211β
212 void observer.refetch()
213β
214 await vi.advanceTimersByTimeAsync(10)
215β
216 expect(observer.getCurrentResult()).toMatchObject({
217 status: 'success',
218 fetchStatus: 'fetching',
219 data: [0, 1],
220 })
221β
222 await vi.advanceTimersByTimeAsync(40)
223β
224 expect(observer.getCurrentResult()).toMatchObject({
225 status: 'success',
226 fetchStatus: 'fetching',
227 data: [0, 1, 0],
228 })
229β
230 await vi.advanceTimersByTimeAsync(100)
231β
232 expect(observer.getCurrentResult()).toMatchObject({
233 status: 'success',
234 fetchStatus: 'idle',
235 data: [0, 1, 0, 1, 2],
236 })
237β
238 unsubscribe()
239 })
240})