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>
223 lines
8.6 KiB
Go
223 lines
8.6 KiB
Go
package main
|
||
|
||
// 「投到指定目录的指定 session」的判据。
|
||
//
|
||
// 用户问的是这句话能不能成立。成立的前提是**地址唯一确定一条线**:
|
||
// branch_id → 工作目录(program/<hash>-<name>)
|
||
// → pi session(SessionID)
|
||
// → 一对通道(InputCh / OutputCh)
|
||
//
|
||
// 这四者必须一一对应,且**不能被两条线共享**。共享的任何一环都会让
|
||
// "投到指定 session"变成"投到某一条(不确定)"。
|
||
//
|
||
// 最危险的一环是唯一性:独立 clone 没有 worktree 的
|
||
// 「同分支不可双挂」保护(git 会拒绝),所以插件必须自己补闸。
|
||
// 设计 §4.3 明确写了这条,但**此前没有判据钉住它**。
|
||
|
||
import (
|
||
"os"
|
||
"path/filepath"
|
||
"strings"
|
||
"testing"
|
||
)
|
||
|
||
// newTestPluginForAddr 造一个只做台账的 Plugin(不碰网络/进程)。
|
||
//
|
||
// ★ ledger.json 放在 t.TempDir() **之外**的独立临时目录:
|
||
// branch_open 会把 clone 转后台 goroutine(runPrepareWorkdir),
|
||
// 而它会在 programRoot() 下建目录 —— 与 t.TempDir() 的清理构成竞态
|
||
// (实测报 "TempDir RemoveAll cleanup: directory not empty")。
|
||
// 用 os.MkdirTemp + 手动清理可以让清理发生在 goroutine 之后。
|
||
func newTestPluginForAddr(t *testing.T) *Plugin {
|
||
t.Helper()
|
||
dir, err := os.MkdirTemp("", "cdaddr")
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
t.Cleanup(func() { os.RemoveAll(dir) })
|
||
p := newTestPluginForShell(t)
|
||
p.path = filepath.Join(dir, "ledger.json")
|
||
p.ledger = &Ledger{
|
||
Projects: map[string]*Project{},
|
||
Branches: map[string]*Branch{},
|
||
Jobs: map[string]*Job{},
|
||
Criteria: map[string]*Criteria{},
|
||
}
|
||
return p
|
||
}
|
||
|
||
// ★★★ 判据:同名分支不能开两条未结的工程对话(唯一性闸)。
|
||
//
|
||
// 这是"投到指定 session"的**前提**:若同一个 branch_id 能对应两条线,
|
||
// 或者两条线共用同一个地址,寻址就不再唯一。
|
||
//
|
||
// ★ 独立 clone 丢掉了 git 的天然保护:worktree 模式下同一分支被两棵
|
||
// worktree 挂载时 git 直接 `fatal: 'feat/a' is already used`,
|
||
// 而独立 clone 完全没有这层拦截 —— 必须由插件补,否则两条线会
|
||
// 各自改各自的目录然后互相覆盖。
|
||
func TestDuplicateBranchIsRejected(t *testing.T) {
|
||
p := newTestPluginForAddr(t)
|
||
p.ledger.Projects["proj"] = &Project{Name: "proj", RemoteURL: "/tmp/x", DefaultBranch: "main"}
|
||
|
||
// 第一次开:应成功
|
||
r1, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat/a"})
|
||
m1, _ := r1.(map[string]interface{})
|
||
if m1["status"] != "ok" {
|
||
t.Fatalf("首次开分支应成功: %v", m1)
|
||
}
|
||
id1, _ := m1["branch_id"].(string)
|
||
if id1 == "" {
|
||
t.Fatal("应返回 branch_id")
|
||
}
|
||
|
||
// 第二次开同一个分支:应被唯一性闸拒绝
|
||
r2, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat/a"})
|
||
m2, _ := r2.(map[string]interface{})
|
||
if _, isErr := m2["error"]; !isErr {
|
||
t.Fatalf("★ 同名分支被允许开第二条(唯一性闸失效): %v", m2)
|
||
}
|
||
if !strings.Contains(m2["error"].(string), "唯一性闸") {
|
||
t.Errorf("拒绝理由应指明唯一性闸: %v", m2["error"])
|
||
}
|
||
|
||
// 台账里必须只有一条
|
||
if n := len(p.ledger.Branches); n != 1 {
|
||
t.Errorf("★ 台账里应只有 1 条分支,实际 %d", n)
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:**已结**的分支可以重开(闸只挡"未结"的)。
|
||
//
|
||
// 闸太严会让"合入后想再改同一个分支名"变成不可能 ——
|
||
// 而那是正常做法(分支已 merged,重开一条新的同名线是合理的)。
|
||
func TestClosedBranchCanBeReopened(t *testing.T) {
|
||
p := newTestPluginForAddr(t)
|
||
p.ledger.Projects["proj"] = &Project{Name: "proj", RemoteURL: "/tmp/x", DefaultBranch: "main"}
|
||
|
||
r1, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat/b"})
|
||
id1 := r1.(map[string]interface{})["branch_id"].(string)
|
||
|
||
// 标记为已合入
|
||
p.ledger.Branches[id1].Status = "merged"
|
||
|
||
// 重开应成功
|
||
r2, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat/b"})
|
||
m2, _ := r2.(map[string]interface{})
|
||
if m2["status"] != "ok" {
|
||
t.Fatalf("已结分支应可重开: %v", m2)
|
||
}
|
||
// 但 id 相同 ⇒ 会覆盖旧台账项;这本身是设计取舍,只断言不报错
|
||
}
|
||
|
||
// ★★ 判据:review 状态同样算"未结"(不能趁复核期再开一条同类线)。
|
||
func TestReviewStatusStillBlocksDuplicate(t *testing.T) {
|
||
p := newTestPluginForAddr(t)
|
||
p.ledger.Projects["proj"] = &Project{Name: "proj", RemoteURL: "/tmp/x", DefaultBranch: "main"}
|
||
r1, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat/c",
|
||
"work_desc": "x"})
|
||
id1 := r1.(map[string]interface{})["branch_id"].(string)
|
||
p.ledger.Branches[id1].Status = "review"
|
||
|
||
r2, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat/c"})
|
||
if _, isErr := r2.(map[string]interface{})["error"]; !isErr {
|
||
t.Errorf("★ review 状态应算未结,但被允许重开")
|
||
}
|
||
}
|
||
|
||
// ★★★ 判据:地址四元组**一一对应**且互不共享。
|
||
//
|
||
// branch_id 必须唯一映射到 一个目录 + 一个 session + 一对通道。
|
||
// 任意两条线共用其中任何一项,寻址就不唯一("投到指定 session"退化为
|
||
// "投到某一条")。
|
||
func TestAddressTupleIsUniquePerBranch(t *testing.T) {
|
||
p := newTestPluginForAddr(t)
|
||
p.ledger.Projects["proj"] = &Project{Name: "proj", RemoteURL: "/tmp/x", DefaultBranch: "main"}
|
||
// 造两条不同的线
|
||
for _, br := range []string{"feat/x", "feat/y"} {
|
||
r, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": br})
|
||
if _, isErr := r.(map[string]interface{})["error"]; isErr {
|
||
t.Fatalf("开 %s 失败: %v", br, r)
|
||
}
|
||
}
|
||
if len(p.ledger.Branches) != 2 {
|
||
t.Fatalf("应有 2 条线,实际 %d", len(p.ledger.Branches))
|
||
}
|
||
|
||
seenDir := map[string]string{}
|
||
seenID := map[string]bool{}
|
||
for id, b := range p.ledger.Branches {
|
||
if seenID[id] {
|
||
t.Errorf("★ branch_id 重复: %s", id)
|
||
}
|
||
seenID[id] = true
|
||
if b.Workdir == "" {
|
||
t.Errorf("★ %s 没有工作目录", id)
|
||
}
|
||
// 目录不能共享
|
||
if prev, dup := seenDir[b.Workdir]; dup {
|
||
t.Errorf("★ 两条线共用同一目录: %s(%s 与 %s)—— 投到目录无法区分线", b.Workdir, prev, id)
|
||
}
|
||
seenDir[b.Workdir] = id
|
||
}
|
||
|
||
// ★ 关键:不同分支名必须得到不同目录(设计 §4.3 的目录映射不变式)
|
||
r1, _ := p.handleBranchOpen(map[string]interface{}{"project": "proj", "branch": "feat.z"})
|
||
_ = r1
|
||
// feat.z 与 feat/z 派生后 slug 相同,但目录 hash 含原始分支名 ⇒ 目录不同
|
||
d1 := branchDir(p.programRoot(), "proj", "feat/z")
|
||
d2 := branchDir(p.programRoot(), "proj", "feat.z")
|
||
if d1 == d2 {
|
||
t.Errorf("★ feat/z 与 feat.z 得到了同一目录 %s —— 两条线会互相覆盖", d1)
|
||
}
|
||
if filepath.Base(d1) == filepath.Base(d2) {
|
||
t.Errorf("★ 目录基名相同 %s,说明 hash 没把分支名纳入", filepath.Base(d1))
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:投递必须打到**该 id 自己的**通道。
|
||
//
|
||
// deliverToPi 从台账取 SessionID;通道名由 id 派生。
|
||
// 若两条线的通道名撞了,内核路由就会把任务投到错的那条 pi。
|
||
func TestChannelNamesAreUniquePerBranch(t *testing.T) {
|
||
names := map[string]string{}
|
||
for _, id := range []string{
|
||
"br-proj-feat_a", "br-proj-feat_b", "br-other-feat_a",
|
||
} {
|
||
in := inputChannelName(id)
|
||
out := outputChannelName(id)
|
||
for _, n := range []string{in, out} {
|
||
if prev, dup := names[n]; dup {
|
||
t.Errorf("★ 通道名冲突 %q(%s 与 %s)—— 投递会打到错的后端", n, prev, id)
|
||
}
|
||
names[n] = id
|
||
}
|
||
// outputch 不能含斜杠(会拼成 output_send__<name>)
|
||
if strings.Contains(out, "/") {
|
||
t.Errorf("★ outputch 含斜杠: %q(output_send__ 名不允许)", out)
|
||
}
|
||
// 上游要求 ^[a-zA-Z0-9_-]{1,64}$
|
||
if !validNamePattern.MatchString(out) || len(out) > 64 {
|
||
t.Errorf("outputch %q 不合规(须匹配 ^[a-zA-Z0-9_-]{1,64}$)", out)
|
||
}
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:**会话漂移必须响亮失败**(不静默改投新会话)。
|
||
//
|
||
// 这是"投到指定 session"的守门人:如果 pi 返回了不同的 session_id
|
||
// 而插件默默接受,任务就投到了另一条会话 —— 而调用方以为投到了指定的那条。
|
||
func TestSessionDriftIsRejectedNotSilentlyAccepted(t *testing.T) {
|
||
b, err := os.ReadFile("plugin.go")
|
||
if err != nil {
|
||
t.Skip("读不到 plugin.go")
|
||
}
|
||
src := string(b)
|
||
if !strings.Contains(src, "会话漂移") {
|
||
t.Fatal("★ deliverToPi 缺少会话漂移检查")
|
||
}
|
||
// 必须**拒绝**而不是记录后继续
|
||
if !strings.Contains(src, "拒绝继续") {
|
||
t.Error("★ 会话漂移应明确拒绝,而非仅记录")
|
||
}
|
||
}
|