mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 14:27:30 +00:00
81a3efa4df
* 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>
190 lines
8.7 KiB
Bash
190 lines
8.7 KiB
Bash
#!/usr/bin/env bash
|
||
# 给 SDK 发版打包**示例插件**的 .hmap 产物。
|
||
#
|
||
# 为什么要在 SDK 仓库里发示例插件的 hmap：
|
||
# 插件二进制与内核是**协议绑定**的（internal/plugin/proc/protocol.go 的
|
||
# ProtocolVersion + 统一共享内存区魔数）。SDK 升版往往同时意味着协议变化，
|
||
# 而示例插件（qq/memo/browser/…）是使用者最常直接安装的东西。
|
||
# 如果 SDK 只发工具链不发示例产物，使用者要么自己重编、要么用到与本版 SDK
|
||
# 不匹配的旧产物——后者的表现是握手失败（协议/魔数不匹配），而且看起来像
|
||
# 「插件坏了」而不是「版本不配套」。
|
||
#
|
||
# 用法：
|
||
# package/build-examples.sh [TARGET] [OUT_DIR]
|
||
# TARGET native(默认) | linux/amd64 | linux/arm64 | darwin/amd64 | darwin/arm64 | windows/amd64 | all
|
||
# OUT_DIR 产物目录（默认 build/examples）
|
||
#
|
||
# 产物：
|
||
# <OUT_DIR>/<name>_<goos>_<goarch>.hmap 每个示例插件一份
|
||
# <OUT_DIR>/SHA256SUMS 全部产物齐全**之后**才计算
|
||
# <OUT_DIR>/MANIFEST.txt 版本、协议版本、产自哪个 commit
|
||
#
|
||
# 纪律（与本项目其它构建脚本一致）：
|
||
# 1. 判成功看**产物是否存在**，不看退出码——hmapdev 对部分错误只打印不退出。
|
||
# 2. SHA256SUMS 必须在全部产物生成完毕后一次算完，边打边算会漏掉后生成的包。
|
||
set -uo pipefail
|
||
|
||
SDK_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
|
||
TARGET="${1:-native}"
|
||
OUT_DIR="${2:-$SDK_ROOT/build/examples}"
|
||
GO="${GO:-$(command -v go 2>/dev/null || echo go)}"
|
||
|
||
case "$TARGET" in
|
||
native) GOOS=""; GOARCH="" ;;
|
||
linux/amd64) GOOS=linux; GOARCH=amd64 ;;
|
||
linux/arm64) GOOS=linux; GOARCH=arm64 ;;
|
||
darwin/amd64) GOOS=darwin; GOARCH=amd64 ;;
|
||
darwin/arm64) GOOS=darwin; GOARCH=arm64 ;;
|
||
windows/amd64)
|
||
# 明确拒绝，而不是让调用方拿到一句深层 Go 编译错误。
|
||
# 协议 2 的统一共享内存区只移植到了 Unix：内核 internal/plugin/proc/
|
||
# shmpass_windows.go 仍是旧的 SHM_STAGE/SHM_EVTRING 两段布局，
|
||
# 插件模板 proc_shm_windows.go 也缺 attachUnifiedShm。
|
||
echo "windows 目标暂不支持：协议 2 的统一共享内存区未移植到 Windows（内核与插件模板均缺实现）。" >&2
|
||
exit 1
|
||
;;
|
||
all)
|
||
echo "本脚本一次只构建一个平台；请由 package/build.sh 传入具体目标。" >&2
|
||
exit 1
|
||
;;
|
||
*)
|
||
echo "Unknown target: $TARGET" >&2
|
||
echo "Usage: $0 [native|linux/amd64|linux/arm64|darwin/amd64|darwin/arm64|windows/amd64|all] [OUT_DIR]" >&2
|
||
exit 1
|
||
;;
|
||
esac
|
||
|
||
export CGO_ENABLED=0
|
||
|
||
# 按平台逐个构建，**不用** bundle 模式：
|
||
# - bundle 会连 windows 一起编，而协议 2 的统一共享区尚未移植到 Windows
|
||
# （内核 shmpass_windows.go 仍是旧的两段布局），必然失败；
|
||
# - 逐平台构建每个目标都产出一份 .hmap，正是发版要附的产物。
|
||
# 平台名解析成本脚本后面用（校验和与 MANIFEST 都要写清楚是哪个平台）。
|
||
if [ -z "${GOOS:-}" ]; then
|
||
GOOS="$(go env GOOS)"; GOARCH="$(go env GOARCH)"
|
||
fi
|
||
|
||
# 1) 先保证工具链可用：示例必须用**本仓当前源码**构建，否则产物协议与这一版 SDK 不符。
|
||
# 允许外部指定（发版脚本会在跨平台构建后把刚产出的工具链路径传进来）。
|
||
# 工具链二进制名由 plugindev 改为 hmapdev；旧变量名 PLUGINDEV 仍兼容。
|
||
#
|
||
# ★ 下面三处必须读 **HMAPDEV**（上一行刚解析出的规范名）。
|
||
# 曾经读的是 PLUGINDEV：那样只有调用方恰好传旧名时才工作，
|
||
# 而新名 HMAPDEV 只被赋给 HMAPDEV 本身、PLUGINDEV 仍是未定义，
|
||
# 在 `set -u` 下第一处判断就 "PLUGINDEV: unbound variable" 直接退出。
|
||
# 实测（2026-09-29）：HMAPDEV=... → exit 1；PLUGINDEV=... → 20/20 成功。
|
||
# 发版路径传的是旧名（build.sh:92）故一直没暴露——正是「兼容」二字
|
||
# 写在注释里、却没在代码里做到的那种缺陷。
|
||
HMAPDEV="${HMAPDEV:-${PLUGINDEV:-$SDK_ROOT/build/hmapdev}}"
|
||
if [ ! -x "$HMAPDEV" ]; then
|
||
echo "[examples] 先构建 hmapdev ..."
|
||
( cd "$SDK_ROOT/tools/hmapdev" && "$GO" build -o "$HMAPDEV" . ) || {
|
||
echo "[examples] hmapdev 构建失败，无法继续" >&2; exit 1; }
|
||
fi
|
||
if [ ! -x "$HMAPDEV" ]; then
|
||
echo "[examples] hmapdev 不存在或不可执行：$HMAPDEV" >&2
|
||
exit 1
|
||
fi
|
||
|
||
echo "=== 协议 ==="
|
||
echo " ProtocolVersion = $(grep -m1 '^const ProtocolVersion' "$SDK_ROOT/../internal/plugin/proc/protocol.go" 2>/dev/null | grep -oE '[0-9]+' || echo '?（本仓非内核仓，跳过）')"
|
||
|
||
mkdir -p "$OUT_DIR"
|
||
# 清掉上一次的校验和：残留的 SHA256SUMS 会掩盖本次缺产物。
|
||
rm -f "$OUT_DIR"/SHA256SUMS "$OUT_DIR"/MANIFEST.txt
|
||
|
||
ok=0
|
||
fail=0
|
||
failed_names=""
|
||
|
||
for dir in "$SDK_ROOT"/example/*/; do
|
||
# ★ 入口判据：Go 插件是 plugin.go，**Lua 插件是 main.lua**。
|
||
#
|
||
# 原判据只有 `[ -f plugin.go ]` ⇒ **Lua 插件被静默跳过**
|
||
# （实测：luademo 是 Lua 插件，entry=main.lua，不产 .hmap 也不报错，
|
||
# 发版产物就少一个插件而没人发现）。改为认两种入口。
|
||
#
|
||
# 用 plg.json 的 entry 做最终判定更准，但**入口文件存在性**足以区分
|
||
# "这是不是一个插件工程"；真正的入口名由 hmapdev 从 plg.json 读。
|
||
if [ ! -f "$dir/plugin.go" ] && [ ! -f "$dir/main.lua" ]; then
|
||
continue
|
||
fi
|
||
name="$(basename "$dir")"
|
||
|
||
# 清掉旧产物：残留会让人（和本脚本）误判成功。
|
||
rm -rf "$dir/build" "$dir/dist"
|
||
|
||
out=$( cd "$dir" && "$HMAPDEV" build --no-bundle --target "$GOOS/$GOARCH" 2>&1 )
|
||
rc=$?
|
||
|
||
# 判据是**退出码 + 产物存在**，两者都要。
|
||
# 只看退出码：hmapdev 曾经出错也退 0（已修，但脚本不该依赖它「现在」是对的）。
|
||
# 只看产物：部分平台失败时会留下上一次的产物，看起来像成功。
|
||
#
|
||
# ★★ 必须挑**本次目标平台**的产物，不能取 `head -1`。
|
||
#
|
||
# ## 为什么（实测缺陷，2026-10-17）
|
||
#
|
||
# `--target` 的语义是**追加**（docs/guide/multi-platform.md 明确写「追加一个目标」），
|
||
# 而示例的 plg.json 普遍声明 `targets: "linux/amd64"`。于是
|
||
# `build --no-bundle --target linux/arm64` 会**同时**产出
|
||
# `..._linux_amd64.hmap` 与 `..._linux_arm64.hmap`。
|
||
#
|
||
# 原代码取 `ls | head -1` ⇒ **按文件名字典序拿到 amd64 那份**
|
||
# ⇒ 打 arm64 包时实际装进去的是 **x86-64 二进制**，
|
||
# 而文件名却写着 `linux_arm64_...`（**文件名与内容不符**）。
|
||
# 实测：arm64 产物 `plugin.bin` 的 ELF machine = 0x003e（x86-64，应为 0x00b7=aarch64）。
|
||
# 这种包在 arm64 机器上只会以 "Exec format error" 失败，而排查方向会被文件名带偏。
|
||
#
|
||
# ⇒ 精确匹配 `<name>_<goos>_<goarch>.hmap`；匹配不到则视为失败（不静默退回任意产物）。
|
||
hmap="$(ls "$dir"/dist/*_"${GOOS}_${GOARCH}".hmap 2>/dev/null | head -1)"
|
||
if [ -z "$hmap" ]; then
|
||
# Lua 插件的产物名是 <name>_lua.hmap（无平台后缀，Lua 不编译）。
|
||
hmap="$(ls "$dir"/dist/*_lua.hmap 2>/dev/null | head -1)"
|
||
fi
|
||
if [ $rc -eq 0 ] && [ -n "$hmap" ]; then
|
||
# 保留插件自己声明的产物名（它用的是 plg.json 的 name_en，是插件的身份），
|
||
# 只在前面加平台前缀避免多平台互相覆盖。
|
||
dest="$OUT_DIR/${GOOS}_${GOARCH}_$(basename "$hmap")"
|
||
cp "$hmap" "$dest"
|
||
printf "✓ %-14s → %s (%s)\n" "$name" "$(basename "$dest")" "$(du -h "$dest" | cut -f1)"
|
||
ok=$((ok + 1))
|
||
else
|
||
printf "✗ %-14s 构建失败 (rc=%d)\n" "$name" "$rc"
|
||
echo "$out" | tail -6 | sed 's/^/ /'
|
||
fail=$((fail + 1))
|
||
failed_names="$failed_names $name"
|
||
fi
|
||
done
|
||
|
||
echo
|
||
echo "示例产物: 成功 $ok / 失败 $fail"
|
||
[ -n "$failed_names" ] && echo "失败:$failed_names"
|
||
|
||
# 有失败就不算发版闭环：宁可整个中断，也不要发出「少几个插件」的包。
|
||
if [ $fail -ne 0 ]; then
|
||
echo "[examples] 有示例构建失败，不生成 SHA256SUMS" >&2
|
||
exit 1
|
||
fi
|
||
|
||
# 2) 全部产物齐了才算校验和。
|
||
( cd "$OUT_DIR" && sha256sum ./*.hmap > SHA256SUMS )
|
||
|
||
VERSION="${VERSION:-$(git -C "$SDK_ROOT" describe --tags --dirty 2>/dev/null || echo unknown)}"
|
||
COMMIT="${COMMIT:-$(git -C "$SDK_ROOT" rev-parse --short HEAD 2>/dev/null || echo unknown)}"
|
||
{
|
||
echo "sdk_version: $VERSION"
|
||
echo "sdk_commit: $COMMIT"
|
||
echo "target: $GOOS/$GOARCH"
|
||
echo "plugins: $ok"
|
||
echo "built_at: $(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
||
echo
|
||
echo "这些 .hmap 与本版 SDK 的插件协议绑定，必须与同版本内核配套安装。"
|
||
echo "校验：sha256sum -c SHA256SUMS"
|
||
} > "$OUT_DIR/MANIFEST.txt"
|
||
|
||
echo "[examples] 产物: $OUT_DIR"
|
||
echo "[examples] 清单: $OUT_DIR/MANIFEST.txt"
|
||
echo "[examples] 校验: $OUT_DIR/SHA256SUMS"
|