feat: Disable server debugging by default

Author: osipxd

CHANGELOG.md

@@ -14,6 +14,8 @@
   By default, the minimal supported JVM version compatible with the specified `bukkit.server.version` is used.
 - Use lazy API for `bukkit.apiVersion` and `bukkit.generateMeta` properties.
 - Accept EULA using CLI parameter `-Dcom.mojang.eula.agree=true` instead of changing `eula.txt`
+- Change the default value of `bukkit.server.debug` to `false`.
+  It is recommended to use IDE facilities to run server with enabled debugging.
 
 ### Fixed
 

src/main/kotlin/server/DevServerPlugin.kt

@@ -6,13 +6,15 @@ import org.gradle.api.file.Directory
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.TaskContainer
 import org.gradle.api.tasks.TaskProvider
+import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.named
 import org.gradle.kotlin.dsl.register
 import ru.endlesscode.bukkitgradle.Bukkit
 import ru.endlesscode.bukkitgradle.bukkit
 import ru.endlesscode.bukkitgradle.server.extension.ServerConfiguration
 import ru.endlesscode.bukkitgradle.server.task.CreateIdeaGradleRunConfiguration
 import ru.endlesscode.bukkitgradle.server.task.PrepareServer
+import xyz.jpenilla.runpaper.RunPaperPlugin
 import xyz.jpenilla.runpaper.task.RunServer
 import java.io.File
 
@@ -32,7 +34,7 @@ public class DevServerPlugin : Plugin<Project> {
         project = target
         bukkit = project.bukkit
 
-        target.plugins.apply("xyz.jpenilla.run-paper")
+        target.apply<RunPaperPlugin>()
         val configuredServerDir = target.resolveConfiguredServerDir()
 
         // Preconfigure RunServer task
@@ -42,6 +44,12 @@ public class DevServerPlugin : Plugin<Project> {
             if (configuredServerDir != null) runDirectory.convention(configuredServerDir)
             jvmArgs(serverConfiguration.buildJvmArgs())
             args(serverConfiguration.bukkitArgs)
+
+            defaultCharacterEncoding = serverConfiguration.encoding
+            debugOptions {
+                enabled.convention(serverConfiguration.debug)
+                suspend.convention(false)
+            }
         }
 
         val prepareServer = registerPrepareServerTask(runServer)

src/main/kotlin/server/extension/ServerConfiguration.kt

@@ -12,5 +12,5 @@ public interface ServerConfiguration {
     public val coreType: CoreType
 
     /** Returns arguments for JVM. */
-    public fun buildJvmArgs(debug: Boolean = this.debug): List<String>
+    public fun buildJvmArgs(): List<String>
 }

src/main/kotlin/server/extension/ServerConfigurationImpl.kt

@@ -11,7 +11,7 @@ public class ServerConfigurationImpl : ServerConfiguration {
     override var version: String? = null
     override var eula: Boolean = false
     override var onlineMode: Boolean = false
-    override var debug: Boolean = true
+    override var debug: Boolean = false
     override var encoding: String = "UTF-8"
 
     override var javaArgs: List<String> = listOf("-Xmx1G")
@@ -48,11 +48,9 @@ public class ServerConfigurationImpl : ServerConfiguration {
         bukkitArgs = bukkitArgs + args.toList()
     }
 
-    override fun buildJvmArgs(debug: Boolean): List<String> {
+    override fun buildJvmArgs(): List<String> {
         return listOfNotNull(
-            DEBUG_ARGS.takeIf { debug },
             ACCEPT_EULA_ARGS.takeIf { eula },
-            "-Dfile.encoding=$encoding"
         ) + javaArgs
     }
 
@@ -69,7 +67,6 @@ public class ServerConfigurationImpl : ServerConfiguration {
     }
 
     private companion object {
-        const val DEBUG_ARGS: String = "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005"
         const val ACCEPT_EULA_ARGS: String = "-Dcom.mojang.eula.agree=true"
     }
 }

src/test/groovy/ru/endlesscode/bukkitgradle/server/extension/ServerConfigurationSpec.groovy

@@ -11,20 +11,13 @@ class ServerConfigurationSpec extends Specification {
         serverConfiguration = new ServerConfigurationImpl()
     }
 
-    void 'when build args - should return args with debug flags'() {
+    void 'when build args - should return args with eula flag'() {
         when:
-        def args = serverConfiguration.buildJvmArgs(true)
+        serverConfiguration.eula = true
+        def args = serverConfiguration.buildJvmArgs()
 
         then:
-        ["-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005", "-Dfile.encoding=UTF-8", "-Xmx1G"] == args
-    }
-
-    void 'when build args - and debug disabled - should return args without debug flags'() {
-        when:
-        def args = serverConfiguration.buildJvmArgs(false)
-
-        then:
-        ["-Dfile.encoding=UTF-8", "-Xmx1G"] == args
+        ["-Dcom.mojang.eula.agree=true", "-Xmx1G"] == args
     }
 
     void 'when set existing core - should set core successfully'() {