Skip to content

Bug: Filter fixes #1655

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 14 commits into from
Nov 20, 2025
Merged

Bug: Filter fixes #1655

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
f24c6e9
Bug: fix prefix filter discovery
cstamas Nov 14, 2025
f8666c1
Do not deprecate, is useful, but document it.
cstamas Nov 14, 2025
d392216
Remove method reference, is untrue.
cstamas Nov 14, 2025
f13ad90
Typo
cstamas Nov 14, 2025
2c0cb93
Simplify, tidy up
cstamas Nov 14, 2025
f88dcd2
Merge remote-tracking branch 'upstream/master' into fix-prefix-filter
cstamas Nov 14, 2025
2f47e80
Adjust groupId too for skip
cstamas Nov 17, 2025
71e290b
Update doco
cstamas Nov 17, 2025
cc657dd
Normalize reposes
cstamas Nov 17, 2025
f3303f5
Add more config
cstamas Nov 17, 2025
2726c72
More and TODO
cstamas Nov 17, 2025
7eae084
Normalize in both
cstamas Nov 17, 2025
490b1ca
Work out the TODO
cstamas Nov 19, 2025
353751b
Add more detailed javadoc
cstamas Nov 20, 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
4 changes: 3 additions & 1 deletion ...in/java/org/eclipse/aether/internal/impl/filter/DefaultRemoteRepositoryFilterManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@ public DefaultRemoteRepositoryFilterManager(Map<String, RemoteRepositoryFilterSo

@Override
public RemoteRepositoryFilter getRemoteRepositoryFilter(RepositorySystemSession session) {
return (RemoteRepositoryFilter) session.getData().computeIfAbsent(INSTANCE_KEY, () -> {
// use session specific key to distinguish between "derived" sessions
String instanceSpecificKey = INSTANCE_KEY + "." + session.hashCode();
return (RemoteRepositoryFilter) session.getData().computeIfAbsent(instanceSpecificKey, () -> {
HashMap<String, RemoteRepositoryFilter> filters = new HashMap<>();
for (Map.Entry<String, RemoteRepositoryFilterSource> entry : sources.entrySet()) {
RemoteRepositoryFilter filter = entry.getValue().getRemoteRepositoryFilter(session);
Expand Down
40 changes: 32 additions & 8 deletions ...ain/java/org/eclipse/aether/internal/impl/filter/GroupIdRemoteRepositoryFilterSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,21 @@ public final class GroupIdRemoteRepositoryFilterSource extends RemoteRepositoryF

public static final boolean DEFAULT_ENABLED = true;

/**
* Configuration to skip the GroupId filter for given request. This configuration is evaluated and if {@code true}
* the GroupId remote filter will not kick in.
*
* @since 2.0.14
* @configurationSource {@link RepositorySystemSession#getConfigProperties()}
* @configurationType {@link java.lang.Boolean}
* @configurationRepoIdSuffix Yes
* @configurationDefaultValue {@link #DEFAULT_SKIPPED}
*/
public static final String CONFIG_PROP_SKIPPED =
RemoteRepositoryFilterSourceSupport.CONFIG_PROPS_PREFIX + NAME + ".skipped";

public static final boolean DEFAULT_SKIPPED = false;

/**
* The basedir where to store filter files. If path is relative, it is resolved from local repository root.
*
Expand Down Expand Up @@ -160,15 +175,22 @@ public GroupIdRemoteRepositoryFilterSource(

@Override
protected boolean isEnabled(RepositorySystemSession session) {
return ConfigUtils.getBoolean(session, DEFAULT_ENABLED, CONFIG_PROP_ENABLED);
return ConfigUtils.getBoolean(session, DEFAULT_ENABLED, CONFIG_PROP_ENABLED)
&& !ConfigUtils.getBoolean(session, DEFAULT_SKIPPED, CONFIG_PROP_SKIPPED);
}

private boolean isRepositoryFilteringEnabled(RepositorySystemSession session, RemoteRepository remoteRepository) {
if (isEnabled(session)) {
return ConfigUtils.getBoolean(
session,
ConfigUtils.getBoolean(session, true, CONFIG_PROP_ENABLED + ".*"),
CONFIG_PROP_ENABLED + "." + remoteRepository.getId());
session,
DEFAULT_ENABLED,
CONFIG_PROP_ENABLED + "." + remoteRepository.getId(),
CONFIG_PROP_ENABLED + ".*")
&& !ConfigUtils.getBoolean(
session,
DEFAULT_SKIPPED,
CONFIG_PROP_SKIPPED + "." + remoteRepository.getId(),
CONFIG_PROP_SKIPPED + ".*");
}
return false;
}
Expand All @@ -193,10 +215,11 @@ public void postProcess(RepositorySystemSession session, List<ArtifactResult> ar
if (isRepositoryFilteringEnabled(session, remoteRepository)) {
ruleFile(session, remoteRepository); // populate it; needed for save
String line = "=" + artifactResult.getArtifact().getGroupId();
RemoteRepository normalized = normalizeRemoteRepository(session, remoteRepository);
recordedRules
.computeIfAbsent(remoteRepository, k -> new TreeSet<>())
.computeIfAbsent(normalized, k -> new TreeSet<>())
.add(line);
rules.compute(remoteRepository, (k, v) -> {
rules.compute(normalized, (k, v) -> {
if (v == null || v == GroupTree.SENTINEL) {
v = new GroupTree("");
}
Expand All @@ -210,15 +233,16 @@ public void postProcess(RepositorySystemSession session, List<ArtifactResult> ar
}

private Path ruleFile(RepositorySystemSession session, RemoteRepository remoteRepository) {
return ruleFiles.computeIfAbsent(remoteRepository, r -> getBasedir(
return ruleFiles.computeIfAbsent(normalizeRemoteRepository(session, remoteRepository), r -> getBasedir(
session, LOCAL_REPO_PREFIX_DIR, CONFIG_PROP_BASEDIR, false)
.resolve(GROUP_ID_FILE_PREFIX
+ RepositoryIdHelper.cachedIdToPathSegment(session).apply(remoteRepository)
+ GROUP_ID_FILE_SUFFIX));
}

private GroupTree cacheRules(RepositorySystemSession session, RemoteRepository remoteRepository) {
return rules.computeIfAbsent(remoteRepository, r -> loadRepositoryRules(session, r));
return rules.computeIfAbsent(
normalizeRemoteRepository(session, remoteRepository), r -> loadRepositoryRules(session, r));
}

private GroupTree loadRepositoryRules(RepositorySystemSession session, RemoteRepository remoteRepository) {
Expand Down
145 changes: 83 additions & 62 deletions ...in/java/org/eclipse/aether/internal/impl/filter/PrefixesRemoteRepositoryFilterSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Collections;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Supplier;

Expand Down Expand Up @@ -106,9 +105,7 @@ public final class PrefixesRemoteRepositoryFilterSource extends RemoteRepository
* <strong>Initial setup:</strong> Don't provide any files - rely on auto-discovery as repositories are accessed.
* <strong>Override when needed:</strong> Create {@code prefixes-myrepoId.txt} files in {@code .mvn/rrf/} and
* commit to version control.
* <strong>Caching:</strong> Auto-discovered prefix files are cached in the local repository with unique IDs
* (using {@link RepositoryIdHelper#remoteRepositoryUniqueId(RemoteRepository)}) to prevent conflicts that
* could cause build failures.
* <strong>Caching:</strong> Auto-discovered prefix files are cached in the local repository.
*
* @configurationSource {@link RepositorySystemSession#getConfigProperties()}
* @configurationType {@link java.lang.Boolean}
Expand All @@ -119,6 +116,40 @@ public final class PrefixesRemoteRepositoryFilterSource extends RemoteRepository

public static final boolean DEFAULT_ENABLED = true;

/**
* Configuration to skip the Prefixes filter for given request. This configuration is evaluated and if {@code true}
* the prefixes remote filter will not kick in. Main use case is by filter itself, to prevent recursion during
* discovery of remote prefixes file, but this also allows other components to control prefix filter discovery, while
* leaving configuration like {@link #CONFIG_PROP_ENABLED} still show the "real state".
*
* @since 2.0.14
* @configurationSource {@link RepositorySystemSession#getConfigProperties()}
* @configurationType {@link java.lang.Boolean}
* @configurationRepoIdSuffix Yes
* @configurationDefaultValue {@link #DEFAULT_SKIPPED}
*/
public static final String CONFIG_PROP_SKIPPED =
RemoteRepositoryFilterSourceSupport.CONFIG_PROPS_PREFIX + NAME + ".skipped";

public static final boolean DEFAULT_SKIPPED = false;

/**
* Configuration to allow Prefixes filter to auto-discover prefixes from mirrored repositories as well. For this to
* work <em>Maven should be aware</em> that given remote repository is mirror and is usually backed by MRM. Given
* multiple MRM implementations messes up prefixes file, is better to just skip these. In other case, one may use
* {@link #CONFIG_PROP_ENABLED} with repository ID suffix.
*
* @since 2.0.14
* @configurationSource {@link RepositorySystemSession#getConfigProperties()}
* @configurationType {@link java.lang.Boolean}
* @configurationRepoIdSuffix Yes
* @configurationDefaultValue {@link #DEFAULT_USE_MIRRORED_REPOSITORIES}
*/
public static final String CONFIG_PROP_USE_MIRRORED_REPOSITORIES =
RemoteRepositoryFilterSourceSupport.CONFIG_PROPS_PREFIX + NAME + ".useMirroredRepositories";

public static final boolean DEFAULT_USE_MIRRORED_REPOSITORIES = false;

/**
* The basedir where to store filter files. If path is relative, it is resolved from local repository root.
*
Expand Down Expand Up @@ -146,8 +177,6 @@ public final class PrefixesRemoteRepositoryFilterSource extends RemoteRepository

private final ConcurrentHashMap<RemoteRepository, RepositoryLayout> layouts;

private final ConcurrentHashMap<RemoteRepository, Boolean> ongoingUpdates;

@Inject
public PrefixesRemoteRepositoryFilterSource(
Supplier<MetadataResolver> metadataResolver,
Expand All @@ -158,20 +187,26 @@ public PrefixesRemoteRepositoryFilterSource(
this.repositoryLayoutProvider = requireNonNull(repositoryLayoutProvider);
this.prefixes = new ConcurrentHashMap<>();
this.layouts = new ConcurrentHashMap<>();
this.ongoingUpdates = new ConcurrentHashMap<>();
}

@Override
protected boolean isEnabled(RepositorySystemSession session) {
return ConfigUtils.getBoolean(session, DEFAULT_ENABLED, CONFIG_PROP_ENABLED);
return ConfigUtils.getBoolean(session, DEFAULT_ENABLED, CONFIG_PROP_ENABLED)
&& !ConfigUtils.getBoolean(session, DEFAULT_SKIPPED, CONFIG_PROP_SKIPPED);
}

private boolean isRepositoryFilteringEnabled(RepositorySystemSession session, RemoteRepository remoteRepository) {
if (isEnabled(session)) {
return ConfigUtils.getBoolean(
session,
ConfigUtils.getBoolean(session, true, CONFIG_PROP_ENABLED + ".*"),
CONFIG_PROP_ENABLED + "." + remoteRepository.getId());
session,
DEFAULT_ENABLED,
CONFIG_PROP_ENABLED + "." + remoteRepository.getId(),
CONFIG_PROP_ENABLED + ".*")
&& !ConfigUtils.getBoolean(
session,
DEFAULT_SKIPPED,
CONFIG_PROP_SKIPPED + "." + remoteRepository.getId(),
CONFIG_PROP_SKIPPED + ".*");
}
return false;
}
Expand All @@ -190,7 +225,7 @@ public RemoteRepositoryFilter getRemoteRepositoryFilter(RepositorySystemSession
* @return the layout instance of {@code null} if layout not supported.
*/
private RepositoryLayout cacheLayout(RepositorySystemSession session, RemoteRepository remoteRepository) {
return layouts.computeIfAbsent(remoteRepository, r -> {
return layouts.computeIfAbsent(normalizeRemoteRepository(session, remoteRepository), r -> {
try {
return repositoryLayoutProvider.newRepositoryLayout(session, remoteRepository);
} catch (NoRepositoryLayoutException e) {
Expand All @@ -201,22 +236,9 @@ private RepositoryLayout cacheLayout(RepositorySystemSession session, RemoteRepo

private PrefixTree cachePrefixTree(
RepositorySystemSession session, Path basedir, RemoteRepository remoteRepository) {
return ongoingUpdatesGuard(
remoteRepository,
() -> prefixes.computeIfAbsent(
remoteRepository, r -> loadPrefixTree(session, basedir, remoteRepository)),
() -> PrefixTree.SENTINEL);
}

private <T> T ongoingUpdatesGuard(RemoteRepository remoteRepository, Supplier<T> unblocked, Supplier<T> blocked) {
if (!remoteRepository.isBlocked() && null == ongoingUpdates.putIfAbsent(remoteRepository, Boolean.TRUE)) {
try {
return unblocked.get();
} finally {
ongoingUpdates.remove(remoteRepository);
}
}
return blocked.get();
return prefixes.computeIfAbsent(
normalizeRemoteRepository(session, remoteRepository),
r -> loadPrefixTree(session, basedir, remoteRepository));
}

private PrefixTree loadPrefixTree(
Expand All @@ -225,8 +247,12 @@ private PrefixTree loadPrefixTree(
String origin = "user-provided";
Path filePath = resolvePrefixesFromLocalConfiguration(session, baseDir, remoteRepository);
if (filePath == null) {
origin = "auto-discovered";
filePath = resolvePrefixesFromRemoteRepository(session, remoteRepository);
if (!supportedResolvePrefixesForRemoteRepository(session, remoteRepository)) {
origin = "unsupported";
} else {
origin = "auto-discovered";
filePath = resolvePrefixesFromRemoteRepository(session, remoteRepository);
}
}
if (filePath != null) {
PrefixesSource prefixesSource = PrefixesSource.of(remoteRepository, filePath);
Expand Down Expand Up @@ -273,6 +299,14 @@ private Path resolvePrefixesFromLocalConfiguration(
}
}

private boolean supportedResolvePrefixesForRemoteRepository(
RepositorySystemSession session, RemoteRepository remoteRepository) {
// TODO: RemoteRepository.isRepositoryManager() is still unused in Maven; once used, factor it in
Copy link
Contributor

@gnodet gnodet Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be a good idea to create an issue in Maven and reference it here, so that we can track more easily in the future.

Copy link
Member Author

@cstamas cstamas Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, let me work thru this: despite nothing sets this RemoteRepository property, it is queried regularly in resolver codebase.

return remoteRepository.getMirroredRepositories().isEmpty()
|| ConfigUtils.getBoolean(
session, DEFAULT_USE_MIRRORED_REPOSITORIES, CONFIG_PROP_USE_MIRRORED_REPOSITORIES);
}

private Path resolvePrefixesFromRemoteRepository(
RepositorySystemSession session, RemoteRepository remoteRepository) {
MetadataResolver mr = metadataResolver.get();
Expand All @@ -282,35 +316,22 @@ private Path resolvePrefixesFromRemoteRepository(
RemoteRepository prepared = rm.aggregateRepositories(
session, Collections.emptyList(), Collections.singletonList(remoteRepository), true)
.get(0);
// make it unique
RemoteRepository unique = new RemoteRepository.Builder(prepared)
.setId(RepositoryIdHelper.remoteRepositoryUniqueId(remoteRepository))
.build();
// supplier for path
Supplier<Path> supplier = () -> {
MetadataRequest request =
new MetadataRequest(new DefaultMetadata(PREFIX_FILE_PATH, Metadata.Nature.RELEASE_OR_SNAPSHOT));
// use unique repository; this will result in prefix (repository metadata) cached under unique id
request.setRepository(unique);
request.setDeleteLocalCopyIfMissing(true);
request.setFavorLocalRepository(true);
MetadataResult result = mr.resolveMetadata(
new DefaultRepositorySystemSession(session).setTransferListener(null),
Collections.singleton(request))
.get(0);
if (result.isResolved()) {
return result.getMetadata().getPath();
} else {
return null;
}
};

// prevent recursive calls; but we need extra work if not dealing with Central (as in that case outer call
// shields us)
if (Objects.equals(prepared.getId(), unique.getId())) {
return supplier.get();
// retrieve prefix as metadata from repository
MetadataRequest request =
new MetadataRequest(new DefaultMetadata(PREFIX_FILE_PATH, Metadata.Nature.RELEASE_OR_SNAPSHOT));
request.setRepository(prepared);
request.setDeleteLocalCopyIfMissing(true);
request.setFavorLocalRepository(true);
MetadataResult result = mr.resolveMetadata(
new DefaultRepositorySystemSession(session)
.setTransferListener(null)
.setConfigProperty(CONFIG_PROP_SKIPPED, Boolean.TRUE.toString()),
Collections.singleton(request))
.get(0);
if (result.isResolved()) {
return result.getMetadata().getPath();
} else {
return ongoingUpdatesGuard(unique, supplier, () -> null);
return null;
}
}
return null;
Expand Down Expand Up @@ -347,15 +368,15 @@ public Result acceptMetadata(RemoteRepository remoteRepository, Metadata metadat
repositoryLayout.getLocation(metadata, false).getPath());
}

private Result acceptPrefix(RemoteRepository remoteRepository, String path) {
PrefixTree prefixTree = cachePrefixTree(session, basedir, remoteRepository);
private Result acceptPrefix(RemoteRepository repository, String path) {
PrefixTree prefixTree = cachePrefixTree(session, basedir, repository);
if (PrefixTree.SENTINEL == prefixTree) {
return NOT_PRESENT_RESULT;
}
if (prefixTree.acceptedPath(path)) {
return new SimpleResult(true, "Path " + path + " allowed from " + remoteRepository);
return new SimpleResult(true, "Path " + path + " allowed from " + repository);
} else {
return new SimpleResult(false, "Prefix " + path + " NOT allowed from " + remoteRepository);
return new SimpleResult(false, "Path " + path + " NOT allowed from " + repository);
}
}
}
Expand Down
18 changes: 18 additions & 0 deletions ...ain/java/org/eclipse/aether/internal/impl/filter/RemoteRepositoryFilterSourceSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Path;
import java.util.List;

import org.eclipse.aether.ConfigurationProperties;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilter;
import org.eclipse.aether.spi.connector.filter.RemoteRepositoryFilterSource;
import org.eclipse.aether.util.DirectoryUtils;
Expand Down Expand Up @@ -76,6 +78,22 @@ protected Path getBasedir(
}
}

/**
* We use remote repositories as keys, but they may fly in as "bare" or as "equipped" (w/ auth and proxy) if caller
* used {@link org.eclipse.aether.RepositorySystem#newResolutionRepositories(RepositorySystemSession, List)} beforehand.
* The hash/equalTo method factors in all these as well, but from our perspective, they do not matter. So we make all
* key remote repositories back to "bare".
*/
protected RemoteRepository normalizeRemoteRepository(
RepositorySystemSession session, RemoteRepository remoteRepository) {
return new RemoteRepository.Builder(remoteRepository)
.setProxy(null)
.setAuthentication(null)
.setMirroredRepositories(null)
.setRepositoryManager(false)
.build();
}

/**
* Simple {@link RemoteRepositoryFilter.Result} immutable implementation.
*/
Expand Down
Loading