Merge pull request #4177 from juliengbt/feature/4149-is-prefetch-query

feat: add isPrefetch property in query action

Author: EskiMojo14

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

@@ -301,7 +301,8 @@ You must add the middleware for RTK-Query to function correctly!`,
           forceRefetch,
           subscriptionOptions,
           [forceQueryFnSymbol]: forceQueryFn,
-        } = {},
+          ...rest
+        } = {}
       ) =>
       (dispatch, getState) => {
         const queryCacheKey = serializeQueryArgs({
@@ -311,6 +312,7 @@ You must add the middleware for RTK-Query to function correctly!`,
         })
 
         const thunk = queryThunk({
+          ...rest,
           type: 'query',
           subscribe,
           forceRefetch: forceRefetch,

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

@@ -609,11 +609,12 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".`
       const force = hasTheForce(options) && options.force
       const maxAge = hasMaxAge(options) && options.ifOlderThan
 
-      const queryAction = (force: boolean = true) =>
-        (api.endpoints[endpointName] as ApiEndpointQuery<any, any>).initiate(
-          arg,
-          { forceRefetch: force },
-        )
+      const queryAction = (force: boolean = true) => {
+        const options = { forceRefetch: force, isPrefetch: true }
+        return (
+          api.endpoints[endpointName] as ApiEndpointQuery<any, any>
+        ).initiate(arg, options)
+      }
       const latestStateValue = (
         api.endpoints[endpointName] as ApiEndpointQuery<any, any>
       ).select(arg)(getState())

packages/toolkit/src/query/tests/buildThunks.test.tsx

@@ -1,7 +1,7 @@
-import { configureStore } from '@reduxjs/toolkit'
+import { configureStore, isAllOf } from '@reduxjs/toolkit'
 import { createApi } from '@reduxjs/toolkit/query/react'
 import { renderHook, waitFor } from '@testing-library/react'
-import { withProvider } from '../../tests/utils/helpers'
+import { actionsReducer, withProvider } from '../../tests/utils/helpers'
 import type { BaseQueryApi } from '../baseQueryTypes'
 
 test('handles a non-async baseQuery without error', async () => {
@@ -200,3 +200,52 @@ describe('re-triggering behavior on arg change', () => {
     }
   })
 })
+
+describe('prefetch', () => {
+  const baseQuery = () => ({ data: null })
+  const api = createApi({
+    baseQuery,
+    endpoints: (build) => ({
+      getUser: build.query<any, any>({
+        query: (obj) => obj,
+      }),
+    }),
+  })
+
+  const store = configureStore({
+    reducer: { [api.reducerPath]: api.reducer, ...actionsReducer },
+    middleware: (gDM) => gDM().concat(api.middleware),
+  })
+  it('should attach isPrefetch if prefetching', async () => {
+    store.dispatch(api.util.prefetch('getUser', 1, {}))
+
+    await Promise.all(store.dispatch(api.util.getRunningQueriesThunk()))
+
+    const isPrefetch = (
+      action: any,
+    ): action is { meta: { arg: { isPrefetch: true } } } =>
+      action?.meta?.arg?.isPrefetch
+
+    expect(store.getState().actions).toMatchSequence(
+      api.internalActions.middlewareRegistered.match,
+      isAllOf(api.endpoints.getUser.matchPending, isPrefetch),
+      isAllOf(api.endpoints.getUser.matchFulfilled, isPrefetch),
+    )
+
+    // compare against a regular initiate call
+    await store.dispatch(
+      api.endpoints.getUser.initiate(1, { forceRefetch: true }),
+    )
+
+    const isNotPrefetch = (action: any): action is unknown =>
+      !isPrefetch(action)
+
+    expect(store.getState().actions).toMatchSequence(
+      api.internalActions.middlewareRegistered.match,
+      isAllOf(api.endpoints.getUser.matchPending, isPrefetch),
+      isAllOf(api.endpoints.getUser.matchFulfilled, isPrefetch),
+      isAllOf(api.endpoints.getUser.matchPending, isNotPrefetch),
+      isAllOf(api.endpoints.getUser.matchFulfilled, isNotPrefetch),
+    )
+  })
+})