diff --git a/docs/zh-CN/gateway/health.md b/docs/zh-CN/gateway/health.md index 9ae60e2f3..f7aec6dfe 100644 --- a/docs/zh-CN/gateway/health.md +++ b/docs/zh-CN/gateway/health.md @@ -1,14 +1,14 @@ --- read_when: - - 诊断渠道连接性或 Gateway 网关健康状态 + - 诊断渠道连接或 Gateway 网关健康状况 - 了解健康检查 CLI 命令和选项 -summary: 健康检查命令与 Gateway 网关健康监控 +summary: 健康检查命令和 Gateway 网关健康监控 title: 健康检查 x-i18n: - generated_at: "2026-04-05T08:23:20Z" + generated_at: "2026-04-23T00:48:54Z" model: gpt-5.4 provider: openai - source_hash: b8824bca34c4d1139f043481c75f0a65d83e54008898c34cf69c6f98fd04e819 + source_hash: 5ddcbe6fa913c5ba889f78cb417124c96b562cf8939410b1d6f66042dfb51a9f source_path: gateway/health.md workflow: 15 --- @@ -19,50 +19,52 @@ x-i18n: ## 快速检查 -- `openclaw status` —— 本地摘要：Gateway 网关可达性/模式、更新提示、已关联渠道的认证时长、sessions + 最近活动。 -- `openclaw status --all` —— 完整本地诊断（只读、彩色、可安全复制粘贴用于调试）。 -- `openclaw status --deep` —— 向正在运行的 Gateway 网关请求实时健康探测（`health` 携带 `probe:true`），包括在支持时按账号划分的渠道探测。 -- `openclaw health` —— 向正在运行的 Gateway 网关请求其健康快照（仅 WS；CLI 不会直接连接渠道 socket）。 -- `openclaw health --verbose` —— 强制执行实时健康探测，并打印 Gateway 网关连接详情。 -- `openclaw health --json` —— 机器可读的健康快照输出。 -- 在 WhatsApp/WebChat 中将 `/status` 作为单独消息发送，以在不调用智能体的情况下获取状态回复。 +- `openclaw status` — 本地摘要：Gateway 网关可达性/模式、更新提示、已关联渠道的凭证有效期、会话 + 最近活动。 +- `openclaw status --all` — 完整本地诊断（只读、带颜色、可安全粘贴用于调试）。 +- `openclaw status --deep` — 向正在运行的 Gateway 网关请求实时健康探测（`health` 且 `probe:true`），包括支持时按账号划分的渠道探测。 +- `openclaw health` — 向正在运行的 Gateway 网关请求其健康快照（仅 `WS`；CLI 不会直接连接渠道套接字）。 +- `openclaw health --verbose` — 强制执行实时健康探测，并打印 Gateway 网关连接详情。 +- `openclaw health --json` — 机器可读的健康快照输出。 +- 在 WhatsApp/WebChat 中单独发送 `/status` 消息，可在不调用智能体的情况下获取状态回复。 - 日志：跟踪 `/tmp/openclaw/openclaw-*.log`，并筛选 `web-heartbeat`、`web-reconnect`、`web-auto-reply`、`web-inbound`。 ## 深度诊断 -- 磁盘上的凭证：`ls -l ~/.openclaw/credentials/whatsapp//creds.json`（mtime 应该是最近的）。 -- 会话存储：`ls -l ~/.openclaw/agents//sessions/sessions.json`（路径可在配置中覆盖）。数量和最近接收者会通过 `status` 显示。 -- 重新关联流程：当日志中出现状态码 409–515 或 `loggedOut` 时，运行 `openclaw channels logout && openclaw channels login --verbose`。（注意：在配对后，二维码登录流程会在状态 515 时自动重启一次。） +- 磁盘上的凭证：`ls -l ~/.openclaw/credentials/whatsapp//creds.json`（`mtime` 应该是最近的）。 +- 会话存储：`ls -l ~/.openclaw/agents//sessions/sessions.json`（路径可在配置中覆盖）。`status` 会显示数量和最近的接收方。 +- 重新关联流程：当日志中出现状态码 `409–515` 或 `loggedOut` 时，运行 `openclaw channels logout && openclaw channels login --verbose`。（注意：配对后，二维码登录流程会在状态 `515` 时自动重启一次。） +- 默认启用诊断。除非设置了 `diagnostics.enabled: false`，否则 Gateway 网关会记录运行事实。内存事件会记录 RSS/堆字节数、阈值压力和增长压力。超大负载事件会记录哪些内容被拒绝、截断或分块，以及可用时的大小和限制。它们不会记录消息文本、附件内容、webhook 正文、原始请求或响应正文、令牌、Cookie 或机密值。同一个心跳还会启动有界稳定性记录器，可通过 `openclaw gateway stability` 或 `diagnostics.stability` Gateway 网关 RPC 访问。当存在事件时，致命的 Gateway 网关退出、关闭超时和重启启动失败会将最新的记录器快照持久化到 `~/.openclaw/logs/stability/`；可使用 `openclaw gateway stability --bundle latest` 检查最新保存的 bundle。 +- 对于 bug 报告，运行 `openclaw gateway diagnostics export` 并附上生成的 zip。该导出会合并 Markdown 摘要、最新稳定性 bundle、已净化的日志元数据、已净化的 Gateway 网关状态/健康快照以及配置结构。它设计为可共享：聊天文本、webhook 正文、工具输出、凭证、Cookie、账号/消息标识符和机密值会被省略或脱敏。 ## 健康监控配置 -- `gateway.channelHealthCheckMinutes`：Gateway 网关检查渠道健康状态的频率。默认：`5`。设置为 `0` 可全局禁用健康监控重启。 -- `gateway.channelStaleEventThresholdMinutes`：某个已连接渠道在被健康监控视为陈旧并重启之前，允许空闲的最长时间。默认：`30`。请保持其大于或等于 `gateway.channelHealthCheckMinutes`。 -- `gateway.channelMaxRestartsPerHour`：按渠道/账号统计的、健康监控重启的滚动一小时上限。默认：`10`。 -- `channels..healthMonitor.enabled`：在保持全局监控启用的同时，为某个特定渠道禁用健康监控重启。 -- `channels..accounts..healthMonitor.enabled`：多账号覆盖项，其优先级高于渠道级设置。 -- 这些按渠道划分的覆盖项适用于当前暴露该能力的内置渠道监控器：Discord、Google Chat、iMessage、Microsoft Teams、Signal、Slack、Telegram 和 WhatsApp。 +- `gateway.channelHealthCheckMinutes`：Gateway 网关检查渠道健康状态的频率。默认值：`5`。设为 `0` 可全局禁用健康监控重启。 +- `gateway.channelStaleEventThresholdMinutes`：已连接渠道在被健康监控视为陈旧并重启之前，可以保持空闲多长时间。默认值：`30`。请保持该值大于或等于 `gateway.channelHealthCheckMinutes`。 +- `gateway.channelMaxRestartsPerHour`：每个渠道/账号在滚动一小时内由健康监控触发重启的上限。默认值：`10`。 +- `channels..healthMonitor.enabled`：在保持全局监控启用的同时，禁用特定渠道的健康监控重启。 +- `channels..accounts..healthMonitor.enabled`：多账号覆盖项，优先于渠道级设置。 +- 这些按渠道划分的覆盖项适用于当前公开这些功能的内置渠道监控器：Discord、Google Chat、iMessage、Microsoft Teams、Signal、Slack、Telegram 和 WhatsApp。 -## 当某些内容失败时 +## 失败时的处理 -- `logged out` 或状态码 409–515 → 使用 `openclaw channels logout` 然后 `openclaw channels login` 重新关联。 -- Gateway 网关不可达 → 启动它：`openclaw gateway --port 18789`（如果端口繁忙，请使用 `--force`）。 -- 没有入站消息 → 确认已关联手机在线，且发送者已被允许（`channels.whatsapp.allowFrom`）；对于群聊，请确保允许列表 + 提及规则匹配（`channels.whatsapp.groups`、`agents.list[].groupChat.mentionPatterns`）。 +- `logged out` 或状态码 `409–515` → 使用 `openclaw channels logout`，然后运行 `openclaw channels login` 重新关联。 +- Gateway 网关不可达 → 启动它：`openclaw gateway --port 18789`（如果端口被占用，使用 `--force`）。 +- 没有入站消息 → 确认已关联的手机处于在线状态，并且发送方被允许（`channels.whatsapp.allowFrom`）；对于群聊，确保允许列表和提及规则匹配（`channels.whatsapp.groups`、`agents.list[].groupChat.mentionPatterns`）。 -## 专用的 “health” 命令 +## 专用 “health” 命令 `openclaw health` 会向正在运行的 Gateway 网关请求其健康快照（CLI 不会直接连接渠道 -socket）。默认情况下，它可以返回一个新的缓存 Gateway 网关快照；随后 -Gateway 网关会在后台刷新该缓存。`openclaw health --verbose` 则会强制执行 -实时探测。该命令会在可用时报告已关联凭证/认证时长、 -按渠道划分的探测摘要、会话存储摘要以及探测耗时。如果 -Gateway 网关不可达，或探测失败/超时，它会以非零状态退出。 +套接字）。默认情况下，它可以返回一个较新的缓存 Gateway 网关快照；随后 +Gateway 网关会在后台刷新该缓存。`openclaw health --verbose` 则会强制 +执行实时探测。该命令会在可用时报告已关联凭证/凭证有效期、 +按渠道划分的探测摘要、会话存储摘要以及探测耗时。如果 Gateway 网关不可达，或者探测失败/超时， +它会以非零状态退出。 选项： - `--json`：机器可读的 JSON 输出 -- `--timeout `：覆盖默认的 10 秒探测超时 -- `--verbose`：强制实时探测并打印 Gateway 网关连接详情 +- `--timeout `：覆盖默认的 `10s` 探测超时 +- `--verbose`：强制执行实时探测，并打印 Gateway 网关连接详情 - `--debug`：`--verbose` 的别名 -健康快照包括：`ok`（布尔值）、`ts`（时间戳）、`durationMs`（探测耗时）、按渠道划分的状态、智能体可用性，以及会话存储摘要。 +健康快照包括：`ok`（布尔值）、`ts`（时间戳）、`durationMs`（探测耗时）、按渠道划分的状态、智能体可用性以及会话存储摘要。 diff --git a/docs/zh-CN/gateway/protocol.md b/docs/zh-CN/gateway/protocol.md index 59f8c8f71..0803d3e1e 100644 --- a/docs/zh-CN/gateway/protocol.md +++ b/docs/zh-CN/gateway/protocol.md @@ -2,30 +2,31 @@ read_when: - 实现或更新 Gateway 网关 WS 客户端 - 调试协议不匹配或连接失败 - - 重新生成协议 schema/模型 + - 重新生成协议 schema / 模型 summary: Gateway 网关 WebSocket 协议：握手、帧、版本控制 title: Gateway 网关协议 x-i18n: - generated_at: "2026-04-21T20:16:08Z" + generated_at: "2026-04-23T00:48:56Z" model: gpt-5.4 provider: openai - source_hash: 6efa76f5f0faa6c10a8515b0cf457233e48551e3484a605dffaf6459ddff9231 + source_hash: 9d4ea65fbe31962ed8ece04a645cfe5aaff9fee8b5f89bc896b461cd45567634 source_path: gateway/protocol.md workflow: 15 --- # Gateway 网关协议（WebSocket） -Gateway 网关 WS 协议是 OpenClaw 的**单一控制平面 + 节点传输协议**。所有客户端（CLI、web UI、macOS 应用、iOS/Android 节点、无头节点）都通过 WebSocket 连接，并在握手时声明其**角色** + **作用域**。 +Gateway 网关 WS 协议是 OpenClaw 的**单一控制平面 + 节点传输层**。所有客户端（CLI、Web UI、macOS 应用、iOS/Android 节点、无头节点）都通过 WebSocket 连接，并在握手时声明其**角色** + **作用域**。 ## 传输 - WebSocket，使用带有 JSON 负载的文本帧。 -- 第一帧**必须**是 `connect` 请求。 +- 第一帧**必须**是一个 `connect` 请求。 +- 连接前的帧大小上限为 64 KiB。成功握手后，客户端应遵循 `hello-ok.policy.maxPayload` 和 `hello-ok.policy.maxBufferedBytes` 限制。启用诊断时，过大的入站帧和缓慢的出站缓冲区会先发出 `payload.large` 事件，然后 Gateway 网关才会关闭连接或丢弃受影响的帧。这些事件会保留大小、限制、表面、以及安全原因代码。它们不会保留消息正文、附件内容、原始帧正文、令牌、cookie 或密钥值。 ## 握手（connect） -Gateway 网关 → 客户端（连接前质询）： +Gateway 网关 → 客户端（连接前挑战）： ```json { @@ -92,9 +93,9 @@ Gateway 网关 → 客户端： } ``` -`server`、`features`、`snapshot` 和 `policy` 都是 schema 要求的字段（`src/gateway/protocol/schema/frames.ts`）。`canvasHostUrl` 是可选字段。`auth` 会在可用时报告协商后的角色/作用域，并在 Gateway 网关签发设备令牌时包含 `deviceToken`。 +根据 schema（`src/gateway/protocol/schema/frames.ts`），`server`、`features`、`snapshot` 和 `policy` 都是必需的。`canvasHostUrl` 是可选项。`auth` 会在可用时报告协商后的角色/作用域，并在 Gateway 网关签发设备令牌时包含 `deviceToken`。 -当未签发设备令牌时，`hello-ok.auth` 仍然可以报告协商后的权限： +当未签发设备令牌时，`hello-ok.auth` 仍可报告协商后的权限： ```json { @@ -105,7 +106,7 @@ Gateway 网关 → 客户端： } ``` -当签发了设备令牌时，`hello-ok` 还会包含： +当签发设备令牌时，`hello-ok` 还会包含： ```json { @@ -117,7 +118,7 @@ Gateway 网关 → 客户端： } ``` -在受信任的引导交接期间，`hello-ok.auth` 还可能在 `deviceTokens` 中包含额外的受限角色条目： +在受信任的 bootstrap 交接期间，`hello-ok.auth` 还可以在 `deviceTokens` 中包含额外的有界角色条目： ```json { @@ -136,9 +137,9 @@ Gateway 网关 → 客户端： } ``` -对于内置的 node/operator 引导流程，主 node 令牌保持为 `scopes: []`，而任何交接的 operator 令牌都会保持受限于引导 operator 允许列表（`operator.approvals`、`operator.read`、`operator.talk.secrets`、`operator.write`）。引导作用域检查仍然按角色前缀进行：operator 条目只满足 operator 请求，非 operator 角色仍然需要其自身角色前缀下的作用域。 +对于内置的 node/operator bootstrap 流程，主 node 令牌保持为 `scopes: []`，任何交接出去的 operator 令牌都保持限制在 bootstrap operator 允许列表内（`operator.approvals`、`operator.read`、`operator.talk.secrets`、`operator.write`）。Bootstrap 作用域检查仍保持角色前缀规则：operator 条目只满足 operator 请求，而非 operator 角色仍然需要其自身角色前缀下的作用域。 -### Node 示例 +### 节点示例 ```json { @@ -179,7 +180,7 @@ Gateway 网关 → 客户端： - **响应**：`{type:"res", id, ok, payload|error}` - **事件**：`{type:"event", event, payload, seq?, stateVersion?}` -有副作用的方法需要 **idempotency keys**（参见 schema）。 +有副作用的方法需要 **幂等键**（参见 schema）。 ## 角色 + 作用域 @@ -201,56 +202,57 @@ Gateway 网关 → 客户端： 带有 `includeSecrets: true` 的 `talk.config` 需要 `operator.talk.secrets`（或 `operator.admin`）。 -由插件注册的 Gateway 网关 RPC 方法可以请求它们自己的 operator 作用域，但保留的核心管理前缀（`config.*`、`exec.approvals.*`、`wizard.*`、`update.*`）始终解析为 `operator.admin`。 +由插件注册的 Gateway 网关 RPC 方法可以请求其自己的 operator 作用域，但保留的核心管理前缀（`config.*`、`exec.approvals.*`、`wizard.*`、`update.*`）始终解析为 `operator.admin`。 -方法作用域只是第一道关卡。通过 `chat.send` 到达的一些斜杠命令还会在此基础上应用更严格的命令级检查。例如，持久化的 `/config set` 和 `/config unset` 写入需要 `operator.admin`。 +方法作用域只是第一道门。通过 `chat.send` 到达的一些斜杠命令还会在此基础上应用更严格的命令级检查。例如，持久化的 `/config set` 和 `/config unset` 写入需要 `operator.admin`。 -`node.pair.approve` 也在基础方法作用域之上增加了一层审批时作用域检查： +`node.pair.approve` 在基础方法作用域之上还有额外的批准时作用域检查： - 无命令请求：`operator.pairing` -- 带有非 exec 节点命令的请求：`operator.pairing` + `operator.write` -- 包含 `system.run`、`system.run.prepare` 或 `system.which` 的请求： - `operator.pairing` + `operator.admin` +- 带有非 exec node 命令的请求：`operator.pairing` + `operator.write` +- 包含 `system.run`、`system.run.prepare` 或 `system.which` 的请求：`operator.pairing` + `operator.admin` -### Caps/commands/permissions（node） +### caps/commands/permissions（node） -节点在连接时声明能力声明： +节点在连接时声明能力主张： -- `caps`：高层能力类别。 +- `caps`：高级能力类别。 - `commands`：用于 invoke 的命令允许列表。 - `permissions`：细粒度开关（例如 `screen.record`、`camera.capture`）。 -Gateway 网关将这些视为**声明**，并在服务端强制执行允许列表。 +Gateway 网关将这些视为**主张**，并在服务器端强制执行允许列表。 ## 在线状态 -- `system-presence` 返回按设备标识键控的条目。 -- 在线状态条目包含 `deviceId`、`roles` 和 `scopes`，因此 UI 即使在设备同时以 **operator** 和 **node** 身份连接时，也可以为每台设备显示单独一行。 +- `system-presence` 返回按设备身份键控的条目。 +- 在线状态条目包含 `deviceId`、`roles` 和 `scopes`，这样 UI 就能为单个设备显示一行， + 即使它同时以 **operator** 和 **node** 身份连接。 ## 广播事件作用域控制 -服务端推送的 WebSocket 广播事件受作用域门控，以确保仅配对作用域或仅 node 的会话不会被动接收会话内容。 +服务器推送的 WebSocket 广播事件会进行作用域门控，因此仅具备 pairing 作用域或仅 node 的会话不会被动接收会话内容。 - **聊天、智能体和工具结果帧**（包括流式 `agent` 事件和工具调用结果）至少需要 `operator.read`。没有 `operator.read` 的会话会完全跳过这些帧。 -- **插件定义的 `plugin.*` 广播** 会根据插件注册方式，被门控到 `operator.write` 或 `operator.admin`。 -- **状态和传输事件**（`heartbeat`、`presence`、`tick`、连接/断开生命周期等）保持不受限制，以便每个已认证会话都能观察到传输健康状态。 -- **未知广播事件族** 默认受作用域门控（默认拒绝），除非已注册的处理器显式放宽限制。 +- **插件定义的 `plugin.*` 广播** 会被门控到 `operator.write` 或 `operator.admin`，具体取决于插件注册它们的方式。 +- **状态和传输事件**（`heartbeat`、`presence`、`tick`、连接/断开生命周期等）仍然不受限制，以便每个已认证会话都能观察到传输健康状态。 +- **未知广播事件族** 默认进行作用域门控（失败时关闭），除非已注册的处理器显式放宽它们。 -每个客户端连接都会维护各自的每客户端序列号，因此即使不同客户端看到的是经过不同作用域过滤后的事件流子集，广播在该 socket 上仍会保持单调顺序。 +每个客户端连接都维护自己的按客户端计数的序列号，因此即使不同客户端看到的事件流子集因作用域过滤而不同，广播在该 socket 上仍保持单调有序。 ## 常见 RPC 方法族 -本页不是自动生成的完整转储，但公共 WS 接口比上面的握手/认证示例更广。这些是 Gateway 网关当前公开的主要方法族。 +本页不是生成的完整转储，但公开的 WS 表面比上面的握手/认证示例更广。这些是 Gateway 网关当前暴露的主要方法族。 -`hello-ok.features.methods` 是一个保守的发现列表，由 `src/gateway/server-methods-list.ts` 加上已加载的插件/渠道方法导出构建而成。应将其视为功能发现，而不是 `src/gateway/server-methods/*.ts` 中实现的每个可调用辅助函数的自动生成转储。 +`hello-ok.features.methods` 是一个保守的发现列表，基于 `src/gateway/server-methods-list.ts` 加上已加载的插件/渠道方法导出构建。应将其视为功能发现，而不是对 `src/gateway/server-methods/*.ts` 中每个可调用辅助函数的生成式转储。 -### 系统和标识 +### 系统和身份 - `health` 返回缓存的或新探测的 Gateway 网关健康快照。 +- `diagnostics.stability` 返回最近的有界诊断稳定性记录器。它会保留事件名称、计数、字节大小、内存读数、队列/会话状态、渠道/插件名称以及会话 id 等操作元数据。它不会保留聊天文本、webhook 正文、工具输出、原始请求或响应正文、令牌、cookie 或密钥值。需要 operator 读取作用域。 - `status` 返回 `/status` 风格的 Gateway 网关摘要；敏感字段仅对具有 admin 作用域的 operator 客户端包含。 -- `gateway.identity.get` 返回 relay 和配对流程使用的 Gateway 网关设备标识。 +- `gateway.identity.get` 返回 relay 和 pairing 流程所使用的 Gateway 网关设备身份。 - `system-presence` 返回当前已连接 operator/node 设备的在线状态快照。 -- `system-event` 追加系统事件，并可更新/广播在线状态上下文。 +- `system-event` 追加一条系统事件，并可更新/广播在线状态上下文。 - `last-heartbeat` 返回最近持久化的 heartbeat 事件。 - `set-heartbeats` 切换 Gateway 网关上的 heartbeat 处理。 @@ -258,282 +260,273 @@ Gateway 网关将这些视为**声明**，并在服务端强制执行允许列 - `models.list` 返回运行时允许的模型目录。 - `usage.status` 返回提供商用量窗口/剩余额度摘要。 -- `usage.cost` 返回某日期范围的聚合成本用量摘要。 -- `doctor.memory.status` 返回活动默认智能体工作区的向量记忆 / embedding 就绪状态。 -- `sessions.usage` 返回按会话聚合的用量摘要。 -- `sessions.usage.timeseries` 返回单个会话的时序用量。 +- `usage.cost` 返回日期范围内聚合的成本用量摘要。 +- `doctor.memory.status` 返回活动默认智能体工作区的向量内存 / embedding 就绪状态。 +- `sessions.usage` 返回按会话划分的用量摘要。 +- `sessions.usage.timeseries` 返回单个会话的时间序列用量。 - `sessions.usage.logs` 返回单个会话的用量日志条目。 ### 渠道和登录辅助 -- `channels.status` 返回内置 + 内置插件渠道/插件状态摘要。 -- `channels.logout` 在渠道支持登出的情况下，登出特定渠道/账号。 -- `web.login.start` 为当前支持 QR 的 web 渠道提供商启动 QR/web 登录流程。 -- `web.login.wait` 等待该 QR/web 登录流程完成，并在成功时启动渠道。 -- `push.test` 向已注册的 iOS node 发送测试 APNs 推送。 +- `channels.status` 返回内置 + 内置插件渠道状态摘要。 +- `channels.logout` 在渠道支持登出的情况下，为特定渠道/账号执行登出。 +- `web.login.start` 为当前支持 QR 的 Web 渠道提供商启动 QR/Web 登录流程。 +- `web.login.wait` 等待该 QR/Web 登录流程完成，并在成功后启动渠道。 +- `push.test` 向已注册的 iOS 节点发送测试 APNs 推送。 - `voicewake.get` 返回已存储的唤醒词触发器。 -- `voicewake.set` 更新唤醒词触发器并广播更改。 +- `voicewake.set` 更新唤醒词触发器并广播变更。 ### 消息和日志 -- `send` 是直接的出站投递 RPC，用于在聊天运行器之外，按渠道/账号/线程目标发送消息。 -- `logs.tail` 返回配置的 Gateway 网关文件日志尾部，支持 cursor/limit 和最大字节数控制。 +- `send` 是直接的出站投递 RPC，用于在 chat runner 之外，向特定渠道/账号/线程目标发送消息。 +- `logs.tail` 返回已配置的 Gateway 网关文件日志尾部，并支持 cursor/limit 和 max-byte 控制。 ### Talk 和 TTS -- `talk.config` 返回生效的 Talk 配置负载；`includeSecrets` 需要 `operator.talk.secrets`（或 `operator.admin`）。 -- `talk.mode` 为 WebChat/Control UI 客户端设置/广播当前 Talk 模式状态。 -- `talk.speak` 通过活动的 Talk 语音提供商合成语音。 -- `tts.status` 返回 TTS 启用状态、活动提供商、后备提供商和提供商配置状态。 +- `talk.config` 返回生效中的 Talk 配置负载；`includeSecrets` 需要 `operator.talk.secrets`（或 `operator.admin`）。 +- `talk.mode` 为 WebChat/控制 UI 客户端设置/广播当前 Talk 模式状态。 +- `talk.speak` 通过当前活动的 Talk 语音提供商合成语音。 +- `tts.status` 返回 TTS 启用状态、当前提供商、后备提供商以及提供商配置状态。 - `tts.providers` 返回可见的 TTS 提供商清单。 - `tts.enable` 和 `tts.disable` 切换 TTS 偏好设置状态。 - `tts.setProvider` 更新首选 TTS 提供商。 -- `tts.convert` 执行一次性文本转语音转换。 +- `tts.convert` 运行一次性文本转语音转换。 -### Secrets、配置、更新和向导 +### 密钥、配置、更新和向导 -- `secrets.reload` 重新解析活动 SecretRefs，并且仅在完全成功时替换运行时 secret 状态。 -- `secrets.resolve` 为特定命令/目标集解析命令目标 secret 赋值。 +- `secrets.reload` 会重新解析活动的 SecretRefs，并且仅在完全成功时才切换运行时密钥状态。 +- `secrets.resolve` 会为特定命令/目标集解析命令目标的密钥分配。 - `config.get` 返回当前配置快照和哈希值。 - `config.set` 写入已验证的配置负载。 - `config.patch` 合并部分配置更新。 - `config.apply` 验证并替换完整配置负载。 -- `config.schema` 返回 Control UI 和 CLI 工具使用的实时配置 schema 负载：schema、`uiHints`、版本和生成元数据，包括在运行时可加载时的插件 + 渠道 schema 元数据。该 schema 包含从 UI 所用相同标签和帮助文本派生的字段 `title` / `description` 元数据，包括嵌套对象、通配符、数组项以及 `anyOf` / `oneOf` / `allOf` 组合分支中存在匹配字段文档的情况。 -- `config.schema.lookup` 返回单个配置路径的路径作用域查找负载：规范化路径、浅层 schema 节点、匹配的 hint + `hintPath`，以及供 UI/CLI 逐级深入的直接子项摘要。 - - 查找 schema 节点保留面向用户的文档和常见验证字段： - `title`、`description`、`type`、`enum`、`const`、`format`、`pattern`， - 数值/字符串/数组/对象边界，以及诸如 - `additionalProperties`、`deprecated`、`readOnly`、`writeOnly` 之类的布尔标志。 - - 子项摘要公开 `key`、规范化 `path`、`type`、`required`、 - `hasChildren`，以及匹配的 `hint` / `hintPath`。 -- `update.run` 运行 Gateway 网关更新流程，并且仅在更新本身成功时安排重启。 -- `wizard.start`、`wizard.next`、`wizard.status` 和 `wizard.cancel` 通过 WS RPC 公开新手引导向导。 +- `config.schema` 返回供控制 UI 和 CLI 工具使用的实时配置 schema 负载：schema、`uiHints`、版本和生成元数据，包括运行时可加载时的插件 + 渠道 schema 元数据。该 schema 包含从 UI 使用的相同标签和帮助文本派生的字段 `title` / `description` 元数据，包括嵌套对象、通配符、数组项，以及在存在匹配字段文档时的 `anyOf` / `oneOf` / `allOf` 组合分支。 +- `config.schema.lookup` 返回针对单个配置路径的路径作用域查找负载：规范化路径、浅层 schema 节点、匹配的提示 + `hintPath`，以及用于 UI/CLI 深入查看的直接子项摘要。 + - 查找 schema 节点会保留面向用户的文档和常见验证字段：`title`、`description`、`type`、`enum`、`const`、`format`、`pattern`、数字/字符串/数组/对象边界，以及诸如 `additionalProperties`、`deprecated`、`readOnly`、`writeOnly` 之类的布尔标志。 + - 子项摘要会公开 `key`、规范化的 `path`、`type`、`required`、`hasChildren`，以及匹配的 `hint` / `hintPath`。 +- `update.run` 运行 Gateway 网关更新流程，并且仅在更新本身成功时才安排重启。 +- `wizard.start`、`wizard.next`、`wizard.status` 和 `wizard.cancel` 通过 WS RPC 暴露新手引导向导。 ### 现有主要方法族 #### 智能体和工作区辅助 - `agents.list` 返回已配置的智能体条目。 -- `agents.create`、`agents.update` 和 `agents.delete` 管理智能体记录和工作区接线。 -- `agents.files.list`、`agents.files.get` 和 `agents.files.set` 管理为某个智能体公开的引导工作区文件。 -- `agent.identity.get` 返回某个智能体或会话的生效助手身份。 +- `agents.create`、`agents.update` 和 `agents.delete` 管理智能体记录和工作区连接。 +- `agents.files.list`、`agents.files.get` 和 `agents.files.set` 管理为某个智能体公开的 bootstrap 工作区文件。 +- `agent.identity.get` 返回某个智能体或会话的有效助手身份。 - `agent.wait` 等待一次运行结束，并在可用时返回终态快照。 #### 会话控制 - `sessions.list` 返回当前会话索引。 - `sessions.subscribe` 和 `sessions.unsubscribe` 为当前 WS 客户端切换会话变更事件订阅。 -- `sessions.messages.subscribe` 和 `sessions.messages.unsubscribe` 为单个会话切换 transcript/message 事件订阅。 +- `sessions.messages.subscribe` 和 `sessions.messages.unsubscribe` 为单个会话切换 transcript/消息事件订阅。 - `sessions.preview` 返回特定会话键的有界 transcript 预览。 -- `sessions.resolve` 解析或规范化某个会话目标。 +- `sessions.resolve` 解析或规范化会话目标。 - `sessions.create` 创建新的会话条目。 - `sessions.send` 向现有会话发送消息。 -- `sessions.steer` 是针对活动会话的中断并转向变体。 +- `sessions.steer` 是针对活动会话的中断并引导变体。 - `sessions.abort` 中止某个会话的活动工作。 - `sessions.patch` 更新会话元数据/覆盖项。 - `sessions.reset`、`sessions.delete` 和 `sessions.compact` 执行会话维护。 - `sessions.get` 返回完整存储的会话行。 -- 聊天执行仍然使用 `chat.history`、`chat.send`、`chat.abort` 和 `chat.inject`。 -- `chat.history` 会为 UI 客户端进行显示规范化：可见文本中的内联指令标签会被去除，纯文本工具调用 XML 负载（包括 `...`、`...`、`...`、`...` 以及被截断的工具调用块）和泄漏的 ASCII/全角模型控制令牌会被去除，纯静默令牌的助手行（如精确的 `NO_REPLY` / `no_reply`）会被省略，而超大行可被占位符替换。 +- 聊天执行仍使用 `chat.history`、`chat.send`、`chat.abort` 和 `chat.inject`。 +- `chat.history` 对 UI 客户端做了显示规范化：会从可见文本中移除内联指令标签，移除纯文本工具调用 XML 负载（包括 `...`、`...`、`...`、`...`，以及被截断的工具调用块）和泄露的 ASCII/全角模型控制令牌，省略纯静默令牌的助手行（例如精确的 `NO_REPLY` / `no_reply`），并且可将过大的行替换为占位符。 #### 设备配对和设备令牌 -- `device.pair.list` 返回待处理和已批准的已配对设备。 +- `device.pair.list` 返回待处理和已批准的配对设备。 - `device.pair.approve`、`device.pair.reject` 和 `device.pair.remove` 管理设备配对记录。 - `device.token.rotate` 在已批准的角色和作用域边界内轮换已配对设备令牌。 -- `device.token.revoke` 撤销已配对设备令牌。 +- `device.token.revoke` 吊销已配对设备令牌。 -#### Node 配对、调用和待处理工作 +#### 节点配对、调用和待处理工作 -- `node.pair.request`、`node.pair.list`、`node.pair.approve`、 - `node.pair.reject` 和 `node.pair.verify` 涵盖 node 配对和引导验证。 -- `node.list` 和 `node.describe` 返回已知/已连接的 node 状态。 -- `node.rename` 更新已配对 node 标签。 -- `node.invoke` 将命令转发给已连接 node。 -- `node.invoke.result` 返回某次 invoke 请求的结果。 -- `node.event` 将 node 发起的事件携带回 Gateway 网关。 -- `node.canvas.capability.refresh` 刷新有作用域限制的 canvas 能力令牌。 -- `node.pending.pull` 和 `node.pending.ack` 是已连接 node 的队列 API。 -- `node.pending.enqueue` 和 `node.pending.drain` 管理离线/断开连接 node 的持久待处理工作。 +- `node.pair.request`、`node.pair.list`、`node.pair.approve`、`node.pair.reject` 和 `node.pair.verify` 涵盖节点配对和 bootstrap 验证。 +- `node.list` 和 `node.describe` 返回已知/已连接的节点状态。 +- `node.rename` 更新已配对节点标签。 +- `node.invoke` 将命令转发到已连接节点。 +- `node.invoke.result` 返回 invoke 请求的结果。 +- `node.event` 将源自节点的事件回传到 Gateway 网关。 +- `node.canvas.capability.refresh` 刷新带作用域的 canvas 能力令牌。 +- `node.pending.pull` 和 `node.pending.ack` 是已连接节点队列 API。 +- `node.pending.enqueue` 和 `node.pending.drain` 管理离线/断开连接节点的持久待处理工作。 -#### 审批方法族 +#### 批准方法族 -- `exec.approval.request`、`exec.approval.get`、`exec.approval.list` 和 - `exec.approval.resolve` 涵盖一次性 exec 审批请求，以及待处理审批的查找/重放。 -- `exec.approval.waitDecision` 等待一个待处理 exec 审批并返回最终决定（或在超时时返回 `null`）。 -- `exec.approvals.get` 和 `exec.approvals.set` 管理 Gateway 网关 exec 审批策略快照。 -- `exec.approvals.node.get` 和 `exec.approvals.node.set` 通过 node relay 命令管理 node 本地 exec 审批策略。 -- `plugin.approval.request`、`plugin.approval.list`、 - `plugin.approval.waitDecision` 和 `plugin.approval.resolve` 涵盖插件定义的审批流程。 +- `exec.approval.request`、`exec.approval.get`、`exec.approval.list` 和 `exec.approval.resolve` 涵盖一次性 exec 批准请求，以及待处理批准的查找/重放。 +- `exec.approval.waitDecision` 等待一个待处理 exec 批准，并返回最终决定（或在超时时返回 `null`）。 +- `exec.approvals.get` 和 `exec.approvals.set` 管理 Gateway 网关 exec 批准策略快照。 +- `exec.approvals.node.get` 和 `exec.approvals.node.set` 通过节点中继命令管理节点本地 exec 批准策略。 +- `plugin.approval.request`、`plugin.approval.list`、`plugin.approval.waitDecision` 和 `plugin.approval.resolve` 涵盖插件定义的批准流程。 #### 其他主要方法族 -- 自动化： - - `wake` 调度立即或下一次 heartbeat 的唤醒文本注入 - - `cron.list`、`cron.status`、`cron.add`、`cron.update`、`cron.remove`、 - `cron.run`、`cron.runs` -- Skills/工具：`commands.list`、`skills.*`、`tools.catalog`、`tools.effective` +- automation： + - `wake` 安排立即或在下一个 heartbeat 时注入唤醒文本 + - `cron.list`、`cron.status`、`cron.add`、`cron.update`、`cron.remove`、`cron.run`、`cron.runs` +- skills/tools：`commands.list`、`skills.*`、`tools.catalog`、`tools.effective` ### 常见事件族 - `chat`：UI 聊天更新，例如 `chat.inject` 和其他仅 transcript 的聊天事件。 - `session.message` 和 `session.tool`：已订阅会话的 transcript/事件流更新。 -- `sessions.changed`：会话索引或元数据已更改。 +- `sessions.changed`：会话索引或元数据已变更。 - `presence`：系统在线状态快照更新。 - `tick`：周期性 keepalive / 存活事件。 - `health`：Gateway 网关健康快照更新。 - `heartbeat`：heartbeat 事件流更新。 - `cron`：cron 运行/任务变更事件。 - `shutdown`：Gateway 网关关闭通知。 -- `node.pair.requested` / `node.pair.resolved`：node 配对生命周期。 -- `node.invoke.request`：node invoke 请求广播。 +- `node.pair.requested` / `node.pair.resolved`：节点配对生命周期。 +- `node.invoke.request`：节点 invoke 请求广播。 - `device.pair.requested` / `device.pair.resolved`：已配对设备生命周期。 -- `voicewake.changed`：唤醒词触发器配置已更改。 -- `exec.approval.requested` / `exec.approval.resolved`：exec 审批生命周期。 -- `plugin.approval.requested` / `plugin.approval.resolved`：插件审批生命周期。 +- `voicewake.changed`：唤醒词触发器配置已变更。 +- `exec.approval.requested` / `exec.approval.resolved`：exec 批准生命周期。 +- `plugin.approval.requested` / `plugin.approval.resolved`：插件批准生命周期。 -### Node 辅助方法 +### 节点辅助方法 -- Nodes 可以调用 `skills.bins` 来获取当前 Skills 可执行文件列表，用于自动允许检查。 +- 节点可以调用 `skills.bins` 以获取当前 Skills 可执行文件列表，用于自动允许检查。 ### Operator 辅助方法 -- Operators 可以调用 `commands.list`（`operator.read`）来获取某个智能体的运行时命令清单。 - - `agentId` 是可选的；省略它可读取默认智能体工作区。 - - `scope` 控制主 `name` 针对哪个接口： +- Operator 可以调用 `commands.list`（`operator.read`）以获取某个智能体的运行时命令清单。 + - `agentId` 是可选的；省略它即可读取默认智能体工作区。 + - `scope` 控制主 `name` 所指向的表面： - `text` 返回不带前导 `/` 的主文本命令令牌 - - `native` 和默认的 `both` 路径会在可用时返回提供商感知的原生命令名称 + - `native` 和默认的 `both` 路径会在可用时返回具备提供商感知能力的原生命名 - `textAliases` 携带精确的斜杠别名，例如 `/model` 和 `/m`。 - - `nativeName` 在存在时携带提供商感知的原生命令名称。 - - `provider` 是可选的，仅影响原生命名以及原生插件命令可用性。 + - `nativeName` 在存在时携带具备提供商感知能力的原生命令名。 + - `provider` 是可选的，仅影响原生命名以及原生插件命令的可用性。 - `includeArgs=false` 会从响应中省略序列化参数元数据。 -- Operators 可以调用 `tools.catalog`（`operator.read`）来获取某个智能体的运行时工具目录。响应包含已分组的工具和来源元数据： +- Operator 可以调用 `tools.catalog`（`operator.read`）以获取某个智能体的运行时工具目录。响应包括分组后的工具和来源元数据： - `source`：`core` 或 `plugin` - - 当 `source="plugin"` 时，`pluginId` 为插件归属方 - - `optional`：插件工具是否为可选 -- Operators 可以调用 `tools.effective`（`operator.read`）来获取某个会话的运行时生效工具清单。 - - `sessionKey` 是必填项。 - - Gateway 网关会从服务端会话中派生受信任的运行时上下文，而不是接受调用方提供的 auth 或投递上下文。 - - 响应具有会话作用域，并反映当前活动对话此刻可使用的内容，包括 core、plugin 和渠道工具。 -- Operators 可以调用 `skills.status`（`operator.read`）来获取某个智能体可见的 Skills 清单。 - - `agentId` 是可选的；省略它可读取默认智能体工作区。 - - 响应包含资格、缺失要求、配置检查和已清洗的安装选项，而不会暴露原始 secret 值。 -- Operators 可以调用 `skills.search` 和 `skills.detail`（`operator.read`）来获取 ClawHub 发现元数据。 -- Operators 可以通过两种模式调用 `skills.install`（`operator.admin`）： - - ClawHub 模式：`{ source: "clawhub", slug, version?, force? }` 将某个 skill 文件夹安装到默认智能体工作区的 `skills/` 目录中。 + - `pluginId`：当 `source="plugin"` 时的插件所有者 + - `optional`：某个插件工具是否为可选 +- Operator 可以调用 `tools.effective`（`operator.read`）以获取某个会话的运行时有效工具清单。 + - `sessionKey` 是必需的。 + - Gateway 网关从服务端会话派生受信任的运行时上下文，而不是接受调用方提供的认证或投递上下文。 + - 响应是按会话作用域返回的，并反映当前活动对话此刻可使用的内容，包括核心、插件和渠道工具。 +- Operator 可以调用 `skills.status`（`operator.read`）以获取某个智能体的可见 Skills 清单。 + - `agentId` 是可选的；省略它即可读取默认智能体工作区。 + - 响应包括资格、缺失要求、配置检查以及经过净化的安装选项，而不会暴露原始密钥值。 +- Operator 可以调用 `skills.search` 和 `skills.detail`（`operator.read`）以获取 ClawHub 发现元数据。 +- Operator 可以用两种模式调用 `skills.install`（`operator.admin`）： + - ClawHub 模式：`{ source: "clawhub", slug, version?, force? }` 将 skill 文件夹安装到默认智能体工作区的 `skills/` 目录中。 - Gateway 网关安装器模式：`{ name, installId, dangerouslyForceUnsafeInstall?, timeoutMs? }` 在 Gateway 网关宿主机上运行已声明的 `metadata.openclaw.install` 操作。 -- Operators 可以通过两种模式调用 `skills.update`（`operator.admin`）： - - ClawHub 模式会更新默认智能体工作区中一个被跟踪的 slug，或全部被跟踪的 ClawHub 安装。 - - 配置模式会修补 `skills.entries.` 值，例如 `enabled`、 - `apiKey` 和 `env`。 +- Operator 可以用两种模式调用 `skills.update`（`operator.admin`）： + - ClawHub 模式会更新一个已跟踪的 slug，或默认智能体工作区中所有已跟踪的 ClawHub 安装项。 + - 配置模式会修补 `skills.entries.` 值，例如 `enabled`、`apiKey` 和 `env`。 -## Exec 审批 +## Exec 批准 -- 当某个 exec 请求需要审批时，Gateway 网关会广播 `exec.approval.requested`。 -- Operator 客户端通过调用 `exec.approval.resolve` 来处理（需要 `operator.approvals` 作用域）。 +- 当某个 exec 请求需要批准时，Gateway 网关会广播 `exec.approval.requested`。 +- Operator 客户端通过调用 `exec.approval.resolve` 来完成处理（需要 `operator.approvals` 作用域）。 - 对于 `host=node`，`exec.approval.request` 必须包含 `systemRunPlan`（规范的 `argv`/`cwd`/`rawCommand`/会话元数据）。缺少 `systemRunPlan` 的请求会被拒绝。 -- 审批通过后，转发的 `node.invoke system.run` 调用会复用该规范 `systemRunPlan` 作为权威的 command/cwd/session 上下文。 -- 如果调用方在 prepare 和最终获批的 `system.run` 转发之间篡改了 `command`、`rawCommand`、`cwd`、`agentId` 或 `sessionKey`，Gateway 网关会拒绝该运行，而不是信任被篡改的负载。 +- 批准后，转发的 `node.invoke system.run` 调用会复用该规范 `systemRunPlan` 作为权威的命令/cwd/会话上下文。 +- 如果调用方在 prepare 和最终获批的 `system.run` 转发之间修改了 `command`、`rawCommand`、`cwd`、`agentId` 或 `sessionKey`，Gateway 网关会拒绝此次运行，而不是信任被修改后的负载。 -## 智能体投递后备 +## 智能体投递回退 - `agent` 请求可以包含 `deliver=true` 以请求出站投递。 -- `bestEffortDeliver=false` 保持严格行为：未解析或仅内部的投递目标会返回 `INVALID_REQUEST`。 -- `bestEffortDeliver=true` 允许在无法解析出外部可投递路径时回退到仅会话执行（例如内部/webchat 会话或多渠道配置不明确时）。 +- `bestEffortDeliver=false` 保持严格行为：无法解析或仅内部可用的投递目标会返回 `INVALID_REQUEST`。 +- `bestEffortDeliver=true` 允许在无法解析外部可投递路径时回退到仅会话执行（例如内部/webchat 会话或存在歧义的多渠道配置）。 ## 版本控制 - `PROTOCOL_VERSION` 位于 `src/gateway/protocol/schema/protocol-schemas.ts`。 -- 客户端发送 `minProtocol` + `maxProtocol`；服务端会拒绝不匹配情况。 -- Schemas + 模型由 TypeBox 定义生成： +- 客户端发送 `minProtocol` + `maxProtocol`；服务器会拒绝不匹配的情况。 +- Schemas + 模型从 TypeBox 定义生成： - `pnpm protocol:gen` - `pnpm protocol:gen:swift` - `pnpm protocol:check` ### 客户端常量 -`src/gateway/client.ts` 中的参考客户端使用以下默认值。这些值在协议 v3 中保持稳定，是第三方客户端应遵循的预期基线。 +`src/gateway/client.ts` 中的参考客户端使用这些默认值。这些值在协议 v3 中保持稳定，并且是第三方客户端的预期基线。 -| Constant | Default | Source | -| --- | --- | --- | +| 常量 | 默认值 | 来源 | +| ----------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------- | | `PROTOCOL_VERSION` | `3` | `src/gateway/protocol/schema/protocol-schemas.ts` | -| 请求超时（每个 RPC） | `30_000` ms | `src/gateway/client.ts` (`requestTimeoutMs`) | -| 预认证 / connect-challenge 超时 | `10_000` ms | `src/gateway/handshake-timeouts.ts`（限制在 `250`–`10_000`） | -| 初始重连退避 | `1_000` ms | `src/gateway/client.ts` (`backoffMs`) | -| 最大重连退避 | `30_000` ms | `src/gateway/client.ts` (`scheduleReconnect`) | -| 设备令牌关闭后的快速重试限制 | `250` ms | `src/gateway/client.ts` | -| `terminate()` 前的强制停止宽限期 | `250` ms | `FORCE_STOP_TERMINATE_GRACE_MS` | +| 每个 RPC 的请求超时 | `30_000` ms | `src/gateway/client.ts`（`requestTimeoutMs`） | +| 预认证 / 连接挑战超时 | `10_000` ms | `src/gateway/handshake-timeouts.ts`（钳制范围 `250`–`10_000`） | +| 初始重连退避 | `1_000` ms | `src/gateway/client.ts`（`backoffMs`） | +| 最大重连退避 | `30_000` ms | `src/gateway/client.ts`（`scheduleReconnect`） | +| 设备令牌关闭后的快速重试钳制 | `250` ms | `src/gateway/client.ts` | +| 在 `terminate()` 前的强制停止宽限期 | `250` ms | `FORCE_STOP_TERMINATE_GRACE_MS` | | `stopAndWait()` 默认超时 | `1_000` ms | `STOP_AND_WAIT_TIMEOUT_MS` | -| 默认 tick 间隔（`hello-ok` 前） | `30_000` ms | `src/gateway/client.ts` | -| Tick 超时关闭 | 当静默超过 `tickIntervalMs * 2` 时使用代码 `4000` | `src/gateway/client.ts` | +| 默认 tick 间隔（`hello-ok` 之前） | `30_000` ms | `src/gateway/client.ts` | +| tick 超时关闭 | 当静默超过 `tickIntervalMs * 2` 时使用代码 `4000` | `src/gateway/client.ts` | | `MAX_PAYLOAD_BYTES` | `25 * 1024 * 1024`（25 MB） | `src/gateway/server-constants.ts` | -服务端会在 `hello-ok` 中公布生效的 `policy.tickIntervalMs`、`policy.maxPayload` 和 `policy.maxBufferedBytes`；客户端应遵循这些值，而不是握手前的默认值。 +服务器会在 `hello-ok` 中公布生效的 `policy.tickIntervalMs`、`policy.maxPayload` 和 `policy.maxBufferedBytes`；客户端应遵循这些值，而不是握手前的默认值。 ## 认证 -- 共享密钥 Gateway 网关认证使用 `connect.params.auth.token` 或 `connect.params.auth.password`，具体取决于配置的认证模式。 -- 带身份的模式，例如 Tailscale Serve（`gateway.auth.allowTailscale: true`）或非 loopback 的 `gateway.auth.mode: "trusted-proxy"`，会通过请求头而不是 `connect.params.auth.*` 来满足 connect 认证检查。 -- 私有入口的 `gateway.auth.mode: "none"` 会完全跳过共享密钥 connect 认证；不要在公共/不受信任的入口上暴露该模式。 -- 配对完成后，Gateway 网关会签发一个**设备令牌**，其作用域受限于连接角色 + 作用域。它会在 `hello-ok.auth.deviceToken` 中返回，客户端应将其持久化以用于后续连接。 -- 客户端应在任何成功连接后持久化主 `hello-ok.auth.deviceToken`。 -- 使用该**已存储**设备令牌重新连接时，也应复用该令牌已存储的已批准作用域集合。这样可以保留已经授予的读取/探测/状态访问权限，并避免重连时静默收缩为更窄的隐式仅 admin 作用域。 -- 客户端侧 connect 认证组装（`src/gateway/client.ts` 中的 `selectConnectAuth`）： - - `auth.password` 是独立项，只要设置就始终会被转发。 - - `auth.token` 按优先级顺序填充：首先是显式共享令牌，然后是显式 `deviceToken`，最后是按 `deviceId` + `role` 键控的每设备存储令牌。 - - 只有在上述都未解析出 `auth.token` 时，才会发送 `auth.bootstrapToken`。共享令牌或任何已解析的设备令牌都会抑制它。 - - 在一次性 `AUTH_TOKEN_MISMATCH` 重试时，自动提升为已存储设备令牌仅对**受信任端点**开放——loopback，或带固定 `tlsFingerprint` 的 `wss://`。未固定证书的公共 `wss://` 不符合条件。 -- 额外的 `hello-ok.auth.deviceTokens` 条目是引导交接令牌。只有当连接使用了受信任传输（如 `wss://` 或 loopback/本地配对）上的引导认证时，才应持久化它们。 -- 如果客户端提供了**显式** `deviceToken` 或显式 `scopes`，则该调用方请求的作用域集仍然是权威值；只有当客户端正在复用已存储的每设备令牌时，才会复用缓存作用域。 -- 设备令牌可以通过 `device.token.rotate` 和 `device.token.revoke` 轮换/撤销（需要 `operator.pairing` 作用域）。 -- 令牌签发/轮换始终受限于该设备配对条目中记录的已批准角色集合；轮换令牌不能将设备扩展到配对审批从未授予的角色。 -- 对于已配对设备令牌会话，除非调用方还拥有 `operator.admin`，否则设备管理是自作用域的：非 admin 调用方只能移除/撤销/轮换其**自己的**设备条目。 -- `device.token.rotate` 还会根据调用方当前会话作用域检查所请求的 operator 作用域集。非 admin 调用方不能将令牌轮换为比其当前所持有更宽的 operator 作用域集。 +- 基于共享密钥的 Gateway 网关认证使用 `connect.params.auth.token` 或 `connect.params.auth.password`，具体取决于所配置的认证模式。 +- 带身份的模式，例如 Tailscale Serve（`gateway.auth.allowTailscale: true`）或非 loopback 的 `gateway.auth.mode: "trusted-proxy"`，会从请求头而不是 `connect.params.auth.*` 满足连接认证检查。 +- 私有入口的 `gateway.auth.mode: "none"` 会完全跳过基于共享密钥的连接认证；不要在公共/不受信任的入口上暴露该模式。 +- 配对后，Gateway 网关会签发一个**设备令牌**，其作用域受连接角色 + 作用域限制。它会在 `hello-ok.auth.deviceToken` 中返回，客户端应为未来连接持久化保存它。 +- 客户端应在任意成功连接后持久化主要的 `hello-ok.auth.deviceToken`。 +- 使用该**已存储**设备令牌重连时，也应复用该令牌已存储的已批准作用域集合。这样可以保留此前已授予的读取/探测/状态访问权限，并避免重连时悄悄收缩为更窄的隐式仅 admin 作用域。 +- 客户端侧连接认证组装（`src/gateway/client.ts` 中的 `selectConnectAuth`）： + - `auth.password` 是正交的，只要设置了就始终会被转发。 + - `auth.token` 按优先级顺序填充：首先是显式共享令牌，其次是显式 `deviceToken`，最后是存储的按设备令牌（按 `deviceId` + `role` 键控）。 + - 仅当上述内容均未解析出 `auth.token` 时，才会发送 `auth.bootstrapToken`。共享令牌或任何解析出的设备令牌都会抑制它。 + - 在一次性的 `AUTH_TOKEN_MISMATCH` 重试中，自动提升已存储设备令牌仅对**受信任端点**开放——loopback，或带固定 `tlsFingerprint` 的 `wss://`。未做固定的公共 `wss://` 不符合条件。 +- 附加的 `hello-ok.auth.deviceTokens` 条目是 bootstrap 交接令牌。仅当连接在受信任传输上使用 bootstrap 认证时才持久化它们，例如 `wss://` 或 loopback/local pairing。 +- 如果客户端提供了**显式** `deviceToken` 或显式 `scopes`，则该调用方请求的作用域集保持权威；仅当客户端复用存储的按设备令牌时，才会复用缓存的作用域。 +- 设备令牌可通过 `device.token.rotate` 和 `device.token.revoke` 进行轮换/吊销（需要 `operator.pairing` 作用域）。 +- 令牌签发/轮换始终受限于该设备配对条目中记录的已批准角色集；轮换令牌不能将设备扩展到配对批准从未授予的角色。 +- 对于已配对设备令牌会话，除非调用方还具有 `operator.admin`，否则设备管理仅限于自身作用域：非 admin 调用方只能移除/吊销/轮换其**自己的**设备条目。 +- `device.token.rotate` 还会根据调用方当前会话作用域检查所请求的 operator 作用域集。非 admin 调用方不能将令牌轮换为比其当前持有范围更宽的 operator 作用域集。 - 认证失败会包含 `error.details.code` 以及恢复提示： - `error.details.canRetryWithDeviceToken`（布尔值） - `error.details.recommendedNextStep`（`retry_with_device_token`、`update_auth_configuration`、`update_auth_credentials`、`wait_then_retry`、`review_auth_configuration`） -- 客户端针对 `AUTH_TOKEN_MISMATCH` 的行为： - - 受信任客户端可以使用缓存的每设备令牌尝试一次有界重试。 - - 如果该次重试失败，客户端应停止自动重连循环，并向 operator 显示操作指引。 +- 客户端对 `AUTH_TOKEN_MISMATCH` 的行为： + - 受信任客户端可以尝试使用缓存的按设备令牌进行一次有界重试。 + - 如果该重试失败，客户端应停止自动重连循环并提示 operator 采取操作。 ## 设备身份 + 配对 -- Nodes 应包含稳定的设备身份（`device.id`），该身份由密钥对指纹派生。 -- Gateway 网关按设备 + 角色签发令牌。 -- 新的设备 ID 需要配对审批，除非启用了本地自动审批。 -- 配对自动审批以直接本地 local loopback 连接为中心。 -- OpenClaw 还具有一条狭窄的后端/容器本地自连接路径，用于受信任的共享密钥辅助流程。 -- 同主机 tailnet 或 LAN 连接在配对上仍被视为远程连接，仍需要审批。 -- 所有 WS 客户端都必须在 `connect` 期间包含 `device` 身份（operator + node）。 - Control UI 仅可在以下模式中省略它： +- 节点应包含稳定的设备身份（`device.id`），它来源于密钥对指纹。 +- Gateway 网关会按设备 + 角色签发令牌。 +- 新设备 id 需要配对批准，除非启用了本地自动批准。 +- 配对自动批准主要围绕直接的 local loopback 连接。 +- OpenClaw 还为受信任的共享密钥辅助流程提供了一个狭窄的后端/容器本地自连接路径。 +- 同一主机上的 tailnet 或 LAN 连接在配对上仍被视为远程连接，并且需要批准。 +- 所有 WS 客户端都必须在 `connect` 时包含 `device` 身份（operator + node）。 + 仅在以下模式下，控制 UI 才可以省略它： - `gateway.controlUi.allowInsecureAuth=true`，用于仅 localhost 的不安全 HTTP 兼容性。 - - 成功的 `gateway.auth.mode: "trusted-proxy"` operator Control UI 认证。 - - `gateway.controlUi.dangerouslyDisableDeviceAuth=true`（破窗应急，严重降低安全性）。 -- 所有连接都必须对服务端提供的 `connect.challenge` nonce 进行签名。 + - 成功通过 `gateway.auth.mode: "trusted-proxy"` 的 operator 控制 UI 认证。 + - `gateway.controlUi.dangerouslyDisableDeviceAuth=true`（紧急破窗模式，严重降低安全性）。 +- 所有连接都必须对服务器提供的 `connect.challenge` nonce 进行签名。 ### 设备认证迁移诊断 -对于仍使用挑战前签名行为的旧版客户端，`connect` 现在会在 `error.details.code` 下返回 `DEVICE_AUTH_*` 详细代码，并带有稳定的 `error.details.reason`。 +对于仍使用挑战前签名行为的旧版客户端，`connect` 现在会在 `error.details.code` 下返回 `DEVICE_AUTH_*` 详情代码，并带有稳定的 `error.details.reason`。 常见迁移失败： -| Message | details.code | details.reason | 含义 | -| --- | --- | --- | --- | +| 消息 | details.code | details.reason | 含义 | +| --------------------------- | -------------------------------- | ------------------------ | -------------------------------------------------- | | `device nonce required` | `DEVICE_AUTH_NONCE_REQUIRED` | `device-nonce-missing` | 客户端省略了 `device.nonce`（或发送了空值）。 | -| `device nonce mismatch` | `DEVICE_AUTH_NONCE_MISMATCH` | `device-nonce-mismatch` | 客户端使用过期/错误的 nonce 进行了签名。 | +| `device nonce mismatch` | `DEVICE_AUTH_NONCE_MISMATCH` | `device-nonce-mismatch` | 客户端使用了过期/错误的 nonce 进行签名。 | | `device signature invalid` | `DEVICE_AUTH_SIGNATURE_INVALID` | `device-signature` | 签名负载与 v2 负载不匹配。 | -| `device signature expired` | `DEVICE_AUTH_SIGNATURE_EXPIRED` | `device-signature-stale` | 签名时间戳超出了允许的时钟偏差范围。 | +| `device signature expired` | `DEVICE_AUTH_SIGNATURE_EXPIRED` | `device-signature-stale` | 已签名时间戳超出允许的时钟偏移。 | | `device identity mismatch` | `DEVICE_AUTH_DEVICE_ID_MISMATCH` | `device-id-mismatch` | `device.id` 与公钥指纹不匹配。 | | `device public key invalid` | `DEVICE_AUTH_PUBLIC_KEY_INVALID` | `device-public-key` | 公钥格式/规范化失败。 | 迁移目标： - 始终等待 `connect.challenge`。 -- 对包含服务端 nonce 的 v2 负载进行签名。 +- 对包含服务器 nonce 的 v2 负载进行签名。 - 在 `connect.params.device.nonce` 中发送相同的 nonce。 - 首选签名负载是 `v3`，它除了 device/client/role/scopes/token/nonce 字段外，还绑定了 `platform` 和 `deviceFamily`。 -- 为了兼容性，旧版 `v2` 签名仍然被接受，但已配对设备的元数据固定仍会在重连时控制命令策略。 +- 为了兼容性，旧版 `v2` 签名仍然可被接受，但已配对设备的元数据固定仍会在重连时控制命令策略。 ## TLS + 固定 @@ -542,4 +535,4 @@ Gateway 网关将这些视为**声明**，并在服务端强制执行允许列 ## 范围 -该协议公开了**完整的 Gateway 网关 API**（status、channels、models、chat、agent、sessions、nodes、approvals 等）。确切接口由 `src/gateway/protocol/schema.ts` 中的 TypeBox schemas 定义。 +此协议公开了**完整的 Gateway 网关 API**（状态、渠道、模型、聊天、智能体、会话、节点、批准等）。确切表面由 `src/gateway/protocol/schema.ts` 中的 TypeBox schema 定义。 diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index a7f31cc0b..34d19f2d7 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,105 +1,105 @@ --- read_when: - 在本地或 CI 中运行测试 - - 为模型 / 提供商缺陷添加回归测试 + - 为模型/提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：单元 / e2e / live 测试套件、Docker 运行器，以及每项测试覆盖的内容 +summary: 测试套件：unit/e2e/live 测试套件、Docker 运行器，以及每项测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-22T23:49:31Z" + generated_at: "2026-04-23T00:48:55Z" model: gpt-5.4 provider: openai - source_hash: 7d1392e0a46c5d142d65852e9d05179cce6bb1cd93df2fb372fdf13de6681a8a + source_hash: 5e77b1e4eb5e750f732655c9dc4047b1cc07b4057e75a4cde042bf26410ce927 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、live）以及一小组 Docker 运行器。 +OpenClaw 有三个 Vitest 测试套件（unit/integration、e2e、live）以及一小组 Docker 运行器。 本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么内容（以及它刻意 _不_ 覆盖什么） +- 每个测试套件覆盖什么（以及它刻意 _不_ 覆盖什么） - 常见工作流应运行哪些命令（本地、推送前、调试） -- live 测试如何发现凭证并选择模型 / 提供商 -- 如何为真实世界中的模型 / 提供商问题添加回归测试 +- live 测试如何发现凭证并选择模型/提供商 +- 如何为真实世界中的模型/提供商问题添加回归测试 ## 快速开始 大多数时候： - 完整门禁（预期在推送前执行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` -- 在配置充足的机器上更快地运行本地完整测试套件：`pnpm test:max` +- 在配置较宽裕的机器上更快地运行本地全套测试：`pnpm test:max` - 直接使用 Vitest 观察循环：`pnpm test:watch` -- 现在直接按文件定位也支持扩展 / 渠道路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` -- 当你在处理单个失败问题时，优先先运行有针对性的测试。 +- 现在直接按文件定位也会路由到 extension/channel 路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` +- 当你在迭代单个失败用例时，优先使用定向运行。 - 基于 Docker 的 QA 站点：`pnpm qa:lab:up` -- 基于 Linux VM 的 QA 测试通道：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` +- 基于 Linux VM 的 QA 通道：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` -当你修改了测试或想获得额外信心时： +当你修改测试或想获得更多信心时： - 覆盖率门禁：`pnpm test:coverage` - E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商 / 模型时（需要真实凭证）： +当你调试真实提供商/模型时（需要真实凭证）： -- Live 测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` -- 安静地只运行一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -- Moonshot / Kimi 成本冒烟测试：设置 `MOONSHOT_API_KEY` 后，运行 +- Live 测试套件（模型 + Gateway 网关工具/图像探测）：`pnpm test:live` +- 安静地只跑一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` +- Moonshot/Kimi 成本冒烟测试：设置 `MOONSHOT_API_KEY` 后，运行 `openclaw models list --provider moonshot --json`，然后针对 `moonshot/kimi-k2.6` - 运行一个隔离的 + 运行隔离命令 `openclaw agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json` - 。验证 JSON 报告的是 Moonshot / K2.6，并且助手转录存储了已标准化的 `usage.cost`。 + 。验证 JSON 报告了 Moonshot/K2.6，并且助手转录中存储了规范化的 `usage.cost`。 -提示：当你只需要一个失败用例时，优先通过下面描述的 allowlist 环境变量来缩小 live 测试范围。 +提示：当你只需要一个失败用例时，优先使用下文描述的 allowlist 环境变量来缩小 live 测试范围。 ## QA 专用运行器 -当你需要更接近 qa-lab 真实环境的测试时，这些命令与主测试套件并列存在： +当你需要更贴近真实环境的 qa-lab 时，这些命令与主测试套件并列使用： - `pnpm openclaw qa suite` - 直接在宿主机上运行基于仓库的 QA 场景。 - - 默认会使用隔离的 Gateway 网关工作进程并行运行多个所选场景。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整工作进程数量，或使用 `--concurrency 1` 回到旧的串行通道。 - - 任何场景失败时以非零状态退出。如果你想保留产物但不让退出码失败，请使用 `--allow-failures`。 + - 默认会并行运行多个选中的场景，并使用隔离的 Gateway 网关 worker。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整 worker 数量，或使用 `--concurrency 1` 回退到旧的串行通道。 + - 任一场景失败时以非零状态退出。当你想保留产物但不希望退出码失败时，使用 `--allow-failures`。 - 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。 - `aimock` 会启动一个本地的 AIMock 支持的提供商服务器，用于实验性的夹具和协议 mock 覆盖，但不会替代具备场景感知能力的 `mock-openai` 通道。 + `aimock` 会启动一个基于本地 AIMock 的提供商服务器，用于实验性的 fixture 和协议 mock 覆盖，但不会替代具备场景感知能力的 `mock-openai` 通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一个一次性的 Multipass Linux VM 内运行同一套 QA 测试。 + - 在一次性的 Multipass Linux VM 中运行同一套 QA 测试套件。 - 保持与宿主机上 `qa suite` 相同的场景选择行为。 - - 复用与 `qa suite` 相同的提供商 / 模型选择参数。 - - live 运行会转发来宾系统可实际使用的受支持 QA 认证输入： - 基于环境变量的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保持在仓库根目录下，以便来宾可通过挂载的工作区写回。 - - 会在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要，以及 Multipass 日志。 + - 复用与 `qa suite` 相同的提供商/模型选择标志。 + - Live 运行会转发来宾机可实际使用的受支持 QA 认证输入： + 基于 env 的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 + - 输出目录必须保留在仓库根目录下，以便来宾机通过挂载的工作区回写。 + - 在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要以及 Multipass 日志。 - `pnpm qa:lab:up` - - 启动基于 Docker 的 QA 站点，用于偏操作员风格的 QA 工作。 + - 启动基于 Docker 的 QA 站点，供偏操作员风格的 QA 工作使用。 - `pnpm test:docker:bundled-channel-deps` - - 在 Docker 中打包并安装当前的 OpenClaw 构建，使用已配置的 OpenAI 启动 Gateway 网关，然后通过配置编辑启用 Telegram 和 Discord。 - - 验证第一次重启 Gateway 网关时，会按需为每个内置渠道插件安装运行时依赖；第二次重启不会重复安装已激活的依赖。 + - 在 Docker 中打包并安装当前 OpenClaw 构建，使用已配置的 OpenAI 启动 Gateway 网关，然后通过配置编辑启用 Telegram 和 Discord。 + - 验证第一次重启 Gateway 网关时会按需安装每个内置渠道插件的运行时依赖，并且第二次重启不会重新安装已激活的依赖。 - 还会安装一个已知较旧的 npm 基线，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 能修复内置渠道运行时依赖，而无需测试框架侧的 postinstall 修复。 - `pnpm openclaw qa aimock` - 仅启动本地 AIMock 提供商服务器，用于直接协议冒烟测试。 - `pnpm openclaw qa matrix` - 针对一次性的、基于 Docker 的 Tuwunel homeserver 运行 Matrix live QA 通道。 - - 这个 QA 宿主当前仅供仓库 / 开发使用。已打包的 OpenClaw 安装不会附带 `qa-lab`，因此也不会暴露 `openclaw qa`。 - - 仓库检出会直接加载内置运行器；不需要单独安装插件。 - - 会预配三个临时 Matrix 用户（`driver`、`sut`、`observer`）以及一个私有房间，然后以真实 Matrix 插件作为 SUT 传输层启动一个 QA Gateway 网关子进程。 - - 默认使用固定的稳定 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。如需测试其他镜像，可用 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 - - Matrix 不暴露共享凭证来源标志，因为该通道会在本地预配一次性用户。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Matrix QA 报告、摘要、observed-events 产物，以及合并后的 stdout / stderr 输出日志。 + - 该 QA 宿主目前仅供仓库/开发使用。打包后的 OpenClaw 安装不包含 `qa-lab`，因此不会暴露 `openclaw qa`。 + - 仓库检出会直接加载内置运行器，无需单独安装插件。 + - 创建三个临时 Matrix 用户（`driver`、`sut`、`observer`）和一个私有房间，然后以真实 Matrix 插件作为 SUT 传输层启动一个 QA gateway 子进程。 + - 默认使用固定稳定版 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。当你需要测试其他镜像时，使用 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 + - Matrix 不暴露共享的凭证来源标志，因为该通道会在本地创建一次性用户。 + - 在 `.artifacts/qa-e2e/...` 下写入 Matrix QA 报告、摘要、observed-events 产物以及合并的 stdout/stderr 输出日志。 - `pnpm openclaw qa telegram` - - 使用环境变量中的 driver 和 SUT bot token，针对真实私有群组运行 Telegram live QA 通道。 - - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。群组 id 必须是 Telegram chat 的数字 id。 - - 支持 `--credential-source convex` 用于共享的池化凭证。默认使用 env 模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 - - 任何场景失败时以非零状态退出。如果你想保留产物但不让退出码失败，请使用 `--allow-failures`。 - - 需要同一私有群组中的两个不同 bot，并且 SUT bot 需要公开一个 Telegram 用户名。 - - 为了稳定地观察 bot 与 bot 之间的交互，请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode，并确保 driver bot 可以观察群组中的 bot 流量。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 产物。 + - 使用 env 中的 driver 和 SUT bot token，针对真实私有群组运行 Telegram live QA 通道。 + - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。group id 必须是 Telegram chat 的数字 id。 + - 支持 `--credential-source convex` 以使用共享池化凭证。默认使用 env 模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 + - 任一场景失败时以非零状态退出。当你想保留产物但不希望退出码失败时，使用 `--allow-failures`。 + - 需要同一个私有群组中的两个不同 bot，并且 SUT bot 必须暴露 Telegram 用户名。 + - 为了稳定地观察 bot 到 bot 通信，请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode，并确保 driver bot 能观察到群组内 bot 流量。 + - 在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 产物。 -Live 传输通道共享一个标准契约，以避免新传输方式发生漂移： +Live 传输通道共享一份标准契约，因此新传输方式不会发生漂移： -`qa-channel` 仍然是覆盖面广的合成 QA 测试套件，不属于 live +`qa-channel` 仍然是范围广泛的合成 QA 测试套件，不属于 live 传输覆盖矩阵的一部分。 | 通道 | Canary | Mention gating | Allowlist block | Top-level reply | Restart resume | Thread follow-up | Thread isolation | Reaction observation | Help command | @@ -109,7 +109,8 @@ Live 传输通道共享一个标准契约，以避免新传输方式发生漂移 ### 通过 Convex 共享 Telegram 凭证（v1） -当为 `openclaw qa telegram` 启用 `--credential-source convex`（或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`）时，QA lab 会从基于 Convex 的池中获取独占租约，在该通道运行期间对租约发送心跳，并在关闭时释放租约。 +当为 `openclaw qa telegram` 启用 `--credential-source convex`（或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`）时， +QA lab 会从基于 Convex 的池中获取一个独占租约，在通道运行期间为该租约发送心跳，并在关闭时释放租约。 参考 Convex 项目脚手架： @@ -118,12 +119,12 @@ Live 传输通道共享一个标准契约，以避免新传输方式发生漂移 必需的环境变量： - `OPENCLAW_QA_CONVEX_SITE_URL`（例如 `https://your-deployment.convex.site`） -- 为所选角色提供一个密钥： - - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`，用于 `maintainer` - - `OPENCLAW_QA_CONVEX_SECRET_CI`，用于 `ci` +- 为所选角色提供一个 secret： + - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` 对应 `maintainer` + - `OPENCLAW_QA_CONVEX_SECRET_CI` 对应 `ci` - 凭证角色选择： - CLI：`--credential-role maintainer|ci` - - 默认环境变量：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认是 `ci`，否则为 `maintainer`） + - env 默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认为 `ci`，否则默认为 `maintainer`） 可选环境变量： @@ -132,15 +133,15 @@ Live 传输通道共享一个标准契约，以避免新传输方式发生漂移 - `OPENCLAW_QA_CREDENTIAL_ACQUIRE_TIMEOUT_MS`（默认 `90000`） - `OPENCLAW_QA_CREDENTIAL_HTTP_TIMEOUT_MS`（默认 `15000`） - `OPENCLAW_QA_CONVEX_ENDPOINT_PREFIX`（默认 `/qa-credentials/v1`） -- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`（可选跟踪 id） +- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`（可选追踪 id） - `OPENCLAW_QA_ALLOW_INSECURE_HTTP=1` 允许在仅限本地开发时使用 loopback `http://` Convex URL。 -`OPENCLAW_QA_CONVEX_SITE_URL` 在正常运行中应使用 `https://`。 +正常运行时，`OPENCLAW_QA_CONVEX_SITE_URL` 应使用 `https://`。 -维护者管理命令（池添加 / 移除 / 列表）必须明确使用 +维护者管理命令（池添加/删除/列出）必须明确使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 -供维护者使用的 CLI 辅助命令： +面向维护者的 CLI 辅助命令： ```bash pnpm openclaw qa credentials add --kind telegram --payload-file qa/telegram-credential.json @@ -155,44 +156,44 @@ pnpm openclaw qa credentials remove --credential-id - `POST /acquire` - 请求：`{ kind, ownerId, actorRole, leaseTtlMs, heartbeatIntervalMs }` - 成功：`{ status: "ok", credentialId, leaseToken, payload, leaseTtlMs?, heartbeatIntervalMs? }` - - 资源耗尽 / 可重试：`{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }` + - 资源耗尽/可重试：`{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }` - `POST /heartbeat` - 请求：`{ kind, ownerId, actorRole, credentialId, leaseToken, leaseTtlMs }` - 成功：`{ status: "ok" }`（或空的 `2xx`） - `POST /release` - 请求：`{ kind, ownerId, actorRole, credentialId, leaseToken }` - 成功：`{ status: "ok" }`（或空的 `2xx`） -- `POST /admin/add`（仅限 maintainer 密钥） +- `POST /admin/add`（仅维护者 secret） - 请求：`{ kind, actorId, payload, note?, status? }` - 成功：`{ status: "ok", credential }` -- `POST /admin/remove`（仅限 maintainer 密钥） +- `POST /admin/remove`（仅维护者 secret） - 请求：`{ credentialId, actorId }` - 成功：`{ status: "ok", changed, credential }` - 活跃租约保护：`{ status: "error", code: "LEASE_ACTIVE", ... }` -- `POST /admin/list`（仅限 maintainer 密钥） +- `POST /admin/list`（仅维护者 secret） - 请求：`{ kind?, status?, includePayload?, limit? }` - 成功：`{ status: "ok", credentials, count }` -Telegram 类型的负载结构： +Telegram 类型的 payload 结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是 Telegram chat 数字 id 字符串。 -- `admin/add` 会为 `kind: "telegram"` 验证该结构，并拒绝格式错误的负载。 +- `groupId` 必须是 Telegram chat 的数字 id 字符串。 +- 对于 `kind: "telegram"`，`admin/add` 会验证该结构并拒绝格式错误的 payload。 ### 向 QA 添加一个渠道 -向 Markdown QA 系统中添加一个渠道，必须且只需要两样东西： +将一个渠道添加到 Markdown QA 系统中，严格只需要两样东西： 1. 该渠道的传输适配器。 -2. 一组用于验证渠道契约的场景包。 +2. 一个用于验证渠道契约的场景包。 -如果共享的 `qa-lab` 宿主可以负责这条流程，就不要新增顶层 QA 命令根。 +当共享 `qa-lab` 宿主能够承载流程时，不要新增顶层 QA 命令根。 `qa-lab` 负责共享宿主机制： - `openclaw qa` 命令根 -- 测试套件启动和清理 -- 工作进程并发 +- 测试套件启动与关闭 +- worker 并发 - 产物写入 - 报告生成 - 场景执行 @@ -200,35 +201,35 @@ Telegram 类型的负载结构： 运行器插件负责传输契约： -- `openclaw qa ` 如何挂载在共享的 `qa` 根命令之下 +- `openclaw qa ` 如何挂载到共享 `qa` 根之下 - 如何为该传输方式配置 Gateway 网关 - 如何检查就绪状态 - 如何注入入站事件 - 如何观察出站消息 -- 如何暴露转录和标准化后的传输状态 -- 如何执行基于传输的操作 +- 如何暴露转录和规范化后的传输状态 +- 如何执行由传输支持的操作 - 如何处理传输特定的重置或清理 新渠道的最低接入门槛是： -1. 保持由 `qa-lab` 负责共享的 `qa` 根命令。 +1. 保持由 `qa-lab` 负责共享的 `qa` 根。 2. 在共享的 `qa-lab` 宿主接缝上实现传输运行器。 -3. 将传输特定机制保留在运行器插件或渠道测试框架内部。 +3. 将传输特定的机制保留在运行器插件或渠道测试框架内部。 4. 将运行器挂载为 `openclaw qa `，而不是注册一个相互竞争的根命令。 运行器插件应在 `openclaw.plugin.json` 中声明 `qaRunners`，并从 `runtime-api.ts` 导出匹配的 `qaRunnerCliRegistrations` 数组。 - 保持 `runtime-api.ts` 足够轻量；延迟 CLI 和运行器执行应放在单独的入口点之后。 -5. 在带主题的 `qa/scenarios/` 目录下编写或改造 Markdown 场景。 + 保持 `runtime-api.ts` 足够轻量；延迟 CLI 和运行器执行应保留在独立入口点之后。 +5. 在按主题划分的 `qa/scenarios/` 目录下编写或改造 Markdown 场景。 6. 为新场景使用通用场景辅助函数。 -7. 除非仓库正在进行有意的迁移，否则保持现有兼容别名继续可用。 +7. 除非仓库正在进行有意迁移，否则应保持现有兼容别名继续可用。 决策规则是严格的： -- 如果某个行为能在 `qa-lab` 中统一表达一次，就放到 `qa-lab` 中。 -- 如果某个行为依赖于单一渠道传输方式，就把它保留在该运行器插件或插件测试框架中。 -- 如果某个场景需要一个以上渠道都可使用的新能力，就添加一个通用辅助函数，而不是在 `suite.ts` 中添加渠道特定分支。 -- 如果某个行为只对一种传输方式有意义，就让该场景保持传输特定性，并在场景契约中明确说明。 +- 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放在 `qa-lab` 中。 +- 如果某个行为依赖单一渠道传输，就把它保留在对应的运行器插件或插件测试框架中。 +- 如果某个场景需要多个渠道都能使用的新能力，添加一个通用辅助函数，而不是在 `suite.ts` 中添加渠道特定分支。 +- 如果某个行为只对一种传输有意义，就让该场景保持传输特定，并在场景契约中明确说明。 -新场景推荐使用的通用辅助函数名称为： +新场景推荐使用的通用辅助函数名称是： - `waitForTransportReady` - `waitForChannelReady` @@ -252,83 +253,96 @@ Telegram 类型的负载结构： - `resetBus` 新的渠道工作应使用通用辅助函数名称。 -兼容别名的存在是为了避免一次性迁移，不应作为 -新场景编写的范式。 +保留兼容别名是为了避免一次性强制迁移，而不是作为 +新场景编写的模板。 ## 测试套件（各自运行位置） -可以把这些测试套件理解为“真实度逐步增加”（同时不稳定性 / 成本也增加）： +可以将这些测试套件理解为“真实程度逐步增加”（同时不稳定性/成本也逐步增加）： -### 单元 / 集成（默认） +### Unit / integration（默认） - 命令：`pnpm test` -- 配置：对现有按范围划分的 Vitest 项目运行十个顺序分片（`vitest.full-*.config.ts`） -- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core / 单元测试清单，以及由 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 +- 配置：通过现有的分域 Vitest project，运行十个顺序分片（`vitest.full-*.config.ts`） +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core/unit 清单，以及由 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 - 范围： - 纯单元测试 - - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） - - 针对已知缺陷的确定性回归测试 + - 进程内集成测试（gateway 凭证、路由、工具、解析、配置） + - 已知缺陷的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 -- 项目说明： - - 无目标的 `pnpm test` 现在会运行 11 个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个巨大的原生根项目进程。这样可以在负载较高的机器上降低峰值 RSS，并避免 auto-reply / 扩展工作拖慢无关测试套件。 - - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` 项目图，因为多分片的 watch 循环并不现实。 - - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会先将显式文件 / 目录目标路由到有范围的测试通道，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根项目启动成本。 - - 当变更的 git 路径只涉及可路由的源码 / 测试文件时，`pnpm test:changed` 会将其展开到相同的有范围测试通道；配置 / setup 修改仍会回退到更广泛的根项目重跑。 - - `pnpm check:changed` 是针对小范围工作的常规智能本地门禁。它会将 diff 分类为 core、core 测试、扩展、扩展测试、应用、文档、发布元数据和工具，并运行对应的 typecheck / lint / 测试通道。公开的插件 SDK 和插件契约变更会包含扩展验证，因为扩展依赖这些 core 契约。仅涉及发布元数据的版本变更会运行有针对性的版本 / 配置 / 根依赖检查，而不是完整测试套件，并带有一个保护机制，拒绝顶层版本字段之外的 package 变更。 - - 来自 agents、commands、plugins、auto-reply helpers、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试会通过 `unit-fast` 通道运行，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件则继续保留在现有通道中。 - - 选定的 `plugin-sdk` 和 `commands` 辅助源码文件也会将 changed 模式运行映射到这些轻量通道中的显式同级测试，因此辅助函数修改无需为该目录重跑整个重型测试套件。 - - `auto-reply` 现在有三个专用分桶：顶层 core helpers、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply 测试框架工作不影响便宜的状态 / 分块 / token 测试。 -- 嵌入式运行器说明： - - 当你修改消息工具发现输入或压缩运行时上下文时， - 保持两个层级的覆盖。 - - 为纯路由 / 标准化边界添加有针对性的辅助函数回归测试。 - - 还要保持嵌入式运行器集成测试套件健康： +- Projects 说明： + - 无定向目标的 `pnpm test` 现在会运行 11 个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个巨大的原生 root-project 进程。这能降低高负载机器上的峰值 RSS，并避免 auto-reply/extension 工作拖累无关测试套件。 + - `pnpm test --watch` 仍然使用原生根级 `vitest.config.ts` project 图，因为多分片 watch 循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会先通过分域通道路由显式文件/目录目标，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 无需承担完整 root project 启动成本。 + - 当 diff 只涉及可路由的 source/test 文件时，`pnpm test:changed` 会将变更的 git 路径扩展到相同的分域通道；配置/初始化编辑仍会回退为重新运行更广的 root-project。 + - `pnpm check:changed` 是狭窄范围工作时的常规智能本地门禁。它会将 diff 分类为 core、core tests、extensions、extension tests、apps、docs、release metadata 和 tooling，然后运行对应的类型检查/lint/测试通道。公开的插件 SDK 和插件契约变更会包含 extension 验证，因为 extensions 依赖这些 core 契约。仅涉及发布元数据的版本升级会运行定向的版本/配置/根依赖检查，而不是完整测试套件，并带有一个保护机制，用于拒绝顶层版本字段之外的 package 变更。 + - 来自 agents、commands、plugins、auto-reply 辅助函数、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试会路由到 `unit-fast` 通道，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态/运行时较重的文件仍保留在现有通道中。 + - 某些 `plugin-sdk` 和 `commands` 辅助源文件在 changed 模式运行中也会映射到这些轻量通道中的显式同级测试，因此辅助函数编辑无需为该目录重新运行完整的重型测试套件。 + - `auto-reply` 现在有三个专用分桶：顶层 core 辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply 测试框架工作不影响廉价的 status/chunk/token 测试。 +- Embedded runner 说明： + - 当你更改消息工具发现输入或压缩运行时上下文时， + 需要同时保留两个层级的覆盖。 + - 为纯路由/规范化边界添加聚焦的辅助函数回归测试。 + - 同时保持 embedded runner 集成测试套件健康： `src/agents/pi-embedded-runner/compact.hooks.test.ts`、 `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 和 `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`。 - - 这些测试套件验证带作用域的 id 和压缩行为仍然会流经真实的 - `run.ts` / `compact.ts` 路径；仅有辅助函数测试 + - 这些测试套件会验证作用域 id 和压缩行为仍然会流经真实的 `run.ts` / `compact.ts` 路径；仅有辅助函数测试 不能充分替代这些集成路径。 -- 池说明： +- Pool 说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置还固定设置了 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 - - 根 UI 通道保留其 `jsdom` setup 和优化器，但现在也运行在共享的非隔离运行器上。 + - 共享 Vitest 配置还固定了 `isolate: false`，并在根 projects、e2e 和 live 配置中使用非隔离运行器。 + - 根级 UI 通道保留其 `jsdom` 设置和优化器，但现在也运行在共享的非隔离运行器上。 - 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 - - 共享的 `scripts/run-vitest.mjs` 启动器现在默认还会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原生 V8 行为进行比较，可设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 -- 快速本地迭代说明： - - `pnpm changed:lanes` 会显示某个 diff 会触发哪些架构通道。 - - pre-commit hook 会在暂存格式化 / lint 之后运行 `pnpm check:changed --staged`，因此仅 core 的提交不会承担扩展测试成本，除非它们触及面向扩展的公开契约。仅发布元数据的提交会保持在有针对性的版本 / 配置 / 根依赖通道上。 - - 当变更路径能够清晰映射到较小测试套件时，`pnpm test:changed` 会通过有范围的测试通道运行。 + - 共享的 `scripts/run-vitest.mjs` 启动器现在默认还会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原生 V8 行为比较，设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 +- Fast-local iteration 说明： + - `pnpm changed:lanes` 会显示某个 diff 触发了哪些架构通道。 + - pre-commit hook 会在已暂存格式化/lint 之后运行 `pnpm check:changed --staged`，因此仅 core 的提交无需承担 extension 测试成本，除非它们触及面向 extension 的公开契约。仅涉及发布元数据的提交会保留在定向的版本/配置/根依赖通道上。 + - 当变更路径可以清晰映射到更小的测试套件时，`pnpm test:changed` 会通过分域通道进行路由。 - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是使用更高的 worker 上限。 - - 本地 worker 自动扩缩现在有意更保守，并且在宿主机平均负载已经很高时也会回退，因此多个并发 Vitest 运行默认造成的影响更小。 - - 基础 Vitest 配置将项目 / 配置文件标记为 `forceRerunTriggers`，因此当测试接线发生变化时，changed 模式重跑仍然正确。 - - 配置会在受支持的宿主机上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你想为直接性能分析指定一个明确的缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 -- 性能调试说明： - - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及导入明细输出。 - - `pnpm test:perf:imports:changed` 会将相同的分析视图限定到自 `origin/main` 以来发生变更的文件。 -- `pnpm test:perf:changed:bench -- --ref ` 会针对该已提交 diff，将已路由的 `test:changed` 与原生根项目路径进行比较，并输出总耗时以及 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会对当前脏工作树进行基准测试，通过 `scripts/test-projects.mjs` 和根 Vitest 配置来路由变更文件列表。 - - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动和 transform 开销写入主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为单元测试套件写入运行器 CPU + heap profile。 + - 现在本地 worker 自动扩缩容有意更保守，并且在宿主负载平均值已经很高时也会回退，因此默认情况下多个并发 Vitest 运行对系统的影响更小。 + - 基础 Vitest 配置会将 projects/config 文件标记为 `forceRerunTriggers`，以便在测试接线发生变化时，changed 模式重新运行仍然正确。 + - 配置会在受支持的宿主上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你希望为直接性能分析指定一个明确缓存位置，请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 +- Perf-debug 说明： + - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及导入拆解输出。 + - `pnpm test:perf:imports:changed` 会将同样的性能分析视图限定到自 `origin/main` 以来发生变更的文件。 +- `pnpm test:perf:changed:bench -- --ref ` 会针对该已提交 diff，将经过路由的 `test:changed` 与原生 root-project 路径进行比较，并输出总耗时以及 macOS 最大 RSS。 +- `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和根 Vitest 配置对当前脏工作树进行基准测试，把变更文件列表路由进去。 + - `pnpm test:perf:profile:main` 会为 Vitest/Vite 启动和 transform 开销写出主线程 CPU profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件级并行时，为 unit 测试套件写出 runner CPU+heap profile。 -### E2E（Gateway 网关冒烟） +### 稳定性（gateway） + +- 命令：`pnpm test:stability:gateway` +- 配置：`vitest.gateway.config.ts`，强制单 worker +- 范围： + - 启动一个真实的 loopback Gateway 网关，并默认启用诊断 + - 通过诊断事件路径驱动合成的 gateway 消息、memory 和大负载 churn + - 通过 Gateway 网关 WS RPC 查询 `diagnostics.stability` + - 覆盖诊断稳定性 bundle 持久化辅助函数 + - 断言 recorder 保持有界、合成 RSS 采样保持在压力预算之下，并且每个会话的队列深度会回落到零 +- 预期： + - 对 CI 安全且无需密钥 + - 用于跟进稳定性回归的狭窄通道，不可替代完整 Gateway 网关测试套件 + +### E2E（gateway 冒烟） - 命令：`pnpm test:e2e` - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` - 运行时默认值： - - 使用 Vitest `threads` 且设置 `isolate: false`，与仓库其余部分保持一致。 - - 使用自适应 worker（CI：最多 2，本地：默认 1）。 - - 默认以静默模式运行，以减少控制台 I/O 开销。 + - 使用 Vitest `threads` 且 `isolate: false`，与仓库其他部分保持一致。 + - 使用自适应 workers（CI：最多 2 个，本地：默认 1 个）。 + - 默认以 silent 模式运行，以减少控制台 I/O 开销。 - 常用覆盖项： - - `OPENCLAW_E2E_WORKERS=` 用于强制设置 worker 数量（上限为 16）。 - - `OPENCLAW_E2E_VERBOSE=1` 用于重新启用详细控制台输出。 + - `OPENCLAW_E2E_WORKERS=` 强制指定 worker 数量（上限为 16）。 + - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - - 多实例 Gateway 网关端到端行为 - - WebSocket / HTTP 接口、节点配对，以及更重的网络行为 + - 多实例 gateway 端到端行为 + - WebSocket/HTTP 表面、节点配对和更重的网络交互 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 @@ -339,17 +353,17 @@ Telegram 类型的负载结构： - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 + - 通过 Docker 在宿主机上启动一个隔离的 OpenShell gateway - 从一个临时本地 Dockerfile 创建一个沙箱 - - 通过真实的 `sandbox ssh-config` + SSH 执行，测试 OpenClaw 的 OpenShell 后端 - - 通过沙箱文件系统桥接验证远程规范文件系统行为 + - 通过真实的 `sandbox ssh-config` + SSH exec 演练 OpenClaw 的 OpenShell 后端 + - 通过 sandbox fs bridge 验证远端规范文件系统行为 - 预期： - 仅按需启用；不属于默认 `pnpm test:e2e` 运行的一部分 - - 需要本地 `openshell` CLI 和可工作的 Docker daemon - - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，随后销毁测试 Gateway 网关和沙箱 + - 需要本地 `openshell` CLI 和可用的 Docker daemon + - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 gateway 和沙箱 - 常用覆盖项： - - `OPENCLAW_E2E_OPENSHELL=1`：在手动运行更广泛的 e2e 测试套件时启用该测试 - - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`：指向非默认 CLI 二进制或包装脚本 + - `OPENCLAW_E2E_OPENSHELL=1`，在手动运行更广泛的 e2e 测试套件时启用该测试 + - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`，指向非默认的 CLI 二进制或包装脚本 ### Live（真实提供商 + 真实模型） @@ -358,115 +372,115 @@ Telegram 类型的负载结构： - 文件：`src/**/*.live.test.ts` - 默认：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型在 _今天_ 配合真实凭证是否真的能工作？” - - 捕获提供商格式变化、工具调用怪癖、认证问题和速率限制行为 + - “这个提供商/模型在 _今天_ 配合真实凭证时，是否真的可用？” + - 捕获提供商格式变更、工具调用怪癖、认证问题以及速率限制行为 - 预期： - 按设计不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - - 会花钱 / 消耗速率限制 - - 优先运行缩小范围的子集，而不是“全部” -- Live 运行会读取 `~/.profile`，以获取缺失的 API 密钥。 -- 默认情况下，live 运行仍会隔离 `HOME`，并把配置 / 认证材料复制到一个临时测试 home 中，这样单元测试夹具就不会修改你的真实 `~/.openclaw`。 + - 会花钱 / 消耗速率限制额度 + - 优先运行缩小范围后的子集，而不是“全部” +- Live 运行会读取 `~/.profile`，以补齐缺失的 API key。 +- 默认情况下，live 运行仍会隔离 `HOME`，并将配置/认证材料复制到临时测试 home 中，这样 unit fixture 就不会修改你的真实 `~/.openclaw`。 - 仅当你明确需要让 live 测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 -- `pnpm test:live` 现在默认使用更安静的模式：保留 `[live] ...` 进度输出，但会抑制额外的 `~/.profile` 提示，并静默 Gateway 网关启动日志 / Bonjour 噪声。如果你想重新看到完整启动日志，请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 -- API 密钥轮换（提供商特定）：设置 `*_API_KEYS` 为逗号 / 分号格式，或设置 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），或者通过 `OPENCLAW_LIVE_*_KEY` 设置每个 live 测试的覆盖值；测试会在收到速率限制响应时重试。 -- 进度 / 心跳输出： - - Live 测试套件现在会将进度行输出到 stderr，因此即使 Vitest 控制台捕获保持安静，较长时间的提供商调用也会明确显示仍在活动。 - - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，因此在 live 运行期间，提供商 / Gateway 网关进度行会立即流式输出。 - - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型调用的心跳间隔。 - - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探测的心跳间隔。 +- `pnpm test:live` 现在默认使用更安静的模式：会保留 `[live] ...` 进度输出，但会抑制额外的 `~/.profile` 提示，并静默 gateway 启动日志/Bonjour 噪声。如果你想恢复完整启动日志，请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 +- API key 轮换（提供商特定）：设置 `*_API_KEYS`，使用逗号/分号格式，或设置 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），也可以通过 `OPENCLAW_LIVE_*_KEY` 为单次 live 运行覆盖；测试在遇到速率限制响应时会重试。 +- 进度/心跳输出： + - Live 测试套件现在会把进度行输出到 stderr，因此即使 Vitest 控制台捕获保持安静，长时间的提供商调用也能明显显示仍在活动。 + - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，因此提供商/gateway 进度行会在 live 运行期间立即流式输出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直连模型心跳。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 gateway/探测心跳。 ## 我应该运行哪个测试套件？ 使用这个决策表： -- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，再运行 `pnpm test:coverage`） -- 触及 Gateway 网关网络 / WS 协议 / 配对：加跑 `pnpm test:e2e` -- 调试“我的 bot 挂了” / 提供商特定故障 / 工具调用：运行缩小范围的 `pnpm test:live` +- 编辑逻辑/测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） +- 修改 gateway 网络 / WS 协议 / 配对：额外运行 `pnpm test:e2e` +- 调试“我的 bot 挂了”/ 提供商特定故障 / 工具调用：运行一个缩小范围的 `pnpm test:live` ## Live：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前声明的**每一条命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前**公开的每一条命令**，并断言命令契约行为。 - 范围： - - 带前置条件 / 手动 setup（该测试套件不会安装 / 运行 / 配对应用）。 - - 针对所选 Android 节点逐条验证 Gateway 网关 `node.invoke`。 -- 必需的预先 setup： - - Android 应用已连接并已与 Gateway 网关配对。 - - 应用保持在前台。 - - 对你期望通过的能力，已授予权限 / 捕获授权。 + - 预置条件/手动设置（该测试套件不会安装/运行/配对 app）。 + - 针对所选 Android 节点逐命令验证 gateway `node.invoke`。 +- 必需的预先设置： + - Android app 已经连接并配对到 gateway。 + - app 保持在前台。 + - 已为你预期能够通过的能力授予权限/采集同意。 - 可选目标覆盖： - `OPENCLAW_ANDROID_NODE_ID` 或 `OPENCLAW_ANDROID_NODE_NAME`。 - `OPENCLAW_ANDROID_GATEWAY_URL` / `OPENCLAW_ANDROID_GATEWAY_TOKEN` / `OPENCLAW_ANDROID_GATEWAY_PASSWORD`。 -- 完整 Android setup 详情：[Android App](/zh-CN/platforms/android) +- 完整 Android 设置详情：[Android App](/zh-CN/platforms/android) ## Live：模型冒烟（profile keys） -Live 测试分为两层，以便我们隔离故障： +Live 测试分成两层，以便我们隔离故障： -- “直接模型”告诉我们：给定密钥时，提供商 / 模型是否至少可以响应。 -- “Gateway 网关冒烟”告诉我们：该模型的完整 gateway + 智能体链路是否正常工作（会话、历史、工具、沙箱策略等）。 +- “直连模型”告诉我们，提供商/模型是否至少能使用给定 key 做出响应。 +- “Gateway 网关冒烟”告诉我们，完整的 gateway + 智能体流水线是否适用于该模型（会话、历史、工具、沙箱策略等）。 -### 第 1 层：直接模型补全（无 gateway） +### 第 1 层：直连模型补全（无 gateway） - 测试：`src/agents/models.profiles.live.test.ts` - 目标： - 枚举已发现的模型 - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 - - 对每个模型运行一个小型补全（以及在需要时运行定向回归） + - 为每个模型运行一个小型补全（必要时加入定向回归） - 启用方式： - - `pnpm test:live`（或直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） -- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，即 modern 的别名）才会真正运行该测试套件；否则它会跳过，以便让 `pnpm test:live` 聚焦在 Gateway 网关冒烟上 + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） +- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，即 modern 的别名）后才会真正运行这个测试套件；否则它会跳过，以便让 `pnpm test:live` 聚焦于 gateway 冒烟测试 - 如何选择模型： - - `OPENCLAW_LIVE_MODELS=modern` 运行 modern allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - `OPENCLAW_LIVE_MODELS=modern` 运行 modern allowlist（Opus/Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - `OPENCLAW_LIVE_MODELS=all` 是 modern allowlist 的别名 - - 或 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔 allowlist） - - modern / all 扫描默认使用精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可进行完整的 modern 扫描，或设置一个正数以使用更小的上限。 + - 或者设置 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔 allowlist） + - Modern/all 扫描默认使用经过筛选的高信号数量上限；将 `OPENCLAW_LIVE_MAX_MODELS=0` 设为穷尽式 modern 扫描，或设为正数以使用更小上限。 - 如何选择提供商： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔 allowlist） -- 密钥来源： - - 默认：profile 存储和环境变量回退 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅使用 profile 存储** -- 存在原因： - - 将“提供商 API 坏了 / 密钥无效”与“gateway 智能体链路坏了”区分开来 - - 包含小型、隔离的回归测试（示例：OpenAI Responses / Codex Responses 的推理回放 + 工具调用流程） +- key 来源： + - 默认：profile store 和 env 回退 + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 以强制**仅使用 profile store** +- 该层存在的原因： + - 将“提供商 API 坏了 / key 无效”和“gateway 智能体流水线坏了”区分开来 + - 容纳小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 推理回放 + 工具调用流程） -### 第 2 层：Gateway 网关 + dev 智能体冒烟（也就是 “@openclaw” 实际在做什么） +### 第 2 层：Gateway 网关 + dev 智能体冒烟（也就是 “@openclaw” 实际做的事） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - - 启动一个进程内 Gateway 网关 - - 创建 / 修补一个 `agent:dev:*` 会话（每次运行覆盖模型） - - 遍历有密钥的模型并断言： - - 有“有意义”的响应（无工具） - - 一次真实的工具调用可用（read 探测） + - 启动一个进程内 gateway + - 创建/修补一个 `agent:dev:*` 会话（每次运行都覆盖模型） + - 遍历带 key 的模型并断言： + - “有意义”的响应（不使用工具） + - 真实工具调用可用（read 探测） - 可选的额外工具探测（exec+read 探测） - - OpenAI 回归路径（仅工具调用 → 后续跟进）仍然可用 -- 探测细节（这样你可以快速解释故障）： - - `read` 探测：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 它并回显该 nonce。 - - `exec+read` 探测：测试会要求智能体通过 `exec` 将 nonce 写入一个临时文件，然后再 `read` 回来。 - - 图像探测：测试会附加一个生成的 PNG（cat + 随机代码），并期望模型返回 `cat `。 + - OpenAI 回归路径（仅工具调用 → 后续跟进）继续可用 +- 探测细节（这样你可以快速解释失败）： + - `read` 探测：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 该文件并回显 nonce。 + - `exec+read` 探测：测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件，然后再 `read` 回来。 + - 图像探测：测试会附加一张生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 - 实现参考：`src/gateway/gateway-models.profiles.live.test.ts` 和 `src/gateway/live-image-probe.ts`。 - 启用方式： - - `pnpm test:live`（或直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） - 如何选择模型： - - 默认：modern allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - 默认：modern allowlist（Opus/Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是 modern allowlist 的别名 - - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）来缩小范围 - - modern / all 的 gateway 扫描默认使用精心挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可进行完整的 modern 扫描，或设置一个正数以使用更小的上限。 -- 如何选择提供商（避免 “OpenRouter 全都测”）： + - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）以缩小范围 + - Modern/all gateway 扫描默认使用经过筛选的高信号数量上限；将 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 设为穷尽式 modern 扫描，或设为正数以使用更小上限。 +- 如何选择提供商（避免“OpenRouter 全部都跑”）： - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔 allowlist） -- 工具 + 图像探测在此 live 测试中始终启用： +- 工具 + 图像探测在这个 live 测试中始终开启： - `read` 探测 + `exec+read` 探测（工具压力测试） - 当模型声明支持图像输入时，会运行图像探测 - 流程（高层）： - - 测试生成一个带有 “CAT” + 随机代码的小型 PNG（`src/gateway/live-image-probe.ts`） - - 通过 `agent` `attachments: [{ mimeType: "image/png", content: "" }]` 发送 - - Gateway 网关将附件解析进 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） - - 嵌入式智能体向模型转发一条多模态用户消息 + - 测试生成一个带有 “CAT” + 随机代码的微型 PNG（`src/gateway/live-image-probe.ts`） + - 通过 `agent` 的 `attachments: [{ mimeType: "image/png", content: "" }]` 发送 + - Gateway 网关将附件解析为 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） + - Embedded 智能体将多模态用户消息转发给模型 - 断言：回复包含 `cat` + 该代码（OCR 容错：允许轻微错误） -提示：如果你想查看你的机器上可以测试哪些内容（以及确切的 `provider/model` id），运行： +提示：要查看你这台机器上能测试什么（以及精确的 `provider/model` id），运行： ```bash openclaw models list @@ -476,23 +490,23 @@ openclaw models list --json ## Live：CLI 后端冒烟（Claude、Codex、Gemini 或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：使用本地 CLI 后端验证 Gateway 网关 + 智能体链路，而不触碰你的默认配置。 -- 后端特定的冒烟默认值位于所属扩展的 `cli-backend.ts` 定义中。 +- 目标：在不触碰默认配置的前提下，使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线。 +- 后端特定的冒烟默认值位于其所属 extension 的 `cli-backend.ts` 定义中。 - 启用： - - `pnpm test:live`（或直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） - `OPENCLAW_LIVE_CLI_BACKEND=1` - 默认值： - - 默认提供商 / 模型：`claude-cli/claude-sonnet-4-6` - - 命令 / 参数 / 图像行为来自所属 CLI 后端插件元数据。 + - 默认提供商/模型：`claude-cli/claude-sonnet-4-6` + - 命令/参数/图像行为来自所属 CLI 后端插件元数据。 - 覆盖项（可选）： - `OPENCLAW_LIVE_CLI_BACKEND_MODEL="codex-cli/gpt-5.4"` - `OPENCLAW_LIVE_CLI_BACKEND_COMMAND="/full/path/to/codex"` - `OPENCLAW_LIVE_CLI_BACKEND_ARGS='["exec","--json","--color","never","--sandbox","read-only","--skip-git-repo-check"]'` - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 发送真实图像附件（路径会注入到提示词中）。 - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 将图像文件路径作为 CLI 参数传入，而不是注入到提示词中。 - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）用于控制在设置 `IMAGE_ARG` 时如何传递图像参数。 - - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 发送第二轮并验证恢复流程。 - - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 禁用默认的 Claude Sonnet -> Opus 同会话连续性探测（当所选模型支持切换目标时，设置为 `1` 可强制启用）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 发送真实图像附件（路径会注入到提示中）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 通过 CLI 参数传递图像文件路径，而不是通过提示注入。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）用于控制设置了 `IMAGE_ARG` 时图像参数的传递方式。 + - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 发送第二轮消息并验证恢复流程。 + - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 禁用默认的 Claude Sonnet -> Opus 同会话连续性探测（当所选模型支持切换目标时，设为 `1` 可强制启用）。 示例： @@ -520,27 +534,27 @@ pnpm test:docker:live-cli-backend:gemini 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会在仓库 Docker 镜像内，以非 root 的 `node` 用户运行 live CLI 后端冒烟测试。 -- 它会从所属扩展解析 CLI 冒烟元数据，然后将对应的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到一个可缓存的可写前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR`（默认：`~/.cache/openclaw/docker-cli-tools`）中。 -- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过 `~/.claude/.credentials.json` 中的 `claudeAiOauth.subscriptionType`，或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN` 提供。它会先在 Docker 中证明直接 `claude -p` 可用，然后在不保留 Anthropic API 密钥环境变量的情况下运行两轮 Gateway 网关 CLI 后端测试。这个订阅通道默认禁用 Claude MCP / 工具和图像探测，因为 Claude 当前会将第三方应用使用路由到额外用量计费，而不是正常的订阅套餐限制。 -- 现在，live CLI 后端冒烟测试会对 Claude、Codex 和 Gemini 走同样的端到端流程：文本轮次、图像分类轮次，然后是通过 gateway CLI 验证的 MCP `cron` 工具调用。 -- Claude 的默认冒烟测试还会将会话从 Sonnet 修补为 Opus，并验证恢复后的会话仍记得先前的备注。 +- 它会在仓库 Docker 镜像内以非 root 的 `node` 用户运行 live CLI 后端冒烟测试。 +- 它会从所属 extension 解析 CLI 冒烟元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到可缓存、可写的前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR` 中（默认：`~/.cache/openclaw/docker-cli-tools`）。 +- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过 `~/.claude/.credentials.json` 中带 `claudeAiOauth.subscriptionType` 的配置，或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN` 提供。它会先在 Docker 中直接验证 `claude -p`，然后在不保留 Anthropic API key 环境变量的情况下运行两轮 Gateway 网关 CLI 后端交互。该订阅通道默认禁用 Claude MCP/tool 和图像探测，因为 Claude 目前会将第三方 app 使用计入额外 usage 计费，而不是正常订阅计划额度。 +- live CLI 后端冒烟测试现在会对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后是通过 gateway CLI 验证的 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet 修补切换到 Opus，并验证恢复后的会话仍然记得先前的备注。 ## Live：ACP 绑定冒烟（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用 live ACP 智能体验证真实 ACP 会话绑定流程： +- 目标：使用一个 live ACP 智能体验证真实的 ACP 会话绑定流程： - 发送 `/acp spawn --bind here` - - 原地绑定一个合成的消息渠道会话 - - 在同一会话上发送一条普通后续消息 - - 验证该后续消息出现在已绑定 ACP 会话转录中 + - 就地绑定一个合成的消息渠道会话 + - 在同一会话上发送一次普通跟进 + - 验证该跟进落入已绑定的 ACP 会话转录中 - 启用： - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` - 默认值： - Docker 中的 ACP 智能体：`claude,codex,gemini` - - 直接 `pnpm test:live ...` 的 ACP 智能体：`claude` - - 合成渠道：Slack 私信风格会话上下文 + - 直接运行 `pnpm test:live ...` 时使用的 ACP 智能体：`claude` + - 合成渠道：Slack 私信风格的会话上下文 - ACP 后端：`acpx` - 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` @@ -549,8 +563,8 @@ pnpm test:docker:live-cli-backend:gemini - `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude,codex,gemini` - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - 说明： - - 该通道使用 gateway `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，因此测试可以附加消息渠道上下文，而无需假装消息来自外部投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件的内建智能体注册表来选择 ACP 测试智能体。 + - 这个通道使用 gateway 的 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，因此测试可以附加消息渠道上下文，而无需假装进行外部投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中为所选 ACP 测试框架智能体提供的内建智能体注册表。 示例： @@ -577,34 +591,34 @@ pnpm test:docker:live-acp-bind:gemini Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会按顺序针对所有受支持的 live CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后 `gemini`。 +- 默认情况下，它会按顺序针对所有受支持的 live CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后是 `gemini`。 - 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可以缩小矩阵范围。 -- 它会读取 `~/.profile`，将匹配的 CLI 认证材料暂存到容器中，把 `acpx` 安装到一个可写 npm 前缀中，并在缺失时安装所请求的 live CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 -- 在 Docker 内，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，以便 acpx 能将来自已读取 profile 的提供商环境变量继续提供给子测试 CLI。 +- 它会读取 `~/.profile`，将匹配的 CLI 认证材料放入容器中，把 `acpx` 安装到可写 npm 前缀中，然后在缺失时安装请求的 live CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 +- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，以便 `acpx` 保留来自已读取 profile 的 provider 环境变量，并使其对子测试框架 CLI 可用。 ## Live：Codex app-server 测试框架冒烟 -- 目标：通过正常的 gateway +- 目标：通过常规 gateway `agent` 方法验证由插件负责的 Codex 测试框架： - - 加载内置的 `codex` 插件 + - 加载内置 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - 向 `codex/gpt-5.4` 发送第一轮 gateway 智能体请求 - 向同一个 OpenClaw 会话发送第二轮请求，并验证 app-server 线程可以恢复 - 通过同一条 gateway 命令 路径运行 `/codex status` 和 `/codex models` - - 可选运行两个经 Guardian 审核的提权 shell 探测：一个应被批准的 - 良性命令，以及一个应被拒绝的伪秘密上传命令， - 从而让智能体回过头来询问 + - 可选地运行两个经过 Guardian 审核的提权 shell 探测：一个应被批准的无害 + 命令，以及一个应被拒绝的伪造 secret 上传， + 以便智能体发起回问 - 测试：`src/gateway/gateway-codex-harness.live.test.ts` - 启用：`OPENCLAW_LIVE_CODEX_HARNESS=1` - 默认模型：`codex/gpt-5.4` - 可选图像探测：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` -- 可选 MCP / 工具探测：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` +- 可选 MCP/tool 探测：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` - 可选 Guardian 探测：`OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=1` - 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，因此损坏的 Codex - 测试框架不会通过悄悄回退到 PI 的方式蒙混过关。 -- 认证：来自 shell / profile 的 `OPENAI_API_KEY`，以及可选复制的 + 测试框架无法通过悄悄回退到 PI 的方式“假装通过”。 +- 认证：来自 shell/profile 的 `OPENAI_API_KEY`，以及可选复制的 `~/.codex/auth.json` 和 `~/.codex/config.toml` 本地配方： @@ -630,50 +644,50 @@ Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 - 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI - 认证文件，将 `@openai/codex` 安装到可写的已挂载 npm - 前缀中，暂存源码树，然后仅运行 Codex 测试框架 live 测试。 -- Docker 默认启用图像、MCP / 工具以及 Guardian 探测。设置 + 认证文件，将 `@openai/codex` 安装到可写的挂载 npm + 前缀中，准备源码树，然后只运行 Codex 测试框架 live 测试。 +- Docker 默认启用图像、MCP/tool 和 Guardian 探测。如需更窄范围的调试 + 运行，可设置 `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0` 或 - `OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0`，即可在需要更窄调试 - 运行时关闭它们。 + `OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0`。 - Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与 live 测试配置保持一致，因此 `openai-codex/*` 或 PI 回退都无法掩盖 Codex 测试框架 - 回归问题。 + 回归。 ### 推荐的 live 配方 -范围窄且显式的 allowlist 最快，也最不容易出错： +范围窄、显式的 allowlist 最快，也最不容易抖动： -- 单模型，直接调用（无 gateway）： +- 单模型，直连（无 gateway）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` -- 单模型，Gateway 网关冒烟： +- 单模型，gateway 冒烟： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - 跨多个提供商的工具调用： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 聚焦 Google（Gemini API 密钥 + Antigravity）： - - Gemini（API 密钥）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` +- Google 聚焦（Gemini API key + Antigravity）： + - Gemini（API key）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - Antigravity（OAuth）：`OPENCLAW_LIVE_GATEWAY_MODELS="google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-pro-high" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` 说明： -- `google/...` 使用 Gemini API（API 密钥）。 -- `google-antigravity/...` 使用 Antigravity OAuth 桥接（Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立的认证 + 工具行为差异）。 +- `google/...` 使用 Gemini API（API key）。 +- `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立认证 + 工具行为差异）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这也是大多数用户说“Gemini”时指的内容。 - - CLI：OpenClaw 会调用本地 `gemini` 二进制；它有自己的认证方式，行为也可能不同（流式传输 / 工具支持 / 版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API key / profile 认证）；这通常就是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 调用本地 `gemini` 二进制；它有自己的认证方式，并且行为可能不同（流式传输/工具支持/版本偏差）。 ## Live：模型矩阵（我们覆盖什么） -没有固定的“CI 模型列表”（live 是按需启用的），但对于在开发机上持有密钥的情况，以下是建议定期覆盖的模型。 +没有固定的“CI 模型列表”（live 是按需启用的），但以下是在有 key 的开发机上**推荐**定期覆盖的模型。 -### 现代冒烟集合（工具调用 + 图像） +### Modern 冒烟集（工具调用 + 图像） -这是我们预期应持续正常工作的“常用模型”运行集合： +这是我们预期应持续可用的“常用模型”运行： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -683,7 +697,7 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -使用工具 + 图像运行 Gateway 网关冒烟： +使用工具 + 图像运行 gateway 冒烟： `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,openai-codex/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3.1-pro-preview,google/gemini-3-flash-preview,google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-flash,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` ### 基线：工具调用（Read + 可选 Exec） @@ -696,46 +710,46 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的额外覆盖（有则更好）： +可选的额外覆盖（有更好，没有也行）： - xAI：`xai/grok-4`（或最新可用版本） -- Mistral：`mistral/`…（选择一个你已启用、具备 “tools” 能力的模型） +- Mistral：`mistral/`…（选择一个你已启用、支持工具的模型） - Cerebras：`cerebras/`…（如果你有访问权限） - LM Studio：`lmstudio/`…（本地；工具调用取决于 API 模式） ### Vision：发送图像（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个具备图像能力的模型（Claude / Gemini / OpenAI 具备视觉能力的变体等），以覆盖图像探测。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude/Gemini/OpenAI 的视觉能力变体等），以覆盖图像探测。 -### 聚合器 / 其他 Gateway 网关 +### 聚合器 / 替代 Gateway 网关 -如果你启用了相应密钥，我们也支持通过以下方式进行测试： +如果你已启用相应 key，我们也支持通过以下方式测试： -- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找具备工具 + 图像能力的候选项） -- OpenCode：Zen 使用 `opencode/...`，Go 使用 `opencode-go/...`（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） +- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具+图像的候选项） +- OpenCode：Zen 用 `opencode/...`，Go 用 `opencode-go/...`（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） -如果你有凭证 / 配置，也可以将更多提供商纳入 live 矩阵： +如果你有凭证/配置，也可以将更多提供商纳入 live 矩阵： - 内置：`openai`、`openai-codex`、`anthropic`、`google`、`google-vertex`、`google-antigravity`、`google-gemini-cli`、`zai`、`openrouter`、`opencode`、`opencode-go`、`xai`、`groq`、`cerebras`、`mistral`、`github-copilot` -- 通过 `models.providers`（自定义端点）：`minimax`（云端 / API），以及任何兼容 OpenAI / Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） +- 通过 `models.providers`（自定义端点）：`minimax`（云/API），以及任何兼容 OpenAI/Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） -提示：不要试图在文档中硬编码“所有模型”。权威列表是你机器上 `discoverModels(...)` 的返回结果，加上当前可用的密钥所共同决定的。 +提示：不要试图在文档里硬编码“所有模型”。权威列表应以你机器上 `discoverModels(...)` 返回的内容，以及当前可用 key 为准。 -## 凭证（切勿提交） +## 凭证（绝不要提交） -Live 测试发现凭证的方式与 CLI 相同。实际含义是： +Live 测试发现凭证的方式与 CLI 完全相同。实际含义如下： -- 如果 CLI 能工作，live 测试也应该能找到相同的密钥。 -- 如果某个 live 测试提示“没有凭证”，就用你调试 `openclaw models list` / 模型选择时相同的方法去调试。 +- 如果 CLI 能工作，live 测试也应该能找到相同的 key。 +- 如果 live 测试提示“没有凭证”，就像调试 `openclaw models list` / 模型选择那样去调试。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile keys” 的含义） +- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试里 “profile keys” 的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到暂存的 live home 中，但它不是主 profile-key 存储） -- 本地 live 运行默认会将当前活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；已暂存的 live home 会跳过 `workspace/` 和 `sandboxes/`，并剥离 `agents.*.workspace` / `agentDir` 路径覆盖，这样探测就不会落到你真实宿主机工作区中。 +- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到准备好的 live home 中，但它不是主 profile-key 存储） +- 本地 live 运行默认会把当前配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；准备好的 live home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探测就不会落到你的真实宿主工作区上。 -如果你想依赖环境变量密钥（例如在 `~/.profile` 中导出的密钥），请在本地测试前运行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 +如果你希望依赖 env key（例如导出在 `~/.profile` 中），请在 `source ~/.profile` 之后运行本地测试，或使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载进容器）。 -## Deepgram live（音频转写） +## Deepgram live（音频转录） - 测试：`src/media-understanding/providers/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts` @@ -746,14 +760,14 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义是： - 启用：`BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` - 可选模型覆盖：`BYTEPLUS_CODING_MODEL=ark-code-latest` -## ComfyUI 工作流媒体 live +## ComfyUI workflow 媒体 live - 测试：`extensions/comfy/comfy.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts` - 范围： - 覆盖内置 comfy 图像、视频和 `music_generate` 路径 - - 除非配置了 `models.providers.comfy.`，否则会跳过各项能力 - - 在修改 comfy 工作流提交、轮询、下载或插件注册之后非常有用 + - 除非已配置 `models.providers.comfy.`，否则会跳过每项能力 + - 在修改 comfy workflow 提交、轮询、下载或插件注册后很有用 ## 图像生成 live @@ -761,16 +775,16 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义是： - 命令：`pnpm test:live src/image-generation/runtime.live.test.ts` - 测试框架：`pnpm test:live:media image` - 范围： - - 枚举每个已注册的图像生成提供商插件 - - 在探测前先从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过时的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 + - 枚举每个已注册的图像生成 provider 插件 + - 在探测前，从你的登录 shell（`~/.profile`）加载缺失的 provider 环境变量 + - 默认优先使用 live/env API key，而不是已存储的 auth profile，因此 `auth-profiles.json` 中过期的测试 key 不会掩盖真实的 shell 凭证 + - 跳过没有可用 auth/profile/model 的 provider - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` - `google:pro-edit` - `openai:default-generate` -- 当前覆盖的内置提供商： +- 当前覆盖的内置 provider： - `openai` - `google` - `xai` @@ -779,7 +793,7 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义是： - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-2,google/gemini-3.1-flash-image-preview,xai/grok-imagine-image"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit,xai:default-generate,xai:default-edit"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量提供的覆盖值 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅来自 env 的覆盖 ## 音乐生成 live @@ -787,23 +801,23 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义是： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` - 测试框架：`pnpm test:live:media music` - 范围： - - 覆盖共享的内置音乐生成提供商路径 + - 覆盖共享的内置音乐生成 provider 路径 - 当前覆盖 Google 和 MiniMax - - 在探测前先从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过时的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 - - 在可用时运行两种声明的运行时模式： - - `generate`：仅提示词输入 - - `edit`：当提供商声明 `capabilities.edit.enabled` 时 + - 在探测前，从你的登录 shell（`~/.profile`）加载 provider 环境变量 + - 默认优先使用 live/env API key，而不是已存储的 auth profile，因此 `auth-profiles.json` 中过期的测试 key 不会掩盖真实的 shell 凭证 + - 跳过没有可用 auth/profile/model 的 provider + - 在可用时运行两种已声明的运行时模式： + - `generate`，仅使用提示词输入 + - 当 provider 声明 `capabilities.edit.enabled` 时运行 `edit` - 当前共享通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：单独的 Comfy live 文件，不在这个共享扫描中 + - `comfy`：使用单独的 Comfy live 文件，不在这个共享扫描中 - 可选缩小范围： - `OPENCLAW_LIVE_MUSIC_GENERATION_PROVIDERS="google,minimax"` - `OPENCLAW_LIVE_MUSIC_GENERATION_MODELS="google/lyria-3-clip-preview,minimax/music-2.5+"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量提供的覆盖值 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅来自 env 的覆盖 ## 视频生成 live @@ -811,67 +825,67 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义是： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` - 测试框架：`pnpm test:live:media video` - 范围： - - 覆盖共享的内置视频生成提供商路径 - - 默认走对发布安全的冒烟路径：非 FAL 提供商、每个提供商一次文本到视频请求、1 秒龙虾提示词，以及通过 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 控制的每个提供商操作上限（默认 `180000`） - - 默认跳过 FAL，因为提供商侧队列延迟可能主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 可显式运行它 - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过时的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 + - 覆盖共享的内置视频生成 provider 路径 + - 默认使用对发布安全的冒烟路径：非 FAL provider、每个 provider 一次 text-to-video 请求、1 秒龙虾提示词，以及来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的每 provider 操作上限（默认 `180000`） + - 默认跳过 FAL，因为 provider 侧队列延迟可能主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 以显式运行 + - 在探测前，从你的登录 shell（`~/.profile`）加载 provider 环境变量 + - 默认优先使用 live/env API key，而不是已存储的 auth profile，因此 `auth-profiles.json` 中过期的测试 key 不会掩盖真实的 shell 凭证 + - 跳过没有可用 auth/profile/model 的 provider - 默认只运行 `generate` - - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 还会在可用时运行已声明的转换模式： - - `imageToVideo`：当提供商声明 `capabilities.imageToVideo.enabled`，并且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时 - - `videoToVideo`：当提供商声明 `capabilities.videoToVideo.enabled`，并且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时 - - 当前在共享扫描中已声明但跳过的 `imageToVideo` 提供商： + - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 后，如果可用，也会运行已声明的转换模式： + - 当 provider 声明 `capabilities.imageToVideo.enabled`，且所选 provider/model 在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` + - 当 provider 声明 `capabilities.videoToVideo.enabled`，且所选 provider/model 在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` + - 当前在共享扫描中“已声明但跳过”的 `imageToVideo` provider： - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL - - 提供商特定的 Vydra 覆盖： + - provider 特定的 Vydra 覆盖： - `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - - 该文件会运行 `veo3` 文本到视频，以及默认使用远程图像 URL 夹具的 `kling` 通道 + - 该文件会运行 `veo3` text-to-video，以及一个默认使用远程图像 URL fixture 的 `kling` 通道 - 当前 `videoToVideo` live 覆盖： - - 仅 `runway`，前提是所选模型为 `runway/gen4_aleph` - - 当前在共享扫描中已声明但跳过的 `videoToVideo` 提供商： + - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 + - 当前在共享扫描中“已声明但跳过”的 `videoToVideo` provider： - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini / Veo 通道使用的是本地基于 buffer 的输入，而共享扫描不接受该路径 - - `openai`，因为当前共享通道缺少对组织特定视频修补 / 混剪访问权限的保证 + - `google`，因为当前共享 Gemini/Veo 通道使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享通道缺少特定组织的视频局部重绘/混剪访问保证 - 可选缩小范围： - `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="google,openai,runway"` - `OPENCLAW_LIVE_VIDEO_GENERATION_MODELS="google/veo-3.1-fast-generate-preview,openai/sora-2,runway/gen4_aleph"` - - `OPENCLAW_LIVE_VIDEO_GENERATION_SKIP_PROVIDERS=""` 以在默认扫描中包含每个提供商，包括 FAL - - `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS=60000` 以降低每个提供商操作上限，用于激进的冒烟运行 + - `OPENCLAW_LIVE_VIDEO_GENERATION_SKIP_PROVIDERS=""` 将默认扫描中的每个 provider 都包含进来，包括 FAL + - `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS=60000` 用于在激进的冒烟运行中缩短每个 provider 的操作上限 - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量提供的覆盖值 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅来自 env 的覆盖 ## 媒体 live 测试框架 - 命令：`pnpm test:live:media` - 目的： - - 通过一个仓库原生入口点运行共享的图像、音乐和视频 live 测试套件 - - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 - - 复用 `scripts/test-live.mjs`，因此心跳和静默模式行为保持一致 + - 通过一个原生仓库入口运行共享的图像、音乐和视频 live 测试套件 + - 自动从 `~/.profile` 加载缺失的 provider 环境变量 + - 默认自动将每个测试套件缩小到当前具有可用认证的 provider + - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 - 示例： - `pnpm test:live:media` - `pnpm test:live:media image video --providers openai,google,minimax` - `pnpm test:live:media video --video-providers openai,runway --all-providers` - `pnpm test:live:media music --quiet` -## Docker 运行器（可选的“在 Linux 中可用”检查） +## Docker 运行器（可选的“在 Linux 中能工作”检查） 这些 Docker 运行器分为两类： -- live 模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 仅在仓库 Docker 镜像中运行各自对应的 profile-key live 文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如已挂载，也会读取 `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 +- Live 模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像中运行各自匹配的 profile-key live 文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，也会读取 `~/.profile`）。对应的本地入口是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 - Docker live 运行器默认使用更小的冒烟上限，以便完整 Docker 扫描仍然可行： - `test:docker:live-models` 默认设置 `OPENCLAW_LIVE_MAX_MODELS=12`，并且 - `test:docker:live-gateway` 默认设置 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 + `test:docker:live-models` 默认使用 `OPENCLAW_LIVE_MAX_MODELS=12`，并且 + `test:docker:live-gateway` 默认使用 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=8`、 - `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000` 和 + `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000` 以及 `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你 - 明确想要更大的完整扫描时，可覆盖这些环境变量。 + 明确需要更大的穷尽式扫描时，可覆盖这些环境变量。 - `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后在两个 live Docker 通道中复用它。 - 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools` 和 `test:docker:plugins` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -live 模型 Docker 运行器还会仅 bind-mount 所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持的认证 home），然后在运行前将其复制到容器 home 中，以便外部 CLI OAuth 可以刷新 token，而不会修改宿主机认证存储： +Live 模型 Docker 运行器还会只绑定挂载所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持的 home），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新 token，而不会修改宿主的认证存储： -- 直接模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） +- 直连模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） - ACP 绑定冒烟：`pnpm test:docker:live-acp-bind`（脚本：`scripts/test-live-acp-bind-docker.sh`） - CLI 后端冒烟：`pnpm test:docker:live-cli-backend`（脚本：`scripts/test-live-cli-backend-docker.sh`） - Codex app-server 测试框架冒烟：`pnpm test:docker:live-codex-harness`（脚本：`scripts/test-live-codex-harness-docker.sh`） @@ -879,169 +893,169 @@ live 模型 Docker 运行器还会仅 bind-mount 所需的 CLI 认证 home（如 - Open WebUI live 冒烟：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） - 新手引导向导（TTY，完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） - Gateway 网关网络（两个容器，WS 认证 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） -- MCP 渠道桥接（带种子的 Gateway 网关 + stdio 桥接 + 原始 Claude 通知帧冒烟）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） -- Pi 内置 MCP 工具（真实 stdio MCP 服务器 + 嵌入式 Pi profile allow / deny 冒烟）：`pnpm test:docker:pi-bundle-mcp-tools`（脚本：`scripts/e2e/pi-bundle-mcp-tools-docker.sh`） -- 插件（安装冒烟 + `/plugin` 别名 + Claude 内置包重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -- 内置插件运行时依赖：`pnpm test:docker:bundled-channel-deps` 默认会构建一个小型 Docker 运行器镜像，在宿主机上构建并打包一次 OpenClaw，然后将该 tarball 挂载到每个 Linux 安装场景中。使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 复用镜像；在完成一次全新的本地构建后，可通过 `OPENCLAW_BUNDLED_CHANNEL_HOST_BUILD=0` 跳过宿主机重建；或通过 `OPENCLAW_BUNDLED_CHANNEL_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 指向一个现有 tarball。 -- 在迭代时，可通过禁用无关场景来缩小内置插件运行时依赖测试范围，例如： - `OPENCLAW_BUNDLED_CHANNEL_SCENARIOS=0 OPENCLAW_BUNDLED_CHANNEL_UPDATE_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_ROOT_OWNED_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_SETUP_ENTRY_SCENARIO=0 pnpm test:docker:bundled-channel-deps`。 +- MCP 渠道桥接（带种子的 Gateway 网关 + stdio bridge + 原始 Claude 通知帧冒烟）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） +- Pi bundle MCP 工具（真实 stdio MCP 服务器 + 内置 Pi profile allow/deny 冒烟）：`pnpm test:docker:pi-bundle-mcp-tools`（脚本：`scripts/e2e/pi-bundle-mcp-tools-docker.sh`） +- 插件（安装冒烟 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） +- 内置插件运行时依赖：`pnpm test:docker:bundled-channel-deps` 默认会构建一个小型 Docker 运行器镜像，在宿主机上构建并打包一次 OpenClaw，然后将该 tarball 挂载到每个 Linux 安装场景中。使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 复用镜像；在本地新构建后使用 `OPENCLAW_BUNDLED_CHANNEL_HOST_BUILD=0` 跳过宿主重建；或通过 `OPENCLAW_BUNDLED_CHANNEL_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 指向现有 tarball。 +- 在迭代时可通过禁用无关场景来缩小内置插件运行时依赖测试范围，例如： + `OPENCLAW_BUNDLED_CHANNEL_SCENARIOS=0 OPENCLAW_BUNDLED_CHANNEL_UPDATE_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_ROOT_OWNED_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_SETUP_ENTRY_SCENARIO=0 pnpm test:docker:bundled-channel-deps` -live 模型 Docker 运行器还会以只读方式 bind-mount 当前检出，并在容器内将其暂存到临时工作目录中。这样既能保持运行时镜像精简，又仍能针对你本地精确的源码 / 配置运行 Vitest。 -暂存步骤会跳过大型仅本地缓存和应用构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地 `.build` 或 -Gradle 输出目录，因此 Docker live 运行不会花上数分钟复制 -机器特定产物。 +Live 模型 Docker 运行器还会以只读方式 bind-mount 当前检出，并将其准备到容器内的临时工作目录中。这样既能保持运行时镜像精简，又能让 Vitest 针对你本地精确的源码/配置运行。 +准备步骤会跳过大型仅本地缓存和 app 构建输出，例如 +`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及 app 本地的 `.build` 或 +Gradle 输出目录，因此 Docker live 运行不会浪费数分钟去复制 +机器特定的产物。 它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 gateway live 探测就不会在容器内启动 -真实的 Telegram / Discord / 等渠道工作进程。 -`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要缩小范围或排除 gateway -live 覆盖时，也请一并透传 +真实的 Telegram/Discord 等渠道 worker。 +`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要在该 Docker 通道中缩小范围或排除 gateway +live 覆盖时，也要一并传递 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个 -启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器， -再针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器，通过 -Open WebUI 完成登录，验证 `/api/models` 暴露了 `openclaw/default`，然后通过 -Open WebUI 的 `/api/chat/completions` 代理发送一条真实聊天请求。 +`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个启用了 OpenAI 兼容 HTTP 端点的 +OpenClaw gateway 容器， +再针对该 gateway 启动一个固定版本的 Open WebUI 容器，通过 +Open WebUI 登录，验证 `/api/models` 暴露了 `openclaw/default`，然后通过 +Open WebUI 的 `/api/chat/completions` 代理发送一条 +真实聊天请求。 首次运行可能明显更慢，因为 Docker 可能需要拉取 -Open WebUI 镜像，而 Open WebUI 也可能需要完成自身的冷启动 setup。 -该通道需要一个可用的 live 模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认是 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 -成功运行会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": +Open WebUI 镜像，而 Open WebUI 也可能需要完成其自身的冷启动设置。 +该通道需要可用的 live 模型 key，而 `OPENCLAW_PROFILE_FILE` +（默认 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 +成功运行会打印一段简短的 JSON，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是有意保持确定性的，不需要 +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要 真实的 Telegram、Discord 或 iMessage 账号。它会启动一个带种子的 Gateway 网关 -容器，启动第二个容器来运行 `openclaw mcp serve`，然后 -验证经路由的会话发现、转录读取、附件元数据、 -live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + -权限通知，这些都通过真实的 stdio MCP 桥接完成。通知检查 -会直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 -桥接实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露的内容。 -`test:docker:pi-bundle-mcp-tools` 具有确定性，不需要 live -模型密钥。它会构建仓库 Docker 镜像，在容器内启动一个真实 stdio MCP 探测服务器， -通过嵌入式 Pi 内置 MCP 运行时实例化该服务器， -执行工具，然后验证 `coding` 和 `messaging` 保留 +容器，再启动第二个容器来运行 `openclaw mcp serve`，然后 +验证路由后的会话发现、转录读取、附件元数据、 +live 事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 传递的 Claude 风格渠道 + +权限通知。通知检查会直接检查原始 stdio MCP frame， +因此这个冒烟测试验证的是 bridge 实际发出了什么，而不只是某个特定客户端 SDK 恰好暴露了什么。 +`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要 live +模型 key。它会构建仓库 Docker 镜像，在容器中启动一个真实 stdio MCP probe 服务器， +通过内置的 Pi bundle +MCP 运行时将该服务器实例化，执行工具，然后验证 `coding` 和 `messaging` 会保留 `bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会将其过滤掉。 手动 ACP 自然语言线程冒烟测试（非 CI）： - `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel ...` -- 保留此脚本用于回归 / 调试工作流。后续可能仍需要它来验证 ACP 线程路由，因此不要删除它。 +- 将此脚本保留用于回归/调试工作流。它未来可能仍会用于 ACP 线程路由验证，因此不要删除。 有用的环境变量： -- `OPENCLAW_CONFIG_DIR=...`（默认：`~/.openclaw`）挂载到 `/home/node/.openclaw` -- `OPENCLAW_WORKSPACE_DIR=...`（默认：`~/.openclaw/workspace`）挂载到 `/home/node/.openclaw/workspace` -- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile`，并在运行测试前读取 -- `OPENCLAW_DOCKER_PROFILE_ENV_ONLY=1` 用于仅验证从 `OPENCLAW_PROFILE_FILE` 读取的环境变量，此时会使用临时配置 / 工作区目录，并且不挂载外部 CLI 认证 -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于在 Docker 内缓存 CLI 安装 -- `$HOME` 下的外部 CLI 认证目录 / 文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` +- `OPENCLAW_CONFIG_DIR=...`（默认：`~/.openclaw`），挂载到 `/home/node/.openclaw` +- `OPENCLAW_WORKSPACE_DIR=...`（默认：`~/.openclaw/workspace`），挂载到 `/home/node/.openclaw/workspace` +- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`），挂载到 `/home/node/.profile`，并在运行测试前读取 +- `OPENCLAW_DOCKER_PROFILE_ENV_ONLY=1`，用于只验证从 `OPENCLAW_PROFILE_FILE` 读取的环境变量，使用临时 config/workspace 目录，且不挂载外部 CLI 认证 +- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`），挂载到 `/home/node/.npm-global`，用于 Docker 内的缓存 CLI 安装 +- `$HOME` 下的外部 CLI 认证目录/文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` - 默认目录：`.minimax` - 默认文件：`~/.codex/auth.json`、`~/.codex/config.toml`、`.claude.json`、`~/.claude/.credentials.json`、`~/.claude/settings.json`、`~/.claude/settings.local.json` - - 缩小范围的提供商运行只会挂载从 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录 / 文件 - - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none`，或类似 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex` 的逗号列表手动覆盖 -- `OPENCLAW_LIVE_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...` 用于缩小运行范围 -- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于在容器内筛选提供商 -- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用已有的 `openclaw:local-live` 镜像，以便在无需重建的重跑中使用 -- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自 profile 存储（而不是环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择 Gateway 网关为 Open WebUI 冒烟测试暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词 -- `OPENWEBUI_IMAGE=...` 用于覆盖固定的 Open WebUI 镜像标签 + - 缩小范围后的 provider 运行只会挂载根据 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录/文件 + - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none` 或逗号列表（如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex`）手动覆盖 +- `OPENCLAW_LIVE_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...`，用于缩小运行范围 +- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...`，用于在容器内过滤 provider +- `OPENCLAW_SKIP_DOCKER_BUILD=1`，用于在无需重建时复用现有 `openclaw:local-live` 镜像 +- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`，确保凭证来自 profile store（而不是 env） +- `OPENCLAW_OPENWEBUI_MODEL=...`，用于选择在 Open WebUI 冒烟测试中由 gateway 暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...`，用于覆盖 Open WebUI 冒烟测试中的 nonce 检查提示词 +- `OPENWEBUI_IMAGE=...`，用于覆盖固定的 Open WebUI 镜像标签 ## 文档完整性检查 -在编辑文档后运行文档检查：`pnpm check:docs`。 -当你还需要检查页内标题锚点时，运行完整的 Mintlify 锚点验证：`pnpm docs:check-links:anchors`。 +修改文档后运行文档检查：`pnpm check:docs`。 +当你还需要检查页内标题锚点时，运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 -## 离线回归测试（CI 安全） +## 离线回归（CI 安全） -这些是在不依赖真实提供商的情况下进行的“真实链路”回归测试： +这些是在没有真实 provider 的情况下进行的“真实流水线”回归测试： - Gateway 网关工具调用（mock OpenAI，真实 gateway + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） -- Gateway 网关向导（WS `wizard.start` / `wizard.next`，强制写入 config + auth）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） +- Gateway 网关向导（WS `wizard.start`/`wizard.next`，会写入 config + 强制 auth）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） ## 智能体可靠性评估（Skills） -我们已经有一些 CI 安全的测试，它们的行为类似“智能体可靠性评估”： +我们已经有一些 CI 安全的测试，其行为类似“智能体可靠性评估”： - 通过真实 gateway + 智能体循环进行 mock 工具调用（`src/gateway/gateway.test.ts`）。 - 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 -对于 Skills（见 [Skills](/zh-CN/tools/skills)），目前仍缺少： +对于 Skills（见 [Skills](/zh-CN/tools/skills)），目前仍缺少的内容： -- **决策能力：** 当提示词中列出了 Skills 时，智能体是否会选择正确的 Skills（或避免无关的 Skills）？ -- **合规性：** 智能体是否会在使用前读取 `SKILL.md`，并遵循所需步骤 / 参数？ -- **工作流契约：** 用于断言工具顺序、会话历史延续和沙箱边界的多轮场景。 +- **决策**：当 prompt 中列出 Skills 时，智能体是否会选择正确的 skill（或避开无关的 skill）？ +- **合规性**：智能体在使用前是否会读取 `SKILL.md`，并遵循必需的步骤/参数？ +- **工作流契约**：断言工具顺序、会话历史延续和沙箱边界的多轮场景。 -未来的评估应优先保持确定性： +未来的评估应首先保持确定性： -- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 -- 一小组聚焦 skill 的场景（使用 vs 避免、门禁、提示词注入）。 -- 只有在 CI 安全测试套件到位之后，才添加可选的 live 评估（按需启用、由环境变量控制）。 +- 一个使用 mock provider 的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 +- 一小组聚焦于 skill 的场景（使用 vs 避免、门控、prompt 注入）。 +- 仅在 CI 安全测试套件完善之后，再加入可选的 live 评估（按需启用、受 env 控制）。 ## 契约测试（插件和渠道形状） -契约测试用于验证每个已注册插件和渠道都符合其 -接口契约。它们会遍历所有已发现的插件，并运行一组 -形状和行为断言。默认的 `pnpm test` 单元测试通道会有意 -跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商接口时， +契约测试会验证每个已注册插件和渠道是否符合其 +接口契约。它们会遍历所有已发现的插件，并运行一组关于 +结构和行为的断言。默认的 `pnpm test` unit 通道会有意 +跳过这些共享接缝和冒烟文件；当你修改共享渠道或 provider 表面时， 请显式运行契约命令。 ### 命令 - 所有契约：`pnpm test:contracts` - 仅渠道契约：`pnpm test:contracts:channels` -- 仅提供商契约：`pnpm test:contracts:plugins` +- 仅 provider 契约：`pnpm test:contracts:plugins` ### 渠道契约 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基础插件形状（id、name、capabilities） +- **plugin** - 基本插件结构（id、name、capabilities） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 - **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 -- **actions** - 渠道动作处理器 +- **actions** - 渠道 action 处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录 / roster API +- **directory** - 目录/成员列表 API - **group-policy** - 群组策略执行 -### 提供商状态契约 +### Provider 状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 -- **registry** - 插件注册表形状 +- **registry** - 插件注册表结构 -### 提供商契约 +### Provider 契约 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选择 / 选取 +- **auth-choice** - 认证选项/选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 -- **runtime** - 提供商运行时 -- **shape** - 插件形状 / 接口 +- **runtime** - Provider 运行时 +- **shape** - 插件结构/接口 - **wizard** - 设置向导 ### 何时运行 -- 在修改插件 SDK 导出或子路径之后 -- 在添加或修改渠道或提供商插件之后 -- 在重构插件注册或发现之后 +- 修改 plugin-sdk 导出或子路径之后 +- 添加或修改渠道或 provider 插件之后 +- 重构插件注册或发现逻辑之后 -契约测试会在 CI 中运行，不需要真实 API 密钥。 +契约测试会在 CI 中运行，并且不需要真实 API key。 -## 添加回归测试（指南） +## 添加回归测试（指导） -当你修复在 live 中发现的提供商 / 模型问题时： +当你修复一个在 live 中发现的 provider/model 问题时： -- 如果可能，添加一个 CI 安全的回归测试（mock / stub 提供商，或捕获精确的请求形状转换） -- 如果它天然只能在 live 中复现（速率限制、认证策略），就让 live 测试保持范围窄，并通过环境变量按需启用 -- 优先针对能捕获该缺陷的最小层级： - - 提供商请求转换 / 回放缺陷 → 直接模型测试 - - gateway 会话 / 历史 / 工具链路缺陷 → gateway live 冒烟测试或 CI 安全的 gateway mock 测试 -- `SecretRef` 遍历保护规则： - - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 `SecretRef` 类派生一个采样目标，然后断言遍历段 exec id 会被拒绝。 - - 如果你在 `src/secrets/target-registry-data.ts` 中新增了一个 `includeInPlan` `SecretRef` 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会在遇到未分类的目标 id 时故意失败，这样新的类别就无法被悄悄跳过。 +- 如果可能，添加一个 CI 安全的回归测试（mock/stub provider，或捕获确切的请求结构转换） +- 如果问题天然只能通过 live 发现（速率限制、认证策略），就让 live 测试保持狭窄范围，并通过 env 变量按需启用 +- 优先定位到能捕获该缺陷的最小层级： + - provider 请求转换/回放缺陷 → 直连模型测试 + - gateway 会话/历史/工具流水线缺陷 → gateway live 冒烟测试或 CI 安全的 gateway mock 测试 +- SecretRef 遍历保护规则： + - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言会拒绝 traversal-segment exec id。 + - 如果你在 `src/secrets/target-registry-data.ts` 中新增一个 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会有意在遇到未分类目标 id 时失败，这样新类别就无法被悄悄跳过。