refactor: rework caching, simplify TAB completion

WiIIiam278 · Mar 29, 2024 · 965b57b · 965b57b
1 parent a9adcd0
commit 965b57b
Show file tree

Hide file tree

Showing 21 changed files with 200 additions and 194 deletions.
diff --git a/bukkit/src/main/java/net/william278/huskchat/BukkitHuskChat.java b/bukkit/src/main/java/net/william278/huskchat/BukkitHuskChat.java
@@ -60,7 +60,6 @@ public class BukkitHuskChat extends JavaPlugin implements HuskChat, BukkitEventP
     private MorePaperLib morePaperLib;
     private BukkitAudiences audiences;
     private final List<ChatFilter> filtersAndReplacers = new ArrayList<>();
-    private final UserCache userCache = new UserCache();
     private final List<PlaceholderReplacer> placeholderReplacers = new ArrayList<>();
 
     @Setter
@@ -72,6 +71,8 @@ public class BukkitHuskChat extends JavaPlugin implements HuskChat, BukkitEventP
     @Setter
     private Filters filterSettings;
     @Setter
+    private UserCache.Editor userCache;
+    @Setter
     @Getter(AccessLevel.NONE)
     private DiscordHook discordHook;
     private DataGetter dataGetter;

diff --git a/bungee/src/main/java/net/william278/huskchat/BungeeHuskChat.java b/bungee/src/main/java/net/william278/huskchat/BungeeHuskChat.java
@@ -64,7 +64,6 @@ public final class BungeeHuskChat extends Plugin implements HuskChat, BungeeEven
     private static final int METRICS_ID = 11882;
 
     private final List<ChatFilter> filtersAndReplacers = new ArrayList<>();
-    private final UserCache userCache = new UserCache();
     private final List<PlaceholderReplacer> placeholderReplacers = new ArrayList<>();
 
     @Getter(AccessLevel.NONE)
@@ -78,6 +77,8 @@ public final class BungeeHuskChat extends Plugin implements HuskChat, BungeeEven
     @Setter
     private Filters filterSettings;
     @Setter
+    private UserCache.Editor userCache;
+    @Setter
     @Getter(AccessLevel.NONE)
     private DiscordHook discordHook;
     private DataGetter dataGetter;

diff --git a/common/src/main/java/net/william278/huskchat/HuskChat.java b/common/src/main/java/net/william278/huskchat/HuskChat.java
@@ -30,7 +30,6 @@
 import net.william278.huskchat.getter.DataGetter;
 import net.william278.huskchat.placeholders.PlaceholderReplacer;
 import net.william278.huskchat.user.OnlineUser;
-import net.william278.huskchat.user.UserCache;
 import net.william278.huskchat.util.AudiencesProvider;
 import org.jetbrains.annotations.NotNull;
 
@@ -53,9 +52,6 @@ default void loadDiscordHook() {
         }
     }
 
-    @NotNull
-    UserCache getUserCache();
-
     @NotNull
     List<PlaceholderReplacer> getPlaceholderReplacers();
 

diff --git a/common/src/main/java/net/william278/huskchat/api/HuskChatAPI.java b/common/src/main/java/net/william278/huskchat/api/HuskChatAPI.java
@@ -67,7 +67,7 @@ public String getPlayerChannel(@NotNull OnlineUser player) {
      * @since 3.0
      */
     public void setPlayerChannel(@NotNull OnlineUser player, @NotNull String channel) {
-        plugin.getUserCache().setPlayerChannel(player.getUuid(), channel);
+        plugin.editUserCache(c -> c.setPlayerChannel(player.getUuid(), channel));
     }
 
     /**

diff --git a/common/src/main/java/net/william278/huskchat/command/BroadcastCommand.java b/common/src/main/java/net/william278/huskchat/command/BroadcastCommand.java
@@ -24,7 +24,6 @@
 import net.william278.huskchat.user.OnlineUser;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.List;
 import java.util.StringJoiner;
 
 public class BroadcastCommand extends CommandBase {
@@ -47,8 +46,4 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
         }
     }
 
-    @Override
-    public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
-        return List.of();
-    }
 }
diff --git a/common/src/main/java/net/william278/huskchat/command/ChannelCommand.java b/common/src/main/java/net/william278/huskchat/command/ChannelCommand.java
@@ -43,13 +43,14 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
             return;
         }
         if (args.length == 1) {
-            plugin.getUserCache().switchPlayerChannel(player, args[0], plugin);
+            plugin.editUserCache(c -> c.switchPlayerChannel(player, args[0], plugin));
         } else {
             plugin.getLocales().sendMessage(player, "error_invalid_syntax", getUsage());
         }
     }
 
     @Override
+    @NotNull
     public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
         if (args.length <= 1) {
             return getUsableChannels(player).stream()

diff --git a/common/src/main/java/net/william278/huskchat/command/CommandBase.java b/common/src/main/java/net/william278/huskchat/command/CommandBase.java
@@ -63,7 +63,10 @@ public CommandBase(@NotNull List<String> aliases, @NotNull String usage, @NotNul
      * @param args   Current command arguments
      * @return List of String arguments to offer TAB suggestions
      */
-    public abstract List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args);
+    @NotNull
+    public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
+        return List.of();
+    }
 
     /**
      * Get the primary command alias

diff --git a/common/src/main/java/net/william278/huskchat/command/HuskChatCommand.java b/common/src/main/java/net/william278/huskchat/command/HuskChatCommand.java
@@ -92,6 +92,7 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
     }
 
     @Override
+    @NotNull
     public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
         if (args.length <= 1) {
             return Arrays.stream(COMMAND_TAB_ARGUMENTS)

diff --git a/common/src/main/java/net/william278/huskchat/command/LocalSpyCommand.java b/common/src/main/java/net/william278/huskchat/command/LocalSpyCommand.java
@@ -25,10 +25,9 @@
 import net.william278.huskchat.user.UserCache;
 import org.jetbrains.annotations.NotNull;
 
-import java.io.IOException;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
-import java.util.logging.Level;
 
 public class LocalSpyCommand extends CommandBase {
 
@@ -43,41 +42,38 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
             plugin.getLocales().sendMessage(player, "error_in_game_only");
             return;
         }
+
+        // Set with color
         if (args.length == 1) {
-            UserCache.SpyColor color;
-            Optional<UserCache.SpyColor> selectedColor = UserCache.SpyColor.getColor(args[0]);
-            if (selectedColor.isPresent()) {
-                try {
-                    color = selectedColor.get();
-                    plugin.getUserCache().setLocalSpy(player, color);
-                    plugin.getLocales().sendMessage(player, "local_spy_toggled_on_color",
-                            color.colorCode, color.name().toLowerCase().replaceAll("_", " "));
-                } catch (IOException e) {
-                    plugin.log(Level.SEVERE, "Failed to save local spy state to spies file");
-                }
+            final Optional<UserCache.SpyColor> selectedColor = UserCache.SpyColor.getColor(args[0]);
+            if (selectedColor.isEmpty()) {
+                plugin.getLocales().sendMessage(player, "error_invalid_syntax", getUsage());
                 return;
             }
+
+            final UserCache.SpyColor color = selectedColor.get();
+            plugin.editUserCache(c -> c.setLocalSpy(player, color));
+            plugin.getLocales().sendMessage(player, "local_spy_toggled_on_color",
+                    color.colorCode, color.name().toLowerCase().replaceAll("_", " "));
+            return;
         }
+
+        // Toggle without specifying color
         if (!plugin.getUserCache().isLocalSpying(player)) {
-            try {
-                plugin.getUserCache().setLocalSpy(player);
-                plugin.getLocales().sendMessage(player, "local_spy_toggled_on");
-            } catch (IOException e) {
-                plugin.log(Level.SEVERE, "Failed to save local spy state to spies file");
-            }
-        } else {
-            try {
-                plugin.getUserCache().removeLocalSpy(player);
-                plugin.getLocales().sendMessage(player, "local_spy_toggled_off");
-            } catch (IOException e) {
-                plugin.log(Level.SEVERE, "Failed to save local spy state to spies file");
-            }
+            plugin.editUserCache(c -> c.setLocalSpy(player));
+            plugin.getLocales().sendMessage(player, "local_spy_toggled_on");
+            return;
         }
+        plugin.editUserCache(c -> c.removeLocalSpy(player));
+        plugin.getLocales().sendMessage(player, "local_spy_toggled_off");
     }
 
     @Override
+    @NotNull
     public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
-        return List.of();
+        return Arrays.stream(UserCache.SpyColor.values())
+                .map(UserCache.SpyColor::name).map(String::toLowerCase)
+                .toList();
     }
 
 }
diff --git a/common/src/main/java/net/william278/huskchat/command/MessageCommand.java b/common/src/main/java/net/william278/huskchat/command/MessageCommand.java
@@ -65,6 +65,7 @@ private List<String> getTargetPlayers(String playerList) {
     }
 
     @Override
+    @NotNull
     public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
         if (args.length <= 1) {
             final ArrayList<String> userNames = new ArrayList<>();
@@ -95,9 +96,8 @@ public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[]
                 prependedUsernames.add(precursoryText + username);
             }
             return prependedUsernames;
-        } else {
-            return List.of();
         }
+        return List.of();
     }
 
 }
diff --git a/common/src/main/java/net/william278/huskchat/command/OptOutMessageCommand.java b/common/src/main/java/net/william278/huskchat/command/OptOutMessageCommand.java
@@ -21,7 +21,6 @@
 
 import net.william278.huskchat.HuskChat;
 import net.william278.huskchat.user.OnlineUser;
-import net.william278.huskchat.user.UserCache;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.List;
@@ -36,14 +35,14 @@ public OptOutMessageCommand(@NotNull HuskChat plugin) {
 
     @Override
     public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
-        UserCache.getLastMessengers(player.getUuid()).ifPresentOrElse(lastMessengers -> {
+        plugin.getUserCache().getLastMessengers(player.getUuid()).ifPresentOrElse(lastMessengers -> {
             if (lastMessengers.size() <= 1) {
                 plugin.getLocales().sendMessage(player, "error_last_message_not_group");
                 return;
             }
 
             for (UUID uuid : lastMessengers) {
-                UserCache.getLastMessengers(uuid).ifPresent(last -> last.remove(player.getUuid()));
+                plugin.getUserCache().getLastMessengers(uuid).ifPresent(last -> last.remove(player.getUuid()));
             }
 
             String playerList = lastMessengers.stream().flatMap(u -> plugin.getPlayer(u).stream())
@@ -59,9 +58,4 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
         }, () -> plugin.getLocales().sendMessage(player, "error_no_messages_opt_out"));
     }
 
-    @Override
-    public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
-        return List.of();
-    }
-
 }
diff --git a/common/src/main/java/net/william278/huskchat/command/ReplyCommand.java b/common/src/main/java/net/william278/huskchat/command/ReplyCommand.java
@@ -23,7 +23,6 @@
 import net.william278.huskchat.message.PrivateMessage;
 import net.william278.huskchat.user.ConsoleUser;
 import net.william278.huskchat.user.OnlineUser;
-import net.william278.huskchat.user.UserCache;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -38,7 +37,7 @@ public ReplyCommand(@NotNull HuskChat plugin) {
     @Override
     public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
         if (args.length >= 1) {
-            final Optional<Set<UUID>> lastMessengers = UserCache.getLastMessengers(player.getUuid());
+            final Optional<Set<UUID>> lastMessengers = plugin.getUserCache().getLastMessengers(player.getUuid());
             if (lastMessengers.isEmpty()) {
                 plugin.getLocales().sendMessage(player, "error_reply_no_messages");
                 return;
@@ -49,7 +48,7 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
                 if (ConsoleUser.isConsolePlayer(lastMessenger)) {
                     lastPlayers.add(ConsoleUser.wrap(plugin).getName());
                 } else {
-                    plugin.getPlayer(lastMessenger).ifPresent(onlineMessenger -> lastPlayers.add(onlineMessenger.getName()));
+                    plugin.getPlayer(lastMessenger).ifPresent(online -> lastPlayers.add(online.getName()));
                 }
             }
 
@@ -83,9 +82,4 @@ public String getPermission(@NotNull String... args) {
         );
     }
 
-    @Override
-    public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
-        return List.of();
-    }
-
 }
diff --git a/common/src/main/java/net/william278/huskchat/command/ShortcutCommand.java b/common/src/main/java/net/william278/huskchat/command/ShortcutCommand.java
@@ -48,7 +48,7 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
                 plugin.getLocales().sendMessage(player, "error_console_switch_channels");
                 return;
             }
-            plugin.getUserCache().switchPlayerChannel(player, channelId, plugin);
+            plugin.editUserCache(c -> c.switchPlayerChannel(player, channelId, plugin));
         } else {
             StringJoiner message = new StringJoiner(" ");
             for (String arg : args) {
@@ -79,9 +79,4 @@ public String getPermission(@NotNull String... args) {
                 .orElse(null);
     }
 
-    @Override
-    public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
-        return List.of();
-    }
-
 }
diff --git a/common/src/main/java/net/william278/huskchat/command/SocialSpyCommand.java b/common/src/main/java/net/william278/huskchat/command/SocialSpyCommand.java
@@ -25,10 +25,9 @@
 import net.william278.huskchat.user.UserCache;
 import org.jetbrains.annotations.NotNull;
 
-import java.io.IOException;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
-import java.util.logging.Level;
 
 public class SocialSpyCommand extends CommandBase {
 
@@ -43,41 +42,38 @@ public void onExecute(@NotNull OnlineUser player, @NotNull String[] args) {
             plugin.getLocales().sendMessage(player, "error_in_game_only");
             return;
         }
+
+        // Set with color
         if (args.length == 1) {
-            UserCache.SpyColor color;
-            Optional<UserCache.SpyColor> selectedColor = UserCache.SpyColor.getColor(args[0]);
-            if (selectedColor.isPresent()) {
-                try {
-                    color = selectedColor.get();
-                    plugin.getUserCache().setSocialSpy(player, color);
-                    plugin.getLocales().sendMessage(player, "social_spy_toggled_on_color",
-                            color.colorCode, color.name().toLowerCase().replaceAll("_", " "));
-                } catch (IOException e) {
-                    plugin.log(Level.SEVERE, "Failed to save social spy state to spies file");
-                }
+            final Optional<UserCache.SpyColor> selectedColor = UserCache.SpyColor.getColor(args[0]);
+            if (selectedColor.isEmpty()) {
+                plugin.getLocales().sendMessage(player, "error_invalid_syntax", getUsage());
                 return;
             }
+
+            final UserCache.SpyColor color = selectedColor.get();
+            plugin.editUserCache(c -> c.setSocialSpy(player, color));
+            plugin.getLocales().sendMessage(player, "social_spy_toggled_on_color",
+                    color.colorCode, color.name().toLowerCase().replaceAll("_", " "));
+            return;
         }
+
+        // Toggle without specifying color
         if (!plugin.getUserCache().isSocialSpying(player)) {
-            try {
-                plugin.getUserCache().setSocialSpy(player);
-                plugin.getLocales().sendMessage(player, "social_spy_toggled_on");
-            } catch (IOException e) {
-                plugin.log(Level.SEVERE, "Failed to save social spy state to spies file");
-            }
-        } else {
-            try {
-                plugin.getUserCache().removeSocialSpy(player);
-                plugin.getLocales().sendMessage(player, "social_spy_toggled_off");
-            } catch (IOException e) {
-                plugin.log(Level.SEVERE, "Failed to save social spy state to spies file");
-            }
+            plugin.editUserCache(c -> c.setSocialSpy(player));
+            plugin.getLocales().sendMessage(player, "social_spy_toggled_on");
+            return;
         }
+        plugin.editUserCache(c -> c.removeSocialSpy(player));
+        plugin.getLocales().sendMessage(player, "social_spy_toggled_off");
     }
 
     @Override
+    @NotNull
     public List<String> onTabComplete(@NotNull OnlineUser player, @NotNull String[] args) {
-        return List.of();
+        return Arrays.stream(UserCache.SpyColor.values())
+                .map(UserCache.SpyColor::name).map(String::toLowerCase)
+                .toList();
     }
 
 }