mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-31 06:17:25 +00:00
0111ac3a7a
## 核心缺陷：插件往 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` +§协议通道纪律（正误代码对比）
79 lines
2.8 KiB
Go
79 lines
2.8 KiB
Go
package sdk
|
|
|
|
type SettingsAPI interface {
|
|
// Get reads the plugin's own config value (config_<name> table).
|
|
Get(key string) (interface{}, error)
|
|
|
|
// Set writes a config value to the plugin's own config table.
|
|
Set(key string, value interface{}) error
|
|
|
|
// SetSecret writes a value that is ALWAYS encrypted at rest, regardless of
|
|
// the key name. Use it when the key name is neutral (e.g. "blob", "conn")
|
|
// and so cannot be detected as sensitive automatically.
|
|
//
|
|
// Returns an error (not a silent plaintext write) when no master key is
|
|
// installed — a plugin that believes it stored a secret must not end up
|
|
// with plaintext on disk.
|
|
//
|
|
// The companion read is GetSecret. ConfigDef.Secret/Type=="password" and
|
|
// sensitive key names are encrypted automatically and do NOT need this.
|
|
SetSecret(key string, value interface{}) error
|
|
|
|
// GetSecret reads a value written by SetSecret (transparently decrypted).
|
|
GetSecret(key string) (string, error)
|
|
|
|
// List returns all keys matching the given prefix.
|
|
List(prefix string) ([]string, error)
|
|
|
|
// GetCore reads the core config table.
|
|
GetCore(key string) (interface{}, error)
|
|
|
|
// SetCore writes to the core config table.
|
|
SetCore(key string, value interface{}) error
|
|
|
|
// ListCore lists core config keys matching the prefix.
|
|
ListCore(prefix string) ([]string, error)
|
|
|
|
// DataDir returns the plugin-specific data directory (guaranteed to exist):
|
|
// <daemon data>/plugin_data/<plugin_name>. Plugins should persist any
|
|
// runtime files (generated images, caches, downloads) here.
|
|
DataDir() string
|
|
|
|
// GetPlugin reads another plugin's config table.
|
|
GetPlugin(plugin, key string) (interface{}, error)
|
|
|
|
// SetPlugin writes to another plugin's config table.
|
|
SetPlugin(plugin, key string, value interface{}) error
|
|
|
|
// ListPlugin lists another plugin's config keys matching the prefix.
|
|
ListPlugin(plugin, prefix string) ([]string, error)
|
|
|
|
// RegisterDef registers a config definition for UI display.
|
|
RegisterDef(def ConfigDef)
|
|
|
|
// Defs returns config definitions matching the prefix.
|
|
Defs(prefix string) []*ConfigDef
|
|
|
|
// Dump returns all config values.
|
|
Dump() map[string]interface{}
|
|
|
|
// Plugins returns a list of all plugin config namespaces.
|
|
Plugins() []string
|
|
}
|
|
|
|
// ConfigDef describes a configuration field for the WebUI.
|
|
type ConfigDef struct {
|
|
Key string `json:"key"`
|
|
Default interface{} `json:"default,omitempty"`
|
|
Type string `json:"type"`
|
|
DisplayName string `json:"display_name"`
|
|
Description string `json:"description,omitempty"`
|
|
Category string `json:"category,omitempty"`
|
|
Options []string `json:"options,omitempty"`
|
|
Min float64 `json:"min,omitempty"`
|
|
Max float64 `json:"max,omitempty"`
|
|
Step float64 `json:"step,omitempty"`
|
|
Required bool `json:"required,omitempty"`
|
|
Secret bool `json:"secret,omitempty"`
|
|
}
|