@yanhaidao/wecom 2.4.120 → 2.5.110

package/src/transport/bot-ws/reply.ts

@@ -1,365 +0,0 @@
-import {
-  generateReqId,
-  type WsFrame,
-  type BaseMessage,
-  type EventMessage,
-  type WSClient,
-} from "@wecom/aibot-node-sdk";
-import { formatErrorMessage } from "openclaw/plugin-sdk/infra-runtime";
-import { resolveWecomMediaMaxBytes, resolveWecomMergedMediaLocalRoots } from "../../config/index.js";
-import { getWecomRuntime } from "../../runtime.js";
-import type { ReplyHandle, ReplyPayload } from "../../types/index.js";
-import { toWeComMarkdownV2 } from "../../wecom_msg_adapter/markdown_adapter.js";
-import { uploadAndSendBotWsMedia } from "./media.js";
-
-const PLACEHOLDER_KEEPALIVE_MS = 3000;
-const MAX_KEEPALIVE_MS = 120 * 1000; // Force stop keepalive after 120s if ignored
-
-function isInvalidReqIdError(error: unknown): boolean {
-  if (!error || typeof error !== "object") {
-    return false;
-  }
-  const errcode = "errcode" in error ? Number(error.errcode) : undefined;
-  const errmsg = "errmsg" in error ? String(error.errmsg ?? "") : "";
-  return errcode === 846605 || errmsg.includes("invalid req_id");
-}
-
-function isExpiredStreamUpdateError(error: unknown): boolean {
-  if (!error || typeof error !== "object") {
-    return false;
-  }
-  const errcode = "errcode" in error ? Number(error.errcode) : undefined;
-  const errmsg = "errmsg" in error ? String(error.errmsg ?? "").toLowerCase() : "";
-  return errcode === 846608 || errmsg.includes("stream message update expired");
-}
-
-/** SDK rejects with a plain Error whose message contains "ack timeout" when
- * the WeCom server does not acknowledge a reply within 5 s.  Once timed out
- * the reqId slot is released; further replies on the same reqId will fail. */
-function isAckTimeoutError(error: unknown): boolean {
-  return error instanceof Error && error.message.includes("ack timeout");
-}
-
-function isTerminalReplyError(error: unknown): boolean {
-  return (
-    isInvalidReqIdError(error) || isExpiredStreamUpdateError(error) || isAckTimeoutError(error)
-  );
-}
-
-function formatMediaFailure(mediaUrl: string, error?: string, rejectReason?: string): string {
-  const reason = rejectReason || error || "unknown";
-  return `媒体发送失败：${mediaUrl} (${reason})`;
-}
-
-// Global registry to track active keepalives by peerId
-interface ActiveKeepalive {
-  reqId: string;
-  stop: () => void;
-}
-const activeKeepalivesByPeer = new Map<string, Set<ActiveKeepalive>>();
-
-export function createBotWsReplyHandle(params: {
-  client: WSClient;
-  frame: WsFrame<BaseMessage | EventMessage>;
-  accountId: string;
-  inboundKind: string;
-  placeholderContent?: string;
-  autoSendPlaceholder?: boolean;
-  onDeliver?: () => void;
-  onFail?: (error: unknown) => void;
-}): ReplyHandle {
-  let streamId: string | undefined;
-  let accumulatedText = "";
-  let deferredMediaUrls: string[] = [];
-  const resolveStreamId = () => {
-    streamId ||= generateReqId("stream");
-    return streamId;
-  };
-
-  const placeholderText = params.placeholderContent?.trim() || "⏳ 正在思考中...\n\n";
-  let streamSettled = false;
-  let placeholderInFlight = false;
-  let placeholderKeepalive: ReturnType<typeof setInterval> | undefined;
-  let placeholderTimeout: ReturnType<typeof setTimeout> | undefined;
-
-  // Extract peerId for clustering handles
-  const body = params.frame.body as any;
-  const peerId = String(
-    (body?.chattype === "group" ? body?.chatid || body?.from?.userid : body?.from?.userid) ||
-      "unknown",
-  );
-  const reqId = params.frame.headers.req_id || "unknown";
-
-  const isEvent =
-    params.inboundKind === "welcome" ||
-    params.inboundKind === "event" ||
-    params.inboundKind === "template-card-event";
-
-  const stopPlaceholderKeepalive = () => {
-    if (placeholderKeepalive) {
-      clearInterval(placeholderKeepalive);
-      placeholderKeepalive = undefined;
-    }
-    if (placeholderTimeout) {
-      clearTimeout(placeholderTimeout);
-      placeholderTimeout = undefined;
-    }
-
-    // Remove from registry
-    const keepalives = activeKeepalivesByPeer.get(peerId);
-    if (keepalives) {
-      for (const ka of keepalives) {
-        if (ka.reqId === reqId) {
-          keepalives.delete(ka);
-        }
-      }
-      if (keepalives.size === 0) {
-        activeKeepalivesByPeer.delete(peerId);
-      }
-    }
-  };
-
-  const settleStream = () => {
-    if (streamSettled) return;
-    streamSettled = true;
-    stopPlaceholderKeepalive();
-  };
-
-  const sendPlaceholder = () => {
-    if (streamSettled || placeholderInFlight || isEvent) return;
-    placeholderInFlight = true;
-    params.client
-      .replyStream(params.frame, resolveStreamId(), placeholderText, false)
-      .catch((error) => {
-        if (!isTerminalReplyError(error)) {
-          return;
-        }
-        settleStream();
-        params.onFail?.(error);
-      })
-      .finally(() => {
-        placeholderInFlight = false;
-      });
-  };
-
-  const notifyPeerActive = () => {
-    // A genuine reply or reasoning is happening on THIS handle.
-    // It means the core SDK has chosen this handle to deliver the response.
-    // We can safely terminate all other orphaned keepalives for this peer to prevent infinite loops.
-    const keepalives = activeKeepalivesByPeer.get(peerId);
-    if (keepalives) {
-      for (const ka of keepalives) {
-        if (ka.reqId !== reqId) {
-          ka.stop();
-        }
-      }
-    }
-  };
-
-  const mergeDeferredMediaUrls = (urls: string[]): string[] => {
-    if (urls.length === 0) {
-      return deferredMediaUrls;
-    }
-    const merged = [...deferredMediaUrls];
-    for (const url of urls) {
-      if (!merged.includes(url)) {
-        merged.push(url);
-      }
-    }
-    deferredMediaUrls = merged;
-    return deferredMediaUrls;
-  };
-
-  if (params.autoSendPlaceholder !== false && !isEvent) {
-    sendPlaceholder();
-    placeholderKeepalive = setInterval(() => {
-      sendPlaceholder();
-    }, PLACEHOLDER_KEEPALIVE_MS);
-
-    // Safety net: force stop keepalive after MAX_KEEPALIVE_MS
-    // in case the message is completely ignored by the core and never triggers deliver/fail
-    placeholderTimeout = setTimeout(() => {
-      stopPlaceholderKeepalive();
-    }, MAX_KEEPALIVE_MS);
-
-    // Register keepalive
-    let keepalives = activeKeepalivesByPeer.get(peerId);
-    if (!keepalives) {
-      keepalives = new Set();
-      activeKeepalivesByPeer.set(peerId, keepalives);
-    }
-    keepalives.add({ reqId, stop: stopPlaceholderKeepalive });
-  }
-
-  return {
-    context: {
-      transport: "bot-ws",
-      accountId: params.accountId,
-      reqId: params.frame.headers.req_id,
-      raw: {
-        transport: "bot-ws",
-        command: params.frame.cmd,
-        headers: params.frame.headers,
-        body: params.frame.body,
-        envelopeType: "ws",
-      },
-    },
-    deliver: async (payload: ReplyPayload, info) => {
-      // Mark this chat as active on this handle
-      notifyPeerActive();
-
-      if (payload.isReasoning) {
-        // We reset the safety timeout if reasoning is actively streaming
-        if (placeholderTimeout && !isEvent) {
-          clearTimeout(placeholderTimeout);
-          placeholderTimeout = setTimeout(() => {
-            stopPlaceholderKeepalive();
-          }, MAX_KEEPALIVE_MS);
-        }
-        return;
-      }
-
-      const text = payload.text?.trim() || "";
-      const incomingMediaUrls = payload.mediaUrls || (payload.mediaUrl ? [payload.mediaUrl] : []);
-      const hasIncomingMedia = incomingMediaUrls.length > 0;
-      if (info.kind !== "final" && hasIncomingMedia) {
-        mergeDeferredMediaUrls(incomingMediaUrls);
-      }
-      const mediaUrls =
-        info.kind === "final" ? mergeDeferredMediaUrls(incomingMediaUrls) : incomingMediaUrls;
-      if (!text && mediaUrls.length === 0) {
-        return;
-      }
-
-      if (info.kind === "block") {
-        if (!text) {
-          return;
-        }
-        accumulatedText = accumulatedText ? `${accumulatedText}\n${text}` : text;
-      }
-
-      const outboundText =
-        info.kind === "final"
-          ? accumulatedText
-            ? text
-              ? `${accumulatedText}\n${text}`
-              : accumulatedText
-            : text
-          : accumulatedText || text;
-
-      let finalText = outboundText;
-      if (info.kind === "final" && mediaUrls.length > 0) {
-        const cfg = getWecomRuntime().config.loadConfig();
-        const mediaLocalRoots = resolveWecomMergedMediaLocalRoots({ cfg });
-        const mediaMaxBytes = resolveWecomMediaMaxBytes(cfg, params.accountId);
-        const mediaFailures: string[] = [];
-        const mediaNotes: string[] = [];
-        let mediaSent = 0;
-        for (const mediaUrl of mediaUrls) {
-          const result = await uploadAndSendBotWsMedia({
-            wsClient: params.client,
-            chatId: peerId,
-            mediaUrl,
-            mediaLocalRoots,
-            maxBytes: mediaMaxBytes,
-          });
-          if (result.ok) {
-            mediaSent += 1;
-            if (result.downgradeNote) {
-              mediaNotes.push(result.downgradeNote);
-            }
-            continue;
-          }
-          mediaFailures.push(formatMediaFailure(mediaUrl, result.error, result.rejectReason));
-        }
-
-        if (!finalText && mediaSent > 0) {
-          finalText = "文件已发送。";
-        }
-        if (mediaFailures.length > 0) {
-          finalText = finalText
-            ? `${finalText}\n\n${mediaFailures.join("\n")}`
-            : mediaFailures.join("\n");
-        }
-        if (mediaNotes.length > 0) {
-          finalText = finalText
-            ? `${finalText}\n\n${mediaNotes.join("\n")}`
-            : mediaNotes.join("\n");
-        }
-        deferredMediaUrls = [];
-      }
-      if (!finalText) {
-        return;
-      }
-
-      // Event frames do not support streaming chunks
-      if (isEvent && info.kind !== "final") {
-        return;
-      }
-
-      settleStream();
-      try {
-        if (params.inboundKind === "welcome") {
-          await params.client.replyWelcome(params.frame, {
-            msgtype: "text",
-            text: { content: finalText },
-          });
-        } else if (isEvent) {
-          // Send push message for other events
-          await params.client.sendMessage(peerId, {
-            msgtype: "markdown",
-            markdown: { content: toWeComMarkdownV2(finalText) },
-          });
-        } else {
-          await params.client.replyStream(
-            params.frame,
-            resolveStreamId(),
-            toWeComMarkdownV2(finalText),
-            info.kind === "final",
-          );
-        }
-      } catch (error) {
-        if (isTerminalReplyError(error)) {
-          params.onFail?.(error);
-          return;
-        }
-        throw error;
-      }
-      params.onDeliver?.();
-    },
-    fail: async (error: unknown) => {
-      notifyPeerActive();
-      settleStream();
-      if (isTerminalReplyError(error)) {
-        params.onFail?.(error);
-        return;
-      }
-      const message = formatErrorMessage(error);
-      const text = `WeCom WS reply failed: ${message}`;
-
-      try {
-        if (params.inboundKind === "welcome") {
-          await params.client.replyWelcome(params.frame, {
-            msgtype: "text",
-            text: { content: text },
-          });
-        } else if (isEvent) {
-          await params.client.sendMessage(peerId, {
-            msgtype: "markdown",
-            markdown: { content: text },
-          });
-        } else {
-          await params.client.replyStream(params.frame, resolveStreamId(), text, true);
-        }
-      } catch (sendError) {
-        params.onFail?.(sendError);
-        return;
-      }
-      params.onFail?.(error);
-    },
-    markExternalActivity: () => {
-      notifyPeerActive();
-      stopPlaceholderKeepalive();
-    },
-  };
-}

package/src/transport/bot-ws/sdk-adapter.test.ts

@@ -1,187 +0,0 @@
-import { afterEach, describe, expect, it, vi } from "vitest";
-
-const sdkMockState = vi.hoisted(() => {
-  class MockWSClient {
-    readonly handlers = new Map<string, Array<(payload: any) => void>>();
-    readonly isConnected = true;
-    readonly replyStream = vi.fn().mockResolvedValue(undefined);
-    readonly replyWelcome = vi.fn().mockResolvedValue(undefined);
-
-    constructor(_options: unknown) {
-      sdkMockState.client = this;
-    }
-
-    on(event: string, handler: (payload: any) => void): void {
-      const current = this.handlers.get(event) ?? [];
-      current.push(handler);
-      this.handlers.set(event, current);
-    }
-
-    emit(event: string, payload: any): void {
-      for (const handler of this.handlers.get(event) ?? []) {
-        handler(payload);
-      }
-    }
-
-    connect(): void {}
-
-    disconnect(): void {}
-  }
-
-  return {
-    client: null as InstanceType<typeof MockWSClient> | null,
-    MockWSClient,
-  };
-});
-
-vi.mock("@wecom/aibot-node-sdk", () => ({
-  default: {
-    WSClient: sdkMockState.MockWSClient,
-  },
-  WSClient: sdkMockState.MockWSClient,
-  generateReqId: (prefix: string) => `${prefix}-1`,
-}));
-
-import { BotWsSdkAdapter } from "./sdk-adapter.js";
-
-const waitForAsyncCallbacks = async () => {
-  await Promise.resolve();
-  await new Promise((resolve) => setTimeout(resolve, 0));
-};
-
-describe("BotWsSdkAdapter", () => {
-  const unhandledRejections: unknown[] = [];
-  const onUnhandledRejection = (reason: unknown) => {
-    unhandledRejections.push(reason);
-  };
-
-  afterEach(() => {
-    process.off("unhandledRejection", onUnhandledRejection);
-    unhandledRejections.length = 0;
-    sdkMockState.client = null;
-  });
-
-  it("contains frame handler rejections instead of leaking unhandled rejections", async () => {
-    process.on("unhandledRejection", onUnhandledRejection);
-
-    const runtime = {
-      account: {
-        accountId: "acc-1",
-        bot: {
-          wsConfigured: true,
-          ws: {
-            botId: "bot-1",
-            secret: "secret-1",
-          },
-          config: {},
-        },
-      },
-      handleEvent: vi.fn().mockRejectedValue(new Error("frame exploded")),
-      updateTransportSession: vi.fn(),
-      touchTransportSession: vi.fn(),
-      recordOperationalIssue: vi.fn(),
-    };
-    const log = {
-      info: vi.fn(),
-      warn: vi.fn(),
-      error: vi.fn(),
-    };
-
-    new BotWsSdkAdapter(runtime as any, log as any).start();
-
-    sdkMockState.client?.emit("message", {
-      cmd: "aibot_msg_callback",
-      headers: { req_id: "req-1" },
-      body: {
-        msgid: "msg-1",
-        msgtype: "text",
-        from: { userid: "user-1" },
-        text: { content: "hello" },
-      },
-    });
-
-    await waitForAsyncCallbacks();
-
-    expect(runtime.handleEvent).toHaveBeenCalledTimes(1);
-    expect(runtime.recordOperationalIssue).toHaveBeenCalledWith(
-      expect.objectContaining({
-        transport: "bot-ws",
-        category: "runtime-error",
-        messageId: "msg-1",
-        error: "frame exploded",
-      }),
-    );
-    expect(runtime.touchTransportSession).toHaveBeenCalledWith(
-      "bot-ws",
-      expect.objectContaining({
-        lastError: "frame exploded",
-      }),
-    );
-    expect(log.error).toHaveBeenCalledWith(
-      expect.stringContaining(
-        "frame handler failed account=acc-1 reqId=req-1 message=frame exploded",
-      ),
-    );
-    expect(unhandledRejections).toHaveLength(0);
-  });
-
-  it("short-circuits enter_chat welcome events to a static ws welcome reply", async () => {
-    process.on("unhandledRejection", onUnhandledRejection);
-
-    const runtime = {
-      account: {
-        accountId: "acc-1",
-        bot: {
-          wsConfigured: true,
-          ws: {
-            botId: "bot-1",
-            secret: "secret-1",
-          },
-          config: {
-            welcomeText: "欢迎来到 WeCom",
-          },
-        },
-      },
-      handleEvent: vi.fn().mockResolvedValue(undefined),
-      updateTransportSession: vi.fn(),
-      touchTransportSession: vi.fn(),
-      recordOperationalIssue: vi.fn(),
-    };
-    const log = {
-      info: vi.fn(),
-      warn: vi.fn(),
-      error: vi.fn(),
-    };
-
-    new BotWsSdkAdapter(runtime as any, log as any).start();
-
-    sdkMockState.client?.emit("event", {
-      cmd: "aibot_event_callback",
-      headers: { req_id: "req-welcome" },
-      body: {
-        msgid: "msg-welcome",
-        msgtype: "event",
-        chattype: "single",
-        from: { userid: "user-1" },
-        event: { eventtype: "enter_chat" },
-      },
-    });
-
-    await waitForAsyncCallbacks();
-
-    expect(runtime.handleEvent).not.toHaveBeenCalled();
-    expect(sdkMockState.client?.replyWelcome).toHaveBeenCalledWith(
-      expect.objectContaining({
-        headers: { req_id: "req-welcome" },
-      }),
-      {
-        msgtype: "text",
-        text: { content: "欢迎来到 WeCom" },
-      },
-    );
-    expect(log.info).toHaveBeenCalledWith(
-      expect.stringContaining("static welcome delivered account=acc-1 messageId=msg-welcome"),
-    );
-    expect(unhandledRejections).toHaveLength(0);
-  });
-});