Skip to content

Commit afe8c65

Browse files
TkDodoTkDodo
committed
refactor: make listeners required
because the only place where we pass no listener in is in tests
1 parent e200bf7 commit afe8c65

File tree

8 files changed

+48
-50
lines changed

8 files changed

+48
-50
lines changed

‎src/core/subscribable.ts‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ export class Subscribable<TListener extends Function = Listener> {
77
this.listeners = []
88
}
99

10-
subscribe(listener?: TListener): () => void {
11-
const callback = listener || (() => undefined)
12-
13-
this.listeners.push(callback as TListener)
10+
subscribe(listener: TListener): () => void {
11+
this.listeners.push(listener as TListener)
1412

1513
this.onSubscribe()
1614

1715
return () => {
18-
this.listeners = this.listeners.filter(x => x !== callback)
16+
this.listeners = this.listeners.filter(x => x !== listener)
1917
this.onUnsubscribe()
2018
}
2119
}

‎src/core/tests/focusManager.test.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ describe('focusManager', () => {
6969

7070
const setEventListenerSpy = jest.spyOn(focusManager, 'setEventListener')
7171

72-
const unsubscribe = focusManager.subscribe()
72+
const unsubscribe = focusManager.subscribe(() => undefined)
7373
expect(setEventListenerSpy).toHaveBeenCalledTimes(0)
7474

7575
unsubscribe()
@@ -88,7 +88,7 @@ describe('focusManager', () => {
8888
)
8989

9090
// Should set the default event listener with window event listeners
91-
const unsubscribe = focusManager.subscribe()
91+
const unsubscribe = focusManager.subscribe(() => undefined)
9292
expect(addEventListenerSpy).toHaveBeenCalledTimes(2)
9393

9494
// Should replace the window default event listener by a new one

‎src/core/tests/mutationCache.test.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ describe('mutationCache', () => {
164164
cacheTime: 10,
165165
mutationFn: () => Promise.resolve(),
166166
})
167-
const unsubscribe = observer.subscribe()
167+
const unsubscribe = observer.subscribe(() => undefined)
168168

169169
expect(queryClient.getMutationCache().getAll()).toHaveLength(0)
170170
observer.mutate(1)
@@ -231,7 +231,7 @@ describe('mutationCache', () => {
231231
},
232232
onSuccess,
233233
})
234-
const unsubscribe = observer.subscribe()
234+
const unsubscribe = observer.subscribe(() => undefined)
235235
observer.mutate(1)
236236
unsubscribe()
237237
expect(queryClient.getMutationCache().getAll()).toHaveLength(1)
@@ -257,7 +257,7 @@ describe('mutationCache', () => {
257257
},
258258
onSuccess,
259259
})
260-
const unsubscribe = observer.subscribe()
260+
const unsubscribe = observer.subscribe(() => undefined)
261261
observer.mutate(1)
262262
unsubscribe()
263263
await waitFor(() => {

‎src/core/tests/onlineManager.test.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ describe('onlineManager', () => {
6464

6565
const setEventListenerSpy = jest.spyOn(onlineManager, 'setEventListener')
6666

67-
const unsubscribe = onlineManager.subscribe()
67+
const unsubscribe = onlineManager.subscribe(() => undefined)
6868
expect(setEventListenerSpy).toHaveBeenCalledTimes(0)
6969

7070
unsubscribe()
@@ -83,7 +83,7 @@ describe('onlineManager', () => {
8383
)
8484

8585
// Should set the default event listener with window event listeners
86-
const unsubscribe = onlineManager.subscribe()
86+
const unsubscribe = onlineManager.subscribe(() => undefined)
8787
expect(addEventListenerSpy).toHaveBeenCalledTimes(2)
8888

8989
// Should replace the window default event listener by a new one

‎src/core/tests/queriesObserver.test.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ describe('queriesObserver', () => {
248248
{ queryKey: key1, queryFn: queryFn1 },
249249
{ queryKey: key2, queryFn: queryFn2 },
250250
])
251-
const unsubscribe = observer.subscribe()
251+
const unsubscribe = observer.subscribe(() => undefined)
252252
await sleep(1)
253253
unsubscribe()
254254
expect(queryFn1).toHaveBeenCalledTimes(1)

‎src/core/tests/query.test.tsx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ describe('query', () => {
224224
queryKey: key,
225225
enabled: false,
226226
})
227-
const unsubscribe = observer.subscribe()
227+
const unsubscribe = observer.subscribe(() => undefined)
228228
unsubscribe()
229229

230230
await sleep(100)
@@ -253,7 +253,7 @@ describe('query', () => {
253253
queryKey: key,
254254
enabled: false,
255255
})
256-
const unsubscribe = observer.subscribe()
256+
const unsubscribe = observer.subscribe(() => undefined)
257257
unsubscribe()
258258

259259
await sleep(100)
@@ -484,10 +484,10 @@ describe('query', () => {
484484
cacheTime: 0,
485485
staleTime: Infinity,
486486
})
487-
const unsubscribe1 = observer.subscribe()
487+
const unsubscribe1 = observer.subscribe(() => undefined)
488488
unsubscribe1()
489489
await waitFor(() => expect(queryCache.find(key)).toBeUndefined())
490-
const unsubscribe2 = observer.subscribe()
490+
const unsubscribe2 = observer.subscribe(() => undefined)
491491
unsubscribe2()
492492

493493
await waitFor(() => expect(queryCache.find(key)).toBeUndefined())
@@ -502,7 +502,7 @@ describe('query', () => {
502502
cacheTime: 0,
503503
})
504504
expect(queryCache.find(key)).toBeDefined()
505-
const unsubscribe = observer.subscribe()
505+
const unsubscribe = observer.subscribe(() => undefined)
506506
expect(queryCache.find(key)).toBeDefined()
507507
unsubscribe()
508508
await waitFor(() => expect(queryCache.find(key)).toBeUndefined())
@@ -518,7 +518,7 @@ describe('query', () => {
518518
},
519519
cacheTime: 10,
520520
})
521-
const unsubscribe = observer.subscribe()
521+
const unsubscribe = observer.subscribe(() => undefined)
522522
await sleep(20)
523523
expect(queryCache.find(key)).toBeDefined()
524524
observer.refetch()
@@ -539,7 +539,7 @@ describe('query', () => {
539539
cacheTime: 0,
540540
})
541541
expect(queryCache.find(key)).toBeDefined()
542-
const unsubscribe = observer.subscribe()
542+
const unsubscribe = observer.subscribe(() => undefined)
543543
await sleep(100)
544544
expect(queryCache.find(key)).toBeDefined()
545545
unsubscribe()
@@ -560,9 +560,9 @@ describe('query', () => {
560560

561561
expect(query?.getObserversCount()).toEqual(0)
562562

563-
const unsubscribe1 = observer.subscribe()
564-
const unsubscribe2 = observer2.subscribe()
565-
const unsubscribe3 = observer3.subscribe()
563+
const unsubscribe1 = observer.subscribe(() => undefined)
564+
const unsubscribe2 = observer2.subscribe(() => undefined)
565+
const unsubscribe3 = observer3.subscribe(() => undefined)
566566
expect(query?.getObserversCount()).toEqual(3)
567567

568568
unsubscribe3()
@@ -658,7 +658,7 @@ describe('query', () => {
658658
})
659659

660660
const refetchSpy = jest.spyOn(observer, 'refetch')
661-
const unsubscribe = observer.subscribe()
661+
const unsubscribe = observer.subscribe(() => undefined)
662662
queryCache.onOnline()
663663

664664
// Should refetch the observer
@@ -821,7 +821,7 @@ describe('query', () => {
821821
retry: false,
822822
})
823823

824-
const unsubscribe = observer.subscribe()
824+
const unsubscribe = observer.subscribe(() => undefined)
825825
await sleep(10)
826826
expect(consoleMock).toHaveBeenCalledWith('Missing queryFn')
827827

‎src/core/tests/queryClient.test.tsx‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -722,8 +722,8 @@ describe('queryClient', () => {
722722
queryKey: key1,
723723
enabled: false,
724724
})
725-
observer1.subscribe()
726-
observer2.subscribe()
725+
observer1.subscribe(() => undefined)
726+
observer2.subscribe(() => undefined)
727727
await queryClient.refetchQueries()
728728
observer1.destroy()
729729
observer2.destroy()
@@ -743,7 +743,7 @@ describe('queryClient', () => {
743743
queryFn: queryFn1,
744744
staleTime: Infinity,
745745
})
746-
const unsubscribe = observer.subscribe()
746+
const unsubscribe = observer.subscribe(() => undefined)
747747
await queryClient.refetchQueries({ type: 'active', stale: false })
748748
unsubscribe()
749749
expect(queryFn1).toHaveBeenCalledTimes(2)
@@ -761,7 +761,7 @@ describe('queryClient', () => {
761761
queryKey: key1,
762762
queryFn: queryFn1,
763763
})
764-
const unsubscribe = observer.subscribe()
764+
const unsubscribe = observer.subscribe(() => undefined)
765765
queryClient.invalidateQueries(key1)
766766
await queryClient.refetchQueries({ stale: true })
767767
unsubscribe()
@@ -782,7 +782,7 @@ describe('queryClient', () => {
782782
queryKey: key1,
783783
queryFn: queryFn1,
784784
})
785-
const unsubscribe = observer.subscribe()
785+
const unsubscribe = observer.subscribe(() => undefined)
786786
await queryClient.refetchQueries(
787787
{ type: 'active', stale: true },
788788
{ cancelRefetch: false }
@@ -804,7 +804,7 @@ describe('queryClient', () => {
804804
queryFn: queryFn1,
805805
staleTime: Infinity,
806806
})
807-
const unsubscribe = observer.subscribe()
807+
const unsubscribe = observer.subscribe(() => undefined)
808808
await queryClient.refetchQueries()
809809
unsubscribe()
810810
expect(queryFn1).toHaveBeenCalledTimes(2)
@@ -823,7 +823,7 @@ describe('queryClient', () => {
823823
queryFn: queryFn1,
824824
staleTime: Infinity,
825825
})
826-
const unsubscribe = observer.subscribe()
826+
const unsubscribe = observer.subscribe(() => undefined)
827827
await queryClient.refetchQueries({ type: 'all' })
828828
unsubscribe()
829829
expect(queryFn1).toHaveBeenCalledTimes(2)
@@ -842,7 +842,7 @@ describe('queryClient', () => {
842842
queryFn: queryFn1,
843843
staleTime: Infinity,
844844
})
845-
const unsubscribe = observer.subscribe()
845+
const unsubscribe = observer.subscribe(() => undefined)
846846
await queryClient.refetchQueries({ type: 'active' })
847847
unsubscribe()
848848
expect(queryFn1).toHaveBeenCalledTimes(2)
@@ -861,7 +861,7 @@ describe('queryClient', () => {
861861
queryFn: queryFn1,
862862
staleTime: Infinity,
863863
})
864-
const unsubscribe = observer.subscribe()
864+
const unsubscribe = observer.subscribe(() => undefined)
865865
await queryClient.refetchQueries({ type: 'inactive' })
866866
unsubscribe()
867867
expect(queryFn1).toHaveBeenCalledTimes(1)
@@ -906,7 +906,7 @@ describe('queryClient', () => {
906906
queryFn: queryFn1,
907907
staleTime: Infinity,
908908
})
909-
const unsubscribe = observer.subscribe()
909+
const unsubscribe = observer.subscribe(() => undefined)
910910
queryClient.invalidateQueries(key1)
911911
unsubscribe()
912912
expect(queryFn1).toHaveBeenCalledTimes(2)
@@ -925,7 +925,7 @@ describe('queryClient', () => {
925925
enabled: false,
926926
staleTime: Infinity,
927927
})
928-
const unsubscribe = observer.subscribe()
928+
const unsubscribe = observer.subscribe(() => undefined)
929929
queryClient.invalidateQueries(key1)
930930
unsubscribe()
931931
expect(queryFn1).toHaveBeenCalledTimes(1)
@@ -944,7 +944,7 @@ describe('queryClient', () => {
944944
queryFn: queryFn1,
945945
staleTime: Infinity,
946946
})
947-
const unsubscribe = observer.subscribe()
947+
const unsubscribe = observer.subscribe(() => undefined)
948948
queryClient.invalidateQueries(key1, {
949949
refetchType: 'none',
950950
})
@@ -966,7 +966,7 @@ describe('queryClient', () => {
966966
staleTime: Infinity,
967967
enabled: false,
968968
})
969-
const unsubscribe = observer.subscribe()
969+
const unsubscribe = observer.subscribe(() => undefined)
970970
queryClient.invalidateQueries(key1, {
971971
refetchType: 'inactive',
972972
})
@@ -987,7 +987,7 @@ describe('queryClient', () => {
987987
queryFn: queryFn1,
988988
staleTime: Infinity,
989989
})
990-
const unsubscribe = observer.subscribe()
990+
const unsubscribe = observer.subscribe(() => undefined)
991991
queryClient.invalidateQueries({
992992
refetchType: 'all',
993993
})
@@ -1005,7 +1005,7 @@ describe('queryClient', () => {
10051005
enabled: false,
10061006
initialData: 1,
10071007
})
1008-
observer.subscribe()
1008+
observer.subscribe(() => undefined)
10091009

10101010
queryClient.fetchQuery(key, ({ signal }) => {
10111011
const promise = new Promise(resolve => {
@@ -1036,7 +1036,7 @@ describe('queryClient', () => {
10361036
enabled: false,
10371037
initialData: 1,
10381038
})
1039-
observer.subscribe()
1039+
observer.subscribe(() => undefined)
10401040

10411041
queryClient.fetchQuery(key, ({ signal }) => {
10421042
const promise = new Promise(resolve => {
@@ -1125,8 +1125,8 @@ describe('queryClient', () => {
11251125
queryFn: queryFn2,
11261126
enabled: false,
11271127
})
1128-
observer1.subscribe()
1129-
observer2.subscribe()
1128+
observer1.subscribe(() => undefined)
1129+
observer2.subscribe(() => undefined)
11301130
await queryClient.resetQueries()
11311131
observer2.destroy()
11321132
observer1.destroy()

‎src/core/tests/queryObserver.test.tsx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ describe('queryObserver', () => {
2727
const key = queryKey()
2828
const queryFn = jest.fn()
2929
const observer = new QueryObserver(queryClient, { queryKey: key, queryFn })
30-
const unsubscribe = observer.subscribe()
30+
const unsubscribe = observer.subscribe(() => undefined)
3131
await sleep(1)
3232
unsubscribe()
3333
expect(queryFn).toHaveBeenCalledTimes(1)
@@ -315,7 +315,7 @@ describe('queryObserver', () => {
315315
queryFn,
316316
enabled: false,
317317
})
318-
const unsubscribe = observer.subscribe()
318+
const unsubscribe = observer.subscribe(() => undefined)
319319
await sleep(1)
320320
unsubscribe()
321321
expect(queryFn).toHaveBeenCalledTimes(0)
@@ -441,7 +441,7 @@ describe('queryObserver', () => {
441441
retry: 10,
442442
retryDelay: 50,
443443
})
444-
const unsubscribe = observer.subscribe()
444+
const unsubscribe = observer.subscribe(() => undefined)
445445
await sleep(70)
446446
unsubscribe()
447447
await sleep(200)
@@ -459,7 +459,7 @@ describe('queryObserver', () => {
459459
cacheTime: 0,
460460
refetchInterval: 1,
461461
})
462-
const unsubscribe = observer.subscribe()
462+
const unsubscribe = observer.subscribe(() => undefined)
463463
// @ts-expect-error
464464
expect(observer.refetchIntervalId).not.toBeUndefined()
465465
unsubscribe()
@@ -511,7 +511,7 @@ describe('queryObserver', () => {
511511
retryDelay: 20,
512512
})
513513

514-
const unsubscribe = observer.subscribe()
514+
const unsubscribe = observer.subscribe(() => undefined)
515515

516516
// Simulate a race condition when an unsubscribe and a retry occur.
517517
await sleep(20)
@@ -588,7 +588,7 @@ describe('queryObserver', () => {
588588
refetchInterval: 10,
589589
})
590590

591-
const unsubscribe = observer.subscribe()
591+
const unsubscribe = observer.subscribe(() => undefined)
592592
await sleep(30)
593593

594594
expect(queryFn).toHaveBeenCalledTimes(1)
@@ -610,7 +610,7 @@ describe('queryObserver', () => {
610610
select: () => data,
611611
})
612612

613-
const unsubscribe = observer.subscribe()
613+
const unsubscribe = observer.subscribe(() => undefined)
614614

615615
await sleep(10)
616616
expect(observer.getCurrentResult().data).toBe(data)

0 commit comments

Comments
 (0)