reverted most logic, introduced RevocableRoleBasedAction

interacsion · interacsion · commit 88212b667a2c · 2022-03-30T20:01:25.000+03:00
diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/RevocableModerationAction.java b/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/RevocableModerationAction.java
@@ -2,6 +2,7 @@
 
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.User;
+import net.dv8tion.jda.api.requests.ErrorResponse;
 import net.dv8tion.jda.api.requests.RestAction;
 import org.jetbrains.annotations.NotNull;
 import org.togetherjava.tjbot.commands.moderation.ModerationAction;
@@ -11,16 +12,6 @@
  * {@link TemporaryModerationRoutine} to identify and revoke such actions.
  */
 interface RevocableModerationAction {
-    /**
-     * The name of the action, that will be logged in case of a failed revocation.
-     *
-     * <p>
-     * Naming convention examples: {@code "ban"}, {@code "mute"}, {@code "quarantine"}
-     * </p>
-     */
-    @NotNull
-    String actionName();
-
     /**
      * The type to apply the temporary action, such as
      * {@link net.dv8tion.jda.api.audit.ActionType#BAN}.
@@ -50,4 +41,14 @@ interface RevocableModerationAction {
     @NotNull
     RestAction<Void> revokeAction(@NotNull Guild guild, @NotNull User target,
             @NotNull String reason);
+
+    /**
+     * Handle a failure that might occur during revocation, i.e. execution of the action returned by
+     * {@link #revokeAction(Guild, User, String)}.
+     * 
+     * @param errorResponse the error that occurred
+     * @param targetId the id of the user who is targeted by the revocation
+     * @return whether it should log an unknown failure message or not
+     */
+    boolean handleRevokeFailure(@NotNull ErrorResponse errorResponse, long targetId);
 }
diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/RevocableRoleBasedAction.java b/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/RevocableRoleBasedAction.java
@@ -0,0 +1,38 @@
+package org.togetherjava.tjbot.commands.moderation.temp;
+
+import net.dv8tion.jda.api.requests.ErrorResponse;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+abstract class RevocableRoleBasedAction implements RevocableModerationAction {
+    private static final Logger logger = LoggerFactory.getLogger(RevocableRoleBasedAction.class);
+
+    private final String actionName;
+
+    RevocableRoleBasedAction(String actionName) {
+        this.actionName = actionName;
+    }
+
+    @Override
+    public boolean handleRevokeFailure(@NotNull ErrorResponse error, long targetId) {
+        switch (error) {
+            case UNKNOWN_USER -> logger.debug(
+                    "Attempted to revoke a temporary {} but user '{}' does not exist anymore.",
+                    actionName, targetId);
+            case UNKNOWN_MEMBER -> logger.debug(
+                    "Attempted to revoke a temporary {} but user '{}' is not a member of the guild anymore.",
+                    actionName, targetId);
+            case UNKNOWN_ROLE -> logger.warn(
+                    "Attempted to revoke a temporary {} but the {} role can not be found.",
+                    actionName, actionName);
+            case MISSING_PERMISSIONS -> logger.warn(
+                    "Attempted to revoke a temporary {} but the bot lacks permission.", actionName);
+            default -> {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}
diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryBanAction.java b/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryBanAction.java
@@ -2,8 +2,11 @@
 
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.User;
+import net.dv8tion.jda.api.requests.ErrorResponse;
 import net.dv8tion.jda.api.requests.RestAction;
 import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.togetherjava.tjbot.commands.moderation.ModerationAction;
 
 /**
@@ -12,10 +15,7 @@
  * {@link TemporaryModerationRoutine}.
  */
 final class TemporaryBanAction implements RevocableModerationAction {
-    @Override
-    public @NotNull String actionName() {
-        return "ban";
-    }
+    private static final Logger logger = LoggerFactory.getLogger(TemporaryBanAction.class);
 
     @Override
     public @NotNull ModerationAction getApplyType() {
@@ -32,4 +32,23 @@ final class TemporaryBanAction implements RevocableModerationAction {
             @NotNull String reason) {
         return guild.unban(target).reason(reason);
     }
+
+    @Override
+    public boolean handleRevokeFailure(@NotNull ErrorResponse error, long targetId) {
+        switch (error) {
+            case UNKNOWN_USER -> logger.debug(
+                    "Attempted to revoke a temporary ban but user '{}' does not exist anymore.",
+                    targetId);
+            case MISSING_PERMISSIONS -> logger
+                .warn("Attempted to revoke a temporary ban but the bot lacks permission.");
+            case UNKNOWN_BAN -> logger.debug(
+                    "Attempted to revoke a temporary ban but the user '{}' is not banned anymore.",
+                    targetId);
+            default -> {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryModerationRoutine.java b/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryModerationRoutine.java
@@ -123,8 +123,21 @@ private void revokeAction(@NotNull RevocationGroupIdentifier groupIdentifier) {
         jda.retrieveUserById(groupIdentifier.targetId)
             .flatMap(target -> executeRevocation(guild, target, groupIdentifier.type))
             .queue(result -> {
-            }, failure -> handleFailure(failure, groupIdentifier.targetId,
-                    getRevocableActionByType(groupIdentifier.type).actionName()));
+            }, failure -> handleFailure(failure, groupIdentifier));
+    }
+
+    private void handleFailure(@NotNull Throwable failure,
+            @NotNull RevocationGroupIdentifier groupIdentifier) {
+        if (failure instanceof ErrorResponseException errorResponseException
+                && !getRevocableActionByType(groupIdentifier.type).handleRevokeFailure(
+                        errorResponseException.getErrorResponse(), groupIdentifier.targetId)) {
+
+            return;
+        }
+
+        logger.warn(
+                "Attempted to revoke a temporary moderation action for user '{}' but something unexpected went wrong.",
+                groupIdentifier.targetId, failure);
     }
 
     private @NotNull RestAction<Void> executeRevocation(@NotNull Guild guild, @NotNull User target,
@@ -140,36 +153,6 @@ private void revokeAction(@NotNull RevocationGroupIdentifier groupIdentifier) {
         return action.revokeAction(guild, target, reason);
     }
 
-    private void handleFailure(@NotNull Throwable failure, long targetId,
-            @NotNull String actionName) {
-        Runnable logUnknownFailure = () -> logger.warn(
-                "Attempted to revoke a temporary moderation action for user '{}' but something unexpected went wrong.",
-                targetId, failure);
-
-        if (failure instanceof ErrorResponseException errorResponseException) {
-            switch (errorResponseException.getErrorResponse()) {
-                case UNKNOWN_USER -> logger.debug(
-                        "Attempted to revoke a temporary {} but user '{}' does not exist anymore.",
-                        actionName, targetId);
-                case UNKNOWN_MEMBER -> logger.debug(
-                        "Attempted to revoke a temporary {} but user '{}' is not a member of the guild anymore.",
-                        actionName, targetId);
-                case UNKNOWN_ROLE -> logger.warn(
-                        "Attempted to revoke a temporary {} but the {} role can not be found.",
-                        actionName, actionName);
-                case MISSING_PERMISSIONS -> logger.warn(
-                        "Attempted to revoke a temporary {} but the bot lacks permission.",
-                        actionName);
-                case UNKNOWN_BAN -> logger.debug(
-                        "Attempted to revoke a temporary {} but the user '{}' is not banned anymore.",
-                        actionName, targetId);
-                default -> logUnknownFailure.run();
-            }
-        } else {
-            logUnknownFailure.run();
-        }
-    }
-
     private @NotNull RevocableModerationAction getRevocableActionByType(
             @NotNull ModerationAction type) {
         return Objects.requireNonNull(typeToRevocableAction.get(type),
diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryMuteAction.java b/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryMuteAction.java
@@ -13,7 +13,7 @@
  * {@link org.togetherjava.tjbot.commands.moderation.MuteCommand} and executed by
  * {@link TemporaryModerationRoutine}.
  */
-final class TemporaryMuteAction implements RevocableModerationAction {
+final class TemporaryMuteAction extends RevocableRoleBasedAction {
     private final Config config;
 
     /**
@@ -22,14 +22,10 @@ final class TemporaryMuteAction implements RevocableModerationAction {
      * @param config the config to use to identify the muted role
      */
     TemporaryMuteAction(@NotNull Config config) {
+        super("mute");
         this.config = config;
     }
 
-    @Override
-    public @NotNull String actionName() {
-        return "mute";
-    }
-
     @Override
     public @NotNull ModerationAction getApplyType() {
         return ModerationAction.MUTE;
diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryQuarantineAction.java b/application/src/main/java/org/togetherjava/tjbot/commands/moderation/temp/TemporaryQuarantineAction.java
@@ -13,7 +13,7 @@
  * {@link org.togetherjava.tjbot.commands.moderation.QuarantineCommand} and executed by
  * {@link TemporaryModerationRoutine}.
  */
-final class TemporaryQuarantineAction implements RevocableModerationAction {
+final class TemporaryQuarantineAction extends RevocableRoleBasedAction {
     private final Config config;
 
     /**
@@ -22,14 +22,10 @@ final class TemporaryQuarantineAction implements RevocableModerationAction {
      * @param config the config to use to identify the quarantined role
      */
     TemporaryQuarantineAction(@NotNull Config config) {
+        super("quarantine");
         this.config = config;
     }
 
-    @Override
-    public @NotNull String actionName() {
-        return "quarantine";
-    }
-
     @Override
     public @NotNull ModerationAction getApplyType() {
         return ModerationAction.QUARANTINE;
