mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-17 23:33:12 +09:00
Add typed hook system for plugins
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>
This commit is contained in:
1 parent
8c03ac15ab
commit
7122cbccf8
64 files changed
+1878
-1184
No files matched your search
+9
-2
@@ -3,7 +3,8 @@ import http from "node:http";
|
||||
import express from "express";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
import { User, UserManager, UserRecord, InstanceManager } from "@clusterio/controller";
|
||||
import { User, UserManager, UserRecord, InstanceManager, ControllerHooks } from "@clusterio/controller";
|
||||
import { HostHooks, InstanceHooks } from "@clusterio/host";
|
||||
|
||||
const addr = lib.Address.fromShorthand;
|
||||
|
||||
@@ -123,6 +124,8 @@ export class MockInstance extends lib.Link {
|
||||
this.name = "test";
|
||||
this.id = 7357;
|
||||
this.status = "running";
|
||||
this.hooks = new InstanceHooks(this.logger);
|
||||
this.loadedPlugins = new Set();
|
||||
this.mockConfigEntries = new Map([
|
||||
["instance.id", 7357],
|
||||
["factorio.enable_save_patching", true],
|
||||
@@ -146,6 +149,8 @@ export class MockInstance extends lib.Link {
|
||||
export class MockHost extends lib.Link {
|
||||
constructor() {
|
||||
super(new MockConnector(addr({ hostId: 1 }), addr("controller")));
|
||||
this.hooks = new HostHooks(new MockLogger());
|
||||
this.loadedPlugins = new Set();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -192,6 +197,8 @@ export class MockController {
|
||||
|
||||
this.hosts = new lib.KeyValueDatastore();
|
||||
this.handles = new Map();
|
||||
this.hooks = new ControllerHooks(new MockLogger());
|
||||
this.loadedPlugins = new Set();
|
||||
}
|
||||
|
||||
get authSecret() {
|
||||
@@ -235,7 +242,7 @@ export async function createControllerPlugin(ControllerPluginClass, info) {
|
||||
export async function createInstancePlugin(InstancePluginClass, info) {
|
||||
let instance = new MockInstance();
|
||||
let host = new MockHost();
|
||||
let plugin = new InstancePluginClass(info, instance, host);
|
||||
let plugin = new InstancePluginClass(info, instance, host, new MockLogger());
|
||||
await plugin.init();
|
||||
return plugin;
|
||||
}
|
||||
Reference in new issue
Block a user