fix: ensure consistency in generatePath/compilePath for partial splats #9238
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 7017172 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
brophdawg11
commented
Sep 12, 2022
| describe("when the pattern has a trailing *", () => { | ||
| it("matches the remaining portion of the pathname", () => { | ||
| expect(matchPath("/files*", "/files/mj.jpg")).toMatchObject({ | ||
| params: { "*": "/mj.jpg" }, |
There was a problem hiding this comment.
Previously trimmed leading slashes are now included since we support partial splat matching
brophdawg11
commented
Sep 12, 2022
|
|
||
| function computeScore(path: string, index: boolean | undefined): number { | ||
| let segments = path.split("/"); | ||
| let initialScore = segments.length; | ||
| if (segments.some(isSplat)) { |
There was a problem hiding this comment.
splat scoring moved inside the below loop to avoid multiple traversals of segments
brophdawg11
force-pushed
the
brophdawg11/consistent-partial-splat-handling
branch
from
e8f7403
to
08b2442
Compare
brophdawg11
commented
Sep 12, 2022
| { path: "prefix-:param" }, // Score 12 | ||
| { path: "prefix-*" }, // Score 11 | ||
| { path: ":param" }, // Score 6 | ||
| { path: "*" }, // Score 1 |
There was a problem hiding this comment.
This is my attempt to pressure test all the potential combinations of partial/full splat/dynamic params and assert that we get the expected matches/params
|
Closing in favor of #9506 |
MichaelDeBoey
deleted the
brophdawg11/consistent-partial-splat-handling
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes a small inconsistency ingeneratePathw.r.t.compilePath. We do support partial named params but at the moment we do not support partial splat params, butgeneratePathwas permitting them. This alignsgeneratePathbehavior and provides the same warning ascompilePathAfter chatting with @ryanflorence we decided that if possible we should look into removing that warning and supporting partial splat params (in path matching and
generatePath), such the the path/prefix-*is matched by the URL/prefix-thing. This PR adds specific scoring for both partial dynamic (/prefix-:param) and partial static (/prefix-*) path segments.There are I think 2 exiting unit tests that break, that rely on the behavior indicated by the previous warning. So want to confirm those changes with @mjackson and @ryanflorence, but otherwise everything else passes and I added a decently sized test to try to really kick the tire son the scoring algorithm and potential conflicts.
Note: Recommend viewing the PR with whitespace hidden