fix(o2k) update path param regex to match 1 segment only #3298
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
Tieske
force-pushed
the
fix/path-param-regex
branch
from
b229a3d
to
d5dc70d
Compare
Tieske
force-pushed
the
fix/path-param-regex
branch
from
5af7d2a
to
4db0363
Compare
|
the CI failure doesn't provide a meaningfull hint (at least to me) as to what failed... any help appreciated |
develohpanda
approved these changes
Apr 19, 2021
Comment on lines
190
to
192
| expect(pathVariablesToRegex('/foo/{bar}/{baz}')).toBe( | ||
| '/foo/(?<bar>[^\\/\\r\\n\\t\\f\\v ]+)/(?<baz>[^\\/\\r\\n\\t\\f\\v ]+)$', | ||
| ); |
There was a problem hiding this comment.
The CI failure is to do with this test. The expected result is incorrect? I'm looking at the updated implementation of pathVariablesToRegex() below and it matches what the received result is, not the expected result.
Since \s is equivalent to \r\n\t\f\v , just need to update the expected result.
| @@ -59,7 +59,7 @@ describe('services', () => { | |||
| name: 'My_API-birds_id-get', | |||
| strip_path: false, | |||
| methods: ['GET'], | |||
| paths: ['/birds/(?<id>\\S+)$'], | |||
| paths: ['/birds/(?<id>[^\\/\\r\\n\\t\\f\\v ]+)$'], | |||
There was a problem hiding this comment.
CI also fails with this test for the same reason as my previous comment
| @@ -68,7 +68,7 @@ export function generateSlug(str: string, options: SlugifyOptions = {}): string | |||
| const pathVariableSearchValue = /{([^}]+)}(?!:\/\/)/g; | |||
|
|
|||
| export function pathVariablesToRegex(p: string): string { | |||
| const result = p.replace(pathVariableSearchValue, '(?<$1>\\S+)'); | |||
| const result = p.replace(pathVariableSearchValue, '(?<$1>[^\\/\\s]+)'); | |||
There was a problem hiding this comment.
It would be worth adding a comment here to explain this regex, something like
Suggested change
| const result = p.replace(pathVariableSearchValue, '(?<$1>[^\\/\\s]+)'); | |
| // match any non-whitespace character, excluding / | |
| const result = p.replace(pathVariableSearchValue, '(?<$1>[^\\/\\s]+)'); |
existing regex '\S+' is equivalent to '[^\s]+' by adding the
'/' character as not allowed, we limit the regex to match only 1 path
segment
This path: "/tracks/{hello}/world/{there}”
Would create: “/tracks/(?<hello>\S+)/world/(?<there>\S+)$”
This path works as expected:
/tracks/xxx/world/yyy
With captures:
hello: xxx
there: yyy
This path also works, unexpected:
/tracks/xxx/zzz/world/yyy/andthensome
With captures:
hello: xxx/zzz
there: yyy/andthensome
The last one should have matched only a single path segment, but
actually matches multiple.
Tieske
force-pushed
the
fix/path-param-regex
branch
from
4db0363
to
65c6a01
Compare
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.
existing regex
\S+is equivalent to[^\s]+by adding the/character as not allowed, we limit the regex to match only 1 path segmentThis path:
/tracks/{hello}/world/{there}Would create:
/tracks/(?<hello>\S+)/world/(?<there>\S+)$When published, this path matches
/tracks/xxx/world/yyyas it shouldWith captures:
hello:xxxthere: yyyThis path also matches
/tracks/xxx/zzz/world/yyy/andthensomebut it should notWith captures:
hello:xxx/zzzthere:yyy/andthensomeThe last one should have matched only a single path segment, but actually matches multiple.