Analytics: applies changes for zabuzard 1st CR;

Author: firasrg

application/src/main/java/org/togetherjava/tjbot/Application.java

@@ -12,6 +12,7 @@
 import org.togetherjava.tjbot.db.Database;
 import org.togetherjava.tjbot.features.Features;
 import org.togetherjava.tjbot.features.SlashCommandAdapter;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 import org.togetherjava.tjbot.features.system.BotCore;
 import org.togetherjava.tjbot.logging.LogMarkers;
 import org.togetherjava.tjbot.logging.discord.DiscordLogging;
@@ -82,13 +83,15 @@ public static void runBot(Config config) {
             }
             Database database = new Database("jdbc:sqlite:" + databasePath.toAbsolutePath());
 
+            Metrics metrics = new Metrics(database);
+
             JDA jda = JDABuilder.createDefault(config.getToken())
                 .enableIntents(GatewayIntent.GUILD_MEMBERS, GatewayIntent.MESSAGE_CONTENT)
                 .build();
 
             jda.awaitReady();
 
-            BotCore core = new BotCore(jda, database, config);
+            BotCore core = new BotCore(jda, database, config, metrics);
             CommandReloading.reloadCommands(jda, core);
             core.scheduleRoutines(jda);
 

application/src/main/java/org/togetherjava/tjbot/features/Features.java

@@ -6,6 +6,7 @@
 import org.togetherjava.tjbot.config.FeatureBlacklist;
 import org.togetherjava.tjbot.config.FeatureBlacklistConfig;
 import org.togetherjava.tjbot.db.Database;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 import org.togetherjava.tjbot.features.basic.MemberCountDisplayRoutine;
 import org.togetherjava.tjbot.features.basic.PingCommand;
 import org.togetherjava.tjbot.features.basic.QuoteBoardForwarder;
@@ -91,7 +92,7 @@
  * it with the system.
  * <p>
  * To add a new slash command, extend the commands returned by
- * {@link #createFeatures(JDA, Database, Config)}.
+ * {@link #createFeatures(JDA, Database, Config, Metrics)}.
  */
 public class Features {
     private Features() {
@@ -107,9 +108,12 @@ private Features() {
      * @param jda the JDA instance commands will be registered at
      * @param database the database of the application, which features can use to persist data
      * @param config the configuration features should use
+     * @param metrics the metrics service for tracking analytics
      * @return a collection of all features
      */
-    public static Collection<Feature> createFeatures(JDA jda, Database database, Config config) {
+    @SuppressWarnings("unused")
+    public static Collection<Feature> createFeatures(JDA jda, Database database, Config config,
+            Metrics metrics) {
         FeatureBlacklistConfig blacklistConfig = config.getFeatureBlacklistConfig();
         JShellEval jshellEval = new JShellEval(config.getJshell(), config.getGitHubApiKey());
 

application/src/main/java/org/togetherjava/tjbot/features/analytics/AnalyticsService.java

@@ -0,0 +1,59 @@
+package org.togetherjava.tjbot.features.analytics;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import org.togetherjava.tjbot.db.Database;
+import org.togetherjava.tjbot.db.generated.tables.Analytics;
+
+import java.time.Instant;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+
+/**
+ * Service for tracking and recording events for analytics purposes.
+ */
+public final class Metrics {
+    private static final Logger logger = LoggerFactory.getLogger(Metrics.class);
+
+    private final Database database;
+
+    private final ExecutorService service = Executors.newSingleThreadExecutor();
+
+    /**
+     * Creates a new instance.
+     *
+     * @param database the database to use for storing and retrieving analytics data
+     */
+    public Metrics(Database database) {
+        this.database = database;
+    }
+
+    /**
+     * Track an event execution.
+     *
+     * @param event the event to save
+     */
+    public void count(String event) {
+        logger.debug("Counting new record for event: {}", event);
+        Instant moment = Instant.now();
+        service.submit(() -> persist(event, moment));
+
+        logger.debug("Event {} new record saved successfully", event);
+    }
+
+    /**
+     *
+     * @param event the event to save
+     * @param moment the moment when the event is dispatched
+     */
+    private void persist(String event, Instant moment) {
+        logger.debug("Persisting event: {}, at {}", event, moment);
+        database.write(context -> context.newRecord(Analytics.ANALYTICS)
+            .setEvent(event)
+            .setHappenedAt(moment)
+            .insert());
+        logger.debug("Event {} persisted successfully", event);
+    }
+
+}

application/src/main/java/org/togetherjava/tjbot/features/analytics/Metrics.java

@@ -2,7 +2,7 @@
  * Analytics system for collecting and persisting bot activity metrics.
  * <p>
  * This package provides services and components that record events for later analysis and reporting
- * across multiple feature areas, not limited to commands.
+ * across multiple feature areas.
  */
 @MethodsReturnNonnullByDefault
 @ParametersAreNonnullByDefault

application/src/main/java/org/togetherjava/tjbot/features/analytics/package-info.java

@@ -1,6 +1,5 @@
 package org.togetherjava.tjbot.features.basic;
 
-import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
 
 import org.togetherjava.tjbot.features.CommandVisibility;
@@ -12,7 +11,6 @@
  * The implemented command is {@code /ping}, upon which the bot will respond with {@code Pong!}.
  */
 public final class PingCommand extends SlashCommandAdapter {
-
     /**
      * Creates an instance of the ping pong command.
      */
@@ -27,12 +25,6 @@ public PingCommand() {
      */
     @Override
     public void onSlashCommand(SlashCommandInteractionEvent event) {
-        Guild guild = event.getGuild();
-        if (guild == null) {
-            event.reply("This command can only be used in a server!").setEphemeral(true).queue();
-            return;
-        }
-
         event.reply("Pong!").queue();
     }
 }

application/src/main/java/org/togetherjava/tjbot/features/basic/PingCommand.java

@@ -41,7 +41,7 @@
 import org.togetherjava.tjbot.features.UserInteractionType;
 import org.togetherjava.tjbot.features.UserInteractor;
 import org.togetherjava.tjbot.features.VoiceReceiver;
-import org.togetherjava.tjbot.features.analytics.AnalyticsService;
+import org.togetherjava.tjbot.features.analytics.Metrics;
 import org.togetherjava.tjbot.features.componentids.ComponentId;
 import org.togetherjava.tjbot.features.componentids.ComponentIdParser;
 import org.togetherjava.tjbot.features.componentids.ComponentIdStore;
@@ -85,7 +85,7 @@ public final class BotCore extends ListenerAdapter implements CommandProvider {
     private final ComponentIdStore componentIdStore;
     private final Map<Pattern, MessageReceiver> channelNameToMessageReceiver = new HashMap<>();
     private final Map<Pattern, VoiceReceiver> channelNameToVoiceReceiver = new HashMap<>();
-    private final AnalyticsService analyticsService;
+    private final Metrics metrics;
 
     /**
      * Creates a new command system which uses the given database to allow commands to persist data.
@@ -95,12 +95,11 @@ public final class BotCore extends ListenerAdapter implements CommandProvider {
      * @param jda the JDA instance that this command system will be used with
      * @param database the database that commands may use to persist data
      * @param config the configuration to use for this system
+     * @param metrics the metrics service for tracking analytics
      */
-    public BotCore(JDA jda, Database database, Config config) {
-        Collection<Feature> features = Features.createFeatures(jda, database, config);
-
-        // Initialize analytics service
-        analyticsService = new AnalyticsService(database);
+    public BotCore(JDA jda, Database database, Config config, Metrics metrics) {
+        this.metrics = metrics;
+        Collection<Feature> features = Features.createFeatures(jda, database, config, metrics);
 
         // Message receivers
         features.stream()
@@ -383,22 +382,14 @@ public void onSlashCommandInteraction(SlashCommandInteractionEvent event) {
         logger.debug("Received slash command '{}' (#{}) on guild '{}'", name, event.getId(),
                 event.getGuild());
         COMMAND_SERVICE.execute(() -> {
-            try {
-                requireUserInteractor(UserInteractionType.SLASH_COMMAND.getPrefixedName(name),
-                        SlashCommand.class)
-                    .onSlashCommand(event);
 
+            SlashCommand interactor = requireUserInteractor(
+                    UserInteractionType.SLASH_COMMAND.getPrefixedName(name), SlashCommand.class);
 
-                analyticsService.recordCommandSuccess(event.getChannel().getIdLong(), name,
-                        event.getUser().getIdLong());
-            } catch (Exception ex) {
+            metrics.count("slash-" + name);
 
-                analyticsService.recordCommandFailure(event.getChannel().getIdLong(), name,
-                        event.getUser().getIdLong(),
-                        ex.getMessage() != null ? ex.getMessage() : ex.getClass().getSimpleName());
+            interactor.onSlashCommand(event);
 
-                throw ex;
-            }
         });
     }
 

application/src/main/java/org/togetherjava/tjbot/features/system/BotCore.java

@@ -1,13 +1,6 @@
-CREATE TABLE command_usage
+CREATE TABLE analytics
 (
-    id            INTEGER PRIMARY KEY AUTOINCREMENT,
-    channel_id    BIGINT  NOT NULL,
-    command_name  TEXT    NOT NULL,
-    user_id       BIGINT  NOT NULL,
-    executed_at   TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    success       BOOLEAN NOT NULL DEFAULT TRUE,
-    error_message TEXT
+    id          INTEGER PRIMARY KEY AUTOINCREMENT,
+    event       TEXT      NOT NULL,
+    happened_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
 );
-
-CREATE INDEX idx_command_usage_channel ON command_usage(channel_id);
-CREATE INDEX idx_command_usage_command_name ON command_usage(command_name);