-
Notifications
You must be signed in to change notification settings - Fork 121
Upgrade maven-ejb-plugin alongside jakarta.ejb-api #1155
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
Open
evie-lau
wants to merge
5
commits into
openrewrite:main
Choose a base branch
from
evie-lau:maven-ejb-plugin
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d6ffb7b
Upgrade maven-ejb-plugin alongside jakarta.ejb-api
evie-lau 3de1f38
Change XPath to be less rigid
evie-lau 4b3a03d
Handle case where ejb.api is coupled with maven-ejb-plugin's ejbVersion
evie-lau b6d3ac1
More specific version assertions in ejb-api test
evie-lau 387da74
regenerate recipes.csv
evie-lau File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
89 changes: 89 additions & 0 deletions
89
src/main/java/org/openrewrite/java/migrate/jakarta/UpgradeMavenEjbPluginConfiguration.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright 2025 the original author or authors. | ||
| * <p> | ||
| * Licensed under the Moderne Source Available License (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * <p> | ||
| * https://docs.moderne.io/licensing/moderne-source-available-license | ||
| * <p> | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.openrewrite.java.migrate.jakarta; | ||
|
|
||
| import lombok.EqualsAndHashCode; | ||
| import lombok.Value; | ||
| import org.openrewrite.ExecutionContext; | ||
| import org.openrewrite.Recipe; | ||
| import org.openrewrite.TreeVisitor; | ||
| import org.openrewrite.maven.MavenIsoVisitor; | ||
| import org.openrewrite.xml.ChangeTagValueVisitor; | ||
| import org.openrewrite.xml.tree.Xml; | ||
|
|
||
| /** | ||
| * Sets the {@code <ejbVersion>} configuration of the {@code maven-ejb-plugin} to {@code 4.0}, | ||
| * handling both literal values (e.g. {@code 3.2}) and Maven property references | ||
| * (e.g. {@code ${jee.ejb.api}}) whose resolved value matches the EJB 3.x range. | ||
| * <p> | ||
| * This complements {@code UpgradePluginVersion} (which already handles property-referenced | ||
| * plugin versions via {@code ChangePropertyValue}) and replaces the YAML-only | ||
| * {@code ChangeTagValue} step that could not resolve property expressions. | ||
| */ | ||
| @Value | ||
| @EqualsAndHashCode(callSuper = false) | ||
| public class UpgradeMavenEjbPluginConfiguration extends Recipe { | ||
|
|
||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return "Set `maven-ejb-plugin` ejbVersion to 4.0"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getDescription() { | ||
| return "Updates the `<ejbVersion>` configuration of `maven-ejb-plugin` to `4.0` when the current value " + | ||
| "(or its resolved Maven property) indicates EJB 3.x. Handles the common pattern where `<ejbVersion>` " + | ||
| "is coupled to the `javax.ejb-api` dependency version via a shared property, decoupling them after migration."; | ||
| } | ||
|
|
||
| @Override | ||
| public TreeVisitor<?, ExecutionContext> getVisitor() { | ||
| return new MavenIsoVisitor<ExecutionContext>() { | ||
| @Override | ||
| public Xml.Tag visitTag(Xml.Tag tag, ExecutionContext ctx) { | ||
| // isPluginTag() relies on cursor state — must be checked before super.visitTag() | ||
| if (!isPluginTag("org.apache.maven.plugins", "maven-ejb-plugin")) { | ||
| return super.visitTag(tag, ctx); | ||
| } | ||
| Xml.Tag ejbVersionTag = tag.getChild("configuration") | ||
| .flatMap(config -> config.getChild("ejbVersion")) | ||
| .orElse(null); | ||
| if (ejbVersionTag != null) { | ||
| String rawValue = ejbVersionTag.getValue().orElse(null); | ||
| if (rawValue != null && !"4.0".equals(rawValue.trim())) { | ||
| // Resolve property references (e.g. "${jee.ejb.api}") to their actual value. | ||
| // Note: by the time this recipe runs the property may already have been bumped to 4.x | ||
| // by an earlier step (ChangeDependency / UpgradeDependencyVersion), so we resolve | ||
| // against the *original* pom values by checking the rawValue pattern too. | ||
| String rawTrimmed = rawValue.trim(); | ||
| boolean isPropertyRef = rawTrimmed.startsWith("${"); | ||
| String resolvedValue = isPropertyRef ? | ||
| getResolutionResult().getPom().getValue(rawTrimmed) : rawTrimmed; | ||
| boolean currentlyEjb3 = resolvedValue != null && resolvedValue.startsWith("3."); | ||
| // A property reference means the ejbVersion was coupled to the javax.ejb-api version. | ||
| // Even if the property was already updated to 4.x by an earlier recipe step, the | ||
| // ejbVersion tag still holds a property reference that must be replaced with "4.0". | ||
| if (isPropertyRef || currentlyEjb3) { | ||
| doAfterVisit(new ChangeTagValueVisitor<>(ejbVersionTag, "4.0")); | ||
| } | ||
| } | ||
| } | ||
| return super.visitTag(tag, ctx); | ||
| } | ||
| }; | ||
| } | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think 3.3.0 should work as well, but 3.2.1 is the minimum required.
Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fine to use this; should resolve to whatever version is available in 3.2 range; if you're confident 3.x would work for the foreseeable future we could use that as well to cover both, although it could lead to some unnecessary changes.