improved "how to ask" explanation

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/commands/help/AskCommand.java

@@ -9,8 +9,10 @@
 import net.dv8tion.jda.api.interactions.commands.build.OptionData;
 import net.dv8tion.jda.api.requests.ErrorResponse;
 import net.dv8tion.jda.api.requests.RestAction;
+import net.dv8tion.jda.api.requests.restaction.MessageAction;
 import net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.togetherjava.tjbot.commands.SlashCommandAdapter;
@@ -19,6 +21,8 @@
 import org.togetherjava.tjbot.config.HelpSystemConfig;
 
 import java.awt.Color;
+import java.io.InputStream;
+import java.util.List;
 import java.util.Optional;
 import java.util.function.Predicate;
 import java.util.regex.Pattern;
@@ -31,6 +35,7 @@ public final class AskCommand extends SlashCommandAdapter {
     private static final String CATEGORY_OPTION = "category";
     // FIXME This constant is duplicated quite a lot...
     private static final Color AMBIENT_COLOR = Color.decode("#CCCC00");
+    private static final String CODE_SYNTAX_EXAMPLE_PATH = "codeSyntaxExample.png";
 
     private final Predicate<String> isStagingChannelName;
     private final String categoryRoleSuffix;
@@ -94,7 +99,7 @@ private boolean handleIsStagingChannel(@NotNull IReplyCallback event) {
             @NotNull String category) {
         return sendInitialMessage(event.getGuild(), threadChannel, author, title, category)
             .flatMap(any -> notifyUser(event, threadChannel))
-            .flatMap(any -> sendExplanationMessage(threadChannel, author));
+            .flatMap(any -> sendExplanationMessage(threadChannel));
     }
 
     private RestAction<Message> sendInitialMessage(@NotNull Guild guild,
@@ -118,31 +123,37 @@ private RestAction<Message> sendInitialMessage(@NotNull Guild guild,
             .flatMap(message -> message.editMessage(contentWithRole));
     }
 
-    private static RestAction<Message> sendExplanationMessage(@NotNull ThreadChannel threadChannel,
-            @NotNull Member author) {
-        MessageEmbed embed = new EmbedBuilder().setColor(AMBIENT_COLOR)
-            .setDescription(
-                    """
-                            %s, while you are waiting for getting help, here are some tips to improve your experience:
-
-                            - Code is much easier to read if posted with **syntax highlighting** and proper formatting:
-                            ```java
-                            \\`\\`\\`java
-                            // 3 backticks, java, newline, code, newline, 3 backticks
-                            System.out.println("This is how you format code in Discord");
-                            \\`\\`\\`
-                            ```
-
-                            - If your code is **long**, or you have **multiple files** to share, consider posting it on sites \
-                            like https://pastebin.com/ and share the link instead, that is easier to browse for helpers.
-
-                            - If nobody is calling back, that usually means that your question was **not well asked** and \
-                            hence nobody feels confident enough answering. Try to use your time to elaborate, \
-                            **provide details**, context, more code, examples and maybe some screenshots. \
-                            With enough info, someone knows the answer for sure ."""
-                        .formatted(author.getAsMention()))
-            .build();
-        return threadChannel.sendMessageEmbeds(embed);
+    private static RestAction<Message> sendExplanationMessage(
+            @NotNull MessageChannel threadChannel) {
+        boolean useCodeSyntaxExampleImage = true;
+        InputStream codeSyntaxExampleData =
+                AskCommand.class.getResourceAsStream("/" + CODE_SYNTAX_EXAMPLE_PATH);
+        if (codeSyntaxExampleData == null) {
+            useCodeSyntaxExampleImage = false;
+        }
+
+        String message =
+                "While you are waiting for getting help, here are some tips to improve your experience:";
+
+        List<MessageEmbed> embeds = List.of(embedWith(
+                "Code is much easier to read if posted with **syntax highlighting** and proper formatting.",
+                useCodeSyntaxExampleImage ? "attachment://" + CODE_SYNTAX_EXAMPLE_PATH : null),
+                embedWith(
+                        """
+                                If your code is **long**, or you have **multiple files** to share, consider posting it on sites \
+                                    like https://pastebin.com/ and share the link instead, that is easier to browse for helpers."""),
+                embedWith(
+                        """
+                                If nobody is calling back, that usually means that your question was **not well asked** and \
+                                    hence nobody feels confident enough answering. Try to use your time to elaborate, \
+                                    **provide details**, context, more code, examples and maybe some screenshots. \
+                                    With enough info, someone knows the answer for sure ."""));
+
+        MessageAction action = threadChannel.sendMessage(message);
+        if (useCodeSyntaxExampleImage) {
+            action = action.addFile(codeSyntaxExampleData, CODE_SYNTAX_EXAMPLE_PATH);
+        }
+        return action.setEmbeds(embeds);
     }
 
     private @NotNull Optional<Role> handleFindRoleForCategory(@NotNull String category,
@@ -180,4 +191,18 @@ private static void handleFailure(@NotNull Throwable exception, @NotNull IReplyC
 
         logger.error("Attempted to create a help thread, but failed", exception);
     }
+
+    private static @NotNull MessageEmbed embedWith(@NotNull CharSequence message) {
+        // FIXME Duplication with ImplicitAskListener
+        return embedWith(message, null);
+    }
+
+    private static @NotNull MessageEmbed embedWith(@NotNull CharSequence message,
+            @Nullable String imageUrl) {
+        // FIXME Duplication with ImplicitAskListener
+        return new EmbedBuilder().setColor(AMBIENT_COLOR)
+            .setDescription(message)
+            .setImage(imageUrl)
+            .build();
+    }
 }

application/src/main/java/org/togetherjava/tjbot/commands/help/ImplicitAskListener.java

@@ -11,14 +11,17 @@
 import net.dv8tion.jda.api.requests.RestAction;
 import net.dv8tion.jda.api.requests.restaction.MessageAction;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.togetherjava.tjbot.commands.MessageReceiverAdapter;
 import org.togetherjava.tjbot.config.Config;
 
 import java.awt.Color;
+import java.io.InputStream;
 import java.time.Instant;
 import java.time.temporal.ChronoUnit;
+import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import java.util.regex.Pattern;
@@ -30,6 +33,7 @@ public final class ImplicitAskListener extends MessageReceiverAdapter {
     private static final int TITLE_MAX_LENGTH = 30;
     // FIXME This constant is duplicated quite a lot...
     private static final Color AMBIENT_COLOR = Color.decode("#CCCC00");
+    private static final String CODE_SYNTAX_EXAMPLE_PATH = "codeSyntaxExample.png";
 
     private static final int COOLDOWN_DURATION_VALUE = 15;
     private static final ChronoUnit COOLDOWN_DURATION_UNIT = ChronoUnit.SECONDS;
@@ -131,7 +135,7 @@ private Optional<HelpThread> getLastHelpThreadIfOnCooldown(long userId) {
         return sendInitialMessage(threadChannel, message, title)
             .flatMap(any -> notifyUser(threadChannel, message))
             .flatMap(any -> message.delete())
-            .flatMap(any -> sendExplanationMessage(threadChannel, author));
+            .flatMap(any -> sendExplanationMessage(threadChannel));
     }
 
     private static @NotNull RestAction<Void> inviteUsersToThread(
@@ -172,34 +176,38 @@ private Optional<HelpThread> getLastHelpThreadIfOnCooldown(long userId) {
                                 threadChannel.getAsMention()));
     }
 
-    private static RestAction<Message> sendExplanationMessage(@NotNull ThreadChannel threadChannel,
-            @NotNull Member author) {
-        // FIXME Code duplication with AskCommand
-        MessageEmbed embed = new EmbedBuilder().setColor(AMBIENT_COLOR)
-            .setDescription(
-                    """
-                            %s, while you are waiting for getting help, here are some tips to improve your experience:
-
-                            - Code is much easier to read if posted with **syntax highlighting** and proper formatting:
-                            ```java
-                            \\`\\`\\`java
-                            // 3 backticks, java, newline, code, newline, 3 backticks
-                            System.out.println("This is how you format code in Discord");
-                            \\`\\`\\`
-                            ```
-
-                            - If your code is **long**, or you have **multiple files** to share, consider posting it on sites \
-                            like https://pastebin.com/ and share the link instead, that is easier to browse for helpers.
-
-                            - If nobody is calling back, that usually means that your question was **not well asked** and \
-                            hence nobody feels confident enough answering. Try to use your time to elaborate, \
-                            **provide details**, context, more code, examples and maybe some screenshots. \
-                            With enough info, someone knows the answer for sure ."""
-                        .formatted(author.getAsMention()))
-            .build();
-        return threadChannel.sendMessageEmbeds(embed);
-    }
+    private static RestAction<Message> sendExplanationMessage(
+            @NotNull MessageChannel threadChannel) {
+        boolean useCodeSyntaxExampleImage = true;
+        InputStream codeSyntaxExampleData =
+                AskCommand.class.getResourceAsStream("/" + CODE_SYNTAX_EXAMPLE_PATH);
+        if (codeSyntaxExampleData == null) {
+            useCodeSyntaxExampleImage = false;
+        }
 
+        String message =
+                "While you are waiting for getting help, here are some tips to improve your experience:";
+
+        List<MessageEmbed> embeds = List.of(embedWith(
+                "Code is much easier to read if posted with **syntax highlighting** and proper formatting.",
+                useCodeSyntaxExampleImage ? "attachment://" + CODE_SYNTAX_EXAMPLE_PATH : null),
+                embedWith(
+                        """
+                                If your code is **long**, or you have **multiple files** to share, consider posting it on sites \
+                                    like https://pastebin.com/ and share the link instead, that is easier to browse for helpers."""),
+                embedWith(
+                        """
+                                If nobody is calling back, that usually means that your question was **not well asked** and \
+                                    hence nobody feels confident enough answering. Try to use your time to elaborate, \
+                                    **provide details**, context, more code, examples and maybe some screenshots. \
+                                    With enough info, someone knows the answer for sure ."""));
+
+        MessageAction action = threadChannel.sendMessage(message);
+        if (useCodeSyntaxExampleImage) {
+            action = action.addFile(codeSyntaxExampleData, CODE_SYNTAX_EXAMPLE_PATH);
+        }
+        return action.setEmbeds(embeds);
+    }
 
     private static void handleFailure(@NotNull Throwable exception) {
         if (exception instanceof ErrorResponseException responseException) {
@@ -213,6 +221,20 @@ private static void handleFailure(@NotNull Throwable exception) {
         logger.error("Attempted to create a help thread, but failed", exception);
     }
 
+    private static @NotNull MessageEmbed embedWith(@NotNull CharSequence message) {
+        // FIXME Duplication with AskCommand
+        return embedWith(message, null);
+    }
+
+    private static @NotNull MessageEmbed embedWith(@NotNull CharSequence message,
+            @Nullable String imageUrl) {
+        // FIXME Duplication with AskCommand
+        return new EmbedBuilder().setColor(AMBIENT_COLOR)
+            .setDescription(message)
+            .setImage(imageUrl)
+            .build();
+    }
+
     private record HelpThread(long channelId, long authorId, @NotNull Instant creationTime) {
     }
 }