Files
claude-code/packages/acp-link/src/rcs-upstream.ts
claude-code-best 5e30697950 fix: 严格对齐 ACP 协议实现到 stable v1 规范
对照 /Users/konghayao/code/knowledgebase/origin/acp 规范审计并修复 53 条合规性
发现(critical 5 / major 17 / minor 20 / nit 11),完整审计报告见
docs/acp-compliance-audit.md。

Agent 端 (src/services/acp/agent.ts):
- initialize() 补齐 authMethods,promptCapabilities.image 降级为 false(声明与
  实现脱节,按 initialization.mdx 不声明的 capability 视为不支持)
- sessionCapabilities.fork 移至 _meta.claudeCode.forkSession(fork 在
  meta.unstable.json 中,避免在 stable sessionCapabilities 中暴露 unstable 特性)
- unstable_resumeSession 传 replay:false,不再通过 session/update 重放历史
  (session-setup.mdx:239 明确禁止)
- PromptResponse.usage 移至 _meta.claudeCode.usage
  (extensibility.mdx:39 禁止在 spec 类型根添加自定义字段)
- 空字符串 prompt 改为显式 throw(不再误返 end_turn)

Bridge (src/services/acp/bridge.ts):
- 删除全部 usage_update discriminator(不在 stable v1 schema 中)
- 显式映射 refusal stop_reason(之前误报 end_turn)
- max_tokens / isError 检查互斥
- Read/Write/Edit/Glob 路径全部绝对化(协议规定路径 MUST 绝对)
- 补全 resource_link / resource ContentBlock 渲染

Permissions (src/services/acp/permissions.ts):
- 补齐 reject_always PermissionOption(schema 规定的四个 option 之一)
- checkTerminalOutput 优先检查标准 clientCapabilities.terminal,
  回退到 _meta.terminal_output
- 新增 onPermissionCancelled 回调:cancelled permission outcome →
  StopReason::Cancelled(schema.json:629)
- ExitPlanMode cancelled 分支补上 toolUseID 字段

PromptConversion (src/services/acp/promptConversion.ts):
- resource 分支处理 BlobResource(之前静默丢弃 blob 内容)

acp-link 代理 (packages/acp-link/src/):
- WS 协议从专有 {type, payload} 改造为标准 JSON-RPC 2.0
  (transports.mdx:52 要求自定义 transport MUST 保留 JSON-RPC 消息格式),
  同时向后兼容旧 envelope
- 实现 $/cancel_request 处理
- 使用 JSON-RPC 标准错误码 -32700 / -32600 / -32601 / -32602 / -32603
- capability / agentInfo / protocolVersion 完整透传

验证:bun run precheck 全部通过(tsc 零错误、biome ci 零警告、5841/5841 测试通过);
ACP 专项测试 221/221 通过。独立 verification agent 抽查全部 PASS。

已知暂缓项(审计文档附录 B/C):
- §3.5 traceparent/trace-context 传播(QueryEngine 无 header hook)
- §5.2 terminal/create 完整生命周期(P1,非阻断,需新 RPC 流程)
- §4.2 in_progress tool_call status(SHOULD 级)
- §8.8/8.9/8.14 stale types.ts(不在 owner 分配集合,runtime 已修正)

Co-Authored-By: glm-5.2 <zai-org@claude-code-best.win>
2026-06-20 12:38:43 +08:00

309 lines
9.3 KiB
TypeScript

import { createLogger } from './logger.js'
import { decodeJsonWsMessage, WsPayloadTooLargeError } from './ws-message.js'
import { encodeWebSocketAuthProtocol } from './ws-auth.js'
export interface RcsUpstreamConfig {
rcsUrl: string // e.g. "http://localhost:3000"
apiToken: string
agentName: string
channelGroupId?: string
capabilities?: Record<string, unknown>
maxSessions?: number
}
export function buildRcsWsUrl(rcsUrl: string): string {
let raw = rcsUrl
raw = raw.replace(/^http:\/\//, 'ws://').replace(/^https:\/\//, 'wss://')
const url = new URL(raw)
const path = url.pathname.replace(/\/+$/, '')
if (!path || path === '/') {
url.pathname = '/acp/ws'
}
url.searchParams.delete('token')
return url.toString()
}
/**
* RCS upstream client — connects acp-link to a Remote Control Server.
*
* Lifecycle:
* 1. connect() — opens WS to RCS
* 2. Sends register message
* 3. Waits for registered response
* 4. Forwards all ACP events via send()
* 5. Reconnects with exponential backoff on failure
*/
export class RcsUpstreamClient {
private static log = createLogger('rcs-upstream')
private ws: WebSocket | null = null
private registered = false
private reconnectAttempts = 0
private closed = false
private readonly maxReconnectDelay = 30_000
private readonly baseReconnectDelay = 1_000
/** Agent ID obtained from REST registration */
private agentId: string | null = null
/** Session ID from REST registration (ACP agents auto-create a session) */
private sessionId: string | undefined
/** Handler for incoming ACP messages from RCS relay */
private messageHandler: ((message: Record<string, unknown>) => void) | null =
null
constructor(private config: RcsUpstreamConfig) {}
/** Get the agent ID from REST registration */
getAgentId(): string | null {
return this.agentId
}
/** Set handler for incoming ACP messages from RCS relay */
setMessageHandler(handler: (message: Record<string, unknown>) => void): void {
this.messageHandler = handler
}
/** Register via REST API before establishing WS connection */
private async registerViaRest(): Promise<string> {
const baseUrl = this.config.rcsUrl
.replace(/^ws:\/\//, 'http://')
.replace(/^wss:\/\//, 'https://')
.replace(/\/acp\/ws.*$/, '')
.replace(/\/$/, '')
const url = `${baseUrl}/v1/environments/bridge`
RcsUpstreamClient.log.info({ url }, 'REST register')
const resp = await fetch(url, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${this.config.apiToken}`,
},
body: JSON.stringify({
machine_name: this.config.agentName,
worker_type: 'acp',
bridge_id: this.config.channelGroupId || undefined,
max_sessions: this.config.maxSessions,
capabilities: this.config.capabilities,
}),
})
if (!resp.ok) {
const text = await resp.text()
throw new Error(`REST register failed (${resp.status}): ${text}`)
}
const data = (await resp.json()) as {
environment_id: string
environment_secret: string
status: string
session_id?: string
}
this.agentId = data.environment_id
this.sessionId = data.session_id
RcsUpstreamClient.log.info(
{ agentId: this.agentId, sessionId: this.sessionId },
'REST register success',
)
return data.environment_id
}
/** Normalize RCS URL: accept http(s) base URL and convert to ws(s) + /acp/ws path */
private buildWsUrl(): string {
return buildRcsWsUrl(this.config.rcsUrl)
}
/** Open connection to RCS: REST register → WS identify */
async connect(): Promise<void> {
if (this.closed) return
// Step 1: REST registration
try {
await this.registerViaRest()
} catch (err) {
RcsUpstreamClient.log.error({ err }, 'REST registration failed')
if (!this.closed) {
this.scheduleReconnect()
}
return
}
// Step 2: WebSocket connection with identify
const wsUrl = this.buildWsUrl()
RcsUpstreamClient.log.info({ url: wsUrl }, 'connecting WS')
return new Promise((resolve, reject) => {
try {
this.ws = new WebSocket(wsUrl, [
encodeWebSocketAuthProtocol(this.config.apiToken),
])
this.ws.onopen = () => {
RcsUpstreamClient.log.debug('ws open — sending identify')
this.ws!.send(
JSON.stringify({
type: 'identify',
agent_id: this.agentId,
}),
)
}
this.ws.onmessage = event => {
let data: Record<string, unknown>
try {
data = decodeJsonWsMessage(event.data)
} catch (err) {
if (err instanceof WsPayloadTooLargeError) {
RcsUpstreamClient.log.warn(
{ error: err.message },
'server message too large',
)
this.ws?.close(1009, 'message too large')
return
}
RcsUpstreamClient.log.warn(
{ raw: String(event.data).slice(0, 200) },
'invalid JSON from server',
)
return
}
if (data.type === 'identified') {
RcsUpstreamClient.log.info(
{
agent_id: data.agent_id,
channel_group_id: data.channel_group_id,
},
'identified',
)
this.registered = true
this.reconnectAttempts = 0
const webBase = this.config.rcsUrl
.replace(/^ws:\/\//, 'http://')
.replace(/^wss:\/\//, 'https://')
.replace(/\/acp\/ws.*$/, '')
.replace(/\/$/, '')
console.log()
console.log(` 🔗 Dashboard: ${webBase}/code/`)
if (this.agentId) {
console.log(` Agent ID: ${this.agentId}`)
}
console.log()
resolve()
} else if (data.type === 'registered') {
// Legacy fallback: server still uses old register flow
RcsUpstreamClient.log.info(
{ agent_id: data.agent_id },
'registered (legacy)',
)
this.agentId = (data.agent_id as string) || this.agentId
this.registered = true
this.reconnectAttempts = 0
resolve()
} else if (data.type === 'error') {
RcsUpstreamClient.log.error(
{ message: data.message },
'server error',
)
if (!this.registered) {
reject(new Error(data.message as string))
}
} else if (data.type === 'keep_alive') {
// ignore keepalive
} else {
// Forward ACP protocol messages to handler (for RCS relay support).
// This branch handles both the legacy `{type, payload}` envelope
// and JSON-RPC 2.0 messages (which have no `type` field) so the
// relay preserves the JSON-RPC format end-to-end (audit §8.12).
RcsUpstreamClient.log.debug(
{ type: data.type, method: data.method },
'forwarding to relay handler',
)
this.messageHandler?.(data)
}
}
this.ws.onerror = () => {
// onclose fires after onerror with the actual close code, so we log there
if (!this.registered) {
reject(new Error('WebSocket connection failed'))
}
}
this.ws.onclose = event => {
RcsUpstreamClient.log.info(
{ code: event.code, reason: event.reason || undefined },
'ws closed',
)
this.registered = false
this.ws = null
if (!this.closed) {
this.scheduleReconnect()
}
}
} catch (err) {
RcsUpstreamClient.log.error({ err }, 'connect threw')
reject(err)
}
})
}
/** Send an ACP message to RCS for broadcast */
send(message: object): void {
if (!this.ws || this.ws.readyState !== WebSocket.OPEN || !this.registered) {
return
}
try {
this.ws.send(JSON.stringify(message))
} catch (err) {
RcsUpstreamClient.log.error({ err }, 'send failed')
}
}
/** Check if registered with RCS */
isRegistered(): boolean {
return (
this.registered &&
this.ws !== null &&
this.ws.readyState === WebSocket.OPEN
)
}
/** Close the RCS connection permanently */
async close(): Promise<void> {
this.closed = true
this.registered = false
if (this.ws) {
this.ws.close(1000, 'client shutdown')
this.ws = null
}
RcsUpstreamClient.log.info('closed')
}
private scheduleReconnect(): void {
if (this.closed) return
const delay = Math.min(
this.baseReconnectDelay * 2 ** this.reconnectAttempts,
this.maxReconnectDelay,
)
const jitter = delay * Math.random() * 0.2
const actualDelay = delay + jitter
this.reconnectAttempts++
RcsUpstreamClient.log.warn(
{ attempt: this.reconnectAttempts, delayMs: Math.round(actualDelay) },
'reconnecting',
)
setTimeout(async () => {
if (this.closed) return
try {
await this.connect()
} catch {
// connect() itself logs the error; nothing to add here
}
}, actualDelay)
}
}