Feature flags

build.gradle.kts

@@ -17,14 +17,16 @@ val javaVersionsOverride = mapOf(
 val defaultJavaVersion = 17
 
 subprojects {
-    apply(plugin = "java")
-    apply(plugin = "java-library")
+    apply {
+        plugin("java")
+        plugin("java-library")
+    }
 
-    val example = project.name.startsWith("example")
-    if (example) {
-        apply(plugin = "com.gradleup.shadow")
+    val noPublish = project.name.startsWith("example") || project.name == "config"
+    if (noPublish) {
+        apply { plugin("com.gradleup.shadow") }
     } else {
-        apply(plugin = "maven-publish")
+        apply { plugin("maven-publish") }
     }
 
     group = "dev.faststats.metrics"
@@ -51,7 +53,7 @@ subprojects {
         doLast {
             val file = outputDir.get().file("META-INF/faststats.properties").asFile
             file.parentFile.mkdirs()
-            file.writeText("name=${project.name}\nversion=${project.version}\n")
+            file.writeText("version=${project.version}\n")
         }
     }
 
@@ -94,7 +96,7 @@ subprojects {
     }
 
     afterEvaluate {
-        if (example) return@afterEvaluate
+        if (noPublish) return@afterEvaluate
         extensions.configure<PublishingExtension> {
             publications.create<MavenPublication>("maven") {
                 artifactId = project.name

bukkit/build.gradle.kts

@@ -14,5 +14,6 @@ configurations.compileClasspath {
 
 dependencies {
     api(project(":core"))
+    implementation(project(":config"))
     compileOnly("io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT")
 }

bukkit/example-plugin/src/main/java/com/example/ExamplePlugin.java

@@ -1,56 +1,28 @@
 package com.example;
 
+import dev.faststats.ErrorTracker;
+import dev.faststats.bukkit.BukkitContext;
 import dev.faststats.bukkit.BukkitMetrics;
-import dev.faststats.core.ErrorTracker;
-import dev.faststats.core.data.Metric;
+import dev.faststats.data.Metric;
 import org.bukkit.plugin.java.JavaPlugin;
 
-import java.lang.reflect.InvocationTargetException;
-import java.net.URI;
-import java.nio.file.AccessDeniedException;
 import java.util.concurrent.atomic.AtomicInteger;
 
-public class ExamplePlugin extends JavaPlugin {
-    // context-aware error tracker, automatically tracks errors in the same class loader
-    public static final ErrorTracker ERROR_TRACKER = ErrorTracker.contextAware()
-            // Ignore specific errors and messages
-            .ignoreError(InvocationTargetException.class, "Expected .* but got .*") // Ignored an error with a message
-            .ignoreError(AccessDeniedException.class); // Ignored a specific error type
-
-    // context-unaware error tracker, does not automatically track errors
-    public static final ErrorTracker CONTEXT_UNAWARE_ERROR_TRACKER = ErrorTracker.contextUnaware()
-            // Anonymize error messages if required
-            .anonymize("^[\\w-.]+@([\\w-]+\\.)+[\\w-]{2,4}$", "[email hidden]") // Email addresses
-            .anonymize("Bearer [A-Za-z0-9._~+/=-]+", "Bearer [token hidden]") // Bearer tokens in error messages
-            .anonymize("AKIA[0-9A-Z]{16}", "[aws-key hidden]") // AWS access key IDs
-            .anonymize("[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", "[uuid hidden]") // UUIDs (e.g. session/user IDs)
-            .anonymize("([?&](?:api_?key|token|secret)=)[^&\\s]+", "$1[redacted]"); // API keys in query strings
-
+public final class ExamplePlugin extends JavaPlugin {
     private final AtomicInteger gameCount = new AtomicInteger();
+    private final BukkitContext context = new BukkitContext(this, "YOUR_TOKEN_HERE");
+    public final ErrorTracker errorTracker = context.awareErrorTracker();
 
-    private final BukkitMetrics metrics = BukkitMetrics.factory()
-            .url(URI.create("https://metrics.example.com/v1/collect")) // For self-hosted metrics servers only
-
-            // Custom example metrics
-            // For this to work you have to create a corresponding data source in your project settings first
-            .addMetric(Metric.number("example_metric", () -> 42))
+    private final BukkitMetrics metrics = context.metricsFactory()
+            // Custom metrics require a corresponding data source in your project settings
             .addMetric(Metric.number("game_count", gameCount::get))
-            .addMetric(Metric.string("example_string", () -> "Hello, World!"))
-            .addMetric(Metric.bool("example_boolean", () -> true))
-            .addMetric(Metric.stringArray("example_string_array", () -> new String[]{"Option 1", "Option 2"}))
-            .addMetric(Metric.numberArray("example_number_array", () -> new Number[]{1, 2, 3}))
-            .addMetric(Metric.booleanArray("example_boolean_array", () -> new Boolean[]{true, false}))
-
-            // Attach an error tracker
-            // This must be enabled in the project settings
-            .errorTracker(ERROR_TRACKER)
+            .addMetric(Metric.string("server_version", () -> "1.0.0"))
 
-            .onFlush(() -> gameCount.set(0)) // Reset game count on flush
+            // #onFlush is invoked after successful metrics submission
+            // This is useful for cleaning up cached data
+            .onFlush(() -> gameCount.set(0)) // reset game count on flush
 
-            .debug(true) // Enable debug mode for development and testing
-
-            .token("YOUR_TOKEN_HERE") // required -> token can be found in the settings of your project
-            .create(this);
+            .create();
 
     @Override
     public void onEnable() {
@@ -62,15 +34,6 @@ public void onDisable() {
         metrics.shutdown(); // safely shut down metrics submission
     }
 
-    public void doSomethingWrong() {
-        try {
-            // Do something that might throw an error
-            throw new RuntimeException("Something went wrong!");
-        } catch (final Exception e) {
-            CONTEXT_UNAWARE_ERROR_TRACKER.trackError(e);
-        }
-    }
-
     public void startGame() {
         gameCount.incrementAndGet();
     }

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

@@ -0,0 +1,41 @@
+package dev.faststats.bukkit;
+
+import dev.faststats.SimpleContext;
+import dev.faststats.Token;
+import dev.faststats.config.SimpleConfig;
+import org.bukkit.plugin.Plugin;
+import org.jetbrains.annotations.Contract;
+
+import java.nio.file.Path;
+
+/**
+ * Bukkit FastStats context.
+ *
+ * @since 0.24.0
+ */
+public final class BukkitContext extends SimpleContext {
+    final Plugin plugin;
+
+    public BukkitContext(final Plugin plugin, @Token final String token) {
+        super(SimpleConfig.read(getConfigPath(plugin)), "bukkit", token);
+        this.plugin = plugin;
+    }
+
+    @Override
+    @Contract(value = " -> new", pure = true)
+    public BukkitMetrics.Factory metricsFactory() {
+        return new BukkitMetricsImpl.Factory(this);
+    }
+
+    private static Path getConfigPath(final Plugin plugin) {
+        return getPluginsFolder(plugin).resolve("faststats").resolve("config.properties");
+    }
+
+    private static Path getPluginsFolder(final Plugin plugin) {
+        try {
+            return plugin.getServer().getPluginsFolder().toPath();
+        } catch (final NoSuchMethodError e) {
+            return plugin.getDataFolder().getParentFile().toPath();
+        }
+    }
+}

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

@@ -1,27 +1,16 @@
 package dev.faststats.bukkit;
 
-import dev.faststats.core.Metrics;
+import dev.faststats.Metrics;
+import dev.faststats.data.Metric;
 import org.bukkit.plugin.IllegalPluginAccessException;
 import org.bukkit.plugin.Plugin;
-import org.jetbrains.annotations.Contract;
 
 /**
  * Bukkit metrics implementation.
  *
  * @since 0.1.0
  */
 public sealed interface BukkitMetrics extends Metrics permits BukkitMetricsImpl {
-    /**
-     * Creates a new metrics factory for Bukkit.
-     *
-     * @return the metrics factory
-     * @since 0.1.0
-     */
-    @Contract(pure = true)
-    static Factory factory() {
-        return new BukkitMetricsImpl.Factory();
-    }
-
     /**
      * Registers additional exception handlers on Paper-based implementations.
      *
@@ -32,8 +21,14 @@ static Factory factory() {
     @Override
     void ready() throws IllegalPluginAccessException;
 
-    interface Factory extends Metrics.Factory<Plugin, Factory> {
+    sealed interface Factory extends Metrics.Factory permits BukkitMetricsImpl.Factory {
+        @Override
+        Factory addMetric(Metric<?> metric) throws IllegalArgumentException;
+
+        @Override
+        Factory onFlush(Runnable flush);
+
         @Override
-        BukkitMetrics create(Plugin object) throws IllegalStateException;
+        BukkitMetrics create() throws IllegalStateException;
     }
 }

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

@@ -1,16 +1,15 @@
 package dev.faststats.bukkit;
 
 import com.google.gson.JsonObject;
-import dev.faststats.core.SimpleMetrics;
+import dev.faststats.SimpleMetrics;
+import dev.faststats.config.SimpleConfig;
+import dev.faststats.data.Metric;
 import org.bukkit.plugin.Plugin;
 import org.jetbrains.annotations.Async;
 import org.jetbrains.annotations.Contract;
-import org.jspecify.annotations.Nullable;
 
-import java.nio.file.Path;
 import java.util.Optional;
 import java.util.function.Supplier;
-import java.util.logging.Level;
 
 final class BukkitMetricsImpl extends SimpleMetrics implements BukkitMetrics {
     private final Plugin plugin;
@@ -22,8 +21,8 @@ final class BukkitMetricsImpl extends SimpleMetrics implements BukkitMetrics {
     @Async.Schedule
     @Contract(mutates = "io")
     @SuppressWarnings({"deprecation", "Convert2MethodRef"})
-    private BukkitMetricsImpl(final Factory factory, final Plugin plugin, final Path config) throws IllegalStateException {
-        super(factory, config);
+    private BukkitMetricsImpl(final Factory factory, final Plugin plugin) throws IllegalStateException {
+        super(factory);
 
         this.plugin = plugin;
         final var server = plugin.getServer();
@@ -63,6 +62,11 @@ private boolean isProxyOnlineMode() {
         return settings.getBoolean("bungeecord") && proxies.getBoolean("bungee-cord.online-mode");
     }
 
+    @Override
+    protected boolean preSubmissionStart() {
+        return ((SimpleConfig) context.getConfig()).preSubmissionStart();
+    }
+
     @Override
     protected void appendDefaultData(final JsonObject metrics) {
         metrics.addProperty("minecraft_version", minecraftVersion);
@@ -76,31 +80,17 @@ private int getPlayerCount() {
         try {
             return plugin.getServer().getOnlinePlayers().size();
         } catch (final Throwable t) {
-            error("Failed to get player count", t);
+            logger.error("Failed to get player count", t);
+            // todo: track error?
             return 0;
         }
     }
 
-    @Override
-    protected void printError(final String message, @Nullable final Throwable throwable) {
-        plugin.getLogger().log(Level.SEVERE, message, throwable);
-    }
-
-    @Override
-    protected void printInfo(final String message) {
-        plugin.getLogger().info(message);
-    }
-
-    @Override
-    protected void printWarning(final String message) {
-        plugin.getLogger().warning(message);
-    }
-
     @Override
     public void ready() {
-        if (getErrorTracker().isPresent()) try {
+        try {
             Class.forName("com.destroystokyo.paper.event.server.ServerExceptionEvent");
-            plugin.getServer().getPluginManager().registerEvents(new PaperEventListener(this), plugin);
+            plugin.getServer().getPluginManager().registerEvents(new PaperEventListener(plugin, context), plugin);
         } catch (final ClassNotFoundException ignored) {
         }
     }
@@ -113,20 +103,24 @@ private <T> Optional<T> tryOrEmpty(final Supplier<T> supplier) {
         }
     }
 
-    static final class Factory extends SimpleMetrics.Factory<Plugin, BukkitMetrics.Factory> implements BukkitMetrics.Factory {
+    public static final class Factory extends SimpleMetrics.Factory implements BukkitMetrics.Factory {
+        Factory(final BukkitContext context) {
+            super(context);
+        }
+
         @Override
-        public BukkitMetrics create(final Plugin plugin) throws IllegalStateException {
-            final var dataFolder = getPluginsFolder(plugin).resolve("faststats");
-            final var config = dataFolder.resolve("config.properties");
-            return new BukkitMetricsImpl(this, plugin, config);
+        public Factory addMetric(final Metric<?> metric) throws IllegalArgumentException {
+            return (Factory) super.addMetric(metric);
         }
 
-        private static Path getPluginsFolder(final Plugin plugin) {
-            try {
-                return plugin.getServer().getPluginsFolder().toPath();
-            } catch (final NoSuchMethodError e) {
-                return plugin.getDataFolder().getParentFile().toPath();
-            }
+        @Override
+        public Factory onFlush(final Runnable flush) {
+            return (Factory) super.onFlush(flush);
+        }
+
+        @Override
+        public BukkitMetrics create() throws IllegalStateException {
+            return new BukkitMetricsImpl(this, ((BukkitContext) context).plugin);
         }
     }
 }

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

@@ -2,16 +2,18 @@
 
 import com.destroystokyo.paper.event.server.ServerExceptionEvent;
 import com.destroystokyo.paper.exception.ServerPluginException;
+import dev.faststats.SimpleContext;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
+import org.bukkit.plugin.Plugin;
 
-record PaperEventListener(BukkitMetricsImpl metrics) implements Listener {
+record PaperEventListener(Plugin plugin, SimpleContext context) implements Listener {
     @EventHandler(priority = EventPriority.MONITOR)
     public void onServerException(final ServerExceptionEvent event) {
         if (!(event.getException() instanceof final ServerPluginException exception)) return;
-        if (!exception.getResponsiblePlugin().equals(metrics.plugin())) return;
+        if (!exception.getResponsiblePlugin().equals(plugin)) return;
         final var report = exception.getCause() != null ? exception.getCause() : exception;
-        metrics.getErrorTracker().ifPresent(tracker -> tracker.trackError(report, false));
+        context.errorTrackers().forEach(tracker -> tracker.trackError(report, false));
     }
 }

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

@@ -5,10 +5,11 @@
     exports dev.faststats.bukkit;
 
     requires com.google.gson;
-    requires dev.faststats.core;
+    requires dev.faststats.config;
+    requires dev.faststats;
     requires java.logging;
     requires org.bukkit;
 
     requires static org.jetbrains.annotations;
     requires static org.jspecify;
-}
+}

bungeecord/build.gradle.kts

@@ -6,5 +6,6 @@ repositories {
 
 dependencies {
     api(project(":core"))
+    implementation(project(":config"))
     compileOnly("net.md-5:bungeecord-api:26.1-R0.1-SNAPSHOT")
 }