Preserve pending view transitions through a router revalidation call (#11917)

Author: brophdawg11

.changeset/soft-socks-remain.md

@@ -0,0 +1,5 @@
+---
+"@remix-run/router": patch
+---
+
+Preserve pending view transitions through a router revalidation call

packages/router/__tests__/view-transition-test.ts

@@ -66,4 +66,74 @@ describe("view transitions", () => {
     unsubscribe();
     t.router.dispose();
   });
+
+  it("preserves pending view transitions through router.revalidate()", async () => {
+    let t = setup({
+      routes: [{ path: "/" }, { id: "a", path: "/a", loader: true }],
+    });
+    let spy = jest.fn();
+    let unsubscribe = t.router.subscribe(spy);
+
+    let A = await t.navigate("/a", { unstable_viewTransition: true });
+    expect(spy).toHaveBeenCalledTimes(1);
+    expect(spy.mock.calls[0]).toEqual([
+      expect.objectContaining({
+        navigation: expect.objectContaining({ state: "loading" }),
+      }),
+      expect.objectContaining({ unstable_viewTransitionOpts: undefined }),
+    ]);
+    expect(A.loaders.a.stub).toHaveBeenCalledTimes(1);
+
+    // Interrupt the navigation loading state with a revalidation
+    let B = await t.revalidate();
+    expect(spy).toHaveBeenCalledTimes(3);
+    expect(spy.mock.calls[1]).toEqual([
+      expect.objectContaining({
+        revalidation: "loading",
+      }),
+      expect.objectContaining({
+        unstable_viewTransitionOpts: undefined,
+      }),
+    ]);
+    expect(spy.mock.calls[2]).toEqual([
+      expect.objectContaining({
+        navigation: expect.objectContaining({ state: "loading" }),
+      }),
+      expect.objectContaining({
+        unstable_viewTransitionOpts: undefined,
+      }),
+    ]);
+    expect(spy).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        navigation: expect.objectContaining({ state: "loading" }),
+      }),
+      expect.objectContaining({
+        unstable_viewTransitionOpts: undefined,
+      })
+    );
+    expect(B.loaders.a.stub).toHaveBeenCalledTimes(1);
+
+    await A.loaders.a.resolve("A");
+    await B.loaders.a.resolve("A*");
+
+    expect(spy).toHaveBeenCalledTimes(4);
+    expect(spy.mock.calls[3]).toEqual([
+      expect.objectContaining({
+        navigation: IDLE_NAVIGATION,
+        location: expect.objectContaining({ pathname: "/a" }),
+        loaderData: {
+          a: "A*",
+        },
+      }),
+      expect.objectContaining({
+        unstable_viewTransitionOpts: {
+          currentLocation: expect.objectContaining({ pathname: "/" }),
+          nextLocation: expect.objectContaining({ pathname: "/a" }),
+        },
+      }),
+    ]);
+
+    unsubscribe();
+    t.router.dispose();
+  });
 });

packages/router/router.ts

@@ -1479,7 +1479,11 @@ export function createRouter(init: RouterInit): Router {
     startNavigation(
       pendingAction || state.historyAction,
       state.navigation.location,
-      { overrideNavigation: state.navigation }
+      {
+        overrideNavigation: state.navigation,
+        // Proxy through any rending view transition
+        enableViewTransition: pendingViewTransitionEnabled === true,
+      }
     );
   }