Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix bug in common path prefix calculation in Helidon generators #20310

Merged
merged 1 commit into from
Dec 14, 2024

Conversation

tjquinno
Copy link
Contributor

Resolves #20298

The Helidon generator contains code to calculate the longest common prefix among paths to help optimize the grouping of operations into services.

As described in the bug, the original implementation essentially compared character-by-character which led to problems if paths agreed partway through a segment. For example, given the paths "/a/part-one" and "/a/part-two" the code would incorrectly yield a common prefix of "a/part-" when it should have been "/a".

The PR revises the calculation so it examines corresponding segments rather than corresponding characters of the paths.

The PR includes additional tests to more thoroughly check the implementation.

(Also, the PR updates the hard-coded current latest releases of Helidon used by the generator if the user does not specify a Helidon version and if the available versions are not available on the network.)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@wing328 wing328 added this to the 7.11.0 milestone Dec 14, 2024
@wing328 wing328 merged commit d55a41e into OpenAPITools:master Dec 14, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][java-helidon-server] Router grouping by Longest common path prefix doesn't respect path segments
2 participants