refactor: code review addressed by Zabuzard

* minimumReactions-5, star symbol instead of encoding

* requests changes by zabuzard except for moving getBoardChannel down and markMessageAsProcessed

* Following JavaDocs guidelines of making the first letter capital

* code refactoring

* refactor: use correct method for reactionsCount

It turns out that for each event fired, every *single* damn time,
messageReaction.hasCount() would always return false. No matter what.
Terrible documentation from JDA's side. As a result, because of the
ternary operator:

    messageReaction.hasCount() ? messageReaction.getCount() + 1 : 1

the result of `reactionsCount` would always end up holding the value of
one.

In the following changes, we use `messageReaction.retrieveUsers()` to
get a list of the people reacted, get a `Stream<User>` from that and get
its count. Much more reliable this way and it also happens to be more
readable.

Signed-off-by: Chris Sdogkos <[email protected]>
Co-authored-by: Chris Sdogkos <[email protected]>
Co-authored-by: Surya Tejess <[email protected]>

Author: suryatejess

application/config.json.template

@@ -176,9 +176,9 @@
         "pollIntervalInMinutes": 10
     },
     "coolMessagesConfig": {
-        "minimumReactions": 5,
+        "minimumReactions": 2,
         "boardChannelPattern": "quotes",
-        "reactionEmoji": "U+2B50"
+        "reactionEmoji": "⭐"
     },
     "memberCountCategoryPattern": "Info"
 }

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

@@ -48,7 +48,7 @@ public final class Config {
     private final RSSFeedsConfig rssFeedsConfig;
     private final String selectRolesChannelPattern;
     private final String memberCountCategoryPattern;
-    private final CoolMessagesBoardConfig coolMessagesConfig;
+    private final QuoteBoardConfig coolMessagesConfig;
 
     @SuppressWarnings("ConstructorWithTooManyParameters")
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
@@ -103,7 +103,7 @@ private Config(@JsonProperty(value = "token", required = true) String token,
             @JsonProperty(value = "selectRolesChannelPattern",
                     required = true) String selectRolesChannelPattern,
             @JsonProperty(value = "coolMessagesConfig",
-                    required = true) CoolMessagesBoardConfig coolMessagesConfig) {
+                    required = true) QuoteBoardConfig coolMessagesConfig) {
         this.token = Objects.requireNonNull(token);
         this.githubApiKey = Objects.requireNonNull(githubApiKey);
         this.databasePath = Objects.requireNonNull(databasePath);
@@ -437,7 +437,7 @@ public String getSelectRolesChannelPattern() {
      *
      * @return configuration of cool messages config
      */
-    public CoolMessagesBoardConfig getCoolMessagesConfig() {
+    public QuoteBoardConfig getCoolMessagesConfig() {
         return coolMessagesConfig;
     }
 

application/src/main/java/org/togetherjava/tjbot/config/CoolMessagesBoardConfig.java renamed to application/src/main/java/org/togetherjava/tjbot/config/QuoteBoardConfig.java

@@ -6,23 +6,22 @@
 import java.util.Objects;
 
 /**
- * Configuration for the cool messages board feature, see
- * {@link org.togetherjava.tjbot.features.basic.CoolMessagesBoardManager}.
+ * Configuration for the cool messages board feature, see {@link ``QuoteBoardForwarder``}.
  */
 @JsonRootName("coolMessagesConfig")
-public record CoolMessagesBoardConfig(
+public record QuoteBoardConfig(
         @JsonProperty(value = "minimumReactions", required = true) int minimumReactions,
         @JsonProperty(value = "boardChannelPattern", required = true) String boardChannelPattern,
         @JsonProperty(value = "reactionEmoji", required = true) String reactionEmoji) {
 
     /**
-     * Creates a CoolMessagesBoardConfig.
+     * Creates a QuoteBoardConfig.
      *
      * @param minimumReactions the minimum amount of reactions
      * @param boardChannelPattern the pattern for the board channel
      * @param reactionEmoji the emoji with which users should react to
      */
-    public CoolMessagesBoardConfig {
+    public QuoteBoardConfig {
         Objects.requireNonNull(boardChannelPattern);
     }
 }

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

@@ -6,9 +6,9 @@
 import org.togetherjava.tjbot.config.FeatureBlacklist;
 import org.togetherjava.tjbot.config.FeatureBlacklistConfig;
 import org.togetherjava.tjbot.db.Database;
-import org.togetherjava.tjbot.features.basic.CoolMessagesBoardManager;
 import org.togetherjava.tjbot.features.basic.MemberCountDisplayRoutine;
 import org.togetherjava.tjbot.features.basic.PingCommand;
+import org.togetherjava.tjbot.features.basic.QuoteBoardForwarder;
 import org.togetherjava.tjbot.features.basic.RoleSelectCommand;
 import org.togetherjava.tjbot.features.basic.SlashCommandEducator;
 import org.togetherjava.tjbot.features.basic.SuggestionsUpDownVoter;
@@ -155,7 +155,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new CodeMessageManualDetection(codeMessageHandler));
         features.add(new SlashCommandEducator());
         features.add(new PinnedNotificationRemover(config));
-        features.add(new CoolMessagesBoardManager(config));
+        features.add(new QuoteBoardForwarder(config));
 
         // Event receivers
         features.add(new RejoinModerationRoleListener(actionsStore, config));

application/src/main/java/org/togetherjava/tjbot/features/basic/CoolMessagesBoardManager.java renamed to application/src/main/java/org/togetherjava/tjbot/features/basic/QuoteBoardForwarder.java

@@ -6,12 +6,12 @@
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
 import net.dv8tion.jda.api.entities.emoji.Emoji;
 import net.dv8tion.jda.api.events.message.react.MessageReactionAddEvent;
-import net.dv8tion.jda.api.requests.restaction.MessageCreateAction;
+import net.dv8tion.jda.api.requests.RestAction;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import org.togetherjava.tjbot.config.Config;
-import org.togetherjava.tjbot.config.CoolMessagesBoardConfig;
+import org.togetherjava.tjbot.config.QuoteBoardConfig;
 import org.togetherjava.tjbot.features.MessageReceiverAdapter;
 
 import java.util.Optional;
@@ -20,73 +20,75 @@
 
 /**
  * Manager for the cool messages board. It appends highly-voted text messages to a separate channel
- * where members of the guild can see a list of all of them.
+ * where members of the guild can see a list of all of them. User reacts to a message with a
+ * configured emoji it then forwards this message to the configured quote board channel
  */
-public final class CoolMessagesBoardManager extends MessageReceiverAdapter {
+public final class QuoteBoardForwarder extends MessageReceiverAdapter {
 
-    private static final Logger logger = LoggerFactory.getLogger(CoolMessagesBoardManager.class);
-    private final Emoji coolEmoji;
-    private final Predicate<String> boardChannelNamePredicate;
-    private final CoolMessagesBoardConfig config;
+    private static final Logger logger = LoggerFactory.getLogger(QuoteBoardForwarder.class);
+    private final Emoji triggerReaction;
+    private final Predicate<String> isQuoteBoardChannelName;
+    private final QuoteBoardConfig config;
 
     /**
-     * Constructs a new instance of CoolMessagesBoardManager.
+     * Constructs a new instance of QuoteBoardForwarder.
      *
      * @param config the configuration containing settings specific to the cool messages board,
      *        including the reaction emoji and the pattern to match board channel names
      */
-    public CoolMessagesBoardManager(Config config) {
+    public QuoteBoardForwarder(Config config) {
         this.config = config.getCoolMessagesConfig();
-        this.coolEmoji = Emoji.fromUnicode(this.config.reactionEmoji());
+        this.triggerReaction = Emoji.fromUnicode(this.config.reactionEmoji());
 
-        boardChannelNamePredicate =
+        isQuoteBoardChannelName =
                 Pattern.compile(this.config.boardChannelPattern()).asMatchPredicate();
     }
 
     @Override
     public void onMessageReactionAdd(MessageReactionAddEvent event) {
         final MessageReaction messageReaction = event.getReaction();
-        int originalReactionsCount = messageReaction.hasCount() ? messageReaction.getCount() : 0;
-        boolean isCoolEmoji = messageReaction.getEmoji().equals(coolEmoji);
+        boolean isCoolEmoji = messageReaction.getEmoji().equals(triggerReaction);
         long guildId = event.getGuild().getIdLong();
-        Optional<TextChannel> boardChannel = getBoardChannel(event.getJDA(), guildId);
 
-        if (boardChannel.isEmpty()) {
-            logger.warn(
-                    "Could not find board channel with pattern '{}' in server with ID '{}'. Skipping reaction handling...",
-                    this.config.boardChannelPattern(), guildId);
+        if (hasAlreadyForwardedMessage(event.getJDA(), messageReaction)) {
             return;
         }
 
-        // If the bot has already reacted to this message, then this means that
-        // the message has been quoted to the cool messages board, so skip it.
-        if (hasBotReacted(event.getJDA(), messageReaction)) {
-            return;
-        }
+        final int reactionsCount = (int) messageReaction.retrieveUsers().stream().count();
+        if (isCoolEmoji && reactionsCount >= config.minimumReactions()) {
+            Optional<TextChannel> boardChannel = findQuoteBoardChannel(event.getJDA(), guildId);
+
+            if (boardChannel.isEmpty()) {
+                logger.warn(
+                        "Could not find board channel with pattern '{}' in server with ID '{}'. Skipping reaction handling...",
+                        this.config.boardChannelPattern(), guildId);
+                return;
+            }
 
-        final int newReactionsCount = originalReactionsCount + 1;
-        if (isCoolEmoji && newReactionsCount >= config.minimumReactions()) {
             event.retrieveMessage()
-                .queue(message -> message.addReaction(coolEmoji)
-                    .flatMap(v -> insertCoolMessage(boardChannel.get(), message))
-                    .queue(),
-                        e -> logger.warn("Tried to retrieve cool message but got: {}",
-                                e.getMessage()));
+                .queue(message -> markAsProcessed(message).flatMap(v -> message
+                    .forwardTo(boardChannel.orElseThrow())).queue(), e -> logger.warn(
+                            "Unknown error while attempting to retrieve and forward message for quote-board, message is ignored.",
+                            e));
         }
     }
 
+    private RestAction<Void> markAsProcessed(Message message) {
+        return message.addReaction(triggerReaction);
+    }
+
     /**
      * Gets the board text channel where the quotes go to, wrapped in an optional.
      *
      * @param jda the JDA
      * @param guildId the guild ID
      * @return the board text channel
      */
-    private Optional<TextChannel> getBoardChannel(JDA jda, long guildId) {
+    private Optional<TextChannel> findQuoteBoardChannel(JDA jda, long guildId) {
         return jda.getGuildById(guildId)
             .getTextChannelCache()
             .stream()
-            .filter(channel -> boardChannelNamePredicate.test(channel.getName()))
+            .filter(channel -> isQuoteBoardChannelName.test(channel.getName()))
             .findAny();
     }
 
@@ -95,16 +97,12 @@ private Optional<TextChannel> getBoardChannel(JDA jda, long guildId) {
      *
      * @return a {@link MessageCreateAction} of the call to make
      */
-    private static MessageCreateAction insertCoolMessage(TextChannel boardChannel,
-            Message message) {
-        return message.forwardTo(boardChannel);
-    }
 
     /**
      * Checks a {@link MessageReaction} to see if the bot has reacted to it.
      */
-    private boolean hasBotReacted(JDA jda, MessageReaction messageReaction) {
-        if (!coolEmoji.equals(messageReaction.getEmoji())) {
+    private boolean hasAlreadyForwardedMessage(JDA jda, MessageReaction messageReaction) {
+        if (!triggerReaction.equals(messageReaction.getEmoji())) {
             return false;
         }