feat(core/userdev): Make reobf optional (#290)

* Make reobf optional

Comment out the build data ref and or the pkg ver in the spigot extension to disable (or manually set the enabled prop)

* Improve userdev error when attempting to reobf and dev bundle does not provide reobf mappings

Author: jpenilla

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/PaperweightCore.kt

@@ -145,8 +145,8 @@ abstract class PaperweightCore : Plugin<Project> {
         tasks.generateRelocatedReobfMappings {
             inputJar.set(jar.flatMap { it.archiveFile })
         }
-        val (includeMappings, reobfJar) = target.createBuildTasks(
-            ext.spigot.packageVersion,
+        val (mappedJar, reobfJar) = target.createBuildTasks(
+            ext.spigot,
             ext.reobfPackagesToFix,
             tasks.generateRelocatedReobfMappings.flatMap { it.outputMappings },
         )
@@ -158,8 +158,8 @@ abstract class PaperweightCore : Plugin<Project> {
             tasks.extractFromBundler.flatMap { it.versionJson },
             tasks.extractFromBundler.flatMap { it.serverLibrariesList },
             tasks.downloadServerJar.flatMap { it.outputJar },
-            includeMappings.flatMap { it.outputJar },
-            reobfJar.flatMap { it.outputJar },
+            mappedJar,
+            reobfJar,
             ext.minecraftVersion,
         )
 
@@ -192,7 +192,7 @@ abstract class PaperweightCore : Plugin<Project> {
             tasks.afterEvaluate()
 
             devBundleTasks.configureAfterEvaluate(
-                includeMappings.flatMap { it.outputJar },
+                mappedJar,
             )
 
             if (coreExt.updatingMinecraft.oldPaperCommit.isPresent) {

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/extension/PaperweightCoreExtension.kt

@@ -50,7 +50,13 @@ abstract class PaperweightCoreExtension @Inject constructor(objects: ObjectFacto
 
     val reobfPackagesToFix: ListProperty<String> = objects.listProperty()
 
-    val spigot = objects.newInstance<SpigotExtension>()
+    val spigot = objects.newInstance<SpigotExtension>().also { spigot ->
+        spigot.enabled.convention(
+            spigot.buildDataRef.zip(spigot.packageVersion) { ref, pkg ->
+                ref !== null && pkg !== null && ref.isNotBlank() && pkg.isNotBlank()
+            }
+        )
+    }
     val paper = objects.newInstance<PaperExtension>(project)
 
     @Suppress("unused")

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/extension/SpigotExtension.kt

@@ -28,4 +28,5 @@ interface SpigotExtension {
 
     val buildDataRef: Property<String>
     val packageVersion: Property<String>
+    val enabled: Property<Boolean>
 }

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

@@ -68,7 +68,15 @@ class DevBundleTasks(
 
         minecraftVersion.set(project.coreExt.minecraftVersion)
         mojangMappedPaperclipFile.set(paperclipForDevBundle.flatMap { it.outputZip })
-        reobfMappingsFile.set(coreTasks.generateRelocatedReobfMappings.flatMap { it.outputMappings })
+        reobfMappingsFile.set(
+            project.coreExt.spigot.enabled.flatMap<RegularFile?> {
+                if (it) {
+                    coreTasks.generateRelocatedReobfMappings.flatMap { it.outputMappings }
+                } else {
+                    providers.provider { null }
+                }
+            }
+        )
     }
 
     fun configureAfterEvaluate(serverJar: Provider<RegularFile>) {

paperweight-core/src/main/kotlin/io/papermc/paperweight/core/util/project-util.kt

@@ -23,25 +23,27 @@
 package io.papermc.paperweight.core.util
 
 import io.papermc.paperweight.PaperweightException
+import io.papermc.paperweight.core.extension.SpigotExtension
 import io.papermc.paperweight.tasks.*
 import io.papermc.paperweight.util.*
 import io.papermc.paperweight.util.constants.*
 import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.file.RegularFile
 import org.gradle.api.provider.Provider
-import org.gradle.api.tasks.TaskProvider
 import org.gradle.api.tasks.bundling.AbstractArchiveTask
 import org.gradle.kotlin.dsl.*
 
 fun Project.createBuildTasks(
-    craftBukkitPackageVersion: Provider<String>,
+    spigot: SpigotExtension,
     packagesToFix: Provider<List<String>?>,
     relocatedReobfMappings: Provider<RegularFile>
-): ServerBuildTasks {
+): ServerArtifacts {
+    val jar = tasks.named("jar", AbstractArchiveTask::class).flatMap { it.archiveFile }
+
     val fixJarForReobf by tasks.registering<FixJarForReobf> {
         group = "build"
-        inputJar.set(tasks.named("jar", AbstractArchiveTask::class).flatMap { it.archiveFile })
+        inputJar.set(jar)
         packagesToProcess.set(packagesToFix)
     }
 
@@ -59,7 +61,7 @@ fun Project.createBuildTasks(
     }
     afterEvaluate {
         relocateConstants {
-            relocate("org.bukkit.craftbukkit", "org.bukkit.craftbukkit.${craftBukkitPackageVersion.get()}") {
+            relocate("org.bukkit.craftbukkit", "org.bukkit.craftbukkit.${spigot.packageVersion.get()}") {
                 // This is not actually needed as there are no string constant references to Main
                 // exclude("org.bukkit.craftbukkit.Main*")
             }
@@ -85,7 +87,16 @@ fun Project.createBuildTasks(
         outputJar.set(layout.buildDirectory.map { it.dir("libs").file("${project.name}-${project.version}-reobf.jar") })
     }
 
-    return ServerBuildTasks(includeMappings, reobfJar)
+    return ServerArtifacts(
+        spigot.enabled.flatMap {
+            if (it) {
+                includeMappings.flatMap { it.outputJar }
+            } else {
+                jar
+            }
+        },
+        reobfJar.flatMap { it.outputJar }
+    )
 }
 
 fun Task.reobfRequiresDebug() {
@@ -100,7 +111,7 @@ fun Task.reobfRequiresDebug() {
     }
 }
 
-data class ServerBuildTasks(
-    val includeMappings: TaskProvider<IncludeMappings>,
-    val reobfJar: TaskProvider<RemapJar>,
+data class ServerArtifacts(
+    val mappedJar: Provider<RegularFile>,
+    val reobfJar: Provider<RegularFile>,
 )

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

@@ -31,21 +31,21 @@ import java.nio.file.Files
 import java.nio.file.Path
 import javax.inject.Inject
 import kotlin.io.path.*
-import org.gradle.api.DefaultTask
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.file.DirectoryProperty
-import org.gradle.api.file.ProjectLayout
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
+import org.gradle.api.provider.ProviderFactory
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.InputFiles
+import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 
-abstract class GenerateDevBundle : DefaultTask() {
+abstract class GenerateDevBundle : BaseTask() {
 
     @get:InputFiles
     abstract val sourceDirectories: ConfigurableFileCollection
@@ -69,13 +69,14 @@ abstract class GenerateDevBundle : DefaultTask() {
     abstract val macheDep: Property<String>
 
     @get:InputFile
+    @get:Optional
     abstract val reobfMappingsFile: RegularFileProperty
 
     @get:OutputFile
     abstract val devBundleFile: RegularFileProperty
 
     @get:Inject
-    abstract val layout: ProjectLayout
+    abstract val providers: ProviderFactory
 
     @TaskAction
     fun run() {
@@ -100,7 +101,9 @@ abstract class GenerateDevBundle : DefaultTask() {
 
             val dataZip = zip.getPath(dataDir)
             dataZip.createDirectories()
-            reobfMappingsFile.path.copyTo(dataZip.resolve(reobfMappingsFileName))
+            if (reobfMappingsFile.isPresent) {
+                reobfMappingsFile.path.copyTo(dataZip.resolve(reobfMappingsFileName))
+            }
             mojangMappedPaperclipFile.path.copyTo(dataZip.resolve(mojangMappedPaperclipFileName))
 
             val patchesZip = zip.getPath(patchesDir)
@@ -186,7 +189,7 @@ abstract class GenerateDevBundle : DefaultTask() {
             minecraftVersion = minecraftVersion.get(),
             mache = createMacheDep(),
             patchDir = patchTargetDir,
-            reobfMappingsFile = "$dataTargetDir/$reobfMappingsFileName",
+            reobfMappingsFile = if (reobfMappingsFile.isPresent) "$dataTargetDir/$reobfMappingsFileName" else null,
             mojangMappedPaperclipFile = "$dataTargetDir/$mojangMappedPaperclipFileName",
             libraryRepositories = libraryRepositories.get(),
             pluginRemapArgs = TinyRemapper.pluginRemapArgs,
@@ -200,7 +203,7 @@ abstract class GenerateDevBundle : DefaultTask() {
         val minecraftVersion: String,
         val mache: MavenDep,
         val patchDir: String,
-        val reobfMappingsFile: String,
+        val reobfMappingsFile: String?,
         val mojangMappedPaperclipFile: String,
         val libraryRepositories: List<String>,
         val pluginRemapArgs: List<String>,
@@ -211,6 +214,6 @@ abstract class GenerateDevBundle : DefaultTask() {
         const val mojangMappedPaperclipFileName = "paperclip-$DEOBF_NAMESPACE.jar"
 
         // Should be bumped when the dev bundle config/contents changes in a way which will require users to update paperweight
-        const val currentDataVersion = 6
+        const val currentDataVersion = 7
     }
 }

paperweight-userdev/src/main/kotlin/io/papermc/paperweight/userdev/PaperweightUser.kt

@@ -126,7 +126,17 @@ abstract class PaperweightUser : Plugin<Project> {
             group = GENERAL_TASK_GROUP
             description = "Remap the compiled plugin jar to Spigot's obfuscated runtime names."
 
-            mappingsFile.set(setupTask.flatMap { it.reobfMappings })
+            mappingsFile.set(
+                setupTask.flatMap { task ->
+                    task.reobfMappings.map { mappings ->
+                        if (mappings.asFile.exists()) {
+                            mappings
+                        } else {
+                            throw PaperweightException("The current dev bundle does not provide reobf mappings.")
+                        }
+                    }
+                }
+            )
             remapClasspath.from(setupTask.flatMap { it.mappedServerJar })
             toNamespace.set(SPIGOT_NAMESPACE)
             remapper.from(project.configurations.named(PLUGIN_REMAPPER_CONFIG))

paperweight-userdev/src/main/kotlin/io/papermc/paperweight/userdev/internal/setup/DevBundles.kt

@@ -35,7 +35,8 @@ private val supported = mapOf(
     3 to DevBundleV5.Config::class, // up to 1.20.4
     4 to DevBundleV5.Config::class, // 1.20.5, early 1.20.6
     5 to DevBundleV5.Config::class, // 1.20.6+ (nullable mojangApiCoordinates)
-    6 to GenerateDevBundle.DevBundleConfig::class // Post-repo-restructure 1.21.4+
+    6 to GenerateDevBundle.DevBundleConfig::class, // Post-repo-restructure 1.21.4+
+    7 to GenerateDevBundle.DevBundleConfig::class, // TODO: Add version (nullable reobfMappingsFile)
 )
 
 fun readBundleInfo(bundleZip: Path): BundleInfo<Any> {

paperweight-userdev/src/main/kotlin/io/papermc/paperweight/userdev/internal/setup/SetupHandlerImpl.kt

@@ -188,8 +188,10 @@ class SetupHandlerImpl(
     }
 
     override fun extractReobfMappings(output: Path) {
-        bundle.zip.openZipSafe().use { fs ->
-            fs.getPath(bundle.config.reobfMappingsFile).copyTo(output, true)
+        bundle.config.reobfMappingsFile?.let { location ->
+            bundle.zip.openZipSafe().use { fs ->
+                fs.getPath(location).copyTo(output, true)
+            }
         }
     }
 

paperweight-userdev/src/main/kotlin/io/papermc/paperweight/userdev/internal/setup/UserdevSetupTask.kt

@@ -125,6 +125,7 @@ abstract class UserdevSetupTask : JavaLauncherTask() {
         val copiedTime = measureNanoTime {
             result.mainOutput.copyTo(mappedServerJar.path.createParentDirectories(), overwrite = true)
             result.legacyOutput?.copyTo(legacyPaperclipResult.path.createParentDirectories(), overwrite = true)
+            reobfMappings.path.createParentDirectories().deleteForcefully()
             setupService.get().extractReobfMappings(reobfMappings.path.createParentDirectories())
         }
         logger.lifecycle("Copied artifacts to project cache in ${formatNs(copiedTime)}")