add requestId property to the promise returned by createAsyncThunk (#784)

Author: phryneas

etc/redux-toolkit.api.md

@@ -81,6 +81,8 @@ export type AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig extends AsyncThu
     condition: boolean;
 }, SerializedError>> & {
     abort(reason?: string): void;
+    requestId: string;
+    arg: ThunkArg;
 };
 
 // @public

src/createAsyncThunk.test.ts

@@ -74,7 +74,12 @@ describe('createAsyncThunk', () => {
 
     const thunkFunction = thunkActionCreator(args)
 
-    await thunkFunction(dispatch, () => {}, undefined)
+    const thunkPromise = thunkFunction(dispatch, () => {}, undefined)
+
+    expect(thunkPromise.requestId).toBe(generatedRequestId)
+    expect(thunkPromise.arg).toBe(args)
+
+    await thunkPromise
 
     expect(passedArg).toBe(args)
 
@@ -355,8 +360,9 @@ describe('createAsyncThunk with abortController', () => {
         message: 'AbortReason',
         name: 'AbortError'
       },
-      meta: { aborted: true }
+      meta: { aborted: true, requestId: promise.requestId }
     }
+
     // abortedAction with reason is dispatched after test/pending is dispatched
     expect(store.getState()).toMatchObject([
       {},

src/createAsyncThunk.ts

@@ -162,6 +162,8 @@ export type AsyncThunkAction<
     >
 > & {
   abort(reason?: string): void
+  requestId: string
+  arg: ThunkArg
 }
 
 type AsyncThunkActionCreator<
@@ -448,7 +450,7 @@ If you want to use the AbortController to react to \`abort\` events, please cons
         }
         return finalAction
       })()
-      return Object.assign(promise, { abort })
+      return Object.assign(promise, { abort, requestId, arg })
     }
   }
 

type-tests/files/createAsyncThunk.typetest.ts

@@ -32,6 +32,11 @@ const defaultDispatch = (() => {}) as ThunkDispatch<{}, any, AnyAction>
   )
 
   const promise = defaultDispatch(async(3))
+
+  expectType<string>(promise.requestId)
+  expectType<number>(promise.arg)
+  expectType<(reason?: string) => void>(promise.abort)
+
   const result = await promise
 
   if (async.fulfilled.match(result)) {