@tanstack/query-core 4.0.10 → 4.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.0.10",
+  "version": "4.1.2",
   "description": "TODO",
   "author": "tannerlinsley",
   "license": "MIT",

package/src/mutationCache.ts

@@ -48,6 +48,12 @@ interface NotifyEventMutationObserverRemoved {
   observer: MutationObserver<any, any, any>
 }
 
+interface NotifyEventMutationObserverOptionsUpdated {
+  type: 'observerOptionsUpdated'
+  mutation?: Mutation<any, any, any, any>
+  observer: MutationObserver<any, any, any, any>
+}
+
 interface NotifyEventMutationUpdated {
   type: 'updated'
   mutation: Mutation<any, any, any, any>
@@ -59,6 +65,7 @@ type MutationCacheNotifyEvent =
   | NotifyEventMutationRemoved
   | NotifyEventMutationObserverAdded
   | NotifyEventMutationObserverRemoved
+  | NotifyEventMutationObserverOptionsUpdated
   | NotifyEventMutationUpdated
 
 type MutationCacheListener = (event: MutationCacheNotifyEvent) => void

package/src/mutationObserver.ts

@@ -8,6 +8,7 @@ import type {
   MutationObserverResult,
   MutationObserverOptions,
 } from './types'
+import { shallowEqualObjects } from './utils'
 
 // TYPES
 
@@ -63,7 +64,15 @@ export class MutationObserver<
   setOptions(
     options?: MutationObserverOptions<TData, TError, TVariables, TContext>,
   ) {
+    const prevOptions = this.options
     this.options = this.client.defaultMutationOptions(options)
+    if (!shallowEqualObjects(prevOptions, this.options)) {
+      this.client.getMutationCache().notify({
+        type: 'observerOptionsUpdated',
+        mutation: this.currentMutation,
+        observer: this,
+      })
+    }
   }
 
   protected onUnsubscribe(): void {

package/src/queryCache.ts

@@ -55,6 +55,12 @@ interface NotifyEventQueryObserverResultsUpdated {
   query: Query<any, any, any, any>
 }
 
+interface NotifyEventQueryObserverOptionsUpdated {
+  type: 'observerOptionsUpdated'
+  query: Query<any, any, any, any>
+  observer: QueryObserver<any, any, any, any, any>
+}
+
 type QueryCacheNotifyEvent =
   | NotifyEventQueryAdded
   | NotifyEventQueryRemoved
@@ -62,6 +68,7 @@ type QueryCacheNotifyEvent =
   | NotifyEventQueryObserverAdded
   | NotifyEventQueryObserverRemoved
   | NotifyEventQueryObserverResultsUpdated
+  | NotifyEventQueryObserverOptionsUpdated
 
 type QueryCacheListener = (event: QueryCacheNotifyEvent) => void
 

package/src/queryClient.ts

@@ -570,13 +570,11 @@ export class QueryClient {
       )
       // It is ok not having defaults, but it is error prone to have more than 1 default for a given key
       if (matchingDefaults.length > 1) {
-        if (process.env.NODE_ENV !== 'production') {
-          this.logger.error(
-            `[QueryClient] Several query defaults match with key '${JSON.stringify(
-              queryKey,
-            )}'. The first matching query defaults are used. Please check how query defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetquerydefaults.`,
-          )
-        }
+        this.logger.error(
+          `[QueryClient] Several query defaults match with key '${JSON.stringify(
+            queryKey,
+          )}'. The first matching query defaults are used. Please check how query defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetquerydefaults.`,
+        )
       }
     }
 
@@ -617,13 +615,11 @@ export class QueryClient {
       )
       // It is ok not having defaults, but it is error prone to have more than 1 default for a given key
       if (matchingDefaults.length > 1) {
-        if (process.env.NODE_ENV !== 'production') {
-          this.logger.error(
-            `[QueryClient] Several mutation defaults match with key '${JSON.stringify(
-              mutationKey,
-            )}'. The first matching mutation defaults are used. Please check how mutation defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetmutationdefaults.`,
-          )
-        }
+        this.logger.error(
+          `[QueryClient] Several mutation defaults match with key '${JSON.stringify(
+            mutationKey,
+          )}'. The first matching mutation defaults are used. Please check how mutation defaults are registered. Order does matter here. cf. https://react-query.tanstack.com/reference/QueryClient#queryclientsetmutationdefaults.`,
+        )
       }
     }
 

package/src/queryObserver.ts

@@ -155,6 +155,14 @@ export class QueryObserver<
 
     this.options = this.client.defaultQueryOptions(options)
 
+    if (!shallowEqualObjects(prevOptions, this.options)) {
+      this.client.getQueryCache().notify({
+        type: 'observerOptionsUpdated',
+        query: this.currentQuery,
+        observer: this,
+      })
+    }
+
     if (
       typeof this.options.enabled !== 'undefined' &&
       typeof this.options.enabled !== 'boolean'

package/src/tests/queryObserver.test.tsx

@@ -799,4 +799,23 @@ describe('queryObserver', () => {
 
     unsubscribe()
   })
+
+  test('setOptions should notify cache listeners', async () => {
+    const key = queryKey()
+
+    const observer = new QueryObserver(queryClient, {
+      queryKey: key,
+    })
+
+    const spy = jest.fn()
+    const unsubscribe = queryClient.getQueryCache().subscribe(spy)
+    observer.setOptions({ enabled: false })
+
+    expect(spy).toHaveBeenCalledTimes(1)
+    expect(spy).toHaveBeenCalledWith(
+      expect.objectContaining({ type: 'observerOptionsUpdated' }),
+    )
+
+    unsubscribe()
+  })
 })

package/src/types.ts

@@ -535,18 +535,18 @@ export interface MutationOptions<
     data: TData,
     variables: TVariables,
     context: TContext | undefined,
-  ) => Promise<unknown> | void
+  ) => Promise<unknown> | unknown
   onError?: (
     error: TError,
     variables: TVariables,
     context: TContext | undefined,
-  ) => Promise<unknown> | void
+  ) => Promise<unknown> | unknown
   onSettled?: (
     data: TData | undefined,
     error: TError | null,
     variables: TVariables,
     context: TContext | undefined,
-  ) => Promise<unknown> | void
+  ) => Promise<unknown> | unknown
   retry?: RetryValue<TError>
   retryDelay?: RetryDelayValue<TError>
   networkMode?: NetworkMode
@@ -574,18 +574,18 @@ export interface MutateOptions<
     data: TData,
     variables: TVariables,
     context: TContext,
-  ) => Promise<unknown> | void
+  ) => Promise<unknown> | unknown
   onError?: (
     error: TError,
     variables: TVariables,
     context: TContext | undefined,
-  ) => Promise<unknown> | void
+  ) => Promise<unknown> | unknown
   onSettled?: (
     data: TData | undefined,
     error: TError | null,
     variables: TVariables,
     context: TContext | undefined,
-  ) => Promise<unknown> | void
+  ) => Promise<unknown> | unknown
 }
 
 export type MutateFunction<