Switch config system to Configurate (GeyserMC#5010)

* Start implementing Configurate config system

* More development

* Start migrating to Gson only

* Progress

* Update usage of WebUtils

* Most things now use Gson for JSON

* Allow tests to succeed by using new Gson version

* Use slightly cleaner version for Version deserializer

* Work around older Gson versions without record support

* GeyserCustomSkullConfiguration uses Configurate

* Fix regression in properties get

* New config used in core

* The configuration is gone. Long live the config.

* More changes and migrations away from Jackson

* Improve node ordering when updating configs

* typo

* Better check for ignoring non-configurate configs for considering comment moving

* Ensure metrics UUID is valid

* Initial advanced config

* Remove Jackson; finish config value placements

* Remove duplicate relocate declarations

* Let annotations work

* Renaming to PluginSpecific

* Use global bStats config where possible

* Fix test

* Re-introduce asterisk behavior in configs

* Remove GeyserPluginBootstrap as it's no longer necessary

* Remove old config.yml file

* Update Xbox achievement comment

* Apply suggestions from code review

Co-authored-by: chris <[email protected]>

* No need to remove values anymore

* Fix: disable bstats relocation on platforms where it is not needed

* ensure it builds

* Update custom unavailable slot comment

Co-authored-by: chris <[email protected]>

* Update cooldown image

* Logger message for direct-compression still being enabled

* oops

* More explicit RuntimeException message

Co-authored-by: Konicai <[email protected]>

* Constant for 'system' locale

* Better config JSON encoding (something is broken with Cloudflare; we'll figure it out

* Fix broadcast port default

* Add this file too

* Update configurate branch

* fix build

* Fix: Allow using custom config file on Standalone, add relocation comment

* Move config loading to GeyserBootstrap interface

* Add and rename some config options, add section notes (GeyserMC#5390)

* Add and rename some config options, add section notes

* adjust message

* Update core/src/main/java/org/geysermc/geyser/command/defaults/ConnectionTestCommand.java

Co-authored-by: Eclipse <[email protected]>

* Update core/src/main/java/org/geysermc/geyser/configuration/GeyserConfig.java

Co-authored-by: Eclipse <[email protected]>

* Update ConfigLoader.java

* Update AdvancedConfig.java

* clarify that we're talking about the HAProxy protocol

* rename config option to use-haproxy-protocol

* remove ominous warning sign on xbox auth warning

* adjust wording

---------

Co-authored-by: Eclipse <[email protected]>

* Back to one config file

* Some minor touchups

* Configurate: Sectionification (GeyserMC#5904)

* Init: config sections

* Start on adding tests, move migrations over to ConfigMigrations class

* Get rid of auth section again, rename that one config option, fix mtu migration

* Move custom skulls config options to the bottom of the gameplay settings

* Add more tests

* Rename and migrate proxy-protocol-whitelisted-ips to haproxy-protocol-whitelisted-ips

* Add automatic downloading of the GeyserOptionalPack

* Revert "Add automatic downloading of the GeyserOptionalPack"

This reverts commit 65b9620.

* Add more invalid config tests

* Warn about emote-offhand-workaround removal

* Add automatic loading of the GeyserOptionalPack (feature/configurate) (GeyserMC#5964)

* Add automatic downloading of the GeyserOptionalPack

* Warn about including the OptionalPack from extensions when Geyser is already including it instead of throwing.

* Copy optional pack instead of downloading

---------

Co-authored-by: onebeastchris <[email protected]>

* Remove unused variable

* Start warning users not running Java 21

* Update tests, temporarily remove NumericRanges test

* Remove duplicate advanced section from Geyser dump

* Address some "reviews"

* yeet md5 hash from geyser dump

* Add info about number of resource packs / amount of mappings into Geyser dump

* Re-enable invalid config loading test

* Fix: allow-custom-skulls migration

* Fix test

* Add "enable-emotes" configuration option

* Rename "emotes-enabled" to "show-emotes"

* Only enable integrated pack when optional pack isn't present

* Update integrated pack

* Exclude jackson annotations, remove leftover debug print

* Remove one-time config migration warnings as we don't have access to the logger at that stage

* Throw more detailed descriptive error when loading resource packs from the "packs" folder, add another legacy config test

* Fix NeoForge's fun module conflict

* Re-add warning about moved functionality, fix Geyser-ViaProxy

This reverts commit fbadfa5.

* oops

* Move GeyserLegacyPingPassthrough to separate thread to avoid Standalone command locking issues

---------

Co-authored-by: Konicai <[email protected]>
Co-authored-by: chris <[email protected]>
Co-authored-by: Eclipse <[email protected]>
Co-authored-by: Aurora <[email protected]>

Author: 5 people

bootstrap/bungeecord/build.gradle.kts

@@ -15,11 +15,12 @@ dependencies {
 }
 
 platformRelocate("net.md_5.bungee.jni")
-platformRelocate("com.fasterxml.jackson")
 platformRelocate("net.kyori")
 platformRelocate("org.incendo")
-platformRelocate("io.leangen.geantyref") // provided by cloud, should also be relocated
+platformRelocate("io.leangen.geantyref") // provided by cloud and Configurate, should also be relocated
 platformRelocate("org.yaml") // Broken as of 1.20
+platformRelocate("org.spongepowered")
+platformRelocate("org.bstats")
 
 // These dependencies are already present on the platform
 provided(libs.bungeecord.proxy)

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/BungeeMetrics.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2024 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.platform.bungeecord;
+
+import net.md_5.bungee.api.plugin.Plugin;
+import net.md_5.bungee.config.Configuration;
+import net.md_5.bungee.config.ConfigurationProvider;
+import net.md_5.bungee.config.YamlConfiguration;
+import org.geysermc.geyser.util.metrics.MetricsPlatform;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.UUID;
+
+public final class BungeeMetrics implements MetricsPlatform {
+    private final Configuration configuration;
+
+    public BungeeMetrics(Plugin plugin) throws IOException {
+        // https://github.com/Bastian/bstats-metrics/blob/master/bungeecord/src/main/java/org/bstats/bungeecord/Metrics.java
+        File bStatsFolder = new File(plugin.getDataFolder().getParentFile(), "bStats");
+        //noinspection ResultOfMethodCallIgnored
+        bStatsFolder.mkdirs();
+        File configFile = new File(bStatsFolder, "config.yml");
+        if (!configFile.exists()) {
+            writeFile(configFile,
+                "# bStats (https://bStats.org) collects some basic information for plugin authors, like how",
+                "# many people use their plugin and their total player count. It's recommended to keep bStats",
+                "# enabled, but if you're not comfortable with this, you can turn this setting off. There is no",
+                "# performance penalty associated with having metrics enabled, and data sent to bStats is fully",
+                "# anonymous.",
+                "enabled: true",
+                "serverUuid: \"" + UUID.randomUUID() + "\"",
+                "logFailedRequests: false",
+                "logSentData: false",
+                "logResponseStatusText: false");
+        }
+
+        this.configuration = ConfigurationProvider.getProvider(YamlConfiguration.class).load(configFile);
+    }
+
+    @Override
+    public boolean enabled() {
+        return configuration.getBoolean("enabled", true);
+    }
+
+    @Override
+    public String serverUuid() {
+        return configuration.getString("serverUuid");
+    }
+
+    @Override
+    public boolean logFailedRequests() {
+        return configuration.getBoolean("logFailedRequests", false);
+    }
+
+    @Override
+    public boolean logSentData() {
+        return configuration.getBoolean("logSentData", false);
+    }
+
+    @Override
+    public boolean logResponseStatusText() {
+        return configuration.getBoolean("logResponseStatusText", false);
+    }
+
+    private void writeFile(File file, String... lines) throws IOException {
+        try (BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter(file))) {
+            for (String line : lines) {
+                bufferedWriter.write(line);
+                bufferedWriter.newLine();
+            }
+        }
+    }
+}

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeeInjector.java

@@ -157,7 +157,7 @@ protected IoEventLoop newChild(Executor executor, IoHandlerFactory ioHandlerFact
                 listenerInfo.isPingPassthrough(),
                 listenerInfo.getQueryPort(),
                 listenerInfo.isQueryEnabled(),
-                bootstrap.getGeyserConfig().getRemote().isUseProxyProtocol() // If Geyser is expecting HAProxy, so should the Bungee end
+                bootstrap.config().advanced().java().useHaproxyProtocol() // If Geyser is expecting HAProxy, so should the Bungee end
         );
 
         // The field that stores all listeners in BungeeCord
@@ -191,7 +191,7 @@ protected void initChannel(@NonNull Channel ch) throws Exception {
                         }
                         initChannel.invoke(channelInitializer, ch);
 
-                        if (bootstrap.getGeyserConfig().isDisableCompression()) {
+                        if (bootstrap.config().advanced().java().disableCompression()) {
                             ch.pipeline().addAfter(PipelineUtils.PACKET_ENCODER, "geyser-compression-disabler",
                                     new GeyserBungeeCompressionDisabler());
                         }

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeePingPassthrough.java

@@ -69,7 +69,7 @@ public GeyserPingInfo getPingInformation(InetSocketAddress inetSocketAddress) {
         try {
             event = future.get(100, TimeUnit.MILLISECONDS);
         } catch (Throwable cause) {
-            String address = GeyserImpl.getInstance().getConfig().isLogPlayerIpAddresses() ? inetSocketAddress.toString() : "<IP address withheld>";
+            String address = GeyserImpl.getInstance().config().logPlayerIpAddresses() ? inetSocketAddress.toString() : "<IP address withheld>";
             GeyserImpl.getInstance().getLogger().error("Failed to get ping information for " + address, cause);
             return null;
         }

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeePlugin.java

@@ -33,25 +33,25 @@
 import net.md_5.bungee.protocol.ProtocolConstants;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.geysermc.geyser.FloodgateKeyLoader;
 import org.geysermc.geyser.GeyserBootstrap;
 import org.geysermc.geyser.GeyserImpl;
 import org.geysermc.geyser.api.util.PlatformType;
 import org.geysermc.geyser.command.CommandRegistry;
 import org.geysermc.geyser.command.CommandSourceConverter;
 import org.geysermc.geyser.command.GeyserCommandSource;
-import org.geysermc.geyser.configuration.GeyserConfiguration;
+import org.geysermc.geyser.configuration.GeyserPluginConfig;
 import org.geysermc.geyser.dump.BootstrapDumpInfo;
 import org.geysermc.geyser.network.GameProtocol;
 import org.geysermc.geyser.ping.GeyserLegacyPingPassthrough;
 import org.geysermc.geyser.ping.IGeyserPingPassthrough;
 import org.geysermc.geyser.platform.bungeecord.command.BungeeCommandSource;
 import org.geysermc.geyser.text.GeyserLocale;
-import org.geysermc.geyser.util.FileUtils;
+import org.geysermc.geyser.util.metrics.MetricsPlatform;
 import org.incendo.cloud.CommandManager;
 import org.incendo.cloud.bungee.BungeeCommandManager;
 import org.incendo.cloud.execution.ExecutionCoordinator;
 
-import java.io.File;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.net.InetSocketAddress;
@@ -61,13 +61,12 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
-import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
 public class GeyserBungeePlugin extends Plugin implements GeyserBootstrap {
 
     private CommandRegistry commandRegistry;
-    private GeyserBungeeConfiguration geyserConfig;
+    private GeyserPluginConfig geyserConfig;
     private GeyserBungeeInjector geyserInjector;
     private final GeyserBungeeLogger geyserLogger = new GeyserBungeeLogger(getLogger());
     private IGeyserPingPassthrough geyserBungeePingPassthrough;
@@ -102,12 +101,11 @@ public void onGeyserInitialize() {
             System.setProperty("Mcpl.io_uring", "true");
         }
 
-        if (!this.loadConfig()) {
+        geyserConfig = loadConfig(GeyserPluginConfig.class);
+        if (geyserConfig == null) {
             return;
         }
-        this.geyserLogger.setDebug(geyserConfig.isDebugMode());
-        GeyserConfiguration.checkGeyserConfiguration(geyserConfig, geyserLogger);
-        this.geyser = GeyserImpl.load(PlatformType.BUNGEECORD, this);
+        this.geyser = GeyserImpl.load(this);
         this.geyserInjector = new GeyserBungeeInjector(this);
 
         // Registration of listeners occurs only once
@@ -168,16 +166,15 @@ private void awaitStartupCompletion(int tries) {
 
     public void onGeyserEnable() {
         if (GeyserImpl.getInstance().isReloading()) {
-            if (!loadConfig()) {
+            geyserConfig = loadConfig(GeyserPluginConfig.class);
+            if (geyserConfig == null) {
                 return;
             }
-            this.geyserLogger.setDebug(geyserConfig.isDebugMode());
-            GeyserConfiguration.checkGeyserConfiguration(geyserConfig, geyserLogger);
         }
 
         // Force-disable query if enabled, or else Geyser won't enable
         for (ListenerInfo info : getProxy().getConfig().getListeners()) {
-            if (info.isQueryEnabled() && info.getQueryPort() == geyserConfig.getBedrock().port()) {
+            if (info.isQueryEnabled() && info.getQueryPort() == geyserConfig.bedrock().port()) {
                 try {
                     Field queryField = ListenerInfo.class.getDeclaredField("queryEnabled");
                     queryField.setAccessible(true);
@@ -195,7 +192,7 @@ public void onGeyserEnable() {
 
         GeyserImpl.start();
 
-        if (geyserConfig.isLegacyPingPassthrough()) {
+        if (!geyserConfig.motd().integratedPingPassthrough()) {
             this.geyserBungeePingPassthrough = GeyserLegacyPingPassthrough.init(geyser);
         } else {
             this.geyserBungeePingPassthrough = new GeyserBungeePingPassthrough(getProxy());
@@ -232,8 +229,13 @@ public void onDisable() {
     }
 
     @Override
-    public GeyserBungeeConfiguration getGeyserConfig() {
-        return geyserConfig;
+    public @NonNull PlatformType platformType() {
+        return PlatformType.BUNGEECORD;
+    }
+
+    @Override
+    public GeyserPluginConfig config() {
+        return this.geyserConfig;
     }
 
     @Override
@@ -290,11 +292,29 @@ public int getServerPort() {
 
     @Override
     public boolean testFloodgatePluginPresent() {
-        if (getProxy().getPluginManager().getPlugin("floodgate") != null) {
-            geyserConfig.loadFloodgate(this);
-            return true;
+        return getProxy().getPluginManager().getPlugin("floodgate") != null;
+    }
+
+    @Override
+    public Path getFloodgateKeyPath() {
+        Plugin floodgate = getProxy().getPluginManager().getPlugin("floodgate");
+        Path geyserDataFolder = getDataFolder().toPath();
+        Path floodgateDataFolder = floodgate != null ? floodgate.getDataFolder().toPath() : null;
+
+        return FloodgateKeyLoader.getKeyPath(geyserConfig, floodgateDataFolder, geyserDataFolder, geyserLogger);
+    }
+
+    @Override
+    public MetricsPlatform createMetricsPlatform() {
+        try {
+            return new BungeeMetrics(this);
+        } catch (IOException e) {
+            this.geyserLogger.debug("Integrated bStats support failed to load.");
+            if (this.config().debugMode()) {
+                e.printStackTrace();
+            }
+            return null;
         }
-        return false;
     }
 
     private Optional<InetSocketAddress> findCompatibleListener() {
@@ -303,20 +323,4 @@ private Optional<InetSocketAddress> findCompatibleListener() {
                 .map(info -> (InetSocketAddress) info.getSocketAddress())
                 .findFirst();
     }
-
-    @SuppressWarnings("BooleanMethodIsAlwaysInverted")
-    private boolean loadConfig() {
-        try {
-            if (!getDataFolder().exists()) //noinspection ResultOfMethodCallIgnored
-                getDataFolder().mkdir();
-            File configFile = FileUtils.fileOrCopiedFromResource(new File(getDataFolder(), "config.yml"),
-                    "config.yml", (x) -> x.replaceAll("generateduuid", UUID.randomUUID().toString()), this);
-            this.geyserConfig = FileUtils.loadConfig(configFile, GeyserBungeeConfiguration.class);
-        } catch (IOException ex) {
-            geyserLogger.error(GeyserLocale.getLocaleStringLog("geyser.config.failed"), ex);
-            ex.printStackTrace();
-            return false;
-        }
-        return true;
-    }
 }

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeeUpdateListener.java

@@ -38,7 +38,7 @@ public final class GeyserBungeeUpdateListener implements Listener {
 
     @EventHandler
     public void onPlayerJoin(final PostLoginEvent event) {
-        if (GeyserImpl.getInstance().getConfig().isNotifyOnNewBedrockUpdate()) {
+        if (GeyserImpl.getInstance().config().notifyOnNewBedrockUpdate()) {
             final ProxiedPlayer player = event.getPlayer();
             if (player.hasPermission(Permissions.CHECK_UPDATE)) {
                 VersionCheckUtils.checkForGeyserUpdate(() -> new BungeeCommandSource(player));

bootstrap/mod/fabric/build.gradle.kts

@@ -17,7 +17,7 @@ dependencies {
     shadowBundle(projects.core)
     includeTransitive(projects.core)
 
-    // These are NOT transitively included, and instead shadowed + relocated.
+    // These are NOT transitively included, and instead shadowed (+ relocated, if not under the org.geyser namespace).
     // Avoids fabric complaining about non-SemVer versioning
     shadow(libs.protocol.connection)
     shadow(libs.protocol.common)

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricDumpInfo.java

@@ -25,6 +25,7 @@
 
 package org.geysermc.geyser.platform.fabric;
 
+import com.google.gson.annotations.JsonAdapter;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import net.fabricmc.api.EnvType;
@@ -48,7 +49,7 @@ public class GeyserFabricDumpInfo extends BootstrapDumpInfo {
     private final String minecraftVersion;
     private final EnvType environmentType;
 
-    @AsteriskSerializer.Asterisk(isIp = true)
+    @JsonAdapter(value = AsteriskSerializer.class)
     private final String serverIP;
     private final int serverPort;
     private final boolean onlineMode;

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricPlatform.java

@@ -73,7 +73,7 @@ public boolean testFloodgatePluginPresent(@NonNull GeyserModBootstrap bootstrap)
         Optional<ModContainer> floodgate = FabricLoader.getInstance().getModContainer("floodgate");
         if (floodgate.isPresent()) {
             Path floodgateDataFolder = FabricLoader.getInstance().getConfigDir().resolve("floodgate");
-            bootstrap.getGeyserConfig().loadFloodgate(bootstrap, floodgateDataFolder);
+            bootstrap.loadFloodgate(floodgateDataFolder);
             return true;
         }
 

bootstrap/mod/neoforge/build.gradle.kts

@@ -13,9 +13,6 @@ architectury {
 provided("org.cloudburstmc.math", "api")
 provided("com.google.errorprone", "error_prone_annotations")
 
-// Jackson shipped by Minecraft is too old, so we shade & relocate our newer version
-relocate("com.fasterxml.jackson")
-
 dependencies {
     // See https://github.com/google/guava/issues/6618
     modules {
@@ -30,15 +27,12 @@ dependencies {
     shadowBundle(project(path = ":mod", configuration = "transformProductionNeoForge"))
     shadowBundle(projects.core)
 
-    // Minecraft (1.21.2+) includes jackson. But an old version!
-    shadowBundle(libs.jackson.core)
-    shadowBundle(libs.jackson.databind)
-    shadowBundle(libs.jackson.dataformat.yaml)
-    shadowBundle(libs.jackson.annotations)
-
     // Let's shade in our own api
     shadowBundle(projects.api)
 
+    // this one is particularly dumb
+    shadowBundle(libs.configurate.`interface`)
+
     // cannot be shaded, since neoforge will complain if floodgate-neoforge tries to provide this
     include(projects.common)
 
@@ -61,11 +55,6 @@ tasks {
     remapModrinthJar {
         archiveBaseName.set("geyser-neoforge")
     }
-
-    shadowJar {
-        // Without this, jackson's service files are not relocated
-        mergeServiceFiles()
-    }
 }
 
 modrinth {