feat: Improve the matching of required versions#11770
Conversation
|
Take a peek at "counter pr" #11786 |
| // Specific for Version _requirement_ matching; | ||
| // If the version is a simple integer (like "25") | ||
| // then treat this as the requirement "the major version is 25" | ||
| if (Pattern.matches("^[0-9]+$", requirement)) { |
There was a problem hiding this comment.
We can move pattern compile to static filed
gnodet
left a comment
There was a problem hiding this comment.
Claude Code on behalf of Guillaume Nodet
Nice idea to make toolchain version matching more lenient for the auto-generated toolchains.xml use case. Two issues I spotted:
- Regex bug: The
major.minorpattern only allows a single-digit major version, so"21.3"would not match. Needs[0-9]+for the major part too. - Pattern precompilation: As @slawekjaranowski already noted, the patterns should be compiled once into static fields.
- Missing test coverage: No tests for multi-digit major versions (e.g., requirement
"21"against version"21.0.2", or"21.3"against"21.3.1").
|
|
||
| // If the version is a major.minor (like "1.5") | ||
| // then treat this as the requirement "the major version is 1 and the minor is 5" | ||
| if (Pattern.matches("^[0-9]\\.[0-9]+$", requirement)) { |
There was a problem hiding this comment.
Bug: the major version part is [0-9] (single digit only), so a requirement like "21.3" would silently fall through to the default path and be treated as an exact match. It should be [0-9]+ to mirror the first pattern.
| if (Pattern.matches("^[0-9]\\.[0-9]+$", requirement)) { | |
| if (Pattern.matches("^[0-9]+\\.[0-9]+$", requirement)) { |
Also, as @slawekjaranowski mentioned, both patterns should be pre-compiled into private static final Pattern fields to avoid recompilation on every call.
| assertTrue(matcher.matches("1.5")); // Major.Minor matches | ||
| assertTrue(matcher.matches("1.5.2")); // Full match | ||
| assertFalse(matcher.matches("1.6")); // Wrong minor | ||
| assertFalse(matcher.matches("2")); // Wrong major |
There was a problem hiding this comment.
Consider adding tests for multi-digit major versions to catch the regex bug above, e.g.:
matcher = RequirementMatcherFactory.createVersionMatcher("21.0.2");
assertTrue(matcher.matches("21")); // major-only
assertTrue(matcher.matches("21.0")); // major.minor
assertFalse(matcher.matches("21.1")); // wrong minor
assertFalse(matcher.matches("2")); // wrong major
@cstamas Followup of this discussion on Slack https://the-asf.slack.com/archives/C7Q9JB404/p1773056234905829?thread_ts=1773053661.648449&cid=C7Q9JB404
When people write in (for example) the maven-invoker-plugin something like
invoker.toolchain.jdk.version = 11it is implemented as an exact match on the mentioned version specified in the toolchains.xml .Historically people would write this config manually and then the exact version
11works as expected.With the automatic generation of the toolchains.xml more places will contain the
fullversion of the JDK like<version>11.0.29</version>instead of the more simple<version>11</version>.The effect of people using these automatically generated toolchains.xml files is that now things still work as designed, but not as expected.
This is a quick implementation of my proposal to simply treat the requirement of a single number X as "the major version must be X".
I have also included the same for a "major.minor" requirement to accept all patch versions under that also.
This means a change from a mismatch to a match in cases like this:
I'm unsure if this change is "too breaking" to be implemented.
Following this checklist to help us incorporate your contribution quickly and easily:
Your pull request should address just one issue, without pulling in other changes.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Each commit in the pull request should have a meaningful subject line and body.
Note that commits might be squashed by a maintainer on merge.
Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
Run
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
You have run the Core IT successfully.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.