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

utils.tsx

111 lines2.7 KB

1import { vi } from 'vitest'
2import * as React from 'react'
3import { act, render } from '@testing-library/react'
4import * as utils from '@tanstack/query-core'
5import { QueryClient, QueryClientProvider, onlineManager } from '..'
6import type { QueryClientConfig } from '..'
7import type { SpyInstance } from 'vitest'
8​
9export function renderWithClient(
10 client: QueryClient,
11 ui: React.ReactElement,
12): ReturnType<typeof render> {
13 const { rerender, ...result } = render(
14 <QueryClientProvider client={client}>{ui}</QueryClientProvider>,
15 )
16 return {
17 ...result,
18 rerender: (rerenderUi: React.ReactElement) =>
19 rerender(
20 <QueryClientProvider client={client}>{rerenderUi}</QueryClientProvider>,
21 ),
22 } as any
24​
25export const Blink = ({
26 duration,
27 children,
28}: {
29 duration: number
30 children: React.ReactNode
31}) => {
32 const [shouldShow, setShouldShow] = React.useState<boolean>(true)
33​
34 React.useEffect(() => {
35 setShouldShow(true)
36 const timeout = setActTimeout(() => setShouldShow(false), duration)
37 return () => {
38 clearTimeout(timeout)
39 }
40 }, [duration, children])
41​
42 return shouldShow ? <>{children}</> : <>off</>
44​
45export function createQueryClient(config?: QueryClientConfig): QueryClient {
46 return new QueryClient(config)
48​
49export function mockVisibilityState(
50 value: DocumentVisibilityState,
51): SpyInstance<[], DocumentVisibilityState> {
52 return vi.spyOn(document, 'visibilityState', 'get').mockReturnValue(value)
54​
55export function mockOnlineManagerIsOnline(
56 value: boolean,
57): SpyInstance<[], boolean> {
58 return vi.spyOn(onlineManager, 'isOnline').mockReturnValue(value)
60​
61let queryKeyCount = 0
62export function queryKey(): Array<string> {
63 queryKeyCount++
64 return [`query_${queryKeyCount}`]
66​
67export function sleep(timeout: number): Promise<void> {
68 return new Promise((resolve, _reject) => {
69 setTimeout(resolve, timeout)
70 })
72​
73export function setActTimeout(fn: () => void, ms?: number) {
74 return setTimeout(() => {
75 act(() => {
76 fn()
77 })
78 }, ms)
80​
81export type Equal<TTargetA, TTargetB> = (<T>() => T extends TTargetA
82 ? 1
83 : 2) extends <T>() => T extends TTargetB ? 1 : 2
84 ? true
85 : false
86​
87export type Expect<T extends true> = T
88​
89/**
90 * Assert the parameter is not typed as `any`
91 */
92export function expectTypeNotAny<T>(_: 0 extends 1 & T ? never : T): void {
93 return undefined
95​
96// This monkey-patches the isServer-value from utils,
97// so that we can pretend to be in a server environment
98export function setIsServer(isServer: boolean) {
99 const original = utils.isServer
100 Object.defineProperty(utils, 'isServer', {
101 get: () => isServer,
102 })
103​
104 return () => {
105 Object.defineProperty(utils, 'isServer', {
106 get: () => original,
107 })
108 }
110​
111export const doNotExecute = (_func: () => void) => true