@tanstack/query-core 4.10.3 → 4.13.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.10.3",
-  "description": "TODO",
+  "version": "4.13.0",
+  "description": "The framework agnostic core that powers TanStack Query",
   "author": "tannerlinsley",
   "license": "MIT",
   "repository": "tanstack/query",
@@ -29,6 +29,8 @@
   ],
   "scripts": {
     "clean": "rm -rf ./build",
-    "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src"
+    "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src",
+    "test:jest": "../../node_modules/.bin/jest --config ./jest.config.ts",
+    "test:dev": "pnpm run test:jest --watch"
   }
 }

package/src/mutation.ts

@@ -30,13 +30,16 @@ export interface MutationState<
   data: TData | undefined
   error: TError | null
   failureCount: number
+  failureReason: TError | null
   isPaused: boolean
   status: MutationStatus
   variables: TVariables | undefined
 }
 
-interface FailedAction {
+interface FailedAction<TError> {
   type: 'failed'
+  failureCount: number
+  error: TError | null
 }
 
 interface LoadingAction<TVariables, TContext> {
@@ -71,7 +74,7 @@ interface SetStateAction<TData, TError, TVariables, TContext> {
 export type Action<TData, TError, TVariables, TContext> =
   | ContinueAction
   | ErrorAction<TError>
-  | FailedAction
+  | FailedAction<TError>
   | LoadingAction<TVariables, TContext>
   | PauseAction
   | SetStateAction<TData, TError, TVariables, TContext>
@@ -171,8 +174,8 @@ export class Mutation<
           }
           return this.options.mutationFn(this.state.variables!)
         },
-        onFail: () => {
-          this.dispatch({ type: 'failed' })
+        onFail: (failureCount, error) => {
+          this.dispatch({ type: 'failed', failureCount, error })
         },
         onPause: () => {
           this.dispatch({ type: 'pause' })
@@ -193,7 +196,7 @@ export class Mutation<
       if (!restored) {
         this.dispatch({ type: 'loading', variables: this.options.variables! })
         // Notify cache callback
-        this.mutationCache.config.onMutate?.(
+        await this.mutationCache.config.onMutate?.(
           this.state.variables,
           this as Mutation<unknown, unknown, unknown, unknown>,
         )
@@ -209,7 +212,7 @@ export class Mutation<
       const data = await executeMutation()
 
       // Notify cache callback
-      this.mutationCache.config.onSuccess?.(
+      await this.mutationCache.config.onSuccess?.(
         data,
         this.state.variables,
         this.state.context,
@@ -234,7 +237,7 @@ export class Mutation<
     } catch (error) {
       try {
         // Notify cache callback
-        this.mutationCache.config.onError?.(
+        await this.mutationCache.config.onError?.(
           error,
           this.state.variables,
           this.state.context,
@@ -272,7 +275,8 @@ export class Mutation<
         case 'failed':
           return {
             ...state,
-            failureCount: state.failureCount + 1,
+            failureCount: action.failureCount,
+            failureReason: action.error,
           }
         case 'pause':
           return {
@@ -289,6 +293,8 @@ export class Mutation<
             ...state,
             context: action.context,
             data: undefined,
+            failureCount: 0,
+            failureReason: null,
             error: null,
             isPaused: !canFetch(this.options.networkMode),
             status: 'loading',
@@ -298,6 +304,8 @@ export class Mutation<
           return {
             ...state,
             data: action.data,
+            failureCount: 0,
+            failureReason: null,
             error: null,
             status: 'success',
             isPaused: false,
@@ -308,6 +316,7 @@ export class Mutation<
             data: undefined,
             error: action.error,
             failureCount: state.failureCount + 1,
+            failureReason: action.error,
             isPaused: false,
             status: 'error',
           }
@@ -344,6 +353,7 @@ export function getDefaultState<
     data: undefined,
     error: null,
     failureCount: 0,
+    failureReason: null,
     isPaused: false,
     status: 'idle',
     variables: undefined,

package/src/mutationCache.ts

@@ -16,17 +16,17 @@ interface MutationCacheConfig {
     variables: unknown,
     context: unknown,
     mutation: Mutation<unknown, unknown, unknown>,
-  ) => void
+  ) => Promise<unknown> | unknown
   onSuccess?: (
     data: unknown,
     variables: unknown,
     context: unknown,
     mutation: Mutation<unknown, unknown, unknown>,
-  ) => void
+  ) => Promise<unknown> | unknown
   onMutate?: (
     variables: unknown,
     mutation: Mutation<unknown, unknown, unknown, unknown>,
-  ) => void
+  ) => Promise<unknown> | unknown
 }
 
 interface NotifyEventMutationAdded {

package/src/query.ts

@@ -45,6 +45,7 @@ export interface QueryState<TData = unknown, TError = unknown> {
   errorUpdateCount: number
   errorUpdatedAt: number
   fetchFailureCount: number
+  fetchFailureReason: TError | null
   fetchMeta: any
   isInvalidated: boolean
   status: QueryStatus
@@ -82,8 +83,10 @@ export interface FetchOptions {
   meta?: any
 }
 
-interface FailedAction {
+interface FailedAction<TError> {
   type: 'failed'
+  failureCount: number
+  error: TError
 }
 
 interface FetchAction {
@@ -124,7 +127,7 @@ interface SetStateAction<TData, TError> {
 export type Action<TData, TError> =
   | ContinueAction
   | ErrorAction<TError>
-  | FailedAction
+  | FailedAction<TError>
   | FetchAction
   | InvalidateAction
   | PauseAction
@@ -473,8 +476,8 @@ export class Query<
         this.isFetchingOptimistic = false
       },
       onError,
-      onFail: () => {
-        this.dispatch({ type: 'failed' })
+      onFail: (failureCount, error) => {
+        this.dispatch({ type: 'failed', failureCount, error })
       },
       onPause: () => {
         this.dispatch({ type: 'pause' })
@@ -500,7 +503,8 @@ export class Query<
         case 'failed':
           return {
             ...state,
-            fetchFailureCount: state.fetchFailureCount + 1,
+            fetchFailureCount: action.failureCount,
+            fetchFailureReason: action.error,
           }
         case 'pause':
           return {
@@ -516,6 +520,7 @@ export class Query<
           return {
             ...state,
             fetchFailureCount: 0,
+            fetchFailureReason: null,
             fetchMeta: action.meta ?? null,
             fetchStatus: canFetch(this.options.networkMode)
               ? 'fetching'
@@ -537,6 +542,7 @@ export class Query<
             ...(!action.manual && {
               fetchStatus: 'idle',
               fetchFailureCount: 0,
+              fetchFailureReason: null,
             }),
           }
         case 'error':
@@ -552,6 +558,7 @@ export class Query<
             errorUpdateCount: state.errorUpdateCount + 1,
             errorUpdatedAt: Date.now(),
             fetchFailureCount: state.fetchFailureCount + 1,
+            fetchFailureReason: error as TError,
             fetchStatus: 'idle',
             status: 'error',
           }
@@ -611,6 +618,7 @@ function getDefaultState<
     errorUpdateCount: 0,
     errorUpdatedAt: 0,
     fetchFailureCount: 0,
+    fetchFailureReason: null,
     fetchMeta: null,
     isInvalidated: false,
     status: hasData ? 'success' : 'loading',

package/src/queryObserver.ts

@@ -562,6 +562,7 @@ export class QueryObserver<
       error,
       errorUpdatedAt,
       failureCount: state.fetchFailureCount,
+      failureReason: state.fetchFailureReason,
       errorUpdateCount: state.errorUpdateCount,
       isFetched: state.dataUpdateCount > 0 || state.errorUpdateCount > 0,
       isFetchedAfterMount:

package/src/tests/mutationCache.test.tsx

@@ -22,6 +22,33 @@ describe('mutationCache', () => {
       const mutation = testCache.getAll()[0]
       expect(onError).toHaveBeenCalledWith('error', 'vars', 'context', mutation)
     })
+
+    test('should be awaited', async () => {
+      const key = queryKey()
+      const states: Array<number> = []
+      const onError = async () => {
+        states.push(1)
+        await sleep(1)
+        states.push(2)
+      }
+      const testCache = new MutationCache({ onError })
+      const testClient = createQueryClient({ mutationCache: testCache })
+
+      try {
+        await executeMutation(testClient, {
+          mutationKey: key,
+          variables: 'vars',
+          mutationFn: () => Promise.reject('error'),
+          onError: async () => {
+            states.push(3)
+            await sleep(1)
+            states.push(4)
+          },
+        })
+      } catch {}
+
+      expect(states).toEqual([1, 2, 3, 4])
+    })
   })
   describe('MutationCacheConfig.onSuccess', () => {
     test('should be called when a mutation is successful', async () => {
@@ -47,6 +74,30 @@ describe('mutationCache', () => {
         mutation,
       )
     })
+    test('should be awaited', async () => {
+      const key = queryKey()
+      const states: Array<number> = []
+      const onSuccess = async () => {
+        states.push(1)
+        await sleep(1)
+        states.push(2)
+      }
+      const testCache = new MutationCache({ onSuccess })
+      const testClient = createQueryClient({ mutationCache: testCache })
+
+      await executeMutation(testClient, {
+        mutationKey: key,
+        variables: 'vars',
+        mutationFn: () => Promise.resolve({ data: 5 }),
+        onSuccess: async () => {
+          states.push(3)
+          await sleep(1)
+          states.push(4)
+        },
+      })
+
+      expect(states).toEqual([1, 2, 3, 4])
+    })
   })
   describe('MutationCacheConfig.onMutate', () => {
     test('should be called before a mutation executes', async () => {
@@ -67,6 +118,31 @@ describe('mutationCache', () => {
       const mutation = testCache.getAll()[0]
       expect(onMutate).toHaveBeenCalledWith('vars', mutation)
     })
+
+    test('should be awaited', async () => {
+      const key = queryKey()
+      const states: Array<number> = []
+      const onMutate = async () => {
+        states.push(1)
+        await sleep(1)
+        states.push(2)
+      }
+      const testCache = new MutationCache({ onMutate })
+      const testClient = createQueryClient({ mutationCache: testCache })
+
+      await executeMutation(testClient, {
+        mutationKey: key,
+        variables: 'vars',
+        mutationFn: () => Promise.resolve({ data: 5 }),
+        onMutate: async () => {
+          states.push(3)
+          await sleep(1)
+          states.push(4)
+        },
+      })
+
+      expect(states).toEqual([1, 2, 3, 4])
+    })
   })
 
   describe('find', () => {

package/src/tests/mutations.test.tsx

@@ -71,6 +71,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 0,
+      failureReason: null,
       isError: false,
       isIdle: true,
       isLoading: false,
@@ -97,6 +98,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 0,
+      failureReason: null,
       isError: false,
       isIdle: false,
       isLoading: true,
@@ -115,6 +117,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 0,
+      failureReason: null,
       isError: false,
       isIdle: false,
       isLoading: true,
@@ -133,6 +136,7 @@ describe('mutations', () => {
       data: 'todo',
       error: null,
       failureCount: 0,
+      failureReason: null,
       isError: false,
       isIdle: false,
       isLoading: false,
@@ -172,6 +176,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 0,
+      failureReason: null,
       isError: false,
       isIdle: false,
       isLoading: true,
@@ -190,6 +195,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 0,
+      failureReason: null,
       isError: false,
       isIdle: false,
       isLoading: true,
@@ -208,6 +214,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 1,
+      failureReason: 'err',
       isError: false,
       isIdle: false,
       isLoading: true,
@@ -226,6 +233,7 @@ describe('mutations', () => {
       data: undefined,
       error: 'err',
       failureCount: 2,
+      failureReason: 'err',
       isError: true,
       isIdle: false,
       isLoading: false,
@@ -264,6 +272,7 @@ describe('mutations', () => {
           data: undefined,
           error: null,
           failureCount: 1,
+          failureReason: 'err',
           isPaused: true,
           status: 'loading',
           variables: 'todo',
@@ -275,6 +284,7 @@ describe('mutations', () => {
       data: undefined,
       error: null,
       failureCount: 1,
+      failureReason: 'err',
       isPaused: true,
       status: 'loading',
       variables: 'todo',
@@ -286,7 +296,8 @@ describe('mutations', () => {
       context: 'todo',
       data: 'todo',
       error: null,
-      failureCount: 1,
+      failureCount: 0,
+      failureReason: null,
       isPaused: false,
       status: 'success',
       variables: 'todo',
@@ -316,6 +327,7 @@ describe('mutations', () => {
       data: 'new',
       error: undefined,
       failureCount: 0,
+      failureReason: null,
       isPaused: false,
       status: 'success',
     })

package/src/tests/utils.ts

@@ -65,11 +65,13 @@ export const executeMutation = (
 // so that we can pretend to be in a server environment
 export function setIsServer(isServer: boolean) {
   const original = utils.isServer
-  // @ts-ignore
-  utils.isServer = isServer
+  Object.defineProperty(utils, 'isServer', {
+    get: () => isServer,
+  })
 
   return () => {
-    // @ts-ignore
-    utils.isServer = original
+    Object.defineProperty(utils, 'isServer', {
+      get: () => original,
+    })
   }
 }

package/src/types.ts

@@ -370,6 +370,7 @@ export interface QueryObserverBaseResult<TData = unknown, TError = unknown> {
   error: TError | null
   errorUpdatedAt: number
   failureCount: number
+  failureReason: TError | null
   errorUpdateCount: number
   isError: boolean
   isFetched: boolean