From dc6e940ff401a22c87dba5a0b1a812e9fd1e3207 Mon Sep 17 00:00:00 2001
From: Alan Ko <34646302+alanko0511@users.noreply.github.com>
Date: Mon, 16 Dec 2024 14:06:19 -0500
Subject: [PATCH] Add `onAction` property in AutoButton

---
 .../cypress/component/auto/AutoButton.cy.tsx  | 41 +++++++++++++++++++
 .../auto/hooks/useAutoButtonController.tsx    | 10 ++++-
 2 files changed, 49 insertions(+), 2 deletions(-)

diff --git a/packages/react/cypress/component/auto/AutoButton.cy.tsx b/packages/react/cypress/component/auto/AutoButton.cy.tsx
index 619c6a871..42e9200a3 100644
--- a/packages/react/cypress/component/auto/AutoButton.cy.tsx
+++ b/packages/react/cypress/component/auto/AutoButton.cy.tsx
@@ -183,4 +183,45 @@ describeForEachAutoAdapter("AutoButton", ({ name, adapter: { AutoButton }, wrapp
 
     cy.contains("Flip all succeeded.");
   });
+
+  it("runs the onAction callback when the button is clicked, then runs the action as normal", () => {
+    let onActionCalled = false;
+    cy.mountWithWrapper(
+      <AutoButton
+        action={api.widget.create}
+        variables={{ widget: { name: "foobar" } }}
+        onAction={() => {
+          onActionCalled = true;
+        }}
+      />,
+      wrapper
+    );
+    cy.contains("Create Widget");
+
+    cy.intercept("POST", `${api.connection.options.endpoint}?operation=createWidget`, {
+      body: {
+        data: {
+          widget: {
+            __typename: "Widget",
+            id: "123",
+          },
+        },
+      },
+    }).as("createWidget");
+
+    cy.get("button")
+      .click()
+      .then(() => {
+        expect(onActionCalled).to.be.true;
+      });
+
+    cy.wait("@createWidget");
+    cy.get("@createWidget")
+      .its("request.body.variables")
+      .should("deep.equal", {
+        widget: { name: "foobar" },
+      });
+
+    cy.contains("Create Widget succeeded.");
+  });
 });
diff --git a/packages/react/src/auto/hooks/useAutoButtonController.tsx b/packages/react/src/auto/hooks/useAutoButtonController.tsx
index cc562a8c6..6d6794bb0 100644
--- a/packages/react/src/auto/hooks/useAutoButtonController.tsx
+++ b/packages/react/src/auto/hooks/useAutoButtonController.tsx
@@ -15,6 +15,10 @@ export type AutoButtonProps<
   action: ActionFunc;
   /** The variables to pass to the action when run */
   variables?: ActionFunc["variablesType"];
+  /**
+   * Callback function to run when the button is clicked. The action will run after this is called.
+   */
+  onAction?: () => void;
   /**
    * Callback function to run when the button succeeded at running the action
    * Overrides the default behavior of rendering a message to the user to display success
@@ -34,7 +38,7 @@ export const useAutoButtonController = <
 >(
   props: AutoButtonProps<GivenOptions, SchemaT, ActionFunc>
 ) => {
-  const { action, variables, onSuccess, onError, ...buttonProps } = props;
+  const { action, variables, onAction, onSuccess, onError, ...buttonProps } = props;
   const { metadata, fetching: fetchingMetadata, error: metadataError } = useActionMetadata(action);
 
   const [{ data: result, fetching: fetchingActionResult, error }, runAction] =
@@ -55,13 +59,15 @@ export const useAutoButtonController = <
   }
 
   const run = useCallback(async () => {
+    onAction?.();
+
     const result = await runAction(variables);
     if (result.error) {
       onError?.(result.error, result);
     } else {
       onSuccess?.(result);
     }
-  }, [runAction, variables, onSuccess, onError]) as () => void;
+  }, [onAction, runAction, variables, onError, onSuccess]) as () => void;
 
   return {
     result,