fix: reset actionData state on redirection from an action (#9334)

* fix: reset actionData state on redirection from an action

* Update contributors.yml

* use destination location and add unit test

* Update changelog + comments

Co-authored-by: Matt Brophy <[email protected]>

Author: jrakotoharisoa

.changeset/short-hats-peel.md

@@ -0,0 +1,5 @@
+---
+"@remix-run/router": patch
+---
+
+fix: reset `actionData` after successful action redirect (#9334)

contributors.yml

@@ -54,6 +54,7 @@
 - jmargeta
 - johnpangalos
 - jonkoops
+- jrakotoharisoa
 - kantuni
 - kddnewton
 - kentcdodds

packages/router/__tests__/router-test.ts

@@ -2706,6 +2706,81 @@ describe("a router", () => {
       expect(t.router.state.actionData).toBeNull();
     });
 
+    it("removes action data after action redirect (w/o loaders to run)", async () => {
+      let t = setup({
+        routes: [
+          {
+            index: true,
+            id: "index",
+            action: true,
+          },
+          {
+            path: "/other",
+            id: "other",
+          },
+        ],
+      });
+      let A = await t.navigate("/", {
+        formMethod: "post",
+        formData: createFormData({ gosh: "" }),
+      });
+      await A.actions.index.resolve({ error: "invalid" });
+      expect(t.router.state.actionData).toEqual({
+        index: { error: "invalid" },
+      });
+
+      let B = await t.navigate("/", {
+        formMethod: "post",
+        formData: createFormData({ gosh: "dang" }),
+      });
+      await B.actions.index.redirectReturn("/other");
+
+      expect(t.router.state.actionData).toBeNull();
+    });
+
+    it("removes action data after action redirect (w/ loaders to run)", async () => {
+      let t = setup({
+        routes: [
+          {
+            index: true,
+            id: "index",
+            action: true,
+          },
+          {
+            path: "/other",
+            id: "other",
+            loader: true,
+          },
+        ],
+      });
+      let A = await t.navigate("/", {
+        formMethod: "post",
+        formData: createFormData({ gosh: "" }),
+      });
+      await A.actions.index.resolve({ error: "invalid" });
+      expect(t.router.state.actionData).toEqual({
+        index: { error: "invalid" },
+      });
+
+      let B = await t.navigate("/", {
+        formMethod: "post",
+        formData: createFormData({ gosh: "dang" }),
+      });
+
+      let C = await B.actions.index.redirectReturn("/other");
+      expect(t.router.state.actionData).toEqual({
+        index: { error: "invalid" },
+      });
+      expect(t.router.state.loaderData).toEqual({});
+
+      await C.loaders.other.resolve("OTHER");
+
+      expect(t.router.state.actionData).toBeNull();
+      expect(t.router.state.loaderData).toEqual({
+        other: "OTHER",
+      });
+    });
+
     it("uses the proper action for index routes", async () => {
       let t = setup({
         routes: [

packages/router/router.ts

@@ -660,14 +660,15 @@ export function createRouter(init: RouterInit): Router {
     // - We have committed actionData in the store
     // - The current navigation was a submission
     // - We're past the submitting state and into the loading state
-    // - This should not be susceptible to false positives for
-    //   loading/submissionRedirect since there would not be actionData in the
-    //   state since the prior action would have returned a redirect response
-    //   and short circuited
+    // - The location we've finished loading is different from the submission
+    //   location, indicating we redirected from the action (avoids false
+    //   positives for loading/submissionRedirect when actionData returned
+    //   on a prior submission)
     let isActionReload =
       state.actionData != null &&
       state.navigation.formMethod != null &&
-      state.navigation.state === "loading";
+      state.navigation.state === "loading" &&
+      state.navigation.formAction?.split("?")[0] === location.pathname;
 
     // Always preserve any existing loaderData from re-used routes
     let newLoaderData = newState.loaderData