Added command reference link to messages that want you to take an action

Author: jordybronowicki37

backend/src/main/java/dev/jb/befit/backend/discord/commands/CommandHandlerHelper.java

@@ -6,6 +6,7 @@
 import dev.jb.befit.backend.data.models.WebUser;
 import dev.jb.befit.backend.discord.commands.exceptions.OptionNotFoundException;
 import dev.jb.befit.backend.discord.commands.exceptions.ValueNotFoundException;
+import dev.jb.befit.backend.discord.registration.CommandRegistrarService;
 import discord4j.common.util.Snowflake;
 import discord4j.core.event.domain.interaction.ChatInputAutoCompleteEvent;
 import discord4j.core.event.domain.interaction.ChatInputInteractionEvent;
@@ -271,4 +272,13 @@ public static String addCongratulationsString(ExerciseLog log, Integer spacing,
         }
         return "";
     }
+
+    public static String getCommandReference(String... commandNames) {
+        var reference = new StringBuilder();
+        for (int i = 0; i < commandNames.length; i++) {
+            var commandName = commandNames[i];
+            reference.append(String.format("</%s:%d> ", commandName, CommandRegistrarService.getCommandId(commandName)));
+        }
+        return reference.toString();
+    }
 }

backend/src/main/java/dev/jb/befit/backend/discord/commands/handlers/exercises/ExerciseCreateCommandHandler.java

@@ -41,9 +41,11 @@ public Mono<Void> execute(ChatInputInteractionEvent event) {
                 .title("Your new exercise")
                 .addField(
                         String.format("#%d %s", exercise.getId(), exercise.getName()),
-                        String.format("Measurement: %s\nGoal direction: %s",
+                        String.format("Measurement: %s\nGoal direction: %s\n\n_Use %s to add a log for this exercise._\n_Use %s to add a goal for this exercise._",
                                 exercise.getMeasurementType().getLongName(),
-                                exercise.getGoalDirection().name().toLowerCase()
+                                exercise.getGoalDirection().name().toLowerCase(),
+                                CommandHandlerHelper.getCommandReference(CommandConstants.CommandLog),
+                                CommandHandlerHelper.getCommandReference(CommandConstants.CommandGoalsAdd)
                         ),
                         false)
                 .color(Color.GREEN)

backend/src/main/java/dev/jb/befit/backend/discord/commands/handlers/goals/GoalCancelCommandHandler.java

@@ -41,6 +41,7 @@ public Mono<Void> execute(ChatInputInteractionEvent event) {
 
         var embed = EmbedCreateSpec.builder()
                 .title(":no_entry_sign: Goal cancelled")
+                .description(String.format("Why would you cancel a goal you are working so hard for? :thinking:\nIf you would like to change the target value of a goal you can just replace it by using the %s command again.", CommandHandlerHelper.getCommandReference(CommandConstants.CommandGoalsAdd)))
                 .addField(goalsViewCommandHandler.getGoalField(goal))
                 .color(Color.GREEN)
                 .build();

backend/src/main/java/dev/jb/befit/backend/discord/commands/handlers/goals/GoalsViewCommandHandler.java

@@ -53,7 +53,7 @@ public InteractionReplyEditSpec getReplyEditSpec(Snowflake userId, int page) {
                 .title(":dart: Your goals")
                 .color(Color.GREEN);
 
-        if (goals.isEmpty()) embed.description(String.format("No goals yet, try creating a goal by using the command: `/%s`", CommandConstants.CommandGoalsAdd));
+        if (goals.isEmpty()) embed.description(String.format("No goals yet. Use the %s command to add a goal.", CommandHandlerHelper.getCommandReference(CommandConstants.CommandGoalsAdd)));
 
         goals.stream().skip((long) pageSize * page).limit(pageSize)
                 .sorted(Comparator.comparing(Goal::getCreated).reversed())

backend/src/main/java/dev/jb/befit/backend/discord/commands/handlers/habits/HabitsViewAllCommandHandler.java

@@ -71,7 +71,7 @@ public InteractionReplyEditSpec getReplyEditSpec(Snowflake userId, int page, Hab
                             return EmbedCreateFields.Field.of(habit.getName(), description.toString(), false);
                         }).toList()
                 );
-        if (habitsPage.isEmpty()) embed.description("You have no habits yet, try adding some!");
+        if (habitsPage.isEmpty()) embed.description(String.format("You have no habits yet, try adding some by using the command %s!", CommandHandlerHelper.getCommandReference(CommandConstants.CommandHabitsAdd)));
         var paginationControls = CommandHandlerHelper.getPaginationComponent(page, habitsPage.getTotalPages(), getCommandNameFilter(), String.valueOf(habitTimeRange));
         return InteractionReplyEditSpec.builder().addEmbed(embed.build()).addComponent(paginationControls).build();
     }

backend/src/main/java/dev/jb/befit/backend/discord/commands/handlers/help/HelpCommandHandler.java

@@ -45,13 +45,12 @@ private EmbedCreateSpec getGeneralEmbed(String avatarUrl) {
                 .title("About this bot")
                 .description("This bot helps you track your gym progress and motivates you into a better lifestyle.\n\n### Useful commands:")
                 .addFields(
-                        Field.of("/log", "Create a new log for an exercise. The more logs you create the better the bot can help you improve.", false),
-                        Field.of("/exercises create", "Don't see your favourite exercise inside of our catalogue? Just add it and track your progress for it!", false),
-                        Field.of("/exercises view ...", "View all the exercises, your own exercises or detailed information about a single exercise.", false),
-                        Field.of("/goals add", "Set goals for you to reach and work towards them.", false),
-                        Field.of("/progress", "Get a progress chart on a single exercise.", false),
-                        Field.of("/achievements", "See which achievements you have completed and which are still locked.", false),
-                        Field.of("/motivation", "If you are looking for motivation, just use this command and get some.", false)
+                        Field.of(CommandHandlerHelper.getCommandReference(CommandConstants.CommandLog), "Create a new log for an exercise. The more logs you create the better the bot can help you improve.", false),
+                        Field.of(CommandHandlerHelper.getCommandReference(CommandConstants.CommandExercisesCreate), "Don't see your favourite exercise inside of our catalogue? Just add it and track your progress for it!", false),
+                        Field.of(CommandHandlerHelper.getCommandReference(CommandConstants.CommandExercisesViewAll, CommandConstants.CommandExercisesViewMy, CommandConstants.CommandExercisesViewOne), "View all the exercises, your own exercises or detailed information about a single exercise.", false),
+                        Field.of(CommandHandlerHelper.getCommandReference(CommandConstants.CommandGoalsAdd), "Set goals for you to reach and work towards them.", false),
+                        Field.of(CommandHandlerHelper.getCommandReference(CommandConstants.CommandAchievements), "See which achievements you have completed and which are still locked.", false),
+                        Field.of(CommandHandlerHelper.getCommandReference(CommandConstants.CommandMotivation), "If you are looking for motivation, just use this command and get some.", false)
                 )
                 .color(Color.GRAY)
                 .build();
@@ -75,14 +74,12 @@ private EmbedCreateSpec getCommandEmbed(String avatarUrl, String commandName) {
 
         var fields = command.arguments()
                 .stream()
-                .map(a -> {
-                    return Field.of(a.name(), a.description(), false);
-                })
+                .map(a -> Field.of(a.name(), a.description(), false))
                 .toList();
 
         var embed = EmbedCreateSpec.builder()
                 .author("Befit bot", "https://github.com/jordybronowicki37/befit-bot", avatarUrl)
-                .title(capitalizeFirstLetter(commandName))
+                .title(CommandHandlerHelper.getCommandReference(commandName))
                 .description(description.toString())
                 .fields(fields)
                 .color(Color.GRAY);

backend/src/main/java/dev/jb/befit/backend/discord/commands/handlers/sessions/SessionViewOneCommandHandler.java

@@ -53,7 +53,7 @@ public static InteractionReplyEditSpec getReplyEditSpec(ExerciseSession session,
         var logsPage = CommandHandlerHelper.getPageForList(page, CommandConstants.PageSize, logs);
         var logsDescriptionBuilder = new StringBuilder();
 
-        if (logsPage.isEmpty()) logsDescriptionBuilder.append("_You have not added any logs yet._");
+        if (logsPage.isEmpty()) logsDescriptionBuilder.append(String.format("_You have not added any logs yet.\nUse the %s command to add a log._", CommandHandlerHelper.getCommandReference(CommandConstants.CommandLog)));
         else {
             logsPage.stream().sorted(Comparator.comparing(ExerciseLog::getCreated)).forEach(log -> {
                 addGeneralLogString(logsDescriptionBuilder, log);

backend/src/main/java/dev/jb/befit/backend/discord/registration/CommandRegistrarService.java

@@ -18,7 +18,9 @@
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.function.Consumer;
 import java.util.stream.Stream;
 
@@ -35,6 +37,8 @@ public class CommandRegistrarService {
     @Value("${discord.guilds.management}")
     private Long managementGuildId;
 
+    private static Map<String, Long> commandIds = new HashMap<>();
+
     private final GatewayDiscordClient discordClient;
     private final ResourceLoader resourceLoader;
     private final JacksonResources d4jMapper = JacksonResources.create();
@@ -81,11 +85,20 @@ private void bulkUpdateGlobalCommands(List<ApplicationCommandRequest> commands)
         assert applicationId != null;
 
         applicationService.bulkOverwriteGlobalApplicationCommand(applicationId, commands)
-                .doOnNext(cmd -> log.debug("Successfully updated global command: {}", cmd.name()))
+                .doOnNext(cmd -> {
+                    log.debug("Successfully updated global command: {}", cmd.name());
+                    commandIds.put(cmd.name(), cmd.id().asLong());
+                })
                 .doOnError(e -> log.error("Failed to update global command: ", e))
                 .subscribe();
     }
 
+    public static Long getCommandId(String commandName) {
+        var parentName = commandName.split(" ")[0];
+        if (commandIds.containsKey(parentName)) return commandIds.get(parentName);
+        return null;
+    }
+
     public ApplicationCommandRequest getCommandConfigFile(String fileName) throws IOException {
         var resource = resourceLoader.getResource(String.format(commandsPath, fileName));
         var command = d4jMapper.getObjectMapper().readValue(resource.getContentAsString(StandardCharsets.UTF_8), ApplicationCommandRequest.class);