1 | import {
|
2 | configureStore,
|
3 | createAction,
|
4 | createSlice,
|
5 | isAnyOf,
|
6 | } from '@reduxjs/toolkit'
|
7 |
|
8 | import type { AnyAction, PayloadAction, Action } from '@reduxjs/toolkit'
|
9 |
|
10 | import { createListenerMiddleware, TaskAbortError } from '../index'
|
11 |
|
12 | import type { TypedAddListener } from '../index'
|
13 |
|
14 | describe('Saga-style Effects Scenarios', () => {
|
15 | interface CounterState {
|
16 | value: number
|
17 | }
|
18 |
|
19 | const counterSlice = createSlice({
|
20 | name: 'counter',
|
21 | initialState: { value: 0 } as CounterState,
|
22 | reducers: {
|
23 | increment(state) {
|
24 | state.value += 1
|
25 | },
|
26 | decrement(state) {
|
27 | state.value -= 1
|
28 | },
|
29 |
|
30 | incrementByAmount: (state, action: PayloadAction<number>) => {
|
31 | state.value += action.payload
|
32 | },
|
33 | },
|
34 | })
|
35 | const { increment, decrement, incrementByAmount } = counterSlice.actions
|
36 |
|
37 | let { reducer } = counterSlice
|
38 | let listenerMiddleware = createListenerMiddleware<CounterState>()
|
39 | let { middleware, startListening, stopListening } = listenerMiddleware
|
40 |
|
41 | let store = configureStore({
|
42 | reducer,
|
43 | middleware: (gDM) => gDM().prepend(middleware),
|
44 | })
|
45 |
|
46 | const testAction1 = createAction<string>('testAction1')
|
47 | type TestAction1 = ReturnType<typeof testAction1>
|
48 | const testAction2 = createAction<string>('testAction2')
|
49 | type TestAction2 = ReturnType<typeof testAction2>
|
50 | const testAction3 = createAction<string>('testAction3')
|
51 | type TestAction3 = ReturnType<typeof testAction3>
|
52 |
|
53 | type RootState = ReturnType<typeof store.getState>
|
54 |
|
55 | function delay(ms: number) {
|
56 | return new Promise((resolve) => setTimeout(resolve, ms))
|
57 | }
|
58 |
|
59 | beforeAll(() => {
|
60 | const noop = () => {}
|
61 | jest.spyOn(console, 'error').mockImplementation(noop)
|
62 | })
|
63 |
|
64 | beforeEach(() => {
|
65 | listenerMiddleware = createListenerMiddleware<CounterState>()
|
66 | middleware = listenerMiddleware.middleware
|
67 | startListening = listenerMiddleware.startListening
|
68 | store = configureStore({
|
69 | reducer,
|
70 | middleware: (gDM) => gDM().prepend(middleware),
|
71 | })
|
72 | })
|
73 |
|
74 | test('throttle', async () => {
|
75 |
|
76 |
|
77 |
|
78 | let listenerCalls = 0
|
79 | let workPerformed = 0
|
80 |
|
81 | startListening({
|
82 | actionCreator: increment,
|
83 | effect: (action, listenerApi) => {
|
84 | listenerCalls++
|
85 |
|
86 |
|
87 | listenerApi.unsubscribe()
|
88 |
|
89 |
|
90 | setTimeout(listenerApi.subscribe, 15)
|
91 | workPerformed++
|
92 | },
|
93 | })
|
94 |
|
95 |
|
96 | store.dispatch(increment())
|
97 | store.dispatch(increment())
|
98 | store.dispatch(increment())
|
99 |
|
100 |
|
101 | await delay(25)
|
102 |
|
103 |
|
104 | store.dispatch(increment())
|
105 | store.dispatch(increment())
|
106 |
|
107 |
|
108 | await delay(5)
|
109 |
|
110 |
|
111 | expect(listenerCalls).toBe(2)
|
112 | expect(workPerformed).toBe(2)
|
113 | })
|
114 |
|
115 | test('debounce / takeLatest', async () => {
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 | let listenerCalls = 0
|
123 | let workPerformed = 0
|
124 |
|
125 | startListening({
|
126 | actionCreator: increment,
|
127 | effect: async (action, listenerApi) => {
|
128 | listenerCalls++
|
129 |
|
130 |
|
131 | listenerApi.cancelActiveListeners()
|
132 |
|
133 |
|
134 | await listenerApi.delay(15)
|
135 |
|
136 | workPerformed++
|
137 | },
|
138 | })
|
139 |
|
140 |
|
141 | store.dispatch(increment())
|
142 |
|
143 | store.dispatch(increment())
|
144 |
|
145 | store.dispatch(increment())
|
146 |
|
147 |
|
148 | expect(listenerCalls).toBe(3)
|
149 | expect(workPerformed).toBe(0)
|
150 |
|
151 | await delay(25)
|
152 |
|
153 |
|
154 | expect(listenerCalls).toBe(3)
|
155 |
|
156 |
|
157 | expect(workPerformed).toBe(1)
|
158 | })
|
159 |
|
160 | test('takeEvery', async () => {
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 | let listenerCalls = 0
|
167 | startListening({
|
168 | actionCreator: increment,
|
169 | effect: (action, listenerApi) => {
|
170 | listenerCalls++
|
171 | },
|
172 | })
|
173 |
|
174 | store.dispatch(increment())
|
175 | expect(listenerCalls).toBe(1)
|
176 |
|
177 | store.dispatch(increment())
|
178 | expect(listenerCalls).toBe(2)
|
179 | })
|
180 |
|
181 | test('takeLeading', async () => {
|
182 |
|
183 |
|
184 |
|
185 | let listenerCalls = 0
|
186 | let workPerformed = 0
|
187 |
|
188 | startListening({
|
189 | actionCreator: increment,
|
190 | effect: async (action, listenerApi) => {
|
191 | listenerCalls++
|
192 |
|
193 |
|
194 | listenerApi.unsubscribe()
|
195 |
|
196 |
|
197 | await listenerApi.delay(15)
|
198 |
|
199 | workPerformed++
|
200 |
|
201 |
|
202 | listenerApi.subscribe()
|
203 | },
|
204 | })
|
205 |
|
206 |
|
207 | store.dispatch(increment())
|
208 |
|
209 | store.dispatch(increment())
|
210 |
|
211 |
|
212 | expect(listenerCalls).toBe(1)
|
213 | expect(workPerformed).toBe(0)
|
214 |
|
215 | await delay(5)
|
216 |
|
217 |
|
218 | store.dispatch(increment())
|
219 |
|
220 |
|
221 | expect(listenerCalls).toBe(1)
|
222 | expect(workPerformed).toBe(0)
|
223 |
|
224 | await delay(20)
|
225 |
|
226 |
|
227 | expect(workPerformed).toBe(1)
|
228 |
|
229 |
|
230 | store.dispatch(increment())
|
231 |
|
232 | expect(listenerCalls).toBe(2)
|
233 | expect(workPerformed).toBe(1)
|
234 |
|
235 | await delay(20)
|
236 |
|
237 | expect(workPerformed).toBe(2)
|
238 | })
|
239 |
|
240 | test('fork + join', async () => {
|
241 |
|
242 |
|
243 |
|
244 |
|
245 | let childResult = 0
|
246 |
|
247 | startListening({
|
248 | actionCreator: increment,
|
249 | effect: async (_, listenerApi) => {
|
250 | const childOutput = 42
|
251 |
|
252 | const result = await listenerApi.fork(async () => {
|
253 |
|
254 | await listenerApi.delay(5)
|
255 |
|
256 | return childOutput
|
257 | }).result
|
258 |
|
259 |
|
260 | if (result.status === 'ok') {
|
261 | childResult = result.value
|
262 | }
|
263 | },
|
264 | })
|
265 |
|
266 | store.dispatch(increment())
|
267 |
|
268 | await delay(10)
|
269 | expect(childResult).toBe(42)
|
270 | })
|
271 |
|
272 | test('fork + cancel', async () => {
|
273 |
|
274 |
|
275 |
|
276 |
|
277 | let childResult = 0
|
278 | let listenerCompleted = false
|
279 |
|
280 | startListening({
|
281 | actionCreator: increment,
|
282 | effect: async (action, listenerApi) => {
|
283 |
|
284 | const forkedTask = listenerApi.fork(async () => {
|
285 |
|
286 | await listenerApi.delay(15)
|
287 |
|
288 | childResult = 42
|
289 |
|
290 | return 0
|
291 | })
|
292 |
|
293 | await listenerApi.delay(5)
|
294 | forkedTask.cancel()
|
295 | listenerCompleted = true
|
296 | },
|
297 | })
|
298 |
|
299 |
|
300 | store.dispatch(increment())
|
301 |
|
302 |
|
303 | await delay(20)
|
304 |
|
305 |
|
306 | expect(listenerCompleted).toBe(true)
|
307 | expect(childResult).toBe(0)
|
308 | })
|
309 |
|
310 | test('canceled', async () => {
|
311 |
|
312 |
|
313 |
|
314 | let canceledAndCaught = false
|
315 | let canceledCheck = false
|
316 |
|
317 | startListening({
|
318 | matcher: isAnyOf(increment, decrement, incrementByAmount),
|
319 | effect: async (action, listenerApi) => {
|
320 | if (increment.match(action)) {
|
321 |
|
322 | try {
|
323 | await listenerApi.delay(10)
|
324 | } catch (err) {
|
325 |
|
326 | if (err instanceof TaskAbortError) {
|
327 | canceledAndCaught = true
|
328 | }
|
329 | }
|
330 | } else if (incrementByAmount.match(action)) {
|
331 |
|
332 | await delay(15)
|
333 | if (listenerApi.signal.aborted) {
|
334 | canceledCheck = true
|
335 | }
|
336 | } else if (decrement.match(action)) {
|
337 | listenerApi.cancelActiveListeners()
|
338 | }
|
339 | },
|
340 | })
|
341 |
|
342 |
|
343 | store.dispatch(increment())
|
344 |
|
345 | store.dispatch(decrement())
|
346 |
|
347 |
|
348 |
|
349 | await delay(15)
|
350 |
|
351 | expect(canceledAndCaught).toBe(true)
|
352 |
|
353 |
|
354 | store.dispatch(incrementByAmount(42))
|
355 |
|
356 | store.dispatch(decrement())
|
357 |
|
358 | expect(canceledCheck).toBe(false)
|
359 |
|
360 | await delay(20)
|
361 |
|
362 | expect(canceledCheck).toBe(true)
|
363 | })
|
364 | })
|