Files
homeagent-sdk/example/commondev/sidecar.mjs
JianFeeeee 4387e12ca8 fix(commondev): 投递任务改成真异步,不再同步等 pi 跑完
## 缺陷(用户质疑"投递不就是发一条消息"后实测确认)

`deliverToPi` 的注释写着"把给 pi 发消息包装一下",但实际是:

	await s.prompt(text)   // 同步等 pi 把**整个任务**跑完

而 pi/zcode 开工程线干活(克隆/改代码/跑测试)要几十秒到 20 分钟。
生产日志实测两次:

	23:04:03  executing tool: output_send__commondev_br-...
	23:05:03  ★ timed out after 60s

通道的语义是"**投递**任务"(见 outputch 描述),不是"等完成"。
把它实现成同步等待,就必然撞上内核的 60s 工具超时。

★ 我一开始的诊断是错的:以为"超时值太小",给 output_send 声明了 3m
  —— 那是掩盖症状。投递本该瞬时返回,慢是 bug 不是需求。已撤回。

## 改动

	投递 → 立即回 status=accepted(瞬时)
	     → pi 在后台跑
	     → 跑完推**主动通知**(id=0)
	     → Go 侧 onNotify 经 inputch 注入回 agent

`sidecar.go` 的 readLoop 里早就留好了这个扩展位:
    if resp.ID == 0 { // 主动通知(暂未使用,保留扩展位)
现在接上了 `makePromptNotifier`。

pi 与 zcode 两份 sidecar.mjs 都改了(rawfile/ 里那两份同步更新)。

## 判据抓到我三次(都是真问题)

1. `TestSidecarScriptShipsWithPackage`:rawfile/ 与工程根不一致
   —— 我只改了根那份
2. `TestZcodeMissingCLIErrorIsActionable`:`inflight is not defined`
   —— zcode 版用了未声明变量
3. 同一条判据随后**卡死 2 分钟**:CLI 不存在本该立刻报,异步后错误
   被吞进后台通知 ⇒ 用户先收到"已受理"、几秒后才知道配置错。
   改成**受理阶段就校验 CLI**(配置错是立刻可判定的,不该推迟)。

判据还逼我保住语义:原 `TestZcodeSidecarArgvBehavior` 断言首轮拿到
真实 `sess_` id,异步后要到完成通知里才有 —— 断言保留、改从通知取,
没有削弱。

## 真机 e2e(三条全过,都要求真改工程文件)

	TestZcodeFullPipeline              42.1s
	TestZcodeOverSSH                   72.4s
	TestZcodeOverSSHWithPerHostEndpoints 75.1s

受理现在是瞬时的 ⇒ 内核工具不会再 60s 超时。
2026-10-18 06:39:24 +08:00

215 lines
7.2 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#!/usr/bin/env node
// commondev sidecar:把一个 pi 会话包成可反复 prompt 的 JSON-RPC 服务。
//
// 协议(与 clawhubadapter 同形):
// stdin 请求 {"jsonrpc":"2.0","id":N,"method":"prompt","params":{...}}
// stdout 应答 {"jsonrpc":"2.0","id":N,"result":{...}}
//
// 方法:
// ping 握手,返回 pi 版本与会话 cwd
// prompt 投递一条消息给会话(★ 同一进程内,会话天然连续)
// state 查当前会话状态(session_id / 消息数)
//
// 设计依据(均已在本机实测):
// · createAgentSession({cwd}) 可精确指定工作目录与会话,且同会话可连续追问
// · 会话库用 sessionDir 与工作区隔离,不污染用户 ~/.pi
// · 内层 pi 靠 PI_CODING_AGENT_DIR 用插件自己的 agent dir
import { createRequire } from "node:module";
import { createInterface } from "node:readline";
const require = createRequire(import.meta.url);
function parseArgs(argv) {
const out = {};
for (let i = 0; i < argv.length; i++) {
const a = argv[i];
if (a === "--workdir") out.workdir = argv[++i];
else if (a === "--session-id") out.sessionId = argv[++i];
else if (a === "--session-name") out.sessionName = argv[++i];
}
return out;
}
const args = parseArgs(process.argv.slice(2));
const workdir = args.workdir || process.cwd();
const sessionId = args.sessionId || undefined;
// U6:会话列表里的可读名(pi 侧仅作标注,不参与身份识别)。
const sessionName = args.sessionName || undefined;
// pi 的 SDK 从宿主安装位置解析;随包分发时走 runtime/node_modules。
let mod;
try {
mod = await import("@earendil-works/pi-coding-agent");
} catch (e) {
// 回退:用环境里已装的 pi(PI_WEB / 系统安装)
const fallback =
"/usr/lib/node_modules/@jmfederico/pi-web/node_modules/@earendil-works/pi-coding-agent/dist/index.js";
mod = await import(fallback);
}
const { createAgentSession, SessionManager } = mod;
// piVersion 从模块导出或 package.json 取(U8:内层 pi 版本必须可回显、可锁定)。
// 取不到就是取不到 —— 返回 null 让 Go 侧如实记录,不编一个版本号。
let piVersion = mod.version ?? mod.VERSION ?? null;
try {
const url = import.meta.resolve
? import.meta.resolve("@earendil-works/pi-coding-agent/package.json")
: null;
if (url) {
const meta = await import(url, { with: { type: "json" } }).catch(() => null);
piVersion = meta?.default?.version ?? piVersion;
}
} catch {}
let session;
let started = false;
// inflight 是**已受理但未完成**的 prompt 数(异步投递后用于观测与优雅退出判断)
let inflight = 0;
async function ensureSession() {
if (session) return session;
// ★ 必须用 SessionManager.create(cwd, sessionDir, {id}) **显式指定会话 id**。
//
// 为何不能只靠 createAgentSession({cwd}):那样 pi 会**自己生成一个 UUID**
// 作为会话 id,与 Go 侧台账记的 session_id 不一致 —— 于是
// “投递后断言会话未变”这条纪律会拿两个不同的名字去比,永远失败
//(实测:期望 br-cdtest-feat_alpha,实际 01a13959-bcc3-7007-…)。
//
// 而用固定 id 建 manager,则:① 首次投递建会话;② 重启/重投时
// SessionManager 能打开**同一个**会话文件 ⇒ “续投同一会话”是真保障,不是运气。
const sessionDir = process.env.PI_CODING_AGENT_SESSION_DIR || undefined;
const manager = sessionId
? SessionManager.create(workdir, sessionDir, { id: sessionId })
: SessionManager.create(workdir, sessionDir);
const { session: s } = await createAgentSession({
cwd: workdir,
sessionManager: manager,
});
session = s;
started = true;
return session;
}
function send(obj) {
process.stdout.write(JSON.stringify(obj) + "\n");
}
async function handle(method, params) {
switch (method) {
case "ping": {
await ensureSession();
return {
ok: true,
cwd: workdir,
session_id: sessionId || null,
messages: Array.isArray(session?.messages) ? session.messages.length : 0,
// U8:把内层 pi 版本回显给 Go 侧(台账记录 + agent_up 回显)
pi_version: piVersion,
session_name: sessionName || null,
};
}
case "prompt": {
const text = params?.text ?? "";
const want = params?.session_id || sessionId;
const s = await ensureSession();
// ★★ 投递语义(2026-10-17 修):立即返回"已受理",不等 pi 跑完。
//
// 原实现是 `await s.prompt(text)` —— 同步等整个任务结束再返回。
// 而 pi 开工程线干活(克隆/改代码/跑测试)要几十秒到几分钟,
// 于是内核的 60s 工具超时先到,用户看到「执行超时(60秒)」,
// 而任务其实还在正常跑。通道的语义是"**投递**任务",不是"等完成"。
//
// 现在:prompt 在后台跑;跑完后用 **主动通知**(id=0)把结果推回
// Go 侧,由 deliverToPi 注册的 onNotify 注入回 agent(走 inputch)。
const got = s.sessionId ?? s.id ?? want ?? null;
// 记录在途数量,供 state 查询
inflight++;
(async () => {
try {
await s.prompt(text);
const reply = s.getLastAssistantText ? s.getLastAssistantText() : "";
send({
jsonrpc: "2.0",
id: 0, // ★ 0 = 主动通知(Go 侧 readLoop 按此分派)
result: {
event: "prompt_done",
session_id: s.sessionId ?? s.id ?? got ?? null,
reply: String(reply || "").slice(0, 4000),
},
});
} catch (e) {
send({
jsonrpc: "2.0",
id: 0,
result: {
event: "prompt_error",
session_id: got,
error: String((e && e.message) || e),
},
});
} finally {
inflight--;
}
})();
return {
ok: true,
status: "accepted", // ★ 明确:已受理,未完成
// ★ 必须回报 session_id:Go 侧据此断言「会话漂移」
session_id: got,
};
}
case "state": {
const s = await ensureSession();
return {
ok: true,
session_id: s.sessionId ?? sessionId ?? null,
messages: Array.isArray(s.messages) ? s.messages.length : 0,
};
}
case "close": {
try {
session?.dispose?.();
} catch {}
return { ok: true };
}
default:
throw new Error(`unknown method: ${method}`);
}
}
const rl = createInterface({ input: process.stdin });
rl.on("line", async (line) => {
line = line.trim();
if (!line) return;
let req;
try {
req = JSON.parse(line);
} catch {
return; // 非协议行,忽略
}
try {
const result = await handle(req.method, req.params || {});
send({ jsonrpc: "2.0", id: req.id, result });
if (req.method === "close") process.exit(0);
} catch (e) {
send({
jsonrpc: "2.0",
id: req.id,
error: { code: -32000, message: String(e?.message || e) },
});
}
});
rl.on("close", () => {
try {
session?.dispose?.();
} catch {}
process.exit(0);
});