feat: export isCanonicalPath predicate for resolveDotSegments#1460
Merged
Conversation
Expose the resolver's fast-path guard as a public predicate: exact in both directions (`isCanonicalPath(path, opts)` iff `resolveDotSegments(path, opts) === path`), so a caller that canonicalizes on a hot path (per-request scope or rule matching) can skip the call without duplicating knowledge of what the resolver decodes. Pinned by a 200k-assertion seeded-fuzz equivalence test across all four option modes — any future widening of what the resolver decodes must widen the guard in the same commit or the property breaks. Co-Authored-By: Claude Fable 5 <[email protected]>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The JSDoc claimed the predicate "never inspects a query/hash", which reads as "a query is safely ignored". The resolver has no notion of one and scans it as path, so `/a?next=/../b` resolves to `/b` — the opposite of ignored. State that, with the example. Also drop the duplicated fast-path guard in `resolveDotSegments`: after the leading-run normalization the path starts with a single `/`, so the predicate's leading-slash checks are already satisfied and it can just call `isCanonicalPath`. Behavior and fast-path cost are unchanged; the guard now lives in exactly one place. Co-Authored-By: Claude Opus 4.8 <[email protected]>
pi0
changed the title
isCanonicalPath predicateisCanonicalPath predicate for resolveDotSegments
pi0
approved these changes
Jul 14, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Stacked on #1458 (retarget to
mainafter it merges).What
Exports the resolver's fast-path guard as a public predicate:
Exact in both directions:
trueiffresolveDotSegments(path, opts) === path.Why
Callers that canonicalize on a hot path (per-request scope checks, route-rule matching) want to skip the resolve and the work derived from it — h3-rules matches both the empty-preserving and slash-merged readings on every request, and can collapse to a single match when the path is already canonical in the strictest mode.
They can't safely answer "is this canonical?" themselves. A caller-side prescan duplicates knowledge of what the resolver decodes, and a stale copy silently skips a canonicalization step — for these consumers that's a scope-check bypass, not a perf bug. The alternative,
resolveDotSegments(p, o) === p, only works because the fast path happens to return the same string reference, which is an implementation detail and not part of the contract.Exporting the resolver's own guard gives callers the check without either dependency.
Pinning
isCanonicalPath(p, o) === (resolveDotSegments(p, o) === p). Any future widening of what the resolver decodes must widen the guard in the same commit, or the property breaks.%2fopaque by default vs decoded withdecodeSlashes,//withmergeSlashes) and fast-path retention (/.well-known/…,/a%2eb,/a/...).🤖 Generated with Claude Code