RFC: add "merge" functionality

Author: phryneas

packages/toolkit/src/query/core/buildSlice.ts

@@ -27,6 +27,7 @@ import { calculateProvidedByThunk } from './buildThunks'
 import type {
   AssertTagTypes,
   EndpointDefinitions,
+  QueryDefinition,
 } from '../endpointDefinitions'
 import type { Patch } from 'immer'
 import { applyPatches } from 'immer'
@@ -156,11 +157,16 @@ export function buildSlice({
             meta.arg.queryCacheKey,
             (substate) => {
               if (substate.requestId !== meta.requestId) return
+              const { merge = (x: any) => x } = definitions[
+                meta.arg.endpointName
+              ] as QueryDefinition<any, any, any, any>
               substate.status = QueryStatus.fulfilled
+              let newData = merge(payload, substate.data)
+
               substate.data =
                 definitions[meta.arg.endpointName].structuralSharing ?? true
-                  ? copyWithStructuralSharing(substate.data, payload)
-                  : payload
+                  ? copyWithStructuralSharing(substate.data, newData)
+                  : newData
               delete substate.error
               substate.fulfilledTimeStamp = meta.fulfilledTimeStamp
             }

packages/toolkit/src/query/endpointDefinitions.ts

@@ -272,6 +272,17 @@ export interface QueryExtraOptions<
    * Not to be used. A query should not invalidate tags in the cache.
    */
   invalidatesTags?: never
+  /**
+   * Can be provided to merge the current cache value into the new cache value.
+   *
+   * Useful if you don't want a new request to completely override the current cache value,
+   * maybe because you have manually updated it from another source and don't want those
+   * updates to get lost.
+   */
+  merge?(
+    newCacheValue: ResultType,
+    currentCacheValue: ResultType | undefined
+  ): ResultType
 }
 
 export type QueryDefinition<