@dcrays/dcgchat-test 0.6.8 → 0.6.12

package/src/transport.ts

@@ -0,0 +1,217 @@
+import { WebSocket } from 'ws'
+import { clearSentMediaKeys, getWsConnection, resolveOutboundMediaDedupeKey } from './utils/global.js'
+import { dcgLogger } from './utils/log.js'
+import type { IMsgParams } from './types.js'
+import { getEffectiveMsgParams, getParamsDefaults } from './utils/params.js'
+
+/** 用 sessionKey 从 map 取参，再合并 overrides（channel 出站、媒体等） */
+export function mergeSessionParams(sessionKey: string, overrides?: Partial<IMsgParams>): IMsgParams {
+  const base = getEffectiveMsgParams(sessionKey)
+  if (!overrides) return base
+  return { ...base, ...overrides }
+}
+export function mergeDefaultParams(overrides?: Partial<IMsgParams>): IMsgParams {
+  const base = getParamsDefaults()
+  if (!overrides) return base
+  return { ...base, ...overrides }
+}
+
+export type InboundMsgForContext = {
+  _userId: number | string
+  content: {
+    bot_token: string
+    domain_id?: string
+    app_id?: string
+    bot_id?: string
+    agent_id?: string
+    session_id: string
+    message_id: string
+  }
+}
+
+export type OpenclawBotChatEnvelope = {
+  messageType: 'openclaw_bot_chat'
+  _userId: number | undefined
+  source: 'client'
+  content: Record<string, unknown>
+}
+
+function formatWsEnvelopeForLog(envelope: OpenclawBotChatEnvelope): string {
+  const c = envelope.content
+  const sid = c.session_id
+  const mid = c.message_id
+  const state = c.state
+  const r = c.response
+  const files = c.files
+  const respLen = typeof r === 'string' ? r.length : 0
+  const fileHint = Array.isArray(files) ? ` files=${files.length}` : ''
+  return `[ws] ${envelope.messageType} session_id=${sid} message_id=${mid} state=${String(state)} responseLen=${respLen}${fileHint}`
+}
+
+function isInboundWire(arg: unknown): arg is InboundMsgForContext {
+  return Boolean(arg && typeof arg === 'object' && '_userId' in arg && 'content' in arg)
+}
+
+/** 下行 WebSocket 帧 → 内部上下文（字段缺省用 channel 配置补） */
+function inboundToCtx(msg: InboundMsgForContext, d: IMsgParams): IMsgParams {
+  const c = msg.content
+  return {
+    userId: Number(msg._userId ?? d.userId),
+    botToken: c.bot_token ?? d.botToken,
+    domainId: String(c.domain_id ?? d.domainId),
+    appId: String(c.app_id ?? d.appId),
+    botId: c.bot_id,
+    agentId: c.agent_id,
+    sessionId: c.session_id,
+    messageId: c.message_id
+  }
+}
+
+/** 上行：与配置合并缺省后再 `...ctx` 覆盖（原 wsSendRaw） */
+function mergeOutboundWithDefaults(ctx: IMsgParams, d: IMsgParams): IMsgParams {
+  return {
+    userId: Number(ctx.userId ?? d.userId),
+    botToken: ctx.botToken ?? d.botToken,
+    domainId: String(ctx.domainId ?? d.domainId),
+    appId: String(ctx.appId ?? d.appId),
+    ...ctx
+  }
+}
+
+/**
+ * 组装完整 wire `content` 对象：先写会话/机器人基础字段（回落到 d），再合并调用方传入的 payload。
+ * `content` 在使用处构造（如 response、state、files），同名键可覆盖基础字段。
+ */
+export function buildWireContent(base: IMsgParams, d: IMsgParams, content: Record<string, unknown>): Record<string, unknown> {
+  return {
+    bot_token: base.botToken ?? d.botToken,
+    domain_id: base.domainId ?? d.domainId,
+    app_id: base.appId ?? d.appId,
+    bot_id: base.botId,
+    agent_id: base.agentId,
+    session_id: base.sessionId,
+    message_id: base.messageId || Date.now().toString(),
+    ...content
+  }
+}
+
+/** 上行：在已合并的 ctx 上套 openclaw_bot_chat 信封（messageType / _userId / source + content） */
+function buildOutboundOpenclawBotChatEnvelope(
+  ctx: IMsgParams,
+  content: Record<string, unknown>,
+  opts?: { mergeChannelDefaults?: boolean }
+): OpenclawBotChatEnvelope {
+  const d = getParamsDefaults()
+  const base = opts?.mergeChannelDefaults ? mergeOutboundWithDefaults(ctx, d) : ctx
+  return {
+    messageType: 'openclaw_bot_chat',
+    _userId: base.userId,
+    source: 'client',
+    content: buildWireContent(base, d, content)
+  }
+}
+
+/**
+ * 下行解析为 DcgchatMsgContext，或上行组装 openclaw_bot_chat 信封。
+ * 上行时 `content` 由调用方传入；基础参数来自 `ctx` 与 `getParamsDefaults()`（可选 mergeChannelDefaults，同原 wsSendRaw）。
+ */
+export function buildOpenclawBotChat(msg: InboundMsgForContext): IMsgParams
+export function buildOpenclawBotChat(
+  ctx: IMsgParams,
+  content: Record<string, unknown>,
+  opts?: { mergeChannelDefaults?: boolean }
+): OpenclawBotChatEnvelope
+export function buildOpenclawBotChat(
+  arg1: InboundMsgForContext | IMsgParams,
+  arg2?: Record<string, unknown>,
+  opts?: { mergeChannelDefaults?: boolean }
+): IMsgParams | OpenclawBotChatEnvelope {
+  const d = getParamsDefaults()
+
+  if (arg2 === undefined && isInboundWire(arg1)) {
+    return inboundToCtx(arg1, d)
+  }
+
+  const ctx = arg1 as IMsgParams
+  return buildOutboundOpenclawBotChatEnvelope(ctx, arg2 ?? {}, opts)
+}
+
+export function isWsOpen(): boolean {
+  const isOpen = getWsConnection()?.readyState === WebSocket.OPEN
+  if (!isOpen) {
+    dcgLogger(`server socket not ready ${getWsConnection()?.readyState}`, 'error')
+  }
+  return isOpen
+}
+
+/**
+ * 聊天流路径：content 单独 JSON.stringify（双重编码），符合 dcgchat 协议。
+ * `ctx` 须由调用方用 getEffectiveMsgParams(sessionKey) 等解析好；`content` 为完整业务 payload。
+ */
+export function wsSend(ctx: IMsgParams, content: Record<string, unknown>, isLog = true): boolean {
+  const ws = getWsConnection()
+  if (ws?.readyState !== WebSocket.OPEN) return false
+  const envelope = buildOpenclawBotChat(ctx, content)
+  ws.send(JSON.stringify({ ...envelope, content: JSON.stringify(envelope.content) }))
+  if (isLog) {
+    dcgLogger('[插件=>后端]-[wsSend]：' + formatWsEnvelopeForLog(envelope))
+  }
+  return true
+}
+
+/**
+ * 媒体 / channel 出站：content 保持嵌套对象（单次编码）。
+ * `ctx` 须由调用方解析（如需合并覆盖可先 mergeSessionParams）。
+ */
+export function wsSendRaw(ctx: IMsgParams, content: Record<string, unknown>, isLog = true): boolean {
+  const ws = getWsConnection()
+  if (ws?.readyState !== WebSocket.OPEN) {
+    dcgLogger(`server socket not ready ${ws?.readyState}`, 'error')
+    return false
+  }
+  const envelope = buildOpenclawBotChat(ctx, content, { mergeChannelDefaults: true })
+  ws.send(JSON.stringify(envelope))
+  if (isLog) {
+    dcgLogger('[插件=>后端]-[wsSendRaw]：' + formatWsEnvelopeForLog(envelope))
+  }
+  return true
+}
+
+export function sendChunk(text: string, ctx: IMsgParams, chunkIdx: number): boolean {
+  return wsSend(ctx, { response: text, state: 'chunk', chunk_idx: chunkIdx }, false)
+}
+
+export function sendFinal(ctx: IMsgParams, tag: string, text?: string, params?: Record<string, unknown>): boolean {
+  dcgLogger(` message handling complete state: to=${ctx.sessionId} final tag:${tag}`)
+  const mediaBucket = resolveOutboundMediaDedupeKey(ctx.messageId, ctx.sessionId, ctx.sessionKey)
+  if (mediaBucket) clearSentMediaKeys(mediaBucket)
+  return wsSend(ctx, { response: text || '', state: 'final', ...(params || {}) }, false)
+}
+
+export function sendText(text: string, ctx: IMsgParams, event?: Record<string, unknown>): boolean {
+  return wsSend(ctx, { response: text, ...event })
+}
+
+export function sendError(errorMsg: string, ctx: IMsgParams): boolean {
+  return wsSend(ctx, { response: `[错误] ${errorMsg}`, state: 'final' })
+}
+
+export function sendEventMessage(params: Record<string, any> = {}) {
+  const ctx = getParamsDefaults()
+  const ws = getWsConnection()
+  if (isWsOpen()) {
+    const conntent = JSON.stringify({
+      messageType: 'openclaw_bot_event',
+      source: 'client',
+      content: {
+        bot_token: ctx.botToken,
+        domain_id: ctx.domainId,
+        app_id: ctx.appId,
+        bot_id: ctx.botId,
+        ...params
+      }
+    })
+    dcgLogger(`[插件=>后端]-[sendEventMessage]：${conntent}`)
+    ws?.send(conntent)
+  }
+}

package/src/types.ts

@@ -0,0 +1,139 @@
+/**
+ * 插件配置（channels.dcgchat 下的字段）
+ */
+export type DcgchatConfig = {
+  enabled?: boolean
+  /** 后端 WebSocket 地址，例如 ws://localhost:8080/openclaw/ws */
+  wsUrl?: string
+  /** 连接认证 token */
+  botToken?: string
+  /** 用户标识 */
+  userId?: string
+  domainId?: string
+  appId?: string
+  /**
+   * 内置 `message` 工具走 OpenClaw 目标解析：`true`（默认）时仅将符合 sessionKey 形态的字符串视为合法 target，
+   * 纯数字（WS userId 等）会解析失败；设为 `false` 恢复旧版宽松行为（不推荐）。
+   */
+  strictMessageToolTarget?: boolean
+}
+
+export type ResolvedDcgchatAccount = {
+  accountId: string
+  enabled: boolean
+  configured: boolean
+  wsUrl: string
+  botToken: string
+  userId: string
+  domainId?: string
+  appId?: string
+}
+
+/**
+ * 下行消息：后端 → OpenClaw（用户发的消息）
+ */
+// export type InboundMessage = {
+//   type: "message";
+//   userId: string;
+//   text: string;
+// };
+export type InboundMessage = {
+  messageType: string // "openclaw_bot_chat",
+  _userId: number
+  source: string // 'server',
+  // content: string;
+  content: {
+    skills_scope?: Record<string, any>[]
+    bot_token: string
+    agent_clone_code?: string
+    domain_id?: string
+    app_id?: string
+    bot_id?: string
+    agent_id?: string
+    session_id: string
+    real_mobook: string | number
+    message_id: string
+    text: string
+    files?: {
+      url: string
+      name: string
+    }[]
+  }
+}
+
+//  {"_userId":40,"content":"{\"bot_token\":\"sk_b7f8a3e1c5d24e6f8a1b3c4d5e6f7a8b\",\"session_id\":\"1\",\"message_id\":\"1\",\"text\":\"你好\"}","messageType":"openclaw_bot_chat","msgId":398599,"source":"server","title":"OPENCLAW机器人对话"}
+
+/**
+ * 上行消息：OpenClaw → 后端（Agent 回复）
+ */
+// export type OutboundReply = {
+//   type: "reply";
+//   userId: string;
+//   text: string;
+// };
+
+export type OutboundReply = {
+  messageType: string // "openclaw_bot_chat",
+  _userId: number // 100
+  source: string // 'client',
+  // content: string;
+  content: {
+    bot_token: string // ""
+    session_id: string // ""
+    message_id: string // ""
+    response: string // ""
+    state: string // final, chunk
+    domain_id?: string
+    app_id?: string
+    bot_id?: string
+    agent_id?: string
+    files?: { url: string; name: string }[]
+  }
+}
+
+export interface IResponse<T = unknown> {
+  /** 响应状态码 */
+  code?: number | string
+  /** 响应数据 */
+  data?: T
+  /** 响应消息 */
+  message?: string
+}
+
+export interface IStsToken {
+  bucket: string
+  endPoint: string
+  expiration: string
+  ossFileKey: string
+  policy: string
+  region: string
+  signature: string
+  sourceFileName: string
+  stsEndPoint: string
+  tempAccessKeyId: string
+  tempAccessKeySecret: string
+  tempSecurityToken: string
+  uploadDir: string
+  protocol: string
+}
+
+export interface IStsTokenReq {
+  sourceFileName: string
+  isPrivate: number
+}
+
+export interface IMsgParams {
+  userId?: number
+  botToken?: string
+  sessionId?: string
+  messageId?: string
+  domainId?: string
+  appId?: string
+  botId?: string
+  agentId?: string
+  /** 与 OpenClaw 路由一致，用于 map 与异步链路（工具 / HTTP / cron）对齐当前会话 */
+  sessionKey?: string
+  real_mobook?: string | number
+  is_finish?: number
+  message_tags?: Record<string, string>
+}

package/src/utils/agentErrors.ts

@@ -0,0 +1,116 @@
+/**
+ * 识别 OpenClaw embedded agent 抛出的上下文/压缩相关错误（日志与异常文案可能略有差异）。
+ */
+function errorText(err: unknown): string {
+  if (err instanceof Error) return err.message
+  if (typeof err === 'string') return err
+  return String(err)
+}
+
+export function isContextOverflowError(err: unknown): boolean {
+  const t = errorText(err)
+  return /context overflow/i.test(t) || /prompt too large/i.test(t) || /auto-compaction failed/i.test(t) || /\(precheck\)/i.test(t)
+}
+
+/** 用户可见说明（不含 transport 层前缀） */
+export function contextOverflowUserHint(): string {
+  return '当前对话过长，已超过模型上下文限制；自动压缩未完全生效时会出现此情况。请尝试新开对话、缩短任务，或换用更大上下文的模型。'
+}
+
+function ensureChinesePeriod(text: string): string {
+  const t = text.trim()
+  if (!t) return t
+  return /[。！？.!?]$/u.test(t) ? t : `${t}。`
+}
+
+/** 将 OpenClaw/agent 常见英文错误转换为用户可见中文说明。 */
+export function agentErrorUserHint(err: unknown): string | undefined {
+  if (isContextOverflowError(err)) return contextOverflowUserHint()
+
+  const t = errorText(err).trim()
+  if (!t) return undefined
+
+  if (/Content Exists Risk/i.test(t)) {
+    return '当前检索内容包含风险信息，出于内容安全规范，暂不支持输出相关回答。'
+  }
+  if (/Agent couldn't generate a response\.\s*Note:\s*some tool actions may have already been executed/i.test(t)) {
+    return '很抱歉，本次对话未能生成回复。部分工具操作可能已经执行，请先核对执行结果，确认后再决定是否重试。'
+  }
+  if (/Agent couldn't generate a response/i.test(t)) {
+    return '很抱歉，本次对话未能生成回复，你可以重新发送提问再试试看～'
+  }
+  if (/API rate limit reached/i.test(t)) {
+    return 'API 调用频率已达上限，请稍后重试。'
+  }
+  if (/The AI service is temporarily overloaded/i.test(t)) {
+    return 'AI 服务当前繁忙，请稍后重试。'
+  }
+  if (/The AI service returned an error/i.test(t)) {
+    return 'AI 服务返回异常，请重试。'
+  }
+  if (/The model did not produce a response before the model idle timeout/i.test(t)) {
+    return '模型在超时时间内未返回结果，请重试。'
+  }
+
+  const imageMax = t.match(/Image too large for the model\s*\(max\s+([^)]+)\)/i)
+  if (imageMax?.[1]) {
+    return `图片超过模型支持的大小（最大 ${imageMax[1].trim()}），请压缩或缩小图片后重试。`
+  }
+  if (/Image too large for the model/i.test(t)) {
+    return '图片超过模型支持的大小，请压缩或缩小图片后重试。'
+  }
+  if (/Request failed after repeated internal retries/i.test(t)) {
+    return '系统多次自动重试后仍未成功，请重试；如问题持续存在，请使用 /new 开启新的会话。'
+  }
+  if (/Message ordering conflict/i.test(t)) {
+    return '会话消息顺序发生冲突，请重试；如问题持续存在，请使用 /new 开启新的会话。'
+  }
+
+  const backendFallback = t.match(
+    /couldn't reach the configured model backend\s+(.+?)\.\s*Fallback used\s+(.+?),\s*but it produced no visible reply/i
+  )
+  if (backendFallback?.[1] && backendFallback[2]) {
+    return `⚠️ 无法连接到配置的模型 ${backendFallback[1].trim()}，已切换至备用模型 ${backendFallback[2].trim()}，但仍未生成可见回复。`
+  }
+  if (/Follow-up completed, but OpenClaw could not deliver it to the originating channel/i.test(t)) {
+    return '后续任务已完成，但无法将回复发送回原始会话。为避免消息发送到错误的渠道，本次回复未自动转发。'
+  }
+
+  const memoryFlush = t.match(/Memory flush failed after\s+(\S+)\s+attempts/i)
+  if (memoryFlush?.[1]) {
+    return `⚠️ Memory 写入连续失败 ${memoryFlush[1].trim()} 次，本轮已跳过，将在下一次整理时自动重试。`
+  }
+  if (/All models are temporarily rate-limited/i.test(t)) {
+    return '所有模型当前都受到频率限制，请稍后重试。'
+  }
+
+  const allModelsFailed = t.match(/All models failed\s*\(([^)]+)\)/i)
+  if (allModelsFailed?.[1]) {
+    return `所有模型均调用失败（共 ${allModelsFailed[1].trim()} 个）。`
+  }
+
+  const btwFailedWithMessage = t.match(/\/btw failed:\s*(.+)$/i)
+  if (btwFailedWithMessage?.[1]) {
+    return `⚠️ /btw 命令执行失败：${ensureChinesePeriod(btwFailedWithMessage[1])}`
+  }
+  if (/\/btw failed/i.test(t)) {
+    return '⚠️ /btw 命令执行失败。'
+  }
+  if (/The provider returned an empty response/i.test(t)) {
+    return '很抱歉，本次对话未能生成回复，你可以重新发送提问再试试看～。'
+  }
+  if (/Unknown error \(no error details in response\)/i.test(t)) {
+    return '未知错误（未获取到错误详情）。'
+  }
+  if (/Unknown error/i.test(t)) {
+    return '未知错误。'
+  }
+
+  return undefined
+}
+
+/** 仅翻译 OpenClaw 明确标记为错误的助手载荷，普通正文始终原样返回。 */
+export function agentErrorPayloadText(text: string, isError: boolean): string {
+  if (!isError) return text
+  return agentErrorUserHint(text) ?? text
+}

package/src/utils/constant.ts

@@ -0,0 +1,60 @@
+import { ENV_CONFIG, DEFAULT_BUILD_ENV, BuildEnv } from './env-config.js'
+
+declare const __ENV__: BuildEnv
+declare const __CHANNEL_ID__: string
+
+// esbuild define 会将 __ENV__ / __CHANNEL_ID__ 内联为字面量
+
+export const ENV: BuildEnv =
+  typeof __ENV__ !== 'undefined' ? __ENV__ : DEFAULT_BUILD_ENV
+export const CHANNEL_ID: string =
+  typeof __CHANNEL_ID__ !== 'undefined'
+    ? __CHANNEL_ID__
+    : ENV_CONFIG[DEFAULT_BUILD_ENV].channelId
+
+export const systemCommand = ['/new', '/status']
+export const stopCommand = ['/stop']
+
+export const ignoreToolCommand = ['/search', '/abort', '/queue interrupt', ...systemCommand, ...stopCommand]
+
+/* ── 网络与定时器统一常量 ── */
+
+/** WebSocket 心跳/Ping 间隔（毫秒） */
+export const WS_HEARTBEAT_INTERVAL_MS = 30_000
+
+/** WebSocket 重连延迟（毫秒） */
+export const WS_RECONNECT_DELAY_MS = 5_000
+
+/** OpenClaw Gateway WebSocket 握手协议版本（须与宿主 gateway 一致，当前为 v4） */
+export const GATEWAY_PROTOCOL_VERSION = 4
+
+/** /stop 后立即发新消息时，等待宿主 reply run 释放的 settle 时间（毫秒） */
+export const AFTER_STOP_SETTLE_MS = 50
+
+/** 等待子 agent 空闲的最大超时时间（毫秒） */
+export const SUBAGENT_IDLE_TIMEOUT_MS = 60 * 60 * 1000
+
+/* ── 通用重试工具 ── */
+
+/**
+ * 带指数退避的重试函数
+ * @param fn 需要重试的异步操作
+ * @param maxAttempts 最大尝试次数（默认3）
+ * @param initialDelayMs 初始延迟毫秒（默认500）
+ */
+export async function retryWithBackoff<T>(
+  fn: () => Promise<T>,
+  maxAttempts: number = 3,
+  initialDelayMs: number = 500
+): Promise<T> {
+  for (let attempt = 0; attempt < maxAttempts; attempt++) {
+    try {
+      return await fn()
+    } catch (err) {
+      if (attempt === maxAttempts - 1) throw err
+      const delay = initialDelayMs * Math.pow(2, attempt)
+      await new Promise((resolve) => setTimeout(resolve, delay))
+    }
+  }
+  throw new Error('retryWithBackoff: unreachable')
+}

package/src/utils/env-config.ts

@@ -0,0 +1,19 @@
+export type BuildEnv = 'production' | 'test'
+
+export interface EnvConfig {
+  packageName: string
+  channelId: string
+}
+
+export const ENV_CONFIG: Record<BuildEnv, EnvConfig> = {
+  production: {
+    packageName: '@dcrays/dcgchat',
+    channelId: 'dcgchat'
+  },
+  test: {
+    packageName: '@dcrays/dcgchat-test',
+    channelId: 'dcgchat-test'
+  }
+}
+
+export const DEFAULT_BUILD_ENV: BuildEnv = 'test'

package/src/utils/formatLlmInputEvent.ts

@@ -0,0 +1,48 @@
+export function formatLlmInputEvent(event: Record<string, unknown>, ctx: any): string {
+  try {
+    const runId = String(event.runId ?? '?')
+    const sessionId = String(event.sessionId ?? '?')
+    const provider = String(event.provider ?? '?')
+    const model = String(event.model ?? '?')
+    const imagesCount = Number(event.imagesCount ?? 0)
+    const historyLen = Array.isArray(event.historyMessages) ? event.historyMessages.length : 0
+    const prompt = String(event.prompt ?? '')
+    const systemPrompt = event.systemPrompt != null ? String(event.systemPrompt) : ''
+
+    const sessionKey = ctx?.sessionKey || ''
+    const agentId = ctx?.agentId || ''
+
+    const lines: string[] = []
+    lines.push(`===== llm_input =====`)
+    lines.push(
+      `sessionKey=${sessionKey} agentId=${agentId} runId=${runId} sessionId=${sessionId} provider=${provider} model=${model} images=${imagesCount} historyMessages=${historyLen} systemPromptLenght=${systemPrompt.length} promptLength=${prompt.length}`
+    )
+
+    const sampleText = extractTextPreview(prompt, 200)
+    lines.push(`[TEXT] ${sampleText}${sampleText.length === 200 ? '...' : ''}`)
+    return lines.join('\n')
+  } catch (error) {
+    return `formatLlmInputEvent Error: ${error}`
+  }
+}
+
+function extractTextPreview(prompt: string, maxLen: number): string {
+  let result = ''
+
+  for (const seg of prompt.split('\n\n')) {
+    const raw = seg.trim()
+    if (!raw) continue
+    if (raw.startsWith('### Inbound message metadata')) continue
+    if (raw.startsWith('### Chat history since last reply')) continue
+    if (raw.startsWith('[media attached:')) continue
+    if (raw.startsWith('Conversation info')) continue
+    if (raw.startsWith('Sender (untrusted metadata)')) continue
+    if (raw.startsWith('```json') && raw.includes('message_id')) continue
+    if (raw.includes('[media:') || raw.includes('<media:') || raw.includes('<file ')) continue
+
+    if (result) result += '\n\n'
+    result += raw
+    if (result.length >= maxLen) break
+  }
+  return result.slice(0, maxLen).replace(/\n/g, ' ')
+}