Skip to content

Handle encoded question mark and hash chars in ancestor splat routes #14249

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
+178 −3
Open

Handle encoded question mark and hash chars in ancestor splat routes #14249

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/two-mice-grin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-router": patch
---

Handle encoded question mark and hash characters in ancestor splat routes
158 changes: 158 additions & 0 deletions packages/react-router/__tests__/dom/special-characters-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,164 @@ describe("special character tests", () => {
);
}
});

it("handles encoded question marks in ancestor splat route segments", async () => {
let ctx = render(
<BrowserRouter window={getWindow("/parent/child/question-%3F-mark")}>
<App />
</BrowserRouter>,
);

expect(getHtml(ctx.container)).toMatchInlineSnapshot(`
"<div>
<a
data-discover="true"
href="/parent/child/question-%3F-mark/grandchild"
>
Link to grandchild
</a>
</div>"
`);

await fireEvent.click(screen.getByText("Link to grandchild"));
await waitFor(() => screen.getByText("Grandchild"));

expect(getHtml(ctx.container)).toMatchInlineSnapshot(`
"<div>
<a
data-discover="true"
href="/parent/child/question-%3F-mark/grandchild"
>
Link to grandchild
</a>
<h1>
Grandchild
</h1>
<pre>
{"*":"grandchild","param":"question-?-mark"}
</pre>
</div>"
`);

function App() {
return (
<Routes>
<Route path="/parent/*" element={<Parent />} />
</Routes>
);
}

function Parent() {
return (
<Routes>
<Route path="child/:param/*" element={<Child />} />
</Routes>
);
}

function Child() {
let location = useLocation();
let to = location.pathname.endsWith("grandchild")
? "."
: "./grandchild";
return (
<>
<Link to={to}>Link to grandchild</Link>
<Routes>
<Route path="grandchild" element={<Grandchild />} />
</Routes>
</>
);
}

function Grandchild() {
return (
<>
<h1>Grandchild</h1>
<pre>{JSON.stringify(useParams())}</pre>
</>
);
}
});

it("handles encoded hashes in ancestor splat route segments", async () => {
let ctx = render(
<BrowserRouter window={getWindow("/parent/child/hash-%23-char")}>
<App />
</BrowserRouter>,
);

expect(getHtml(ctx.container)).toMatchInlineSnapshot(`
"<div>
<a
data-discover="true"
href="/parent/child/hash-%23-char/grandchild"
>
Link to grandchild
</a>
</div>"
`);

await fireEvent.click(screen.getByText("Link to grandchild"));
await waitFor(() => screen.getByText("Grandchild"));

expect(getHtml(ctx.container)).toMatchInlineSnapshot(`
"<div>
<a
data-discover="true"
href="/parent/child/hash-%23-char/grandchild"
>
Link to grandchild
</a>
<h1>
Grandchild
</h1>
<pre>
{"*":"grandchild","param":"hash-#-char"}
</pre>
</div>"
`);

function App() {
return (
<Routes>
<Route path="/parent/*" element={<Parent />} />
</Routes>
);
}

function Parent() {
return (
<Routes>
<Route path="child/:param/*" element={<Child />} />
</Routes>
);
}

function Child() {
let location = useLocation();
let to = location.pathname.endsWith("grandchild")
? "."
: "./grandchild";
return (
<>
<Link to={to}>Link to grandchild</Link>
<Routes>
<Route path="grandchild" element={<Grandchild />} />
</Routes>
</>
);
}

function Grandchild() {
return (
<>
<h1>Grandchild</h1>
<pre>{JSON.stringify(useParams())}</pre>
</>
);
}
});
});

describe("when matching as part of the defined route path", () => {
Expand Down
18 changes: 15 additions & 3 deletions packages/react-router/lib/hooks.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,9 +869,14 @@ export function useRoutesImpl(
params: Object.assign({}, parentParams, match.params),
pathname: joinPaths([
parentPathnameBase,
// Re-encode pathnames that were decoded inside matchRoutes
// Re-encode pathnames that were decoded inside matchRoutes.
// Pre-encode `?` and `#` ahead of `encodeLocation` because it uses
// `new URL()` internally and we need to prevent it from treating
// them as separators
navigator.encodeLocation
? navigator.encodeLocation(match.pathname).pathname
? navigator.encodeLocation(
match.pathname.replace(/\?/g, "%3F").replace(/#/g, "%23"),
).pathname
: match.pathname,
]),
pathnameBase:
Expand All @@ -880,8 +885,15 @@ export function useRoutesImpl(
: joinPaths([
parentPathnameBase,
// Re-encode pathnames that were decoded inside matchRoutes
// Pre-encode `?` and `#` ahead of `encodeLocation` because it uses
// `new URL()` internally and we need to prevent it from treating
// them as separators
navigator.encodeLocation
? navigator.encodeLocation(match.pathnameBase).pathname
? navigator.encodeLocation(
match.pathnameBase
.replace(/\?/g, "%3F")
.replace(/#/g, "%23"),
).pathname
: match.pathnameBase,
]),
}),
Expand Down