import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' import { fireEvent, render } from '@solidjs/testing-library' import { ErrorBoundary, Show, Suspense, createRenderEffect, createSignal, on, } from 'solid-js' import { queryKey, sleep } from '@tanstack/query-test-utils' import { QueryCache, QueryClient, QueryClientProvider, useInfiniteQuery, useQuery, } from '..' import type { InfiniteData, UseInfiniteQueryResult, UseQueryResult } from '..' describe("useQuery's in Suspense mode", () => { beforeEach(() => { vi.useFakeTimers() }) afterEach(() => { vi.useRealTimers() }) const queryCache = new QueryCache() const queryClient = new QueryClient({ queryCache }) it('should render the correct amount of times in Suspense mode', async () => { const key = queryKey() const states: Array> = [] let count = 0 let renders = 0 function Page() { const [stateKey, setStateKey] = createSignal(key) const state = useQuery(() => ({ queryKey: stateKey(), queryFn: () => sleep(10).then(() => ++count), })) createRenderEffect(() => { states.push({ ...state }) }) createRenderEffect( on([() => ({ ...state }), () => key], () => { renders++ }), ) return (
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('data: 1')).toBeInTheDocument() fireEvent.click(rendered.getByLabelText('toggle')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('data: 2')).toBeInTheDocument() expect(renders).toBe(4) expect(states.length).toBe(4) expect(states[1]).toMatchObject({ data: 1, status: 'success' }) expect(states[3]).toMatchObject({ data: 2, status: 'success' }) }) it('should return the correct states for a successful infinite query', async () => { const key = queryKey() const states: Array>> = [] function Page() { const [multiplier, setMultiplier] = createSignal(1) const state = useInfiniteQuery(() => ({ queryKey: [`${key}_${multiplier()}`], queryFn: ({ pageParam }) => sleep(10).then(() => pageParam * multiplier()), initialPageParam: 1, suspense: true, getNextPageParam: (lastPage) => lastPage + 1, })) createRenderEffect(() => { states.push({ ...state }) }) return (
data: {state.data?.pages.join(',')}
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('data: 1')).toBeInTheDocument() // eslint-disable-next-line cspell/spellchecker // TODO(lukemurray): in react this is 1 in solid this is 2 because suspense // occurs on read. expect(states.length).toBe(2) expect(states[1]).toMatchObject({ data: { pages: [1], pageParams: [1] }, status: 'success', }) fireEvent.click(rendered.getByText('next')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('data: 2')).toBeInTheDocument() // eslint-disable-next-line cspell/spellchecker // TODO(lukemurray): in react this is 2 and in solid it is 4 expect(states.length).toBe(4) expect(states[3]).toMatchObject({ data: { pages: [2], pageParams: [1] }, status: 'success', }) }) it('should not call the queryFn twice when used in Suspense mode', async () => { const key = queryKey() const queryFn = vi.fn(() => sleep(10).then(() => 'data')) function Page() { useQuery(() => ({ queryKey: [key], queryFn, suspense: true, })) return <>rendered } const rendered = render(() => ( )) expect(rendered.getByText('rendered')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(20) expect(queryFn).toHaveBeenCalledTimes(1) }) it('should remove query instance when component unmounted', async () => { const key = queryKey() function Page() { useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => 'data'), })) return <>rendered } function App() { const [show, setShow] = createSignal(false) return ( <> {show() && } )} > )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(100) expect(rendered.getByText('error boundary')).toBeInTheDocument() expect(rendered.getByText('retry')).toBeInTheDocument() fireEvent.click(rendered.getByText('retry')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('rendered')).toBeInTheDocument() }) it('should retry fetch if the reset error boundary has been reset', async () => { const key = queryKey() let succeed = false function Page() { const state = useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => { if (!succeed) throw new Error('Suspense Error Bingo') return 'data' }), retry: false, suspense: true, })) // Suspense only triggers if used in JSX return (
rendered
) } const rendered = render(() => ( (
error boundary
)} >
)) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() expect(rendered.getByText('retry')).toBeInTheDocument() fireEvent.click(rendered.getByText('retry')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() expect(rendered.getByText('retry')).toBeInTheDocument() succeed = true fireEvent.click(rendered.getByText('retry')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('rendered')).toBeInTheDocument() }) it('should refetch when re-mounting', async () => { const key = queryKey() let count = 0 function Component() { const result = useQuery(() => ({ queryKey: key, queryFn: () => sleep(100).then(() => ++count), retry: false, suspense: true, staleTime: 0, })) return (
data: {result.data} fetching: {result.isFetching ? 'true' : 'false'}
) } function Page() { const [show, setShow] = createSignal(true) return (
{show() && }
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(100) expect(rendered.getByText('data: 1')).toBeInTheDocument() expect(rendered.getByText('fetching: false')).toBeInTheDocument() expect(rendered.getByText('hide')).toBeInTheDocument() fireEvent.click(rendered.getByText('hide')) await vi.advanceTimersByTimeAsync(100) expect(rendered.getByText('show')).toBeInTheDocument() fireEvent.click(rendered.getByText('show')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(0) expect(rendered.getByText('fetching: true')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(100) expect(rendered.getByText('data: 2')).toBeInTheDocument() expect(rendered.getByText('fetching: false')).toBeInTheDocument() }) it('should suspend when switching to a new query', async () => { const key1 = queryKey() const key2 = queryKey() function Component(props: { queryKey: Array }) { const result = useQuery(() => ({ queryKey: props.queryKey, queryFn: () => sleep(100).then(() => props.queryKey), retry: false, suspense: true, })) return
data: {result.data}
} function Page() { const [key, setKey] = createSignal(key1) return (
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(100) expect(rendered.getByText(`data: ${key1}`)).toBeInTheDocument() fireEvent.click(rendered.getByText('switch')) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(100) expect(rendered.getByText(`data: ${key2}`)).toBeInTheDocument() }) it('should throw errors to the error boundary by default', async () => { const key = queryKey() const consoleMock = vi .spyOn(console, 'error') .mockImplementation(() => undefined) function Page() { const state = useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => Promise.reject(new Error('Suspense Error a1x'))), retry: false, suspense: true, })) // read state.data to trigger suspense. createRenderEffect(() => { state.data }) return
rendered
} function App() { return ( (
error boundary
)} >
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() consoleMock.mockRestore() }) it('should not throw errors to the error boundary when throwOnError: false', async () => { const key = queryKey() function Page() { const state = useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => Promise.reject(new Error('Suspense Error a2x'))), retry: false, throwOnError: false, })) // read state.data to trigger suspense. createRenderEffect(() => { state.data }) return
rendered
} function App() { return ( (
error boundary
)} >
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('rendered')).toBeInTheDocument() }) it('should throw errors to the error boundary when a throwOnError function returns true', async () => { const key = queryKey() const consoleMock = vi .spyOn(console, 'error') .mockImplementation(() => undefined) function Page() { const state = useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => Promise.reject(new Error('Remote Error'))), retry: false, throwOnError: (err) => err.message !== 'Local Error', })) // read state.data to trigger suspense. createRenderEffect(() => { state.data }) return
rendered
} function App() { return ( (
error boundary
)} >
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() consoleMock.mockRestore() }) it('should not throw errors to the error boundary when a throwOnError function returns false', async () => { const key = queryKey() function Page() { const state = useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => Promise.reject(new Error('Local Error'))), retry: false, suspense: true, throwOnError: (err) => err.message !== 'Local Error', })) // read state.data to trigger suspense. createRenderEffect(() => { state.data }) return
rendered
} function App() { return ( (
error boundary
)} >
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('rendered')).toBeInTheDocument() }) it('should not call the queryFn when not enabled', async () => { const key = queryKey() const queryFn = vi.fn(() => sleep(10).then(() => '23')) function Page() { const [enabled, setEnabled] = createSignal(false) const result = useQuery(() => ({ queryKey: [key], queryFn, suspense: true, enabled: enabled(), })) return (

{result.data}

) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() expect(queryFn).toHaveBeenCalledTimes(0) await vi.advanceTimersByTimeAsync(10) fireEvent.click(rendered.getByRole('button', { name: /fire/i })) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(rendered.getByRole('heading').textContent).toBe('23') expect(queryFn).toHaveBeenCalledTimes(1) }) it('should error caught in error boundary without infinite loop', async () => { const key = queryKey() const consoleMock = vi .spyOn(console, 'error') .mockImplementation(() => undefined) let succeed = true function Page() { const [nonce] = createSignal(0) const queryKeys = [`${key}-${succeed}`] const result = useQuery(() => ({ queryKey: queryKeys, queryFn: () => sleep(10).then(() => { if (!succeed) throw new Error('Suspense Error Bingo') return nonce() }), retry: false, suspense: true, })) return (
rendered {result.data}
) } function App() { return (
error boundary
}>
) } const rendered = render(() => ( )) // render suspense fallback (Loading...) expect(rendered.getByText('loading')).toBeInTheDocument() // resolve promise -> render Page (rendered) await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('rendered')).toBeInTheDocument() // change query key succeed = false // reset query -> and throw error fireEvent.click(rendered.getByLabelText('fail')) // render error boundary fallback (error boundary) await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() consoleMock.mockRestore() }) it('should error caught in error boundary without infinite loop when query keys changed', async () => { let succeed = true const consoleMock = vi .spyOn(console, 'error') .mockImplementation(() => undefined) function Page() { const [key, setKey] = createSignal(0) const result = useQuery(() => ({ queryKey: [`${key()}-${succeed}`], queryFn: async () => sleep(10).then(() => { if (!succeed) throw new Error('Suspense Error Bingo') return 'data' }), retry: false, suspense: true, })) return (
rendered {result.data}
) } function App() { return (
error boundary
}>
) } const rendered = render(() => ( )) // render suspense fallback (Loading...) expect(rendered.getByText('loading')).toBeInTheDocument() // resolve promise -> render Page (rendered) await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('rendered')).toBeInTheDocument() // change promise result to error succeed = false // change query key fireEvent.click(rendered.getByLabelText('fail')) expect(rendered.getByText('loading')).toBeInTheDocument() // render error boundary fallback (error boundary) await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() consoleMock.mockRestore() }) it('should error caught in error boundary without infinite loop when enabled changed', async () => { const consoleMock = vi .spyOn(console, 'error') .mockImplementation(() => undefined) function Page() { const queryKeys = '1' const [enabled, setEnabled] = createSignal(false) const result = useQuery(() => ({ queryKey: [queryKeys], queryFn: () => sleep(10).then(() => Promise.reject(new Error('Suspense Error Bingo')), ), retry: false, suspense: true, enabled: enabled(), })) return (
rendered {result.data}
) } function App() { return (
error boundary
}>
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) // render empty data with 'rendered' when enabled is false expect(rendered.getByText('rendered')).toBeInTheDocument() // change enabled to true fireEvent.click(rendered.getByLabelText('fail')) // render pending fallback expect(rendered.getByText('loading')).toBeInTheDocument() // render error boundary fallback (error boundary) await vi.advanceTimersByTimeAsync(10) expect(rendered.getByText('error boundary')).toBeInTheDocument() consoleMock.mockRestore() }) it('should render the correct amount of times in Suspense mode when gcTime is set to 0', async () => { const key = queryKey() let state: UseQueryResult | null = null let count = 0 let renders = 0 function Page() { state = useQuery(() => ({ queryKey: key, queryFn: () => sleep(10).then(() => ++count), gcTime: 0, })) createRenderEffect( on([() => ({ ...state })], () => { renders++ }), ) return (
rendered
) } const rendered = render(() => ( )) expect(rendered.getByText('loading')).toBeInTheDocument() await vi.advanceTimersByTimeAsync(10) expect(state).toMatchObject({ data: 1, status: 'success', }) expect(renders).toBe(2) expect(rendered.queryByText('rendered')).toBeInTheDocument() }) })