fix: extract path parameters correctly when the router is mounted as subrouter - #134
Merged
pk-work merged 2 commits intoAug 10, 2026
Merged
Conversation
…subrouter The position of a path parameter was calculated from the beginning of the OpenAPI path template and applied to the path of the incoming request. When the router built from the contract is mounted as a subrouter, the request path contains additional leading segments, so the calculated position pointed to the wrong segment and validation failed or, even worse, validated the wrong value. Since mounting a router can only prepend segments to the request path, the number of additional leading segments is now determined by comparing the number of segments of the request path with the number of segments of the path template, and the parameter position is shifted accordingly. For routers that are not mounted as subrouter the behaviour is unchanged. Fixes eclipse-vertx#120
Contributor
|
@jnbdz Thank you! |
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
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.
Motivation
As reported in #120:
RequestUtilscalculates the position of a path parameter from the beginning of the OpenAPI path template (/entities/{id}→ segment 2) and applies it to the path of the incoming request. When the router built from the contract is mounted as a subrouter (e.g.mainRouter.route("/my-service/*").subRouter(router)), the request path (/my-service/entities/5) contains additional leading segments, so the calculated position points to the wrong segment. Validation then either fails with a confusing type error or — worse — silently validates the wrong value (forstringparameters).Changes
Mounting a router can only prepend segments to the request path, so the number of additional leading segments can be determined by comparing the segment count of the request path with the segment count of the path template. The parameter position is now shifted by this mount offset:
0and the behaviour is unchanged — including the existing handling of empty path parameters.Parameterargument ofextractPathParametersthat was mentioned in the issue discussion.One limitation worth being transparent about: a mounted router receiving an empty trailing path parameter (
/my-service/test/) remains ambiguous, because without knowing the mount point the extra segments cannot be distinguished from the parameter itself. Resolving that fully would require the mount information fromvertx-web(see vert-x3/vertx-web#2694). This change fixes the practically relevant cases without any API change.Fixes #120