Address code review comments from @Zabuzard

- docs(calculateSubscribeTarget): improve JavaDocs
- refactor: rename to DynamicVoiceChannelListener

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

Author: christolis

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

@@ -20,7 +20,7 @@
 import org.togetherjava.tjbot.features.code.CodeMessageAutoDetection;
 import org.togetherjava.tjbot.features.code.CodeMessageHandler;
 import org.togetherjava.tjbot.features.code.CodeMessageManualDetection;
-import org.togetherjava.tjbot.features.dynamicvc.DynamicVoiceListener;
+import org.togetherjava.tjbot.features.dynamicvc.DynamicVoiceChannelListener;
 import org.togetherjava.tjbot.features.filesharing.FileSharingMessageListener;
 import org.togetherjava.tjbot.features.github.GitHubCommand;
 import org.togetherjava.tjbot.features.github.GitHubReference;
@@ -163,7 +163,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new PinnedNotificationRemover(config));
 
         // Voice receivers
-        features.add(new DynamicVoiceListener(config));
+        features.add(new DynamicVoiceChannelListener(config));
 
         // Event receivers
         features.add(new RejoinModerationRoleListener(actionsStore, config));

…ures/dynamicvc/DynamicVoiceListener.java …namicvc/DynamicVoiceChannelListener.javaapplication/src/main/java/org/togetherjava/tjbot/features/dynamicvc/DynamicVoiceListener.java renamed to application/src/main/java/org/togetherjava/tjbot/features/dynamicvc/DynamicVoiceChannelListener.java application/src/main/java/org/togetherjava/tjbot/features/dynamicvc/DynamicVoiceListener.java renamed to application/src/main/java/org/togetherjava/tjbot/features/dynamicvc/DynamicVoiceChannelListener.java

@@ -31,7 +31,7 @@
 import java.util.stream.Stream;
 
 /**
- * {@link DynamicVoiceListener} is a feature that dynamically manages voice channels within a
+ * {@link DynamicVoiceChannelListener} is a feature that dynamically manages voice channels within a
  * Discord guild based on user activity.
  * <p>
  * It is designed to handle events related to voice channel updates (e.g. when users join or leave
@@ -43,9 +43,9 @@
  * channel names it should manage. The configuration is expected to provide a list of regular
  * expression patterns for these channel names.
  */
-public class DynamicVoiceListener extends VoiceReceiverAdapter {
+public class DynamicVoiceChannelListener extends VoiceReceiverAdapter {
 
-    private final Logger logger = LoggerFactory.getLogger(DynamicVoiceListener.class);
+    private final Logger logger = LoggerFactory.getLogger(DynamicVoiceChannelListener.class);
 
     private final Map<String, Predicate<String>> channelPredicates = new HashMap<>();
 
@@ -64,11 +64,11 @@ public class DynamicVoiceListener extends VoiceReceiverAdapter {
     private static final int CONGESTION_THRESHOLD = 5;
 
     /**
-     * Initializes a new {@link DynamicVoiceListener} with the specified configuration.
+     * Initializes a new {@link DynamicVoiceChannelListener} with the specified configuration.
      *
      * @param config the configuration containing dynamic voice channel patterns
      */
-    public DynamicVoiceListener(Config config) {
+    public DynamicVoiceChannelListener(Config config) {
         config.getDynamicVoiceChannelPatterns().forEach(pattern -> {
             channelPredicates.put(pattern, Pattern.compile(pattern).asMatchPredicate());
             activeQueuesMap.put(pattern, new AtomicBoolean(false));

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

@@ -256,18 +256,38 @@ public void onMessageDelete(final MessageDeleteEvent event) {
     }
 
     /**
-     * @param joinChannel the join channel
-     * @param leftChannel the leave channel
+     * Calculates the correct voice channel to act upon.
+     *
+     * <p>
+     * If there is a <code>channelJoined</code> and a <code>channelLeft</code>, then the
+     * <code>channelJoined</code> is prioritized and returned. Otherwise, it returns
+     * <code>channelLeft</code>.
+     *
+     * <p>
+     * This is an essential method due to the need of updating both channel categories that a member
+     * utilizes. For example, take the scenario of a user browsing through voice channels:
+     *
+     * <pre>
+     *     - User joins General -> channelJoined = General | channelLeft = null
+     *     - User switches to Gaming -> channelJoined = Gaming | channelLeft = General
+     *     - User leaves Discord -> channelJoined = null | channelLeft = Gaming
+     * </pre>
+     *
+     * <p>
+     * This way, we make sure that all relevant voice channels are updated.
+     *
+     * @param channelJoined the channel that the member has connected to, if any
+     * @param channelLeft the channel that the member left from, if any
      * @return the join channel if not null, otherwise the leave channel, otherwise an empty
      *         optional
      */
-    private Optional<Channel> calculateSubscribeTarget(@Nullable AudioChannelUnion joinChannel,
-            @Nullable AudioChannelUnion leftChannel) {
-        if (joinChannel != null) {
-            return Optional.of(joinChannel);
+    private Optional<Channel> calculateSubscribeTarget(@Nullable AudioChannelUnion channelJoined,
+            @Nullable AudioChannelUnion channelLeft) {
+        if (channelJoined != null) {
+            return Optional.of(channelJoined);
         }
 
-        return Optional.ofNullable(leftChannel);
+        return Optional.ofNullable(channelLeft);
     }
 
     @Override