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 条「判据本身的判据」(防止判据假绿)。
* fix(sdk): 协议通道纪律 + hmapdev 模板升级 + 示例插件 stdout 污染
## 核心缺陷:插件往 stdout 打日志 = 污染 JSON-RPC 协议通道
子进程插件与内核用 stdout 传 NDJSON 帧,stderr 才是日志通道。
脚手架模板(及 4 个示例插件)用 `fmt.Printf` 打日志 ⇒ 内核收到非 JSON 文本:
[proc] weather 收到非法 JSON 帧(21 字节): invalid character 'i'
**生产实测 1038 条**(huawei_smarthome 720 / weather 113 / rss 103 / calendar 102)。
后果不只是日志噪音:那一行日志被**丢弃**,插件看起来"没启动"。
修法:
- hmapdev 模板 `fmt.Printf` → `log.Printf`(9 处)
- 示例插件 4 个 14 处:ai_image(2) calendar(5) rss(4) weather(3)
+ 补 "log" import
- 内核侧(主仓)同步让报错可定位:内容摘要 + 可能原因 + 修法
判别法:`package main` = 子进程(协议通道,禁用 stdout 打日志);
普通库包 = 进程内插件(编译进内核,写真实终端,**不是**缺陷)——
`internal/plugins/cli` 的 `fmt.Println` 属后者。
## hmapdev
- `cmd_build.go` +136:平台产物精确匹配(`--target` 是**append** 语义,
原脚本 `ls dist/*.hmap | head -1` 会按字典序抓到 amd64,
**导致 arm64 包里装的是 x86-64 二进制**,且退出码 0、校验和通过)
- `cmd_init.go` +46:脚手架 stdio 纪律
- `templates/proc_main.go.tmpl`:补齐 mgrStop/mgrStart/mgrIsRuntimeStopped
三态能力(插件管理器运行态停启)
- `templates/plg.json.tmpl` 删除(合并进 cmd_init)
## 判据
- `scaffold_stdout_test.go`(3 条):扫模板生成的代码不得写 stdout。
★ 判据自身先假红过一次:**模板的注释里就写了 `fmt.Printf`** ⇒
必须 `stripTemplateComments()` 之后才判
- `example_stdout_test.go`(2 条):扫全部 20 个子进程示例插件,
报错给**文件:行号**;变异咬住并给出准确行号
- `package_examples_test.go`(2 条):**执行真实打包脚本**
(第一版测的是 hmapdev 而不是脚本 ⇒ 变异不咬)
- `cmd_build` / `cmd_init` 新判据
## 其他
- sdk/settings.go +15(三态能力透传)
- `docs/versions.md` +§示例插件协议通道纪律(含生产 1038 条实测表格)
- `skills/homeagent-plugin-dev/SKILL.md` +§协议通道纪律(正误代码对比)
* fix(examples): 恢复 go.mod 相对路径 + 移除 plg.json 的 sdk 固定(修 CI 红)
CI 上 `Examples (linux/amd64)` 与 `(darwin/arm64)` 双红,只有两个失败:
✗ commondev 构建失败
✗ editdoc 构建失败
error: 项目声明 sdk=1.4.0,但本地 SDK 存储里没有这个版本
其余 20 个示例全部成功 —— 说明不是通用问题,而是这两个被改坏了。
## 根因(两个叠加)
**① go.mod 被本机绝对路径污染**
我在上一个提交里用 `git add -A`,把本机 `go build` **自动改写**过的
go.mod 一并提交了:
require github.com/JianFeeeee/homeagentsdk v1.4.0
replace github.com/JianFeeeee/homeagentsdk => /root/.homeagent/hmapdev/sdk/v1.4.0
基线(origin/main)是:
require github.com/JianFeeeee/homeagentsdk v0.0.0
replace github.com/JianFeeeee/homeagentsdk => ../../
本机那个目录真的存在 ⇒ 本地全绿;CI 没有 ⇒ 必红。
**② plg.json 声明了 `"sdk": "1.4.0"`**
一声明版本,hmapdev 就去**本地 SDK store** 找它,找不到直接拒绝构建。
全仓 20+ 示例**都不声明**,只有我改过的这两个声明了。
示例的正确依赖表达是 go.mod 的 `v0.0.0` + `replace ../../`。
## 修法
两个文件都恢复到与其余示例一致的写法。
## 判据(3 条,都是新加的)
· `TestExampleGoModHasNoAbsoluteReplace`:任何示例 go.mod 不得含
`/root/`、`/home/`、`/Users/`、`C:\`
· `TestExampleGoModUsesRelativeSDKReplace`:replace 必须是相对路径 `../../`
· `TestExamplePlgJsonDoesNotPinSDKVersion`:plg.json 不得声明 sdk
变异 2/2 咬住(重新引入绝对路径 / 重新声明 sdk,都准确报出文件路径)。
## 本地验证(模拟 CI 干净环境)
用干净 HOME 跑 `package/build-examples.sh`:
· 修复前:成功 18 / 失败 4(commondev, editdoc, browser, rss)
· 修复后:成功 20 / 失败 2(browser, rss —— **本机代理不通**,
`proxy.golang.org` 超时;用本地 modcache 验证这两个可正常构建)
即 22/22 源码都能构建,CI 有网络不受影响。
## 教训
`git add -A` 会把「构建工具自动改写的文件」一起提交。
提交前必须 `git status` 逐个看,尤其 go.mod / go.sum。
---------
Co-authored-by: JianFeeeee <JianFeeeee@users.noreply.gitcode.com>
174 lines
5.6 KiB
JavaScript
174 lines
5.6 KiB
JavaScript
#!/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;
|
||
|
||
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();
|
||
await s.prompt(text);
|
||
const got = s.sessionId ?? s.id ?? want ?? null;
|
||
return {
|
||
ok: true,
|
||
// ★ 必须回报 session_id:Go 侧据此断言「会话漂移」
|
||
session_id: got,
|
||
reply: s.getLastAssistantText ? s.getLastAssistantText() : "",
|
||
};
|
||
}
|
||
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);
|
||
});
|