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>
177 lines
4.6 KiB
Go
177 lines
4.6 KiB
Go
package main
|
||
|
||
// 随包 skill 打包的判据。
|
||
//
|
||
// 约定(与 rawfile/ 平行但**意图不同**):
|
||
//
|
||
// skill/<name>/SKILL.md 每个子目录一个 skill,登记给 skillmgr
|
||
// skill/<name>/skill.json
|
||
//
|
||
// 为什么与 rawfile 分开:内核需要知道**哪些是要注册的**。
|
||
// 靠子路径名猜(rawfile/skills/)是隐式约定,本仓为此吃过亏。
|
||
|
||
import (
|
||
"archive/zip"
|
||
"os"
|
||
"path/filepath"
|
||
"strings"
|
||
"testing"
|
||
)
|
||
|
||
// mkSkillProject 造一个带 skill/ 的工程。
|
||
func mkSkillProject(t *testing.T, files map[string]string) string {
|
||
t.Helper()
|
||
root := t.TempDir()
|
||
for rel, content := range files {
|
||
p := filepath.Join(root, rel)
|
||
if err := os.MkdirAll(filepath.Dir(p), 0o755); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if err := os.WriteFile(p, []byte(content), 0o644); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}
|
||
return root
|
||
}
|
||
|
||
// ★★ 判据:skill/ 下的每个目录被打包,**保留路径**。
|
||
func TestCollectSkillFiles(t *testing.T) {
|
||
root := mkSkillProject(t, map[string]string{
|
||
"skill/alpha/SKILL.md": "# alpha",
|
||
"skill/alpha/skill.json": `{"name":"alpha"}`,
|
||
"skill/beta/SKILL.md": "# beta",
|
||
"skill/beta/references/note.md": "# ref", // 子目录也要保留
|
||
"rawfile/some/data.bin": "x", // 不该被 skill 收集器收
|
||
})
|
||
ents, err := collectSkillFiles(root)
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
got := map[string]bool{}
|
||
for _, e := range ents {
|
||
got[e.zip] = true
|
||
}
|
||
for _, want := range []string{
|
||
"skill/alpha/SKILL.md",
|
||
"skill/alpha/skill.json",
|
||
"skill/beta/SKILL.md",
|
||
"skill/beta/references/note.md",
|
||
} {
|
||
if !got[want] {
|
||
t.Errorf("缺条目 %s(实际 %v)", want, keys(got))
|
||
}
|
||
}
|
||
// 不得收 rawfile 下的东西
|
||
for z := range got {
|
||
if !strings.HasPrefix(z, "skill/") {
|
||
t.Errorf("★ 收到了 skill/ 之外的条目: %s", z)
|
||
}
|
||
}
|
||
}
|
||
|
||
// ★ 判据:**没有 skill/ 目录是常态**,不报错、返回空。
|
||
func TestNoSkillDirIsFine(t *testing.T) {
|
||
root := mkSkillProject(t, map[string]string{"rawfile/x.txt": "x"})
|
||
ents, err := collectSkillFiles(root)
|
||
if err != nil {
|
||
t.Fatalf("无 skill/ 不应报错: %v", err)
|
||
}
|
||
if len(ents) != 0 {
|
||
t.Errorf("应返回空,实际 %d", len(ents))
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:skill/ 下放**文件**要报错(几乎肯定是放错了)。
|
||
//
|
||
// 静默跳过会让"我加的 skill 没生效"变成无提示的谜题。
|
||
func TestFileInSkillDirIsRejected(t *testing.T) {
|
||
root := mkSkillProject(t, map[string]string{
|
||
"skill/stray.md": "# 我放错了",
|
||
"skill/ok/SKILL.md": "# ok",
|
||
})
|
||
_, err := collectSkillFiles(root)
|
||
if err == nil {
|
||
t.Fatal("★ skill/ 下的文件应报错(不静默跳过)")
|
||
}
|
||
if !strings.Contains(err.Error(), "rawfile/") {
|
||
t.Errorf("错误应指出正确去处(rawfile/): %v", err)
|
||
}
|
||
}
|
||
|
||
// ★ 判据:脚手架不被打包。
|
||
func TestSkillScaffoldExcluded(t *testing.T) {
|
||
root := mkSkillProject(t, map[string]string{
|
||
"skill/.gitignore": "x",
|
||
"skill/alpha/.gitkeep": "",
|
||
"skill/alpha/SKILL.md": "# a",
|
||
})
|
||
ents, err := collectSkillFiles(root)
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
for _, e := range ents {
|
||
if IsRawFileScaffold(e.zip) {
|
||
t.Errorf("★ 脚手架被打包: %s", e.zip)
|
||
}
|
||
}
|
||
}
|
||
|
||
// ★★ 判据:真正的 zip 里条目名保留完整路径。
|
||
func TestSkillEntriesInZip(t *testing.T) {
|
||
root := mkSkillProject(t, map[string]string{
|
||
"skill/commondev-discipline/SKILL.md": "# 纪律",
|
||
})
|
||
ents, err := collectSkillFiles(root)
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
out := filepath.Join(t.TempDir(), "t.hmap")
|
||
f, _ := os.Create(out)
|
||
w := zip.NewWriter(f)
|
||
if err := writeRawEntries(w, ents); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
w.Close()
|
||
f.Close()
|
||
|
||
zr, err := zip.OpenReader(out)
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
defer zr.Close()
|
||
found := false
|
||
for _, zf := range zr.File {
|
||
if zf.Name == "skill/commondev-discipline/SKILL.md" {
|
||
found = true
|
||
}
|
||
}
|
||
if !found {
|
||
t.Error("★ zip 里未保留 skill 的目录结构")
|
||
}
|
||
}
|
||
|
||
// ★ 判据:摘要报的是 **skill 个数**(不是文件数)。
|
||
func TestSkillSummaryCountsSkillsNotFiles(t *testing.T) {
|
||
root := mkSkillProject(t, map[string]string{
|
||
"skill/a/SKILL.md": "x",
|
||
"skill/a/references/r.md": "x",
|
||
"skill/b/SKILL.md": "x",
|
||
})
|
||
ents, _ := collectSkillFiles(root)
|
||
sum := skillFilesSummary(ents)
|
||
if !strings.Contains(sum, "2 个 skill") {
|
||
t.Errorf("摘要应按 skill 数计(2 个),实际: %s", sum)
|
||
}
|
||
if !strings.Contains(sum, "3 个文件") {
|
||
t.Errorf("摘要应同时给出文件数: %s", sum)
|
||
}
|
||
}
|
||
|
||
func keys(m map[string]bool) []string {
|
||
var o []string
|
||
for k := range m {
|
||
o = append(o, k)
|
||
}
|
||
return o
|
||
}
|