Skip to content

Simplify prefix resolution #11197

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
merged 1 commit into from
Oct 4, 2025
Merged

Simplify prefix resolution #11197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
121 changes: 50 additions & 71 deletions ...re/src/main/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,14 @@
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.maven.artifact.repository.metadata.Metadata;
import org.apache.maven.artifact.repository.metadata.io.MetadataReader;
import org.apache.maven.model.Build;
import org.apache.maven.model.Plugin;
import org.apache.maven.plugin.BuildPluginManager;
import org.apache.maven.plugin.descriptor.PluginDescriptor;
import org.apache.maven.plugin.prefix.NoPluginFoundForPrefixException;
import org.apache.maven.plugin.prefix.PluginPrefixRequest;
import org.apache.maven.plugin.prefix.PluginPrefixResolver;
Expand Down Expand Up @@ -65,9 +64,6 @@ public class DefaultPluginPrefixResolver implements PluginPrefixResolver {
@Requirement
private Logger logger;

@Requirement
private BuildPluginManager pluginManager;

@Requirement
private RepositorySystem repositorySystem;

Expand All @@ -77,76 +73,55 @@ public class DefaultPluginPrefixResolver implements PluginPrefixResolver {
public PluginPrefixResult resolve(PluginPrefixRequest request) throws NoPluginFoundForPrefixException {
logger.debug("Resolving plugin prefix " + request.getPrefix() + " from " + request.getPluginGroups());

PluginPrefixResult result = resolveFromProject(request);

if (result == null) {
result = resolveFromRepository(request);

if (result == null) {
throw new NoPluginFoundForPrefixException(
request.getPrefix(),
request.getPluginGroups(),
request.getRepositorySession().getLocalRepository(),
request.getRepositories());
} else if (logger.isDebugEnabled()) {
logger.debug("Resolved plugin prefix " + request.getPrefix() + " to " + result.getGroupId() + ":"
+ result.getArtifactId() + " from repository "
+ (result.getRepository() != null
? result.getRepository().getId()
: "null"));
// map of groupId -> Set(artifactId) plugin candidates:
// if value is null, keys are coming from settings, and no artifactId filtering is applied
// if value is non-null: we allow only plugins that have enlisted artifactId only
// ---
// end game is: settings enlisted groupIds are obeying order and are "free for all" (artifactId)
// while POM enlisted plugins coming from non-enlisted settings groupIds (ie conflict of prefixes)
// will prevail/win.
LinkedHashMap<String, Set<String>> candidates = new LinkedHashMap<>();
if (request.getPom() != null) {
if (request.getPom().getBuild() != null) {
request.getPom().getBuild().getPlugins().stream()
.filter(p -> !request.getPluginGroups().contains(p.getGroupId()))
.forEach(p -> candidates
.computeIfAbsent(p.getGroupId(), g -> new HashSet<>())
.add(p.getArtifactId()));
if (request.getPom().getBuild().getPluginManagement() != null) {
request.getPom().getBuild().getPluginManagement().getPlugins().stream()
.filter(p -> !request.getPluginGroups().contains(p.getGroupId()))
.forEach(p -> candidates
.computeIfAbsent(p.getGroupId(), g -> new HashSet<>())
.add(p.getArtifactId()));
}
}
} else if (logger.isDebugEnabled()) {
logger.debug("Resolved plugin prefix " + request.getPrefix() + " to " + result.getGroupId() + ":"
+ result.getArtifactId() + " from POM " + request.getPom());
}
request.getPluginGroups().forEach(g -> candidates.put(g, null));
PluginPrefixResult result = resolveFromRepository(request, candidates);

return result;
}

private PluginPrefixResult resolveFromProject(PluginPrefixRequest request) {
PluginPrefixResult result = null;

if (request.getPom() != null && request.getPom().getBuild() != null) {
Build build = request.getPom().getBuild();

result = resolveFromProject(request, build.getPlugins());

if (result == null && build.getPluginManagement() != null) {
result = resolveFromProject(request, build.getPluginManagement().getPlugins());
}
if (result == null) {
throw new NoPluginFoundForPrefixException(
request.getPrefix(),
new ArrayList<>(candidates.keySet()),
request.getRepositorySession().getLocalRepository(),
request.getRepositories());
} else {
logger.debug("Resolved plugin prefix " + request.getPrefix() + " to " + result.getGroupId() + ":"
+ result.getArtifactId() + " from repository "
+ (result.getRepository() != null ? result.getRepository().getId() : "null"));
}

return result;
}

private PluginPrefixResult resolveFromProject(PluginPrefixRequest request, List<Plugin> plugins) {
for (Plugin plugin : plugins) {
try {
PluginDescriptor pluginDescriptor =
pluginManager.loadPlugin(plugin, request.getRepositories(), request.getRepositorySession());

if (request.getPrefix().equals(pluginDescriptor.getGoalPrefix())) {
return new DefaultPluginPrefixResult(plugin);
}
} catch (Exception e) {
if (logger.isDebugEnabled()) {
logger.warn(
"Failed to retrieve plugin descriptor for " + plugin.getId() + ": " + e.getMessage(), e);
} else {
logger.warn("Failed to retrieve plugin descriptor for " + plugin.getId() + ": " + e.getMessage());
}
}
}

return null;
}

private PluginPrefixResult resolveFromRepository(PluginPrefixRequest request) {
private PluginPrefixResult resolveFromRepository(
PluginPrefixRequest request, LinkedHashMap<String, Set<String>> candidates) {
RequestTrace trace = RequestTrace.newChild(null, request);

List<MetadataRequest> requests = new ArrayList<>();

for (String pluginGroup : request.getPluginGroups()) {
for (String pluginGroup : candidates.keySet()) {
org.eclipse.aether.metadata.Metadata metadata =
new DefaultMetadata(pluginGroup, "maven-metadata.xml", DefaultMetadata.Nature.RELEASE_OR_SNAPSHOT);

Expand All @@ -162,7 +137,7 @@ private PluginPrefixResult resolveFromRepository(PluginPrefixRequest request) {
List<MetadataResult> results = repositorySystem.resolveMetadata(request.getRepositorySession(), requests);
requests.clear();

PluginPrefixResult result = processResults(request, trace, results, requests);
PluginPrefixResult result = processResults(request, trace, results, requests, candidates);

if (result != null) {
return result;
Expand All @@ -176,7 +151,7 @@ private PluginPrefixResult resolveFromRepository(PluginPrefixRequest request) {

results = repositorySystem.resolveMetadata(session, requests);

return processResults(request, trace, results, null);
return processResults(request, trace, results, null, candidates);
}

return null;
Expand All @@ -186,7 +161,8 @@ private PluginPrefixResult processResults(
PluginPrefixRequest request,
RequestTrace trace,
List<MetadataResult> results,
List<MetadataRequest> requests) {
List<MetadataRequest> requests,
LinkedHashMap<String, Set<String>> candidates) {
for (MetadataResult res : results) {
org.eclipse.aether.metadata.Metadata metadata = res.getMetadata();

Expand All @@ -197,7 +173,7 @@ private PluginPrefixResult processResults(
}

PluginPrefixResult result =
resolveFromRepository(request, trace, metadata.getGroupId(), metadata, repository);
resolveFromRepository(request, trace, metadata.getGroupId(), metadata, repository, candidates);

if (result != null) {
return result;
Expand All @@ -217,7 +193,8 @@ private PluginPrefixResult resolveFromRepository(
RequestTrace trace,
String pluginGroup,
org.eclipse.aether.metadata.Metadata metadata,
ArtifactRepository repository) {
ArtifactRepository repository,
LinkedHashMap<String, Set<String>> candidates) {
if (metadata != null && metadata.getFile() != null && metadata.getFile().isFile()) {
try {
Map<String, ?> options = Collections.singletonMap(MetadataReader.IS_STRICT, Boolean.FALSE);
Expand All @@ -228,7 +205,9 @@ private PluginPrefixResult resolveFromRepository(

if (plugins != null) {
for (org.apache.maven.artifact.repository.metadata.Plugin plugin : plugins) {
if (request.getPrefix().equals(plugin.getPrefix())) {
if (request.getPrefix().equals(plugin.getPrefix())
&& (candidates.get(pluginGroup) == null
|| candidates.get(pluginGroup).contains(plugin.getArtifactId()))) {
return new DefaultPluginPrefixResult(pluginGroup, plugin.getArtifactId(), repository);
}
}
Expand Down