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` +§协议通道纪律(正误代码对比)
This commit is contained in:
JianFeeeee
2026-10-17 16:34:29 +08:00
parent c2474f57a2
commit 0111ac3a7a
36 changed files with 5059 additions and 227 deletions

View File

@ -8,6 +8,37 @@ description: 开发、安装、调试 HomeAgent 插件。涉及 hmapdev 工具
> 本机(192.168.2.60)HomeAgent 的插件工具链手册。**所有命令都实测过**,
> 不是从文档抄的。改了本机环境后请回来更正。
## ★ 协议通道纪律:插件**绝不能**往 stdout 打印(高频踩坑)
子进程插件的 **stdout 是 JSON-RPC 协议通道**,**stderr 才是日志通道**
(SDK 侧已 `log.SetOutput(os.Stderr)`)。
```go
// ❌ 错误:写进 stdout ⇒ 内核收到裸文本 ⇒ 报「非法 JSON 帧」并**丢弃这行日志**
fmt.Printf("[%s] started\n", p.name)
// ✅ 正确:log 默认走 stderr,且会被内核收进插件日志
log.Printf("[%s] started", p.name)
```
**症状**(很容易误判成内核/协议故障):
```
[proc] myplugin 收到非法 JSON 帧(19 字节): invalid character 'm' looking for beginning of value
↑ 内容摘要: [myplugin] started
可能原因:插件往 **stdout** 打印了日志,而 stdout 是JSON-RPC **协议通道**(stderr 才是日志通道)。
修法:把插件里的 fmt.Printf/fmt.Println 改成 log.Printf(脚手架模板 1.4.0 起已修正)。
```
看到这条就说明**是你自己 printf 了** —— 日志本身丢了,还多一条看起来像协议故障的报错。
**实测代价**:生产环境累计 **1038 条**这种报错(weather 113 / rss 103 /
calendar 102 / 第三方 720),定位真因花了一整轮排查。
**例外**:**进程内插件**(`plugin.RegisterFactory`,编译进内核)的
`fmt.Println` 写的是内核真实终端,**不是**缺陷。判别方法:
插件源码是不是 `package main`(子进程)还是普通的库包(进程内)。
## 0. 先搞清三件事,别猜
```bash
@ -84,16 +115,21 @@ hmapdev debug . # 不想装就能先跑一遍
### 注册工具的形状(照 example 写,别自创)
**★ `sdk.ToolDef` 里没有 `Handler` 字段** —— handler 是 `RegisterTool` 的**第三个参数**,
不是结构体成员。把 `Handler:` 写进结构体会**编译失败**(`unknown field Handler`)。
```go
s.RegisterTool(tp+"mytool", sdk.ToolDef{
Name: tp + "mytool", // ← Name 必填,且要放在结构体**首位**
Description: "……",
Parameters: map[string]interface{}{"type": "object", "properties": map[string]interface{}{}},
Handler: h.mytool,
NoMemory: true, // 声明字段一律放**末尾**,仿 NoMemory 的写法
}, s)
}, h.mytool) // ← handler 在这里,不在结构体内
```
(`ToolDef` 的全部字段:`Name` / `Plugin` / `Description` / `Parameters` / `NoMemory` /
`Cleaner` / `ContextPolicy` / `RecallPolicy` / `ParallelSafe` / `Serial`。)
**并发声明**(同轮多个 tool_call 时):
- `ParallelSafe: true` —— 可并发(**三个条件都满足才可声明**:handler 线程安全 /
@ -202,4 +238,39 @@ curl -s -H "X-API-Key: $K" http://127.0.0.1:8080/api/v1/status | grep -oE '"comm
- **不要手改生成的文档**:`docs/api/*.md` 由 `tools/apidoc/gensite` 生成,
首行写着「请勿手改」;要改就去改 `sdk/*.go` 的注释再重新生成。
- **不要在插件里硬编码 token / 密钥**:走 `Settings()` 或宿主注入。
### 7.1 敏感配置的落盘加密(用 `SetSecret` / `GetSecret`)
`SettingsAPI` 提供两个方法让插件**无需自己实现加密**(主密钥由内核统一管理):
```go
// 强制加密落盘(不看键名)—— 返回 error 表示内核没装主密钥,
// 此时**拒绝写入**而不是静默存明文;不要吞掉这个 error。
if err := s.Settings().SetSecret("blob", token); err != nil {
return err
}
// 读回(透明解密)
token, _ := s.Settings().GetSecret("blob")
```
**两条自动加密规则**(不写 `SetSecret` 也会加密):
1. `ConfigDef{Secret: true}` —— 推荐,意图最明确
2. `ConfigDef{Type: "password"}` —— 旧写法,兼容保留
3. 键名含 `password` / `secret` / `token` / `api_key` 等词段 —— 兜底
⚠️ 什么时候**必须**用 `SetSecret`:键名是中性的(如 `blob`、`conn`、`payload`),
键名模式猜不到 —— 那就显式声明。
⚠️ 不要自己实现加密:主密钥由内核统一管理(`<dataDir>/security.key` 或
`HOMED_SECURITY_KEY`),插件各自持钥会让密钥散落、无法轮换。
**注意**:`Secret` 字段在旧版本里就已存在但**从未生效**(内核侧的转换漏了它,
见内核仓 `docs/zh/kernel-secret-firewall-design.md` §5.1)。若你的插件声明了
`Secret: true` 却看到明文落盘,说明内核侧还没接通 —— 升级内核,或改用
`SetSecret`(若该方法不存在,就是内核版本过旧)。
⚠️ **升级须知**:`SetSecret`/`GetSecret` 是**接口新增方法**。它们只增不减,
所以插件**消费**侧不受影响;但如果你自己实现了 `SettingsAPI`(如自测替身),
需要补上这两个方法。
- **不要为了让插件生效去改 `homed` 的源码** —— 先确认它是不是内置插件。