| | import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' |
| | import { fireEvent, render } from '@solidjs/testing-library' |
| |
|
| | import { |
| | For, |
| | Index, |
| | Match, |
| | Switch, |
| | createEffect, |
| | createRenderEffect, |
| | createSignal, |
| | on, |
| | } from 'solid-js' |
| | import { queryKey, sleep } from '@tanstack/query-test-utils' |
| | import { |
| | QueryCache, |
| | QueryClient, |
| | QueryClientProvider, |
| | infiniteQueryOptions, |
| | keepPreviousData, |
| | useInfiniteQuery, |
| | } from '..' |
| | import { Blink, setActTimeout } from './utils' |
| | import type { |
| | InfiniteData, |
| | QueryFunctionContext, |
| | UseInfiniteQueryResult, |
| | } from '..' |
| | import type { Mock } from 'vitest' |
| |
|
| | interface Result { |
| | items: Array<number> |
| | nextId?: number |
| | prevId?: number |
| | ts: number |
| | } |
| |
|
| | const pageSize = 10 |
| |
|
| | const fetchItems = ( |
| | page: number, |
| | ts: number, |
| | noNext?: boolean, |
| | noPrev?: boolean, |
| | ): Promise<Result> => |
| | sleep(10).then(() => ({ |
| | items: [...new Array(10)].fill(null).map((_, d) => page * pageSize + d), |
| | nextId: noNext ? undefined : page + 1, |
| | prevId: noPrev ? undefined : page - 1, |
| | ts, |
| | })) |
| |
|
| | describe('useInfiniteQuery', () => { |
| | beforeEach(() => { |
| | vi.useFakeTimers() |
| | }) |
| |
|
| | afterEach(() => { |
| | vi.useRealTimers() |
| | }) |
| |
|
| | const queryCache = new QueryCache() |
| | const queryClient = new QueryClient({ queryCache }) |
| |
|
| | it('should return the correct states for a successful query', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<number>>> = [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: 0, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toEqual({ |
| | data: undefined, |
| | dataUpdatedAt: 0, |
| | error: null, |
| | errorUpdatedAt: 0, |
| | failureCount: 0, |
| | failureReason: null, |
| | errorUpdateCount: 0, |
| | fetchNextPage: expect.any(Function), |
| | fetchPreviousPage: expect.any(Function), |
| | hasNextPage: false, |
| | hasPreviousPage: false, |
| | isError: false, |
| | isFetched: false, |
| | isFetchedAfterMount: false, |
| | isFetching: true, |
| | isPaused: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isPending: true, |
| | isLoading: true, |
| | isInitialLoading: true, |
| | isLoadingError: false, |
| | isPlaceholderData: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | isStale: true, |
| | isSuccess: false, |
| | isEnabled: true, |
| | refetch: expect.any(Function), |
| | status: 'pending', |
| | fetchStatus: 'fetching', |
| | promise: expect.any(Promise), |
| | }) |
| | expect(states[1]).toEqual({ |
| | data: { pages: [0], pageParams: [0] }, |
| | dataUpdatedAt: expect.any(Number), |
| | error: null, |
| | errorUpdatedAt: 0, |
| | failureCount: 0, |
| | failureReason: null, |
| | errorUpdateCount: 0, |
| | fetchNextPage: expect.any(Function), |
| | fetchPreviousPage: expect.any(Function), |
| | hasNextPage: true, |
| | hasPreviousPage: false, |
| | isError: false, |
| | isFetched: true, |
| | isFetchedAfterMount: true, |
| | isFetching: false, |
| | isPaused: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isPending: false, |
| | isLoading: false, |
| | isInitialLoading: false, |
| | isLoadingError: false, |
| | isPlaceholderData: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | isStale: true, |
| | isSuccess: true, |
| | isEnabled: true, |
| | refetch: expect.any(Function), |
| | status: 'success', |
| | fetchStatus: 'idle', |
| | promise: expect.any(Promise), |
| | }) |
| | }) |
| |
|
| | it('should not throw when fetchNextPage returns an error', async () => { |
| | const key = queryKey() |
| | let noThrow = false |
| |
|
| | function Page() { |
| | const start = 1 |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | sleep(10).then(() => { |
| | if (pageParam === 2) throw new Error('error') |
| | return pageParam |
| | }), |
| | retry: 1, |
| | retryDelay: 10, |
| | initialPageParam: start, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | })) |
| |
|
| | createEffect(() => { |
| | const fetchNextPage = state.fetchNextPage |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | .then(() => { |
| | noThrow = true |
| | }) |
| | .catch(() => undefined) |
| | }, 20) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(50) |
| |
|
| | expect(noThrow).toBe(true) |
| | }) |
| |
|
| | it('should keep the previous data when placeholderData is set', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<string>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const [order, setOrder] = createSignal('desc') |
| |
|
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: [key, order()], |
| | queryFn: ({ pageParam }) => |
| | sleep(10).then(() => `${pageParam}-${order()}`), |
| | getNextPageParam: () => 1, |
| | initialPageParam: 0, |
| | placeholderData: keepPreviousData, |
| | notifyOnChangeProps: 'all', |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | ...state, |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | }) |
| | }) |
| |
|
| | return ( |
| | <div> |
| | <button onClick={() => state.fetchNextPage()}>fetchNextPage</button> |
| | <button onClick={() => setOrder('asc')}>order</button> |
| | <div>data: {state.data?.pages.join(',') ?? 'null'}</div> |
| | <div>isFetching: {String(state.isFetching)}</div> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 0-desc')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /fetchNextPage/i })) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 0-desc,1-desc')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /order/i })) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 0-asc')).toBeInTheDocument() |
| | expect(rendered.getByText('isFetching: false')).toBeInTheDocument() |
| |
|
| | expect(states.length).toBe(6) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: false, |
| | isPlaceholderData: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: ['0-desc'] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | isPlaceholderData: false, |
| | }) |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: ['0-desc'] }, |
| | isFetching: true, |
| | isFetchingNextPage: true, |
| | isSuccess: true, |
| | isPlaceholderData: false, |
| | }) |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: ['0-desc', '1-desc'] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | isPlaceholderData: false, |
| | }) |
| | |
| | expect(states[4]).toMatchObject({ |
| | data: { pages: ['0-desc', '1-desc'] }, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | isPlaceholderData: true, |
| | }) |
| | expect(states[5]).toMatchObject({ |
| | data: { pages: ['0-asc'] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | isPlaceholderData: false, |
| | }) |
| | }) |
| |
|
| | it('should be able to select a part of the data', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<string>>> = [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: () => sleep(10).then(() => ({ count: 1 })), |
| | select: (data) => ({ |
| | pages: data.pages.map((x) => `count: ${x.count}`), |
| | pageParams: data.pageParams, |
| | }), |
| | getNextPageParam: () => undefined, |
| | initialPageParam: 0, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: ['count: 1'] }, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should be able to select a new result and not cause infinite renders', async () => { |
| | const key = queryKey() |
| | const states: Array< |
| | UseInfiniteQueryResult<InfiniteData<{ count: number; id: number }>> |
| | > = [] |
| | let selectCalled = 0 |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: () => sleep(10).then(() => ({ count: 1 })), |
| | select: (data) => { |
| | selectCalled++ |
| | return { |
| | pages: data.pages.map((x) => ({ ...x, id: Math.random() })), |
| | pageParams: data.pageParams, |
| | } |
| | }, |
| | getNextPageParam: () => undefined, |
| | initialPageParam: 0, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(selectCalled).toBe(1) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [{ count: 1 }] }, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should be able to reverse the data', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | select: (data) => ({ |
| | pages: [...data.pages].reverse(), |
| | pageParams: [...data.pageParams].reverse(), |
| | }), |
| | notifyOnChangeProps: 'all', |
| | getNextPageParam: () => 1, |
| | initialPageParam: 0, |
| | })) |
| |
|
| | createRenderEffect( |
| | on( |
| | () => ({ ...state }), |
| | () => { |
| | states.push({ |
| | data: state.data |
| | ? JSON.parse(JSON.stringify(state.data)) |
| | : undefined, |
| | isSuccess: state.isSuccess, |
| | }) |
| | }, |
| | ), |
| | ) |
| |
|
| | return ( |
| | <div> |
| | <button onClick={() => state.fetchNextPage()}>fetchNextPage</button> |
| | <div>data: {state.data?.pages.join(',') ?? 'null'}</div> |
| | <div>isFetching: {state.isFetching}</div> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 0')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /fetchNextPage/i })) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 1,0')).toBeInTheDocument() |
| |
|
| | expect(states.length).toBe(4) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [0] }, |
| | isSuccess: true, |
| | }) |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [0] }, |
| | isSuccess: true, |
| | }) |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [1, 0] }, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should be able to fetch a previous page', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const start = 10 |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | getPreviousPageParam: (firstPage) => firstPage - 1, |
| | initialPageParam: start, |
| | notifyOnChangeProps: 'all', |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | hasNextPage: state.hasNextPage, |
| | hasPreviousPage: state.hasPreviousPage, |
| | isFetching: state.isFetching, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isFetchingPreviousPage: state.isFetchingPreviousPage, |
| | isSuccess: state.isSuccess, |
| | }) |
| | }) |
| |
|
| | createEffect(() => { |
| | const fetchPreviousPage = state.fetchPreviousPage |
| | setActTimeout(() => { |
| | fetchPreviousPage() |
| | }, 20) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(30) |
| |
|
| | expect(states.length).toBe(4) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | hasNextPage: false, |
| | hasPreviousPage: false, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: false, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | hasNextPage: true, |
| | hasPreviousPage: true, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [10] }, |
| | hasNextPage: true, |
| | hasPreviousPage: true, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: true, |
| | isSuccess: true, |
| | }) |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [9, 10] }, |
| | hasNextPage: true, |
| | hasPreviousPage: true, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should be able to refetch when providing page params automatically', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | getPreviousPageParam: (firstPage) => firstPage - 1, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: 10, |
| | notifyOnChangeProps: 'all', |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | isFetching: state.isFetching, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isRefetching: state.isRefetching, |
| | isFetchingPreviousPage: state.isFetchingPreviousPage, |
| | }) |
| | }) |
| |
|
| | return ( |
| | <div> |
| | <button onClick={() => state.fetchNextPage()}>fetchNextPage</button> |
| | <button onClick={() => state.fetchPreviousPage()}> |
| | fetchPreviousPage |
| | </button> |
| | <button onClick={() => state.refetch()}>refetch</button> |
| | <div>data: {state.data?.pages.join(',') ?? 'null'}</div> |
| | <div>isFetching: {String(state.isFetching)}</div> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 10')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /fetchNextPage/i })) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 10,11')).toBeInTheDocument() |
| |
|
| | fireEvent.click( |
| | rendered.getByRole('button', { name: /fetchPreviousPage/i }), |
| | ) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 9,10,11')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /refetch/i })) |
| | await vi.advanceTimersByTimeAsync(30) |
| | expect(rendered.getByText('isFetching: false')).toBeInTheDocument() |
| |
|
| | expect(states.length).toBe(8) |
| | |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: true, |
| | isFetchingNextPage: true, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [10, 11] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[4]).toMatchObject({ |
| | data: { pages: [10, 11] }, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: true, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[5]).toMatchObject({ |
| | data: { pages: [9, 10, 11] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[6]).toMatchObject({ |
| | data: { pages: [9, 10, 11] }, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: false, |
| | isRefetching: true, |
| | }) |
| | |
| | expect(states[7]).toMatchObject({ |
| | data: { pages: [9, 10, 11] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isFetchingPreviousPage: false, |
| | isRefetching: false, |
| | }) |
| | }) |
| |
|
| | it('should return the correct states when refetch fails', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | let isRefetch = false |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | sleep(10).then(() => { |
| | if (isRefetch) throw new Error() |
| | return pageParam |
| | }), |
| | getPreviousPageParam: (firstPage) => firstPage - 1, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: 10, |
| | notifyOnChangeProps: 'all', |
| | retry: false, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | isFetching: state.isFetching, |
| | isFetchNextPageError: state.isFetchNextPageError, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isFetchPreviousPageError: state.isFetchPreviousPageError, |
| | isFetchingPreviousPage: state.isFetchingPreviousPage, |
| | isRefetchError: state.isRefetchError as true, |
| | isRefetching: state.isRefetching, |
| | }) |
| | }) |
| |
|
| | return ( |
| | <div> |
| | <button |
| | onClick={() => { |
| | isRefetch = true |
| | state.refetch() |
| | }} |
| | > |
| | refetch |
| | </button> |
| | <div>data: {state.data?.pages.join(',') ?? 'null'}</div> |
| | <div>isFetching: {String(state.isFetching)}</div> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 10')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /refetch/i })) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('isFetching: false')).toBeInTheDocument() |
| |
|
| | expect(states.length).toBe(4) |
| | |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isFetching: true, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: true, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: true, |
| | }) |
| | |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: true, |
| | isRefetching: false, |
| | }) |
| | }) |
| |
|
| | it('should return the correct states when fetchNextPage fails', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | sleep(10).then(() => { |
| | if (pageParam !== 10) throw new Error() |
| | return pageParam |
| | }), |
| | getPreviousPageParam: (firstPage) => firstPage - 1, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: 10, |
| | notifyOnChangeProps: 'all', |
| | retry: false, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | isFetching: state.isFetching, |
| | isFetchNextPageError: state.isFetchNextPageError, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isFetchPreviousPageError: state.isFetchPreviousPageError, |
| | isFetchingPreviousPage: state.isFetchingPreviousPage, |
| | isRefetchError: state.isRefetchError as true, |
| | isRefetching: state.isRefetching, |
| | }) |
| | }) |
| |
|
| | return ( |
| | <div> |
| | <button onClick={() => state.fetchNextPage()}>fetchNextPage</button> |
| | <div>data: {state.data?.pages.join(',') ?? 'null'}</div> |
| | <div>isFetching: {String(state.isFetching)}</div> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 10')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByRole('button', { name: /fetchNextPage/i })) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('isFetching: false')).toBeInTheDocument() |
| |
|
| | expect(states.length).toBe(4) |
| | |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isFetching: true, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: true, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: true, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchNextPageError: true, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | }) |
| |
|
| | it('should return the correct states when fetchPreviousPage fails', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | sleep(10).then(() => { |
| | if (pageParam !== 10) throw new Error() |
| | return pageParam |
| | }), |
| | getPreviousPageParam: (firstPage) => firstPage - 1, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: 10, |
| | notifyOnChangeProps: 'all', |
| | retry: false, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | isFetching: state.isFetching, |
| | isFetchNextPageError: state.isFetchNextPageError, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isFetchPreviousPageError: state.isFetchPreviousPageError, |
| | isFetchingPreviousPage: state.isFetchingPreviousPage, |
| | isRefetchError: state.isRefetchError as true, |
| | isRefetching: state.isRefetching, |
| | }) |
| | }) |
| |
|
| | return ( |
| | <div> |
| | <button onClick={() => state.fetchPreviousPage()}> |
| | fetchPreviousPage |
| | </button> |
| | <div>data: {state.data?.pages.join(',') ?? 'null'}</div> |
| | <div>isFetching: {String(state.isFetching)}</div> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('data: 10')).toBeInTheDocument() |
| |
|
| | fireEvent.click( |
| | rendered.getByRole('button', { name: /fetchPreviousPage/i }), |
| | ) |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('isFetching: false')).toBeInTheDocument() |
| |
|
| | expect(states.length).toBe(4) |
| | |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | isFetching: true, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: true, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: false, |
| | isFetchingPreviousPage: true, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchNextPageError: false, |
| | isFetchingNextPage: false, |
| | isFetchPreviousPageError: true, |
| | isFetchingPreviousPage: false, |
| | isRefetchError: false, |
| | isRefetching: false, |
| | }) |
| | }) |
| |
|
| | it('should silently cancel any ongoing fetch when fetching more', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const start = 10 |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(50).then(() => pageParam), |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: start, |
| | notifyOnChangeProps: 'all', |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | hasNextPage: state.hasNextPage, |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | isFetching: state.isFetching, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isSuccess: state.isSuccess, |
| | }) |
| | }) |
| |
|
| | createEffect(() => { |
| | const { refetch, fetchNextPage } = state |
| | setActTimeout(() => { |
| | refetch() |
| | }, 100) |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | }, 110) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(160) |
| |
|
| | expect(states.length).toBe(5) |
| | expect(states[0]).toMatchObject({ |
| | hasNextPage: false, |
| | data: undefined, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[2]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [10] }, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[3]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [10] }, |
| | isFetching: true, |
| | isFetchingNextPage: true, |
| | isSuccess: true, |
| | }) |
| | expect(states[4]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [10, 11] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should silently cancel an ongoing fetchNextPage request when another fetchNextPage is invoked', async () => { |
| | const key = queryKey() |
| | const start = 10 |
| | const onAborts: Array<Mock<(...args: Array<any>) => any>> = [] |
| | const abortListeners: Array<Mock<(...args: Array<any>) => any>> = [] |
| | const fetchPage = vi.fn< |
| | (context: QueryFunctionContext<typeof key, number>) => Promise<number> |
| | >(async ({ pageParam, signal }) => { |
| | const onAbort = vi.fn() |
| | const abortListener = vi.fn() |
| | onAborts.push(onAbort) |
| | abortListeners.push(abortListener) |
| | signal.onabort = onAbort |
| | signal.addEventListener('abort', abortListener) |
| |
|
| | await sleep(50) |
| | return pageParam |
| | }) |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: fetchPage, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: start, |
| | })) |
| |
|
| | createEffect(() => { |
| | const { fetchNextPage } = state |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | }, 100) |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | }, 110) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(160) |
| |
|
| | const expectedCallCount = 3 |
| | expect(fetchPage).toBeCalledTimes(expectedCallCount) |
| | expect(onAborts).toHaveLength(expectedCallCount) |
| | expect(abortListeners).toHaveLength(expectedCallCount) |
| |
|
| | let callIndex = 0 |
| | const firstCtx = fetchPage.mock.calls[callIndex]![0] |
| | expect(firstCtx.pageParam).toEqual(start) |
| | expect(firstCtx.queryKey).toEqual(key) |
| | expect(firstCtx.signal).toBeInstanceOf(AbortSignal) |
| | expect(firstCtx.signal.aborted).toBe(false) |
| | expect(onAborts[callIndex]).not.toHaveBeenCalled() |
| | expect(abortListeners[callIndex]).not.toHaveBeenCalled() |
| |
|
| | callIndex = 1 |
| | const secondCtx = fetchPage.mock.calls[callIndex]![0] |
| | expect(secondCtx.pageParam).toBe(11) |
| | expect(secondCtx.queryKey).toEqual(key) |
| | expect(secondCtx.signal).toBeInstanceOf(AbortSignal) |
| | expect(secondCtx.signal.aborted).toBe(true) |
| | expect(onAborts[callIndex]).toHaveBeenCalledTimes(1) |
| | expect(abortListeners[callIndex]).toHaveBeenCalledTimes(1) |
| |
|
| | callIndex = 2 |
| | const thirdCtx = fetchPage.mock.calls[callIndex]![0] |
| | expect(thirdCtx.pageParam).toBe(11) |
| | expect(thirdCtx.queryKey).toEqual(key) |
| | expect(thirdCtx.signal).toBeInstanceOf(AbortSignal) |
| | expect(thirdCtx.signal.aborted).toBe(false) |
| | expect(onAborts[callIndex]).not.toHaveBeenCalled() |
| | expect(abortListeners[callIndex]).not.toHaveBeenCalled() |
| | }) |
| |
|
| | it('should not cancel an ongoing fetchNextPage request when another fetchNextPage is invoked if `cancelRefetch: false` is used', async () => { |
| | const key = queryKey() |
| | const start = 10 |
| | const onAborts: Array<Mock<(...args: Array<any>) => any>> = [] |
| | const abortListeners: Array<Mock<(...args: Array<any>) => any>> = [] |
| | const fetchPage = vi.fn< |
| | (context: QueryFunctionContext<typeof key, number>) => Promise<number> |
| | >(async ({ pageParam, signal }) => { |
| | const onAbort = vi.fn() |
| | const abortListener = vi.fn() |
| | onAborts.push(onAbort) |
| | abortListeners.push(abortListener) |
| | signal.onabort = onAbort |
| | signal.addEventListener('abort', abortListener) |
| |
|
| | await sleep(50) |
| | return pageParam |
| | }) |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: fetchPage, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: start, |
| | })) |
| |
|
| | createEffect(() => { |
| | const { fetchNextPage } = state |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | }, 100) |
| | setActTimeout(() => { |
| | fetchNextPage({ cancelRefetch: false }) |
| | }, 110) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(160) |
| |
|
| | const expectedCallCount = 2 |
| | expect(fetchPage).toBeCalledTimes(expectedCallCount) |
| | expect(onAborts).toHaveLength(expectedCallCount) |
| | expect(abortListeners).toHaveLength(expectedCallCount) |
| |
|
| | let callIndex = 0 |
| | const firstCtx = fetchPage.mock.calls[callIndex]![0] |
| | expect(firstCtx.pageParam).toEqual(start) |
| | expect(firstCtx.queryKey).toEqual(key) |
| | expect(firstCtx.signal).toBeInstanceOf(AbortSignal) |
| | expect(firstCtx.signal.aborted).toBe(false) |
| | expect(onAborts[callIndex]).not.toHaveBeenCalled() |
| | expect(abortListeners[callIndex]).not.toHaveBeenCalled() |
| |
|
| | callIndex = 1 |
| | const secondCtx = fetchPage.mock.calls[callIndex]![0] |
| | expect(secondCtx.pageParam).toBe(11) |
| | expect(secondCtx.queryKey).toEqual(key) |
| | expect(secondCtx.signal).toBeInstanceOf(AbortSignal) |
| | expect(secondCtx.signal.aborted).toBe(false) |
| | expect(onAborts[callIndex]).not.toHaveBeenCalled() |
| | expect(abortListeners[callIndex]).not.toHaveBeenCalled() |
| | }) |
| |
|
| | it('should keep fetching first page when not loaded yet and triggering fetch more', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<number>>> = [] |
| |
|
| | function Page() { |
| | const start = 10 |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(50).then(() => pageParam), |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: start, |
| | notifyOnChangeProps: 'all', |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | createEffect(() => { |
| | const { fetchNextPage } = state |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | }, 10) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(60) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toMatchObject({ |
| | hasNextPage: false, |
| | data: undefined, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [10] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should stop fetching additional pages when the component is unmounted and AbortSignal is consumed', async () => { |
| | const key = queryKey() |
| | let fetches = 0 |
| |
|
| | const initialData = { pages: [1, 2, 3, 4], pageParams: [0, 1, 2, 3] } |
| |
|
| | function List() { |
| | useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | sleep(50).then(() => { |
| | fetches++ |
| | return pageParam * 10 |
| | }), |
| | initialData, |
| | getNextPageParam: (_, allPages) => { |
| | return allPages.length === 4 ? undefined : allPages.length |
| | }, |
| | initialPageParam: 0, |
| | })) |
| |
|
| | return null |
| | } |
| |
|
| | function Page() { |
| | const [show, setShow] = createSignal(true) |
| |
|
| | createEffect(() => { |
| | setActTimeout(() => { |
| | setShow(false) |
| | }, 75) |
| | }) |
| |
|
| | return <>{show() ? <List /> : null}</> |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(125) |
| |
|
| | expect(fetches).toBe(2) |
| | expect(queryClient.getQueryState(key)).toMatchObject({ |
| | data: initialData, |
| | status: 'success', |
| | error: null, |
| | }) |
| | }) |
| |
|
| | it('should be able to set new pages with the query client', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const [firstPage, setFirstPage] = createSignal(0) |
| |
|
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | notifyOnChangeProps: 'all', |
| | initialPageParam: firstPage(), |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | hasNextPage: state.hasNextPage, |
| | data: state.data ? JSON.parse(JSON.stringify(state.data)) : undefined, |
| | isFetching: state.isFetching, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isSuccess: state.isSuccess, |
| | }) |
| | }) |
| |
|
| | createEffect(() => { |
| | const { refetch } = state |
| | setActTimeout(() => { |
| | queryClient.setQueryData(key, { pages: [7, 8], pageParams: [7, 8] }) |
| | setFirstPage(7) |
| | }, 20) |
| |
|
| | setActTimeout(() => { |
| | refetch() |
| | }, 50) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(70) |
| |
|
| | expect(states.length).toBe(5) |
| | expect(states[0]).toMatchObject({ |
| | hasNextPage: false, |
| | data: undefined, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: false, |
| | }) |
| | |
| | expect(states[1]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [0] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | |
| | expect(states[2]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [7, 8] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | |
| | expect(states[3]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [7, 8] }, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | |
| | expect(states[4]).toMatchObject({ |
| | hasNextPage: true, |
| | data: { pages: [7, 8] }, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should only refetch the first page when initialData is provided', async () => { |
| | const key = queryKey() |
| | const states: Array<Partial<UseInfiniteQueryResult<InfiniteData<number>>>> = |
| | [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | initialData: { pages: [1], pageParams: [1] }, |
| | getNextPageParam: (lastPage) => lastPage + 1, |
| | initialPageParam: 0, |
| | notifyOnChangeProps: 'all', |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ |
| | data: JSON.parse(JSON.stringify(state.data)), |
| | hasNextPage: state.hasNextPage, |
| | isFetching: state.isFetching, |
| | isFetchingNextPage: state.isFetchingNextPage, |
| | isSuccess: state.isSuccess, |
| | }) |
| | }) |
| |
|
| | createEffect(() => { |
| | const { fetchNextPage } = state |
| | setActTimeout(() => { |
| | fetchNextPage() |
| | }, 20) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(30) |
| |
|
| | expect(states.length).toBe(4) |
| | expect(states[0]).toMatchObject({ |
| | data: { pages: [1] }, |
| | hasNextPage: true, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [1] }, |
| | hasNextPage: true, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[2]).toMatchObject({ |
| | data: { pages: [1] }, |
| | hasNextPage: true, |
| | isFetching: true, |
| | isFetchingNextPage: true, |
| | isSuccess: true, |
| | }) |
| | expect(states[3]).toMatchObject({ |
| | data: { pages: [1, 2] }, |
| | hasNextPage: true, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should set hasNextPage to false if getNextPageParam returns undefined', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<number>>> = [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | initialPageParam: 1, |
| | getNextPageParam: () => undefined, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | hasNextPage: false, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [1] }, |
| | hasNextPage: false, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should compute hasNextPage correctly using initialData', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<number>>> = [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | initialPageParam: 10, |
| | initialData: { pages: [10], pageParams: [10] }, |
| | getNextPageParam: (lastPage) => (lastPage === 10 ? 11 : undefined), |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toMatchObject({ |
| | data: { pages: [10] }, |
| | hasNextPage: true, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | hasNextPage: true, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should compute hasNextPage correctly for falsy getFetchMore return value using initialData', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<number>>> = [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | initialPageParam: 10, |
| | initialData: { pages: [10], pageParams: [10] }, |
| | getNextPageParam: () => undefined, |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toMatchObject({ |
| | data: { pages: [10] }, |
| | hasNextPage: false, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: [10] }, |
| | hasNextPage: false, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should not use selected data when computing hasNextPage', async () => { |
| | const key = queryKey() |
| | const states: Array<UseInfiniteQueryResult<InfiniteData<string>>> = [] |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => sleep(10).then(() => pageParam), |
| | initialPageParam: 1, |
| | getNextPageParam: (lastPage) => (lastPage === 1 ? 2 : undefined), |
| | select: (data) => ({ |
| | pages: data.pages.map((x) => x.toString()), |
| | pageParams: data.pageParams, |
| | }), |
| | })) |
| |
|
| | createRenderEffect(() => { |
| | states.push({ ...state }) |
| | }) |
| |
|
| | return null |
| | } |
| |
|
| | render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| |
|
| | expect(states.length).toBe(2) |
| | expect(states[0]).toMatchObject({ |
| | data: undefined, |
| | hasNextPage: false, |
| | isFetching: true, |
| | isFetchingNextPage: false, |
| | isSuccess: false, |
| | }) |
| | expect(states[1]).toMatchObject({ |
| | data: { pages: ['1'] }, |
| | hasNextPage: true, |
| | isFetching: false, |
| | isFetchingNextPage: false, |
| | isSuccess: true, |
| | }) |
| | }) |
| |
|
| | it('should build fresh cursors on refetch', async () => { |
| | const key = queryKey() |
| |
|
| | const genItems = (size: number) => |
| | [...new Array(size)].fill(null).map((_, d) => d) |
| | const items = genItems(15) |
| | const limit = 3 |
| |
|
| | const fetchItemsWithLimit = (cursor = 0, ts: number) => |
| | sleep(10).then(() => ({ |
| | nextId: cursor + limit, |
| | items: items.slice(cursor, cursor + limit), |
| | ts, |
| | })) |
| |
|
| | function Page() { |
| | let fetchCountRef = 0 |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | fetchItemsWithLimit(pageParam, fetchCountRef++), |
| | initialPageParam: 0, |
| | getNextPageParam: (lastPage) => lastPage.nextId, |
| | })) |
| |
|
| | return ( |
| | <div> |
| | <h1>Pagination</h1> |
| | <Switch |
| | fallback={ |
| | <> |
| | <div>Data:</div> |
| | <For each={state.data?.pages ?? []}> |
| | {(page, i) => ( |
| | <div> |
| | <div> |
| | Page {i()}: {page.ts} |
| | </div> |
| | <div> |
| | <Index each={page.items}> |
| | {(item) => <p>Item: {item()}</p>} |
| | </Index> |
| | </div> |
| | </div> |
| | )} |
| | </For> |
| | <div> |
| | <button |
| | onClick={() => state.fetchNextPage()} |
| | disabled={ |
| | !state.hasNextPage || Boolean(state.isFetchingNextPage) |
| | } |
| | > |
| | <Switch fallback={<>Nothing more to load</>}> |
| | <Match when={state.isFetchingNextPage}> |
| | Loading more... |
| | </Match> |
| | <Match when={state.hasNextPage}>Load More</Match> |
| | </Switch> |
| | </button> |
| | <button onClick={() => state.refetch()}>Refetch</button> |
| | <button |
| | onClick={() => { |
| | // Imagine that this mutation happens somewhere else |
| | // makes an actual network request |
| | // and calls invalidateQueries in an onSuccess |
| | items.splice(4, 1) |
| | queryClient.invalidateQueries({ queryKey: key }) |
| | }} |
| | > |
| | Remove item |
| | </button> |
| | </div> |
| | <div> |
| | {!state.isFetchingNextPage ? 'Background Updating...' : null} |
| | </div> |
| | </> |
| | } |
| | > |
| | <Match when={state.status === 'pending'}>Loading...</Match> |
| | <Match when={state.status === 'error'}> |
| | <span>Error: {state.error?.message}</span> |
| | </Match> |
| | </Switch> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | expect(rendered.getByText('Loading...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Item: 2')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 0')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByText('Load More')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | expect(rendered.getByText('Loading more...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Item: 5')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 0')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 1')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByText('Load More')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | rendered.getByText('Loading more...') |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Item: 8')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 0')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 1')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 2: 2')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByText('Refetch')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | expect(rendered.getByText('Background Updating...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(30) |
| | expect(rendered.getByText('Item: 8')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 3')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 4')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 2: 5')).toBeInTheDocument() |
| |
|
| | |
| | expect(rendered.queryAllByText('Item: 4')).toHaveLength(1) |
| |
|
| | |
| | fireEvent.click(rendered.getByText('Remove item')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | expect(rendered.getByText('Background Updating...')).toBeInTheDocument() |
| | |
| | await vi.advanceTimersByTimeAsync(30) |
| | expect(rendered.getByText('Item: 9')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 6')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 7')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 2: 8')).toBeInTheDocument() |
| |
|
| | |
| | expect(rendered.queryAllByText('Item: 4')).toHaveLength(0) |
| | }) |
| |
|
| | it('should compute hasNextPage correctly for falsy getFetchMore return value on refetching', async () => { |
| | const key = queryKey() |
| | const MAX = 2 |
| |
|
| | function Page() { |
| | let fetchCountRef = 0 |
| | const [isRemovedLastPage, setIsRemovedLastPage] = |
| | createSignal<boolean>(false) |
| |
|
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn: ({ pageParam }) => |
| | fetchItems( |
| | pageParam, |
| | fetchCountRef++, |
| | pageParam === MAX || (pageParam === MAX - 1 && isRemovedLastPage()), |
| | ), |
| | initialPageParam: 0, |
| | getNextPageParam: (lastPage) => lastPage.nextId, |
| | })) |
| |
|
| | return ( |
| | <div> |
| | <h1>Pagination</h1> |
| | <Switch |
| | fallback={ |
| | <> |
| | <div>Data:</div> |
| | <For each={state.data!.pages}> |
| | {(page, i) => ( |
| | <div> |
| | <div> |
| | Page {i()}: {page.ts} |
| | </div> |
| | <div> |
| | <Index each={page.items}> |
| | {(item) => <p>Item: {item()}</p>} |
| | </Index> |
| | </div> |
| | </div> |
| | )} |
| | </For> |
| | <div> |
| | <button |
| | onClick={() => state.fetchNextPage()} |
| | disabled={ |
| | !state.hasNextPage || Boolean(state.isFetchingNextPage) |
| | } |
| | > |
| | {state.isFetchingNextPage |
| | ? 'Loading more...' |
| | : state.hasNextPage |
| | ? 'Load More' |
| | : 'Nothing more to load'} |
| | </button> |
| | <button onClick={() => state.refetch()}>Refetch</button> |
| | <button onClick={() => setIsRemovedLastPage(true)}> |
| | Remove Last Page |
| | </button> |
| | </div> |
| | <div> |
| | {state.isFetching && !state.isFetchingNextPage |
| | ? 'Background Updating...' |
| | : null} |
| | </div> |
| | </> |
| | } |
| | > |
| | <Match when={state.status === 'pending'}>Loading...</Match> |
| | <Match when={state.status === 'error'}> |
| | <span>Error: {state.error?.message}</span> |
| | </Match> |
| | </Switch> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Page /> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | expect(rendered.getByText('Loading...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Item: 9')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 0')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByText('Load More')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | expect(rendered.getByText('Loading more...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Item: 19')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 0')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 1')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByText('Load More')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | expect(rendered.getByText('Loading more...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Item: 29')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 0: 0')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 1')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 2: 2')).toBeInTheDocument() |
| | expect(rendered.getByText('Nothing more to load')).toBeInTheDocument() |
| |
|
| | fireEvent.click(rendered.getByText('Remove Last Page')) |
| | fireEvent.click(rendered.getByText('Refetch')) |
| | await vi.advanceTimersByTimeAsync(0) |
| | expect(rendered.getByText('Background Updating...')).toBeInTheDocument() |
| | await vi.advanceTimersByTimeAsync(20) |
| | expect(rendered.getByText('Page 0: 3')).toBeInTheDocument() |
| | expect(rendered.getByText('Page 1: 4')).toBeInTheDocument() |
| | expect(rendered.getByText('Nothing more to load')).toBeInTheDocument() |
| | expect(rendered.queryByText('Item: 29')).toBeNull() |
| | expect(rendered.queryByText('Page 2: 5')).toBeNull() |
| | }) |
| |
|
| | it('should cancel the query function when there are no more subscriptions', async () => { |
| | const key = queryKey() |
| | let cancelFn: Mock = vi.fn() |
| |
|
| | const queryFn = ({ signal }: { signal?: AbortSignal }) => { |
| | const promise = new Promise<string>((resolve, reject) => { |
| | cancelFn = vi.fn(() => reject('Cancelled')) |
| | signal?.addEventListener('abort', cancelFn) |
| | sleep(20).then(() => resolve('OK')) |
| | }) |
| |
|
| | return promise |
| | } |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery(() => ({ |
| | queryKey: key, |
| | queryFn, |
| | getNextPageParam: () => undefined, |
| | initialPageParam: 0, |
| | })) |
| | return ( |
| | <div> |
| | <h1>Status: {state.status}</h1> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => ( |
| | <QueryClientProvider client={queryClient}> |
| | <Blink duration={5}> |
| | <Page /> |
| | </Blink> |
| | </QueryClientProvider> |
| | )) |
| |
|
| | await vi.advanceTimersByTimeAsync(5) |
| | expect(rendered.getByText('off')).toBeInTheDocument() |
| |
|
| | expect(cancelFn).toHaveBeenCalled() |
| | }) |
| |
|
| | it('should use provided custom queryClient', async () => { |
| | const key = queryKey() |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery( |
| | () => ({ |
| | queryKey: key, |
| | queryFn: () => sleep(10).then(() => 'custom client'), |
| | getNextPageParam: () => undefined, |
| | initialPageParam: 0, |
| | }), |
| | () => queryClient, |
| | ) |
| | return ( |
| | <div> |
| | <h1>Status: {state.data?.pages[0]}</h1> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => <Page />) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Status: custom client')).toBeInTheDocument() |
| | }) |
| |
|
| | it('should work with infiniteQueryOptions', async () => { |
| | const key = queryKey() |
| |
|
| | const options = infiniteQueryOptions({ |
| | queryKey: key, |
| | queryFn: () => sleep(10).then(() => 220), |
| | getNextPageParam: () => undefined, |
| | initialPageParam: 0, |
| | }) |
| |
|
| | function Page() { |
| | const state = useInfiniteQuery( |
| | () => options, |
| | () => queryClient, |
| | ) |
| | return ( |
| | <div> |
| | <h1>Status: {state.data?.pages[0]}</h1> |
| | </div> |
| | ) |
| | } |
| |
|
| | const rendered = render(() => <Page />) |
| |
|
| | await vi.advanceTimersByTimeAsync(10) |
| | expect(rendered.getByText('Status: 220')).toBeInTheDocument() |
| | }) |
| | }) |
| |
|