fix: generatePath incorrectly applying parameters #9051 #10078
Conversation
|
|
Hi @Obi-Dann, Welcome, and thank you for contributing to React Router! Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once. You may review the CLA and sign it by adding your name to contributors.yml. Once the CLA is signed, the If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run. Thanks! - The Remix team |
generatePath was doing multiple passes on the `path` using string replace, the first two passes were applying parameters, the third pass was doing a cleanup and the fourth path was applying the `splat`.
It was possible to get incorrect results while applying `splat` when the last parameter value ended with `*`:
```ts
const path = generatePath("/route/:name", {
name: encodeURIComponent("includes *asterisk at the end*"),
})
```
```
Expected: "/route/includes *asterisk at the end*"
Received: "/route/includes *asterisk at the end"
```
results of the first two passes return the value of `/route/*asterisk at the end*` which was later treated as path with the splat resulting in the last asterisk removed.
it was also possible to inject the splat value unintentionally
```ts
generatePath("/courses/:name", { name: "foo*", "*": "splat_should_not_be_added" })
```
```
Expected: "/courses/foo*"
Received: "/courses/foosplat_should_not_be_added"
```
A safer option, instead of mutating a global path multiple times, is to split the path into segments, process each segment in isolation and then join them back together.
fixes remix-run#9051
paramName for the splat wasn't correctly resolved when the pas is `/*`
Obi-Dann
force-pushed
the
fix-generateRoute-#9051
branch
from
2a1892e
to
eef790c
Compare
|
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
The changeset is there, I added it and rebased. I guess the bot does not handle rebases well :) |
Thanks for this! I've actually got this approach sitting in a stash somewhere 😂 |
generatePath was doing multiple passes on the
pathusing string replace, the first two passes were applying parameters, the third pass was doing a cleanup and the fourth path was applying thesplat. It was possible to get incorrect results while applyingsplatwhen the last parameter value ended with*:results of the first two passes return the value of
/route/*asterisk at the end*which was later treated as path with the splat resulting in the last asterisk removed.it was also possible to inject the splat value unintentionally
A safer option, instead of mutating a global path multiple times, is to split the path into segments, process each segment in isolation and then join them back together.
fixes #9051