rename sideEffectForced to forceRefetch

make forceRefetch be read from endpoint config instead of passing it into thunk as forced

Author: Dennis Schaller

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

@@ -279,20 +279,10 @@ Features like automatic cache collection, automatic refetching etc. will not be
           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 || sideEffectForced,
+          forceRefetch: forceRefetch,
           subscriptionOptions,
           endpointName,
           originalArgs: arg,

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

@@ -12,10 +12,11 @@ import type {
   QueryActionCreatorResult,
 } from './buildInitiate'
 import { forceQueryFnSymbol, isUpsertQuery } from './buildInitiate'
-import type {
+import {
   AssertTagTypes,
   EndpointDefinition,
   EndpointDefinitions,
+  isQueryDefinition,
   MutationDefinition,
   QueryArgFrom,
   QueryDefinition,
@@ -478,6 +479,7 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".`
       const state = getState()
       const requestState = state[reducerPath]?.queries?.[arg.queryCacheKey]
       const fulfilledVal = requestState?.fulfilledTimeStamp
+      const endpointDefinition = endpointDefinitions[arg.endpointName]
 
       // Order of these checks matters.
       // In order for `upsertQueryData` to successfully run while an existing request is in flight,
@@ -490,6 +492,15 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".`
       // if this is forced, continue
       if (isForcedQuery(arg, state)) return true
 
+      if (
+        isQueryDefinition(endpointDefinition) &&
+        endpointDefinition?.forceRefetch?.({
+          endpointState: requestState,
+          state,
+        })
+      )
+        return true
+
       // Pull from the cache unless we explicitly force refetch or qualify based on time
       if (fulfilledVal)
         // Value is cached and we didn't specify to refresh, skip it.

packages/toolkit/src/query/endpointDefinitions.ts

@@ -339,14 +339,15 @@ export interface QueryExtraOptions<
     responseData: ResultType
   ): ResultType | void
 
+  forceRefetch?(params: {
+    state: RootState<any, any, string>
+    endpointState?: QuerySubState<any>
+  }): boolean
+
   /**
    * 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<