query/endpointDefinitions: add sideEffectForced to QueryExtraOptions

query/buildInitiate: check sideEffectForced to conditionally force query

Author: Dennis Schaller

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

@@ -5,11 +5,10 @@ import type {
   QueryArgFrom,
   ResultTypeFrom,
 } from '../endpointDefinitions'
-import { DefinitionType } from '../endpointDefinitions'
+import { DefinitionType, isQueryDefinition } from '../endpointDefinitions'
 import type { QueryThunk, MutationThunk, QueryThunkArg } from './buildThunks'
 import type { AnyAction, ThunkAction, SerializedError } from '@reduxjs/toolkit'
 import type { SubscriptionOptions, RootState } from './apiState'
-import { QueryStatus } from './apiState'
 import type { InternalSerializeQueryArgs } from '../defaultSerializeQueryArgs'
 import type { Api, ApiContext } from '../apiTypes'
 import type { ApiEndpointQuery } from './module'
@@ -279,10 +278,21 @@ Features like automatic cache collection, automatic refetching etc. will not be
           endpointDefinition,
           endpointName,
         })
+
+        const endpointContext = context.endpointDefinitions[endpointName]
+        const sideEffectForced =
+          isQueryDefinition(endpointContext) &&
+          endpointContext.sideEffectForced?.({
+            getState,
+            endpointState: (
+              api.endpoints[endpointName] as ApiEndpointQuery<any, any>
+            ).select(arg)(getState()),
+          })
+
         const thunk = queryThunk({
           type: 'query',
           subscribe,
-          forceRefetch,
+          forceRefetch: forceRefetch || sideEffectForced,
           subscriptionOptions,
           endpointName,
           originalArgs: arg,

packages/toolkit/src/query/endpointDefinitions.ts

@@ -1,6 +1,6 @@
 import type { AnyAction, ThunkDispatch } from '@reduxjs/toolkit'
 import { SerializeQueryArgs } from './defaultSerializeQueryArgs'
-import type { RootState } from './core/apiState'
+import type { QuerySubState, RootState } from './core/apiState'
 import type {
   BaseQueryExtraOptions,
   BaseQueryFn,
@@ -343,6 +343,10 @@ export interface QueryExtraOptions<
    * All of these are `undefined` at runtime, purely to be used in TypeScript declarations!
    */
   Types?: QueryTypes<QueryArg, BaseQuery, TagTypes, ResultType, ReducerPath>
+  sideEffectForced?: (params: {
+    getState(): RootState<any, any, string>
+    endpointState: QuerySubState<any>
+  }) => boolean
 }
 
 export type QueryDefinition<