import { describe, expect, test, vi } from 'vitest' import { render, screen, waitFor } from '@solidjs/testing-library' import { QueryClient, useQueries, useQuery } from '@tanstack/solid-query' import { persistQueryClientSave } from '@tanstack/query-persist-client-core' import { createEffect, createSignal, onMount } from 'solid-js' import { queryKey, sleep } from '@tanstack/query-test-utils' import { PersistQueryClientProvider } from '../PersistQueryClientProvider' import type { PersistedClient, Persister, } from '@tanstack/query-persist-client-core' 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<{ status: string fetchStatus: string data: string | undefined }> = [] 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' }, })) createEffect(() => states.push({ status: state.status, fetchStatus: state.fetchStatus, data: state.data, }), ) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } render(() => ( )) await waitFor(() => screen.getByText('fetchStatus: idle')) await waitFor(() => screen.getByText('hydrated')) await waitFor(() => screen.getByText('fetched')) expect(states).toHaveLength(3) 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: 'idle', data: 'fetched', }) }) test('should also put useQueries into idle state', async () => { const key = queryKey() const states: Array<{ status: string fetchStatus: string data: string | undefined }> = [] 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' }, }, ] as const, })) createEffect(() => states.push({ status: state.status, fetchStatus: state.fetchStatus, data: state.data, }), ) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } render(() => ( )) await waitFor(() => screen.getByText('fetchStatus: idle')) await waitFor(() => screen.getByText('hydrated')) await waitFor(() => screen.getByText('fetched')) expect(states).toHaveLength(3) 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: 'idle', data: 'fetched', }) }) test('should show initialData while restoring', async () => { const key = queryKey() const states: Array<{ status: string fetchStatus: string data: string | undefined }> = [] 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, })) createEffect(() => states.push({ status: state.status, fetchStatus: state.fetchStatus, data: state.data, }), ) return (

{state.data}

fetchStatus: {state.fetchStatus}

) } render(() => ( )) await waitFor(() => screen.getByText('initial')) await waitFor(() => screen.getByText('hydrated')) await waitFor(() => screen.getByText('fetched')) expect(states).toHaveLength(3) 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: 'idle', data: 'fetched', }) }) test('should not refetch after restoring when data is fresh', async () => { const key = queryKey() const states: Array<{ status: string fetchStatus: string data: string | undefined }> = [] 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 () => { fetched = true await sleep(10) return 'fetched' }, staleTime: Infinity, })) createEffect(() => states.push({ status: state.status, fetchStatus: state.fetchStatus, data: state.data, }), ) return (

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

fetchStatus: {state.fetchStatus}

) } render(() => ( )) await waitFor(() => screen.getByText('data: null')) await waitFor(() => screen.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() render(() => ( )) expect(onSuccess).toHaveBeenCalledTimes(0) await waitFor(() => screen.getByText('hydrated')) expect(onSuccess).toHaveBeenCalledTimes(1) await waitFor(() => screen.getByText('fetched')) }) test('should remove cache after non-successful restoring', async () => { const key = queryKey() const onErrorMock = vi .spyOn(console, 'error') .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}

) } render(() => ( )) await waitFor(() => screen.getByText('fetched')) expect(removeClient).toHaveBeenCalledTimes(1) expect(onSuccess).toHaveBeenCalledTimes(0) expect(onError).toHaveBeenCalledTimes(1) expect(onErrorMock).toHaveBeenCalledTimes(1) expect(onErrorMock).toHaveBeenNthCalledWith(1, error) onErrorMock.mockRestore() }) test('should be able to persist into multiple clients', async () => { const key = queryKey() const states: Array<{ status: string fetchStatus: string data: string | undefined }> = [] 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] = createSignal( new QueryClient({ defaultOptions: { queries: { queryFn: queryFn1, }, }, }), ) onMount(() => { setClient( new QueryClient({ defaultOptions: { queries: { queryFn: queryFn2, }, }, }), ) }) return ( ) } function Page() { const state = useQuery(() => ({ queryKey: key })) createEffect(() => states.push({ status: state.status, fetchStatus: state.fetchStatus, data: state.data as string | undefined, }), ) return (

{String(state.data)}

fetchStatus: {state.fetchStatus}

) } render(() => ) await waitFor(() => screen.getByText('hydrated')) await waitFor(() => screen.getByText('queryFn2')) expect(queryFn1).toHaveBeenCalledTimes(0) expect(queryFn2).toHaveBeenCalledTimes(1) expect(onSuccess).toHaveBeenCalledTimes(1) expect(states).toHaveLength(3) 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: 'idle', data: 'queryFn2', }) }) })