mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-23 00:13:13 +09:00
Add waitForPlugin and load plugins concurrently
Plugins can wait for another plugin on the same controller, host or instance with waitForPlugin(waiter, name, timeoutMs). It resolves to what the other plugin's entrypoint returned, or to undefined with a warning naming both plugins if it is not loaded once loading finishes or the timeout runs out. Plugin entrypoints now run concurrently so a plugin can await a plugin later in the list from its entrypoint. loadedPlugins is still filled in plugin list order, as the instance builds its Lua module list from it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
eefb4be44b
commit
c8e52e7bde
12 files changed
+408
-29
No files matched your search
@@ -24,6 +24,7 @@ export * from "./src/lua_tools.js";
|
||||
export * from "./src/permissions.js";
|
||||
export * from "./src/plugin.js";
|
||||
export * from "./src/plugin_loader.js";
|
||||
export * from "./src/PluginLoader.js";
|
||||
export * from "./src/loadPlugin.js";
|
||||
export * from "./src/prometheus.js";
|
||||
export * from "./src/schema.js";
|
||||
|
||||
@@ -0,0 +1,111 @@
|
||||
import { logger as defaultLogger, type Logger } from "./logging.js";
|
||||
import type { PluginNodeEnvInfo } from "./plugin.js";
|
||||
|
||||
type Waiter = {
|
||||
resolve: (api: unknown) => void,
|
||||
timeout: ReturnType<typeof setTimeout>,
|
||||
waiter: string,
|
||||
};
|
||||
|
||||
/**
|
||||
* Loads plugins concurrently and lets them wait for each other
|
||||
*
|
||||
* Owned by the object plugins are loaded into (controller, host or
|
||||
* instance).
|
||||
*/
|
||||
export class PluginLoader {
|
||||
private _apis = new Map<string, unknown>();
|
||||
private _waiters = new Map<string, Waiter[]>();
|
||||
private _finished = false;
|
||||
|
||||
constructor(
|
||||
private _logger: Logger = defaultLogger,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Load plugins concurrently
|
||||
*
|
||||
* Waits for all loads to settle, then throws the error of the first
|
||||
* plugin in the list that failed.
|
||||
*
|
||||
* @param pluginInfos - Plugins to load.
|
||||
* @param loadPlugin - Loads one plugin and returns what its entrypoint returned.
|
||||
*/
|
||||
async load(pluginInfos: PluginNodeEnvInfo[], loadPlugin: (pluginInfo: PluginNodeEnvInfo) => Promise<unknown>) {
|
||||
try {
|
||||
const results = await Promise.allSettled(pluginInfos.map(async pluginInfo => {
|
||||
this._loaded(pluginInfo.name, await loadPlugin(pluginInfo));
|
||||
}));
|
||||
const failed = results.find(result => result.status === "rejected");
|
||||
if (failed) {
|
||||
throw failed.reason;
|
||||
}
|
||||
} finally {
|
||||
this._finish();
|
||||
}
|
||||
}
|
||||
|
||||
private _loaded(name: string, api: unknown) {
|
||||
this._apis.set(name, api);
|
||||
for (const entry of this._waiters.get(name) ?? []) {
|
||||
clearTimeout(entry.timeout);
|
||||
entry.resolve(api);
|
||||
}
|
||||
this._waiters.delete(name);
|
||||
}
|
||||
|
||||
private _finish() {
|
||||
this._finished = true;
|
||||
for (const [name, entries] of this._waiters) {
|
||||
for (const entry of entries) {
|
||||
clearTimeout(entry.timeout);
|
||||
this._warnNotLoaded(entry.waiter, name);
|
||||
entry.resolve(undefined);
|
||||
}
|
||||
}
|
||||
this._waiters.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait for a plugin to load
|
||||
*
|
||||
* @param waiter - Name of the plugin waiting, used in warnings.
|
||||
* @param name - Name of the plugin to wait for.
|
||||
* @param timeoutMs - Time to wait before giving up.
|
||||
* @returns
|
||||
* What the plugin's entrypoint returned, or undefined with a
|
||||
* warning logged if it did not load.
|
||||
*/
|
||||
waitFor<T = unknown>(waiter: string, name: string, timeoutMs = 30_000): Promise<T | undefined> {
|
||||
if (this._apis.has(name)) {
|
||||
return Promise.resolve(this._apis.get(name) as T);
|
||||
}
|
||||
if (this._finished) {
|
||||
this._warnNotLoaded(waiter, name);
|
||||
return Promise.resolve(undefined);
|
||||
}
|
||||
|
||||
return new Promise(resolve => {
|
||||
const entry: Waiter = {
|
||||
resolve: resolve as (api: unknown) => void,
|
||||
waiter,
|
||||
timeout: setTimeout(() => {
|
||||
const entries = this._waiters.get(name)!;
|
||||
entries.splice(entries.indexOf(entry), 1);
|
||||
this._logger.warn(`Plugin ${waiter} timed out after ${timeoutMs}ms waiting for plugin ${name}`);
|
||||
resolve(undefined);
|
||||
}, timeoutMs),
|
||||
};
|
||||
let entries = this._waiters.get(name);
|
||||
if (!entries) {
|
||||
entries = [];
|
||||
this._waiters.set(name, entries);
|
||||
}
|
||||
entries.push(entry);
|
||||
});
|
||||
}
|
||||
|
||||
private _warnNotLoaded(waiter: string, name: string) {
|
||||
this._logger.warn(`Plugin ${waiter} waited for plugin ${name} which is not loaded`);
|
||||
}
|
||||
}
|
||||
@@ -17,7 +17,7 @@ export async function loadPluginEntrypoint<
|
||||
throw new Error(`Expected ${pluginType} plugin ${pluginInfo.name} to export a default function`);
|
||||
}
|
||||
|
||||
await init(context);
|
||||
return await init(context) as unknown;
|
||||
}
|
||||
|
||||
export async function loadPluginClass<
|
||||
|
||||
@@ -256,15 +256,13 @@ export async function loadPlugin<
|
||||
};
|
||||
|
||||
if (typeof module.default === "function") {
|
||||
await loadPluginEntrypoint(pluginInfo, pluginType, pluginContext, module);
|
||||
return;
|
||||
return await loadPluginEntrypoint(pluginInfo, pluginType, pluginContext, module);
|
||||
}
|
||||
|
||||
// migrate: accept plugins which export classes
|
||||
if (module[exportName]) {
|
||||
pluginContext.logger.warn(`Plugin ${pluginInfo.name} is using deprecated class export`);
|
||||
await loadPluginClass(pluginInfo, pluginType, pluginContext, module, exportName, baseClass);
|
||||
return;
|
||||
return await loadPluginClass(pluginInfo, pluginType, pluginContext, module, exportName, baseClass);
|
||||
}
|
||||
|
||||
throw new Error(`Plugin ${pluginInfo.name} must export either a default function or ${exportName} class`);
|
||||
|
||||
Reference in new issue
Block a user