Skip to content

test(query-core): add test case for queryObserver #9146

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.

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

Merged
merged 3 commits into from
May 14, 2025
Merged
Changes from all commits
Commits
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
86 changes: 86 additions & 0 deletions packages/query-core/src/__tests__/queryObserver.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1271,4 +1271,90 @@ describe('queryObserver', () => {

unsubscribe()
})

test('shouldFetchOnWindowFocus should respect refetchOnWindowFocus option', () => {
const key = queryKey()

const observer1 = new QueryObserver(queryClient, {
queryKey: key,
queryFn: () => 'data',
refetchOnWindowFocus: true,
})
expect(observer1.shouldFetchOnWindowFocus()).toBe(true)

const observer2 = new QueryObserver(queryClient, {
queryKey: key,
queryFn: () => 'data',
refetchOnWindowFocus: false,
})
expect(observer2.shouldFetchOnWindowFocus()).toBe(false)
})

test('fetchOptimistic should fetch and return optimistic result', async () => {
const key = queryKey()
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: () => 'data',
})

const result = await observer.fetchOptimistic({
queryKey: key,
queryFn: () => 'data',
})

expect(result.status).toBe('success')
expect(result.data).toBe('data')
})

test('should track error prop when throwOnError is true', async () => {
const key = queryKey()
const results: Array<QueryObserverResult> = []
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: () => Promise.reject('error'),
retry: false,
throwOnError: true,
})

const trackedResult = observer.trackResult(
observer.getCurrentResult(),
(prop) => {
if (prop === 'data' || prop === 'status') {
observer.trackProp(prop)
}
},
)

trackedResult.data
trackedResult.status

const unsubscribe = observer.subscribe((result) => {
results.push(result)
})

await vi.waitFor(() => {
const lastResult = results[results.length - 1]
expect(lastResult?.status).toBe('error')
})

expect(results.length).toBe(1)
expect(results[0]).toMatchObject({
status: 'error',
error: 'error',
})

unsubscribe()
})

test('should set fetchStatus to idle when _optimisticResults is isRestoring', () => {
const key = queryKey()
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: () => 'data',
_optimisticResults: 'isRestoring',
})

const result = observer.getCurrentResult()
expect(result.fetchStatus).toBe('idle')
})
})