Compare commits

...

9 Commits

Author SHA1 Message Date
d0b19cf116 feat: make notifyBotToken/adminUserId optional
The client never sends pairing notifications (the server does); these
Discord fields were required but unused. Make them optional + drop from
the config schema's required list. Back-compat: still accepted if set.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-19 15:59:08 +01:00
root
c3c11c1b27 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-client 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>
2026-05-08 08:08:52 +00:00
6b51bc6475 Merge pull request 'dev/2026-04-08' (#1) from dev/2026-04-08 into main
Reviewed-on: #1
2026-04-13 09:34:01 +00:00
8b26919790 fix: globalThis 2026-04-10 21:58:59 +01:00
4adb187331 fix: migrate startup guard and shared state to globalThis
Module-level _clientStarted / ruleRegistry / onAuthenticatedCallbacks
reset on hot-reload (new VM context), causing a second runtime to start
and the exposed __yonexusClient API to point at orphaned objects.

- Replace let _clientStarted with _G["_yonexusClientStarted"]
- Store ruleRegistry and onAuthenticatedCallbacks under globalThis keys,
  initialising only when absent (survives hot-reload)
- Store runtime under _G["_yonexusClientRuntime"]; sendRule / submitPairingCode
  closures read it from globalThis instead of capturing a module-local ref
- Re-write __yonexusClient every register() call so closures stay current,
  but skip runtime.start() when the globalThis flag is already set

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-10 20:41:27 +01:00
8824e768fb feat: wire rule registry and authenticated callback into client runtime
- Add ruleRegistry and onAuthenticated options to YonexusClientRuntime
- Dispatch non-builtin messages to rule registry
- Fire onAuthenticated callback on auth_success
- Reload persisted state on reconnect so externally-written secrets are picked up
- Re-send hello on auth_failed("not_paired") when client has a valid secret
- Always enter waiting_pair_confirm after pair_request regardless of notification status
- Expose __yonexusClient on globalThis for cross-plugin communication
- Wire onStateChange in transport creation (previously missing, prevented connection)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-10 20:14:57 +01:00
nav
57b53fc122 Fix strict TypeScript checks for client 2026-04-09 04:38:03 +00:00
nav
7cdda2e335 test(client): cover pairing restart resume flow 2026-04-09 04:06:06 +00:00
nav
b10ebc541e test: cover client reconnect failures 2026-04-09 03:33:09 +00:00
13 changed files with 477 additions and 47 deletions

8
package-lock.json generated
View File

@@ -12,10 +12,14 @@
}, },
"devDependencies": { "devDependencies": {
"@types/node": "^25.5.2", "@types/node": "^25.5.2",
"openclaw": "file:/usr/lib/node_modules/openclaw",
"typescript": "^5.6.3", "typescript": "^5.6.3",
"vitest": "^4.1.3" "vitest": "^4.1.3"
} }
}, },
"../../../../../usr/lib/node_modules/openclaw": {
"dev": true
},
"node_modules/@emnapi/core": { "node_modules/@emnapi/core": {
"version": "1.9.1", "version": "1.9.1",
"resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.9.1.tgz", "resolved": "https://registry.npmjs.org/@emnapi/core/-/core-1.9.1.tgz",
@@ -914,6 +918,10 @@
], ],
"license": "MIT" "license": "MIT"
}, },
"node_modules/openclaw": {
"resolved": "../../../../../usr/lib/node_modules/openclaw",
"link": true
},
"node_modules/pathe": { "node_modules/pathe": {
"version": "2.0.3", "version": "2.0.3",
"resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz",

View File

@@ -5,6 +5,9 @@
"description": "Yonexus.Client OpenClaw plugin scaffold", "description": "Yonexus.Client OpenClaw plugin scaffold",
"type": "module", "type": "module",
"main": "dist/plugin/index.js", "main": "dist/plugin/index.js",
"openclaw": {
"extensions": ["./dist/Yonexus.Client/plugin/index.js"]
},
"files": [ "files": [
"dist", "dist",
"plugin", "plugin",
@@ -29,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"
} }
} }

View File

@@ -1,8 +1,12 @@
export interface YonexusClientConfig { export interface YonexusClientConfig {
mainHost: string; mainHost: string;
identifier: string; identifier: string;
notifyBotToken: string; /**
adminUserId: string; * Optional. The client never sends pairing notifications (the server
* does); accepted for back-compat but no longer required.
*/
notifyBotToken?: string;
adminUserId?: string;
} }
export class YonexusClientConfigError extends Error { export class YonexusClientConfigError extends Error {
@@ -32,36 +36,37 @@ export function validateYonexusClientConfig(raw: unknown): YonexusClientConfig {
const source = (raw && typeof raw === "object" ? raw : {}) as Record<string, unknown>; const source = (raw && typeof raw === "object" ? raw : {}) as Record<string, unknown>;
const issues: string[] = []; const issues: string[] = [];
const mainHost = source.mainHost; const rawMainHost = source.mainHost;
if (!isNonEmptyString(mainHost)) { if (!isNonEmptyString(rawMainHost)) {
issues.push("mainHost is required"); issues.push("mainHost is required");
} else if (!isValidWsUrl(mainHost.trim())) { } else if (!isValidWsUrl(rawMainHost.trim())) {
issues.push("mainHost must be a valid ws:// or wss:// URL"); issues.push("mainHost must be a valid ws:// or wss:// URL");
} }
const identifier = source.identifier; const rawIdentifier = source.identifier;
if (!isNonEmptyString(identifier)) { if (!isNonEmptyString(rawIdentifier)) {
issues.push("identifier is required"); issues.push("identifier is required");
} }
const notifyBotToken = source.notifyBotToken; // Optional (back-compat): the client does not send notifications.
if (!isNonEmptyString(notifyBotToken)) { const rawNotifyBotToken = source.notifyBotToken;
issues.push("notifyBotToken is required"); const rawAdminUserId = source.adminUserId;
}
const adminUserId = source.adminUserId;
if (!isNonEmptyString(adminUserId)) {
issues.push("adminUserId is required");
}
if (issues.length > 0) { if (issues.length > 0) {
throw new YonexusClientConfigError(issues); throw new YonexusClientConfigError(issues);
} }
const mainHost = (rawMainHost as string).trim();
const identifier = (rawIdentifier as string).trim();
return { return {
mainHost: mainHost.trim(), mainHost,
identifier: identifier.trim(), identifier,
notifyBotToken: notifyBotToken.trim(), notifyBotToken: isNonEmptyString(rawNotifyBotToken)
adminUserId: adminUserId.trim() ? rawNotifyBotToken.trim()
: undefined,
adminUserId: isNonEmptyString(rawAdminUserId)
? rawAdminUserId.trim()
: undefined
}; };
} }

View File

@@ -29,6 +29,7 @@ import {
} from "./state.js"; } from "./state.js";
import { generateNonce, signMessage } from "../crypto/keypair.js"; import { generateNonce, signMessage } from "../crypto/keypair.js";
import type { ClientConnectionState, ClientTransport } from "./transport.js"; import type { ClientConnectionState, ClientTransport } from "./transport.js";
import type { ClientRuleRegistry } from "./rules.js";
export type YonexusClientPhase = export type YonexusClientPhase =
| "idle" | "idle"
@@ -44,6 +45,8 @@ export interface YonexusClientRuntimeOptions {
config: YonexusClientConfig; config: YonexusClientConfig;
transport: ClientTransport; transport: ClientTransport;
stateStore: YonexusClientStateStore; stateStore: YonexusClientStateStore;
ruleRegistry?: ClientRuleRegistry;
onAuthenticated?: () => void;
now?: () => number; now?: () => number;
} }
@@ -118,6 +121,7 @@ export class YonexusClientRuntime {
} }
if (!isBuiltinMessage(raw)) { if (!isBuiltinMessage(raw)) {
this.options.ruleRegistry?.dispatch(raw);
return; return;
} }
@@ -159,6 +163,7 @@ export class YonexusClientRuntime {
}; };
await this.options.stateStore.save(this.clientState); await this.options.stateStore.save(this.clientState);
this.phase = "authenticated"; this.phase = "authenticated";
this.options.onAuthenticated?.();
return; return;
} }
@@ -177,7 +182,17 @@ export class YonexusClientRuntime {
handleTransportStateChange(state: ClientConnectionState): void { handleTransportStateChange(state: ClientConnectionState): void {
if (state === "connected") { if (state === "connected") {
this.sendHello(); // Reload state from disk before hello so that any secret written by an
// external process (e.g. a pairing script) is picked up on reconnect.
this.options.stateStore.load(this.options.config.identifier).then((fresh) => {
if (fresh) {
this.clientState = { ...this.clientState, ...fresh };
}
this.sendHello();
}).catch(() => {
// If reload fails, proceed with in-memory state
this.sendHello();
});
} }
if (state === "disconnected") { if (state === "disconnected") {
@@ -259,7 +274,10 @@ export class YonexusClientRuntime {
adminNotification: payload.adminNotification adminNotification: payload.adminNotification
}; };
this.lastPairingFailure = undefined; this.lastPairingFailure = undefined;
this.phase = payload.adminNotification === "sent" ? "waiting_pair_confirm" : "pair_required"; // Always wait for the pairing code regardless of notification status.
// When adminNotification is "failed", the admin can retrieve the code
// via the server CLI command and deliver it through an alternate channel.
this.phase = "waiting_pair_confirm";
} }
private async handlePairSuccess(envelope: TypedBuiltinEnvelope<"pair_success">): Promise<void> { private async handlePairSuccess(envelope: TypedBuiltinEnvelope<"pair_success">): Promise<void> {
@@ -316,6 +334,12 @@ export class YonexusClientRuntime {
} }
this.lastPairingFailure = payload.reason; this.lastPairingFailure = payload.reason;
// If the server lost our session (race condition), re-announce via hello
// so the server creates a new session and we can retry auth.
if (payload.reason === "not_paired" && hasClientSecret(this.clientState)) {
this.sendHello();
return;
}
this.phase = "auth_required"; this.phase = "auth_required";
} }

View File

@@ -181,7 +181,8 @@ function assertClientStateShape(
); );
} }
if (!Number.isInteger(candidate.updatedAt) || candidate.updatedAt < 0) { const updatedAt = candidate.updatedAt;
if (typeof updatedAt !== "number" || !Number.isInteger(updatedAt) || updatedAt < 0) {
throw new YonexusClientStateCorruptionError( throw new YonexusClientStateCorruptionError(
`Client state file has invalid updatedAt value: ${filePath}` `Client state file has invalid updatedAt value: ${filePath}`
); );

View File

@@ -39,31 +39,113 @@ export {
type ClientRuleProcessor type ClientRuleProcessor
} from "./core/rules.js"; } from "./core/rules.js";
import os from "node:os";
import path from "node:path";
import fs from "node:fs";
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core";
import { validateYonexusClientConfig } from "./core/config.js";
import { createYonexusClientStateStore } from "./core/state.js";
import { createClientTransport } from "./core/transport.js";
import { createYonexusClientRuntime, type YonexusClientRuntime } from "./core/runtime.js";
import { createClientRuleRegistry, YonexusClientRuleRegistry } from "./core/rules.js";
const _G = globalThis as Record<string, unknown>;
const _STARTED_KEY = "_yonexusClientStarted";
const _RUNTIME_KEY = "_yonexusClientRuntime";
const _REGISTRY_KEY = "_yonexusClientRegistry";
const _CALLBACKS_KEY = "_yonexusClientOnAuthCallbacks";
const PLUGIN_DATA_DIR = path.join(os.homedir(), ".openclaw", "yonexus-client");
export interface YonexusClientPluginManifest { export interface YonexusClientPluginManifest {
readonly name: "Yonexus.Client"; readonly name: "Yonexus.Client";
readonly version: string; readonly version: string;
readonly description: string; readonly description: string;
} }
export interface YonexusClientPluginRuntime {
readonly hooks: readonly [];
readonly commands: readonly [];
readonly tools: readonly [];
}
const manifest: YonexusClientPluginManifest = { const manifest: YonexusClientPluginManifest = {
name: "Yonexus.Client", name: "Yonexus.Client",
version: "0.1.0", version: "0.1.0",
description: "Yonexus client plugin for cross-instance OpenClaw communication" description: "Yonexus client plugin for cross-instance OpenClaw communication"
}; };
export function createYonexusClientPlugin(): YonexusClientPluginRuntime { export function createYonexusClientPlugin(api: OpenClawPluginApi): void {
return { // 1. Ensure shared state survives hot-reload — only initialise when absent
hooks: [], if (!(_G[_REGISTRY_KEY] instanceof YonexusClientRuleRegistry)) {
commands: [], _G[_REGISTRY_KEY] = createClientRuleRegistry();
tools: [] }
if (!Array.isArray(_G[_CALLBACKS_KEY])) {
_G[_CALLBACKS_KEY] = [];
}
const ruleRegistry = _G[_REGISTRY_KEY] as YonexusClientRuleRegistry;
const onAuthenticatedCallbacks = _G[_CALLBACKS_KEY] as Array<() => void>;
// 2. Refresh the cross-plugin API object every call so that sendRule / submitPairingCode
// closures always read the live runtime from globalThis.
_G["__yonexusClient"] = {
ruleRegistry,
sendRule: (ruleId: string, content: string): boolean =>
(_G[_RUNTIME_KEY] as YonexusClientRuntime | undefined)?.sendRuleMessage(ruleId, content) ?? false,
submitPairingCode: (code: string): boolean =>
(_G[_RUNTIME_KEY] as YonexusClientRuntime | undefined)?.submitPairingCode(code) ?? false,
onAuthenticated: onAuthenticatedCallbacks
}; };
// 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 open
// a WebSocket to the Yonexus server.
api.on("gateway_start", () => {
if (_G[_STARTED_KEY]) return;
_G[_STARTED_KEY] = true;
fs.mkdirSync(PLUGIN_DATA_DIR, { recursive: true });
const config = validateYonexusClientConfig(api.pluginConfig);
const stateStore = createYonexusClientStateStore(path.join(PLUGIN_DATA_DIR, "state.json"));
const transport = createClientTransport({
config,
onMessage: (msg) => {
(_G[_RUNTIME_KEY] as YonexusClientRuntime | undefined)?.handleMessage(msg).catch((err: unknown) => {
console.error("[yonexus-client] message handler error:", err);
});
},
onStateChange: (state) => {
(_G[_RUNTIME_KEY] as YonexusClientRuntime | undefined)?.handleTransportStateChange(state);
}
});
const runtime = createYonexusClientRuntime({
config,
transport,
stateStore,
ruleRegistry,
onAuthenticated: () => {
for (const cb of onAuthenticatedCallbacks) cb();
}
});
_G[_RUNTIME_KEY] = runtime;
runtime.start().catch((err: unknown) => {
console.error("[yonexus-client] failed to start:", err);
});
});
api.on("gateway_stop", () => {
const runtime = _G[_RUNTIME_KEY] as YonexusClientRuntime | undefined;
runtime?.stop().catch((err: unknown) => {
console.error("[yonexus-client] shutdown error:", err);
});
});
} }
export default createYonexusClientPlugin; export default definePluginEntry({
id: "yonexus-client",
name: "Yonexus.Client",
description: "Yonexus client plugin for cross-instance OpenClaw communication",
register: createYonexusClientPlugin,
});
export { manifest }; export { manifest };

View File

@@ -1,13 +1,19 @@
{ {
"id": "yonexus-client",
"name": "Yonexus.Client", "name": "Yonexus.Client",
"version": "0.1.0",
"description": "Yonexus client plugin for cross-instance OpenClaw communication", "description": "Yonexus client plugin for cross-instance OpenClaw communication",
"entry": "dist/plugin/index.js", "activation": {
"permissions": [], "onStartup": true
"config": { },
"mainHost": "", "configSchema": {
"identifier": "", "type": "object",
"notifyBotToken": "", "additionalProperties": false,
"adminUserId": "" "properties": {
"mainHost": { "type": "string" },
"identifier": { "type": "string" },
"notifyBotToken": { "type": "string" },
"adminUserId": { "type": "string" }
},
"required": ["mainHost", "identifier"]
} }
} }

24
plugin/types/ws.d.ts vendored Normal file
View File

@@ -0,0 +1,24 @@
declare module "ws" {
export type RawData = Buffer | ArrayBuffer | Buffer[] | string;
export class WebSocket {
static readonly OPEN: number;
constructor(url: string);
readonly readyState: number;
send(data: string): void;
close(code?: number, reason?: string): void;
terminate(): void;
on(event: "open", listener: () => void): this;
on(event: "message", listener: (data: RawData) => void): this;
on(event: "close", listener: (code: number, reason: Buffer) => void): this;
on(event: "error", listener: (error: Error) => void): this;
once(event: "open", listener: () => void): this;
once(event: "error", listener: (error: Error) => void): this;
off(event: "error", listener: (error: Error) => void): this;
removeAllListeners?(event?: string): this;
}
export class WebSocketServer {
constructor(options: { host?: string; port: number });
}
}

View File

@@ -29,6 +29,7 @@ if (mode === "install") {
fs.rmSync(targetDir, { recursive: true, force: true }); fs.rmSync(targetDir, { recursive: true, force: true });
fs.cpSync(sourceDist, path.join(targetDir, "dist"), { recursive: true }); fs.cpSync(sourceDist, path.join(targetDir, "dist"), { recursive: true });
fs.copyFileSync(path.join(repoRoot, "plugin", "openclaw.plugin.json"), path.join(targetDir, "openclaw.plugin.json")); fs.copyFileSync(path.join(repoRoot, "plugin", "openclaw.plugin.json"), path.join(targetDir, "openclaw.plugin.json"));
fs.copyFileSync(path.join(repoRoot, "package.json"), path.join(targetDir, "package.json"));
console.log(`Installed ${pluginName} to ${targetDir}`); console.log(`Installed ${pluginName} to ${targetDir}`);
process.exit(0); process.exit(0);
} }

View File

@@ -479,4 +479,114 @@ describe("Yonexus.Client runtime flow", () => {
expect(runtime.state.pendingPairing).toBeDefined(); expect(runtime.state.pendingPairing).toBeDefined();
expect(runtime.state.lastPairingFailure).toBe("invalid_code"); expect(runtime.state.lastPairingFailure).toBe("invalid_code");
}); });
it("PF-10: restart during pending pairing resumes waiting for out-of-band code", async () => {
const now = 1_710_000_000;
const storeState = createMockStateStore({
identifier: "client-a",
updatedAt: now
});
const firstTransportState = createMockTransport();
const firstRuntime = createYonexusClientRuntime({
config: {
mainHost: "ws://localhost:8787",
identifier: "client-a",
notifyBotToken: "stub-token",
adminUserId: "admin-user"
},
transport: firstTransportState.transport,
stateStore: storeState.store,
now: () => now
});
await firstRuntime.start();
firstRuntime.handleTransportStateChange("connected");
await firstRuntime.handleMessage(
encodeBuiltin(
buildPairRequest(
{
identifier: "client-a",
expiresAt: now + 300,
ttlSeconds: 300,
adminNotification: "sent",
codeDelivery: "out_of_band"
},
{ requestId: "req-pair", timestamp: now }
)
)
);
expect(firstRuntime.state.phase).toBe("waiting_pair_confirm");
expect(firstRuntime.state.pendingPairing).toMatchObject({
expiresAt: now + 300,
ttlSeconds: 300,
adminNotification: "sent"
});
await firstRuntime.stop();
const secondTransportState = createMockTransport();
const secondRuntime = createYonexusClientRuntime({
config: {
mainHost: "ws://localhost:8787",
identifier: "client-a",
notifyBotToken: "stub-token",
adminUserId: "admin-user"
},
transport: secondTransportState.transport,
stateStore: storeState.store,
now: () => now + 5
});
await secondRuntime.start();
secondRuntime.handleTransportStateChange("connected");
const hello = decodeBuiltin(secondTransportState.sent[0]);
expect(hello.type).toBe("hello");
expect(hello.payload).toMatchObject({
identifier: "client-a",
hasSecret: false,
hasKeyPair: true
});
await secondRuntime.handleMessage(
encodeBuiltin(
buildHelloAck(
{
identifier: "client-a",
nextAction: "waiting_pair_confirm"
},
{ requestId: "req-hello-resume", timestamp: now + 5 }
)
)
);
await secondRuntime.handleMessage(
encodeBuiltin(
buildPairRequest(
{
identifier: "client-a",
expiresAt: now + 300,
ttlSeconds: 295,
adminNotification: "sent",
codeDelivery: "out_of_band"
},
{ requestId: "req-pair-resume", timestamp: now + 5 }
)
)
);
expect(secondRuntime.state.phase).toBe("waiting_pair_confirm");
expect(secondRuntime.state.pendingPairing).toMatchObject({
expiresAt: now + 300,
ttlSeconds: 295,
adminNotification: "sent"
});
expect(secondRuntime.submitPairingCode("PAIR-CODE-123", "req-pair-resume")).toBe(true);
const pairConfirm = decodeBuiltin(secondTransportState.sent.at(-1)!);
expect(pairConfirm.type).toBe("pair_confirm");
expect((pairConfirm.payload as PairConfirmPayload).pairingCode).toBe("PAIR-CODE-123");
});
}); });

View File

@@ -0,0 +1,163 @@
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
type EventName = "open" | "close" | "error" | "message";
type EventHandler = (...args: any[]) => void;
const socketInstances: MockWebSocket[] = [];
const pendingBehaviors: Array<"open" | "error"> = [];
class MockWebSocket {
static readonly OPEN = 1;
static readonly CLOSED = 3;
readyState = 0;
sent: string[] = [];
private readonly handlers = new Map<EventName, EventHandler[]>();
constructor(public readonly url: string) {
socketInstances.push(this);
const behavior = pendingBehaviors.shift() ?? "open";
queueMicrotask(() => {
if (behavior === "open") {
this.readyState = MockWebSocket.OPEN;
this.emit("open");
return;
}
const error = new Error(`mock connect failure for ${url}`);
this.emit("error", error);
this.emit("close", 1006, Buffer.from("connect failed"));
this.readyState = MockWebSocket.CLOSED;
});
}
once(event: EventName, handler: EventHandler): this {
const onceHandler: EventHandler = (...args: any[]) => {
this.off(event, onceHandler);
handler(...args);
};
return this.on(event, onceHandler);
}
on(event: EventName, handler: EventHandler): this {
const existing = this.handlers.get(event) ?? [];
existing.push(handler);
this.handlers.set(event, existing);
return this;
}
off(event: EventName, handler: EventHandler): this {
const existing = this.handlers.get(event) ?? [];
this.handlers.set(
event,
existing.filter((candidate) => candidate !== handler)
);
return this;
}
send(message: string): void {
this.sent.push(message);
}
close(code = 1000, reason = ""):
void {
this.readyState = MockWebSocket.CLOSED;
this.emit("close", code, Buffer.from(reason));
}
emit(event: EventName, ...args: any[]): void {
for (const handler of [...(this.handlers.get(event) ?? [])]) {
handler(...args);
}
}
}
vi.mock("ws", () => ({
WebSocket: MockWebSocket
}));
describe("Yonexus.Client transport reconnect behavior", () => {
beforeEach(() => {
vi.useFakeTimers();
socketInstances.length = 0;
pendingBehaviors.length = 0;
});
afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});
it("CF-02: retries initial connect with exponential backoff when server is unreachable", async () => {
const { createClientTransport } = await import("../plugin/core/transport.js");
const onStateChange = vi.fn();
const onError = vi.fn();
pendingBehaviors.push("error", "error", "open");
const transport = createClientTransport({
config: {
mainHost: "ws://localhost:8787",
identifier: "client-a",
notifyBotToken: "stub-token",
adminUserId: "admin-user"
},
onMessage: vi.fn(),
onStateChange,
onError
});
await expect(transport.connect()).rejects.toThrow("mock connect failure");
expect(socketInstances).toHaveLength(1);
expect(transport.state).toBe("disconnected");
await vi.advanceTimersByTimeAsync(999);
expect(socketInstances).toHaveLength(1);
await vi.advanceTimersByTimeAsync(1);
expect(socketInstances).toHaveLength(2);
await vi.advanceTimersByTimeAsync(1_999);
expect(socketInstances).toHaveLength(2);
await vi.advanceTimersByTimeAsync(1);
expect(socketInstances).toHaveLength(3);
expect(transport.state).toBe("connected");
expect(onError.mock.calls.length).toBeGreaterThanOrEqual(2);
expect(onStateChange).toHaveBeenCalledWith("connecting");
expect(onStateChange).toHaveBeenCalledWith("connected");
});
it("CF-01: reconnects with backoff after network partition closes an established connection", async () => {
const { createClientTransport } = await import("../plugin/core/transport.js");
pendingBehaviors.push("open", "open");
const transport = createClientTransport({
config: {
mainHost: "ws://localhost:8787",
identifier: "client-a",
notifyBotToken: "stub-token",
adminUserId: "admin-user"
},
onMessage: vi.fn(),
onStateChange: vi.fn(),
onError: vi.fn()
});
await transport.connect();
expect(socketInstances).toHaveLength(1);
expect(transport.state).toBe("connected");
socketInstances[0].emit("close", 1006, Buffer.from("network partition"));
expect(transport.state).toBe("disconnected");
await vi.advanceTimersByTimeAsync(999);
expect(socketInstances).toHaveLength(1);
await vi.advanceTimersByTimeAsync(1);
expect(socketInstances).toHaveLength(2);
expect(transport.state).toBe("connected");
});
});

View File

@@ -4,7 +4,7 @@
"module": "NodeNext", "module": "NodeNext",
"moduleResolution": "NodeNext", "moduleResolution": "NodeNext",
"outDir": "dist", "outDir": "dist",
"rootDir": ".", "rootDir": "..",
"strict": true, "strict": true,
"skipLibCheck": true, "skipLibCheck": true,
"esModuleInterop": true, "esModuleInterop": true,
@@ -15,7 +15,9 @@
}, },
"include": [ "include": [
"plugin/**/*.ts", "plugin/**/*.ts",
"servers/**/*.ts" "plugin/**/*.d.ts",
"servers/**/*.ts",
"../Yonexus.Protocol/src/**/*.ts"
], ],
"exclude": [ "exclude": [
"dist", "dist",