Files
HomeAgent/internal/sdk/settings_impl.go
HomeAgent Agent 9e6627f0c3 fix(config): 插件 def 查询不再越界 —— ListDefs 作用域 + 新增 ListCoreDefs
两个方向相反的越界,合起来把 WebUI 设置接口的 meta 撑成 5208 条(96% 重复):

1) PluginSettings.ListDefs(prefix) 把 prefix 直接透传给全局 ListDefs,
   等于「返回全仓所有 def」——调用方以为在问某个插件,实际拿到全部。
   修复:限定到 plugin.<name>. 命名空间,并把 Key 剥回插件内局部键
   (调用方看到的键必须与 Set/Get/ListPlugin 的局部键一致)。

2) DefsCore(prefix) → reg.ListDefs(prefix) 会连插件 def 一起返回,
   于是 meta 里出现 plugin.<name>.<key> 的「核心侧副本」。
   修复:新增 ConfigRegistry.ListCoreDefs,显式排除 plugin.* 命名空间。

生产实例实测(旧代码):GET /api/v1/settings 的 meta = 5208 条,
其中 core.agent.* 等每个 def 都被复制 28 份(每个插件命名空间一份),
并派生出 plugin.<a>.plugin.<b>.<key> 这类幻影键。

⚠️ 幻影键不只是脏数据:设置接口的 PUT 走 SplitN(key, ".", 3),
对 plugin.<a>.plugin.<b>.<key> 会解出 (a, "plugin.<b>.<key>"),
即按 UI 上的幻影条目保存会**写进错误插件的配置表**。

新增 TestPluginDefsAreNamespaced 钉住两条作用域。
2026-09-14 06:53:58 +08:00

195 lines
4.8 KiB
Go

package sdk
import (
"fmt"
"strings"
internalConfig "gitcode.com/JianFeeeee/HomeAgent/internal/config"
)
type settingsImpl struct {
pluginName string
reg *internalConfig.ConfigRegistry
dataDir string
}
func NewSettings(name string, reg *internalConfig.ConfigRegistry) SettingsAPI {
return &settingsImpl{pluginName: name, reg: reg}
}
// SetDataDir 注入本插件的数据目录(内核装配时调用)。
func (s *settingsImpl) SetDataDir(dir string) { s.dataDir = dir }
// DataDir 返回插件专属数据目录 <data>/plugin_data/<name>,保证目录存在。
func (s *settingsImpl) DataDir() string { return s.dataDir }
func (s *settingsImpl) Get(key string) (interface{}, error) {
if s.reg == nil {
return nil, nil
}
return s.reg.PluginConfig(s.pluginName).Get(key)
}
func (s *settingsImpl) Set(key string, value interface{}) error {
if s.reg == nil {
return nil
}
return s.reg.PluginConfig(s.pluginName).Set(key, value)
}
func (s *settingsImpl) Remove(key string) error {
if s.reg == nil {
return nil
}
return s.reg.PluginConfig(s.pluginName).Remove(key)
}
func (s *settingsImpl) RemoveCore(key string) error {
if s.reg == nil {
return nil
}
return s.reg.Delete(coreKey(key))
}
func (s *settingsImpl) List(prefix string) ([]string, error) {
if s.reg == nil {
return nil, nil
}
return s.reg.PluginConfig(s.pluginName).List(prefix)
}
func coreKey(key string) string {
if strings.HasPrefix(key, "core.") {
return key
}
return "core." + key
}
func (s *settingsImpl) GetCore(key string) (interface{}, error) {
if s.reg == nil {
return nil, nil
}
return s.reg.Get(coreKey(key))
}
func (s *settingsImpl) SetCore(key string, value interface{}) error {
if s.reg == nil {
return nil
}
return s.reg.Set(coreKey(key), value)
}
func (s *settingsImpl) ListCore(prefix string) ([]string, error) {
if s.reg == nil {
return nil, nil
}
p := coreKey(prefix)
if p == "core." {
p = "core."
}
return s.reg.List(p), nil
}
func (s *settingsImpl) GetPlugin(plugin, key string) (interface{}, error) {
if s.reg == nil {
return nil, nil
}
return s.reg.PluginConfig(plugin).Get(key)
}
func (s *settingsImpl) SetPlugin(plugin, key string, value interface{}) error {
if s.reg == nil {
return nil
}
return s.reg.PluginConfig(plugin).Set(key, value)
}
func (s *settingsImpl) RemovePlugin(plugin, key string) error {
if s.reg == nil {
return nil
}
return s.reg.PluginConfig(plugin).Remove(key)
}
func (s *settingsImpl) ListPlugin(plugin, prefix string) ([]string, error) {
if s.reg == nil {
return nil, nil
}
return s.reg.PluginConfig(plugin).List(prefix)
}
func (s *settingsImpl) RegisterDef(def ConfigDef) {
if s.reg == nil {
return
}
s.reg.PluginConfig(s.pluginName).RegisterDef(internalConfig.ConfigDef{
Key: def.Key, Type: def.Type, DisplayName: def.DisplayName, Description: def.Description,
Category: def.Category, Options: def.Options,
Default: stringifyDefault(def.Default),
})
}
func (s *settingsImpl) Defs(prefix string) []*ConfigDef {
if s.reg == nil {
return nil
}
defs := s.reg.PluginConfig(s.pluginName).ListDefs(prefix)
out := make([]*ConfigDef, len(defs))
for i, d := range defs {
// ConfigDef = pubsdk.ConfigDef (type alias), so direct conversion works
cpy := ConfigDef{
Key: d.Key, Type: d.Type, DisplayName: d.DisplayName, Description: d.Description,
Category: d.Category, Options: d.Options, Default: d.Default,
}
out[i] = &cpy
}
return out
}
func (s *settingsImpl) Dump() map[string]interface{} {
if s.reg == nil {
return nil
}
return s.reg.Dump()
}
func (s *settingsImpl) Plugins() []string {
if s.reg == nil {
return nil
}
names := s.reg.ListPlugins()
result := make([]string, 0, len(names)+1)
result = append(result, "core")
result = append(result, names...)
return result
}
func (s *settingsImpl) DefsCore(prefix string) []*ConfigDef {
if s.reg == nil {
return nil
}
// 只取核心命名空间:插件 def 已限定在 "plugin.<name>.",不能当核心 def 返回。
return mapDefs(s.reg.ListCoreDefs(prefix))
}
func (s *settingsImpl) DefsPlugin(plugin, prefix string) []*ConfigDef {
if s.reg == nil {
return nil
}
return mapDefs(s.reg.PluginConfig(plugin).ListDefs(prefix))
}
func mapDefs(defs []*internalConfig.ConfigDef) []*ConfigDef {
out := make([]*ConfigDef, len(defs))
for i, d := range defs {
out[i] = &ConfigDef{
Key: d.Key, Type: d.Type, DisplayName: d.DisplayName, Description: d.Description,
Category: d.Category, Options: d.Options, Default: d.Default,
}
}
return out
}
func stringifyDefault(v interface{}) string {
if v == nil {
return ""
}
switch x := v.(type) {
case string:
return x
case bool:
if x {
return "true"
}
return "false"
default:
return fmt.Sprint(v)
}
}
// Ensure settingsImpl satisfies SettingsAPI (pubsdk.SettingsAPI via type alias).
var _ SettingsAPI = (*settingsImpl)(nil)