This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch maven-4.0.x
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/maven-4.0.x by this push:
new 3c54525a7e [Backport maven-4.0.x] #11072: Simplify prefix resolution
(#14027)
3c54525a7e is described below
commit 3c54525a7e14066cd14a35fcee7676ae7dc963e1
Author: Guillaume Nodet <[email protected]>
AuthorDate: Mon Nov 16 23:07:51 2026 +0100
[Backport maven-4.0.x] #11072: Simplify prefix resolution (#14027)
* [Backport maven-4.0.x] #11072: Simplify prefix resolution
Simplify prefix resolution and drop use of BuildPluginManager
(as descriptor will be re-resolved again later) and focus only
on prefix to GA resolution, using a map of rules:
- collect POM enlisted plugin groupId:artifactId pairs that come
from non-settings-enlisted groupIDs (and allow only enlisted
artifactIDs)
- add settings enlisted plugin groupIds (keep their order) but
"allow any" artifactId
Using this map, figure out plugin GA from prefix using Maven
metadata only.
Conflict resolution: merged with 4.0.x's evolved candidates-map
approach (Stream.collect/groupingBy → computeIfAbsent forEach)
and removed the 4.0.x-specific resolveFromProject/doResolveFromProject
phase, adopting master's simpler metadata-only resolution path.
Cherry-picked from 2b7bb9c6fdb7b4bedc9b1c0581c70dc5b5a19671
* Remove DefaultPluginPrefixResolverTest obsoleted by prefix resolution
simplification
The test was exercising the BuildPluginManager/PluginVersionResolver
fast-path
that was removed when simplifying prefix resolution in backport of #11072.
The simplified resolver only uses repository metadata and no longer has an
in-memory fast-path based on loading plugin descriptors.
---------
Co-authored-by: Tamas Cservenak <[email protected]>
---
.../internal/DefaultPluginPrefixResolver.java | 116 ++++---------------
.../internal/DefaultPluginPrefixResolverTest.java | 123 ---------------------
2 files changed, 20 insertions(+), 219 deletions(-)
diff --git
a/impl/maven-core/src/main/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolver.java
b/impl/maven-core/src/main/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolver.java
index e2391d4164..3c2cff77c3 100644
---
a/impl/maven-core/src/main/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolver.java
+++
b/impl/maven-core/src/main/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolver.java
@@ -25,30 +25,19 @@
import java.io.IOException;
import java.nio.file.Files;
import java.util.ArrayList;
-import java.util.Collection;
import java.util.Collections;
+import java.util.HashSet;
import java.util.LinkedHashMap;
-import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
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.Model;
-import org.apache.maven.model.Plugin;
-import org.apache.maven.model.PluginManagement;
-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;
import org.apache.maven.plugin.prefix.PluginPrefixResult;
-import org.apache.maven.plugin.version.DefaultPluginVersionRequest;
-import org.apache.maven.plugin.version.PluginVersionResolver;
import org.eclipse.aether.DefaultRepositorySystemSession;
import org.eclipse.aether.RepositoryEvent;
import org.eclipse.aether.RepositoryEvent.EventType;
@@ -76,31 +65,19 @@ public class DefaultPluginPrefixResolver implements
PluginPrefixResolver {
private static final String REPOSITORY_CONTEXT =
org.apache.maven.api.services.RequestTrace.CONTEXT_PLUGIN;
private final Logger logger = LoggerFactory.getLogger(getClass());
- private final BuildPluginManager pluginManager;
private final RepositorySystem repositorySystem;
private final MetadataReader metadataReader;
- private final PluginVersionResolver pluginVersionResolver;
@Inject
- public DefaultPluginPrefixResolver(
- BuildPluginManager pluginManager,
- RepositorySystem repositorySystem,
- MetadataReader metadataReader,
- PluginVersionResolver pluginVersionResolver) {
- this.pluginManager = pluginManager;
+ public DefaultPluginPrefixResolver(RepositorySystem repositorySystem,
MetadataReader metadataReader) {
this.repositorySystem = repositorySystem;
this.metadataReader = metadataReader;
- this.pluginVersionResolver = pluginVersionResolver;
}
@Override
public PluginPrefixResult resolve(PluginPrefixRequest request) throws
NoPluginFoundForPrefixException {
logger.debug("Resolving plugin prefix {} from {}",
request.getPrefix(), request.getPluginGroups());
- Model pom = request.getPom();
- Build build = pom != null ? pom.getBuild() : null;
- PluginManagement management = build != null ?
build.getPluginManagement() : 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
@@ -108,29 +85,25 @@ public PluginPrefixResult resolve(PluginPrefixRequest
request) throws NoPluginFo
// 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 = Stream.of(build,
management)
- .flatMap(container -> container != null ?
container.getPlugins().stream() : Stream.empty())
- .filter(p ->
!request.getPluginGroups().contains(p.getGroupId()))
- .collect(Collectors.groupingBy(
- Plugin::getGroupId,
- LinkedHashMap::new,
- Collectors.mapping(Plugin::getArtifactId,
Collectors.toSet())));
- request.getPluginGroups().forEach(g -> candidates.put(g, null));
- PluginPrefixResult result = null;
- // First, we go through all declared plugins, load them
- // one by one, and try to find a matching prefix.
- if (build != null) {
- result = resolveFromProject(
- request,
- build.getPlugins(),
- management != null ? management.getPlugins() :
Collections.emptyList());
- }
-
- // Second, we use G level metadata to discover prefix
- // This order allows user managed clashing prefixes (they can declare
them in POM)
- if (result == null) {
- result = resolveFromRepository(request, candidates);
+ 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()));
+ }
+ }
}
+ request.getPluginGroups().forEach(g -> candidates.put(g, null));
+ PluginPrefixResult result = resolveFromRepository(request, candidates);
if (result == null) {
throw new NoPluginFoundForPrefixException(
@@ -150,55 +123,6 @@ public PluginPrefixResult resolve(PluginPrefixRequest
request) throws NoPluginFo
return result;
}
- private PluginPrefixResult resolveFromProject(
- PluginPrefixRequest request, List<Plugin> plugins, List<Plugin>
pluginMgmt) {
- if (plugins.isEmpty() && pluginMgmt.isEmpty()) {
- return null;
- }
- PluginPrefixResult result = null;
- Set<Plugin> candidates = new LinkedHashSet<>();
- Stream.concat(plugins.stream(), pluginMgmt.stream())
- .filter(p -> p.getArtifactId().contains(request.getPrefix()))
- .forEach(candidates::add);
- if (!candidates.isEmpty()) {
- result = doResolveFromProject(request, candidates);
- }
- if (result == null) {
- Set<Plugin> remainder = new LinkedHashSet<>(plugins);
- remainder.removeAll(candidates);
- result = doResolveFromProject(request, remainder);
- }
- return result;
- }
-
- private PluginPrefixResult doResolveFromProject(PluginPrefixRequest
request, Collection<Plugin> plugins) {
- for (Plugin plugin : plugins) {
- try {
- if (plugin.getVersion() == null) {
- DefaultPluginVersionRequest versionRequest = new
DefaultPluginVersionRequest(
- plugin, request.getRepositorySession(),
request.getRepositories())
- .setPom(request.getPom());
- plugin.setVersion(
-
pluginVersionResolver.resolve(versionRequest).getVersion());
- }
- 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, LinkedHashMap<String, Set<String>>
candidates) {
RequestTrace trace = RequestTrace.newChild(null, request);
diff --git
a/impl/maven-core/src/test/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolverTest.java
b/impl/maven-core/src/test/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolverTest.java
deleted file mode 100644
index b4f3aedabb..0000000000
---
a/impl/maven-core/src/test/java/org/apache/maven/plugin/prefix/internal/DefaultPluginPrefixResolverTest.java
+++ /dev/null
@@ -1,123 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * 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.apache.maven.plugin.prefix.internal;
-
-import java.util.List;
-
-import org.apache.maven.artifact.repository.metadata.io.MetadataReader;
-import org.apache.maven.model.Build;
-import org.apache.maven.model.Model;
-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.DefaultPluginPrefixRequest;
-import org.apache.maven.plugin.prefix.PluginPrefixResult;
-import org.apache.maven.plugin.version.PluginVersionResolver;
-import org.apache.maven.plugin.version.PluginVersionResult;
-import org.eclipse.aether.RepositorySystem;
-import org.eclipse.aether.RepositorySystemSession;
-import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
-import org.mockito.Mock;
-import org.mockito.junit.jupiter.MockitoExtension;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.argThat;
-import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.Mockito.never;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.verifyNoInteractions;
-import static org.mockito.Mockito.when;
-
-@ExtendWith(MockitoExtension.class)
-class DefaultPluginPrefixResolverTest {
- @Mock
- private BuildPluginManager pluginManager;
-
- @Mock
- private RepositorySystem repositorySystem;
-
- @Mock
- private MetadataReader metadataReader;
-
- @Mock
- private PluginVersionResolver pluginVersionResolver;
-
- @Mock
- private RepositorySystemSession repositorySession;
-
- @Mock
- private PluginVersionResult pluginVersionResult;
-
- @Test
- void resolvesVersionOnlyForMatchingProjectPlugin() throws Exception {
- Plugin matchingPlugin = plugin("com.example", "custom-maven-plugin");
- Plugin unrelatedPlugin = plugin("org.apache.maven.plugins",
"maven-release-plugin");
-
- Build build = new Build();
- build.setPlugins(List.of(unrelatedPlugin, matchingPlugin));
- Model model = new Model();
- model.setBuild(build);
-
- when(pluginVersionResult.getVersion()).thenReturn("1.0");
-
when(pluginVersionResolver.resolve(any())).thenReturn(pluginVersionResult);
-
- PluginDescriptor descriptor = new PluginDescriptor();
- descriptor.setGroupId(matchingPlugin.getGroupId());
- descriptor.setArtifactId(matchingPlugin.getArtifactId());
- descriptor.setVersion("1.0");
- descriptor.setGoalPrefix("custom");
- when(pluginManager.loadPlugin(
- argThat(plugin ->
matchingPlugin.getArtifactId().equals(plugin.getArtifactId())
- && "1.0".equals(plugin.getVersion())),
- eq(List.of()),
- eq(repositorySession)))
- .thenReturn(descriptor);
-
- DefaultPluginPrefixResolver resolver =
- new DefaultPluginPrefixResolver(pluginManager,
repositorySystem, metadataReader, pluginVersionResolver);
- PluginPrefixResult result = resolver.resolve(new
DefaultPluginPrefixRequest()
- .setPrefix("custom")
- .setPom(model)
- .setRepositorySession(repositorySession));
-
- assertEquals(matchingPlugin.getGroupId(), result.getGroupId());
- assertEquals(matchingPlugin.getArtifactId(), result.getArtifactId());
-
- verify(pluginVersionResolver)
- .resolve(argThat(request ->
-
matchingPlugin.getArtifactId().equals(request.getArtifactId()) &&
request.getPom() == model));
- verify(pluginVersionResolver, never())
- .resolve(argThat(request ->
unrelatedPlugin.getArtifactId().equals(request.getArtifactId())));
- verify(pluginManager, never())
- .loadPlugin(
- argThat(plugin ->
unrelatedPlugin.getArtifactId().equals(plugin.getArtifactId())),
- any(),
- eq(repositorySession));
- verifyNoInteractions(repositorySystem);
- }
-
- private Plugin plugin(String groupId, String artifactId) {
- Plugin plugin = new Plugin();
- plugin.setGroupId(groupId);
- plugin.setArtifactId(artifactId);
- return plugin;
- }
-}