Skip to content

ChangeDependencyGroupIdAndArtifactId does not update properties in parent pom #5815

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.

Sign up for GitHub

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

Merged
timtebeek merged 20 commits into from
Aug 11, 2025
Merged

ChangeDependencyGroupIdAndArtifactId does not update properties in parent pom #5815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
fb1eea8
Adding example showcasing problem
steve-aom-elliott Jul 28, 2025
469141d
Impl
jevanlingen Jul 31, 2025
3af3d75
Merge branch 'main' into 1374-dependency-references-version-in-parent…
jevanlingen Jul 31, 2025
f3e719c
Apply suggestion from @github-actions[bot]
jevanlingen Jul 31, 2025
11d8d2e
Polish
jevanlingen Jul 31, 2025
96c9001
Polish
jevanlingen Jul 31, 2025
981a35b
Polish
jevanlingen Jul 31, 2025
c910f45
Polish
jevanlingen Jul 31, 2025
e417e83
Polish
jevanlingen Jul 31, 2025
f6fa1d8
Polish
jevanlingen Jul 31, 2025
7f81eed
Fix retain versions for UpgradeDependencyVersion
jevanlingen Jul 31, 2025
b4d3ca7
Polish
jevanlingen Jul 31, 2025
43440e5
Polish
jevanlingen Jul 31, 2025
1191d39
Polish
jevanlingen Jul 31, 2025
f3c6d1b
Polish
jevanlingen Jul 31, 2025
5b75ed0
Polish
jevanlingen Jul 31, 2025
39c315b
Merge branch 'main' into 1374-dependency-references-version-in-parent…
jevanlingen Jul 31, 2025
7c231f9
Merge branch 'main' into 1374-dependency-references-version-in-parent…
timtebeek Aug 4, 2025
2dca12b
Merge branch 'main' into 1374-dependency-references-version-in-parent…
timtebeek Aug 11, 2025
52e1711
Minor polish
timtebeek Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 147 additions & 52 deletions rewrite-maven/src/main/java/org/openrewrite/maven/ChangeDependencyGroupIdAndArtifactId.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.openrewrite.xml.RemoveContentVisitor;
import org.openrewrite.xml.tree.Xml;

import java.nio.file.Path;
import java.util.*;

import static java.util.Collections.max;
Expand All @@ -37,7 +38,7 @@

@Value
@EqualsAndHashCode(callSuper = false)
public class ChangeDependencyGroupIdAndArtifactId extends Recipe {
public class ChangeDependencyGroupIdAndArtifactId extends ScanningRecipe<ChangeDependencyGroupIdAndArtifactId.Accumulator> {
transient MavenMetadataFailures metadataFailures = new MavenMetadataFailures(this);

@Option(displayName = "Old groupId",
Expand Down Expand Up @@ -143,25 +144,19 @@ public Validated<Object> validate() {
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
public Accumulator getInitialValue(ExecutionContext ctx) {
return new Accumulator();
}

@Override
public TreeVisitor<?, ExecutionContext> getScanner(Accumulator acc) {
return new MavenVisitor<ExecutionContext>() {
@Nullable
final VersionComparator versionComparator = newVersion != null ? Semver.validate(newVersion, versionPattern).getValue() : null;
@Nullable
private Collection<String> availableVersions;
final @Nullable VersionComparator versionComparator = newVersion != null ? Semver.validate(newVersion, versionPattern).getValue() : null;
private boolean isNewDependencyPresent;

@Override
public Xml visitDocument(Xml.Document document, ExecutionContext ctx) {
isNewDependencyPresent = checkIfNewDependencyPresents(newGroupId, newArtifactId, newVersion);
// Any managed dependency change is unlikely to use the same version, so only update selectively.
if ((changeManagedDependency == null || changeManagedDependency) && newVersion != null || versionPattern != null) {
doAfterVisit(new ChangeManagedDependencyGroupIdAndArtifactId(
oldGroupId, oldArtifactId,
Optional.ofNullable(newGroupId).orElse(oldGroupId),
Optional.ofNullable(newArtifactId).orElse(oldArtifactId),
newVersion, versionPattern).getVisitor());
}
return super.visitDocument(document, ctx);
}

Expand All @@ -170,58 +165,59 @@ public Xml visitTag(Xml.Tag tag, ExecutionContext ctx) {
Xml.Tag t = (Xml.Tag) super.visitTag(tag, ctx);
boolean isOldDependencyTag = isDependencyTag(oldGroupId, oldArtifactId);
if (isOldDependencyTag && isNewDependencyPresent) {
doAfterVisit(new RemoveContentVisitor<>(tag, true, true));
maybeUpdateModel();
acc.isNewDependencyPresent = true;
return t;
}
if (isOldDependencyTag || isPluginDependencyTag(oldGroupId, oldArtifactId)) {
String groupId = newGroupId;
if (groupId != null) {
t = changeChildTagValue(t, "groupId", groupId, ctx);
} else {
groupId = t.getChildValue("groupId").orElseThrow(NoSuchElementException::new);
Optional<String> groupIdFromTag = t.getChildValue("groupId");
Optional<String> artifactIdFromTag = t.getChildValue("artifactId");
if (!groupIdFromTag.isPresent() || !artifactIdFromTag.isPresent()) {
return t;
}
String artifactId = newArtifactId;
if (artifactId != null) {
t = changeChildTagValue(t, "artifactId", artifactId, ctx);
} else {
artifactId = t.getChildValue("artifactId").orElseThrow(NoSuchElementException::new);

String groupId = groupIdFromTag.get();
if (newGroupId != null) {
storeParentPomProperty(groupId, newGroupId);
groupId = newGroupId;
acc.changeGroupId = groupId;
}

String artifactId = artifactIdFromTag.get();
if (newArtifactId != null) {
storeParentPomProperty(artifactId, newArtifactId);
artifactId = newArtifactId;
acc.changeArtifactId = artifactId;
}
String currentVersion = t.getChildValue("version").orElse(null);

if (newVersion != null) {
try {
String resolvedNewVersion = resolveSemverVersion(ctx, groupId, artifactId, currentVersion);
Optional<Xml.Tag> scopeTag = t.getChild("scope");
Scope scope = scopeTag.map(xml -> Scope.fromName(xml.getValue().orElse("compile"))).orElse(Scope.Compile);
Optional<String> currentVersion = t.getChildValue("version");
String resolvedNewVersion = resolveSemverVersion(groupId, artifactId, currentVersion.orElse(newVersion), ctx);
Scope scope = t.getChild("scope").map(xml -> Scope.fromName(xml.getValue().orElse(null))).orElse(Scope.Compile);
Optional<Xml.Tag> versionTag = t.getChild("version");

boolean configuredToOverrideManageVersion = overrideManagedVersion != null && overrideManagedVersion; // False by default
boolean configuredToChangeManagedDependency = changeManagedDependency == null || changeManagedDependency; // True by default

boolean versionTagPresent = versionTag.isPresent();
boolean oldDependencyManaged = isDependencyManaged(scope, oldGroupId, oldArtifactId);
boolean newDependencyManaged = isDependencyManaged(scope, groupId, artifactId);
if (versionTagPresent) {
if (versionTag.isPresent()) {
// If the previous dependency had a version but the new artifact is managed, removed the version tag.
if (!configuredToOverrideManageVersion && newDependencyManaged || (oldDependencyManaged && configuredToChangeManagedDependency)) {
t = (Xml.Tag) new RemoveContentVisitor<>(versionTag.get(), false, true).visit(t, ctx);
acc.removeVersionTag = true;
} else {
// Otherwise, change the version to the new value.
t = changeChildTagValue(t, "version", resolvedNewVersion, ctx);
storeParentPomProperty(currentVersion.orElse(null), resolvedNewVersion);
acc.changeVersion = resolvedNewVersion;
}
} else if (configuredToOverrideManageVersion || !newDependencyManaged) {
//If the version is not present, add the version if we are explicitly overriding a managed version or if no managed version exists.
Xml.Tag newVersionTag = Xml.Tag.build("<version>" + resolvedNewVersion + "</version>");
//noinspection ConstantConditions
t = (Xml.Tag) new AddToTagVisitor<ExecutionContext>(t, newVersionTag, new MavenTagInsertionComparator(t.getChildren())).visitNonNull(t, ctx, getCursor().getParent());
// If the version is not present, add the version if we are explicitly overriding a managed version or if no managed version exists.
acc.createVersion = resolvedNewVersion;
}
} catch (MavenDownloadingException e) {
return e.warn(tag);
}
}
if (t != tag) {
maybeUpdateModel();
}
}

//noinspection ConstantConditions
Expand Down Expand Up @@ -249,23 +245,122 @@ private boolean isDependencyManaged(Scope scope, String groupId, String artifact
}

@SuppressWarnings("ConstantConditions")
private String resolveSemverVersion(ExecutionContext ctx, String groupId, String artifactId, @Nullable String currentVersion) throws MavenDownloadingException {
if (versionComparator == null) {
return newVersion;
private String resolveSemverVersion(String groupId, String artifactId, String version, ExecutionContext ctx) throws MavenDownloadingException {
List<String> availableVersions = new ArrayList<>();
MavenMetadata mavenMetadata = metadataFailures.insertRows(ctx, () -> downloadMetadata(groupId, artifactId, ctx));
for (String v : mavenMetadata.getVersioning().getVersions()) {
if (versionComparator.isValid(version, v)) {
availableVersions.add(v);
}
}
String finalCurrentVersion = currentVersion != null ? currentVersion : newVersion;
if (availableVersions == null) {
availableVersions = new ArrayList<>();
MavenMetadata mavenMetadata = metadataFailures.insertRows(ctx, () -> downloadMetadata(groupId, artifactId, ctx));
for (String v : mavenMetadata.getVersioning().getVersions()) {
if (versionComparator.isValid(finalCurrentVersion, v)) {
availableVersions.add(v);
return availableVersions.isEmpty() ? newVersion : max(availableVersions, versionComparator);
}

private void storeParentPomProperty(@Nullable String currentValue, String newValue) {
if (isProperty(currentValue)) {
String name = currentValue.substring(2, currentValue.length() - 1).trim();
if (!getResolutionResult().getPom().getRequested().getProperties().containsKey(name)) {
storeParentPomProperty(getResolutionResult(), name, newValue);
}
}
}

private void storeParentPomProperty(MavenResolutionResult resolutionResult, String name, String value) {
Pom pom = resolutionResult.getPom().getRequested();
if (pom.getSourcePath() != null && pom.getProperties().containsKey(name)) {
acc.pomProperties.add(new PomProperty(pom.getSourcePath(), name, value));
} else if (resolutionResult.getParent() != null) {
storeParentPomProperty(resolutionResult.getParent(), name, value);
}
}
};
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor(Accumulator acc) {
return new MavenVisitor<ExecutionContext>() {
@Override
public Xml visitDocument(Xml.Document document, ExecutionContext ctx) {
// Any managed dependency change is unlikely to use the same version, so only update selectively.
if ((changeManagedDependency == null || changeManagedDependency) && newVersion != null || versionPattern != null) {
doAfterVisit(new ChangeManagedDependencyGroupIdAndArtifactId(
oldGroupId, oldArtifactId,
Optional.ofNullable(newGroupId).orElse(oldGroupId),
Optional.ofNullable(newArtifactId).orElse(oldArtifactId),
newVersion, versionPattern).getVisitor());
}
return super.visitDocument(document, ctx);
}

@Override
public Xml visitTag(Xml.Tag tag, ExecutionContext ctx) {
Xml.Tag t = (Xml.Tag) super.visitTag(tag, ctx);
if (isPropertyTag()) {
Path sourcePath = getResolutionResult().getPom().getRequested().getSourcePath();
for (PomProperty prop : acc.pomProperties) {
if (prop.filePath.equals(sourcePath)) {
doAfterVisit(new ChangePropertyValue(prop.name, prop.value, false, false).getVisitor());
}
}
return t;
}

boolean isOldDependencyTag = isDependencyTag(oldGroupId, oldArtifactId);
if (isOldDependencyTag && acc.isNewDependencyPresent) {
doAfterVisit(new RemoveContentVisitor<>(t, true, true));
maybeUpdateModel();
return t;
}
return availableVersions.isEmpty() ? newVersion : max(availableVersions, versionComparator);
if (isOldDependencyTag || isPluginDependencyTag(oldGroupId, oldArtifactId)) {
if (acc.changeGroupId != null) {
t = changeChildTagValue(t, "groupId", newGroupId, ctx);
}
if (acc.changeArtifactId != null) {
t = changeChildTagValue(t, "artifactId", newArtifactId, ctx);
}

if (acc.createVersion != null) {
Xml.Tag newVersionTag = Xml.Tag.build("<version>" + acc.createVersion + "</version>");
t = (Xml.Tag) new AddToTagVisitor<ExecutionContext>(t, newVersionTag, new MavenTagInsertionComparator(t.getChildren())).visitNonNull(t, ctx, getCursor().getParent());
} else if (acc.changeVersion != null) {
t = changeChildTagValue(t, "version", acc.changeVersion, ctx);
} else if (acc.removeVersionTag) {
t = (Xml.Tag) new RemoveContentVisitor<>(t.getChild("version").get(), false, true).visitNonNull(t, ctx);
}

if (t != tag) {
maybeUpdateModel();
}
}

return t;
}
};
}

public static class Accumulator {
Set<PomProperty> pomProperties = new HashSet<>();
boolean isNewDependencyPresent;

@Nullable
String changeGroupId;

@Nullable
String changeArtifactId;

boolean removeVersionTag;

@Nullable
String createVersion;

@Nullable
String changeVersion;
}

@Value
public static class PomProperty {
Path filePath;
String name;
String value;
}
}
22 changes: 17 additions & 5 deletions rewrite-maven/src/main/java/org/openrewrite/maven/MavenVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package org.openrewrite.maven;

import org.jetbrains.annotations.Contract;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.SourceFile;
Expand Down Expand Up @@ -281,19 +282,29 @@ private boolean isTag(String name) {
return getCursor().getValue() instanceof Xml.Tag && name.equals(getCursor().<Xml.Tag>getValue().getName());
}

/**
* Updates the value of a given child tag within an XML tag, if the new value differs from the current one.
* <p>
* If the current value of the tag is a property (e.g. {@code ${some.property}}), and the property is defined
* in the same POM, the method updates the property instead of directly modifying the tag value.
* This method does not update properties defined in a parent POM.
*
* @param tag The XML tag that contains the child tag.
* @param childTagName The name of the child tag whose value should be changed.
* @param newValue The new value to assign to the child tag. If {@code null} or equal to the current value,
* no change is made.
* @param p The visitor context.
* @return The potentially updated tag.
*/
protected Xml.Tag changeChildTagValue(Xml.Tag tag, String childTagName, @Nullable String newValue, P p) {
return changeChildTagValue(tag, childTagName, newValue, false, p);
}

protected Xml.Tag changeChildTagValue(Xml.Tag tag, String childTagName, @Nullable String newValue, @Nullable Boolean addPropertyIfMissing, P p) {
Optional<Xml.Tag> childTag = tag.getChild(childTagName);
if (childTag.isPresent()) {
String oldValue = childTag.get().getValue().orElse(null);
if (newValue != null && !newValue.equals(oldValue)) {
if (isProperty(oldValue)) {
String propertyName = oldValue.substring(2, oldValue.length() - 1);
if (getResolutionResult().getPom().getRequested().getProperties().containsKey(propertyName)) {
doAfterVisit((TreeVisitor<?, P>) new ChangePropertyValue(propertyName, newValue, addPropertyIfMissing, false).getVisitor());
doAfterVisit((TreeVisitor<?, P>) new ChangePropertyValue(propertyName, newValue, false, false).getVisitor());
}
} else {
tag = (Xml.Tag) new ChangeTagValueVisitor<>(childTag.get(), newValue).visitNonNull(tag, p);
Expand All @@ -303,6 +314,7 @@ protected Xml.Tag changeChildTagValue(Xml.Tag tag, String childTagName, @Nullabl
return tag;
}

@Contract("null -> false")
protected boolean isProperty(@Nullable String value) {
return value != null && value.startsWith("${") && !IMPLICITLY_DEFINED_VERSION_PROPERTIES.contains(value);
}
Expand Down
Loading