Moved message purging into routine

Author: Zabuzard

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

@@ -15,6 +15,7 @@
 import org.togetherjava.tjbot.commands.tags.TagsCommand;
 import org.togetherjava.tjbot.commands.tophelper.TopHelpersCommand;
 import org.togetherjava.tjbot.commands.tophelper.TopHelpersMessageListener;
+import org.togetherjava.tjbot.commands.tophelper.TopHelpersPurgeMessagesRoutine;
 import org.togetherjava.tjbot.db.Database;
 import org.togetherjava.tjbot.routines.ModAuditLogRoutine;
 
@@ -55,6 +56,7 @@ public enum Features {
         // Routines
         features.add(new ModAuditLogRoutine(database));
         features.add(new TemporaryModerationRoutine(jda, actionsStore));
+        features.add(new TopHelpersPurgeMessagesRoutine(database));
 
         // Message receivers
         features.add(new TopHelpersMessageListener(database));

application/src/main/java/org/togetherjava/tjbot/commands/tophelper/TopHelpersMessageListener.java

@@ -2,29 +2,19 @@
 
 import net.dv8tion.jda.api.events.message.guild.GuildMessageReceivedEvent;
 import org.jetbrains.annotations.NotNull;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.togetherjava.tjbot.commands.MessageReceiverAdapter;
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.db.Database;
 
-import java.time.Instant;
-import java.time.Period;
 import java.util.regex.Pattern;
 
 import static org.togetherjava.tjbot.db.generated.tables.HelpChannelMessages.HELP_CHANNEL_MESSAGES;
 
 /**
  * Listener that receives all sent help messages and puts them into the database for
  * {@link TopHelpersCommand} to pick them up.
- *
- * Also runs a cleanup routine to get rid of old entries. In general, it manages the database data
- * to determine top-helpers.
  */
 public final class TopHelpersMessageListener extends MessageReceiverAdapter {
-    private static final Logger logger = LoggerFactory.getLogger(TopHelpersMessageListener.class);
-    private static final Period DELETE_MESSAGE_RECORDS_AFTER = Period.ofDays(90);
-
     private final Database database;
 
     /**
@@ -44,8 +34,6 @@ public void onMessageReceived(@NotNull GuildMessageReceivedEvent event) {
         }
 
         addMessageRecord(event);
-        // TODO Use a routine that runs every 4 hours for the deletion instead
-        deleteOldMessageRecords();
     }
 
     private void addMessageRecord(@NotNull GuildMessageReceivedEvent event) {
@@ -57,18 +45,4 @@ private void addMessageRecord(@NotNull GuildMessageReceivedEvent event) {
             .setSentAt(event.getMessage().getTimeCreated().toInstant())
             .insert());
     }
-
-    private void deleteOldMessageRecords() {
-        int recordsDeleted =
-                database.writeAndProvide(context -> context.deleteFrom(HELP_CHANNEL_MESSAGES)
-                    .where(HELP_CHANNEL_MESSAGES.SENT_AT
-                        .lessOrEqual(Instant.now().minus(DELETE_MESSAGE_RECORDS_AFTER)))
-                    .execute());
-
-        if (recordsDeleted > 0) {
-            logger.debug(
-                    "{} old help message records have been deleted because they are older than {}.",
-                    recordsDeleted, DELETE_MESSAGE_RECORDS_AFTER);
-        }
-    }
 }

application/src/main/java/org/togetherjava/tjbot/commands/tophelper/TopHelpersPurgeMessagesRoutine.java

@@ -0,0 +1,54 @@
+package org.togetherjava.tjbot.commands.tophelper;
+
+import net.dv8tion.jda.api.JDA;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.togetherjava.tjbot.commands.Routine;
+import org.togetherjava.tjbot.db.Database;
+
+import java.time.Instant;
+import java.time.Period;
+import java.util.concurrent.TimeUnit;
+
+import static org.togetherjava.tjbot.db.generated.tables.HelpChannelMessages.HELP_CHANNEL_MESSAGES;
+
+/**
+ * Cleanup routine to get rid of old database top-helper message entries.
+ */
+public final class TopHelpersPurgeMessagesRoutine implements Routine {
+    private static final Logger logger =
+            LoggerFactory.getLogger(TopHelpersPurgeMessagesRoutine.class);
+    private static final Period DELETE_MESSAGE_RECORDS_AFTER = Period.ofDays(90);
+
+    private final Database database;
+
+    /**
+     * Creates a new cleanup routine.
+     *
+     * @param database the database that contains the messages to purge
+     */
+    public TopHelpersPurgeMessagesRoutine(@NotNull Database database) {
+        this.database = database;
+    }
+
+    @Override
+    public @NotNull Schedule createSchedule() {
+        return new Schedule(ScheduleMode.FIXED_RATE, 0, 4, TimeUnit.HOURS);
+    }
+
+    @Override
+    public void runRoutine(@NotNull JDA jda) {
+        int recordsDeleted =
+                database.writeAndProvide(context -> context.deleteFrom(HELP_CHANNEL_MESSAGES)
+                    .where(HELP_CHANNEL_MESSAGES.SENT_AT
+                        .lessOrEqual(Instant.now().minus(DELETE_MESSAGE_RECORDS_AFTER)))
+                    .execute());
+
+        if (recordsDeleted > 0) {
+            logger.debug(
+                    "{} old help message records have been deleted because they are older than {}.",
+                    recordsDeleted, DELETE_MESSAGE_RECORDS_AFTER);
+        }
+    }
+}