import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { fireEvent, render } from '@solidjs/testing-library'
import { Show, createEffect, createRenderEffect, createSignal } from 'solid-js'
import { queryKey, sleep } from '@tanstack/query-test-utils'
import {
QueryCache,
QueryClient,
QueryClientProvider,
useIsFetching,
useQuery,
} from '..'
import { setActTimeout } from './utils'
describe('useIsFetching', () => {
beforeEach(() => {
vi.useFakeTimers()
})
afterEach(() => {
vi.useRealTimers()
})
// See https://github.com/tannerlinsley/react-query/issues/105
it('should update as queries start and stop fetching', async () => {
const queryCache = new QueryCache()
const queryClient = new QueryClient({ queryCache })
const key = queryKey()
function IsFetching() {
const isFetching = useIsFetching()
return
isFetching: {isFetching()}
}
function Query() {
const [ready, setReady] = createSignal(false)
useQuery(() => ({
queryKey: key,
queryFn: () => sleep(50).then(() => 'test'),
enabled: ready(),
}))
return
}
function Page() {
return (
)
}
const rendered = render(() => (
))
expect(rendered.getByText('isFetching: 0')).toBeInTheDocument()
fireEvent.click(rendered.getByRole('button', { name: /setReady/i }))
expect(rendered.getByText('isFetching: 1')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(50)
expect(rendered.getByText('isFetching: 0')).toBeInTheDocument()
})
it('should not update state while rendering', async () => {
const queryCache = new QueryCache()
const queryClient = new QueryClient({ queryCache })
const key1 = queryKey()
const key2 = queryKey()
const isFetchingArray: Array = []
function IsFetching() {
const isFetching = useIsFetching()
createRenderEffect(() => {
isFetchingArray.push(isFetching())
})
return null
}
function FirstQuery() {
useQuery(() => ({
queryKey: key1,
queryFn: () => sleep(150).then(() => 'data'),
}))
return null
}
function SecondQuery() {
useQuery(() => ({
queryKey: key2,
queryFn: () => sleep(200).then(() => 'data'),
}))
return null
}
function Page() {
const [renderSecond, setRenderSecond] = createSignal(false)
createEffect(() => {
setActTimeout(() => {
setRenderSecond(true)
}, 100)
})
return (
<>
>
)
}
render(() => (
))
// unlike react, Updating renderSecond wont cause a rerender for FirstQuery
await vi.advanceTimersByTimeAsync(300)
expect(isFetchingArray).toEqual([0, 1, 2, 1, 0])
})
it('should be able to filter', async () => {
const queryClient = new QueryClient()
const key1 = queryKey()
const key2 = queryKey()
const isFetchingArray: Array = []
function One() {
useQuery(() => ({
queryKey: key1,
queryFn: () => sleep(10).then(() => 'test'),
}))
return null
}
function Two() {
useQuery(() => ({
queryKey: key2,
queryFn: () => sleep(20).then(() => 'test'),
}))
return null
}
function Page() {
const [started, setStarted] = createSignal(false)
const isFetching = useIsFetching(() => ({
queryKey: key1,
}))
createRenderEffect(() => {
isFetchingArray.push(isFetching())
})
return (
isFetching: {isFetching()}
<>
>
)
}
const rendered = render(() => (
))
expect(rendered.getByText('isFetching: 0')).toBeInTheDocument()
fireEvent.click(rendered.getByRole('button', { name: /setStarted/i }))
expect(rendered.getByText('isFetching: 1')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(20)
expect(rendered.getByText('isFetching: 0')).toBeInTheDocument()
// at no point should we have isFetching: 2
expect(isFetchingArray).toEqual(expect.not.arrayContaining([2]))
})
it('should show the correct fetching state when mounted after a query', async () => {
const queryClient = new QueryClient()
const key = queryKey()
function Page() {
useQuery(() => ({
queryKey: key,
queryFn: () => sleep(10).then(() => 'test'),
}))
const isFetching = useIsFetching()
return (
isFetching: {isFetching()}
)
}
const rendered = render(() => (
))
expect(rendered.getByText('isFetching: 1')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(10)
expect(rendered.getByText('isFetching: 0')).toBeInTheDocument()
})
it('should use provided custom queryClient', async () => {
const queryClient = new QueryClient()
const key = queryKey()
function Page() {
useQuery(
() => ({
queryKey: key,
queryFn: () => sleep(10).then(() => 'test'),
}),
() => queryClient,
)
const isFetching = useIsFetching(undefined, () => queryClient)
return (
isFetching: {isFetching()}
)
}
const rendered = render(() => )
expect(rendered.getByText('isFetching: 1')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(10)
expect(rendered.getByText('isFetching: 0')).toBeInTheDocument()
})
})