fix: gate runtime startup behind gateway_start; migrate to current plugin SDK
Lifecycle:
- Move runtime.start() and shutdown handlers out of register() into
api.on("gateway_start", ...) and api.on("gateway_stop", ...). register()
runs in every CLI subprocess that loads plugins (e.g. `openclaw completion`,
`openclaw doctor`); without this gate the runtime would open a network
connection / bind a listener every time those one-shot commands ran.
- Drop process.once("SIGTERM"/"SIGINT") in favour of the gateway_stop hook,
which is the documented way for plugins to react to shutdown.
- Stop relying on the non-standard `api.rootDir` field (not present on the
current OpenClawPluginApi); compute the per-plugin data directory as
~/.openclaw/yonexus-server and ensure it exists before use.
Plugin SDK convention update:
- Wrap default export with definePluginEntry({ id, name, description, register })
per the current openclaw plugin authoring contract.
- Re-type the register function to accept OpenClawPluginApi instead of the
hand-crafted { rootDir, pluginConfig, ... } shape.
- Use focused subpath imports openclaw/plugin-sdk/plugin-entry and
openclaw/plugin-sdk/core.
- Add openclaw as a devDependency (file:/usr/lib/node_modules/openclaw) so
tsc resolves the SDK type subpaths at build time.
- Modernize openclaw.plugin.json: drop version/entry/permissions, add
activation.onStartup so gateway_start fires for this plugin at boot.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -32,6 +32,7 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^25.5.2",
|
"@types/node": "^25.5.2",
|
||||||
"typescript": "^5.6.3",
|
"typescript": "^5.6.3",
|
||||||
"vitest": "^4.1.3"
|
"vitest": "^4.1.3",
|
||||||
|
"openclaw": "file:/usr/lib/node_modules/openclaw"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -32,6 +32,9 @@ export {
|
|||||||
|
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import fs from "node:fs";
|
import fs from "node:fs";
|
||||||
|
import os from "node:os";
|
||||||
|
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
|
||||||
|
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core";
|
||||||
import { validateYonexusServerConfig } from "./core/config.js";
|
import { validateYonexusServerConfig } from "./core/config.js";
|
||||||
import { createYonexusServerStore } from "./core/store.js";
|
import { createYonexusServerStore } from "./core/store.js";
|
||||||
import { createServerTransport, type ServerTransport } from "./core/transport.js";
|
import { createServerTransport, type ServerTransport } from "./core/transport.js";
|
||||||
@@ -40,6 +43,8 @@ import { createServerRuleRegistry, YonexusServerRuleRegistry } from "./core/rule
|
|||||||
import { encodeRuleMessage } from "../../Yonexus.Protocol/src/index.js";
|
import { encodeRuleMessage } from "../../Yonexus.Protocol/src/index.js";
|
||||||
import type { ServerPersistenceData } from "./core/persistence.js";
|
import type { ServerPersistenceData } from "./core/persistence.js";
|
||||||
|
|
||||||
|
const PLUGIN_DATA_DIR = path.join(os.homedir(), ".openclaw", "yonexus-server");
|
||||||
|
|
||||||
const _G = globalThis as Record<string, unknown>;
|
const _G = globalThis as Record<string, unknown>;
|
||||||
const _STARTED_KEY = "_yonexusServerStarted";
|
const _STARTED_KEY = "_yonexusServerStarted";
|
||||||
const _TRANSPORT_KEY = "_yonexusServerTransport";
|
const _TRANSPORT_KEY = "_yonexusServerTransport";
|
||||||
@@ -58,14 +63,8 @@ const manifest: YonexusServerPluginManifest = {
|
|||||||
description: "Yonexus central hub plugin for cross-instance OpenClaw communication"
|
description: "Yonexus central hub plugin for cross-instance OpenClaw communication"
|
||||||
};
|
};
|
||||||
|
|
||||||
export function createYonexusServerPlugin(api: {
|
export function createYonexusServerPlugin(api: OpenClawPluginApi): void {
|
||||||
rootDir: string;
|
const stateFilePath = path.join(PLUGIN_DATA_DIR, "state.json");
|
||||||
pluginConfig: unknown;
|
|
||||||
registrationMode?: string; // "full" (gateway) | "cli-metadata" | "setup-only" | "setup-runtime"
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
||||||
registerCli?: (registrar: (ctx: { program: any }) => void, opts?: { commands?: string[] }) => void;
|
|
||||||
}): void {
|
|
||||||
const stateFilePath = path.join(api.rootDir, "state.json");
|
|
||||||
|
|
||||||
// Register CLI regardless of whether the gateway is already running.
|
// Register CLI regardless of whether the gateway is already running.
|
||||||
// The CLI process is a separate invocation that reads from the persisted state file.
|
// The CLI process is a separate invocation that reads from the persisted state file.
|
||||||
@@ -162,10 +161,18 @@ export function createYonexusServerPlugin(api: {
|
|||||||
onClientAuthenticated: onClientAuthenticatedCallbacks
|
onClientAuthenticated: onClientAuthenticatedCallbacks
|
||||||
};
|
};
|
||||||
|
|
||||||
// 3. Start the runtime only once — the globalThis flag survives hot-reload
|
// 3. Runtime startup — only fire when the gateway boots, not eagerly during
|
||||||
|
// register() inside one-shot CLI subprocesses (e.g. `openclaw completion`).
|
||||||
|
// Without this gate, every CLI invocation that loads plugins would try to
|
||||||
|
// bind the WebSocket listener; EADDRINUSE recovery handled the gateway-
|
||||||
|
// already-running case but a genuine first-bind in a subprocess would
|
||||||
|
// keep that process alive forever.
|
||||||
|
api.on("gateway_start", () => {
|
||||||
if (_G[_STARTED_KEY]) return;
|
if (_G[_STARTED_KEY]) return;
|
||||||
_G[_STARTED_KEY] = true;
|
_G[_STARTED_KEY] = true;
|
||||||
|
|
||||||
|
fs.mkdirSync(PLUGIN_DATA_DIR, { recursive: true });
|
||||||
|
|
||||||
const config = validateYonexusServerConfig(api.pluginConfig);
|
const config = validateYonexusServerConfig(api.pluginConfig);
|
||||||
const store = createYonexusServerStore(stateFilePath);
|
const store = createYonexusServerStore(stateFilePath);
|
||||||
|
|
||||||
@@ -196,26 +203,30 @@ export function createYonexusServerPlugin(api: {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
runtimeRef = runtime;
|
runtimeRef = runtime;
|
||||||
|
_G["_yonexusServerRuntime"] = runtime;
|
||||||
const shutdown = (): void => {
|
|
||||||
runtime.stop().catch((err: unknown) => {
|
|
||||||
console.error("[yonexus-server] shutdown error:", err);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
process.once("SIGTERM", shutdown);
|
|
||||||
process.once("SIGINT", shutdown);
|
|
||||||
|
|
||||||
runtime.start().catch((err: unknown) => {
|
runtime.start().catch((err: unknown) => {
|
||||||
// EADDRINUSE means the gateway is already running (e.g. this is a CLI invocation).
|
|
||||||
// Any other error is a real problem worth logging.
|
|
||||||
const code = (err as NodeJS.ErrnoException | undefined)?.code;
|
const code = (err as NodeJS.ErrnoException | undefined)?.code;
|
||||||
if (code !== "EADDRINUSE") {
|
if (code !== "EADDRINUSE") {
|
||||||
console.error("[yonexus-server] failed to start:", err);
|
console.error("[yonexus-server] failed to start:", err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
api.on("gateway_stop", () => {
|
||||||
|
const runtime = _G["_yonexusServerRuntime"] as ReturnType<typeof createYonexusServerRuntime> | undefined;
|
||||||
|
runtime?.stop().catch((err: unknown) => {
|
||||||
|
console.error("[yonexus-server] shutdown error:", err);
|
||||||
|
});
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
export default createYonexusServerPlugin;
|
export default definePluginEntry({
|
||||||
|
id: "yonexus-server",
|
||||||
|
name: "Yonexus.Server",
|
||||||
|
description: "Yonexus central hub plugin for cross-instance OpenClaw communication",
|
||||||
|
register: createYonexusServerPlugin,
|
||||||
|
});
|
||||||
export {
|
export {
|
||||||
createServerTransport,
|
createServerTransport,
|
||||||
YonexusServerTransport,
|
YonexusServerTransport,
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
{
|
{
|
||||||
"id": "yonexus-server",
|
"id": "yonexus-server",
|
||||||
"name": "Yonexus.Server",
|
"name": "Yonexus.Server",
|
||||||
"version": "0.1.0",
|
|
||||||
"description": "Yonexus central hub plugin for cross-instance OpenClaw communication",
|
"description": "Yonexus central hub plugin for cross-instance OpenClaw communication",
|
||||||
"entry": "./dist/Yonexus.Server/plugin/index.js",
|
"activation": {
|
||||||
"permissions": [],
|
"onStartup": true
|
||||||
|
},
|
||||||
|
"commandAliases": [
|
||||||
|
{ "name": "yonexus-server" }
|
||||||
|
],
|
||||||
"configSchema": {
|
"configSchema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
|
|||||||
Reference in New Issue
Block a user