Make the already existing constants configurable from config.json

For the purposes of speeding up the process of reviews and since it really
doesn't matter if they are configurable or not (just extra unnecessary
development time), move all the constants into the config.json so that
users who run the bot can easily configure these constants without
touching the code.

Signed-off-by: Chris Sdogkos <work@chris-sdogkos.com>

Author: christolis

application/config.json.template

@@ -205,9 +205,14 @@
         "assignmentChannelPattern": "community-commands",
         "announcementChannelPattern": "hall-of-fame"
     },
-    "dynamicVoiceChannelPatterns": [
-        "Gaming",
-        "Support/Studying Room",
-        "Chit Chat"
-    ]
+    "dynamicVoiceChatConfig": {
+        "dynamicChannelPatterns": [
+            "Gaming",
+            "Support/Studying Room",
+            "Chit Chat"
+        ],
+        "archiveCategoryPattern": "Voice Channel Archives",
+        "cleanChannelsAmount": 20,
+        "minimumChannelsAmount": 40
+    }
 }

application/src/main/java/org/togetherjava/tjbot/config/Config.java

@@ -50,7 +50,7 @@ public final class Config {
     private final String memberCountCategoryPattern;
     private final QuoteBoardConfig quoteBoardConfig;
     private final TopHelpersConfig topHelpers;
-    private final List<String> dynamicVoiceChannelPatterns;
+    private final DynamicVoiceChatConfig dynamicVoiceChatConfig;
 
     @SuppressWarnings("ConstructorWithTooManyParameters")
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
@@ -107,8 +107,8 @@ private Config(@JsonProperty(value = "token", required = true) String token,
             @JsonProperty(value = "quoteBoardConfig",
                     required = true) QuoteBoardConfig quoteBoardConfig,
             @JsonProperty(value = "topHelpers", required = true) TopHelpersConfig topHelpers,
-            @JsonProperty(value = "dynamicVoiceChannelPatterns",
-                    required = true) List<String> dynamicVoiceChannelPatterns) {
+            @JsonProperty(value = "dynamicVoiceChatConfig",
+                    required = true) DynamicVoiceChatConfig dynamicVoiceChatConfig) {
         this.token = Objects.requireNonNull(token);
         this.githubApiKey = Objects.requireNonNull(githubApiKey);
         this.databasePath = Objects.requireNonNull(databasePath);
@@ -145,7 +145,7 @@ private Config(@JsonProperty(value = "token", required = true) String token,
         this.selectRolesChannelPattern = Objects.requireNonNull(selectRolesChannelPattern);
         this.quoteBoardConfig = Objects.requireNonNull(quoteBoardConfig);
         this.topHelpers = Objects.requireNonNull(topHelpers);
-        this.dynamicVoiceChannelPatterns = Objects.requireNonNull(dynamicVoiceChannelPatterns);
+        this.dynamicVoiceChatConfig = Objects.requireNonNull(dynamicVoiceChatConfig);
     }
 
     /**
@@ -479,11 +479,11 @@ public TopHelpersConfig getTopHelpers() {
     }
 
     /**
-     * Gets the list of voice channel patterns that are treated dynamically.
+     * Gets the dynamic voice chat configuration
      *
-     * @return the list of dynamic voice channel patterns
+     * @return the dynamic voice chat configuration
      */
-    public List<String> getDynamicVoiceChannelPatterns() {
-        return dynamicVoiceChannelPatterns;
+    public DynamicVoiceChatConfig getDynamicVoiceChatConfig() {
+        return dynamicVoiceChatConfig;
     }
 }

application/src/main/java/org/togetherjava/tjbot/config/DynamicVoiceChatConfig.java

@@ -0,0 +1,30 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.regex.Pattern;
+
+/**
+ * Configuration for the dynamic voice chat feature.
+ *
+ * @param archiveCategoryPattern the name of the Discord Guild category in which the archived
+ *        channels will go
+ * @param cleanChannelsAmount the amount of channels to clean once a cleanup is triggered
+ * @param minimumChannelsAmount the amount of voice channels for the archive category to have before
+ *        a cleanup triggers
+ */
+public record DynamicVoiceChatConfig(
+        @JsonProperty(value = "dynamicChannelPatterns",
+                required = true) List<Pattern> dynamicChannelPatterns,
+        @JsonProperty(value = "archiveCategoryPattern",
+                required = true) String archiveCategoryPattern,
+        @JsonProperty(value = "cleanChannelsAmount") int cleanChannelsAmount,
+        @JsonProperty(value = "minimumChannelsAmount", required = true) int minimumChannelsAmount) {
+
+    public DynamicVoiceChatConfig {
+        Objects.requireNonNull(dynamicChannelPatterns);
+        Objects.requireNonNull(archiveCategoryPattern);
+    }
+}

application/src/main/java/org/togetherjava/tjbot/features/voicechat/DynamicVoiceChat.java

@@ -17,11 +17,10 @@
 import org.slf4j.LoggerFactory;
 
 import org.togetherjava.tjbot.config.Config;
+import org.togetherjava.tjbot.config.DynamicVoiceChatConfig;
 import org.togetherjava.tjbot.features.VoiceReceiverAdapter;
 
-import java.util.List;
 import java.util.Optional;
-import java.util.regex.Pattern;
 
 /**
  * Handles dynamic voice channel creation and deletion based on user activity.
@@ -33,18 +32,15 @@
 public final class DynamicVoiceChat extends VoiceReceiverAdapter {
     private static final Logger logger = LoggerFactory.getLogger(DynamicVoiceChat.class);
 
-    private static final String ARCHIVE_CATEGORY_NAME = "Voice Channel Archives";
-    private static final int CLEAN_CHANNELS_AMOUNT = 25;
-    private static final int MINIMUM_CHANNELS_AMOUNT = 50;
-
     private final VoiceChatCleanupStrategy voiceChatCleanupStrategy;
-    private final List<Pattern> dynamicVoiceChannelPatterns;
+    private final DynamicVoiceChatConfig dynamicVoiceChannelConfig;
 
     public DynamicVoiceChat(Config config) {
-        this.dynamicVoiceChannelPatterns =
-                config.getDynamicVoiceChannelPatterns().stream().map(Pattern::compile).toList();
+        this.dynamicVoiceChannelConfig = config.getDynamicVoiceChatConfig();
+
         this.voiceChatCleanupStrategy =
-                new OldestVoiceChatCleanup(CLEAN_CHANNELS_AMOUNT, MINIMUM_CHANNELS_AMOUNT);
+                new OldestVoiceChatCleanup(dynamicVoiceChannelConfig.cleanChannelsAmount(),
+                        dynamicVoiceChannelConfig.minimumChannelsAmount());
     }
 
     @Override
@@ -74,7 +70,8 @@ public void onVoiceUpdate(@NotNull GuildVoiceUpdateEvent event) {
     }
 
     private boolean eventHappenOnDynamicRootChannel(AudioChannelUnion channel) {
-        return dynamicVoiceChannelPatterns.stream()
+        return dynamicVoiceChannelConfig.dynamicChannelPatterns()
+            .stream()
             .anyMatch(pattern -> pattern.matcher(channel.getName()).matches());
     }
 
@@ -119,7 +116,8 @@ private void archiveDynamicVoiceChannel(AudioChannelUnion channel) {
         Optional<Category> archiveCategoryOptional = channel.getGuild()
             .getCategoryCache()
             .stream()
-            .filter(c -> c.getName().equalsIgnoreCase(ARCHIVE_CATEGORY_NAME))
+            .filter(c -> c.getName()
+                .equalsIgnoreCase(dynamicVoiceChannelConfig.archiveCategoryPattern()))
             .findFirst();
 
         AudioChannelManager<?, ?> channelManager = channel.getManager();
@@ -130,7 +128,7 @@ private void archiveDynamicVoiceChannel(AudioChannelUnion channel) {
         if (archiveCategoryOptional.isEmpty()) {
             logger.warn("Could not find archive category. Attempting to create one...");
             channel.getGuild()
-                .createCategory(ARCHIVE_CATEGORY_NAME)
+                .createCategory(dynamicVoiceChannelConfig.archiveCategoryPattern())
                 .queue(newCategory -> restActionChain.and(channelManager.setParent(newCategory))
                     .queue());
             return;