mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 14:27:30 +00:00
feat(commondev): 主管式多仓库开发流水线 + sidecar 后端抽象(pi/zcode) (#3)
* 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>
This commit is contained in:
@ -9,6 +9,9 @@ import (
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"sort"
|
||||
|
||||
pubsdk "github.com/JianFeeeee/homeagentsdk/sdk"
|
||||
"strings"
|
||||
)
|
||||
|
||||
@ -256,8 +259,24 @@ func buildBundle(plg *PlgConfig, outDir string, sdkPath string) {
|
||||
writePluginJSON(plg, plats, procEntryFile)
|
||||
|
||||
// package single .hmap with correctly named entries
|
||||
//
|
||||
// rawfile:工程根 rawfile/ 默认全收 + plg.json 声明的外部路径。
|
||||
// 收集失败即**整包失败**(少资源就是个坏包,却仍会产出 .hmap 让人以为成功)。
|
||||
raws, rerr := collectRawFiles(".", plg.RawFiles)
|
||||
if rerr != nil {
|
||||
fmt.Printf(" error: rawfiles: %v\n", rerr)
|
||||
return
|
||||
}
|
||||
// 随包 skill(skill/ 目录,与 rawfile/ 平行;见 skills.go)
|
||||
skills, serr := collectSkillFiles(".")
|
||||
if serr != nil {
|
||||
fmt.Printf(" error: skill: %v\n", serr)
|
||||
return
|
||||
}
|
||||
hmapPath := filepath.Join(outDir, fmt.Sprintf("%s_bundle.hmap", toSnake(plg.NameEn)))
|
||||
createBundleHmap(hmapPath, "plugin.json", binaries)
|
||||
// skill 与 rawfile 用同一个写入路径(都是"保留路径"的条目),
|
||||
// 但分开收集以便分别报错与摘要。
|
||||
createBundleHmap(hmapPath, "plugin.json", binaries, append(raws, skills...))
|
||||
fmt.Printf(" packaged %s\n", filepath.Base(hmapPath))
|
||||
}
|
||||
|
||||
@ -343,6 +362,23 @@ func writePluginJSON(plg *PlgConfig, platforms []string, entry string) {
|
||||
if len(plg.Proxies) > 0 {
|
||||
m["proxies"] = plg.Proxies
|
||||
}
|
||||
// ★ 启动时机声明**必须透传**(与 proxies 同一类"漏了插件作者会静默踩坑"):
|
||||
// 内核读 plugin.json 的 requires_facilities 决定"何时拉起该插件"。
|
||||
// 不透传 ⇒ 插件照常装上运行,但启动时机与作者预期不符,**无任何提示**。
|
||||
if len(plg.RequiresFacilities) > 0 {
|
||||
// 打包期校验:名字必须是内核已知设施(拼错在打包时报错,
|
||||
// 而不是让用户装上一个"永不等不到就绪"因而**永不启动**的插件)。
|
||||
if bad := unknownFacilities(plg.RequiresFacilities); len(bad) > 0 {
|
||||
fmt.Printf(" error: requires_facilities 含内核未知的设施名 %v(已知: %v)\n",
|
||||
bad, pubsdk.KnownFacilities())
|
||||
return
|
||||
}
|
||||
m["requires_facilities"] = plg.RequiresFacilities
|
||||
}
|
||||
// auto_start:只有**显式 false** 才写(缺省 true 与旧行为一致,不写字段最兼容)
|
||||
if plg.AutoStart != nil && !*plg.AutoStart {
|
||||
m["auto_start"] = false
|
||||
}
|
||||
data, _ := json.MarshalIndent(m, "", " ")
|
||||
os.WriteFile("plugin.json", data, 0644)
|
||||
}
|
||||
@ -711,7 +747,17 @@ func buildTarget(plg *PlgConfig, target, outDir, sdkPath string) {
|
||||
}
|
||||
}
|
||||
hmapName := fmt.Sprintf("%s_%s_%s.hmap", toSnake(plg.NameEn), cfg.goos, cfg.goarch)
|
||||
createHmap(filepath.Join(outDir, hmapName), pkgFiles)
|
||||
raws, rerr := collectRawFiles(".", plg.RawFiles)
|
||||
if rerr != nil {
|
||||
fmt.Printf(" error: rawfiles: %v\n", rerr)
|
||||
return
|
||||
}
|
||||
skills, serr := collectSkillFiles(".")
|
||||
if serr != nil {
|
||||
fmt.Printf(" error: skill: %v\n", serr)
|
||||
return
|
||||
}
|
||||
createHmapWithRaw(filepath.Join(outDir, hmapName), pkgFiles, append(raws, skills...))
|
||||
fmt.Printf(" packaged %s\n", hmapName)
|
||||
}
|
||||
|
||||
@ -723,7 +769,7 @@ type binEntry struct {
|
||||
// createBundleHmap 创建包含多平台二进制的 bundle .hmap 文件。
|
||||
// jsonName 是 plugin.json 在 zip 中的条目名;
|
||||
// binaries 的 src 为磁盘路径,zip 为 zip 中的条目名。
|
||||
func createBundleHmap(hmapPath, jsonName string, binaries []binEntry) {
|
||||
func createBundleHmap(hmapPath, jsonName string, binaries []binEntry, raws []rawEntry) {
|
||||
f, err := os.Create(hmapPath)
|
||||
if err != nil {
|
||||
fmt.Printf("error: create hmap %s: %v\n", hmapPath, err)
|
||||
@ -773,6 +819,27 @@ func createBundleHmap(hmapPath, jsonName string, binaries []binEntry) {
|
||||
writeZipEntry(fname, fname)
|
||||
}
|
||||
}
|
||||
|
||||
// ★ rawfile:非代码资源(**保留路径**,与 writeZipEntry 的扁平化不同)
|
||||
if len(raws) > 0 {
|
||||
if err := writeRawEntries(w, raws); err != nil {
|
||||
fmt.Printf("error: 写入 rawfiles 失败: %v\n", err)
|
||||
return
|
||||
}
|
||||
if sum := rawFilesSummary(raws); sum != "" {
|
||||
fmt.Printf(" 已打包 %s\n", sum)
|
||||
}
|
||||
// skill 单独一行(与 rawfile 分开报,便于判断"我加的 skill 进去了吗")
|
||||
var skillOnly []rawEntry
|
||||
for _, e := range raws {
|
||||
if strings.HasPrefix(e.zip, SkillZipPrefix+"/") {
|
||||
skillOnly = append(skillOnly, e)
|
||||
}
|
||||
}
|
||||
if sum := skillFilesSummary(skillOnly); sum != "" {
|
||||
fmt.Printf(" 已打包 %s\n", sum)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func createHmap(hmapPath string, files []string) {
|
||||
@ -813,6 +880,49 @@ func createHmap(hmapPath string, files []string) {
|
||||
}
|
||||
}
|
||||
|
||||
// createHmapWithRaw 是 createHmap 的 rawfile 版本(保留路径)。
|
||||
func createHmapWithRaw(hmapPath string, files []string, raws []rawEntry) {
|
||||
f, err := os.Create(hmapPath)
|
||||
if err != nil {
|
||||
fmt.Printf("error: create hmap %s: %v\n", hmapPath, err)
|
||||
return
|
||||
}
|
||||
defer f.Close()
|
||||
w := zip.NewWriter(f)
|
||||
defer w.Close()
|
||||
for _, path := range files {
|
||||
if path == "" {
|
||||
continue
|
||||
}
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
hdr, err := zip.FileInfoHeader(info)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
hdr.Method = zip.Deflate
|
||||
hdr.Name = filepath.Base(path)
|
||||
writer, err := w.CreateHeader(hdr)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
src, err := os.Open(path)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
io.Copy(writer, src)
|
||||
src.Close()
|
||||
}
|
||||
if len(raws) > 0 {
|
||||
if err := writeRawEntries(w, raws); err != nil {
|
||||
fmt.Printf("error: 写入 rawfiles 失败: %v\n", err)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func toSnake(s string) string {
|
||||
return strings.ToLower(strings.ReplaceAll(s, " ", "_"))
|
||||
}
|
||||
@ -942,3 +1052,23 @@ func sdkHasInjectPriority(sdkPath string) bool {
|
||||
}
|
||||
return strings.Contains(seg, "Priority")
|
||||
}
|
||||
|
||||
// unknownFacilities 返回**内核未知**的设施名(打包期校验,防拼错)。
|
||||
//
|
||||
// ★ 为什么在打包期校验而不是留给内核:拼错的后果是插件**永不启动**
|
||||
// (永远等不到那个名字就绪),且内核侧此前无任何报错。在这里报错时
|
||||
// 用户还没装它,代价最小。
|
||||
func unknownFacilities(declared []string) []string {
|
||||
known := map[string]bool{}
|
||||
for _, f := range pubsdk.KnownFacilities() {
|
||||
known[f] = true
|
||||
}
|
||||
var bad []string
|
||||
for _, f := range declared {
|
||||
if !known[f] {
|
||||
bad = append(bad, f)
|
||||
}
|
||||
}
|
||||
sort.Strings(bad)
|
||||
return bad
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user