@tanstack/query-core 4.0.11-beta.0 → 4.0.11-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-core",
-  "version": "4.0.11-beta.0",
+  "version": "4.0.11-beta.1",
   "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/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/queryClient.test.tsx

@@ -13,6 +13,7 @@ import {
   QueryClient,
   QueryFunction,
   QueryObserver,
+  QueryObserverOptions,
 } from '..'
 import { focusManager, onlineManager } from '..'
 
@@ -357,6 +358,38 @@ describe('queryClient', () => {
       expect(queryCache.find(key)!.state.data).toBe(newData)
     })
 
+    test('should apply a custom structuralSharing function when provided', () => {
+      const key = queryKey()
+
+      const queryObserverOptions = {
+        structuralSharing: (
+          prevData: { value: Date } | undefined,
+          newData: { value: Date },
+        ) => {
+          if (!prevData) {
+            return newData
+          }
+          return newData.value.getTime() === prevData.value.getTime()
+            ? prevData
+            : newData
+        },
+      } as QueryObserverOptions
+
+      queryClient.setDefaultOptions({ queries: queryObserverOptions })
+
+      const oldData = { value: new Date(2022, 6, 19) }
+      const newData = { value: new Date(2022, 6, 19) }
+      queryClient.setQueryData(key, oldData)
+      queryClient.setQueryData(key, newData)
+
+      expect(queryCache.find(key)!.state.data).toBe(oldData)
+
+      const distinctData = { value: new Date(2021, 11, 25) }
+      queryClient.setQueryData(key, distinctData)
+
+      expect(queryCache.find(key)!.state.data).toBe(distinctData)
+    })
+
     test('should not set isFetching to false', async () => {
       const key = queryKey()
       queryClient.prefetchQuery(key, async () => {

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

@@ -76,9 +76,12 @@ export interface QueryOptions<
   behavior?: QueryBehavior<TQueryFnData, TError, TData>
   /**
    * Set this to `false` to disable structural sharing between query results.
+   * Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
    * Defaults to `true`.
    */
-  structuralSharing?: boolean
+  structuralSharing?:
+    | boolean
+    | ((oldData: TData | undefined, newData: TData) => TData)
   /**
    * This function can be set to automatically get the previous cursor for infinite queries.
    * The result will also be used to determine the value of `hasPreviousPage`.
@@ -425,11 +428,14 @@ export interface QueryObserverSuccessResult<TData = unknown, TError = unknown>
   status: 'success'
 }
 
+export type DefinedQueryObserverResult<TData = unknown, TError = unknown> =
+  | QueryObserverRefetchErrorResult<TData, TError>
+  | QueryObserverSuccessResult<TData, TError>
+
 export type QueryObserverResult<TData = unknown, TError = unknown> =
+  | DefinedQueryObserverResult<TData, TError>
   | QueryObserverLoadingErrorResult<TData, TError>
   | QueryObserverLoadingResult<TData, TError>
-  | QueryObserverRefetchErrorResult<TData, TError>
-  | QueryObserverSuccessResult<TData, TError>
 
 export interface InfiniteQueryObserverBaseResult<
   TData = unknown,
@@ -535,18 +541,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 +580,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<

package/src/utils.ts

@@ -427,6 +427,8 @@ export function replaceData<
   // Use prev data if an isDataEqual function is defined and returns `true`
   if (options.isDataEqual?.(prevData, data)) {
     return prevData as TData
+  } else if (typeof options.structuralSharing === 'function') {
+    return options.structuralSharing(prevData, data)
   } else if (options.structuralSharing !== false) {
     // Structurally share data between prev and new data if needed
     return replaceEqualDeep(prevData, data)