import { describe, expect, test, vi } from 'vitest' import * as React from 'react' import { fireEvent, render, waitFor } from '@testing-library/react' import { QueryClient, useQueries, useQuery } from '@tanstack/react-query' import { persistQueryClientSave } from '@tanstack/query-persist-client-core' import { queryKey, sleep } from '@tanstack/query-test-utils' import { PersistQueryClientProvider } from '../PersistQueryClientProvider' import type { PersistedClient, Persister, } from '@tanstack/query-persist-client-core' import type { DefinedUseQueryResult, UseQueryResult, } from '@tanstack/react-query' const createMockPersister = (): Persister => { let storedState: PersistedClient | undefined return { persistClient(persistClient: PersistedClient) { storedState = persistClient }, async restoreClient() { await sleep(10) return storedState }, removeClient() { storedState = undefined }, } } const createMockErrorPersister = ( removeClient: Persister['removeClient'], ): [Error, Persister] => { const error = new Error('restore failed') return [ error, { async persistClient() { // noop }, async restoreClient() { await sleep(10) throw error }, removeClient, }, ] } describe('PersistQueryClientProvider', () => { test('restores cache from persister', async () => { const key = queryKey() const states: Array> = [] const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { await sleep(10) return 'fetched' }, }) states.push(state) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , ) await waitFor(() => rendered.getByText('fetchStatus: idle')) await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('fetched')) expect(states).toHaveLength(4) expect(states[0]).toMatchObject({ status: 'pending', fetchStatus: 'idle', data: undefined, }) expect(states[1]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[2]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[3]).toMatchObject({ status: 'success', fetchStatus: 'idle', data: 'fetched', }) }) test('should subscribe correctly in StrictMode', async () => { const key = queryKey() const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { await sleep(10) return 'fetched' }, }) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , , ) await waitFor(() => rendered.getByText('fetchStatus: idle')) await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('fetched')) fireEvent.click(rendered.getByRole('button', { name: /update/i })) await waitFor(() => rendered.getByText('updated')) const state = await persister.restoreClient() expect(state?.clientState.queries[0]?.state.data).toBe('updated') }) test('should also put useQueries into idle state', async () => { const key = queryKey() const states: Array = [] const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() function Page() { const [state] = useQueries({ queries: [ { queryKey: key, queryFn: async (): Promise => { await sleep(10) return 'fetched' }, }, ], }) states.push(state) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , ) await waitFor(() => rendered.getByText('fetchStatus: idle')) await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('fetched')) expect(states).toHaveLength(4) expect(states[0]).toMatchObject({ status: 'pending', fetchStatus: 'idle', data: undefined, }) expect(states[1]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[2]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[3]).toMatchObject({ status: 'success', fetchStatus: 'idle', data: 'fetched', }) }) test('should show initialData while restoring', async () => { const key = queryKey() const states: Array> = [] const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { await sleep(10) return 'fetched' }, initialData: 'initial', // make sure that initial data is older than the hydration data // otherwise initialData would be newer and takes precedence initialDataUpdatedAt: 1, }) states.push(state) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , ) await waitFor(() => rendered.getByText('initial')) await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('fetched')) expect(states).toHaveLength(4) expect(states[0]).toMatchObject({ status: 'success', fetchStatus: 'idle', data: 'initial', }) expect(states[1]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[2]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[3]).toMatchObject({ status: 'success', fetchStatus: 'idle', data: 'fetched', }) }) test('should not refetch after restoring when data is fresh', async () => { const key = queryKey() const states: Array> = [] const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() let fetched = false function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { // eslint-disable-next-line react-hooks/react-compiler fetched = true await sleep(10) return 'fetched' }, staleTime: Infinity, }) states.push(state) return (

data: {state.data ?? 'null'}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , ) await waitFor(() => rendered.getByText('data: null')) await waitFor(() => rendered.getByText('data: hydrated')) expect(states).toHaveLength(2) expect(fetched).toBe(false) expect(states[0]).toMatchObject({ status: 'pending', fetchStatus: 'idle', data: undefined, }) expect(states[1]).toMatchObject({ status: 'success', fetchStatus: 'idle', data: 'hydrated', }) }) test('should call onSuccess after successful restoring', async () => { const key = queryKey() const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { await sleep(10) return 'fetched' }, }) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const onSuccess = vi.fn() const rendered = render( , ) expect(onSuccess).toHaveBeenCalledTimes(0) await waitFor(() => rendered.getByText('hydrated')) expect(onSuccess).toHaveBeenCalledTimes(1) await waitFor(() => rendered.getByText('fetched')) }) test('should await onSuccess after successful restoring', async () => { const key = queryKey() const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() const states: Array = [] function Page() { const { data, fetchStatus } = useQuery({ queryKey: key, queryFn: async () => { states.push('fetching') await sleep(10) states.push('fetched') return 'fetched' }, }) return (

{data}

fetchStatus: {fetchStatus}

) } const rendered = render( { states.push('onSuccess') await sleep(20) states.push('onSuccess done') }} > , ) await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('fetched')) expect(states).toEqual([ 'onSuccess', 'onSuccess done', 'fetching', 'fetched', ]) }) test('should remove cache after non-successful restoring', async () => { const key = queryKey() const consoleMock = vi.spyOn(console, 'error') const consoleWarn = vi .spyOn(console, 'warn') .mockImplementation(() => undefined) consoleMock.mockImplementation(() => undefined) const queryClient = new QueryClient() const removeClient = vi.fn() const onSuccess = vi.fn() const onError = vi.fn() const [error, persister] = createMockErrorPersister(removeClient) function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { await sleep(10) return 'fetched' }, }) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , ) await waitFor(() => rendered.getByText('fetched')) expect(removeClient).toHaveBeenCalledTimes(1) expect(onSuccess).toHaveBeenCalledTimes(0) expect(onError).toHaveBeenCalledTimes(1) expect(consoleMock).toHaveBeenCalledTimes(1) expect(consoleMock).toHaveBeenNthCalledWith(1, error) consoleMock.mockRestore() consoleWarn.mockRestore() }) test('should be able to persist into multiple clients', async () => { const key = queryKey() const states: Array = [] const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createMockPersister() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() const onSuccess = vi.fn() const queryFn1 = vi.fn().mockImplementation(async () => { await sleep(10) return 'queryFn1' }) const queryFn2 = vi.fn().mockImplementation(async () => { await sleep(10) return 'queryFn2' }) function App() { const [client, setClient] = React.useState( () => new QueryClient({ defaultOptions: { queries: { queryFn: queryFn1, }, }, }), ) React.useEffect(() => { setClient( new QueryClient({ defaultOptions: { queries: { queryFn: queryFn2, }, }, }), ) }, []) return ( ) } function Page() { const state = useQuery({ queryKey: key }) states.push(state) return (

{String(state.data)}

fetchStatus: {state.fetchStatus}

) } const rendered = render() await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('queryFn2')) expect(queryFn1).toHaveBeenCalledTimes(0) expect(queryFn2).toHaveBeenCalledTimes(1) expect(onSuccess).toHaveBeenCalledTimes(1) expect(states).toHaveLength(5) expect(states[0]).toMatchObject({ status: 'pending', fetchStatus: 'idle', data: undefined, }) expect(states[1]).toMatchObject({ status: 'pending', fetchStatus: 'idle', data: undefined, }) expect(states[2]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[3]).toMatchObject({ status: 'success', fetchStatus: 'fetching', data: 'hydrated', }) expect(states[4]).toMatchObject({ status: 'success', fetchStatus: 'idle', data: 'queryFn2', }) }) test('should only restore once in StrictMode', async () => { let restoreCount = 0 const createPersister = (): Persister => { let storedState: PersistedClient | undefined return { persistClient(persistClient) { storedState = persistClient }, async restoreClient() { restoreCount++ await sleep(10) return storedState }, removeClient() { storedState = undefined }, } } const key = queryKey() const queryClient = new QueryClient() await queryClient.prefetchQuery({ queryKey: key, queryFn: () => Promise.resolve('hydrated'), }) const persister = createPersister() const onSuccess = vi.fn() await persistQueryClientSave({ queryClient, persister }) queryClient.clear() function Page() { const state = useQuery({ queryKey: key, queryFn: async () => { await sleep(10) return 'fetched' }, }) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } const rendered = render( , ) await waitFor(() => rendered.getByText('fetchStatus: idle')) await waitFor(() => rendered.getByText('hydrated')) await waitFor(() => rendered.getByText('fetched')) expect(onSuccess).toHaveBeenCalledTimes(1) expect(restoreCount).toBe(1) }) })