Reload the web interface when the controller's plugins change

The web interface loads plugin bundles, registers their messages and
adds their config fields once in bootstrap, and has no way to undo any
of it.  A controller restarted to pick up a plugin being installed,
enabled or disabled comes back running a different set, and a controller
started in recovery mode runs none of them while still accepting control
connections, so open pages carry on sending messages it no longer
handles.

The controller already states the plugins it is running in the handshake
it sends on every connection, which is what hosts track as serverPlugins
and use to decide what to forward and which instance plugins to load.
Compare that against the set the page loaded and stop rendering on a
mismatch, asking to be reloaded instead.

The comparison is against loaded rather than enabled because loaded is
what the handshake reports and what the controller is actually running;
enabled also takes load_plugin into account, which only applies from the
next restart and would otherwise latch a permanent mismatch.

Closes #804
This commit is contained in:
bbassie committed 2026-08-10 10:01:35 +00:00
1 parent 5e0ab3423f
commit e3c18db7b8
4 files changed
+73 -6

No files matched your search

+26
View File
@@ -0,0 +1,26 @@
import type { PluginWebApi } from "@clusterio/lib";
/**
* Canonical key for a set of plugins loaded on the controller
*
* @param plugins - name to version mapping of loaded plugins.
* @returns value comparable with === against another key.
*/
export function pluginSetKey(plugins: Record<string, string>) {
return JSON.stringify(Object.entries(plugins).sort(([a], [b]) => a.localeCompare(b)));
}
/**
* Canonical key for the plugins loaded when this page was started
*
* @param pluginList - plugin list as served by /api/plugins.
* @returns value comparable with === against a key from the handshake.
*/
export function loadedPluginSetKey(pluginList: PluginWebApi[]) {
// The handshake reports the plugins the controller is running, so
// compare against loaded rather than enabled, which also takes the
// config into account and only applies from the next restart.
return pluginSetKey(Object.fromEntries(
pluginList.filter(plugin => plugin.loaded).map(plugin => [plugin.name, plugin.version])
));
}