@workclaw/openclaw-workchat 1.0.0 → 1.0.4

package/src/monitor/monitor.ts

@@ -1,261 +1,261 @@
-import { Agent, WebSocket } from "undici";
-
-import type { ChannelAccountSnapshot } from "openclaw/plugin-sdk/channel-contract";
-import type { PluginRuntime } from "openclaw/plugin-sdk";
-
-import { openConnection, clearWorkChatTokenCache } from "../api/api.js";
-import type { WorkChatApiOptions } from "../api/api.js";
-import { normalizeBaseUrl } from "../api/api.js";
-import { buildPongFrame, parseWorkChatFrame } from "../messaging/inbound.js";
-import { processOneFrame } from "../messaging/process-message.js";
-import { logger } from "../util/logger.js";
-import type { Logger } from "../util/logger.js";
-
-const WS_CONNECT_TIMEOUT_MS = 30_000;
-const RECONNECT_BACKOFF_BASE_MS = 5_000;
-const RECONNECT_BACKOFF_MAX_MS = 5 * 60_000;
-const RATE_LIMIT_BACKOFF_MS = 1_000;
-
-export type MonitorWorkChatOpts = {
-  apiOpts: WorkChatApiOptions;
-  websocketUrl?: string;
-  localIp?: string;
-  accountId: string;
-  account: import("../auth/accounts.js").ResolvedWorkChatAccount;
-  config: import("openclaw/plugin-sdk").OpenClawConfig;
-  runtime?: { log?: (msg: string) => void; error?: (msg: string) => void };
-  /**
-   * Gateway-injected channel runtime surface (reply/routing/session/media/commands/...).
-   * Required for inbound message processing; provided by `ChannelGatewayContext.channelRuntime`.
-   */
-  channelRuntime: PluginRuntime["channel"];
-  abortSignal?: AbortSignal;
-  /** Gateway status callback — called on connect and inbound messages. */
-  setStatus?: (next: ChannelAccountSnapshot) => void;
-};
-
-function isAuthError(errorStr: string): boolean {
-  return (
-    errorStr.includes('"errCode":2001')
-    || errorStr.includes('"code":2001')
-    || errorStr.includes("鉴权失败")
-    || errorStr.includes("invalid credentials")
-    || errorStr.includes("unauthorized")
-    || errorStr.includes("missing appKey/appSecret")
-  );
-}
-
-function sleep(ms: number, abortSignal?: AbortSignal): Promise<void> {
-  return new Promise(resolve => {
-    const timer = setTimeout(() => {
-      abortSignal?.removeEventListener("abort", onAbort);
-      resolve();
-    }, ms);
-    function onAbort(): void {
-      clearTimeout(timer);
-      resolve();
-    }
-    if (abortSignal?.aborted) {
-      clearTimeout(timer);
-      resolve();
-      return;
-    }
-    abortSignal?.addEventListener("abort", onAbort, { once: true });
-  });
-}
-
-/**
- * WebSocket monitor loop: open connection → connect → dispatch frames.
- * Connection loss reconnects with exponential backoff; auth failures stop
- * the loop; rate limiting retries with minimal backoff.
- */
-export async function monitorWorkChatProvider(opts: MonitorWorkChatOpts): Promise<void> {
-  const { apiOpts, accountId, config, channelRuntime, abortSignal, setStatus } = opts;
-  const log = opts.runtime?.log ?? (() => {});
-  const errLog = opts.runtime?.error ?? ((m: string) => log(m));
-  const aLog: Logger = logger.withAccount(accountId);
-
-  if (!channelRuntime) {
-    const msg = "channelRuntime missing on monitor opts; gateway must inject ChannelGatewayContext.channelRuntime";
-    aLog.error(msg);
-    throw new Error(msg);
-  }
-
-  log(`workchat monitor started (${normalizeBaseUrl(apiOpts.baseUrl)}, account=${accountId})`);
-  aLog.info(`Monitor started: baseUrl=${normalizeBaseUrl(apiOpts.baseUrl)}`);
-
-  let backoffMs = RECONNECT_BACKOFF_BASE_MS;
-
-  while (!abortSignal?.aborted) {
-    let ws: WebSocket | null = null;
-    try {
-      const tokenCacheKey = apiOpts.appKey || accountId;
-      clearWorkChatTokenCache(tokenCacheKey);
-      const { endpoint, ticket } = await openConnection({
-        ...apiOpts,
-        websocketUrl: opts.websocketUrl,
-        localIp: opts.localIp,
-      });
-      const url = `${endpoint}?ticket=${encodeURIComponent(ticket)}`;
-
-      const dispatcher = apiOpts.allowInsecureTls
-        ? new Agent({ connect: { rejectUnauthorized: false } })
-        : undefined;
-      ws = new WebSocket(url, dispatcher ? { dispatcher } : undefined);
-
-      await new Promise<void>((resolve, reject) => {
-        const timer = setTimeout(
-          () => reject(new Error("workchat websocket connection timeout")),
-          WS_CONNECT_TIMEOUT_MS,
-        );
-        ws!.onopen = () => {
-          clearTimeout(timer);
-          resolve();
-        };
-        ws!.onerror = (event: unknown) => {
-          clearTimeout(timer);
-          reject(new Error(String((event as any)?.message ?? event)));
-        };
-        ws!.onclose = (event: unknown) => {
-          clearTimeout(timer);
-          reject(new Error(`workchat websocket closed before ready code=${String((event as any)?.code ?? "")}`));
-        };
-      });
-
-      aLog.info("WebSocket connected");
-      setStatus?.({
-        accountId,
-        running: true,
-        lastStartAt: Date.now(),
-        lastEventAt: Date.now(),
-      });
-      backoffMs = RECONNECT_BACKOFF_BASE_MS;
-
-      ws.onmessage = (event: unknown) => {
-        const data = typeof (event as any).data === "string"
-          ? (event as any).data
-          : String((event as any).data ?? "");
-        void handleFrame(data, ws);
-      };
-      let connectionClosed!: () => void;
-      const connectionClosedPromise = new Promise<void>(resolve => {
-        connectionClosed = resolve;
-      });
-      ws.onclose = (event: unknown) => {
-        aLog.warn(`WebSocket closed code=${String((event as any)?.code ?? "")} reason=${String((event as any)?.reason ?? "")}`);
-        scheduleReconnect();
-        connectionClosed();
-      };
-      ws.onerror = (event: unknown) => {
-        aLog.error(`WebSocket error: ${String((event as any)?.message ?? event)}`);
-      };
-
-      // Stay in this connection until it closes or the account is aborted;
-      // closing resolves the wait and lets the outer while-loop reconnect
-      // with backoff (the previous open-ended wait never resolved on close,
-      // so a mid-session 1005 close left the monitor stuck forever).
-      await new Promise<void>(resolve => {
-        const settle = (): void => {
-          abortSignal?.removeEventListener("abort", onAbort);
-          resolve();
-        };
-        const onAbort = (): void => {
-          settle();
-          try {
-            ws?.close();
-          } catch {
-            // ignore
-          }
-        };
-        if (abortSignal?.aborted) {
-          settle();
-          return;
-        }
-        abortSignal?.addEventListener("abort", onAbort, { once: true });
-        connectionClosedPromise.then(settle);
-      });
-      // Connection ended mid-session (not aborted): loop again to reconnect.
-      if (!abortSignal?.aborted) {
-        await sleep(backoffMs, abortSignal);
-        backoffMs = Math.min(backoffMs * 2, RECONNECT_BACKOFF_MAX_MS);
-        continue;
-      }
-      return;
-    } catch (err) {
-      const errorStr = String(err);
-      aLog.error(`connect failed: ${errorStr}`);
-      errLog(`workchat connect failed: ${errorStr}`);
-
-      if (isAuthError(errorStr)) {
-        aLog.error("authentication failed, not reconnecting");
-        setStatus?.({ accountId, running: false, lastError: errorStr });
-        throw err;
-      }
-
-      if (errorStr.includes("访问过于频繁")) {
-        backoffMs = RATE_LIMIT_BACKOFF_MS;
-      }
-
-      await sleep(backoffMs, abortSignal);
-      backoffMs = Math.min(backoffMs * 2, RECONNECT_BACKOFF_MAX_MS);
-    } finally {
-      try {
-        if (abortSignal?.aborted) ws?.close();
-      } catch {
-        // ignore
-      }
-    }
-  }
-
-  function scheduleReconnect(): void {
-    // The connection-wait resolves on close so the outer while-loop re-runs
-    // and reconnects with backoff; this hook only logs the transition.
-    aLog.info(`reconnect scheduled via monitor loop (backoff=${backoffMs}ms)`);
-  }
-
-  async function handleFrame(data: string, ws: WebSocket | null): Promise<void> {
-    aLog.debug(`frame received bytes=${data.length}`);
-    const result = parseWorkChatFrame(data);
-    if (!result) {
-      aLog.warn("failed to parse frame");
-      return;
-    }
-
-    if (result.type === "ping") {
-      try {
-        ws?.send(buildPongFrame(result.pongData));
-        aLog.debug("pong sent");
-        // Ping/pong proves the WS is bidirectionally alive — surface it so
-        // connectivity diagnostics can distinguish live from zombie sockets.
-        setStatus?.({ accountId, running: true, lastEventAt: Date.now() });
-      } catch (err) {
-        aLog.error(`failed to send pong: ${String(err)}`);
-      }
-      return;
-    }
-    if (result.type === "disconnect") {
-      aLog.info("disconnect command received, closing WebSocket");
-      try {
-        ws?.close();
-      } catch {
-        // ignore
-      }
-      return;
-    }
-
-    setStatus?.({ accountId, running: true, lastEventAt: Date.now() });
-    try {
-      await processOneFrame(result, data, {
-        accountId,
-        account: opts.account,
-        config,
-        channelRuntime,
-        apiOpts,
-        log,
-        errLog,
-      });
-    } catch (err) {
-      aLog.error(`processOneFrame failed: ${String(err)}`);
-    }
-  }
-}
+import { Agent, WebSocket } from "undici";
+
+import type { ChannelAccountSnapshot } from "openclaw/plugin-sdk/channel-contract";
+import type { PluginRuntime } from "openclaw/plugin-sdk";
+
+import { openConnection, clearWorkChatTokenCache } from "../api/api.js";
+import type { WorkChatApiOptions } from "../api/api.js";
+import { normalizeBaseUrl } from "../api/api.js";
+import { buildPongFrame, parseWorkChatFrame } from "../messaging/inbound.js";
+import { processOneFrame } from "../messaging/process-message.js";
+import { logger } from "../util/logger.js";
+import type { Logger } from "../util/logger.js";
+
+const WS_CONNECT_TIMEOUT_MS = 30_000;
+const RECONNECT_BACKOFF_BASE_MS = 5_000;
+const RECONNECT_BACKOFF_MAX_MS = 5 * 60_000;
+const RATE_LIMIT_BACKOFF_MS = 1_000;
+
+export type MonitorWorkChatOpts = {
+  apiOpts: WorkChatApiOptions;
+  websocketUrl?: string;
+  localIp?: string;
+  accountId: string;
+  account: import("../auth/accounts.js").ResolvedWorkChatAccount;
+  config: import("openclaw/plugin-sdk").OpenClawConfig;
+  runtime?: { log?: (msg: string) => void; error?: (msg: string) => void };
+  /**
+   * Gateway-injected channel runtime surface (reply/routing/session/media/commands/...).
+   * Required for inbound message processing; provided by `ChannelGatewayContext.channelRuntime`.
+   */
+  channelRuntime: PluginRuntime["channel"];
+  abortSignal?: AbortSignal;
+  /** Gateway status callback — called on connect and inbound messages. */
+  setStatus?: (next: ChannelAccountSnapshot) => void;
+};
+
+function isAuthError(errorStr: string): boolean {
+  return (
+    errorStr.includes('"errCode":2001')
+    || errorStr.includes('"code":2001')
+    || errorStr.includes("鉴权失败")
+    || errorStr.includes("invalid credentials")
+    || errorStr.includes("unauthorized")
+    || errorStr.includes("missing appKey/appSecret")
+  );
+}
+
+function sleep(ms: number, abortSignal?: AbortSignal): Promise<void> {
+  return new Promise(resolve => {
+    const timer = setTimeout(() => {
+      abortSignal?.removeEventListener("abort", onAbort);
+      resolve();
+    }, ms);
+    function onAbort(): void {
+      clearTimeout(timer);
+      resolve();
+    }
+    if (abortSignal?.aborted) {
+      clearTimeout(timer);
+      resolve();
+      return;
+    }
+    abortSignal?.addEventListener("abort", onAbort, { once: true });
+  });
+}
+
+/**
+ * WebSocket monitor loop: open connection → connect → dispatch frames.
+ * Connection loss reconnects with exponential backoff; auth failures stop
+ * the loop; rate limiting retries with minimal backoff.
+ */
+export async function monitorWorkChatProvider(opts: MonitorWorkChatOpts): Promise<void> {
+  const { apiOpts, accountId, config, channelRuntime, abortSignal, setStatus } = opts;
+  const log = opts.runtime?.log ?? (() => {});
+  const errLog = opts.runtime?.error ?? ((m: string) => log(m));
+  const aLog: Logger = logger.withAccount(accountId);
+
+  if (!channelRuntime) {
+    const msg = "channelRuntime missing on monitor opts; gateway must inject ChannelGatewayContext.channelRuntime";
+    aLog.error(msg);
+    throw new Error(msg);
+  }
+
+  log(`workchat monitor started (${normalizeBaseUrl(apiOpts.baseUrl)}, account=${accountId})`);
+  aLog.info(`Monitor started: baseUrl=${normalizeBaseUrl(apiOpts.baseUrl)}`);
+
+  let backoffMs = RECONNECT_BACKOFF_BASE_MS;
+
+  while (!abortSignal?.aborted) {
+    let ws: WebSocket | null = null;
+    try {
+      const tokenCacheKey = apiOpts.appKey || accountId;
+      clearWorkChatTokenCache(tokenCacheKey);
+      const { endpoint, ticket } = await openConnection({
+        ...apiOpts,
+        websocketUrl: opts.websocketUrl,
+        localIp: opts.localIp,
+      });
+      const url = `${endpoint}?ticket=${encodeURIComponent(ticket)}`;
+
+      const dispatcher = apiOpts.allowInsecureTls
+        ? new Agent({ connect: { rejectUnauthorized: false } })
+        : undefined;
+      ws = new WebSocket(url, dispatcher ? { dispatcher } : undefined);
+
+      await new Promise<void>((resolve, reject) => {
+        const timer = setTimeout(
+          () => reject(new Error("workchat websocket connection timeout")),
+          WS_CONNECT_TIMEOUT_MS,
+        );
+        ws!.onopen = () => {
+          clearTimeout(timer);
+          resolve();
+        };
+        ws!.onerror = (event: unknown) => {
+          clearTimeout(timer);
+          reject(new Error(String((event as any)?.message ?? event)));
+        };
+        ws!.onclose = (event: unknown) => {
+          clearTimeout(timer);
+          reject(new Error(`workchat websocket closed before ready code=${String((event as any)?.code ?? "")}`));
+        };
+      });
+
+      aLog.info("WebSocket connected");
+      setStatus?.({
+        accountId,
+        running: true,
+        lastStartAt: Date.now(),
+        lastEventAt: Date.now(),
+      });
+      backoffMs = RECONNECT_BACKOFF_BASE_MS;
+
+      ws.onmessage = (event: unknown) => {
+        const data = typeof (event as any).data === "string"
+          ? (event as any).data
+          : String((event as any).data ?? "");
+        void handleFrame(data, ws);
+      };
+      let connectionClosed!: () => void;
+      const connectionClosedPromise = new Promise<void>(resolve => {
+        connectionClosed = resolve;
+      });
+      ws.onclose = (event: unknown) => {
+        aLog.warn(`WebSocket closed code=${String((event as any)?.code ?? "")} reason=${String((event as any)?.reason ?? "")}`);
+        scheduleReconnect();
+        connectionClosed();
+      };
+      ws.onerror = (event: unknown) => {
+        aLog.error(`WebSocket error: ${String((event as any)?.message ?? event)}`);
+      };
+
+      // Stay in this connection until it closes or the account is aborted;
+      // closing resolves the wait and lets the outer while-loop reconnect
+      // with backoff (the previous open-ended wait never resolved on close,
+      // so a mid-session 1005 close left the monitor stuck forever).
+      await new Promise<void>(resolve => {
+        const settle = (): void => {
+          abortSignal?.removeEventListener("abort", onAbort);
+          resolve();
+        };
+        const onAbort = (): void => {
+          settle();
+          try {
+            ws?.close();
+          } catch {
+            // ignore
+          }
+        };
+        if (abortSignal?.aborted) {
+          settle();
+          return;
+        }
+        abortSignal?.addEventListener("abort", onAbort, { once: true });
+        connectionClosedPromise.then(settle);
+      });
+      // Connection ended mid-session (not aborted): loop again to reconnect.
+      if (!abortSignal?.aborted) {
+        await sleep(backoffMs, abortSignal);
+        backoffMs = Math.min(backoffMs * 2, RECONNECT_BACKOFF_MAX_MS);
+        continue;
+      }
+      return;
+    } catch (err) {
+      const errorStr = String(err);
+      aLog.error(`connect failed: ${errorStr}`);
+      errLog(`workchat connect failed: ${errorStr}`);
+
+      if (isAuthError(errorStr)) {
+        aLog.error("authentication failed, not reconnecting");
+        setStatus?.({ accountId, running: false, lastError: errorStr });
+        throw err;
+      }
+
+      if (errorStr.includes("访问过于频繁")) {
+        backoffMs = RATE_LIMIT_BACKOFF_MS;
+      }
+
+      await sleep(backoffMs, abortSignal);
+      backoffMs = Math.min(backoffMs * 2, RECONNECT_BACKOFF_MAX_MS);
+    } finally {
+      try {
+        if (abortSignal?.aborted) ws?.close();
+      } catch {
+        // ignore
+      }
+    }
+  }
+
+  function scheduleReconnect(): void {
+    // The connection-wait resolves on close so the outer while-loop re-runs
+    // and reconnects with backoff; this hook only logs the transition.
+    aLog.info(`reconnect scheduled via monitor loop (backoff=${backoffMs}ms)`);
+  }
+
+  async function handleFrame(data: string, ws: WebSocket | null): Promise<void> {
+    aLog.debug(`frame received bytes=${data.length}`);
+    const result = parseWorkChatFrame(data);
+    if (!result) {
+      aLog.warn("failed to parse frame");
+      return;
+    }
+
+    if (result.type === "ping") {
+      try {
+        ws?.send(buildPongFrame(result.pongData));
+        aLog.debug("pong sent");
+        // Ping/pong proves the WS is bidirectionally alive — surface it so
+        // connectivity diagnostics can distinguish live from zombie sockets.
+        setStatus?.({ accountId, running: true, lastEventAt: Date.now() });
+      } catch (err) {
+        aLog.error(`failed to send pong: ${String(err)}`);
+      }
+      return;
+    }
+    if (result.type === "disconnect") {
+      aLog.info("disconnect command received, closing WebSocket");
+      try {
+        ws?.close();
+      } catch {
+        // ignore
+      }
+      return;
+    }
+
+    setStatus?.({ accountId, running: true, lastEventAt: Date.now() });
+    try {
+      await processOneFrame(result, data, {
+        accountId,
+        account: opts.account,
+        config,
+        channelRuntime,
+        apiOpts,
+        log,
+        errLog,
+      });
+    } catch (err) {
+      aLog.error(`processOneFrame failed: ${String(err)}`);
+    }
+  }
+}

package/src/storage/state-dir.ts

@@ -1,11 +1,11 @@
-import os from "node:os";
-import path from "node:path";
-
-/** Resolve the OpenClaw state directory (mirrors core logic in src/infra). */
-export function resolveStateDir(): string {
-  return (
-    process.env.OPENCLAW_STATE_DIR?.trim() ||
-    process.env.CLAWDBOT_STATE_DIR?.trim() ||
-    path.join(os.homedir(), ".openclaw")
-  );
-}
+import os from "node:os";
+import path from "node:path";
+
+/** Resolve the OpenClaw state directory (mirrors core logic in src/infra). */
+export function resolveStateDir(): string {
+  return (
+    process.env.OPENCLAW_STATE_DIR?.trim() ||
+    process.env.CLAWDBOT_STATE_DIR?.trim() ||
+    path.join(os.homedir(), ".openclaw")
+  );
+}