Files
homeagent-sdk/example/commondev/sidecar.mjs
JianFeeeee 28c162cf81 feat(commondev): 支持取消正在运行的任务(commondev_agent_interrupt)
## 缺陷(用户实测反馈)

「commondev 无法取消正在运行的 session,agent 反馈它无法取消错误的
pi session,只能等它跑完。」

日志佐证:agent 在 09:07 收到 interrupt 请求后只能如实回答无法取消。

## 根因不是"没实现取消",而是取消能力从来没被暴露

pi 的 AgentSession **本身就有** abort()(agent-session.d.ts:598,
"Abort current operation and wait for agent to become idle")。
但 commondev 注册的 30 个工具里一个 cancel/stop 都没有,
sidecar 也只有 ping/prompt/state/close 四个 method。

这是异步投递(2026-10-17)带来的新缺口:改动之前 prompt 是同步的,
调用方阻塞到任务结束,没有"中途要停"这个需求;改成异步投递后,
任务在后台长跑,用户却失去了停止它的手段。

## 改动

**sidecar 三个平台各有各的取消方式:**

	pi    → session.abort()(协作式中断,必须 await:不 await 会立刻
	        回"已中断"而实际还在跑 = 谎报成功)
	zcode → 整组杀掉当前回合的子进程(没有 abort API)
	        spawn 时 detached=true 建了独立进程组,killTree 整组杀

**interrupt 语义如实回报:**

	interrupted=true   确实有任务在跑并被终止
	interrupted=false  当时没有在跑的任务(不算错误)
	ok=false + error   该 CLI 没实现 / 调用失败

**三个收尾分支都清 currentChild**(timeout / error / close):
不清的话 interrupt 会拿到已死的子进程去杀,或更糟 —— 误杀下一轮。

## 判据(4 条 + 「不谎报」)

 · pi 的两个 sidecar 都有 interrupt 且用 await session.abort()
 · zcode 的 interrupt 真的 killTree 且用 currentChild
 · 三个 sidecar 无重复声明(我写的时候真撞了:zcode 已有 currentChild)
 · **不谎报成功**:sidecar 没跑 / CLI 没实现时必须 interrupted=false

## 变异验证

 pi 删 interrupt case → 咬
 pi 去掉 await         → 咬("会谎报已中断")
 zcode 不 killTree     → 咬("只回 ok 不真杀")

## 顺带

既有判据 TestEveryRegisteredToolHasHandler 立刻抓到我加了 RegisterTool
但没在 handlerFor 映射里登记 —— 它比我先发现漏了接线。
2026-10-18 10:17:08 +08:00

244 lines
8.7 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,
};
}
// ★★ interrupt:取消正在运行的任务(2026-10-18 新增)。
//
// 为什么必须有:prompt 改成异步投递后,Go 侧只能"发出去",无法收回。
// 实测后果 —— 用户发现派错了任务、或某个 session 卡住时,**没有任何办法
// 停下它**,只能等 pi 自己跑完(agent 在日志里如实回答"无法取消")。
//
// pi 的 AgentSession 本身有 abort():Abort current operation and wait
// for agent to become idle。这里直接用它,不自己造机制。
//
// 语义说明(必须如实回给调用方):
// · abort() 是**协作式**的:它在下一个可中断点生效,不是 SIGKILL。
// 工具调用中途可能还要一小段时间才真正停下。
// · 返回 interrupted=true 表示"已发出中断且会话已回到空闲";
// 若当时没有在跑的任务,interrupted=false 但 ok=true(不算错误)。
case "interrupt": {
if (!session) return { ok: true, interrupted: false, reason: "no_session" };
const hadInflight = inflight > 0;
try {
await session.abort();
} catch (e) {
return { ok: false, interrupted: false, error: String((e && e.message) || e) };
}
return {
ok: true,
interrupted: hadInflight,
// 如实报告剩余在途数:>0 说明还有任务在收尾(调用方可据此决定是否再等)
inflight,
};
}
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);
});