mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 14:27:30 +00:00
feat(commondev): 主管式多仓库开发流水线 + sidecar 后端抽象(pi/zcode)
## 是什么
agent 统筹开发流程的插件:登记项目 → 开工程线(每条线一个隔离工作目录 +
一个 sidecar 子进程 + 一对通道)→ 投递任务 → 同会话续投 → 评审/合入。
38 个工具:project_*/branch_*/workdir_*/job_*/review_*/test_*/
endpoint_*/agent_*/pi_*/conflict_check。
## sidecar 后端抽象(本轮核心)
传输层(local/ssh)与后端(pi/zcode/自定义)**正交**,四个自由组合:
driver.json 描述一个后端:script / cliPath / env / args / llmConfig
三级查找:插件数据目录 → **随包 rawfile** → 内置 pi 描述
占位符:{workdir} {dataDir} {pluginDir} {rawfile} {sessionId}
★ 内置 pi 回退**与默认后端解耦**(2026-10-17 修):原实现写
`if cli == defaultAgentCLI { return builtinPiDriver() }`,把"给谁兜底"
和"默认选谁"耦合到同一常量 —— 一旦有人改默认,pi 当场失去兜底,
显式 cli="pi" 开始报「驱动不存在」。现在判断字面 "pi"。
默认后端保持 **pi**(我们本地主用);交付方用 zcode 走两种局部开关:
· 单线:commondev_branch_open(cli="zcode")
· 按机器:commondev_endpoint_set(host=..., cli="zcode")
## zcode 接入(三条真机判据,全部要求真改工程文件)
· TestZcodeFullPipeline(29-34s):随包 driver + 真实 ZCode CLI
· TestZcodeOverSSH(39s):真 ssh + scp,远端 node 跑 zcode
· TestZcodeOverSSHWithPerHostEndpoints(68s):两个 host 别名配不同
cli_path,走端点表而不是全局 settings
★ 会话库必须隔离到工作区(sidecar.mjs 的 ensureWorkspaceSessionStore):
实测 ZCode 的会话库路径**硬编码 homedir()**,`ZCODE_DATA_BASE_DIR` 对它
完全无效(26 个会话全落全局库)。但 `<workdir>/.zcode/config.json` 的
`storage.sessionDbPath` **确实生效**。所以启动前写一份工作区配置,
一举解决:多线不共用历史 / 不污染全局 ~/.zcode / 删线不留孤儿会话。
只在不存在时写 —— 用户手工放的要尊重。
## 其他
· rawfile:项目根 rawfile/ 默认全收,解到 <插件目录>/rawfile/,绝对路径拒绝
· 凭证:命名引用 + ${ENV_VAR},独立 0600 文件,绝不进 config.db(0644)
· secretshell:给不受信 agent 用的安全 shell(ackey + safeshell)
· 冲突检查 / 评审判据 / 镜像 / 每条线独立 workdir(hash 命名,合并后删除)
判据 30+ 条,含 4 条「判据本身的判据」(防止判据假绿)。
This commit is contained in:
22
example/commondev/examples/custom-cli/zcode/driver.json
Normal file
22
example/commondev/examples/custom-cli/zcode/driver.json
Normal file
@ -0,0 +1,22 @@
|
||||
{
|
||||
"name": "zcode",
|
||||
"script": "sidecar.mjs",
|
||||
"node": "auto",
|
||||
"sessionNameFlag": false,
|
||||
"sessionDirSuffix": ".zcode-sessions",
|
||||
"llmConfig": "none",
|
||||
"env": {
|
||||
"ZCODE_DATA_BASE_DIR": "{dataDir}/runtime/zcode",
|
||||
"ZCODE_SESSION_DIR": "{workdir}/.zcode-sessions"
|
||||
},
|
||||
"args": [
|
||||
"--workdir",
|
||||
"{workdir}",
|
||||
"--session-id",
|
||||
"{sessionId}",
|
||||
"--mode",
|
||||
"guarded"
|
||||
],
|
||||
"note": "llmConfig=none:ZCode 用自己的 provider 配置(插件不猜它的格式)。cliPath 支持占位符;{rawfile} 指随包资源目录 —— 把 zcode.cjs 放进 rawfile/zcode/ 即可随包分发。用户也可在 <插件数据>/runtime/zcode/driver.json 覆盖成本机真实路径。",
|
||||
"cliPath": "{rawfile}/zcode/zcode.cjs"
|
||||
}
|
||||
287
example/commondev/examples/custom-cli/zcode/sidecar.mjs
Normal file
287
example/commondev/examples/custom-cli/zcode/sidecar.mjs
Normal file
@ -0,0 +1,287 @@
|
||||
#!/usr/bin/env node
|
||||
// ZCode sidecar:把 **ZCode CLI** 包成与 pi sidecar **同一个 JSON-RPC 契约**的服务。
|
||||
//
|
||||
// ## 为什么必须同契约
|
||||
//
|
||||
// 插件的 `startSidecar` / `sc.call("prompt")` 是唯一的调用面 ——
|
||||
// 只要这个脚本实现 ping/prompt/state/close,**插件核心一行不用改**
|
||||
// 就能跑 ZCode。这就是「通过不同 sidecar 支持不同 CLI」的落点。
|
||||
//
|
||||
// ## 与 pi sidecar 的关键差异(实测契约,来自 agentmail/zcode-mail-bridge)
|
||||
//
|
||||
// pi sidecar ZCode sidecar
|
||||
// ──────────────────── ──────────────────────────────
|
||||
// 常驻进程 + prompt() **每轮起一个新进程**(CLI 是一次性的)
|
||||
// --session-id 建会话 --resume <id> 延续;首轮不给
|
||||
// SDK 直接返回文本 --output-format stream-json,末行 {type:"result"}
|
||||
// 无授权概念 --mode **必传**(不传 = yolo,绕过全部授权询问)
|
||||
//
|
||||
// ## 会话 id 的处理(★ 与插件的契约)
|
||||
//
|
||||
// 插件在 prompt 后**断言 session_id 未变**(防会话漂移)。
|
||||
// ZCode 首轮才产生真实 sessionId,所以这里:
|
||||
// · 首轮:把 CLI 返回的 sess_xxx 回报(插件接受它作为会话标识)
|
||||
// · 后续:用 --resume 传回去,并回报同一个 id
|
||||
//
|
||||
// ## 超时必须杀进程树
|
||||
//
|
||||
// ZCode 会派生工具子进程(bash 等)。只杀父进程会留下一堆孤儿继续跑,
|
||||
// 而且它们仍占着工作目录。
|
||||
|
||||
import { spawn } from "node:child_process";
|
||||
import { createInterface } from "node:readline";
|
||||
import { existsSync } from "node:fs";
|
||||
import path from "node:path";
|
||||
|
||||
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];
|
||||
else if (a === "--cli") out.cliPath = argv[++i];
|
||||
else if (a === "--mode") out.mode = argv[++i];
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
const args = parseArgs(process.argv.slice(2));
|
||||
const workdir = args.workdir || process.cwd();
|
||||
|
||||
// ★ mode 必须显式给:不传时 CLI 默认 **yolo**(源码 src/run.ts:
|
||||
// DEFAULT_HEADLESS_PROMPT_MODE),那会绕过全部授权询问。
|
||||
// 合法值:build | edit | plan | yolo | guarded。默认用 guarded。
|
||||
const VALID_MODES = ["build", "edit", "plan", "yolo", "guarded"];
|
||||
const mode = args.mode || process.env.ZCODE_MODE || "guarded";
|
||||
if (!VALID_MODES.includes(mode)) {
|
||||
throw new Error(`--mode 必须是 ${VALID_MODES.join("|")} 之一(收到 ${mode})`);
|
||||
}
|
||||
|
||||
// CLI 入口:驱动可经 --cli 指定,否则按常见安装位置找。
|
||||
//
|
||||
// ★ 返回 {path, tried} 而不是裸字符串:**必须知道路径是"声明的"还是"探测到的"**,
|
||||
// 才能在报错里说清楚该改哪里。
|
||||
//
|
||||
// 实测真缺陷(2026-10-16):随包 driver.json 声明了 `{rawfile}/zcode/zcode.cjs`,
|
||||
// 但包里**没有**这个文件(28MB,按需分发)。旧实现 `if (args.cliPath) return args.cliPath`
|
||||
// 直接把它当有效路径返回 ⇒ Node 在 spawn 时抛模块解析失败,用户看到的是一坨
|
||||
// `Module._resolveFilename` 堆栈,**完全看不出"CLI 不存在"**,更不知道去哪儿配。
|
||||
// 声明的路径同样必须验存。
|
||||
function findCLI() {
|
||||
const cands = [
|
||||
{ p: args.cliPath, source: "driver.json 的 cliPath" },
|
||||
{ p: process.env.ZCODE_CLI, source: "环境变量 ZCODE_CLI" },
|
||||
{ p: path.join(process.env.HOME || "", ".zcode/runtime/bin/zcode.mjs"), source: "默认探测" },
|
||||
{ p: "/opt/ZCode/resources/glm/zcode.cjs", source: "默认探测" },
|
||||
{ p: "/usr/local/bin/zcode", source: "默认探测" },
|
||||
];
|
||||
const tried = [];
|
||||
for (const c of cands) {
|
||||
if (!c.p) continue;
|
||||
tried.push(`${c.p}(${c.source})`);
|
||||
if (existsSync(c.p)) return { path: c.p, tried };
|
||||
}
|
||||
return { path: "", tried };
|
||||
}
|
||||
|
||||
// ★ 必须区分两个不同的东西:
|
||||
//
|
||||
// desiredSessionId —— 插件传进来的**标签**(br-<project>-<branch>),
|
||||
// 它是插件台账里的会话名,**不是** ZCode 的会话 id
|
||||
// zcodeSessionId —— ZCode 真实产出的 `sess_...`,只有它能用于 --resume
|
||||
//
|
||||
// 初版把 args.sessionId 直接当成 --resume 的目标,于是**首轮就带上
|
||||
// `--resume br-xxx`**,ZCode 报 `Session not found: br-xxx` ——
|
||||
// 表现为"第一次投递必定失败",而第二次才可能成功(如果插件把
|
||||
// 上一轮返回的 sess_... 传回来了)。
|
||||
//
|
||||
// 实测(2026-10-16):真实 ZCode 0.16.9 上首轮即失败。
|
||||
// 契约(参考实现在注释里也写了):**首轮不给 --resume**,
|
||||
// 从 `{type:"result"}` 行取回 sess_...,之后才用它续谈。
|
||||
let desiredSessionId = args.sessionId || "";
|
||||
let zcodeSessionId = "";
|
||||
let turnCount = 0;
|
||||
|
||||
function send(obj) {
|
||||
process.stdout.write(JSON.stringify(obj) + "\n");
|
||||
}
|
||||
|
||||
/** 杀**进程树**(ZCode 会派生工具子进程)。 */
|
||||
function killTree(child) {
|
||||
if (!child || child.killed) return;
|
||||
try {
|
||||
// 负号 = 进程组;spawn 时 detached 建了独立进程组。
|
||||
process.kill(-child.pid, "SIGTERM");
|
||||
} catch {
|
||||
try { child.kill("SIGTERM"); } catch {}
|
||||
}
|
||||
setTimeout(() => {
|
||||
try { process.kill(-child.pid, "SIGKILL"); } catch {}
|
||||
}, 3000).unref?.();
|
||||
}
|
||||
|
||||
/** 跑一轮 ZCode,返回 {sessionId, response}。 */
|
||||
function runTurn(text, timeoutMs) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const found = findCLI();
|
||||
if (!found.path) {
|
||||
reject(new Error(
|
||||
"找不到 ZCode CLI。已找过:\n - " + found.tried.join("\n - ") +
|
||||
"\n请把 driver.json 的 cliPath 指向真实 CLI(本机覆盖写到 " +
|
||||
"<插件数据>/runtime/zcode/driver.json),或设 ZCODE_CLI 环境变量。"));
|
||||
return;
|
||||
}
|
||||
const argv = [
|
||||
found.path,
|
||||
"--prompt", text,
|
||||
"--output-format", "stream-json",
|
||||
"--cwd", workdir,
|
||||
"--mode", mode,
|
||||
];
|
||||
// ★ 会话延续:首轮不给 --resume(还没有 id),后续都给。
|
||||
// ★ 只有拿到 ZCode 真实 id 才 resume;首轮没有 → 不传。
|
||||
if (zcodeSessionId) argv.push("--resume", zcodeSessionId);
|
||||
|
||||
const child = spawn(process.execPath, argv, {
|
||||
cwd: workdir,
|
||||
detached: true, // 独立进程组 ⇒ 能整组杀
|
||||
stdio: ["ignore", "pipe", "pipe"],
|
||||
});
|
||||
|
||||
let out = "";
|
||||
let err = "";
|
||||
let settled = false;
|
||||
const timer = setTimeout(() => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
killTree(child);
|
||||
reject(new Error(`ZCode 回合超时(${Math.round(timeoutMs / 1000)}s)`));
|
||||
}, timeoutMs);
|
||||
|
||||
child.stdout.on("data", (d) => { out += d.toString(); });
|
||||
child.stderr.on("data", (d) => { err += d.toString(); });
|
||||
|
||||
child.on("error", (e) => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
reject(e);
|
||||
});
|
||||
child.on("close", (code) => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
|
||||
// 逐行解析 stream-json:事件行随时来,末行是 {type:"result"}
|
||||
let result = null;
|
||||
let events = 0;
|
||||
for (const line of out.split("\n")) {
|
||||
const t = line.trim();
|
||||
if (!t || t[0] !== "{") continue;
|
||||
let obj;
|
||||
try { obj = JSON.parse(t); } catch { continue; }
|
||||
if (obj && obj.type === "result") result = obj;
|
||||
else events++;
|
||||
}
|
||||
if (!result) {
|
||||
reject(new Error(
|
||||
`ZCode 未返回 result 行(exit=${code},事件 ${events} 条)` +
|
||||
(err ? `;stderr: ${err.slice(-400)}` : "")));
|
||||
return;
|
||||
}
|
||||
resolve({
|
||||
sessionId: typeof result.sessionId === "string" && result.sessionId
|
||||
? result.sessionId
|
||||
: zcodeSessionId,
|
||||
response: typeof result.response === "string" ? result.response : "",
|
||||
events,
|
||||
});
|
||||
});
|
||||
|
||||
// 供 close 时中断当前回合
|
||||
currentChild = child;
|
||||
});
|
||||
}
|
||||
|
||||
let currentChild = null;
|
||||
|
||||
async function handle(method, params) {
|
||||
switch (method) {
|
||||
case "ping": {
|
||||
// 不启动 CLI:握手要快且确定(10s 上限)。
|
||||
// 报出 CLI 版本 —— 插件的 ping 处理会认 pi_version/cli_version/version 三者之一。
|
||||
return {
|
||||
ok: true,
|
||||
cwd: workdir,
|
||||
// 握手阶段还没有 ZCode 会话;报插件给我们的标签即可
|
||||
// (插件侧台账用它,真实 sess_... 在首轮 prompt 后才产生)。
|
||||
session_id: zcodeSessionId || desiredSessionId || null,
|
||||
cli_version: process.env.ZCODE_VERSION || null,
|
||||
session_name: args.sessionName || null,
|
||||
backend: "zcode",
|
||||
};
|
||||
}
|
||||
case "prompt": {
|
||||
const text = params?.text ?? "";
|
||||
// ★ params.session_id 是**插件的标签**(br-xxx),不是 ZCode 的会话 id。
|
||||
// 绝不能拿它当 --resume 目标 —— 那正是首轮必然失败的根因。
|
||||
// 只在还没有真实 id 时记下它,供握手/state 回报用。
|
||||
if (params?.session_id && !zcodeSessionId) {
|
||||
desiredSessionId = String(params.session_id);
|
||||
}
|
||||
const timeoutMs = Number(params?.timeout_ms) > 0
|
||||
? Number(params.timeout_ms)
|
||||
: 20 * 60 * 1000;
|
||||
const r = await runTurn(text, timeoutMs);
|
||||
// ★ 只在拿到真实 sess_... 时更新;空值不能覆盖已有 id
|
||||
// (否则一次失败就把续谈能力抹掉)。
|
||||
if (r.sessionId) zcodeSessionId = r.sessionId;
|
||||
turnCount++;
|
||||
return {
|
||||
ok: true,
|
||||
// ★ 必须回报 session_id:Go 侧据此断言「会话未漂移」
|
||||
// 报真实 id(有则报它,否则退回插件的标签)。
|
||||
session_id: zcodeSessionId || desiredSessionId || null,
|
||||
reply: r.response,
|
||||
};
|
||||
}
|
||||
case "state": {
|
||||
return {
|
||||
ok: true,
|
||||
session_id: zcodeSessionId || desiredSessionId || null,
|
||||
messages: turnCount,
|
||||
};
|
||||
}
|
||||
case "close": {
|
||||
killTree(currentChild);
|
||||
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", () => {
|
||||
killTree(currentChild);
|
||||
process.exit(0);
|
||||
});
|
||||
Reference in New Issue
Block a user