mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-11 23:04:52 +09:00
7122cbccf8
Replace invokeHook and the per plugin on* methods with AsyncHook collections on the controller, host, instance, clusterioctl and web control objects. Plugin entrypoints export a default function that receives a load context and attaches handlers to the hooks it needs. Class exports still load through fromContext with a deprecation warning. The create templates and docs use the entrypoint function. This is clusterio/clusterio#921 recreated on top of master after the ESM migration and the PluginDeclaration permissions change. Closes #730 Co-Authored-By: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com> Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
60 lines
2.3 KiB
JavaScript
60 lines
2.3 KiB
JavaScript
import assert from "node:assert/strict";
|
|
|
|
import * as mock from "../mock.js";
|
|
import * as controller from "@clusterio/controller";
|
|
|
|
describe("controller/src/BaseControllerPlugin", function() {
|
|
describe("class BaseControllerPlugin", function() {
|
|
const info = { name: "test" };
|
|
let mockController;
|
|
beforeEach(function() {
|
|
mockController = new mock.MockController();
|
|
});
|
|
|
|
it("should be constructible", async function() {
|
|
const plugin = new controller.BaseControllerPlugin(info, mockController, {}, new mock.MockLogger());
|
|
await plugin.init();
|
|
assert.equal(mockController.hooks.size, 0);
|
|
});
|
|
it("should be constructible from a load context", async function() {
|
|
const logger = new mock.MockLogger();
|
|
const plugin = controller.BaseControllerPlugin.fromContext({
|
|
plugin: info, controller: mockController, metrics: {}, logger,
|
|
});
|
|
assert.equal(plugin.info, info);
|
|
assert.equal(plugin.controller, mockController);
|
|
assert.equal(plugin.logger, logger);
|
|
});
|
|
it("should attach overridden hooks", async function() {
|
|
let calls = [];
|
|
class ControllerPlugin extends controller.BaseControllerPlugin {
|
|
async onSaveData() { calls.push(["save", this]); }
|
|
async onInstanceStatusChanged(instance, prev) { calls.push(["status", instance, prev]); }
|
|
onHostConnectionEvent(connection, event) { calls.push(["host", connection, event]); }
|
|
}
|
|
const plugin = new ControllerPlugin(info, mockController, {}, new mock.MockLogger());
|
|
assert.deepEqual([...mockController.hooks.attached], ["test"]);
|
|
assert.equal(mockController.hooks.shutdown.size, 0);
|
|
|
|
await mockController.hooks.save.invoke();
|
|
await mockController.hooks.instanceStatusChanged.invoke("instance", "running");
|
|
await mockController.hooks.hostConnectionEvent.invoke("connection", "connect");
|
|
assert.deepEqual(calls, [
|
|
["save", plugin],
|
|
["status", "instance", "running"],
|
|
["host", "connection", "connect"],
|
|
]);
|
|
});
|
|
it("should detach hooks", async function() {
|
|
class ControllerPlugin extends controller.BaseControllerPlugin {
|
|
async onSaveData() { }
|
|
async onShutdown() { }
|
|
}
|
|
const plugin = new ControllerPlugin(info, mockController, {}, new mock.MockLogger());
|
|
assert.equal(mockController.hooks.size, 1);
|
|
plugin.detachHooks();
|
|
assert.equal(mockController.hooks.size, 0);
|
|
});
|
|
});
|
|
});
|