Skip to content
Open
Show file tree
Hide file tree
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
26 changes: 25 additions & 1 deletion packages/query-core/src/__tests__/queryCache.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,36 @@ describe('queryCache', () => {
})
await vi.advanceTimersByTimeAsync(100)
const query = testCache.find({ queryKey: key })
expect(onError).toHaveBeenCalledWith('error', query)
expect(onError).toHaveBeenCalledWith('error', query, {
retryAttempt: 0,
})
expect(onError).toHaveBeenCalledTimes(1)
expect(onSuccess).not.toHaveBeenCalled()
expect(onSettled).toHaveBeenCalledTimes(1)
expect(onSettled).toHaveBeenCalledWith(undefined, 'error', query)
})

it('should include retryAttempt in the onError context', async () => {
const key = queryKey()
const onError = vi.fn()
const testCache = new QueryCache({ onError })
const testClient = new QueryClient({ queryCache: testCache })

testClient.prefetchQuery({
queryKey: key,
queryFn: () => sleep(0).then(() => Promise.reject('error')),
retry: 2,
retryDelay: 0,
})

await vi.advanceTimersByTimeAsync(10)

const query = testCache.find({ queryKey: key })
expect(onError).toHaveBeenCalledTimes(1)
expect(onError).toHaveBeenCalledWith('error', query, {
retryAttempt: 2,
})
})
})

describe('QueryCacheConfig success callbacks', () => {
Expand Down
3 changes: 3 additions & 0 deletions packages/query-core/src/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,7 @@ export class Query<
}

// Try to fetch the data
let latestFailureRetryCount = 0
this.#retryer = createRetryer({
initialPromise: fetchOptions?.initialPromise as
| Promise<TData>
Expand All @@ -548,6 +549,7 @@ export class Query<
abortController.abort()
},
onFail: (failureCount, error) => {
latestFailureRetryCount = failureCount
this.#dispatch({ type: 'failed', failureCount, error })
},
onPause: () => {
Expand Down Expand Up @@ -610,6 +612,7 @@ export class Query<
this.#cache.config.onError?.(
error as any,
this as Query<any, any, any, any>,
{ retryAttempt: latestFailureRetryCount },
)
this.#cache.config.onSettled?.(
this.state.data,
Expand Down
3 changes: 3 additions & 0 deletions packages/query-core/src/queryCache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ interface QueryCacheConfig {
onError?: (
error: DefaultError,
query: Query<unknown, unknown, unknown>,
context: {
retryAttempt: number
},
) => void
onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void
onSettled?: (
Expand Down