Add live web editor, guided setup and pairing for 3.3.7

.gitignore

@@ -31,3 +31,7 @@ dist/bin/
 *.tmp
 *.bak
 *.swp
+
+# wrangler dev
+node_modules/
+.wrangler/

README.md

@@ -234,11 +234,12 @@ api.onConnectionStateChanged(state -> {
   - [x] player locator service
   - [ ] more channel types and lifecycle hooks
 
-- [ ] **web interface**
-  - [ ] ...
-
-- [ ] **admin GUI**
-  - [ ] ...
+- [ ] **web editor (`/cb editor`)**
+  - [x] live session over a Cloudflare relay (no open ports, no self-hosting)
+  - [x] signed messages, secret only in the editor link
+  - [x] create, edit and delete scripts with inline validation errors
+  - [ ] config editing (without secrets and transport settings)
+  - [ ] backend config editing
 
 see the [open issues](https://github.com/objz/CommandBridge/issues) for bugs and feature requests.
 

backends/build.gradle.kts

@@ -31,6 +31,9 @@ tasks.jar {
 
 dependencies {
     testImplementation(libs.junit.jupiter)
+    testImplementation("org.spongepowered:configurate-yaml:4.2.0")
+    testImplementation("org.snakeyaml:snakeyaml-engine:2.10")
+    testImplementation("dev.jorel:commandapi-spigot-core:11.2.0")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
 }
 

backends/bukkit/src/main/java/dev/objz/commandbridge/bukkit/Adapter.java

@@ -13,6 +13,8 @@
 import dev.objz.commandbridge.backends.platform.ScheduleHandle;
 import dev.objz.commandbridge.backends.platform.cmd.ClientCommands;
 import dev.objz.commandbridge.backends.platform.cmd.CommandExecutor;
+import dev.objz.commandbridge.backends.platform.cmd.PairCommand;
+import dev.objz.commandbridge.backends.setup.PairClient;
 import dev.objz.commandbridge.config.ConfigManager;
 import dev.objz.commandbridge.config.model.BackendsConfig;
 import dev.objz.commandbridge.config.model.EndpointType;
@@ -38,6 +40,7 @@
 
 public final class Adapter implements PlatformAdapter<JavaPlugin> {
     private BackendClient client;
+    private RegistrationHandler registrationHandler;
     private BackendsConfig cfg;
     private Path dataDir;
     private JavaPlugin plugin;
@@ -53,6 +56,13 @@ public void load(PlatformEnv env, JavaPlugin plugin) throws Exception {
         this.cfg = cfgMgr.current();
         if (!ok || cfg == null) {
             configOk = false;
+            Log.info(PairClient.UNPAIRED_HINT);
+            return;
+        }
+        // the shipped config can't authenticate anywhere, so don't keep trying
+        if (PairClient.isUnpaired(cfg)) {
+            configOk = false;
+            Log.info(PairClient.UNPAIRED_HINT);
             return;
         }
 
@@ -66,11 +76,14 @@ public void load(PlatformEnv env, JavaPlugin plugin) throws Exception {
 
     @Override
     public void start(PlatformEnv env) throws Exception {
+        if (this.dataDir == null)
+            this.dataDir = PathsUtil.normalizeDataDir(env.dataDir());
+        // register /cbc pair even when the config is fresh or broken, since that's when it's needed
+        ClientCommands.register(() -> client,
+                PairCommand.subcommand(this, dataDir, Bukkit.getBukkitVersion().split("-")[0]));
         if (!configOk) {
             return;
         }
-        if (this.dataDir == null)
-            this.dataDir = PathsUtil.normalizeDataDir(env.dataDir());
         if (this.cfg == null) {
             var cfgMgr = new ConfigManager<>(dataDir, BackendsConfig.class);
             if (!cfgMgr.load()) {
@@ -89,6 +102,11 @@ public void start(PlatformEnv env) throws Exception {
                 Bukkit::isPrimaryThread,
                 task -> Bukkit.getScheduler().runTask(plugin, task));
 
+        startClient();
+        Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+    }
+
+    private void startClient() {
         this.client = cfg.endpointType() == EndpointType.REDIS
                 ? new RedisClient(cfg, dataDir, this)
                 : new WsClient(cfg, dataDir, this);
@@ -100,9 +118,7 @@ public void start(PlatformEnv env) throws Exception {
             client.scheduleReconnection();
         }
 
-        ClientCommands.register(client);
-
-        RegistrationHandler registrationHandler = new RegistrationHandler(client);
+        registrationHandler = new RegistrationHandler(client);
         client.inboundRouter().register(MessageType.REGISTER_COMMANDS, registrationHandler);
         client.inboundRouter().register(MessageType.EXECUTE_COMMAND,
                 new ExecuteCommandHandler(commandExecutor));
@@ -115,7 +131,37 @@ public void start(PlatformEnv env) throws Exception {
                         Location.BACKEND));
 
         client.onAuthenticated(this::sendPlayerList);
-        Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+    }
+
+    @Override
+    public void applyNewConfig() {
+        Bukkit.getScheduler().runTask(plugin, () -> {
+            try {
+                if (registrationHandler != null)
+                    registrationHandler.unregisterAll();
+                if (client != null)
+                    client.close();
+                var cfgMgr = new ConfigManager<>(dataDir, BackendsConfig.class);
+                if (!cfgMgr.load()) {
+                    Log.error("The paired config.yml is not valid");
+                    return;
+                }
+                this.cfg = cfgMgr.current();
+                Log.setDebug(cfg.debug());
+                if (commandExecutor == null)
+                    commandExecutor = new BukkitExecutor(plugin);
+                if (!configOk) {
+                    configOk = true;
+            Log.installThreadMarshalling(
+                    Bukkit::isPrimaryThread,
+                    task -> Bukkit.getScheduler().runTask(plugin, task));
+                    Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+                }
+                startClient();
+            } catch (Exception e) {
+                Log.error(e, "Could not connect with the new config: {}", e.getMessage());
+            }
+        });
     }
 
     @Override

backends/folia/src/main/java/dev/objz/commandbridge/folia/Adapter.java

@@ -13,6 +13,8 @@
 import dev.objz.commandbridge.backends.platform.ScheduleHandle;
 import dev.objz.commandbridge.backends.platform.cmd.ClientCommands;
 import dev.objz.commandbridge.backends.platform.cmd.CommandExecutor;
+import dev.objz.commandbridge.backends.platform.cmd.PairCommand;
+import dev.objz.commandbridge.backends.setup.PairClient;
 import dev.objz.commandbridge.config.ConfigManager;
 import dev.objz.commandbridge.config.model.BackendsConfig;
 import dev.objz.commandbridge.config.model.EndpointType;
@@ -39,6 +41,7 @@
 
 public final class Adapter implements PlatformAdapter<JavaPlugin> {
     private BackendClient client;
+    private RegistrationHandler registrationHandler;
     private BackendsConfig cfg;
     private Path dataDir;
     private JavaPlugin plugin;
@@ -54,6 +57,13 @@ public void load(PlatformEnv env, JavaPlugin plugin) throws Exception {
         this.cfg = cfgMgr.current();
         if (!ok || cfg == null) {
             configOk = false;
+            Log.info(PairClient.UNPAIRED_HINT);
+            return;
+        }
+        // the shipped config can't authenticate anywhere, so don't keep trying
+        if (PairClient.isUnpaired(cfg)) {
+            configOk = false;
+            Log.info(PairClient.UNPAIRED_HINT);
             return;
         }
 
@@ -67,11 +77,14 @@ public void load(PlatformEnv env, JavaPlugin plugin) throws Exception {
 
     @Override
     public void start(PlatformEnv env) throws Exception {
+        if (this.dataDir == null)
+            this.dataDir = PathsUtil.normalizeDataDir(env.dataDir());
+        // register /cbc pair even when the config is fresh or broken, since that's when it's needed
+        ClientCommands.register(() -> client,
+                PairCommand.subcommand(this, dataDir, Bukkit.getBukkitVersion().split("-")[0]));
         if (!configOk) {
             return;
         }
-        if (this.dataDir == null)
-            this.dataDir = PathsUtil.normalizeDataDir(env.dataDir());
         if (this.cfg == null) {
             var cfgMgr = new ConfigManager<>(dataDir, BackendsConfig.class);
             if (!cfgMgr.load()) {
@@ -86,6 +99,11 @@ public void start(PlatformEnv env) throws Exception {
             this.commandExecutor = new FoliaExecutor(plugin);
         }
 
+        startClient();
+        Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+    }
+
+    private void startClient() {
         this.client = cfg.endpointType() == EndpointType.REDIS
                 ? new RedisClient(cfg, dataDir, this)
                 : new WsClient(cfg, dataDir, this);
@@ -97,9 +115,7 @@ public void start(PlatformEnv env) throws Exception {
             client.scheduleReconnection();
         }
 
-        ClientCommands.register(client);
-
-        RegistrationHandler registrationHandler = new RegistrationHandler(client);
+        registrationHandler = new RegistrationHandler(client);
         client.inboundRouter().register(MessageType.REGISTER_COMMANDS, registrationHandler);
         client.inboundRouter().register(MessageType.EXECUTE_COMMAND,
                 new ExecuteCommandHandler(commandExecutor));
@@ -112,7 +128,34 @@ public void start(PlatformEnv env) throws Exception {
                         Location.BACKEND));
 
         client.onAuthenticated(this::sendPlayerList);
-        Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+    }
+
+    @Override
+    public void applyNewConfig() {
+        Bukkit.getGlobalRegionScheduler().execute(plugin, () -> {
+            try {
+                if (registrationHandler != null)
+                    registrationHandler.unregisterAll();
+                if (client != null)
+                    client.close();
+                var cfgMgr = new ConfigManager<>(dataDir, BackendsConfig.class);
+                if (!cfgMgr.load()) {
+                    Log.error("The paired config.yml is not valid");
+                    return;
+                }
+                this.cfg = cfgMgr.current();
+                Log.setDebug(cfg.debug());
+                if (commandExecutor == null)
+                    commandExecutor = new FoliaExecutor(plugin);
+                if (!configOk) {
+                    configOk = true;
+                    Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+                }
+                startClient();
+            } catch (Exception e) {
+                Log.error(e, "Could not connect with the new config: {}", e.getMessage());
+            }
+        });
     }
 
     @Override

backends/paper/src/main/java/dev/objz/commandbridge/paper/Adapter.java

@@ -13,6 +13,8 @@
 import dev.objz.commandbridge.backends.platform.ScheduleHandle;
 import dev.objz.commandbridge.backends.platform.cmd.ClientCommands;
 import dev.objz.commandbridge.backends.platform.cmd.CommandExecutor;
+import dev.objz.commandbridge.backends.platform.cmd.PairCommand;
+import dev.objz.commandbridge.backends.setup.PairClient;
 import dev.objz.commandbridge.config.ConfigManager;
 import dev.objz.commandbridge.config.model.BackendsConfig;
 import dev.objz.commandbridge.config.model.EndpointType;
@@ -38,6 +40,7 @@
 
 public final class Adapter implements PlatformAdapter<JavaPlugin> {
     private BackendClient client;
+    private RegistrationHandler registrationHandler;
     private BackendsConfig cfg;
     private Path dataDir;
     private JavaPlugin plugin;
@@ -53,6 +56,13 @@ public void load(PlatformEnv env, JavaPlugin plugin) throws Exception {
         this.cfg = cfgMgr.current();
         if (!ok || cfg == null) {
             configOk = false;
+            Log.info(PairClient.UNPAIRED_HINT);
+            return;
+        }
+        // the shipped config can't authenticate anywhere, so don't keep trying
+        if (PairClient.isUnpaired(cfg)) {
+            configOk = false;
+            Log.info(PairClient.UNPAIRED_HINT);
             return;
         }
 
@@ -66,11 +76,14 @@ public void load(PlatformEnv env, JavaPlugin plugin) throws Exception {
 
     @Override
     public void start(PlatformEnv env) throws Exception {
+        if (this.dataDir == null)
+            this.dataDir = PathsUtil.normalizeDataDir(env.dataDir());
+        // register /cbc pair even when the config is fresh or broken, since that's when it's needed
+        ClientCommands.register(() -> client,
+                PairCommand.subcommand(this, dataDir, Bukkit.getBukkitVersion().split("-")[0]));
         if (!configOk) {
             return;
         }
-        if (this.dataDir == null)
-            this.dataDir = PathsUtil.normalizeDataDir(env.dataDir());
         if (this.cfg == null) {
             var cfgMgr = new ConfigManager<>(dataDir, BackendsConfig.class);
             if (!cfgMgr.load()) {
@@ -89,6 +102,11 @@ public void start(PlatformEnv env) throws Exception {
                 Bukkit::isPrimaryThread,
                 task -> Bukkit.getScheduler().runTask(plugin, task));
 
+        startClient();
+        Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+    }
+
+    private void startClient() {
         this.client = cfg.endpointType() == EndpointType.REDIS
                 ? new RedisClient(cfg, dataDir, this)
                 : new WsClient(cfg, dataDir, this);
@@ -100,9 +118,7 @@ public void start(PlatformEnv env) throws Exception {
             client.scheduleReconnection();
         }
 
-        ClientCommands.register(client);
-
-        RegistrationHandler registrationHandler = new RegistrationHandler(client);
+        registrationHandler = new RegistrationHandler(client);
         client.inboundRouter().register(MessageType.REGISTER_COMMANDS, registrationHandler);
         client.inboundRouter().register(MessageType.EXECUTE_COMMAND,
                 new ExecuteCommandHandler(commandExecutor));
@@ -115,7 +131,37 @@ public void start(PlatformEnv env) throws Exception {
                         Location.BACKEND));
 
         client.onAuthenticated(this::sendPlayerList);
-        Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+    }
+
+    @Override
+    public void applyNewConfig() {
+        Bukkit.getScheduler().runTask(plugin, () -> {
+            try {
+                if (registrationHandler != null)
+                    registrationHandler.unregisterAll();
+                if (client != null)
+                    client.close();
+                var cfgMgr = new ConfigManager<>(dataDir, BackendsConfig.class);
+                if (!cfgMgr.load()) {
+                    Log.error("The paired config.yml is not valid");
+                    return;
+                }
+                this.cfg = cfgMgr.current();
+                Log.setDebug(cfg.debug());
+                if (commandExecutor == null)
+                    commandExecutor = new PaperExecutor(plugin);
+                if (!configOk) {
+                    configOk = true;
+                    Log.installThreadMarshalling(
+                            Bukkit::isPrimaryThread,
+                            task -> Bukkit.getScheduler().runTask(plugin, task));
+                    Bukkit.getPluginManager().registerEvents(new PlayerListener(), plugin);
+                }
+                startClient();
+            } catch (Exception e) {
+                Log.error(e, "Could not connect with the new config: {}", e.getMessage());
+            }
+        });
     }
 
     @Override