split up middleware, add OptionalPromise, add cache entry lifecycle

src/query/core/buildMiddleware/cacheLifecycle.ts

@@ -31,7 +31,8 @@ export const build: SubMiddlewareBuilder = ({
           action.meta.arg.endpointName,
           action.meta.arg.originalArgs,
           cacheKey,
-          mwApi
+          mwApi,
+          action.meta.requestId
         )
       }
     } else if (mutationThunk.pending.match(action)) {
@@ -41,7 +42,8 @@ export const build: SubMiddlewareBuilder = ({
           action.meta.arg.endpointName,
           action.meta.arg.originalArgs,
           cacheKey,
-          mwApi
+          mwApi,
+          action.meta.requestId
         )
       }
     } else if (isFullfilledThunk(action)) {
@@ -81,7 +83,8 @@ export const build: SubMiddlewareBuilder = ({
     endpointName: string,
     originalArgs: any,
     queryCacheKey: string,
-    mwApi: SubMiddlewareApi
+    mwApi: SubMiddlewareApi,
+    requestId: string
   ) {
     const onCacheEntryAdded =
       context.endpointDefinitions[endpointName]?.onCacheEntryAdded
@@ -107,11 +110,14 @@ export const build: SubMiddlewareBuilder = ({
     )
     lifecycleMap[queryCacheKey] = lifecycle
     const selector = (api.endpoints[endpointName] as any).select(originalArgs)
+    const extra = mwApi.dispatch((_, __, extra) => extra)
     const runningHandler = onCacheEntryAdded(
       originalArgs,
       {
         ...mwApi,
         getCacheEntry: () => selector(mwApi.getState()),
+        requestId,
+        extra,
       },
       {
         firstValueResolved,

src/query/core/buildMiddleware/queryLifecycle.ts

@@ -40,11 +40,14 @@ export const build: SubMiddlewareBuilder = ({
           originalArgs
         )
 
+        const extra = mwApi.dispatch((_, __, extra) => extra)
         onQuery(
           originalArgs,
           {
             ...mwApi,
             getCacheEntry: () => selector(mwApi.getState()),
+            requestId,
+            extra,
           },
           { resultPromise }
         )

src/query/core/buildThunks.ts

@@ -240,17 +240,6 @@ export function buildThunks<
   > = async (arg, { signal, rejectWithValue, ...api }) => {
     const endpointDefinition = endpointDefinitions[arg.endpointName]
 
-    const context: Record<string, any> = {}
-    const queryApi:
-      | QueryApi<ReducerPath, any>
-      | MutationApi<ReducerPath, any> = {
-      ...api,
-      context,
-    }
-
-    if (endpointDefinition.onStart)
-      endpointDefinition.onStart(arg.originalArgs, queryApi)
-
     try {
       let transformResponse: (
         baseQueryReturnValue: any,
@@ -282,25 +271,12 @@ export function buildThunks<
         )
       }
       if (result.error) throw new HandledError(result.error, result.meta)
-      if (endpointDefinition.onSuccess)
-        endpointDefinition.onSuccess(
-          arg.originalArgs,
-          queryApi,
-          result.data,
-          result.meta
-        )
+
       return {
         fulfilledTimeStamp: Date.now(),
         result: await transformResponse(result.data, result.meta),
       }
     } catch (error) {
-      if (endpointDefinition.onError)
-        endpointDefinition.onError(
-          arg.originalArgs,
-          queryApi,
-          error instanceof HandledError ? error.value : error,
-          error instanceof HandledError ? error.meta : undefined
-        )
       if (error instanceof HandledError) {
         return rejectWithValue(error.value)
       }

src/query/createApi.ts

@@ -277,6 +277,26 @@ export function buildCreateApi<Modules extends [Module<any>, ...Module<any>[]]>(
             }
             x.providesTags ??= x.provides
           }
+          if (x.onStart || x.onSuccess || x.onError) {
+            if (
+              typeof process !== 'undefined' &&
+              process.env.NODE_ENV === 'development'
+            ) {
+              console.warn(
+                '`onStart`, `onSuccess` and `onError` have been replaced by `onQuery`, please change your code accordingly'
+              )
+            }
+            x.onQuery ??= async (arg, api, { resultPromise }) => {
+              const queryApi = { ...api, context: {} }
+              x.onStart?.(arg, queryApi)
+              try {
+                const result = await resultPromise
+                x.onSuccess?.(arg, queryApi, result, undefined)
+              } catch (error) {
+                x.onError?.(arg, queryApi, error, undefined)
+              }
+            }
+          }
           return { ...x, type: DefinitionType.query } as any
         },
         mutation: (x) => {
@@ -292,6 +312,26 @@ export function buildCreateApi<Modules extends [Module<any>, ...Module<any>[]]>(
             }
             x.invalidatesTags ??= x.invalidates
           }
+          if (x.onStart || x.onSuccess || x.onError) {
+            if (
+              typeof process !== 'undefined' &&
+              process.env.NODE_ENV === 'development'
+            ) {
+              console.warn(
+                '`onStart`, `onSuccess` and `onError` have been replaced by `onQuery`, please change your code accordingly'
+              )
+            }
+            x.onQuery ??= async (arg, api, { resultPromise }) => {
+              const queryApi = { ...api, context: {} }
+              x.onStart?.(arg, queryApi)
+              try {
+                const result = await resultPromise
+                x.onSuccess?.(arg, queryApi, result, undefined)
+              } catch (error) {
+                x.onError?.(arg, queryApi, error, undefined)
+              }
+            }
+          }
           return { ...x, type: DefinitionType.mutation } as any
         },
       })