Analytics: remove AnalyticsService injection in PingCommand and using it from BotCore;

Author: firasrg

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

@@ -6,7 +6,6 @@
 import org.togetherjava.tjbot.config.FeatureBlacklist;
 import org.togetherjava.tjbot.config.FeatureBlacklistConfig;
 import org.togetherjava.tjbot.db.Database;
-import org.togetherjava.tjbot.features.analytics.AnalyticsService;
 import org.togetherjava.tjbot.features.basic.MemberCountDisplayRoutine;
 import org.togetherjava.tjbot.features.basic.PingCommand;
 import org.togetherjava.tjbot.features.basic.QuoteBoardForwarder;
@@ -129,7 +128,6 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         TopHelpersService topHelpersService = new TopHelpersService(database);
         TopHelpersAssignmentRoutine topHelpersAssignmentRoutine =
                 new TopHelpersAssignmentRoutine(config, topHelpersService);
-        AnalyticsService analyticsService = new AnalyticsService(database);
 
         // NOTE The system can add special system relevant commands also by itself,
         // hence this list may not necessarily represent the full list of all commands actually
@@ -186,7 +184,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
 
         // Slash commands
         features.add(new LogLevelCommand());
-        features.add(new PingCommand(analyticsService));
+        features.add(new PingCommand());
         features.add(new TeXCommand());
         features.add(new TagCommand(tagSystem));
         features.add(new TagManageCommand(tagSystem, modAuditLogWriter));

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

@@ -36,49 +36,49 @@ public AnalyticsService(Database database) {
      * This method should be called by commands after they complete execution to track usage
      * patterns and error rates.
      *
-     * @param guildId the guild ID where the command was executed
+     * @param channelId the channel ID where the command was executed
      * @param commandName the name of the command that was executed
      * @param userId the ID of the user who executed the command
      * @param success whether the command executed successfully
      * @param errorMessage optional error message if the command failed (null if successful)
      */
-    public void recordCommandExecution(long guildId, String commandName, long userId,
+    public void recordCommandExecution(long channelId, String commandName, long userId,
             boolean success, @Nullable String errorMessage) {
 
         database.write(context -> context
-            .insertInto(DSL.table("command_usage"), DSL.field("guild_id"),
+            .insertInto(DSL.table("command_usage"), DSL.field("channel_id"),
                     DSL.field("command_name"), DSL.field("user_id"), DSL.field("executed_at"),
                     DSL.field("success"), DSL.field("error_message"))
-            .values(guildId, commandName, userId, DSL.currentTimestamp(), success, errorMessage)
+            .values(channelId, commandName, userId, DSL.currentTimestamp(), success, errorMessage)
             .execute());
 
         if (!success && errorMessage != null) {
-            logger.warn("Command '{}' failed in guild {} with error: {}", commandName, guildId,
+            logger.warn("Command '{}' failed on channel {} with error: {}", commandName, channelId,
                     errorMessage);
         }
     }
 
     /**
      * Records a successful command execution.
      *
-     * @param guildId the guild ID where the command was executed
+     * @param channelId the channel ID where the command was executed
      * @param commandName the name of the command that was executed
      * @param userId the ID of the user who executed the command
      */
-    public void recordCommandSuccess(long guildId, String commandName, long userId) {
-        recordCommandExecution(guildId, commandName, userId, true, null);
+    public void recordCommandSuccess(long channelId, String commandName, long userId) {
+        recordCommandExecution(channelId, commandName, userId, true, null);
     }
 
     /**
      * Records a failed command execution.
      *
-     * @param guildId the guild ID where the command was executed
+     * @param channelId the channel ID where the command was executed
      * @param commandName the name of the command that was executed
      * @param userId the ID of the user who executed the command
      * @param errorMessage a description of what went wrong
      */
-    public void recordCommandFailure(long guildId, String commandName, long userId,
+    public void recordCommandFailure(long channelId, String commandName, long userId,
             String errorMessage) {
-        recordCommandExecution(guildId, commandName, userId, false, errorMessage);
+        recordCommandExecution(channelId, commandName, userId, false, errorMessage);
     }
 }

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

@@ -5,24 +5,19 @@
 
 import org.togetherjava.tjbot.features.CommandVisibility;
 import org.togetherjava.tjbot.features.SlashCommandAdapter;
-import org.togetherjava.tjbot.features.analytics.AnalyticsService;
 
 /**
  * Implementation of an example command to illustrate how to respond to a user.
  * <p>
  * The implemented command is {@code /ping}, upon which the bot will respond with {@code Pong!}.
  */
 public final class PingCommand extends SlashCommandAdapter {
-    private final AnalyticsService analyticsService;
 
     /**
      * Creates an instance of the ping pong command.
-     *
-     * @param analyticsService the analytics service to track command usage
      */
-    public PingCommand(AnalyticsService analyticsService) {
+    public PingCommand() {
         super("ping", "Bot responds with 'Pong!'", CommandVisibility.GUILD);
-        this.analyticsService = analyticsService;
     }
 
     /**
@@ -38,17 +33,6 @@ public void onSlashCommand(SlashCommandInteractionEvent event) {
             return;
         }
 
-        try {
-            event.reply("Pong!").queue();
-
-            analyticsService.recordCommandSuccess(guild.getIdLong(), getName(),
-                    event.getUser().getIdLong());
-
-        } catch (Exception e) {
-            analyticsService.recordCommandFailure(guild.getIdLong(), getName(),
-                    event.getUser().getIdLong(),
-                    e.getMessage() != null ? e.getMessage() : e.getClass().getSimpleName());
-            throw e;
-        }
+        event.reply("Pong!").queue();
     }
 }

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

@@ -23,7 +23,6 @@
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 import net.dv8tion.jda.api.interactions.components.ComponentInteraction;
-import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
 import org.slf4j.Logger;
@@ -42,6 +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.componentids.ComponentId;
 import org.togetherjava.tjbot.features.componentids.ComponentIdParser;
 import org.togetherjava.tjbot.features.componentids.ComponentIdStore;
@@ -79,13 +79,13 @@ public final class BotCore extends ListenerAdapter implements CommandProvider {
     private static final ExecutorService COMMAND_SERVICE = Executors.newCachedThreadPool();
     private static final ScheduledExecutorService ROUTINE_SERVICE =
             Executors.newScheduledThreadPool(5);
-    private final Config config;
     private final Map<String, UserInteractor> prefixedNameToInteractor;
     private final List<Routine> routines;
     private final ComponentIdParser componentIdParser;
     private final ComponentIdStore componentIdStore;
     private final Map<Pattern, MessageReceiver> channelNameToMessageReceiver = new HashMap<>();
     private final Map<Pattern, VoiceReceiver> channelNameToVoiceReceiver = new HashMap<>();
+    private final AnalyticsService analyticsService;
 
     /**
      * Creates a new command system which uses the given database to allow commands to persist data.
@@ -97,9 +97,11 @@ public final class BotCore extends ListenerAdapter implements CommandProvider {
      * @param config the configuration to use for this system
      */
     public BotCore(JDA jda, Database database, Config config) {
-        this.config = config;
         Collection<Feature> features = Features.createFeatures(jda, database, config);
 
+        // Initialize analytics service
+        analyticsService = new AnalyticsService(database);
+
         // Message receivers
         features.stream()
             .filter(MessageReceiver.class::isInstance)
@@ -300,14 +302,14 @@ private Optional<Channel> selectPreferredAudioChannel(@Nullable AudioChannelUnio
     }
 
     @Override
-    public void onGuildVoiceUpdate(@NotNull GuildVoiceUpdateEvent event) {
+    public void onGuildVoiceUpdate(GuildVoiceUpdateEvent event) {
         selectPreferredAudioChannel(event.getChannelJoined(), event.getChannelLeft())
             .ifPresent(channel -> getVoiceReceiversSubscribedTo(channel)
                 .forEach(voiceReceiver -> voiceReceiver.onVoiceUpdate(event)));
     }
 
     @Override
-    public void onGuildVoiceVideo(@NotNull GuildVoiceVideoEvent event) {
+    public void onGuildVoiceVideo(GuildVoiceVideoEvent event) {
         AudioChannelUnion channel = event.getVoiceState().getChannel();
 
         if (channel == null) {
@@ -319,7 +321,7 @@ public void onGuildVoiceVideo(@NotNull GuildVoiceVideoEvent event) {
     }
 
     @Override
-    public void onGuildVoiceStream(@NotNull GuildVoiceStreamEvent event) {
+    public void onGuildVoiceStream(GuildVoiceStreamEvent event) {
         AudioChannelUnion channel = event.getVoiceState().getChannel();
 
         if (channel == null) {
@@ -331,7 +333,7 @@ public void onGuildVoiceStream(@NotNull GuildVoiceStreamEvent event) {
     }
 
     @Override
-    public void onGuildVoiceMute(@NotNull GuildVoiceMuteEvent event) {
+    public void onGuildVoiceMute(GuildVoiceMuteEvent event) {
         AudioChannelUnion channel = event.getVoiceState().getChannel();
 
         if (channel == null) {
@@ -343,7 +345,7 @@ public void onGuildVoiceMute(@NotNull GuildVoiceMuteEvent event) {
     }
 
     @Override
-    public void onGuildVoiceDeafen(@NotNull GuildVoiceDeafenEvent event) {
+    public void onGuildVoiceDeafen(GuildVoiceDeafenEvent event) {
         AudioChannelUnion channel = event.getVoiceState().getChannel();
 
         if (channel == null) {
@@ -380,10 +382,24 @@ public void onSlashCommandInteraction(SlashCommandInteractionEvent event) {
 
         logger.debug("Received slash command '{}' (#{}) on guild '{}'", name, event.getId(),
                 event.getGuild());
-        COMMAND_SERVICE.execute(
-                () -> requireUserInteractor(UserInteractionType.SLASH_COMMAND.getPrefixedName(name),
+        COMMAND_SERVICE.execute(() -> {
+            try {
+                requireUserInteractor(UserInteractionType.SLASH_COMMAND.getPrefixedName(name),
                         SlashCommand.class)
-                    .onSlashCommand(event));
+                    .onSlashCommand(event);
+
+
+                analyticsService.recordCommandSuccess(event.getChannel().getIdLong(), name,
+                        event.getUser().getIdLong());
+            } catch (Exception ex) {
+
+                analyticsService.recordCommandFailure(event.getChannel().getIdLong(), name,
+                        event.getUser().getIdLong(),
+                        ex.getMessage() != null ? ex.getMessage() : ex.getClass().getSimpleName());
+
+                throw ex;
+            }
+        });
     }
 
     @Override

application/src/main/resources/db/V16__Add_Analytics_System.sql

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

application/src/test/java/org/togetherjava/tjbot/features/basic/PingCommandTest.java

@@ -6,16 +6,13 @@
 import org.junit.jupiter.api.Test;
 
 import org.togetherjava.tjbot.features.SlashCommand;
-import org.togetherjava.tjbot.features.analytics.AnalyticsService;
 import org.togetherjava.tjbot.jda.JdaTester;
 
-import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 
 final class PingCommandTest {
     private JdaTester jdaTester;
     private SlashCommand command;
-    private AnalyticsService analyticsService;
 
     private SlashCommandInteractionEvent triggerSlashCommand() {
         SlashCommandInteractionEvent event =
@@ -27,8 +24,7 @@ private SlashCommandInteractionEvent triggerSlashCommand() {
     @BeforeEach
     void setUp() {
         jdaTester = new JdaTester();
-        analyticsService = mock(AnalyticsService.class);
-        command = jdaTester.spySlashCommand(new PingCommand(analyticsService));
+        command = jdaTester.spySlashCommand(new PingCommand());
     }
 
     @Test