mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 06:17:25 +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>
185 lines
5.7 KiB
Go
185 lines
5.7 KiB
Go
package main
|
||
|
||
// 凭据存储:**保留的通用部分**。
|
||
//
|
||
// ## 2026-10-15 架构调整(用户拍板)
|
||
//
|
||
// **git 托管平台专有的部分已移出插件**(`platformSpec` / `account_*` 工具 /
|
||
// 角色语义 / 按平台构造认证头)—— 那些是**平台知识**,进 skill 由 agent
|
||
// 用 `safeshell` + `curl` 操作。理由:每接一个托管平台都要改 Go 代码、
|
||
// 重编译、重启服务,而平台差异只是「API 前缀 + 认证头」两个维度的不同。
|
||
//
|
||
// **本文件保留的是与平台无关的部分**:
|
||
// · 凭据的加密落盘(AES-256-GCM,自持密钥)
|
||
// · `${ENV_VAR}` 变量引用解析
|
||
// · 「不泄漏值」的展示形态
|
||
//
|
||
// 平台的用法见 skill `commondev-discipline`(含 Gitea/GitHub/GitLab/Gitee
|
||
// 的认证头对照表、PR 与分支保护的 curl 命令、以及三个实测踩到的 API 坑)。
|
||
|
||
import (
|
||
"encoding/json"
|
||
"fmt"
|
||
"os"
|
||
"path/filepath"
|
||
"regexp"
|
||
"strings"
|
||
"sync"
|
||
)
|
||
|
||
// Account 是一条凭据。
|
||
//
|
||
// ★ 已移除 `Platform` / `Role` / `BaseURL` 等**平台语义**字段:
|
||
// 本插件不再按平台构造请求,也不再有「执行侧/主管侧」的角色区分 ——
|
||
// 那是平台侧的(分支保护)与 skill 侧的知识。
|
||
type Account struct {
|
||
Name string `json:"name"`
|
||
// Token 是**旧路径**:明文或 `${ENV_VAR}` 引用。
|
||
// ★ 新登记会立即加密进 Sealed,本字段随即清空(见 sealAllLocked)。
|
||
// 本字段**绝不出现在任何工具返回值里**(见 redacted)。
|
||
Token string `json:"token,omitempty"`
|
||
// Sealed 是 AES-256-GCM 加密后的凭据(base64,nonce 前置)。
|
||
//
|
||
// 为何要加密:文件虽 0600,但会被备份、打包、随日志外带;
|
||
// 加密后即使文件外泄,没有密钥也不可用。
|
||
Sealed string `json:"sealed,omitempty"`
|
||
// Username 仅用于 git 提交身份(可选)。
|
||
Username string `json:"username,omitempty"`
|
||
Email string `json:"email,omitempty"`
|
||
Note string `json:"note,omitempty"`
|
||
CreatedAt string `json:"created_at"`
|
||
}
|
||
|
||
// credentialsFile 是磁盘上的凭据集合(独立文件,0600)。
|
||
type credentialsFile struct {
|
||
Accounts map[string]*Account `json:"accounts"`
|
||
}
|
||
|
||
// varRefPattern 匹配 ${VAR} 或 $VAR 形式的变量引用。
|
||
var varRefPattern = regexp.MustCompile(`\$\{([A-Za-z_][A-Za-z0-9_]*)\}|\$([A-Za-z_][A-Za-z0-9_]*)`)
|
||
|
||
// credStore 是凭据管理器(与 Plugin 同生命周期)。
|
||
type credStore struct {
|
||
mu sync.Mutex
|
||
path string
|
||
data credentialsFile
|
||
|
||
// keyProvider 返回加密密钥(由 Plugin 注入)。
|
||
keyProvider func() ([]byte, error)
|
||
}
|
||
|
||
func newCredStore(path string) (*credStore, error) {
|
||
cs := &credStore{path: path, data: credentialsFile{Accounts: map[string]*Account{}}}
|
||
b, err := os.ReadFile(path)
|
||
if err != nil {
|
||
if os.IsNotExist(err) {
|
||
return cs, nil
|
||
}
|
||
return nil, err
|
||
}
|
||
// ★ 启动时校验权限:凭据文件必须 0600(本仓纪律:响亮失败,不静默降级)
|
||
if fi, err := os.Stat(path); err == nil {
|
||
if perm := fi.Mode().Perm(); perm != 0o600 {
|
||
return nil, fmt.Errorf(
|
||
"凭据文件权限不安全:%s 是 %04o,必须是 0600(它是能 push 用户仓库的凭据)",
|
||
path, perm)
|
||
}
|
||
}
|
||
if err := json.Unmarshal(b, &cs.data); err != nil {
|
||
return nil, fmt.Errorf("凭据文件损坏(拒绝静默重建): %w", err)
|
||
}
|
||
if cs.data.Accounts == nil {
|
||
cs.data.Accounts = map[string]*Account{}
|
||
}
|
||
return cs, nil
|
||
}
|
||
|
||
// saveLocked 写入并确权(调用方持锁)。
|
||
func (cs *credStore) saveLocked() error {
|
||
b, err := json.MarshalIndent(cs.data, "", " ")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
tmp := cs.path + ".tmp"
|
||
if err := os.WriteFile(tmp, b, 0o600); err != nil {
|
||
return err
|
||
}
|
||
if err := os.Chmod(tmp, 0o600); err != nil {
|
||
return err
|
||
}
|
||
return os.Rename(tmp, cs.path)
|
||
}
|
||
|
||
// resolveSecret 把凭据里的变量引用解析成实际值。
|
||
//
|
||
// 返回错误的情形(都不静默降级):
|
||
// - 引用了未设置的环境变量
|
||
// - 解析结果为空
|
||
func resolveSecret(raw string) (string, error) {
|
||
raw = strings.TrimSpace(raw)
|
||
if raw == "" {
|
||
return "", fmt.Errorf("凭据为空")
|
||
}
|
||
var missing []string
|
||
out := varRefPattern.ReplaceAllStringFunc(raw, func(m string) string {
|
||
name := m
|
||
if strings.HasPrefix(m, "${") {
|
||
name = m[2 : len(m)-1]
|
||
} else {
|
||
name = m[1:]
|
||
}
|
||
v, ok := os.LookupEnv(name)
|
||
if !ok || v == "" {
|
||
missing = append(missing, name)
|
||
return ""
|
||
}
|
||
return v
|
||
})
|
||
if len(missing) > 0 {
|
||
return "", fmt.Errorf(
|
||
"凭据引用的环境变量未设置: %s —— 请在插件进程的环境里提供它(不静默当空串,"+
|
||
"否则会退化成匿名访问、表现成 401 而非“凭据没配”)",
|
||
strings.Join(missing, ", "))
|
||
}
|
||
if strings.TrimSpace(out) == "" {
|
||
return "", fmt.Errorf("凭据解析后为空")
|
||
}
|
||
return out, nil
|
||
}
|
||
|
||
// redacted 返回凭据的可安全展示形态:**绝不暴露 secret**。
|
||
func (a *Account) redacted() map[string]interface{} {
|
||
out := map[string]interface{}{
|
||
"name": a.Name,
|
||
"username": a.Username,
|
||
"token_ref": tokenRefLabel(a.Token),
|
||
"token_set": a.Sealed != "" || strings.TrimSpace(a.Token) != "",
|
||
}
|
||
if a.Note != "" {
|
||
out["note"] = a.Note
|
||
}
|
||
if a.Sealed != "" {
|
||
out["storage"] = "encrypted(AES-256-GCM)"
|
||
} else {
|
||
out["storage"] = "plaintext-or-envref"
|
||
}
|
||
return out
|
||
}
|
||
|
||
// tokenRefLabel 描述凭据来源但**不泄露值**。
|
||
func tokenRefLabel(raw string) string {
|
||
raw = strings.TrimSpace(raw)
|
||
if raw == "" {
|
||
return ""
|
||
}
|
||
if varRefPattern.MatchString(raw) {
|
||
return raw // ${VAR} 是引用不是秘密,展示它对排查有用
|
||
}
|
||
return "(明文已设置)"
|
||
}
|
||
|
||
// credentialsPath 是凭据文件路径(与台账同目录)。
|
||
func (p *Plugin) credentialsPath() string {
|
||
return filepath.Join(filepath.Dir(p.path), "credentials.json")
|
||
}
|