Make SetupMinecraftSources cacheable (#329)

To preserve the Git repo integrity we must zip the outputs ourselves

Author: jpenilla

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/taskcontainers/CoreTasks.kt

@@ -24,6 +24,7 @@ package io.papermc.paperweight.core.taskcontainers
 
 import io.papermc.paperweight.PaperweightException
 import io.papermc.paperweight.core.extension.ForkConfig
+import io.papermc.paperweight.core.tasks.ExtractMinecraftSources
 import io.papermc.paperweight.core.tasks.ImportLibraryFiles
 import io.papermc.paperweight.core.tasks.IndexLibraryFiles
 import io.papermc.paperweight.core.tasks.SetupMinecraftSources
@@ -106,16 +107,26 @@ class CoreTasks(
         description = "Setup Minecraft source dir (applying mache patches and paper ATs)."
         configureSetupMacheSources()
         libraryImports.set(importLibraryFiles.flatMap { it.outputDir })
-        outputDir.set(layout.cache.resolve(BASE_PROJECT).resolve("sources"))
+        outputZip.set(layout.cache.resolve(BASE_PROJECT).resolve("sources.zip"))
 
         atFile.set(mergePaperATs.flatMap { it.outputFile })
         ats.jstClasspath.from(project.configurations.named(MACHE_MINECRAFT_LIBRARIES_CONFIG))
         ats.jst.from(project.configurations.named(JST_CONFIG))
     }
 
+    val extractMacheSources by tasks.registering(ExtractMinecraftSources::class) {
+        zip.set(setupMacheSources.flatMap { it.outputZip })
+        outputDir.set(layout.cache.resolve(BASE_PROJECT).resolve("sources"))
+    }
+
     val setupMacheSourcesForDevBundle by tasks.registering(SetupMinecraftSources::class) {
         description = "Setup Minecraft source dir (applying mache patches)."
         configureSetupMacheSources()
+        outputZip.set(layout.cache.resolve(BASE_PROJECT).resolve("sources_dev_bundle.zip"))
+    }
+
+    val extractMacheSourcesForDevBundle by tasks.registering(ExtractMinecraftSources::class) {
+        zip.set(setupMacheSourcesForDevBundle.flatMap { it.outputZip })
         outputDir.set(layout.cache.resolve(BASE_PROJECT).resolve("sources_dev_bundle"))
     }
 
@@ -124,6 +135,11 @@ class CoreTasks(
 
         inputFile.set(extractFromBundler.flatMap { it.serverJar })
         predicate.set { Files.isRegularFile(it) && !it.toString().endsWith(".class") }
+        outputZip.set(layout.cache.resolve(BASE_PROJECT).resolve("resources.zip"))
+    }
+
+    val extractMacheResources by tasks.registering(ExtractMinecraftSources::class) {
+        zip.set(setupMacheResources.flatMap { it.outputZip })
         outputDir.set(layout.cache.resolve(BASE_PROJECT).resolve("resources"))
     }
 
@@ -174,8 +190,8 @@ class CoreTasks(
             project.coreExt.paper.resourcePatchDir,
             project.coreExt.paper.featurePatchDir,
             project.coreExt.paper.additionalAts,
-            setupMacheSources.flatMap { it.outputDir },
-            setupMacheResources.flatMap { it.outputDir },
+            extractMacheSources.flatMap { it.outputDir },
+            extractMacheResources.flatMap { it.outputDir },
             project.coreExt.gitFilePatches,
             project.coreExt.filterPatches,
             paperOutputRoot,

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/taskcontainers/DevBundleTasks.kt

@@ -64,7 +64,7 @@ class DevBundleTasks(
                 .getByName("main")
                 .allJava
         )
-        vanillaJavaDir.set(coreTasks.setupMacheSourcesForDevBundle.flatMap { it.outputDir })
+        vanillaJavaDir.set(coreTasks.extractMacheSourcesForDevBundle.flatMap { it.outputDir })
 
         minecraftVersion.set(project.coreExt.minecraftVersion)
         mojangMappedPaperclipFile.set(paperclipForDevBundle.flatMap { it.outputZip })

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/tasks/ExtractMinecraftSources.kt

@@ -0,0 +1,49 @@
+/*
+ * paperweight is a Gradle plugin for the PaperMC project.
+ *
+ * Copyright (c) 2023 Kyle Wood (DenWav)
+ *                    Contributors
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation;
+ * version 2.1 only, no later versions.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ * USA
+ */
+
+package io.papermc.paperweight.core.tasks
+
+import io.papermc.paperweight.tasks.BaseTask
+import io.papermc.paperweight.util.deleteRecursive
+import io.papermc.paperweight.util.path
+import io.papermc.paperweight.util.unzip
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.TaskAction
+
+// To make the Git repos cacheable they must be zipped, this tasks extracts them again...
+abstract class ExtractMinecraftSources : BaseTask() {
+    @get:InputFile
+    abstract val zip: RegularFileProperty
+
+    @get:OutputDirectory
+    abstract val outputDir: DirectoryProperty
+
+    @TaskAction
+    fun run() {
+        val output = outputDir.path
+        output.deleteRecursive()
+        unzip(zip, output)
+    }
+}

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/tasks/SetupMinecraftSources.kt

@@ -46,7 +46,8 @@ import org.gradle.api.provider.Property
 import org.gradle.api.tasks.*
 import org.gradle.kotlin.dsl.*
 
-abstract class SetupMinecraftSources : JavaLauncherTask() {
+@CacheableTask
+abstract class SetupMinecraftSources : JavaLauncherZippedTask() {
 
     @get:PathSensitive(PathSensitivity.NONE)
     @get:InputFile
@@ -55,11 +56,9 @@ abstract class SetupMinecraftSources : JavaLauncherTask() {
     @get:Internal
     abstract val predicate: Property<Predicate<Path>>
 
-    @get:OutputDirectory
-    abstract val outputDir: DirectoryProperty
-
     @get:Optional
     @get:InputDirectory
+    @get:PathSensitive(PathSensitivity.RELATIVE)
     abstract val libraryImports: DirectoryProperty
 
     @get:Optional
@@ -75,12 +74,10 @@ abstract class SetupMinecraftSources : JavaLauncherTask() {
 
     @get:InputFile
     @get:Optional
+    @get:PathSensitive(PathSensitivity.NONE)
     abstract val atFile: RegularFileProperty
 
-    @TaskAction
-    fun run() {
-        val outputPath = outputDir.convertToPath()
-
+    override fun run(outputPath: Path) {
         val git: Git
         if (oldPaperCommit.isPresent) {
             val oldPaperDir = setupOldPaper()

paperweight-lib/src/main/kotlin/io/papermc/paperweight/tasks/ExtractFromBundler.kt

@@ -29,13 +29,11 @@ import java.nio.file.Path
 import kotlin.io.path.*
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFileProperty
-import org.gradle.api.tasks.CacheableTask
 import org.gradle.api.tasks.Classpath
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 
-@CacheableTask
 abstract class ExtractFromBundler : BaseTask() {
 
     @get:Classpath