Support using a build-wide shared module info cache

Author: jjohannes

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesExtension.java

@@ -77,7 +77,8 @@ public abstract class JavaModuleDependenciesExtension {
     private static final String INTERNAL = "internal";
 
     private final VersionCatalogsExtension versionCatalogs;
-    private final ModuleInfoCache moduleInfoCache;
+
+    public abstract Property<ModuleInfoCache> getModuleInfoCache();
 
     /**
      * Custom mappings can be defined in a property files in your build.
@@ -134,7 +135,7 @@ public abstract class JavaModuleDependenciesExtension {
 
     public JavaModuleDependenciesExtension(VersionCatalogsExtension versionCatalogs) {
         this.versionCatalogs = versionCatalogs;
-        this.moduleInfoCache = getObjects().newInstance(ModuleInfoCache.class);
+        getModuleInfoCache().convention(getProviders().provider(() -> getObjects().newInstance(ModuleInfoCache.class, false)));
         getModulesProperties().set(new File(getProject().getRootDir(), "gradle/modules.properties"));
         getVersionCatalogName().convention("libs");
         getModuleNameCheck().convention(true);
@@ -212,7 +213,7 @@ private String toProjectName(String moduleNameSuffix) {
     }
 
     public Provider<Dependency> create(String moduleName, SourceSet sourceSetWithModuleInfo) {
-        if (moduleInfoCache.initializedInSettings()) {
+        if (getModuleInfoCache().get().isInitializedInSettings()) {
             return createPrecise(moduleName, sourceSetWithModuleInfo);
         } else {
             return createWithGuessing(moduleName, sourceSetWithModuleInfo);
@@ -221,8 +222,8 @@ public Provider<Dependency> create(String moduleName, SourceSet sourceSetWithMod
 
     public Provider<Dependency> createPrecise(String moduleName, SourceSet sourceSetWithModuleInfo) {
         return getProviders().provider(() -> {
-            String projectPath = moduleInfoCache.getProjectPath(moduleName);
-            String capability = moduleInfoCache.getCapability(moduleName);
+            String projectPath = getModuleInfoCache().get().getProjectPath(moduleName);
+            String capability = getModuleInfoCache().get().getCapability(moduleName);
 
             if (projectPath != null) {
                 // local project
@@ -243,7 +244,7 @@ public Provider<Dependency> createWithGuessing(String moduleName, SourceSet sour
             Map<String, String> allProjectNamesAndGroups = getProject().getRootProject().getSubprojects().stream().collect(
                     Collectors.toMap(Project::getName, p -> (String) p.getGroup(), (a, b) -> a));
 
-            ModuleInfo moduleInfo = moduleInfoCache.get(sourceSetWithModuleInfo, getProviders());
+            ModuleInfo moduleInfo = getModuleInfoCache().get().get(sourceSetWithModuleInfo, getProviders());
             String ownModuleNamesPrefix = moduleInfo.moduleNamePrefix(getProject().getName(), sourceSetWithModuleInfo.getName(), getModuleNameCheck().get());
 
             String moduleNameSuffix = ownModuleNamesPrefix == null ? null :
@@ -510,7 +511,7 @@ public void addRequiresRuntimeSupport(SourceSet sourceSetForModuleInfo, SourceSe
     }
 
     void doAddRequiresRuntimeSupport(SourceSet sourceSetForModuleInfo, SourceSet sourceSetForClasspath) {
-        List<String> requiresRuntime = getModuleInfoCache().get(sourceSetForModuleInfo, getProviders()).get(REQUIRES_RUNTIME);
+        List<String> requiresRuntime = getModuleInfoCache().get().get(sourceSetForModuleInfo, getProviders()).get(REQUIRES_RUNTIME);
         String generatorTaskName = sourceSetForClasspath.getTaskName("generate", "syntheticModuleInfoFolders");
         if (requiresRuntime.isEmpty() || getProject().getTasks().getNames().contains(generatorTaskName)) {
             // Already active or not needed for this source set
@@ -573,8 +574,4 @@ private String moduleDebugInfo(String moduleName, File moduleInfoFile, File root
 
     @Inject
     protected abstract SourceSetContainer getSourceSets();
-
-    ModuleInfoCache getModuleInfoCache() {
-        return moduleInfoCache;
-    }
 }

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesPlugin.java

@@ -234,7 +234,7 @@ private void setupOrderingCheckTasks(Project project, TaskProvider<Task> checkAl
                 t.setGroup("java modules");
                 t.setDescription("Check order of directives in 'module-info.java' in '" + sourceSet.getName() + "' source set");
 
-                ModuleInfo moduleInfo = javaModuleDependencies.getModuleInfoCache().get(sourceSet, project.getProviders());
+                ModuleInfo moduleInfo = javaModuleDependencies.getModuleInfoCache().get().get(sourceSet, project.getProviders());
 
                 t.getModuleInfoPath().convention(moduleInfo.getFilePath().getAbsolutePath());
                 t.getModuleNamePrefix().convention(moduleInfo.moduleNamePrefix(project.getName(), sourceSet.getName(), false));
@@ -264,7 +264,7 @@ private void readModuleInfo(ModuleInfo.Directive moduleDirective, SourceSet sour
         if (javaModuleDependenciesExtension.getAnalyseOnly().get()) {
             return;
         }
-        ModuleInfo moduleInfo = javaModuleDependenciesExtension.getModuleInfoCache().get(sourceSet, project.getProviders());
+        ModuleInfo moduleInfo = javaModuleDependenciesExtension.getModuleInfoCache().get().get(sourceSet, project.getProviders());
         for (String moduleName : moduleInfo.get(moduleDirective)) {
             declareDependency(moduleName, moduleInfo.getFilePath(), project, sourceSet, configuration, javaModuleDependenciesExtension);
         }
@@ -280,7 +280,7 @@ private void declareDependency(String moduleName, File moduleInfoFile, Project p
     }
 
     private List<BuildFileDependenciesGenerate.DependencyDeclaration> collectDependencies(Project project, JavaModuleDependenciesExtension javaModuleDependencies, SourceSet sourceSet, ModuleInfo.Directive directive, String scope) {
-        ModuleInfo moduleInfo = javaModuleDependencies.getModuleInfoCache().get(sourceSet, project.getProviders());
+        ModuleInfo moduleInfo = javaModuleDependencies.getModuleInfoCache().get().get(sourceSet, project.getProviders());
         if (moduleInfo == ModuleInfo.EMPTY) {
             // check if there is a whiltebox module-info we can use isntead
             File sourceSetDir = sourceSet.getJava().getSrcDirs().iterator().next().getParentFile();

src/main/java/org/gradlex/javamodule/dependencies/initialization/JavaModulesExtension.java

@@ -27,6 +27,7 @@
 import org.gradle.api.plugins.JavaApplication;
 import org.gradle.api.plugins.JavaPlatformPlugin;
 import org.gradle.util.GradleVersion;
+import org.gradlex.javamodule.dependencies.JavaModuleDependenciesExtension;
 import org.gradlex.javamodule.dependencies.JavaModuleDependenciesPlugin;
 import org.gradlex.javamodule.dependencies.JavaModuleVersionsPlugin;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo;
@@ -52,7 +53,7 @@ public abstract class JavaModulesExtension {
     @Inject
     public JavaModulesExtension(Settings settings) {
         this.settings = settings;
-        this.moduleInfoCache = getObjects().newInstance(ModuleInfoCache.class);
+        this.moduleInfoCache = getObjects().newInstance(ModuleInfoCache.class, true);
     }
 
     public void module(String folder) {
@@ -122,9 +123,9 @@ private void includeModule(Module module, File projectDir) {
         String group = module.getGroup().getOrNull();
         List<String> plugins = module.getPlugins().get();
         if (SUPPORT_PROJECT_ISOLATION) {
-            settings.getGradle().getLifecycle().beforeProject(new ApplyPluginsAction(artifact, group, plugins, mainModuleName));
+            settings.getGradle().getLifecycle().beforeProject(new ApplyPluginsAction(artifact, group, plugins, mainModuleName, moduleInfoCache));
         } else {
-            settings.getGradle().beforeProject(new ApplyPluginsAction(artifact, group, plugins, mainModuleName));
+            settings.getGradle().beforeProject(new ApplyPluginsAction(artifact, group, plugins, mainModuleName, moduleInfoCache));
         }
     }
 
@@ -135,19 +136,22 @@ private static class ApplyPluginsAction implements IsolatedAction<Project>, Acti
         private final String group;
         private final List<String> plugins;
         private final String mainModuleName;
+        private final ModuleInfoCache moduleInfoCache;
 
-        public ApplyPluginsAction(String artifact, @Nullable String group, List<String> plugins, @Nullable String mainModuleName) {
+        public ApplyPluginsAction(String artifact, @Nullable String group, List<String> plugins, @Nullable String mainModuleName, ModuleInfoCache moduleInfoCache) {
             this.artifact = artifact;
             this.group = group;
             this.plugins = plugins;
             this.mainModuleName = mainModuleName;
+            this.moduleInfoCache = moduleInfoCache;
         }
 
         @Override
         public void execute(Project project) {
             if (project.getName().equals(artifact)) {
                 if (group != null) project.setGroup(group);
                 project.getPlugins().apply(JavaModuleDependenciesPlugin.class);
+                project.getExtensions().getByType(JavaModuleDependenciesExtension.class).getModuleInfoCache().set(moduleInfoCache);
                 plugins.forEach(id -> project.getPlugins().apply(id));
                 if (mainModuleName != null) {
                     project.getPlugins().withType(ApplicationPlugin.class, p ->

src/main/java/org/gradlex/javamodule/dependencies/internal/utils/ModuleInfoCache.java

@@ -32,13 +32,23 @@
 
 public abstract class ModuleInfoCache {
 
+    private final boolean initializedInSettings;
     private final Map<File, ModuleInfo> moduleInfo = new HashMap<>();
     private final Map<String, String> moduleNameToProjectPath = new HashMap<>();
     private final Map<String, String> moduleNameToCapability = new HashMap<>();
 
     @Inject
     public abstract ObjectFactory getObjects();
 
+    @Inject
+    public ModuleInfoCache(boolean initializedInSettings) {
+        this.initializedInSettings = initializedInSettings;
+    }
+
+    public boolean isInitializedInSettings() {
+        return initializedInSettings;
+    }
+
     /**
      * Returns the module-info.java for the given SourceSet. If the SourceSet has multiple source folders with multiple
      * module-info files (which is usually a broken setup) the first file found is returned.
@@ -93,8 +103,4 @@ private boolean maybePutModuleInfo(File folder, ProviderFactory providers) {
         }
         return false;
     }
-
-    public boolean initializedInSettings() {
-        return false;
-    }
 }