Add a stats module. Track trick uses

config/src/main/groovy/net/neoforged/camelot/config/module/Statistics.groovy

@@ -0,0 +1,14 @@
+package net.neoforged.camelot.config.module
+
+import groovy.transform.CompileStatic
+
+/**
+ * The module tracking different statistics.
+ */
+@CompileStatic
+class Statistics extends ModuleConfiguration {
+    /**
+     * Track trick statistics (number of uses, and type).
+     */
+    boolean tricks = true
+}

src/main/java/net/neoforged/camelot/BotMain.java

@@ -21,6 +21,7 @@
 import net.neoforged.camelot.configuration.ConfigMigrator;
 import net.neoforged.camelot.db.transactionals.LoggingChannelsDAO;
 import net.neoforged.camelot.db.transactionals.PendingUnbansDAO;
+import net.neoforged.camelot.db.transactionals.StatsDAO;
 import net.neoforged.camelot.listener.CountersListener;
 import net.neoforged.camelot.listener.DismissListener;
 import net.neoforged.camelot.listener.ReferencingListener;
@@ -29,11 +30,13 @@
 import net.neoforged.camelot.log.MessageLogging;
 import net.neoforged.camelot.log.ModerationActionRecorder;
 import net.neoforged.camelot.module.CamelotModule;
+import net.neoforged.camelot.module.StatsModule;
 import net.neoforged.camelot.util.AuthUtil;
 import net.neoforged.camelot.util.Utils;
 import net.neoforged.camelot.util.jda.ButtonManager;
 import org.codehaus.groovy.control.CompilerConfiguration;
 import org.codehaus.groovy.control.customizers.ImportCustomizer;
+import org.jdbi.v3.core.extension.ExtensionConsumer;
 import org.jetbrains.annotations.NotNull;
 import org.kohsuke.github.GitHubBuilder;
 import org.slf4j.Logger;
@@ -302,4 +305,14 @@ private static <T> T newInstance(Class<T> type) {
             throw new RuntimeException(e);
         }
     }
+
+    /**
+     * Use the stats extension of the given {@code type}.
+     */
+    public static <T extends StatsDAO> void stats(Class<T> type, ExtensionConsumer<T, RuntimeException> dao) {
+        var module = getModule(StatsModule.class);
+        if (module != null) {
+            module.use(type, dao);
+        }
+    }
 }

src/main/java/net/neoforged/camelot/Database.java

@@ -33,7 +33,7 @@ public class Database {
     /**
      * Static JDBI main instance. Can be accessed via {@link #main()}.
      */
-    public static Jdbi main;
+    private static Jdbi main;
 
     /**
      * {@return the static main JDBI instance}
@@ -54,7 +54,7 @@ public static Jdbi pings() {
         return pings;
     }
 
-    public static Jdbi appeals;
+    private static Jdbi appeals;
 
     /**
      * {@return the static appeals DB JDBI instance}
@@ -63,6 +63,15 @@ public static Jdbi appeals() {
         return appeals;
     }
 
+    private static Jdbi stats;
+
+    /**
+     * {@return the stats DB JDBI instance}
+     */
+    public static Jdbi stats() {
+        return stats;
+    }
+
     /**
      * Initialises the databases.
      */
@@ -83,6 +92,7 @@ static void init() throws IOException {
         main = createDatabaseConnection(mainDb, "main");
         pings = createDatabaseConnection(dir.resolve("pings.db"), "pings");
         appeals = createDatabaseConnection(dir.resolve("appeals.db"), "appeals");
+        stats = createDatabaseConnection(dir.resolve("stats.db"), "stats");
         CustomPingListener.requestRefresh();
     }
 

src/main/java/net/neoforged/camelot/commands/utility/ManageTrickCommand.java

@@ -31,6 +31,7 @@
 import net.neoforged.camelot.db.schemas.SlashTrick;
 import net.neoforged.camelot.db.schemas.Trick;
 import net.neoforged.camelot.db.transactionals.SlashTricksDAO;
+import net.neoforged.camelot.db.transactionals.StatsDAO;
 import net.neoforged.camelot.db.transactionals.TricksDAO;
 import net.neoforged.camelot.listener.ReferencingListener;
 import net.neoforged.camelot.module.TricksModule;
@@ -440,12 +441,18 @@ protected void execute(SlashCommandEvent event) {
 
             try {
                 embed.addField("Description", ScriptUtils.getInformation(trick.script()).description(), false);
-            } catch (CannotRetrieveInformationException ignored) {
+            } catch (CannotRetrieveInformationException _) {
 
             }
 
             embed.addField("Owner", "<@" + trick.owner() + "> (" + trick.owner() + ")", false);
 
+            BotMain.stats(StatsDAO.Tricks.class, extension -> {
+                final int prefix = extension.getPrefixUses(trick.id());
+                final int slash = extension.getSlashUses(trick.id());
+                embed.addField("Stats", "Uses: **" + (prefix + slash) + "** total: **" + prefix + "** prefix, **" + slash + "** slash", false);
+            });
+
             event.getHook().editOriginalEmbeds(embed.build()).queue();
         }
 

src/main/java/net/neoforged/camelot/commands/utility/TrickCommand.java

@@ -9,7 +9,9 @@
 import net.dv8tion.jda.api.requests.RestAction;
 import net.dv8tion.jda.api.utils.messages.MessageCreateData;
 import net.dv8tion.jda.api.utils.messages.MessageEditData;
+import net.neoforged.camelot.BotMain;
 import net.neoforged.camelot.db.schemas.Trick;
+import net.neoforged.camelot.db.transactionals.StatsDAO;
 import net.neoforged.camelot.script.ScriptContext;
 import net.neoforged.camelot.script.ScriptReplier;
 import net.neoforged.camelot.script.ScriptUtils;
@@ -49,6 +51,8 @@ protected RestAction<?> doSend(MessageCreateData createData) {
         }, trick.privileged());
 
         ScriptUtils.submitExecution(context, trick.script(), args);
+
+        BotMain.stats(StatsDAO.Tricks.class, extension -> extension.incrementSlashUses(trick.id()));
     }
 
     @Override

src/main/java/net/neoforged/camelot/db/transactionals/StatsDAO.java

@@ -0,0 +1,33 @@
+package net.neoforged.camelot.db.transactionals;
+
+import org.jdbi.v3.sqlobject.customizer.Bind;
+import org.jdbi.v3.sqlobject.statement.SqlQuery;
+import org.jdbi.v3.sqlobject.statement.SqlUpdate;
+import org.jdbi.v3.sqlobject.transaction.Transactional;
+
+/**
+ * Transactionals used to interact with statistics.
+ */
+public interface StatsDAO {
+    /**
+     * Trick statistics
+     */
+    interface Tricks extends Transactional<Tricks>, StatsDAO {
+        @SqlUpdate("insert into trick_stats (trick, prefix_uses, slash_uses) values(:trick, 1, 0) on conflict(trick) do update set prefix_uses = prefix_uses + 1")
+        void incrementPrefixUses(@Bind("trick") int trickId);
+        @SqlUpdate("insert into trick_stats (trick, prefix_uses, slash_uses) values(:trick, 0, 1) on conflict(trick) do update set slash_uses = slash_uses + 1")
+        void incrementSlashUses(@Bind("trick") int trickId);
+
+        default int getPrefixUses(int trickId) {
+            return getHandle().createQuery("select prefix_uses from trick_stats where trick = ?")
+                    .bind(0, trickId)
+                    .execute((statementSupplier, _) -> statementSupplier.get().getResultSet().getInt("prefix_uses"));
+        }
+
+        default int getSlashUses(int trickId) {
+            return getHandle().createQuery("select slash_uses from trick_stats where trick = ?")
+                    .bind(0, trickId)
+                    .execute((statementSupplier, _) -> statementSupplier.get().getResultSet().getInt("slash_uses"));
+        }
+    }
+}

src/main/java/net/neoforged/camelot/listener/TrickListener.java

@@ -15,6 +15,7 @@
 import net.neoforged.camelot.Database;
 import net.neoforged.camelot.db.schemas.SlashTrick;
 import net.neoforged.camelot.db.transactionals.SlashTricksDAO;
+import net.neoforged.camelot.db.transactionals.StatsDAO;
 import net.neoforged.camelot.module.TricksModule;
 import net.neoforged.camelot.script.ScriptContext;
 import net.neoforged.camelot.script.ScriptReplier;
@@ -96,6 +97,8 @@ protected RestAction<?> doSend(MessageCreateData createData) {
             }, trick.privileged());
 
             ScriptUtils.submitExecution(context, trick.script(), args);
+
+            BotMain.stats(StatsDAO.Tricks.class, extension -> extension.incrementPrefixUses(trick.id()));
         }
     }
 }

src/main/java/net/neoforged/camelot/module/StatsModule.java

@@ -0,0 +1,30 @@
+package net.neoforged.camelot.module;
+
+import com.google.auto.service.AutoService;
+import net.neoforged.camelot.Database;
+import net.neoforged.camelot.config.module.Statistics;
+import net.neoforged.camelot.db.transactionals.StatsDAO;
+import org.jdbi.v3.core.extension.ExtensionConsumer;
+
+/**
+ * The module used to track statistics.
+ */
+@AutoService(CamelotModule.class)
+public class StatsModule extends CamelotModule.Base<Statistics> {
+    public StatsModule() {
+        super(Statistics.class);
+    }
+
+    @Override
+    public String id() {
+        return "stats";
+    }
+
+    /**
+     * Use the extension of the given {@code type}.
+     */
+    public <T extends StatsDAO> void use(Class<T> type, ExtensionConsumer<T, RuntimeException> dao) {
+        if (type == StatsDAO.Tricks.class && !config().isTricks()) return;
+        Database.stats().useExtension(type, dao);
+    }
+}

src/main/java/net/neoforged/camelot/script/SlashTrickManager.java

@@ -20,9 +20,11 @@
 import net.dv8tion.jda.api.requests.restaction.CommandListUpdateAction;
 import net.dv8tion.jda.api.utils.messages.MessageCreateData;
 import net.dv8tion.jda.api.utils.messages.MessageEditData;
+import net.neoforged.camelot.BotMain;
 import net.neoforged.camelot.db.schemas.SlashTrick;
 import net.neoforged.camelot.db.schemas.Trick;
 import net.neoforged.camelot.db.transactionals.SlashTricksDAO;
+import net.neoforged.camelot.db.transactionals.StatsDAO;
 import net.neoforged.camelot.db.transactionals.TricksDAO;
 import net.neoforged.camelot.module.TricksModule;
 import net.neoforged.camelot.script.option.EnumOptionHandler;
@@ -142,6 +144,8 @@ protected RestAction<?> doSend(MessageCreateData createData) {
                 }, trick.privileged());
 
                 ScriptUtils.submitExecution(context, trick.script(), options);
+
+                BotMain.stats(StatsDAO.Tricks.class, extension -> extension.incrementSlashUses(trick.id()));
             }
             default -> {}
         }

src/main/resources/db/stats/V1__trick_stats.sql

@@ -0,0 +1,8 @@
+create table trick_stats
+(
+    -- the trick these stats are associated with
+    trick       integer not null primary key,
+
+    prefix_uses integer,
+    slash_uses  integer
+) without rowid;