Add invalidateImmediately setting

Author: GeorchW

packages/toolkit/src/query/apiTypes.ts

@@ -45,6 +45,7 @@ export type Module<Name extends ModuleName> = {
       | 'refetchOnMountOrArgChange'
       | 'refetchOnFocus'
       | 'refetchOnReconnect'
+      | 'invalidateImmediately'
       | 'tagTypes'
     >,
     context: ApiContext<Definitions>

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

@@ -167,6 +167,7 @@ export type QuerySubState<D extends BaseEndpointDefinition<any, any, any>> = Id<
     > & { error: undefined })
   | ({
       status: QueryStatus.pending
+      pendingTagInvalidations: FullTagDescription<string>[]
     } & BaseQuerySubState<D>)
   | ({
       status: QueryStatus.rejected
@@ -256,6 +257,7 @@ export type ConfigState<ReducerPath> = RefetchConfigOptions & {
 
 export type ModifiableConfigState = {
   keepUnusedDataFor: number
+  invalidateImmediately: boolean
 } & RefetchConfigOptions
 
 export type MutationState<D extends EndpointDefinitions> = {

packages/toolkit/src/query/core/buildMiddleware/invalidationByTags.ts

@@ -85,6 +85,11 @@ export const buildInvalidationByTagsHandler: InternalHandlerBuilder = ({
 
     const state = rootState[reducerPath]
 
+    if (state.config.invalidateImmediately) {
+      handleInvalidatedTags(tags, mwApi)
+      return
+    }
+
     const hasPendingQueries = Object.values(state.queries).some(
       (x) => x?.status === QueryStatus.pending
     )

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

@@ -452,6 +452,7 @@ export const coreModule = (): Module<CoreModule> => ({
       refetchOnMountOrArgChange,
       refetchOnFocus,
       refetchOnReconnect,
+      invalidateImmediately,
     },
     context
   ) {
@@ -514,6 +515,7 @@ export const coreModule = (): Module<CoreModule> => ({
         refetchOnMountOrArgChange,
         keepUnusedDataFor,
         reducerPath,
+        invalidateImmediately,
       },
     })
 

packages/toolkit/src/query/createApi.ts

@@ -151,6 +151,15 @@ export interface CreateApiOptions<
    * Note: requires [`setupListeners`](./setupListeners) to have been called.
    */
   refetchOnReconnect?: boolean
+  /**
+   * Defaults to `false`. This setting allows you to disable a consistency measure that delay tag invalidations until all pending queries and mutations are settled.
+   *
+   * Context: If a mutation finishes while a query is pending, then RTK-query has to wait until the query is finished until it can invalidate any tags, since the query itself could provide a tag that the mutation will invalidate.
+   * RTK-query also waits with the tag invalidations if another mutation is pending, to "batch" the tag invalidations if two mutations invalidate the same tag, avoiding unnecessary re-fetching.
+   *
+   * If you constantly have some queries running, this can delay the tag invalidations. In this case, you can enable this setting to opt-out of the "correct" behavior and refetch immediately when a mutation finishes instead.
+   */
+  invalidateImmediately?: boolean
   /**
    * A function that is passed every dispatched action. If this returns something other than `undefined`,
    * that return value will be used to rehydrate fulfilled & errored queries.
@@ -255,6 +264,7 @@ export function buildCreateApi<Modules extends [Module<any>, ...Module<any>[]]>(
       refetchOnMountOrArgChange: false,
       refetchOnFocus: false,
       refetchOnReconnect: false,
+      invalidateImmediately: false,
       ...options,
       extractRehydrationInfo,
       serializeQueryArgs(queryArgsApi) {

packages/toolkit/src/query/tests/buildSlice.test.ts

@@ -51,6 +51,7 @@ describe('buildSlice', () => {
       api: {
         config: {
           focused: true,
+          invalidateImmediately: false,
           keepUnusedDataFor: 60,
           middlewareRegistered: true,
           online: true,