WIP: add baseQueryMeta to thunks, meta to lifecycle results

reduxjs · May 27, 2021 · c0f2848 · c0f2848
1 parent c125c38
commit c0f2848
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 29 deletions.
diff --git a/src/createAsyncThunk.ts b/src/createAsyncThunk.ts
@@ -366,7 +366,9 @@ export type AsyncThunkRejectedActionCreator<
     aborted: boolean
     condition: boolean
   } & (
-    | { rejectedWithValue: false }
+    | ({ rejectedWithValue: false } & {
+        [K in keyof GetRejectedMeta<ThunkApiConfig>]?: undefined
+      })
     | ({ rejectedWithValue: true } & GetRejectedMeta<ThunkApiConfig>)
   )
 >

diff --git a/src/query/core/buildMiddleware/cacheLifecycle.ts b/src/query/core/buildMiddleware/cacheLifecycle.ts
@@ -219,7 +219,12 @@ export const build: SubMiddlewareBuilder = ({
       } else if (isFullfilledThunk(action)) {
         const lifecycle = lifecycleMap[cacheKey]
         if (lifecycle?.valueResolved) {
-          lifecycle.valueResolved({ data: action.payload })
+          lifecycle.valueResolved(
+            {
+              data: action.payload,
+              meta: action.meta.baseQueryMeta,
+            } as any /* TODO typings */
+          )
           delete lifecycle.valueResolved
         }
       } else if (

diff --git a/src/query/core/buildMiddleware/queryLifecycle.ts b/src/query/core/buildMiddleware/queryLifecycle.ts
@@ -170,15 +170,23 @@ export const build: SubMiddlewareBuilder = ({
           onQueryStarted(originalArgs, lifecycleApi)
         }
       } else if (isFullfilledThunk(action)) {
-        const { requestId } = action.meta
-        lifecycleMap[requestId]?.resolve({ data: action.payload })
+        const { requestId, baseQueryMeta } = action.meta
+        lifecycleMap[requestId]?.resolve(
+          {
+            data: action.payload,
+            meta: baseQueryMeta,
+          } as any /* TODO typings for this */
+        )
         delete lifecycleMap[requestId]
       } else if (isRejectedThunk(action)) {
-        const { requestId, rejectedWithValue } = action.meta
-        lifecycleMap[requestId]?.reject({
-          error: action.payload ?? action.error,
-          isUnhandledError: !rejectedWithValue,
-        })
+        const { requestId, rejectedWithValue, baseQueryMeta } = action.meta
+        lifecycleMap[requestId]?.reject(
+          {
+            error: action.payload ?? action.error,
+            isUnhandledError: !rejectedWithValue,
+            meta: baseQueryMeta,
+          } as any /* TODO typings for this */
+        )
         delete lifecycleMap[requestId]
       }
 

diff --git a/src/query/core/buildSlice.ts b/src/query/core/buildSlice.ts
@@ -31,7 +31,9 @@ import {
 } from './apiState'
 import {
   calculateProvidedByThunk,
+  MutationThunk,
   MutationThunkArg,
+  QueryThunk,
   QueryThunkArg,
   ThunkResult,
 } from './buildThunks'
@@ -78,22 +80,8 @@ export function buildSlice({
   config,
 }: {
   reducerPath: string
-  queryThunk: AsyncThunk<
-    ThunkResult,
-    QueryThunkArg,
-    {
-      pendingMeta: { startedTimeStamp: number }
-      fulfilledMeta: { fulfilledTimeStamp: number }
-    }
-  >
-  mutationThunk: AsyncThunk<
-    ThunkResult,
-    MutationThunkArg,
-    {
-      pendingMeta: { startedTimeStamp: number }
-      fulfilledMeta: { fulfilledTimeStamp: number }
-    }
-  >
+  queryThunk: QueryThunk
+  mutationThunk: MutationThunk
   context: ApiContext<EndpointDefinitions>
   assertTagType: AssertTagTypes
   config: Omit<ConfigState<string>, 'online' | 'focused'>

diff --git a/src/query/core/buildThunks.ts b/src/query/core/buildThunks.ts
@@ -123,7 +123,13 @@ export type ThunkResult = unknown
 
 export type ThunkApiMetaConfig = {
   pendingMeta: { startedTimeStamp: number }
-  fulfilledMeta: { fulfilledTimeStamp: number }
+  fulfilledMeta: {
+    fulfilledTimeStamp: number
+    baseQueryMeta: unknown
+  }
+  rejectedMeta: {
+    baseQueryMeta: unknown
+  }
 }
 export type QueryThunk = AsyncThunk<
   ThunkResult,
@@ -306,11 +312,12 @@ export function buildThunks<
         await transformResponse(result.data, result.meta),
         {
           fulfilledTimeStamp: Date.now(),
+          baseQueryMeta: result.meta,
         }
       )
     } catch (error) {
       if (error instanceof HandledError) {
-        return rejectWithValue(error.value)
+        return rejectWithValue(error.value, { baseQueryMeta: error.meta })
       }
       throw error
     }

diff --git a/src/query/tests/cacheLifecycle.test.ts b/src/query/tests/cacheLifecycle.test.ts
@@ -108,7 +108,13 @@ describe.each([['query'], ['mutation']] as const)(
       await fakeTimerWaitFor(() => {
         expect(gotFirstValue).toHaveBeenCalled()
       })
-      expect(gotFirstValue).toHaveBeenCalledWith({ data: { value: 'success' } })
+      expect(gotFirstValue).toHaveBeenCalledWith({
+        data: { value: 'success' },
+        meta: {
+          request: expect.any(Request),
+          response: expect.any(Object), // Response is not available in jest env
+        },
+      })
       expect(onCleanup).not.toHaveBeenCalled()
 
       promise.unsubscribe(), await waitMs()

diff --git a/src/query/tests/queryLifecycle.test.tsx b/src/query/tests/queryLifecycle.test.tsx
@@ -59,7 +59,13 @@ describe.each([['query'], ['mutation']] as const)(
       storeRef.store.dispatch(extended.endpoints.injected.initiate('arg'))
       expect(onStart).toHaveBeenCalledWith('arg')
       await waitFor(() => {
-        expect(onSuccess).toHaveBeenCalledWith({ data: { value: 'success' } })
+        expect(onSuccess).toHaveBeenCalledWith({
+          data: { value: 'success' },
+          meta: {
+            request: expect.any(Request),
+            response: expect.any(Object), // Response is not available in jest env
+          },
+        })
       })
     })
 
@@ -90,6 +96,10 @@ describe.each([['query'], ['mutation']] as const)(
             data: { value: 'error' },
           },
           isUnhandledError: false,
+          meta: {
+            request: expect.any(Request),
+            response: expect.any(Object), // Response is not available in jest env
+          },
         })
       })
       expect(onSuccess).not.toHaveBeenCalled()