refactor(application-form): better exception handling

There are currently many undesired conditions the code could run into
when it comes to the `RoleApplicationHandler` which we would not desire
and we would not be prepared for, particularly in situations where:

    - We would somehow find ourselves handling application form
      submissions in a non-guild environment.

    - The arguments size including the clicked component ID as well as
      the role name (the title of that component ID in essence) would
      have an unexpected size.

    - The staff-monitored application submissions text channel would not
      be found by the bot.

We do not have entire control over these cases, but we need to handle
them properly and set ourselves up for success in the rare case they
happen.

Make `sendApplicationResult` throw an `IllegalArgumentException` with
descriptive messages if anything goes wrong, and log appropriate
stacktraces if anything goes wrong in the logger for easy debugging.

I thought about printing straight to the logger and not using any
`IllegalArgumentException` in the code (or at least, using a different
or maybe custom `Exception` but that would be too much), but with this
method, we get to see custom messages along with exceptions for each
individual case - all that without unnecessarily overcomplicating the
code and sacrificing its readability to a considerable extent.

Suggested-by: Zabuzard <[email protected]>
Signed-off-by: Chris Sdogkos <[email protected]>

Author: christolis

application/src/main/java/org/togetherjava/tjbot/features/roleapplication/RoleApplicationHandler.java

@@ -10,6 +10,8 @@
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
 import net.dv8tion.jda.api.events.interaction.ModalInteractionEvent;
 import net.dv8tion.jda.api.interactions.modals.ModalMapping;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.togetherjava.tjbot.config.RoleApplicationSystemConfig;
 
@@ -29,8 +31,9 @@
  * users to prevent spamming.
  */
 public class RoleApplicationHandler {
-    private static final int APPLICATION_SUBMIT_COOLDOWN_MINUTES = 5;
+    private static final Logger logger = LoggerFactory.getLogger(RoleApplicationHandler.class);
 
+    private static final int APPLICATION_SUBMIT_COOLDOWN_MINUTES = 5;
     private final Cache<Member, OffsetDateTime> applicationSubmitCooldown;
     private final Predicate<String> applicationChannelPattern;
     private final RoleApplicationSystemConfig roleApplicationSystemConfig;
@@ -65,17 +68,26 @@ public RoleApplicationHandler(RoleApplicationSystemConfig roleApplicationSystemC
      * @param answer the answer provided by the applicant to the default question
      */
     protected void sendApplicationResult(final ModalInteractionEvent event, List<String> args,
-            String answer) {
+            String answer) throws IllegalArgumentException {
         Guild guild = event.getGuild();
-        if (args.size() != 2 || guild == null) {
-            return;
+
+        if (guild == null) {
+            throw new IllegalArgumentException(
+                    "sendApplicationResult() got fired in a non-guild environment.");
+        }
+
+        if (args.size() != 2) {
+            throw new IllegalArgumentException(
+                    "Received application result after user submitted one, and did not receive 2 arguments. Args: "
+                            + args);
         }
 
         String roleString = args.get(1);
 
         Optional<TextChannel> applicationChannel = getApplicationChannel(guild);
         if (applicationChannel.isEmpty()) {
-            return;
+            throw new IllegalArgumentException("Application channel %s could not be found."
+                .formatted(roleApplicationSystemConfig.submissionsChannelPattern()));
         }
 
         User applicant = event.getUser();
@@ -125,10 +137,17 @@ protected void submitApplicationFromModalInteraction(ModalInteractionEvent event
 
         ModalMapping modalAnswer = event.getValues().getFirst();
 
-        sendApplicationResult(event, args, modalAnswer.getAsString());
-        event.reply("Your application has been submitted. Thank you for applying! 😎")
-            .setEphemeral(true)
-            .queue();
+        try {
+            sendApplicationResult(event, args, modalAnswer.getAsString());
+            event.reply("Your application has been submitted. Thank you for applying! 😎")
+                .setEphemeral(true)
+                .queue();
+        } catch (IllegalArgumentException e) {
+            logger.error("A role application could not be submitted. ", e);
+            event.reply("Your application could not be submitted. Please contact the staff team.")
+                .setEphemeral(true)
+                .queue();
+        }
 
         applicationSubmitCooldown.put(event.getMember(), OffsetDateTime.now());
     }