Remove zstd dependency and switch to GZIP in SimpleMetrics

Author: NonSwag

bukkit/src/main/java/dev/faststats/bukkit/BukkitMetricsImpl.java

@@ -105,7 +105,7 @@ static final class Factory extends SimpleMetrics.Factory<Plugin> {
         @Override
         public Metrics create(Plugin plugin) throws IOException, IllegalStateException {
             var dataFolder = plugin.getServer().getPluginsFolder().toPath().resolve("faststats");
-            var config = dataFolder.resolve("config.json");
+            var config = dataFolder.resolve("config.properties");
             return new BukkitMetricsImpl(this, plugin, config);
         }
     }

core/build.gradle.kts

@@ -1,6 +1,4 @@
 dependencies {
-    api("com.github.luben:zstd-jni:1.5.7-6")
-    
     compileOnlyApi("com.google.code.gson:gson:2.13.2")
     compileOnlyApi("org.jetbrains:annotations:26.0.2-1")
     compileOnlyApi("org.jspecify:jspecify:1.0.0")

core/src/main/java/dev/faststats/core/SimpleMetrics.java

@@ -1,18 +1,14 @@
 package dev.faststats.core;
 
-import com.github.luben.zstd.Zstd;
-import com.google.gson.FormattingStyle;
 import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
-import com.google.gson.stream.JsonReader;
-import com.google.gson.stream.JsonWriter;
 import dev.faststats.core.chart.Chart;
 import org.jetbrains.annotations.Async;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.MustBeInvokedByOverriders;
 import org.jetbrains.annotations.VisibleForTesting;
 import org.jspecify.annotations.Nullable;
 
+import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.net.ConnectException;
@@ -28,11 +24,13 @@
 import java.time.Duration;
 import java.util.HashSet;
 import java.util.Optional;
+import java.util.Properties;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
+import java.util.zip.GZIPInputStream;
 
 public abstract class SimpleMetrics implements Metrics {
     private final HttpClient httpClient = HttpClient.newBuilder()
@@ -95,9 +93,10 @@ protected boolean isSubmitting() {
     }
 
     protected void submitData() {
-        try {
-            var data = createData().toString();
-            var compressed = Zstd.compress(data.getBytes(StandardCharsets.UTF_8), 6);
+        var data = createData().toString();
+        try (var bytes = new ByteArrayInputStream(data.getBytes(StandardCharsets.UTF_8));
+             var input = new GZIPInputStream(bytes)) {
+            var compressed = input.readAllBytes();
             var request = HttpRequest.newBuilder()
                     .POST(HttpRequest.BodyPublishers.ofByteArray(compressed))
                     .header("Content-Encoding", "zstd")
@@ -154,7 +153,7 @@ protected JsonObject createData() {
                 error("Failed to build chart data: " + chart.getId(), e);
             }
         });
-        
+
         appendDefaultData(charts);
 
         data.addProperty("server_id", config.serverId().toString());
@@ -235,9 +234,9 @@ protected static final class Config implements Metrics.Config {
         protected Config(Path file) throws IOException {
             var json = readOrEmpty(file);
 
-            this.serverId = json.map(object -> UUID.fromString(object.get("serverId").getAsString())).orElseGet(UUID::randomUUID);
-            this.enabled = json.map(object -> object.get("enabled").getAsBoolean()).orElse(true);
-            this.debug = json.map(object -> object.get("debug").getAsBoolean()).orElse(false);
+            this.serverId = json.map(object -> UUID.fromString(object.getProperty("serverId"))).orElseGet(UUID::randomUUID);
+            this.enabled = json.map(object -> object.getProperty("enabled")).map(Boolean::parseBoolean).orElse(true);
+            this.debug = json.map(object -> object.getProperty("debug")).map(Boolean::parseBoolean).orElse(false);
 
             if (json.isEmpty()) create(file, serverId);
         }
@@ -264,7 +263,7 @@ public boolean debug() {
             return debug;
         }
 
-        private static Optional<JsonObject> readOrEmpty(Path file) throws IOException {
+        private static Optional<Properties> readOrEmpty(Path file) throws IOException {
             if (Files.isRegularFile(file)) {
                 return Optional.of(read(file));
             } else {
@@ -275,19 +274,32 @@ private static Optional<JsonObject> readOrEmpty(Path file) throws IOException {
         private static void create(Path file, UUID serverId) throws IOException {
             Files.createDirectories(file.getParent());
             try (var out = Files.newOutputStream(file, StandardOpenOption.CREATE_NEW);
-                 var writer = new JsonWriter(new OutputStreamWriter(out, StandardCharsets.UTF_8))) {
-                writer.setFormattingStyle(FormattingStyle.PRETTY);
-                writer.beginObject();
-                writer.name("serverId").value(serverId.toString());
-                writer.name("enabled").value(true);
-                writer.name("debug").value(false);
-                writer.endObject();
+                 var writer = new OutputStreamWriter(out, StandardCharsets.UTF_8)) {
+                var properties = new Properties();
+
+                properties.setProperty("serverId", serverId.toString());
+                properties.setProperty("enabled", Boolean.toString(true));
+                properties.setProperty("debug", Boolean.toString(false));
+
+                var comment = """
+                         FastStats (https://faststats.dev) collects some basic information for plugin authors, like
+                        # how many people use their plugin and their total player count. It's recommended to keep
+                        # metrics 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
+                        # FastStats is fully anonymous.
+                        
+                        # If you suspect a plugin is collecting personal data or bypassing the "enabled" option,
+                        # please report it to the FastStats team (https://faststats.dev/abuse).
+                        """;
+                properties.store(writer, comment);
             }
         }
 
-        private static JsonObject read(Path file) throws IOException {
-            try (var reader = new JsonReader(Files.newBufferedReader(file, StandardCharsets.UTF_8))) {
-                return JsonParser.parseReader(reader).getAsJsonObject();
+        private static Properties read(Path file) throws IOException {
+            try (var reader = Files.newBufferedReader(file, StandardCharsets.UTF_8)) {
+                var properties = new Properties();
+                properties.load(reader);
+                return properties;
             }
         }
     }

core/src/main/java/module-info.java

@@ -5,7 +5,6 @@
     exports dev.faststats.core.chart;
     exports dev.faststats.core;
 
-    requires com.github.luben.zstd_jni;
     requires com.google.gson;
     requires java.net.http;
 

velocity/src/main/java/dev/faststats/velocity/VelocityMetricsImpl.java

@@ -100,7 +100,7 @@ public Factory(ProxyServer server, Logger logger, @DataDirectory Path dataDirect
         public Metrics create(Object plugin) throws IOException, IllegalStateException, IllegalArgumentException {
             var faststats = dataDirectory.resolveSibling("faststats");
             var container = server.getPluginManager().ensurePluginContainer(plugin);
-            return new VelocityMetricsImpl(this, logger, server, faststats.resolve("config.json"), container);
+            return new VelocityMetricsImpl(this, logger, server, faststats.resolve("config.properties"), container);
         }
     }
 }