Remove a unnecessary abstraction, improve some documentation

DiscordSRV · Oct 20, 2024 · fdaa215 · fdaa215
1 parent 7d47552
commit fdaa215
Show file tree

Hide file tree

Showing 13 changed files with 98 additions and 153 deletions.
diff --git a/bukkit/src/main/java/com/discordsrv/bukkit/BukkitDiscordSRV.java b/bukkit/src/main/java/com/discordsrv/bukkit/BukkitDiscordSRV.java
@@ -40,7 +40,7 @@
 import com.discordsrv.bukkit.scheduler.BukkitScheduler;
 import com.discordsrv.bukkit.scheduler.FoliaScheduler;
 import com.discordsrv.bukkit.scheduler.IBukkitScheduler;
-import com.discordsrv.common.ServerDiscordSRV;
+import com.discordsrv.common.AbstractDiscordSRV;
 import com.discordsrv.common.abstraction.plugin.PluginManager;
 import com.discordsrv.common.command.game.handler.ICommandHandler;
 import com.discordsrv.common.config.configurate.manager.ConnectionConfigManager;
@@ -59,7 +59,7 @@
 import java.util.List;
 import java.util.Set;
 
-public class BukkitDiscordSRV extends ServerDiscordSRV<DiscordSRVBukkitBootstrap, BukkitConfig, BukkitConnectionConfig, MessagesConfig> {
+public class BukkitDiscordSRV extends AbstractDiscordSRV<DiscordSRVBukkitBootstrap, BukkitConfig, BukkitConnectionConfig, MessagesConfig> {
 
     private BukkitAudiences audiences;
     private BukkitTranslationLoader translationLoader;
@@ -124,6 +124,11 @@ public BukkitConsole console() {
         return console;
     }
 
+    @Override
+    public ServerType serverType() {
+        return ServerType.SERVER;
+    }
+
     @Override
     public @NotNull BukkitPlayerProvider playerProvider() {
         return playerProvider;

diff --git a/bungee/src/main/java/com/discordsrv/bungee/BungeeDiscordSRV.java b/bungee/src/main/java/com/discordsrv/bungee/BungeeDiscordSRV.java
@@ -22,7 +22,7 @@
 import com.discordsrv.bungee.console.BungeeConsole;
 import com.discordsrv.bungee.player.BungeePlayerProvider;
 import com.discordsrv.bungee.plugin.BungeePluginManager;
-import com.discordsrv.common.ProxyDiscordSRV;
+import com.discordsrv.common.AbstractDiscordSRV;
 import com.discordsrv.common.abstraction.plugin.PluginManager;
 import com.discordsrv.common.command.game.handler.ICommandHandler;
 import com.discordsrv.common.config.configurate.manager.ConnectionConfigManager;
@@ -38,7 +38,7 @@
 import net.md_5.bungee.api.plugin.Plugin;
 import org.jetbrains.annotations.NotNull;
 
-public class BungeeDiscordSRV extends ProxyDiscordSRV<DiscordSRVBungeeBootstrap, MainConfig, ConnectionConfig, MessagesConfig> {
+public class BungeeDiscordSRV extends AbstractDiscordSRV<DiscordSRVBungeeBootstrap, MainConfig, ConnectionConfig, MessagesConfig> {
 
     private BungeeAudiences audiences;
 
@@ -71,6 +71,11 @@ public BungeeAudiences audiences() {
         return audiences;
     }
 
+    @Override
+    public ServerType serverType() {
+        return ServerType.PROXY;
+    }
+
     @Override
     public StandardScheduler scheduler() {
         return scheduler;

diff --git a/common/src/main/java/com/discordsrv/common/AbstractDiscordSRV.java b/common/src/main/java/com/discordsrv/common/AbstractDiscordSRV.java
@@ -75,10 +75,7 @@
 import com.discordsrv.common.feature.mention.MentionGameRenderingModule;
 import com.discordsrv.common.feature.messageforwarding.discord.DiscordChatMessageModule;
 import com.discordsrv.common.feature.messageforwarding.discord.DiscordMessageMirroringModule;
-import com.discordsrv.common.feature.messageforwarding.game.JoinMessageModule;
-import com.discordsrv.common.feature.messageforwarding.game.LeaveMessageModule;
-import com.discordsrv.common.feature.messageforwarding.game.StartMessageModule;
-import com.discordsrv.common.feature.messageforwarding.game.StopMessageModule;
+import com.discordsrv.common.feature.messageforwarding.game.*;
 import com.discordsrv.common.feature.mention.MentionCachingModule;
 import com.discordsrv.common.feature.profile.ProfileManager;
 import com.discordsrv.common.feature.update.UpdateChecker;
@@ -133,6 +130,7 @@ public abstract class AbstractDiscordSRV<
 
     private final AtomicReference<Status> status = new AtomicReference<>(Status.INITIALIZED);
     private final AtomicReference<Boolean> beenReady = new AtomicReference<>(false);
+    private boolean serverStarted = false;
 
     // DiscordSRVApi
     private EventBusImpl eventBus;
@@ -598,6 +596,14 @@ protected void enable() throws Throwable {
         registerModule(MentionGameRenderingModule::new);
         registerModule(CustomCommandModule::new);
 
+        if (serverType() == ServerType.PROXY) {
+            registerModule(ServerSwitchMessageModule::new);
+        }
+        if (serverType() == ServerType.SERVER) {
+            registerModule(AwardMessageModule::new);
+            registerModule(DeathMessageModule::new);
+        }
+
         // Integrations
         registerIntegration("com.discordsrv.common.integration.LuckPermsIntegration");
 
@@ -608,16 +614,49 @@ protected void enable() throws Throwable {
             throw e.getCause();
         }
 
+        if (serverType() == ServerType.PROXY) {
+            invokeServerStarted().get();
+        }
+
         // Register PlayerProvider listeners
         playerProvider().subscribe();
     }
 
-    protected final void startedMessage() {
+    public final CompletableFuture<Void> invokeServerStarted() {
+        return scheduler().supply(() -> {
+            if (status().isShutdown()) {
+                // Already shutdown/shutting down, don't bother
+                return null;
+            }
+            try {
+                this.serverStarted();
+            } catch (Throwable t) {
+                if (status().isShutdown() && t instanceof NoClassDefFoundError) {
+                    // Already shutdown, ignore errors for classes that already got unloaded
+                    return null;
+                }
+                setStatus(Status.FAILED_TO_START);
+                disable();
+                logger().error("Failed to start", t);
+            }
+            return null;
+        });
+    }
+
+    @MustBeInvokedByOverriders
+    protected void serverStarted() {
+        serverStarted = true;
+        moduleManager().enableModules();
+
         registerModule(StartMessageModule::new);
         registerModule(StopMessageModule::new);
         Optional.ofNullable(getModule(PresenceUpdaterModule.class)).ifPresent(PresenceUpdaterModule::serverStarted);
     }
 
+    public boolean isServerStarted() {
+        return serverStarted;
+    }
+
     private StorageType getStorageType() {
         String backend = connectionConfig().storage.backend;
         switch (backend.toLowerCase(Locale.ROOT)) {

diff --git a/common/src/main/java/com/discordsrv/common/DiscordSRV.java b/common/src/main/java/com/discordsrv/common/DiscordSRV.java
@@ -72,6 +72,7 @@ public interface DiscordSRV extends DiscordSRVApi {
     String WEBSITE = "https://discordsrv.vankka.dev";
 
     // Platform
+    ServerType serverType();
     IBootstrap bootstrap();
     Logger platformLogger();
     Path dataDirectory();
@@ -172,10 +173,16 @@ default <K, V> Caffeine<K, V> caffeineBuilder() {
     void runEnable();
     List<ReloadResult> runReload(Set<ReloadFlag> flags, boolean silent);
     CompletableFuture<Void> invokeDisable();
+    boolean isServerStarted();
 
     @Nullable
     default GameCommandExecutionHelper executeHelper() {
         return null;
     }
 
+    enum ServerType {
+        SERVER,
+        PROXY
+    }
+
 }
diff --git a/common/src/main/java/com/discordsrv/common/ProxyDiscordSRV.java b/common/src/main/java/com/discordsrv/common/ProxyDiscordSRV.java
diff --git a/common/src/main/java/com/discordsrv/common/ServerDiscordSRV.java b/common/src/main/java/com/discordsrv/common/ServerDiscordSRV.java
diff --git a/common/src/main/java/com/discordsrv/common/abstraction/bootstrap/IBootstrap.java b/common/src/main/java/com/discordsrv/common/abstraction/bootstrap/IBootstrap.java
@@ -23,6 +23,9 @@
 
 import java.nio.file.Path;
 
+/**
+ * The plugin-/mod main "startup" class that the server sees.
+ */
 public interface IBootstrap {
 
     Logger logger();

diff --git a/common/src/main/java/com/discordsrv/common/abstraction/bootstrap/LifecycleManager.java b/common/src/main/java/com/discordsrv/common/abstraction/bootstrap/LifecycleManager.java
@@ -36,6 +36,9 @@
 import java.util.concurrent.Executors;
 import java.util.function.Supplier;
 
+/**
+ * A wrapper for loading in the initial dependencies, enabling and disabling {@link DiscordSRV}.
+ */
 public class LifecycleManager {
 
     private final Logger logger;

diff --git a/common/src/main/java/com/discordsrv/common/feature/channel/TimedUpdaterModule.java b/common/src/main/java/com/discordsrv/common/feature/channel/TimedUpdaterModule.java
@@ -21,7 +21,6 @@
 import com.discordsrv.api.DiscordSRVApi;
 import com.discordsrv.api.discord.connection.jda.errorresponse.ErrorCallbackContext;
 import com.discordsrv.common.DiscordSRV;
-import com.discordsrv.common.ServerDiscordSRV;
 import com.discordsrv.common.config.main.TimedUpdaterConfig;
 import com.discordsrv.common.core.logging.NamedLogger;
 import com.discordsrv.common.core.module.type.AbstractModule;
@@ -64,9 +63,7 @@ public boolean isEnabled() {
             return false;
         }
 
-        return super.isEnabled() && discordSRV.isReady() &&
-                (!(discordSRV instanceof ServerDiscordSRV)
-                        || ((ServerDiscordSRV<?, ?, ?, ?>) discordSRV).isServerStarted());
+        return super.isEnabled() && discordSRV.isReady() && discordSRV.isServerStarted();
     }
 
     @Override

diff --git a/common/src/main/java/com/discordsrv/common/helper/Someone.java b/common/src/main/java/com/discordsrv/common/helper/Someone.java
@@ -29,6 +29,17 @@
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
+/**
+ * Represents a subject that is
+ * - a Minecraft player, or
+ * - a Discord user, or
+ * - a Minecraft player and their linked Discord user
+ *
+ * @see #withLinkedAccounts(DiscordSRV)
+ * @see #withUserId(DiscordSRV)
+ * @see #withPlayerUUID(DiscordSRV)
+ * @see #profile(DiscordSRV)
+ */
 public class Someone {
 
     public static Someone.Resolved of(@NotNull DiscordSRVPlayer player, @NotNull DiscordUser user) {

diff --git a/common/src/main/java/com/discordsrv/common/helper/TestHelper.java b/common/src/main/java/com/discordsrv/common/helper/TestHelper.java
@@ -20,6 +20,9 @@
 
 import java.util.function.Consumer;
 
+/**
+ * Data access for unit testing.
+ */
 public final class TestHelper {
 
     private static final ThreadLocal<Consumer<Throwable>> error = new ThreadLocal<>();

diff --git a/common/src/test/java/com/discordsrv/common/MockDiscordSRV.java b/common/src/test/java/com/discordsrv/common/MockDiscordSRV.java
@@ -105,6 +105,11 @@ public Path dataDirectory() {
         versionInfo = new VersionInfo("JUnit", "JUnit", "JUnit", "JUnit");
     }
 
+    @Override
+    public ServerType serverType() {
+        return ServerType.SERVER;
+    }
+
     @Override
     public Path dataDirectory() {
         if (this.path == null) {