add lazilyDiffTarget task

QuiltMC · Dec 4, 2024 · dfee3c2 · dfee3c2
1 parent 9595fd5
commit dfee3c2
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 6 deletions.
diff --git a/buildSrc/src/main/java/quilt/internal/plugin/ProcessMappingsPlugin.java b/buildSrc/src/main/java/quilt/internal/plugin/ProcessMappingsPlugin.java
@@ -133,7 +133,7 @@ protected ProcessMappingsExtension applyImpl(@NotNull Project project) {
                     insertAutoGeneratedMappings.flatMap(AddProposedMappingsTask::getOutputMappings)
                 ));
 
-                // TODO LATER move this to build/ once generate-diff.yml uses generateDiff
+                // TODO LATER move this to build/ once generate-diff.yml uses lazilyDiffTarget
                 task.getOutput().convention(this.getProjectDir().dir("namedSrc"));
             }
         );

diff --git a/buildSrc/src/main/java/quilt/internal/plugin/TargetDiffPlugin.java b/buildSrc/src/main/java/quilt/internal/plugin/TargetDiffPlugin.java
@@ -3,6 +3,7 @@
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
 import org.gradle.api.Action;
+import org.gradle.api.DefaultTask;
 import org.gradle.api.GradleException;
 import org.gradle.api.Project;
 import org.gradle.api.Task;
@@ -20,6 +21,7 @@
 import quilt.internal.constants.Constants;
 import quilt.internal.constants.Classifiers;
 import quilt.internal.constants.Extensions;
+import quilt.internal.constants.Groups;
 import quilt.internal.extension.QuiltMappingsExtension;
 import quilt.internal.decompile.javadoc.MappingsJavadocProvider;
 import quilt.internal.plugin.abstraction.MappingsProjectPlugin;
@@ -40,15 +42,16 @@
 
 import java.io.FileReader;
 import java.io.IOException;
+import java.util.Collections;
 
 import static quilt.internal.constants.Constants.UNPICK_NAME;
 import static quilt.internal.task.build.MappingsV2JarTask.JAR_MAPPINGS_PATH;
 
 /**
  * {@linkplain TaskContainer#register Registers} tasks that download the latest published Quilt Mappings for the current
  * {@link QuiltMappingsExtension#getMinecraftVersion() minecraftVersion} so the
- * {@value DiffTargetTask#DIFF_TARGET_TASK_NAME} task can {@value DiffDirectoriesTask#DIFF_COMMAND}
- * them with this project's mappings.
+ * {@value DiffTargetTask#DIFF_TARGET_TASK_NAME} (or {@value #LAZILY_DIFF_TARGET_TASK_NAME}) task can
+ * {@value DiffDirectoriesTask#DIFF_COMMAND} them with this project's mappings.
  * <p>
  * The generated {@value DiffDirectoriesTask#DIFF_COMMAND} is useful when reviewing new mappings.
  * <p>
@@ -80,6 +83,16 @@
  * </ul>
  */
 public abstract class TargetDiffPlugin implements MappingsProjectPlugin {
+    /**
+     * A wrapper for {@value DiffTargetTask#DIFF_TARGET_TASK_NAME} that conditionally depends on
+     * {@value DiffTargetTask#DIFF_TARGET_TASK_NAME} only if its
+     * {@link TargetVersionConsumingTask#getTargetVersion() targetVersion} {@link Provider#isPresent() isPresent}.
+     * <p>
+     * This is a hack to prevent unnecessarily generating sources using local mappings when
+     * {@link TargetVersionConsumingTask#getTargetVersion() targetVersion} isn't present.
+     */
+    public static final String LAZILY_DIFF_TARGET_TASK_NAME = "lazilyDiffTarget";
+
     @Override
     public void apply(@NotNull Project project) {
         final PluginContainer plugins = project.getPlugins();
@@ -232,13 +245,12 @@ public void apply(@NotNull Project project) {
                         .map(dest -> dest.file(JAR_MAPPINGS_PATH))
                 ));
 
-                // TODO LATER move this to build/ once generate-diff.yml uses generateDiff
+                // TODO LATER move this to build/ once generate-diff.yml uses lazilyDiffTarget
                 task.getOutput().convention(this.getProjectDir().dir("namedTargetSrc"));
             }
         );
 
-        // TODO LATER use this in generate-diff.yml
-        tasks.register(
+        final var diffTarget = tasks.register(
             DiffTargetTask.DIFF_TARGET_TASK_NAME,
             DiffTargetTask.class,
             task -> {
@@ -251,6 +263,25 @@ public void apply(@NotNull Project project) {
                 task.getDest().convention(this.getBuildDir().file("target.diff"));
             }
         );
+
+        // TODO LATER use this in generate-diff.yml
+        tasks.register(
+            LAZILY_DIFF_TARGET_TASK_NAME,
+            DefaultTask.class,
+            task -> {
+                task.setGroup(Groups.DIFF);
+
+                // This provider is safe to get at configuration time because it comes from a ValueSource.
+                // Configuring diffTarget's targetVersion to a provider mapped from a task output would break this.
+                final Property<String> targetVersion = diffTarget.get().getTargetVersion();
+                targetVersion.finalizeValue();
+                final boolean targetVersionPresent = targetVersion.isPresent();
+
+                task.setEnabled(targetVersionPresent);
+
+                task.dependsOn(targetVersionPresent ? diffTarget : Collections.emptyList());
+            }
+        );
     }
 
     public Provider<Directory> getTargetsBuildDir() {