Skip to content

Commit

Permalink
[MNG-8540] Replace ModelCache with the new cache API
Browse files Browse the repository at this point in the history
  • Loading branch information
@gnodet
gnodet committed Feb 5, 2025
1 parent e091d55 commit cb1b1e0
Show file tree
Hide file tree
Showing 6 changed files with 145 additions and 277 deletions.
8 changes: 0 additions & 8 deletions impl/maven-core/src/test/java/org/apache/maven/project/DefaultMavenProjectBuilderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@
import java.nio.file.StandardCopyOption;
import java.util.List;

import org.apache.maven.api.SessionData;
import org.apache.maven.api.services.model.ModelCache;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.impl.InternalSession;
Expand Down Expand Up @@ -338,12 +336,6 @@ void rereadPom_mng7063() throws Exception {
projectBuilder.build(pom.toFile(), buildingRequest).getProject();
assertThat(project.getName(), is("aid")); // inherited from artifactId

// clear the cache
InternalSession.from(buildingRequest.getRepositorySession())
.getData()
.get(SessionData.key(ModelCache.class))
.clear();

try (InputStream pomResource =
DefaultMavenProjectBuilderTest.class.getResourceAsStream("/projects/reread/pom2.xml")) {
Files.copy(pomResource, pom, StandardCopyOption.REPLACE_EXISTING);
Expand Down
8 changes: 0 additions & 8 deletions impl/maven-core/src/test/java/org/apache/maven/project/ProjectBuilderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
import java.util.concurrent.atomic.AtomicInteger;

import org.apache.maven.AbstractCoreMavenComponentTestCase;
import org.apache.maven.api.SessionData;
import org.apache.maven.api.services.model.ModelCache;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.InputLocation;
Expand Down Expand Up @@ -179,12 +177,6 @@ void testReadModifiedPoms(@TempDir Path tempDir) throws Exception {
File child = new File(tempDir.toFile(), "child/pom.xml");
// build project once
projectBuilder.build(child, configuration);
// clear the cache
mavenSession
.getSession()
.getData()
.get(SessionData.key(ModelCache.class))
.clear();
// modify parent
File parent = new File(tempDir.toFile(), "pom.xml");
String parentContent = new String(Files.readAllBytes(parent.toPath()), StandardCharsets.UTF_8);
Expand Down
40 changes: 0 additions & 40 deletions impl/maven-impl/src/main/java/org/apache/maven/api/services/model/ModelCacheFactory.java
View file

This file was deleted.

171 changes: 145 additions & 26 deletions impl/maven-impl/src/main/java/org/apache/maven/impl/model/DefaultModelBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,12 @@
import org.apache.maven.api.Constants;
import org.apache.maven.api.RemoteRepository;
import org.apache.maven.api.Session;
import org.apache.maven.api.SessionData;
import org.apache.maven.api.Type;
import org.apache.maven.api.VersionRange;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.api.annotations.Nullable;
import org.apache.maven.api.cache.CacheMetadata;
import org.apache.maven.api.cache.CacheRetention;
import org.apache.maven.api.di.Inject;
import org.apache.maven.api.di.Named;
import org.apache.maven.api.di.Singleton;
Expand Down Expand Up @@ -81,16 +84,16 @@
import org.apache.maven.api.services.ModelSource;
import org.apache.maven.api.services.ProblemCollector;
import org.apache.maven.api.services.RepositoryFactory;
import org.apache.maven.api.services.Request;
import org.apache.maven.api.services.RequestTrace;
import org.apache.maven.api.services.Result;
import org.apache.maven.api.services.Source;
import org.apache.maven.api.services.Sources;
import org.apache.maven.api.services.SuperPomProvider;
import org.apache.maven.api.services.VersionParserException;
import org.apache.maven.api.services.model.DependencyManagementImporter;
import org.apache.maven.api.services.model.DependencyManagementInjector;
import org.apache.maven.api.services.model.InheritanceAssembler;
import org.apache.maven.api.services.model.ModelCache;
import org.apache.maven.api.services.model.ModelCacheFactory;
import org.apache.maven.api.services.model.ModelInterpolator;
import org.apache.maven.api.services.model.ModelNormalizer;
import org.apache.maven.api.services.model.ModelPathTranslator;
Expand Down Expand Up @@ -151,7 +154,6 @@ public class DefaultModelBuilder implements ModelBuilder {
private final PluginConfigurationExpander pluginConfigurationExpander;
private final ModelVersionParser versionParser;
private final List<ModelTransformer> transformers;
private final ModelCacheFactory modelCacheFactory;
private final ModelResolver modelResolver;
private final Interpolator interpolator;
private final PathTranslator pathTranslator;
Expand All @@ -176,7 +178,6 @@ public DefaultModelBuilder(
PluginConfigurationExpander pluginConfigurationExpander,
ModelVersionParser versionParser,
List<ModelTransformer> transformers,
ModelCacheFactory modelCacheFactory,
ModelResolver modelResolver,
Interpolator interpolator,
PathTranslator pathTranslator,
Expand All @@ -197,7 +198,6 @@ public DefaultModelBuilder(
this.pluginConfigurationExpander = pluginConfigurationExpander;
this.versionParser = versionParser;
this.transformers = transformers;
this.modelCacheFactory = modelCacheFactory;
this.modelResolver = modelResolver;
this.interpolator = interpolator;
this.pathTranslator = pathTranslator;
Expand Down Expand Up @@ -253,7 +253,6 @@ protected class ModelBuilderSessionState implements ModelProblemCollector {
final Session session;
final ModelBuilderRequest request;
final DefaultModelBuilderResult result;
final ModelCache cache;
final Graph dag;
final Map<GAKey, Set<ModelSource>> mappedSources;

Expand All @@ -270,9 +269,6 @@ protected class ModelBuilderSessionState implements ModelProblemCollector {
request.getSession(),
request,
new DefaultModelBuilderResult(request, ProblemCollector.create(request.getSession())),
request.getSession()
.getData()
.computeIfAbsent(SessionData.key(ModelCache.class), modelCacheFactory::newInstance),
new Graph(),
new ConcurrentHashMap<>(64),
List.of(),
Expand All @@ -292,7 +288,6 @@ private ModelBuilderSessionState(
Session session,
ModelBuilderRequest request,
DefaultModelBuilderResult result,
ModelCache cache,
Graph dag,
Map<GAKey, Set<ModelSource>> mappedSources,
List<RemoteRepository> pomRepositories,
Expand All @@ -301,7 +296,6 @@ private ModelBuilderSessionState(
this.session = session;
this.request = request;
this.result = result;
this.cache = cache;
this.dag = dag;
this.mappedSources = mappedSources;
this.pomRepositories = pomRepositories;
Expand Down Expand Up @@ -330,24 +324,15 @@ ModelBuilderSessionState derive(ModelBuilderRequest request, DefaultModelBuilder
throw new IllegalArgumentException("Session mismatch");
}
return new ModelBuilderSessionState(
session,
request,
result,
cache,
dag,
mappedSources,
pomRepositories,
externalRepositories,
repositories);
session, request, result, dag, mappedSources, pomRepositories, externalRepositories, repositories);
}

@Override
public String toString() {
return "ModelBuilderSession[" + "session="
+ session + ", " + "request="
+ request + ", " + "result="
+ result + ", " + "cache="
+ cache + ']';
+ result + ']';
}

PhasingExecutor createExecutor() {
Expand Down Expand Up @@ -707,7 +692,6 @@ private void loadFromRoot(Path root, Path top) {
+ "build, the top project will be used as the root project.",
top,
root);
cache.clear();
mappedSources.clear();
loadFromRoot(top, top);
}
Expand Down Expand Up @@ -1787,6 +1771,124 @@ ModelSource resolveReactorModel(String groupId, String artifactId, String versio
return null;
}

record RgavCacheKey(
Session session,
RequestTrace trace,
List<RemoteRepository> repositories,
String groupId,
String artifactId,
String version,
String classifier,
String tag)
implements Request<Session> {
@Nonnull
@Override
public Session getSession() {
return session;
}

@Nullable
@Override
public RequestTrace getTrace() {
return trace;
}

@Override
public boolean equals(Object o) {
return o instanceof RgavCacheKey that
&& Objects.equals(tag, that.tag)
&& Objects.equals(groupId, that.groupId)
&& Objects.equals(version, that.version)
&& Objects.equals(artifactId, that.artifactId)
&& Objects.equals(classifier, that.classifier)
&& Objects.equals(repositories, that.repositories);
}

@Override
public int hashCode() {
return Objects.hash(repositories, groupId, artifactId, version, classifier, tag);
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(getClass().getSimpleName()).append("[").append("gav='");
if (groupId != null) {
sb.append(groupId);
}
sb.append(":");
if (artifactId != null) {
sb.append(artifactId);
}
sb.append(":");
if (version != null) {
sb.append(version);
}
sb.append(":");
if (classifier != null) {
sb.append(classifier);
}
sb.append("', tag='");
sb.append(tag);
sb.append("']");
return sb.toString();
}
}

record SourceCacheKey(Session session, RequestTrace trace, Source source, String tag)
implements Request<Session>, CacheMetadata {
@Nonnull
@Override
public Session getSession() {
return session;
}

@Nullable
@Override
public RequestTrace getTrace() {
return trace;
}

@Override
public CacheRetention getCacheRetention() {
return source instanceof CacheMetadata cacheMetadata ? cacheMetadata.getCacheRetention() : null;
}

@Override
public boolean equals(Object o) {
return o instanceof SourceCacheKey that
&& Objects.equals(tag, that.tag)
&& Objects.equals(source, that.source);
}

@Override
public int hashCode() {
return Objects.hash(source, tag);
}

@Override
public String toString() {
return getClass().getSimpleName() + "[" + "location=" + source.getLocation() + ", tag=" + tag
+ ", path=" + source.getPath() + ']';
}
}

static class SourceResponse<R extends Request<?>, T> implements Result<R> {
private final R request;
private final T response;

SourceResponse(R request, T response) {
this.request = request;
this.response = response;
}

@Nonnull
@Override
public R getRequest() {
return request;
}
}

private <T> T cache(
List<RemoteRepository> repositories,
String groupId,
Expand All @@ -1795,11 +1897,28 @@ private <T> T cache(
String classifier,
String tag,
Supplier<T> supplier) {
return cache.computeIfAbsent(repositories, groupId, artifactId, version, classifier, tag, supplier);
RequestTraceHelper.ResolverTrace trace = RequestTraceHelper.enter(session, request);
try {
RgavCacheKey r = new RgavCacheKey(
session, trace.mvnTrace(), repositories, groupId, artifactId, version, classifier, tag);
SourceResponse<RgavCacheKey, T> response =
InternalSession.from(session).request(r, tr -> new SourceResponse<>(tr, supplier.get()));
return response.response;
} finally {
RequestTraceHelper.exit(trace);
}
}

private <T> T cache(Source source, String tag, Supplier<T> supplier) throws ModelBuilderException {
return cache.computeIfAbsent(source, tag, supplier);
RequestTraceHelper.ResolverTrace trace = RequestTraceHelper.enter(session, request);
try {
SourceCacheKey r = new SourceCacheKey(session, trace.mvnTrace(), source, tag);
SourceResponse<SourceCacheKey, T> response =
InternalSession.from(session).request(r, tr -> new SourceResponse<>(tr, supplier.get()));
return response.response;
} finally {
RequestTraceHelper.exit(trace);
}
}

boolean isBuildRequest() {
Expand Down
Loading

0 comments on commit cb1b1e0

Please sign in to comment.