Adding UserInteractor to the core system

it basically moves getName(), onButtonClick() and onSelectionMenu() from SlashCommand one level higher - so that also non-slash-commands can use it

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/commands/SlashCommand.java

@@ -1,15 +1,12 @@
 package org.togetherjava.tjbot.commands;
 
 import net.dv8tion.jda.api.entities.Emoji;
-import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
-import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
-import net.dv8tion.jda.api.events.interaction.component.SelectMenuInteractionEvent;
+import net.dv8tion.jda.api.events.interaction.ButtonClickEvent;
+import net.dv8tion.jda.api.events.interaction.SelectionMenuEvent;
+import net.dv8tion.jda.api.events.interaction.SlashCommandEvent;
 import net.dv8tion.jda.api.interactions.commands.build.CommandData;
-import net.dv8tion.jda.api.interactions.commands.build.Commands;
-import net.dv8tion.jda.api.interactions.commands.build.SlashCommandData;
+import net.dv8tion.jda.api.interactions.components.ButtonStyle;
 import net.dv8tion.jda.api.interactions.components.ComponentInteraction;
-import net.dv8tion.jda.api.interactions.components.buttons.Button;
-import net.dv8tion.jda.api.interactions.components.buttons.ButtonStyle;
 import org.jetbrains.annotations.NotNull;
 import org.togetherjava.tjbot.commands.componentids.ComponentId;
 import org.togetherjava.tjbot.commands.componentids.ComponentIdGenerator;
@@ -31,32 +28,19 @@
  * is then to be returned by {@link #getData()} where the system will then pick it up from.
  * <p>
  * After registration, the system will notify a command whenever one of its corresponding slash
- * commands ({@link #onSlashCommand(SlashCommandInteractionEvent)}), buttons
- * ({@link #onButtonClick(ButtonInteractionEvent, List)}) or menus
- * ({@link #onSelectionMenu(SelectMenuInteractionEvent, List)}) have been triggered.
+ * commands ({@link #onSlashCommand(SlashCommandEvent)}), buttons
+ * ({@link #onButtonClick(ButtonClickEvent, List)}) or menus
+ * ({@link #onSelectionMenu(SelectionMenuEvent, List)}) have been triggered.
  * <p>
  * <p>
  * Some example commands are available in {@link org.togetherjava.tjbot.commands.basic}.
  */
-public interface SlashCommand extends Feature {
-
-    /**
-     * Gets the name of the command.
-     * <p>
-     * Requirements for this are documented in {@link Commands#slash(String, String)}.
-     * <p>
-     * <p>
-     * After registration of the command, the name must not change anymore.
-     *
-     * @return the name of the command
-     */
-    @NotNull
-    String getName();
+public interface SlashCommand extends UserInteractor {
 
     /**
      * Gets the description of the command.
      * <p>
-     * Requirements for this are documented in {@link Commands#slash(String, String)}.
+     * Requirements for this are documented in {@link CommandData#CommandData(String, String)}.
      * <p>
      * <p>
      * After registration of the command, the description must not change anymore.
@@ -92,7 +76,7 @@ public interface SlashCommand extends Feature {
      * @return the command data of this command
      */
     @NotNull
-    SlashCommandData getData();
+    CommandData getData();
 
     /**
      * Triggered by the core system when a slash command corresponding to this implementation (based
@@ -107,9 +91,9 @@ public interface SlashCommand extends Feature {
      * <p>
      * Buttons or menus have to be created with a component ID (see
      * {@link ComponentInteraction#getComponentId()},
-     * {@link Button#of(ButtonStyle, String, Emoji)}}) in a very specific format, otherwise the core
-     * system will fail to identify the command that corresponded to the button or menu click event
-     * and is unable to route it back.
+     * {@link net.dv8tion.jda.api.interactions.components.Button#of(ButtonStyle, String, Emoji)}) in
+     * a very specific format, otherwise the core system will fail to identify the command that
+     * corresponded to the button or menu click event and is unable to route it back.
      * <p>
      * The component ID has to be a UUID-string (see {@link java.util.UUID}), which is associated to
      * a specific database entry, containing meta information about the command being executed. Such
@@ -118,8 +102,8 @@ public interface SlashCommand extends Feature {
      * given to {@link #acceptComponentIdGenerator(ComponentIdGenerator)} during system setup. The
      * required {@link ComponentId} instance accepts optional extra arguments, which, if provided,
      * can be picked up during the corresponding event (see
-     * {@link #onButtonClick(ButtonInteractionEvent, List)},
-     * {@link #onSelectionMenu(SelectMenuInteractionEvent, List)}).
+     * {@link #onButtonClick(ButtonClickEvent, List)},
+     * {@link #onSelectionMenu(SelectionMenuEvent, List)}).
      * <p>
      * Alternatively, if {@link SlashCommandAdapter} has been extended, it also offers a handy
      * {@link SlashCommandAdapter#generateComponentId(String...)} method to ease the flow.
@@ -132,57 +116,5 @@ public interface SlashCommand extends Feature {
      *
      * @param event the event that triggered this
      */
-    void onSlashCommand(@NotNull SlashCommandInteractionEvent event);
-
-    /**
-     * Triggered by the core system when a button corresponding to this implementation (based on
-     * {@link #getData()}) has been clicked.
-     * <p>
-     * This method may be called multi-threaded. In particular, there are no guarantees that it will
-     * be executed on the same thread repeatedly or on the same thread that other event methods have
-     * been called on.
-     * <p>
-     * Details are available in the given event and the event also enables implementations to
-     * respond to it.
-     * <p>
-     * This method will be called in a multi-threaded context and the event may not be hold valid
-     * forever.
-     *
-     * @param event the event that triggered this
-     * @param args the arguments transported with the button, see
-     *        {@link #onSlashCommand(SlashCommandInteractionEvent)} for details on how these are
-     *        created
-     */
-    void onButtonClick(@NotNull ButtonInteractionEvent event, @NotNull List<String> args);
-
-    /**
-     * Triggered by the core system when a selection menu corresponding to this implementation
-     * (based on {@link #getData()}) has been clicked.
-     * <p>
-     * This method may be called multi-threaded. In particular, there are no guarantees that it will
-     * be executed on the same thread repeatedly or on the same thread that other event methods have
-     * been called on.
-     * <p>
-     * Details are available in the given event and the event also enables implementations to
-     * respond to it.
-     * <p>
-     * This method will be called in a multi-threaded context and the event may not be hold valid
-     * forever.
-     *
-     * @param event the event that triggered this
-     * @param args the arguments transported with the selection menu, see
-     *        {@link #onSlashCommand(SlashCommandInteractionEvent)} for details on how these are
-     *        created
-     */
-    void onSelectionMenu(@NotNull SelectMenuInteractionEvent event, @NotNull List<String> args);
-
-    /**
-     * Triggered by the core system during its setup phase. It will provide the command a component
-     * id generator through this method, which can be used to generate component ids, as used for
-     * button or selection menus. See {@link #onSlashCommand(SlashCommandInteractionEvent)} for
-     * details on how to use this.
-     *
-     * @param generator the provided component id generator
-     */
-    void acceptComponentIdGenerator(@NotNull ComponentIdGenerator generator);
+    void onSlashCommand(@NotNull SlashCommandEvent event);
 }

application/src/main/java/org/togetherjava/tjbot/commands/UserInteractor.java

@@ -0,0 +1,84 @@
+package org.togetherjava.tjbot.commands;
+
+import net.dv8tion.jda.api.events.interaction.ButtonClickEvent;
+import net.dv8tion.jda.api.events.interaction.SelectionMenuEvent;
+import net.dv8tion.jda.api.events.interaction.SlashCommandEvent;
+import net.dv8tion.jda.api.interactions.commands.build.CommandData;
+import org.jetbrains.annotations.NotNull;
+import org.togetherjava.tjbot.commands.componentids.ComponentIdGenerator;
+
+import java.util.List;
+
+/**
+ * Represents a feature that can interact with users. The most important implementation is
+ * {@link SlashCommand}.
+ * <p>
+ * An interactor must have a unique name and can react to button clicks and selection menu actions.
+ */
+public interface UserInteractor extends Feature {
+
+    /**
+     * Gets the name of the interactor.
+     * <p>
+     * Requirements for this are documented in {@link CommandData#CommandData(String, String)}.
+     * <p>
+     * <p>
+     * After registration of the interactor, the name must not change anymore.
+     *
+     * @return the name of the interactor
+     */
+    @NotNull
+    String getName();
+
+    /**
+     * Triggered by the core system when a button corresponding to this implementation (based on
+     * {@link #getName()}) has been clicked.
+     * <p>
+     * This method may be called multi-threaded. In particular, there are no guarantees that it will
+     * be executed on the same thread repeatedly or on the same thread that other event methods have
+     * been called on.
+     * <p>
+     * Details are available in the given event and the event also enables implementations to
+     * respond to it.
+     * <p>
+     * This method will be called in a multi-threaded context and the event may not be hold valid
+     * forever.
+     *
+     * @param event the event that triggered this
+     * @param args the arguments transported with the button, see
+     *        {@link SlashCommand#onSlashCommand(SlashCommandEvent)} for details on how these are
+     *        created
+     */
+    void onButtonClick(@NotNull ButtonClickEvent event, @NotNull List<String> args);
+
+    /**
+     * Triggered by the core system when a selection menu corresponding to this implementation
+     * (based on {@link #getName()}) has been clicked.
+     * <p>
+     * This method may be called multi-threaded. In particular, there are no guarantees that it will
+     * be executed on the same thread repeatedly or on the same thread that other event methods have
+     * been called on.
+     * <p>
+     * Details are available in the given event and the event also enables implementations to
+     * respond to it.
+     * <p>
+     * This method will be called in a multi-threaded context and the event may not be hold valid
+     * forever.
+     *
+     * @param event the event that triggered this
+     * @param args the arguments transported with the selection menu, see
+     *        {@link SlashCommand#onSlashCommand(SlashCommandEvent)} for details on how these are
+     *        created
+     */
+    void onSelectionMenu(@NotNull SelectionMenuEvent event, @NotNull List<String> args);
+
+    /**
+     * Triggered by the core system during its setup phase. It will provide the interactor a
+     * component id generator through this method, which can be used to generate component ids, as
+     * used for button or selection menus. See
+     * {@link SlashCommand#onSlashCommand(SlashCommandEvent)} for details on how to use this.
+     *
+     * @param generator the provided component id generator
+     */
+    void acceptComponentIdGenerator(@NotNull ComponentIdGenerator generator);
+}

application/src/main/java/org/togetherjava/tjbot/commands/componentids/ComponentId.java

@@ -9,9 +9,9 @@
  * {@link org.togetherjava.tjbot.commands.SlashCommand#onSlashCommand(SlashCommandInteractionEvent)}
  * for its usages.
  *
- * @param commandName the name of the command that handles the event associated to this component
- *        ID, when triggered
+ * @param userInteractorName the name of the user interactor that handles the event associated to
+ *        this component ID, when triggered
  * @param elements the additional elements to carry along this component ID, empty if not desired
  */
-public record ComponentId(@NotNull String commandName, @NotNull List<String> elements) {
+public record ComponentId(@NotNull String userInteractorName, @NotNull List<String> elements) {
 }

application/src/main/java/org/togetherjava/tjbot/commands/componentids/ComponentIdStore.java

@@ -266,8 +266,8 @@ private void evictDatabase() {
                     recordToDelete.delete();
                     evictedCounter.getAndIncrement();
                     logger.debug(
-                            "Evicted component id with uuid '{}' from command '{}', last used '{}'",
-                            uuid, componentId.commandName(), lastUsed);
+                            "Evicted component id with uuid '{}' from user interactor '{}', last used '{}'",
+                            uuid, componentId.userInteractorName(), lastUsed);
 
                     // Remove them from the cache if still in there
                     storeCache.invalidate(uuid);