pass in full ctx, args, and result

Author: ianmacartney

packages/convex-helpers/README.md

@@ -65,10 +65,10 @@ const myQueryBuilder = customQuery(query, {
     return {
       ctx: { db, apiUser },
       args: {},
-      onSuccess: (result) => {
+      onSuccess: ({ args, result }) => {
         // Optional callback that runs after the function executes
         // Has access to resources created during input processing
-        console.log(`Query for ${apiUser.name} completed:`, result);
+        console.log(apiUser.name, args, result);
       },
     };
   },

packages/convex-helpers/server/customFunctions.test.ts

@@ -633,8 +633,8 @@ describe("finally callback", () => {
       input: async () => ({
         ctx: { foo: "bar" },
         args: {},
-        onSuccess: (params) => {
-          finallyMock(params);
+        onSuccess: ({ result }) => {
+          finallyMock(result);
         },
       }),
     });
@@ -684,8 +684,8 @@ describe("finally callback", () => {
       input: async () => ({
         ctx: { foo: "bar" },
         args: {},
-        onSuccess: (params) => {
-          finallyMock(params);
+        onSuccess: ({ result }) => {
+          finallyMock(result);
         },
       }),
     });
@@ -714,8 +714,8 @@ describe("finally callback", () => {
       input: async () => ({
         ctx: { foo: "bar" },
         args: {},
-        onSuccess: (params) => {
-          finallyMock(params);
+        onSuccess: ({ result }) => {
+          finallyMock(result);
         },
       }),
     });

packages/convex-helpers/server/customFunctions.ts

@@ -15,7 +15,6 @@ import type {
   ObjectType,
   PropertyValidators,
   Validator,
-  Value,
 } from "convex/values";
 import { asObjectValidator, v } from "convex/values";
 import type {
@@ -92,12 +91,20 @@ export type Customization<
     | Promise<{
         ctx: CustomCtx;
         args: CustomMadeArgs;
-        onSuccess?: (result: unknown) => void | Promise<void>;
+        onSuccess?: (obj: {
+          ctx: Ctx;
+          args: Record<string, unknown>;
+          result: unknown;
+        }) => void | Promise<void>;
       }>
     | {
         ctx: CustomCtx;
         args: CustomMadeArgs;
-        onSuccess?: (result: unknown) => void | Promise<void>;
+        onSuccess?: (obj: {
+          ctx: Ctx;
+          args: Record<string, unknown>;
+          result: unknown;
+        }) => void | Promise<void>;
       };
 };
 
@@ -201,7 +208,7 @@ export const NoOp = {
  *     return {
  *       ctx: { db, user, session },
  *       args: {},
- *       onSuccess: (result) => {
+ *       onSuccess: ({ result }) => {
  *         // Optional callback that runs after the function executes
  *         // Has access to resources created during input processing
  *         console.log(`Query for ${user.name} returned:`, result);
@@ -289,7 +296,7 @@ export function customQuery<
  *     return {
  *       ctx: { db, user, session },
  *       args: {},
- *       onSuccess: (result) => {
+ *       onSuccess: ({ result }) => {
  *         // Optional callback that runs after the function executes
  *         // Has access to resources created during input processing
  *         console.log(`User ${user.name} returned:`, result);
@@ -381,7 +388,7 @@ export function customMutation<
  *     return {
  *       ctx: { user },
  *       args: {},
- *       onSuccess: (result) => {
+ *       onSuccess: ({ result }) => {
  *         // Optional callback that runs after the function executes
  *         // Has access to resources created during input processing
  *         logger.info(`Action for user ${user.name} returned:`, result);
@@ -484,9 +491,10 @@ function customFnBuilder(
           );
           const args = omit(allArgs, Object.keys(inputArgs));
           const finalCtx = { ...ctx, ...added.ctx };
-          const result = await handler(finalCtx, { ...args, ...added.args });
+          const finalArgs = { ...args, ...added.args };
+          const result = await handler(finalCtx, finalArgs);
           if (added.onSuccess) {
-            await added.onSuccess(result ?? null);
+            await added.onSuccess({ ctx, args, result });
           }
           return result;
         },
@@ -503,9 +511,10 @@ function customFnBuilder(
       handler: async (ctx: any, args: any) => {
         const added = await customInput(ctx, args, extra);
         const finalCtx = { ...ctx, ...added.ctx };
-        const result = await handler(finalCtx, { ...args, ...added.args });
+        const finalArgs = { ...args, ...added.args };
+        const result = await handler(finalCtx, finalArgs);
         if (added.onSuccess) {
-          await added.onSuccess(result ?? null);
+          await added.onSuccess({ ctx, args, result });
         }
         return result;
       },