Open History to see the last commit
1import * as React from 'react'
2import { act, render } from '@testing-library/react'
3import * as utils from '@tanstack/query-core'
4import { QueryClient, QueryClientProvider } from '..'
5import type { ContextOptions, MutationOptions, QueryClientConfig } from '..'
6β
7export const doNotExecute = (_func: () => void) => true
8β
9export function renderWithClient(
10 client: QueryClient,
11 ui: React.ReactElement,
12 options: ContextOptions = {},
13): ReturnType<typeof render> {
14 const { rerender, ...result } = render(
15 <QueryClientProvider client={client} context={options.context}>
16 {ui}
17 </QueryClientProvider>,
18 )
19 return {
20 ...result,
21 rerender: (rerenderUi: React.ReactElement) =>
22 rerender(
23 <QueryClientProvider client={client} context={options.context}>
24 {rerenderUi}
25 </QueryClientProvider>,
26 ),
27 } as any
28}
29β
30export const Blink = ({
31 duration,
32 children,
33}: {
34 duration: number
35 children: React.ReactNode
36}) => {
37 const [shouldShow, setShouldShow] = React.useState<boolean>(true)
38β
39 React.useEffect(() => {
40 setShouldShow(true)
41 const timeout = setActTimeout(() => setShouldShow(false), duration)
42 return () => {
43 clearTimeout(timeout)
44 }
45 }, [duration, children])
46β
47 return shouldShow ? <>{children}</> : <>off</>
48}
49β
50export function createQueryClient(config?: QueryClientConfig): QueryClient {
51 jest.spyOn(console, 'error').mockImplementation(() => undefined)
52 return new QueryClient({ logger: mockLogger, ...config })
53}
54β
55export function mockVisibilityState(value: DocumentVisibilityState) {
56 return jest.spyOn(document, 'visibilityState', 'get').mockReturnValue(value)
57}
58β
59export function mockNavigatorOnLine(value: boolean) {
60 return jest.spyOn(navigator, 'onLine', 'get').mockReturnValue(value)
61}
62β
63export const mockLogger = {
64 log: jest.fn(),
65 warn: jest.fn(),
66 error: jest.fn(),
67}
68β
69let queryKeyCount = 0
70export function queryKey(): Array<string> {
71 queryKeyCount++
72 return [`query_${queryKeyCount}`]
73}
74β
75export function sleep(timeout: number): Promise<void> {
76 return new Promise((resolve, _reject) => {
77 setTimeout(resolve, timeout)
78 })
79}
80β
81export function setActTimeout(fn: () => void, ms?: number) {
82 return setTimeout(() => {
83 act(() => {
84 fn()
85 })
86 }, ms)
87}
88β
89/**
90 * Assert the parameter is of a specific type.
91 */
92export function expectType<T>(_: T): void {
93 return undefined
94}
95β
96/**
97 * Assert the parameter is not typed as `any`
98 */
99export function expectTypeNotAny<T>(_: 0 extends 1 & T ? never : T): void {
100 return undefined
101}
102β
103export function executeMutation(
104 queryClient: QueryClient,
105 options: MutationOptions<any, any, any, any>,
106): Promise<unknown> {
107 return queryClient.getMutationCache().build(queryClient, options).execute()
108}
109β
110// This monkey-patches the isServer-value from utils,
111// so that we can pretend to be in a server environment
112export function setIsServer(isServer: boolean) {
113 const original = utils.isServer
114 Object.defineProperty(utils, 'isServer', {
115 get: () => isServer,
116 })
117β
118 return () => {
119 Object.defineProperty(utils, 'isServer', {
120 get: () => original,
121 })
122 }
123}
124β
125export function reactVersion() {
126 const version = (process.env.REACTJS_VERSION || '19') as '17' | '18' | '19'
127 return version
128}