Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

Activity.test.tsx

121 lines3.1 KB

1import { createKey, sleep } from '@tanstack/query-test-utils'
2import { act } from '@testing-library/react'
3import * as React from 'react'
4import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
5import {
6 QueryClient,
7 useQueries,
8 useQuery,
9 useSuspenseQueries,
10 useSuspenseQuery,
11} from '..'
12import { renderWithClient } from './utils'
13​
14type Options = {
15 queryKey: Array<string>
16 queryFn: () => Promise<string>
18​
19describe.each([
20 {
21 name: 'useQuery',
22 useTestQuery: (options: Options) => useQuery(options).data,
23 },
24 {
25 name: 'useSuspenseQuery',
26 useTestQuery: (options: Options) => useSuspenseQuery(options).data,
27 },
28 {
29 name: 'useQueries',
30 useTestQuery: (options: Options) =>
31 useQueries({ queries: [options] })[0].data,
32 },
33 {
34 name: 'useSuspenseQueries',
35 useTestQuery: (options: Options) =>
36 useSuspenseQueries({ queries: [options] })[0].data,
37 },
38])('$name with Activity', ({ useTestQuery }) => {
39 let queryClient: QueryClient
40​
41 beforeEach(() => {
42 vi.useFakeTimers()
43 queryClient = new QueryClient()
44 })
45​
46 afterEach(() => {
47 queryClient.clear()
48 vi.useRealTimers()
49 })
50​
51 it('should not fetch the old key when revealed after a hidden key change', async () => {
52 const key = createKey()
53 const fetched: Array<string> = []
54​
55 function Page({ filter }: { filter: string }) {
56 const data = useTestQuery({
57 queryKey: [...key, filter],
58 queryFn: async () => {
59 fetched.push(filter)
60 await sleep(10)
61 return filter
62 },
63 })
64​
65 return <p>data: {data}</p>
66 }
67​
68 function App({
69 mode,
70 filter,
71 }: {
72 mode: 'visible' | 'hidden'
73 filter: string
74 }) {
75 return (
76 <React.Activity mode={mode}>
77 <React.Suspense fallback="loading">
78 <Page filter={filter} />
79 </React.Suspense>
80 </React.Activity>
81 )
82 }
83​
84 const rendered = renderWithClient(
85 queryClient,
86 <App mode="visible" filter="a" />,
87 )
88 await act(() => vi.advanceTimersByTimeAsync(11))
89 expect(rendered.getByText('data: a')).toBeVisible()
90​
91 rendered.rerender(<App mode="hidden" filter="b" />)
92 // Hidden trees render without running effects. Also let suspense's minimum
93 // staleTime elapse so that subscribing to the old key would refetch it.
94 await act(() => vi.advanceTimersByTimeAsync(1100))
95 expect(
96 queryClient
97 .getQueryCache()
98 .find({ queryKey: [...key, 'a'] })!
99 .getObserversCount(),
100 ).toBe(0)
101 expect(
102 queryClient
103 .getQueryCache()
104 .find({ queryKey: [...key, 'b'] })!
105 .getObserversCount(),
106 ).toBe(0)
107​
108 rendered.rerender(<App mode="visible" filter="b" />)
109 await act(() => vi.advanceTimersByTimeAsync(50))
110​
111 expect(rendered.getByText('data: b')).toBeVisible()
112 expect(fetched).toContain('b')
113 expect(fetched.filter((filter) => filter === 'a')).toStrictEqual(['a'])
114 expect(
115 queryClient
116 .getQueryCache()
117 .find({ queryKey: [...key, 'b'] })!
118 .getObserversCount(),
119 ).toBe(1)
120 })
121})