Skip to content

Fix Issue with decoding URLs #11138

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

Closed
wants to merge 11 commits into from
Closed

Fix Issue with decoding URLs #11138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
703892c
Merge branch 'release-next'
brophdawg11 Dec 21, 2023
680589f
Mark safelyDecodeURIComponent "paramName" as optional
labkey-nicka Dec 23, 2023
3b1bcf0
matchRoutes: use safelyDecodeURIComponent
labkey-nicka Dec 23, 2023
42d5958
Fix typo
labkey-nicka Dec 23, 2023
c93ff90
Update integration tests
labkey-nicka Dec 23, 2023
dc89199
Add self to contributors.yml
labkey-nicka Dec 23, 2023
ac714b8
Remove safelyDecodeURI (unused)
labkey-nicka Dec 23, 2023
0aa8893
Readd space to test string
labkey-nicka Dec 24, 2023
86b7e5d
Update test paths
labkey-nicka Dec 24, 2023
5ec5e00
Add changeset
labkey-nicka Dec 24, 2023
b242c77
#8072: Support consecutive slash as a parameter
labkey-nicka Dec 26, 2023
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
6 changes: 6 additions & 0 deletions .changeset/decode-uri-component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"react-router": patch
"@remix-run/router": patch
---

Use `safelyDecodeURIComponent` to ensure proper URL decoding of full string in `matchRoutes`.
1 change: 1 addition & 0 deletions contributors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
- KubasuIvanSakwa
- KutnerUri
- kylegirard
- labkey-nicka
- landisdesign
- latin-1
- lequangdongg
Expand Down
88 changes: 44 additions & 44 deletions packages/react-router-dom/__tests__/special-characters-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -763,85 +763,85 @@ describe("special character tests", () => {
describe("memory routers", () => {
it("does not encode characters in MemoryRouter", () => {
let ctx = render(
<MemoryRouter initialEntries={["/with space"]}>
<MemoryRouter initialEntries={["/with space&encoded:characters"]}>
<Routes>
<Route path="/with space" element={<ShowPath />} />
<Route path="/with space&encoded:characters" element={<ShowPath />} />
</Routes>
</MemoryRouter>
);

expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with space&amp;encoded:characters","search":"","hash":""}</pre>"`
);
});

it("does not encode characters in MemoryRouter (navigate)", () => {
function Start() {
let navigate = useNavigate();
// eslint-disable-next-line react-hooks/exhaustive-deps
React.useEffect(() => navigate("/with space"), []);
React.useEffect(() => navigate("/with space&encoded:characters"), []);
return null;
}
let ctx = render(
<MemoryRouter>
<Routes>
<Route path="/" element={<Start />} />
<Route path="/with space" element={<ShowPath />} />
<Route path="/with space&encoded:characters" element={<ShowPath />} />
</Routes>
</MemoryRouter>
);

expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with space&amp;encoded:characters","search":"","hash":""}</pre>"`
);
});

it("does not encode characters in createMemoryRouter", () => {
let router = createMemoryRouter(
[{ path: "/with space", element: <ShowPath /> }],
{ initialEntries: ["/with space"] }
[{ path: "/with space&encoded:characters", element: <ShowPath /> }],
{ initialEntries: ["/with space&encoded:characters"] }
);
let ctx = render(<RouterProvider router={router} />);

expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with space&amp;encoded:characters","search":"","hash":""}</pre>"`
);
});

it("does not encode characters in createMemoryRouter (navigate)", () => {
function Start() {
let navigate = useNavigate();
// eslint-disable-next-line react-hooks/exhaustive-deps
React.useEffect(() => navigate("/with space"), []);
React.useEffect(() => navigate("/with space&encoded:characters"), []);
return null;
}
let router = createMemoryRouter([
{ path: "/", element: <Start /> },
{ path: "/with space", element: <ShowPath /> },
{ path: "/with space&encoded:characters", element: <ShowPath /> },
]);
let ctx = render(<RouterProvider router={router} />);

expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with space&amp;encoded:characters","search":"","hash":""}</pre>"`
);
});
});

describe("browser routers", () => {
it("encodes characters in BrowserRouter", () => {
let testWindow = getWindow("/with space");
let testWindow = getWindow("/with%20space%26encoded%3Acharacters");

let ctx = render(
<BrowserRouter window={testWindow}>
<Routes>
<Route path="/with space" element={<ShowPath />} />
<Route path="/with space&encoded:characters" element={<ShowPath />} />
</Routes>
</BrowserRouter>
);

expect(testWindow.location.pathname).toBe("/with%20space");
expect(testWindow.location.pathname).toBe("/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});

Expand All @@ -851,37 +851,37 @@ describe("special character tests", () => {
function Start() {
let navigate = useNavigate();
// eslint-disable-next-line react-hooks/exhaustive-deps
React.useEffect(() => navigate("/with space"), []);
React.useEffect(() => navigate("/with%20space%26encoded%3Acharacters"), []);
return null;
}

let ctx = render(
<BrowserRouter window={testWindow}>
<Routes>
<Route path="/" element={<Start />} />
<Route path="/with space" element={<ShowPath />} />
<Route path="/with space&encoded:characters" element={<ShowPath />} />
</Routes>
</BrowserRouter>
);

expect(testWindow.location.pathname).toBe("/with%20space");
expect(testWindow.location.pathname).toBe("/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});

it("encodes characters in createBrowserRouter", () => {
let testWindow = getWindow("/with space");
let testWindow = getWindow("/with%20space%26encoded%3Acharacters");

let router = createBrowserRouter(
[{ path: "/with space", element: <ShowPath /> }],
[{ path: "/with space&encoded:characters", element: <ShowPath /> }],
{ window: testWindow }
);
let ctx = render(<RouterProvider router={router} />);

expect(testWindow.location.pathname).toBe("/with%20space");
expect(testWindow.location.pathname).toBe("/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});

Expand All @@ -891,42 +891,42 @@ describe("special character tests", () => {
function Start() {
let navigate = useNavigate();
// eslint-disable-next-line react-hooks/exhaustive-deps
React.useEffect(() => navigate("/with space"), []);
React.useEffect(() => navigate("/with%20space%26encoded%3Acharacters"), []);
return null;
}

let router = createBrowserRouter(
[
{ path: "/", element: <Start /> },
{ path: "/with space", element: <ShowPath /> },
{ path: "/with space&encoded:characters", element: <ShowPath /> },
],
{ window: testWindow }
);
let ctx = render(<RouterProvider router={router} />);

expect(testWindow.location.pathname).toBe("/with%20space");
expect(testWindow.location.pathname).toBe("/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});
});

describe("hash routers", () => {
it("encodes characters in HashRouter", () => {
let testWindow = getWindow("/#/with space");
let testWindow = getWindow("/#/with%20space%26encoded%3Acharacters");

let ctx = render(
<HashRouter window={testWindow}>
<Routes>
<Route path="/with space" element={<ShowPath />} />
<Route path="/with space&encoded:characters" element={<ShowPath />} />
</Routes>
</HashRouter>
);

expect(testWindow.location.pathname).toBe("/");
expect(testWindow.location.hash).toBe("#/with%20space");
expect(testWindow.location.hash).toBe("#/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});

Expand All @@ -936,39 +936,39 @@ describe("special character tests", () => {
function Start() {
let navigate = useNavigate();
// eslint-disable-next-line react-hooks/exhaustive-deps
React.useEffect(() => navigate("/with space"), []);
React.useEffect(() => navigate("/with%20space%26encoded%3Acharacters"), []);
return null;
}

let ctx = render(
<HashRouter window={testWindow}>
<Routes>
<Route path="/" element={<Start />} />
<Route path="/with space" element={<ShowPath />} />
<Route path="/with space&encoded:characters" element={<ShowPath />} />
</Routes>
</HashRouter>
);

expect(testWindow.location.pathname).toBe("/");
expect(testWindow.location.hash).toBe("#/with%20space");
expect(testWindow.location.hash).toBe("#/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});

it("encodes characters in createHashRouter", () => {
let testWindow = getWindow("/#/with space");
let testWindow = getWindow("/#/with%20space%26encoded%3Acharacters");

let router = createHashRouter(
[{ path: "/with space", element: <ShowPath /> }],
[{ path: "/with space&encoded:characters", element: <ShowPath /> }],
{ window: testWindow }
);
let ctx = render(<RouterProvider router={router} />);

expect(testWindow.location.pathname).toBe("/");
expect(testWindow.location.hash).toBe("#/with%20space");
expect(testWindow.location.hash).toBe("#/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});

Expand All @@ -978,23 +978,23 @@ describe("special character tests", () => {
function Start() {
let navigate = useNavigate();
// eslint-disable-next-line react-hooks/exhaustive-deps
React.useEffect(() => navigate("/with space"), []);
React.useEffect(() => navigate("/with%20space%26encoded%3Acharacters"), []);
return null;
}

let router = createHashRouter(
[
{ path: "/", element: <Start /> },
{ path: "/with space", element: <ShowPath /> },
{ path: "/with space&encoded:characters", element: <ShowPath /> },
],
{ window: testWindow }
);
let ctx = render(<RouterProvider router={router} />);

expect(testWindow.location.pathname).toBe("/");
expect(testWindow.location.hash).toBe("#/with%20space");
expect(testWindow.location.hash).toBe("#/with%20space%26encoded%3Acharacters");
expect(ctx.container.innerHTML).toMatchInlineSnapshot(
`"<pre>{"pathname":"/with%20space","search":"","hash":""}</pre>"`
`"<pre>{"pathname":"/with%20space%26encoded%3Acharacters","search":"","hash":""}</pre>"`
);
});
});
Expand Down
12 changes: 12 additions & 0 deletions packages/react-router/__tests__/matchPath-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,14 @@ describe("matchPath", () => {
pathnameBase: "/users/mj",
});
});

it("matches second consecutive slash as a parameter", () => {
expect(matchPath("/:id", "//")).toMatchObject({
params: { id: "/" },
pathname: "//",
pathnameBase: "//",
});
});
});

describe("with { end: false }", () => {
Expand Down Expand Up @@ -164,6 +172,10 @@ describe("matchPath", () => {
matchPath({ path: "/users/mj", end: false }, "/users/mj2")
).toBeNull();
});

it("does not match second consecutive slash as a parameter", () => {
expect(matchPath({ path: "/:id", end: false }, "//")).toBeNull();
});
});

describe("with { end: false } and a / pattern", () => {
Expand Down
Loading