@tanstack/query-core 5.85.1 → 5.85.3

package/build/modern/utils.d.ts

@@ -1,3 +1,3 @@
-export { j as MutationFilters, l as QueryFilters, bk as QueryTypeFilter, S as SkipToken, U as Updater, bw as addToEnd, bx as addToStart, by as ensureQueryFn, bl as functionalUpdate, h as hashKey, bq as hashQueryKeyByOptions, bs as isPlainArray, bt as isPlainObject, i as isServer, bm as isValidTimeout, k as keepPreviousData, f as matchMutation, m as matchQuery, n as noop, p as partialMatchKey, bv as replaceData, r as replaceEqualDeep, bp as resolveEnabled, bo as resolveStaleTime, br as shallowEqualObjects, g as shouldThrowError, s as skipToken, bu as sleep, bn as timeUntilStale } from './hydration-Cvr-9VdO.js';
+export { j as MutationFilters, l as QueryFilters, bk as QueryTypeFilter, S as SkipToken, U as Updater, bw as addToEnd, bx as addToStart, by as ensureQueryFn, bl as functionalUpdate, h as hashKey, bq as hashQueryKeyByOptions, bs as isPlainArray, bt as isPlainObject, i as isServer, bm as isValidTimeout, k as keepPreviousData, f as matchMutation, m as matchQuery, n as noop, p as partialMatchKey, bv as replaceData, r as replaceEqualDeep, bp as resolveEnabled, bo as resolveStaleTime, br as shallowEqualObjects, g as shouldThrowError, s as skipToken, bu as sleep, bn as timeUntilStale } from './hydration-D0MPgBG9.js';
 import './removable.js';
 import './subscribable.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "5.85.1",
+  "version": "5.85.3",
   "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/query.ts

@@ -8,7 +8,7 @@ import {
   timeUntilStale,
 } from './utils'
 import { notifyManager } from './notifyManager'
-import { canFetch, createRetryer, isCancelledError } from './retryer'
+import { CancelledError, canFetch, createRetryer } from './retryer'
 import { Removable } from './removable'
 import type { QueryCache } from './queryCache'
 import type { QueryClient } from './queryClient'
@@ -372,11 +372,17 @@ export class Query<
     }
   }
 
-  fetch(
+  async fetch(
     options?: QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
     fetchOptions?: FetchOptions<TQueryFnData>,
   ): Promise<TData> {
-    if (this.state.fetchStatus !== 'idle') {
+    if (
+      this.state.fetchStatus !== 'idle' &&
+      // If the promise in the retyer is already rejected, we have to definitely
+      // re-start the fetch; there is a chance that the query is still in a
+      // pending state when that happens
+      this.#retryer?.status() !== 'rejected'
+    ) {
       if (this.state.data !== undefined && fetchOptions?.cancelRefetch) {
         // Silently cancel current fetch if the user wants to cancel refetch
         this.cancel({ silent: true })
@@ -495,32 +501,6 @@ export class Query<
       this.#dispatch({ type: 'fetch', meta: context.fetchOptions?.meta })
     }
 
-    const onError = (error: TError | { silent?: boolean }) => {
-      // Optimistically update state if needed
-      if (!(isCancelledError(error) && error.silent)) {
-        this.#dispatch({
-          type: 'error',
-          error: error as TError,
-        })
-      }
-
-      if (!isCancelledError(error)) {
-        // Notify cache callback
-        this.#cache.config.onError?.(
-          error as any,
-          this as Query<any, any, any, any>,
-        )
-        this.#cache.config.onSettled?.(
-          this.state.data,
-          error as any,
-          this as Query<any, any, any, any>,
-        )
-      }
-
-      // Schedule query gc after fetching
-      this.scheduleGc()
-    }
-
     // Try to fetch the data
     this.#retryer = createRetryer({
       initialPromise: fetchOptions?.initialPromise as
@@ -528,36 +508,6 @@ export class Query<
         | undefined,
       fn: context.fetchFn as () => Promise<TData>,
       abort: abortController.abort.bind(abortController),
-      onSuccess: (data) => {
-        if (data === undefined) {
-          if (process.env.NODE_ENV !== 'production') {
-            console.error(
-              `Query data cannot be undefined. Please make sure to return a value other than undefined from your query function. Affected query key: ${this.queryHash}`,
-            )
-          }
-          onError(new Error(`${this.queryHash} data is undefined`) as any)
-          return
-        }
-
-        try {
-          this.setData(data)
-        } catch (error) {
-          onError(error as TError)
-          return
-        }
-
-        // Notify cache callback
-        this.#cache.config.onSuccess?.(data, this as Query<any, any, any, any>)
-        this.#cache.config.onSettled?.(
-          data,
-          this.state.error as any,
-          this as Query<any, any, any, any>,
-        )
-
-        // Schedule query gc after fetching
-        this.scheduleGc()
-      },
-      onError,
       onFail: (failureCount, error) => {
         this.#dispatch({ type: 'failed', failureCount, error })
       },
@@ -573,7 +523,65 @@ export class Query<
       canRun: () => true,
     })
 
-    return this.#retryer.start()
+    try {
+      const data = await this.#retryer.start()
+      // this is more of a runtime guard
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      if (data === undefined) {
+        if (process.env.NODE_ENV !== 'production') {
+          console.error(
+            `Query data cannot be undefined. Please make sure to return a value other than undefined from your query function. Affected query key: ${this.queryHash}`,
+          )
+        }
+        throw new Error(`${this.queryHash} data is undefined`)
+      }
+
+      this.setData(data)
+
+      // Notify cache callback
+      this.#cache.config.onSuccess?.(data, this as Query<any, any, any, any>)
+      this.#cache.config.onSettled?.(
+        data,
+        this.state.error as any,
+        this as Query<any, any, any, any>,
+      )
+      return data
+    } catch (error) {
+      if (error instanceof CancelledError) {
+        if (error.silent) {
+          // silent cancellation implies a new fetch is going to be started,
+          // so we hatch onto that promise
+          return this.#retryer.promise
+        } else if (error.revert) {
+          this.setState({
+            ...this.#revertState,
+            fetchStatus: 'idle' as const,
+          })
+          // transform error into reverted state data
+          return this.state.data!
+        }
+      }
+      this.#dispatch({
+        type: 'error',
+        error: error as TError,
+      })
+
+      // Notify cache callback
+      this.#cache.config.onError?.(
+        error as any,
+        this as Query<any, any, any, any>,
+      )
+      this.#cache.config.onSettled?.(
+        this.state.data,
+        error as any,
+        this as Query<any, any, any, any>,
+      )
+
+      throw error // rethrow the error for further handling
+    } finally {
+      // Schedule query gc after fetching
+      this.scheduleGc()
+    }
   }
 
   #dispatch(action: Action<TData, TError>): void {
@@ -618,7 +626,6 @@ export class Query<
               fetchFailureReason: null,
             }),
           }
-
           // If fetching ends successfully, we don't need revertState as a fallback anymore.
           // For manual updates, capture the state to revert to it in case of a cancellation.
           this.#revertState = action.manual ? newState : undefined
@@ -626,11 +633,6 @@ export class Query<
           return newState
         case 'error':
           const error = action.error
-
-          if (isCancelledError(error) && error.revert && this.#revertState) {
-            return { ...this.#revertState, fetchStatus: 'idle' }
-          }
-
           return {
             ...state,
             error,

package/src/retryer.ts

@@ -2,6 +2,7 @@ import { focusManager } from './focusManager'
 import { onlineManager } from './onlineManager'
 import { pendingThenable } from './thenable'
 import { isServer, sleep } from './utils'
+import type { Thenable } from './thenable'
 import type { CancelOptions, DefaultError, NetworkMode } from './types'
 
 // TYPES
@@ -10,8 +11,6 @@ interface RetryerConfig<TData = unknown, TError = DefaultError> {
   fn: () => TData | Promise<TData>
   initialPromise?: Promise<TData>
   abort?: () => void
-  onError?: (error: TError) => void
-  onSuccess?: (data: TData) => void
   onFail?: (failureCount: number, error: TError) => void
   onPause?: () => void
   onContinue?: () => void
@@ -29,6 +28,7 @@ export interface Retryer<TData = unknown> {
   continueRetry: () => void
   canStart: () => boolean
   start: () => Promise<TData>
+  status: () => 'pending' | 'resolved' | 'rejected'
 }
 
 export type RetryValue<TError> = boolean | number | ShouldRetryFunction<TError>
@@ -65,6 +65,9 @@ export class CancelledError extends Error {
   }
 }
 
+/**
+ * @deprecated Use instanceof `CancelledError` instead.
+ */
 export function isCancelledError(value: any): value is CancelledError {
   return value instanceof CancelledError
 }
@@ -74,13 +77,15 @@ export function createRetryer<TData = unknown, TError = DefaultError>(
 ): Retryer<TData> {
   let isRetryCancelled = false
   let failureCount = 0
-  let isResolved = false
   let continueFn: ((value?: unknown) => void) | undefined
 
   const thenable = pendingThenable<TData>()
 
+  const isResolved = () =>
+    (thenable.status as Thenable<TData>['status']) !== 'pending'
+
   const cancel = (cancelOptions?: CancelOptions): void => {
-    if (!isResolved) {
+    if (!isResolved()) {
       reject(new CancelledError(cancelOptions))
 
       config.abort?.()
@@ -102,18 +107,14 @@ export function createRetryer<TData = unknown, TError = DefaultError>(
   const canStart = () => canFetch(config.networkMode) && config.canRun()
 
   const resolve = (value: any) => {
-    if (!isResolved) {
-      isResolved = true
-      config.onSuccess?.(value)
+    if (!isResolved()) {
       continueFn?.()
       thenable.resolve(value)
     }
   }
 
   const reject = (value: any) => {
-    if (!isResolved) {
-      isResolved = true
-      config.onError?.(value)
+    if (!isResolved()) {
       continueFn?.()
       thenable.reject(value)
     }
@@ -122,14 +123,14 @@ export function createRetryer<TData = unknown, TError = DefaultError>(
   const pause = () => {
     return new Promise((continueResolve) => {
       continueFn = (value) => {
-        if (isResolved || canContinue()) {
+        if (isResolved() || canContinue()) {
           continueResolve(value)
         }
       }
       config.onPause?.()
     }).then(() => {
       continueFn = undefined
-      if (!isResolved) {
+      if (!isResolved()) {
         config.onContinue?.()
       }
     })
@@ -138,7 +139,7 @@ export function createRetryer<TData = unknown, TError = DefaultError>(
   // Create loop function
   const run = () => {
     // Do nothing if already resolved
-    if (isResolved) {
+    if (isResolved()) {
       return
     }
 
@@ -159,7 +160,7 @@ export function createRetryer<TData = unknown, TError = DefaultError>(
       .then(resolve)
       .catch((error) => {
         // Stop if the fetch is already resolved
-        if (isResolved) {
+        if (isResolved()) {
           return
         }
 
@@ -204,6 +205,7 @@ export function createRetryer<TData = unknown, TError = DefaultError>(
 
   return {
     promise: thenable,
+    status: () => thenable.status,
     cancel,
     continue: () => {
       continueFn?.()