Integrated existing routines

Author: Zabuzard

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

@@ -51,10 +51,8 @@ public enum Features {
         Collection<Feature> features = new ArrayList<>();
 
         // Routines
-        // TODO This should be moved into some proper command system instead (see GH issue #235
-        // which adds support for routines)
-        new ModAuditLogRoutine(jda, database).start();
-        new TemporaryModerationRoutine(jda, actionsStore).start();
+        features.add(new ModAuditLogRoutine(database));
+        features.add(new TemporaryModerationRoutine(jda, actionsStore));
 
         // Message receivers
 

application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryModerationRoutine.java

@@ -7,6 +7,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.togetherjava.tjbot.commands.Routine;
 import org.togetherjava.tjbot.commands.moderation.ActionRecord;
 import org.togetherjava.tjbot.commands.moderation.ModerationAction;
 import org.togetherjava.tjbot.commands.moderation.ModerationActionsStore;
@@ -15,8 +16,6 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -26,19 +25,15 @@
  * Routine that revokes temporary moderation actions, such as temporary bans, as listed by
  * {@link ModerationActionsStore}.
  * <p>
- * The routine is started by using {@link #start()} and then automatically executes on a schedule.
- * <p>
  * Revoked actions are compatible with {@link ModerationActionsStore} and commands such as
  * {@link org.togetherjava.tjbot.commands.moderation.UnbanCommand} and
  * {@link org.togetherjava.tjbot.commands.moderation.AuditCommand}.
  */
-public final class TemporaryModerationRoutine {
+public final class TemporaryModerationRoutine implements Routine {
     private static final Logger logger = LoggerFactory.getLogger(TemporaryModerationRoutine.class);
 
     private final ModerationActionsStore actionsStore;
     private final JDA jda;
-    private final ScheduledExecutorService checkExpiredActionsService =
-            Executors.newSingleThreadScheduledExecutor();
     private final Map<ModerationAction, RevocableModerationAction> typeToRevocableAction;
 
     /**
@@ -57,6 +52,16 @@ public TemporaryModerationRoutine(@NotNull JDA jda,
                     Collectors.toMap(RevocableModerationAction::getApplyType, Function.identity()));
     }
 
+    @Override
+    public void run(@NotNull JDA jda) {
+        checkExpiredActions();
+    }
+
+    @Override
+    public @NotNull Schedule createSchedule() {
+        return new Schedule(ScheduleMode.FIXED_DELAY, 5, 5, TimeUnit.MINUTES);
+    }
+
     private void checkExpiredActions() {
         logger.debug("Checking expired temporary moderation actions to revoke...");
 
@@ -146,19 +151,6 @@ private void handleFailure(@NotNull Throwable failure,
                 "Action type is not revocable: " + type);
     }
 
-    /**
-     * Starts the routine, automatically checking expired temporary moderation actions on a
-     * schedule.
-     */
-    public void start() {
-        // TODO This should be registered at some sort of routine system instead (see GH issue #235
-        // which adds support for routines)
-        // TODO The initial run has to be delayed until after the guild cache has been updated
-        // (during CommandSystem startup)
-        checkExpiredActionsService.scheduleWithFixedDelay(this::checkExpiredActions, 5, 5,
-                TimeUnit.MINUTES);
-    }
-
     private record RevocationGroupIdentifier(long guildId, long targetId,
             @NotNull ModerationAction type) {
         static RevocationGroupIdentifier of(@NotNull ActionRecord actionRecord) {

application/src/main/java/org/togetherjava/tjbot/routines/ModAuditLogRoutine.java

@@ -15,6 +15,7 @@
 import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.togetherjava.tjbot.commands.Routine;
 import org.togetherjava.tjbot.commands.moderation.ModerationUtils;
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.db.Database;
@@ -26,7 +27,6 @@
 import java.time.temporal.TemporalAccessor;
 import java.util.*;
 import java.util.List;
-import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
 import java.util.function.BiFunction;
@@ -36,13 +36,13 @@
 
 /**
  * Routine that automatically checks moderator actions on a schedule and logs them to dedicated
- * channels. Use {@link #start()} to trigger automatic execution of the routine.
+ * channels.
  * <p>
  * The routine is executed periodically, for example three times per day. When it runs, it checks
  * all moderator actions, such as user bans, kicks, muting or message deletion. Actions are then
  * logged to a dedicated channel, given by {@link Config#getModAuditLogChannelPattern()}.
  */
-public final class ModAuditLogRoutine {
+public final class ModAuditLogRoutine implements Routine {
     private static final Logger logger = LoggerFactory.getLogger(ModAuditLogRoutine.class);
     private static final int CHECK_AUDIT_LOG_START_HOUR = 4;
     private static final int CHECK_AUDIT_LOG_EVERY_HOURS = 8;
@@ -51,24 +51,19 @@ public final class ModAuditLogRoutine {
 
     private final Predicate<TextChannel> isAuditLogChannel;
     private final Database database;
-    private final JDA jda;
-    private final ScheduledExecutorService checkAuditLogService =
-            Executors.newSingleThreadScheduledExecutor();
 
     /**
      * Creates a new instance.
      *
-     * @param jda the JDA instance to use to send messages and retrieve information
      * @param database the database for memorizing audit log dates
      */
-    public ModAuditLogRoutine(@NotNull JDA jda, @NotNull Database database) {
+    public ModAuditLogRoutine(@NotNull Database database) {
         Predicate<String> isAuditLogChannelName =
                 Pattern.compile(Config.getInstance().getModAuditLogChannelPattern())
                     .asMatchPredicate();
         isAuditLogChannel = channel -> isAuditLogChannelName.test(channel.getName());
 
         this.database = database;
-        this.jda = jda;
     }
 
     private static @NotNull RestAction<MessageEmbed> handleAction(@NotNull Action action,
@@ -106,7 +101,7 @@ private static boolean isSnowflakeAfter(@NotNull ISnowflake snowflake,
     }
 
     /**
-     * Schedules the given task for execution at a fixed rate (see
+     * Creates a schedule for execution at a fixed rate (see
      * {@link ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit)}). The
      * initial first execution will be delayed to the next fixed time that matches the given period,
      * effectively making execution stable at fixed times of a day - regardless of when this method
@@ -120,14 +115,11 @@ private static boolean isSnowflakeAfter(@NotNull ISnowflake snowflake,
      * Execution will also correctly roll over to the next day, for example if the method is
      * triggered at 21:30, the next execution will be at 4:00 the following day.
      *
-     * @param service the scheduler to use
-     * @param command the command to schedule
      * @param periodStartHour the hour of the day that marks the start of this period
      * @param periodHours the scheduling period in hours
-     * @return the instant when the command will be executed the first time
+     * @return the according schedule representing the planned execution
      */
-    private static @NotNull Instant scheduleAtFixedRateFromNextFixedTime(
-            @NotNull ScheduledExecutorService service, @NotNull Runnable command,
+    private static @NotNull Schedule scheduleAtFixedRateFromNextFixedTime(
             @SuppressWarnings("SameParameterValue") int periodStartHour,
             @SuppressWarnings("SameParameterValue") int periodHours) {
         // NOTE This scheduler could be improved, for example supporting arbitrary periods (not just
@@ -153,9 +145,8 @@ private static boolean isSnowflakeAfter(@NotNull ISnowflake snowflake,
         Instant now = Instant.now();
         Instant nextFixedTime =
                 computeClosestNextScheduleDate(now, fixedScheduleHours, periodHours);
-        service.scheduleAtFixedRate(command, ChronoUnit.SECONDS.between(now, nextFixedTime),
+        return new Schedule(ScheduleMode.FIXED_RATE, ChronoUnit.SECONDS.between(now, nextFixedTime),
                 TimeUnit.HOURS.toSeconds(periodHours), TimeUnit.SECONDS);
-        return nextFixedTime;
     }
 
     private static @NotNull Instant computeClosestNextScheduleDate(@NotNull Instant instant,
@@ -213,19 +204,21 @@ private static boolean isSnowflakeAfter(@NotNull ISnowflake snowflake,
         return Optional.of(handleAction(Action.MESSAGE_DELETION, entry));
     }
 
-    /**
-     * Starts the routine, automatically checking the audit logs on a schedule.
-     */
-    public void start() {
-        // TODO This should be registered at some sort of routine system instead (see GH issue #235
-        // which adds support for routines)
-        Instant startInstant = scheduleAtFixedRateFromNextFixedTime(checkAuditLogService,
-                this::checkAuditLogsRoutine, CHECK_AUDIT_LOG_START_HOUR,
+    @Override
+    public void run(@NotNull JDA jda) {
+        checkAuditLogsRoutine(jda);
+    }
+
+    @Override
+    public @NotNull Schedule createSchedule() {
+        Schedule schedule = scheduleAtFixedRateFromNextFixedTime(CHECK_AUDIT_LOG_START_HOUR,
                 CHECK_AUDIT_LOG_EVERY_HOURS);
-        logger.info("Checking audit logs is scheduled for {}.", startInstant);
+        logger.info("Checking audit logs is scheduled for {}.",
+                Instant.now().plus(schedule.initialDuration(), schedule.unit().toChronoUnit()));
+        return schedule;
     }
 
-    private void checkAuditLogsRoutine() {
+    private void checkAuditLogsRoutine(@NotNull JDA jda) {
         logger.info("Checking audit logs of all guilds...");
 
         jda.getGuildCache().forEach(guild -> {