Added injection support for platform context

Author: NonSwag

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

@@ -5,38 +5,30 @@
 import dev.faststats.Metrics;
 import dev.faststats.data.Metric;
 import dev.faststats.sponge.SpongeContext;
-import org.apache.logging.log4j.Logger;
 import org.jspecify.annotations.Nullable;
 import org.spongepowered.api.Server;
-import org.spongepowered.api.config.ConfigDir;
 import org.spongepowered.api.event.Listener;
 import org.spongepowered.api.event.lifecycle.StartedEngineEvent;
 import org.spongepowered.api.event.lifecycle.StoppingEngineEvent;
-import org.spongepowered.plugin.PluginContainer;
 import org.spongepowered.plugin.builtin.jvm.Plugin;
 
-import java.nio.file.Path;
-
 @Plugin("example")
 public class ExamplePlugin {
-    private @Inject PluginContainer pluginContainer;
-    private @Inject Logger logger;
-    private @ConfigDir(sharedRoot = true)
-    @Inject Path dataDirectory;
+    private @Inject SpongeContext.Builder contextBuilder;
 
     private @Nullable Metrics metrics = null;
 
     @Listener
     public void onServerStart(final StartedEngineEvent<Server> event) {
-        final var context = new SpongeContext(pluginContainer, logger, dataDirectory, "YOUR_TOKEN_HERE");
+        final var context = contextBuilder.build("YOUR_TOKEN_HERE");
         this.metrics = context.metrics()
                 // Custom metrics require a corresponding data source in your project settings
                 .addMetric(Metric.number("example_metric", () -> 42))
 
                 // Error tracking must be enabled in the project settings
                 .errorTracker(ErrorTracker.contextAware())
 
-                .create(pluginContainer);
+                .create();
     }
 
     @Listener

sponge/src/main/java/dev/faststats/sponge/SpongeContext.java

@@ -1,5 +1,6 @@
 package dev.faststats.sponge;
 
+import com.google.inject.Inject;
 import dev.faststats.SimpleContext;
 import dev.faststats.Token;
 import org.apache.logging.log4j.Logger;
@@ -21,7 +22,7 @@ public SpongeContext(
             final PluginContainer plugin,
             final Logger logger,
             @ConfigDir(sharedRoot = true) final Path dataDirectory,
-            @Token final String token // fixme: cannot have a token here
+            @Token final String token
     ) {
         super(SpongeConfig.read(plugin, dataDirectory.resolve("faststats").resolve("config.properties")), token);
         this.plugin = plugin;
@@ -32,4 +33,47 @@ public SpongeContext(
     public SpongeMetrics.Factory metrics() {
         return new SpongeMetrics.Factory(this);
     }
+
+    /**
+     * Injectable Sponge context builder.
+     *
+     * @since 0.23.0
+     */
+    public static final class Builder {
+        private final PluginContainer plugin;
+        private final Logger logger;
+        private final Path dataDirectory;
+
+        /**
+         * Creates a new Sponge context builder.
+         *
+         * @param plugin        the plugin container
+         * @param logger        the plugin logger
+         * @param dataDirectory the shared Sponge config directory
+         * @apiNote This instance can be injected into your plugin.
+         * @since 0.23.0
+         */
+        @Inject
+        public Builder(
+                final PluginContainer plugin,
+                final Logger logger,
+                @ConfigDir(sharedRoot = true) final Path dataDirectory
+        ) {
+            this.plugin = plugin;
+            this.logger = logger;
+            this.dataDirectory = dataDirectory;
+        }
+
+        /**
+         * Builds the finalized Sponge context.
+         *
+         * @param token the FastStats project token
+         * @return the Sponge context
+         * @throws IllegalArgumentException if the token is invalid
+         * @since 0.23.0
+         */
+        public SpongeContext build(@Token final String token) throws IllegalArgumentException {
+            return new SpongeContext(plugin, logger, dataDirectory, token);
+        }
+    }
 }

sponge/src/main/java/dev/faststats/sponge/SpongeMetricsImpl.java

@@ -41,7 +41,7 @@ protected void appendDefaultData(final JsonObject metrics) {
         metrics.addProperty("server_type", Sponge.platform().container(Platform.Component.IMPLEMENTATION).metadata().id());
     }
 
-    static class Factory extends SimpleMetrics.Factory<SpongeMetrics.Factory> {
+    static class Factory extends SimpleMetrics.Factory {
         public Factory(final FastStatsContext context) {
             super(context);
         }

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

@@ -5,16 +5,11 @@
 import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
 import com.velocitypowered.api.event.proxy.ProxyShutdownEvent;
 import com.velocitypowered.api.plugin.Plugin;
-import com.velocitypowered.api.plugin.annotation.DataDirectory;
-import com.velocitypowered.api.proxy.ProxyServer;
 import dev.faststats.ErrorTracker;
 import dev.faststats.Metrics;
 import dev.faststats.data.Metric;
 import dev.faststats.velocity.VelocityContext;
 import org.jspecify.annotations.Nullable;
-import org.slf4j.Logger;
-
-import java.nio.file.Path;
 
 @Plugin(id = "example", name = "Example Plugin", version = "1.0.0",
         url = "https://example.com", authors = {"Your Name"})
@@ -23,8 +18,8 @@ public class ExamplePlugin {
     private @Nullable Metrics metrics = null;
 
     @Inject
-    public ExamplePlugin(final ProxyServer server, final Logger logger, @DataDirectory final Path dataDirectory) {
-        this.context = new VelocityContext(server, logger, dataDirectory, "YOUR_TOKEN_HERE");
+    public ExamplePlugin(final VelocityContext.Builder contextBuilder) {
+        this.context = contextBuilder.build("YOUR_TOKEN_HERE");
     }
 
     @Subscribe
@@ -36,7 +31,7 @@ public void onProxyInitialize(final ProxyInitializeEvent event) {
                 // Error tracking must be enabled in the project settings
                 .errorTracker(ErrorTracker.contextAware())
 
-                .create(this);
+                .create();
     }
 
     @Subscribe

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

@@ -1,9 +1,11 @@
 package dev.faststats.velocity;
 
+import com.google.inject.Inject;
+import com.velocitypowered.api.plugin.PluginContainer;
 import com.velocitypowered.api.plugin.annotation.DataDirectory;
 import com.velocitypowered.api.proxy.ProxyServer;
 import dev.faststats.Config;
-import dev.faststats.FastStatsContext;
+import dev.faststats.SimpleContext;
 import dev.faststats.Token;
 import dev.faststats.config.SimpleConfig;
 import org.slf4j.Logger;
@@ -15,35 +17,85 @@
  *
  * @since 0.23.0
  */
-public final class VelocityContext extends FastStatsContext {
+public final class VelocityContext extends SimpleContext {
+    private final PluginContainer plugin;
     private final ProxyServer server;
     private final Logger logger;
     private final Path dataDirectory;
 
     public VelocityContext(
             final Config config,
+            final PluginContainer plugin,
             final ProxyServer server,
             final Logger logger,
             final Path dataDirectory,
             @Token final String token
     ) {
         super(config, token);
+        this.plugin = plugin;
         this.server = server;
         this.logger = logger;
         this.dataDirectory = dataDirectory;
     }
 
     public VelocityContext(
+            final PluginContainer plugin,
             final ProxyServer server,
             final Logger logger,
             @DataDirectory final Path dataDirectory,
             @Token final String token
     ) {
-        this(SimpleConfig.read(dataDirectory.resolveSibling("faststats").resolve("config.properties")), server, logger, dataDirectory, token);
+        this(SimpleConfig.read(dataDirectory.resolveSibling("faststats").resolve("config.properties")), plugin, server, logger, dataDirectory, token);
     }
 
     @Override
     public VelocityMetrics.Factory metrics() {
-        return new VelocityMetrics.Factory(this, server, logger, dataDirectory);
+        return new VelocityMetrics.Factory(this, plugin, server, logger, dataDirectory);
+    }
+
+    /**
+     * Injectable Velocity context builder.
+     *
+     * @since 0.23.0
+     */
+    public static final class Builder {
+        private final PluginContainer plugin;
+        private final ProxyServer server;
+        private final Logger logger;
+        private final Path dataDirectory;
+
+        /**
+         * Creates a new Velocity context builder.
+         *
+         * @param server        the velocity server
+         * @param logger        the plugin logger
+         * @param dataDirectory the plugin data directory
+         * @apiNote This instance can be injected into your plugin.
+         * @since 0.23.0
+         */
+        @Inject
+        public Builder(
+                final PluginContainer plugin,
+                final ProxyServer server,
+                final Logger logger,
+                @DataDirectory final Path dataDirectory
+        ) {
+            this.plugin = plugin;
+            this.server = server;
+            this.logger = logger;
+            this.dataDirectory = dataDirectory;
+        }
+
+        /**
+         * Builds the finalized Velocity context.
+         *
+         * @param token the FastStats project token
+         * @return the Velocity context
+         * @throws IllegalArgumentException if the token is invalid
+         * @since 0.23.0
+         */
+        public VelocityContext build(@Token final String token) throws IllegalArgumentException {
+            return new VelocityContext(plugin, server, logger, dataDirectory, token);
+        }
     }
 }

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

@@ -1,6 +1,6 @@
 package dev.faststats.velocity;
 
-import com.google.inject.Inject;
+import com.velocitypowered.api.plugin.PluginContainer;
 import com.velocitypowered.api.plugin.annotation.DataDirectory;
 import com.velocitypowered.api.proxy.ProxyServer;
 import dev.faststats.Metrics;
@@ -15,22 +15,14 @@
  */
 public sealed interface VelocityMetrics extends Metrics permits VelocityMetricsImpl {
     final class Factory extends VelocityMetricsImpl.Factory {
-        public Factory(final VelocityContext context, final ProxyServer server, final Logger logger, @DataDirectory final Path dataDirectory) {
-            super(context, server, logger, dataDirectory);
-        }
-
-        /**
-         * Creates a new metrics factory for Velocity.
-         *
-         * @param server        the velocity server
-         * @param logger        the logger
-         * @param dataDirectory the data directory
-         * @apiNote This instance is automatically injected into your plugin.
-         * @since 0.1.0
-         */
-        @Inject
-        private Factory(final ProxyServer server, final Logger logger, @DataDirectory final Path dataDirectory) {
-            super(server, logger, dataDirectory);
+        public Factory(
+                final VelocityContext context,
+                final PluginContainer plugin,
+                final ProxyServer server,
+                final Logger logger,
+                @DataDirectory final Path dataDirectory
+        ) {
+            super(context, plugin, server, logger, dataDirectory);
         }
     }
 }

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

@@ -51,17 +51,21 @@ protected void appendDefaultData(final JsonObject metrics) {
         metrics.addProperty("server_type", server.getVersion().getName());
     }
 
-    static class Factory extends SimpleMetrics.Factory<VelocityMetrics.Factory> {
+    static class Factory extends SimpleMetrics.Factory {
         protected final Logger logger;
         protected final Path dataDirectory;
         protected final ProxyServer server;
+        protected final PluginContainer plugin;
 
-        public Factory(final ProxyServer server, final Logger logger, @DataDirectory final Path dataDirectory) {
-            this(null, server, logger, dataDirectory);
-        }
-
-        public Factory(final FastStatsContext context, final ProxyServer server, final Logger logger, @DataDirectory final Path dataDirectory) {
+        public Factory(
+                final FastStatsContext context,
+                final PluginContainer plugin,
+                final ProxyServer server,
+                final Logger logger,
+                @DataDirectory final Path dataDirectory
+        ) {
             super(context);
+            this.plugin = plugin;
             this.logger = logger;
             this.dataDirectory = dataDirectory;
             this.server = server;
@@ -72,21 +76,13 @@ public Factory(final FastStatsContext context, final ProxyServer server, final L
          * <p>
          * Metrics submission will start automatically.
          *
-         * @param plugin the plugin instance
          * @return the metrics instance
          * @throws IllegalStateException    if the token is not specified
-         * @throws IllegalArgumentException if the given object is not a valid plugin
-         * @see #token(String)
          * @since 0.23.0
          */
         @Override
-        public Metrics create(final Object plugin) throws IllegalStateException, IllegalArgumentException {
-            final var faststats = dataDirectory.resolveSibling("faststats");
-            final var container = server.getPluginManager().ensurePluginContainer(plugin);
-            final var config = hasContext()
-                    ? getConfigOrThrow()
-                    : SimpleConfig.read(faststats.resolve("config.properties"));
-            return new VelocityMetricsImpl(this, logger, server, config, container);
+        public Metrics create() throws IllegalStateException {
+            return new VelocityMetricsImpl(this, logger, server, context.getConfig(), plugin);
         }
     }
 }