Add extra to BaseQueryApi (#1378)

Co-authored-by: Ricardo Sanchez <ricardosancheze@outlook.com>
reduxjs · Aug 11, 2021 · 22e4074 · 22e4074
1 parent cb3e158
commit 22e4074
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 1 deletion.
diff --git a/packages/toolkit/src/query/baseQueryTypes.ts b/packages/toolkit/src/query/baseQueryTypes.ts
@@ -5,6 +5,7 @@ export interface BaseQueryApi {
   signal: AbortSignal
   dispatch: ThunkDispatch<any, any, any>
   getState: () => unknown
+  extra: unknown
 }
 
 export type QueryReturnValue<T = unknown, E = unknown, M = unknown> =

diff --git a/packages/toolkit/src/query/core/buildThunks.ts b/packages/toolkit/src/query/core/buildThunks.ts
@@ -259,7 +259,7 @@ export function buildThunks<
     ThunkApiMetaConfig & { state: RootState<any, string, ReducerPath> }
   > = async (
     arg,
-    { signal, rejectWithValue, fulfillWithValue, dispatch, getState }
+    { signal, rejectWithValue, fulfillWithValue, dispatch, getState, extra }
   ) => {
     const endpointDefinition = endpointDefinitions[arg.endpointName]
 
@@ -271,6 +271,7 @@ export function buildThunks<
         signal,
         dispatch,
         getState,
+        extra,
       }
       if (endpointDefinition.query) {
         result = await baseQuery(

diff --git a/packages/toolkit/src/query/tests/buildThunks.test.tsx b/packages/toolkit/src/query/tests/buildThunks.test.tsx
@@ -2,6 +2,7 @@ import { configureStore } from '@reduxjs/toolkit'
 import { createApi } from '@reduxjs/toolkit/query/react'
 
 import { renderHook } from '@testing-library/react-hooks'
+import type { BaseQueryApi } from '../baseQueryTypes'
 import { withProvider } from './helpers'
 
 test('handles a non-async baseQuery without error', async () => {
@@ -49,6 +50,28 @@ test('handles a non-async baseQuery without error', async () => {
   })
 })
 
+test('passes the extraArgument property to the baseQueryApi', async () => {
+  const baseQuery = (_args: any, api: BaseQueryApi) => ({ data: api.extra })
+  const api = createApi({
+    baseQuery,
+    endpoints: (build) => ({
+      getUser: build.query<unknown, void>({
+        query: () => '',
+      }),
+    }),
+  })
+  const store = configureStore({
+    reducer: {
+      [api.reducerPath]: api.reducer,
+    },
+    middleware: (gDM) =>
+      gDM({ thunk: { extraArgument: 'cakes' } }).concat(api.middleware),
+  })
+  const { getUser } = api.endpoints
+  const { data } = await store.dispatch(getUser.initiate())
+  expect(data).toBe('cakes')
+})
+
 describe('re-triggering behavior on arg change', () => {
   const api = createApi({
     baseQuery: () => ({ data: undefined }),

diff --git a/packages/toolkit/src/query/tests/errorHandling.test.tsx b/packages/toolkit/src/query/tests/errorHandling.test.tsx
@@ -41,6 +41,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -61,6 +62,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )

diff --git a/packages/toolkit/src/query/tests/fetchBaseQuery.test.tsx b/packages/toolkit/src/query/tests/fetchBaseQuery.test.tsx
@@ -79,6 +79,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -95,6 +96,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -113,6 +115,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -136,6 +139,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -165,6 +169,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -189,6 +194,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -218,6 +224,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -245,6 +252,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -275,6 +283,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -293,6 +302,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -318,6 +328,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -341,6 +352,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -359,6 +371,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -376,6 +389,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -393,6 +407,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -410,6 +425,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -427,6 +443,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -448,6 +465,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       )
@@ -471,6 +489,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -488,6 +507,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -512,6 +532,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -533,6 +554,7 @@ describe('fetchBaseQuery', () => {
           signal: new AbortController().signal,
           dispatch: storeRef.store.dispatch,
           getState: storeRef.store.getState,
+          extra: undefined,
         },
         {}
       ))
@@ -563,6 +585,7 @@ describe('fetchBaseQuery', () => {
             signal: new AbortController().signal,
             dispatch: storeRef.store.dispatch,
             getState: storeRef.store.getState,
+            extra: undefined,
           },
           {}
         )
@@ -582,6 +605,7 @@ describe('fetchBaseQuery', () => {
             signal: new AbortController().signal,
             dispatch: storeRef.store.dispatch,
             getState: storeRef.store.getState,
+            extra: undefined,
           },
           {}
         )
@@ -607,6 +631,7 @@ describe('fetchBaseQuery', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     ))
@@ -625,6 +650,7 @@ describe('fetchBaseQuery', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     ))
@@ -644,6 +670,7 @@ describe('fetchBaseQuery', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     ))
@@ -672,6 +699,7 @@ describe('fetchFn', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     ))
@@ -699,6 +727,7 @@ describe('fetchFn', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     )
@@ -725,6 +754,7 @@ describe('FormData', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     )
@@ -746,6 +776,7 @@ describe('still throws on completely unexpected errors', () => {
         signal: new AbortController().signal,
         dispatch: storeRef.store.dispatch,
         getState: storeRef.store.getState,
+        extra: undefined,
       },
       {}
     )