Skip to content

test(angular-query-persist-client/withPersistQueryClient): switch to fake timers, replace 'waitFor' with 'advanceTimersByTimeAsync', use 'sleep().then()' pattern, replace 'screen' with 'rendered', add 'toBeInTheDocument', and add '@testing-library/jest-dom/vitest' #9895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+82 −52
Open

test(angular-query-persist-client/withPersistQueryClient): switch to fake timers, replace 'waitFor' with 'advanceTimersByTimeAsync', use 'sleep().then()' pattern, replace 'screen' with 'rendered', add 'toBeInTheDocument', and add '@testing-library/jest-dom/vitest' #9895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
914e012
test(angular-query-persist-client/withPersistQueryClient): switch to …
sukvvon Nov 23, 2025
3f92720
test(angular-query-persist-client/withPersistQueryClient): replace 'a…
sukvvon Nov 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 81 additions & 52 deletions packages/angular-query-persist-client/src/__tests__/with-persist-query-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { describe, expect, test, vi } from 'vitest'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import {
QueryClient,
injectQuery,
Expand All @@ -10,14 +10,22 @@ import {
effect,
provideZonelessChangeDetection,
} from '@angular/core'
import { render, screen, waitFor } from '@testing-library/angular'
import { render } from '@testing-library/angular'
import { queryKey, sleep } from '@tanstack/query-test-utils'
import { withPersistQueryClient } from '../with-persist-query-client'
import type {
PersistedClient,
Persister,
} from '@tanstack/query-persist-client-core'

beforeEach(() => {
vi.useFakeTimers()
})

afterEach(() => {
vi.useRealTimers()
})

const createMockPersister = (): Persister => {
let storedState: PersistedClient | undefined

Expand All @@ -26,8 +34,7 @@ const createMockPersister = (): Persister => {
storedState = persistClient
},
async restoreClient() {
await sleep(10)
return storedState
return sleep(10).then(() => storedState)
},
removeClient() {
storedState = undefined
Expand All @@ -46,8 +53,9 @@ const createMockErrorPersister = (
// noop
},
async restoreClient() {
await sleep(10)
throw error
return sleep(10).then(() => {
throw error
})
},
removeClient,
},
Expand All @@ -64,14 +72,16 @@ describe('withPersistQueryClient', () => {
}> = []

const queryClient = new QueryClient()
await queryClient.prefetchQuery({
queryClient.prefetchQuery({
queryKey: key,
queryFn: () => Promise.resolve('hydrated'),
queryFn: () => sleep(10).then(() => 'hydrated'),
})
await vi.advanceTimersByTimeAsync(10)

const persister = createMockPersister()

await persistQueryClientSave({ queryClient, persister })
persistQueryClientSave({ queryClient, persister })
await vi.advanceTimersByTimeAsync(0)

queryClient.clear()

Expand All @@ -86,10 +96,7 @@ describe('withPersistQueryClient', () => {
class Page {
state = injectQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
return 'fetched'
},
queryFn: () => sleep(10).then(() => 'fetched'),
}))
_ = effect(() => {
states.push({
Expand All @@ -100,7 +107,7 @@ describe('withPersistQueryClient', () => {
})
}

render(Page, {
const rendered = await render(Page, {
providers: [
provideZonelessChangeDetection(),
provideTanStackQuery(
Expand All @@ -110,9 +117,14 @@ describe('withPersistQueryClient', () => {
],
})

await waitFor(() => screen.getByText('fetchStatus: idle'))
await waitFor(() => screen.getByText('hydrated'))
await waitFor(() => screen.getByText('fetched'))
expect(rendered.getByText('fetchStatus: idle')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(10)
rendered.fixture.detectChanges()
expect(rendered.getByText('hydrated')).toBeInTheDocument()

await vi.advanceTimersByTimeAsync(11)
rendered.fixture.detectChanges()
expect(rendered.getByText('fetched')).toBeInTheDocument()

expect(states).toHaveLength(3)

Expand Down Expand Up @@ -148,14 +160,16 @@ describe('withPersistQueryClient', () => {
}> = []

const queryClient = new QueryClient()
await queryClient.prefetchQuery({
queryClient.prefetchQuery({
queryKey: key,
queryFn: () => Promise.resolve('hydrated'),
queryFn: () => sleep(10).then(() => 'hydrated'),
})
await vi.advanceTimersByTimeAsync(10)

const persister = createMockPersister()

await persistQueryClientSave({ queryClient, persister })
persistQueryClientSave({ queryClient, persister })
await vi.advanceTimersByTimeAsync(0)

queryClient.clear()

Expand All @@ -170,10 +184,7 @@ describe('withPersistQueryClient', () => {
class Page {
state = injectQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
return 'fetched'
},
queryFn: () => sleep(10).then(() => 'fetched'),
initialData: 'initial',
// make sure that initial data is older than the hydration data
// otherwise initialData would be newer and takes precedence
Expand All @@ -188,7 +199,7 @@ describe('withPersistQueryClient', () => {
})
}

render(Page, {
const rendered = await render(Page, {
providers: [
provideZonelessChangeDetection(),
provideTanStackQuery(
Expand All @@ -198,7 +209,14 @@ describe('withPersistQueryClient', () => {
],
})

await waitFor(() => screen.getByText('fetched'))
expect(rendered.getByText('initial')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(10)
rendered.fixture.detectChanges()
expect(rendered.getByText('hydrated')).toBeInTheDocument()

await vi.advanceTimersByTimeAsync(11)
rendered.fixture.detectChanges()
expect(rendered.getByText('fetched')).toBeInTheDocument()

expect(states).toHaveLength(3)

Expand Down Expand Up @@ -230,14 +248,16 @@ describe('withPersistQueryClient', () => {
}> = []

const queryClient = new QueryClient()
await queryClient.prefetchQuery({
queryClient.prefetchQuery({
queryKey: key,
queryFn: () => Promise.resolve('hydrated'),
queryFn: () => sleep(10).then(() => 'hydrated'),
})
await vi.advanceTimersByTimeAsync(10)

const persister = createMockPersister()

await persistQueryClientSave({ queryClient, persister })
persistQueryClientSave({ queryClient, persister })
await vi.advanceTimersByTimeAsync(0)

queryClient.clear()

Expand All @@ -254,11 +274,11 @@ describe('withPersistQueryClient', () => {
class Page {
state = injectQuery(() => ({
queryKey: key,
queryFn: async () => {
fetched = true
await sleep(10)
return 'fetched'
},
queryFn: () =>
sleep(10).then(() => {
fetched = true
return 'fetched'
}),
staleTime: Infinity,
}))
_ = effect(() => {
Expand All @@ -270,7 +290,7 @@ describe('withPersistQueryClient', () => {
})
}

render(Page, {
const rendered = await render(Page, {
providers: [
provideZonelessChangeDetection(),
provideTanStackQuery(
Expand All @@ -280,8 +300,10 @@ describe('withPersistQueryClient', () => {
],
})

await waitFor(() => screen.getByText('data: null'))
await waitFor(() => screen.getByText('data: hydrated'))
expect(rendered.getByText('data: null')).toBeInTheDocument()
await vi.advanceTimersByTimeAsync(10)
rendered.fixture.detectChanges()
expect(rendered.getByText('data: hydrated')).toBeInTheDocument()

expect(states).toHaveLength(2)

Expand All @@ -303,13 +325,15 @@ describe('withPersistQueryClient', () => {
test('should call onSuccess after successful restoring', async () => {
const key = queryKey()
const queryClient = new QueryClient()
await queryClient.prefetchQuery({
queryClient.prefetchQuery({
queryKey: key,
queryFn: () => Promise.resolve('hydrated'),
queryFn: () => sleep(10).then(() => 'hydrated'),
})
await vi.advanceTimersByTimeAsync(10)

const persister = createMockPersister()
await persistQueryClientSave({ queryClient, persister })
persistQueryClientSave({ queryClient, persister })
await vi.advanceTimersByTimeAsync(0)

queryClient.clear()

Expand All @@ -324,16 +348,13 @@ describe('withPersistQueryClient', () => {
class Page {
state = injectQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
return 'fetched'
},
queryFn: () => sleep(10).then(() => 'fetched'),
}))
}

const onSuccess = vi.fn()

render(Page, {
const rendered = await render(Page, {
providers: [
provideZonelessChangeDetection(),
provideTanStackQuery(
Expand All @@ -347,8 +368,14 @@ describe('withPersistQueryClient', () => {
})

expect(onSuccess).toHaveBeenCalledTimes(0)
await waitFor(() => screen.getByText('fetched'))
await vi.advanceTimersByTimeAsync(10)
rendered.fixture.detectChanges()
expect(rendered.getByText('hydrated')).toBeInTheDocument()
expect(onSuccess).toHaveBeenCalledTimes(1)

await vi.advanceTimersByTimeAsync(11)
rendered.fixture.detectChanges()
expect(rendered.getByText('fetched')).toBeInTheDocument()
})

test('should remove cache after non-successful restoring', async () => {
Expand All @@ -373,14 +400,11 @@ describe('withPersistQueryClient', () => {
class Page {
state = injectQuery(() => ({
queryKey: key,
queryFn: async () => {
await sleep(10)
return 'fetched'
},
queryFn: () => sleep(10).then(() => 'fetched'),
}))
}

render(Page, {
const rendered = await render(Page, {
providers: [
provideZonelessChangeDetection(),
provideTanStackQuery(
Expand All @@ -394,11 +418,16 @@ describe('withPersistQueryClient', () => {
],
})

await waitFor(() => screen.getByText('fetched'))
await vi.advanceTimersByTimeAsync(10)
rendered.fixture.detectChanges()
expect(removeClient).toHaveBeenCalledTimes(1)
expect(onSuccess).toHaveBeenCalledTimes(0)
expect(onError).toHaveBeenCalledTimes(1)

await vi.advanceTimersByTimeAsync(11)
rendered.fixture.detectChanges()
expect(rendered.getByText('fetched')).toBeInTheDocument()

expect(onErrorMock).toHaveBeenCalledTimes(1)
expect(onErrorMock).toHaveBeenNthCalledWith(1, error)
onErrorMock.mockRestore()
Expand Down
1 change: 1 addition & 0 deletions packages/angular-query-persist-client/test-setup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import '@testing-library/jest-dom/vitest'
import { getTestBed } from '@angular/core/testing'
import {
BrowserTestingModule,
Expand Down
Loading