Fix configuration cache issues with the APT plugin (#218)

Author: nedtwigg

CHANGES.md

@@ -1,6 +1,8 @@
 # Goomph releases
 
 ## [Unreleased]
+### Added
+- Add Gradle configuration cache compatibility fixes for the Eclipse APT plugin.
 
 ## [4.3.0] - 2025-03-11
 ### Added

src/main/java/com/diffplug/gradle/eclipse/apt/AptEclipsePlugin.java

@@ -23,9 +23,11 @@
 import org.gradle.api.Project;
 import org.gradle.api.Task;
 import org.gradle.api.internal.PropertiesTransformer;
+import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.ExtensionAware;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.provider.MapProperty;
 import org.gradle.api.tasks.Delete;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.internal.xml.XmlTransformer;
@@ -36,6 +38,8 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
+import javax.inject.Inject;
+
 /**
  * Plugin which modifies the eclipse project file so that it will
  * include gradle `annotationProcessor` dependencies.  No configuration
@@ -52,6 +56,18 @@ private static Action<Task> dependsOn(final Object taskDependency) {
     return task -> task.dependsOn(taskDependency);
   }
 
+  private final ObjectFactory objects;
+
+  @Deprecated
+  public AptEclipsePlugin() {
+      throw new UnsupportedOperationException("Cannot directly instantiate AptEclipsePlugin");
+  }
+
+  @Inject
+  public AptEclipsePlugin(ObjectFactory objects) {
+      this.objects = objects;
+  }
+
   @Override
   public void apply(final Project project) {
     project.getPlugins().apply(AptPlugin.class);
@@ -103,14 +119,13 @@ private void configureJdtApt(
                     .getExtensions()
                     .getByType(AptPlugin.AptOptions.class)
                     .isAnnotationProcessing()));
-    jdtApt.setProcessorOptions(
-        () ->
-            project
-                .getTasks()
-                .getByName(mainSourceSet.getCompileJavaTaskName())
-                .getExtensions()
-                .getByType(AptPlugin.AptOptions.class)
-                .getProcessorArgs());
+    MapProperty<String, ?> processorOptions = objects
+      .mapProperty(String.class, Object.class)
+      .value(project.getTasks().named(mainSourceSet.getCompileJavaTaskName()).map(task ->
+        task.getExtensions().getByType(AptPlugin.AptOptions.class).getProcessorArgs()
+      ));
+    jdtApt.setProcessorOptions(processorOptions::getOrNull);
+    project.afterEvaluate(p -> processorOptions.finalizeValue());
 
     eclipseModel
         .getJdt()

src/main/java/com/diffplug/gradle/eclipse/apt/AptPlugin.java

@@ -109,15 +109,14 @@ private <T extends AbstractCompile> void configureCompileTasks(
       final Project project,
       Class<T> compileTaskClass,
       final Function<T, CompileOptions> getCompileOptions) {
-    IMPL.configureTasks(
-        project,
-        compileTaskClass,
-        task -> {
-          CompileOptions compileOptions = getCompileOptions.apply(task);
-          final AptOptions aptOptions = IMPL.createAptOptions();
-          task.getExtensions().add(AptOptions.class, "aptOptions", aptOptions);
-          IMPL.configureCompileTask(task, compileOptions, aptOptions);
-        });
+    project.afterEvaluate(p -> {
+        for (T task : p.getTasks().withType(compileTaskClass)) {
+            CompileOptions compileOptions = getCompileOptions.apply(task);
+            final AptOptions aptOptions = IMPL.createAptOptions();
+            task.getExtensions().add(AptOptions.class, "aptOptions", aptOptions);
+            IMPL.configureCompileTask(task, compileOptions, aptOptions);
+        }
+    });
   }
 
   private <T extends AbstractCompile> void configureCompileTaskForSourceSet(

src/main/java/com/diffplug/gradle/eclipse/apt/EclipseJdtApt.java

@@ -22,19 +22,31 @@
 import java.util.Objects;
 import java.util.function.Supplier;
 import javax.annotation.Nullable;
+import javax.inject.Inject;
+
 import org.gradle.api.Action;
 import org.gradle.api.Project;
+import org.gradle.api.file.ProjectLayout;
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.Provider;
+import org.gradle.api.provider.ProviderFactory;
 import org.gradle.plugins.ide.api.PropertiesFileContentMerger;
 import org.gradle.util.ConfigureUtil;
 
 public class EclipseJdtApt {
-  private final Project project;
+  private final ProviderFactory providers;
+  private final ProjectLayout layout;
   private final PropertiesFileContentMerger file;
 
+  @Deprecated
   public EclipseJdtApt(Project project, PropertiesFileContentMerger file) {
-    this.project = project;
+    this(project, project.getProviders(), project.getLayout(), file);
+  }
+
+  @Inject
+  public EclipseJdtApt(Project project, ProviderFactory providers, ProjectLayout layout, PropertiesFileContentMerger file) {
+    this.providers = providers;
+    this.layout = layout;
     this.file = file;
     this.aptEnabled = project.getObjects().property(Boolean.class);
     aptEnabled.set(true);
@@ -78,7 +90,7 @@ public void setReconcileEnabled(Provider<Boolean> reconcileEnabled) {
   private final Property<File> genSrcDir;
 
   public File getGenSrcDir() {
-    return project.file(genSrcDir);
+    return layout.getProjectDirectory().file(genSrcDir.map(File::getAbsolutePath)).get().getAsFile();
   }
 
   public void setGenSrcDir(File genSrcDir) {
@@ -87,13 +99,13 @@ public void setGenSrcDir(File genSrcDir) {
 
   public void setGenSrcDir(Object genSrcDir) {
     Objects.requireNonNull(genSrcDir);
-    this.genSrcDir.set(project.provider(() -> project.file(genSrcDir)));
+    this.genSrcDir.set(providers.provider(() -> layout.getProjectDirectory().files(genSrcDir).getSingleFile()));
   }
 
   private final Property<File> genTestSrcDir;
 
   public File getGenTestSrcDir() {
-    return project.file(genTestSrcDir);
+    return layout.getProjectDirectory().file(genTestSrcDir.map(File::getAbsolutePath)).get().getAsFile();
   }
 
   public void setGenTestSrcDir(File genTestSrcDir) {
@@ -102,7 +114,7 @@ public void setGenTestSrcDir(File genTestSrcDir) {
 
   public void setGenTestSrcDir(Object genTestSrcDir) {
     Objects.requireNonNull(genTestSrcDir);
-    this.genTestSrcDir.set(project.provider(() -> project.file(genTestSrcDir)));
+    this.genSrcDir.set(providers.provider(() -> layout.getProjectDirectory().files(genTestSrcDir).getSingleFile()));
   }
 
   // XXX: this is actually either a Property<Map> or a MapProperty depending on Gradle version

src/main/java/com/diffplug/gradle/eclipse/apt/GenerateEclipseFactorypath.java

@@ -18,7 +18,7 @@
 import java.io.File;
 import java.util.LinkedHashSet;
 import java.util.Set;
-import org.gradle.api.artifacts.Configuration;
+import org.gradle.api.file.FileCollection;
 import org.gradle.api.tasks.Internal;
 import org.gradle.plugins.ide.api.XmlGeneratorTask;
 
@@ -38,10 +38,10 @@ protected void configure(Factorypath factorypath) {
     EclipseFactorypath factorypathModel = getFactorypath();
     factorypathModel.getFile().getBeforeMerged().execute(factorypath);
     Set<File> entries = new LinkedHashSet<>();
-    for (Configuration configuration : factorypathModel.getPlusConfigurations()) {
+    for (FileCollection configuration : factorypathModel.getPlusConfigurations()) {
       entries.addAll(configuration.getFiles());
     }
-    for (Configuration configuration : factorypathModel.getMinusConfigurations()) {
+    for (FileCollection configuration : factorypathModel.getMinusConfigurations()) {
       entries.removeAll(configuration.getFiles());
     }
     factorypath.mergeEntries(entries);

src/main/java/com/diffplug/gradle/eclipse/apt/GenerateEclipseJdtApt.java

@@ -16,21 +16,37 @@
 package com.diffplug.gradle.eclipse.apt;
 
 import java.util.Map;
+
+import org.gradle.api.file.ProjectLayout;
 import org.gradle.api.tasks.Internal;
 import org.gradle.plugins.ide.api.PropertiesGeneratorTask;
 
+import javax.inject.Inject;
+
 public class GenerateEclipseJdtApt extends PropertiesGeneratorTask<JdtApt> {
   @SuppressWarnings("NullAway.Init") // will be initialized by setJdtApt right after creation
   private EclipseJdtApt jdtApt;
 
+  private final ProjectLayout layout;
+
+  @Deprecated
+  public GenerateEclipseJdtApt() {
+    this(null);
+  }
+
+  @Inject
+  public GenerateEclipseJdtApt(ProjectLayout layout) {
+    this.layout = layout != null ? layout : getProject().getLayout();
+  }
+
   @SuppressWarnings("unchecked")
   @Override
   protected void configure(JdtApt jdtApt) {
     EclipseJdtApt jdtAptModel = getJdtApt();
     jdtAptModel.getFile().getBeforeMerged().execute(jdtApt);
     jdtApt.setAptEnabled(jdtAptModel.isAptEnabled());
-    jdtApt.setGenSrcDir(getProject().relativePath(jdtAptModel.getGenSrcDir()));
-    jdtApt.setGenTestSrcDir(getProject().relativePath(jdtAptModel.getGenTestSrcDir()));
+    jdtApt.setGenSrcDir(layout.getProjectDirectory().file(jdtAptModel.getGenSrcDir().getAbsolutePath()).getAsFile().getPath());
+    jdtApt.setGenTestSrcDir(layout.getProjectDirectory().file(jdtAptModel.getGenTestSrcDir().getAbsolutePath()).getAsFile().getPath());
     jdtApt.setReconcileEnabled(jdtAptModel.isReconcileEnabled());
     jdtApt.getProcessorOptions().clear();
     if (jdtAptModel.getProcessorOptions() != null) {