Skip to content

Fix hash issue for matchRoutes optimization #12927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2025
Merged

Fix hash issue for matchRoutes optimization #12927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/witty-birds-fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-router": patch
---

Fix regression introduced in `7.1.4` via [#12800](https://github.com/remix-run/react-router/pull/12800) that caused issues navigating to hash routes inside splat routes for applications using Lazy Route Discovery (`patchRoutesOnNavigation`)
52 changes: 52 additions & 0 deletions packages/react-router/__tests__/router/navigation-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { JSDOM } from "jsdom";
import { createBrowserRouter } from "../../lib/dom/lib";
import type { HydrationState } from "../../lib/router/router";
import { cleanup, setup } from "./utils/data-router-setup";
import { createFormData } from "./utils/utils";
Expand Down Expand Up @@ -60,6 +62,13 @@ function initializeTest(init?: {
});
}

function getWindowImpl(initialUrl: string, isHash = false): Window {
// Need to use our own custom DOM in order to get a working history
const dom = new JSDOM(`<!DOCTYPE html>`, { url: "http://localhost/" });
dom.window.history.replaceState(null, "", (isHash ? "#" : "") + initialUrl);
return dom.window as unknown as Window;
}

describe("navigations", () => {
afterEach(() => cleanup());

Expand Down Expand Up @@ -431,6 +440,49 @@ describe("navigations", () => {
});
});

it("does not use fog of war partial matches for hash change only navigations", async () => {
let router = createBrowserRouter(
[
{
path: "/",
children: [
{
path: "*",
},
],
},
],
{
window: getWindowImpl("/"),
// This is what enables the partialMatches logic
patchRoutesOnNavigation: () => {},
}
);
expect(router.state.location).toMatchObject({
pathname: "/",
hash: "",
});
expect(router.state.matches).toMatchObject([{ route: { path: "/" } }]);
await router.navigate("/foo");
expect(router.state.location).toMatchObject({
pathname: "/foo",
hash: "",
});
expect(router.state.matches).toMatchObject([
{ route: { path: "/" } },
{ route: { path: "*" } },
]);
await router.navigate("/foo#bar");
expect(router.state.location).toMatchObject({
pathname: "/foo",
hash: "#bar",
});
expect(router.state.matches).toMatchObject([
{ route: { path: "/" } },
{ route: { path: "*" } },
]);
});

it("redirects from loaders (throw)", async () => {
let t = initializeTest();

Expand Down
33 changes: 17 additions & 16 deletions packages/react-router/lib/router/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1533,6 +1533,23 @@ export function createRouter(init: RouterInit): Router {
: matchRoutes(routesToUse, location, basename);
let flushSync = (opts && opts.flushSync) === true;

// Short circuit if it's only a hash change and not a revalidation or
// mutation submission.
//
// Ignore on initial page loads because since the initial hydration will always
// be "same hash". For example, on /page#hash and submit a <Form method="post">
// which will default to a navigation to /page
if (
matches &&
state.initialized &&
!isRevalidationRequired &&
isHashChangeOnly(state.location, location) &&
!(opts && opts.submission && isMutationMethod(opts.submission.formMethod))
) {
completeNavigation(location, { matches }, { flushSync });
return;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This short circuit needs to happen before we look for a fog of war scenario (true when there is a param in the route) and set matches to the partial matches


let fogOfWar = checkFogOfWar(matches, routesToUse, location.pathname);
if (fogOfWar.active && fogOfWar.matches) {
matches = fogOfWar.matches;
Expand All @@ -1557,22 +1574,6 @@ export function createRouter(init: RouterInit): Router {
return;
}

// Short circuit if it's only a hash change and not a revalidation or
// mutation submission.
//
// Ignore on initial page loads because since the initial hydration will always
// be "same hash". For example, on /page#hash and submit a <Form method="post">
// which will default to a navigation to /page
if (
state.initialized &&
!isRevalidationRequired &&
isHashChangeOnly(state.location, location) &&
!(opts && opts.submission && isMutationMethod(opts.submission.formMethod))
) {
completeNavigation(location, { matches }, { flushSync });
return;
}

// Create a controller/Request for this navigation
pendingNavigationController = new AbortController();
let request = createClientSideRequest(
Expand Down