From a8d0b0351508e81fd91fe443618df147f0cc0531 Mon Sep 17 00:00:00 2001 From: wenjie Date: Thu, 16 Apr 2026 10:30:16 +0800 Subject: [PATCH] fix(web): save channel configs with nested channel_list patches (#2530) Persist channel settings through the current channel_list schema, keeping common channel fields at the top level and channel-specific fields under settings. Return common fields and default config shapes from channel config endpoints, and add coverage for nested patches, missing channel defaults, and secret handling. --- pkg/config/defaults.go | 8 ++ web/backend/api/channels.go | 41 +++++- web/backend/api/channels_test.go | 102 ++++++++++++++ web/backend/api/config_test.go | 124 ++++++++++++++++++ .../channels/channel-config-page.tsx | 31 ++++- .../channels/channel-forms/wecom-form.tsx | 3 +- 6 files changed, 295 insertions(+), 14 deletions(-) diff --git a/pkg/config/defaults.go b/pkg/config/defaults.go index f2f5c44c7..3d12c6ba5 100644 --- a/pkg/config/defaults.go +++ b/pkg/config/defaults.go @@ -514,6 +514,14 @@ func defaultChannels() ChannelsConfig { "max_connections": 100, }, }, + "irc": map[string]any{ + "settings": map[string]any{ + "server": "", + "tls": true, + "nick": "picoclaw", + "channels": []string{}, + }, + }, } channels := make(ChannelsConfig, len(defs)) diff --git a/web/backend/api/channels.go b/web/backend/api/channels.go index d5b65eda5..82cd54b72 100644 --- a/web/backend/api/channels.go +++ b/web/backend/api/channels.go @@ -117,8 +117,11 @@ func buildChannelConfigResponse(cfg *config.Config, item channelCatalogItem) cha bc := cfg.Channels.Get(item.ConfigKey) if bc == nil { - resp.Config = map[string]any{} - return resp + bc = defaultChannelConfig(item.ConfigKey) + if bc == nil { + resp.Config = map[string]any{} + return resp + } } // Detect configured secrets by checking the raw Settings JSON @@ -126,21 +129,47 @@ func buildChannelConfigResponse(cfg *config.Config, item channelCatalogItem) cha resp.ConfiguredSecrets = secrets // Parse settings into a generic map for JSON response - var settings map[string]any - if err := json.Unmarshal(bc.Settings, &settings); err != nil { - resp.Config = map[string]any{} - return resp + settings := map[string]any{} + if len(bc.Settings) > 0 { + if err := json.Unmarshal(bc.Settings, &settings); err != nil { + resp.Config = map[string]any{} + return resp + } } // Remove secure fields from response for _, key := range secrets { delete(settings, key) } + addChannelCommonConfig(settings, bc) resp.Config = settings return resp } +func defaultChannelConfig(configKey string) *config.Channel { + return config.DefaultConfig().Channels.Get(configKey) +} + +func addChannelCommonConfig(settings map[string]any, bc *config.Channel) { + settings["enabled"] = bc.Enabled + if len(bc.AllowFrom) > 0 { + settings["allow_from"] = []string(bc.AllowFrom) + } + if bc.ReasoningChannelID != "" { + settings["reasoning_channel_id"] = bc.ReasoningChannelID + } + if bc.GroupTrigger.MentionOnly || len(bc.GroupTrigger.Prefixes) > 0 { + settings["group_trigger"] = bc.GroupTrigger + } + if bc.Typing.Enabled { + settings["typing"] = bc.Typing + } + if bc.Placeholder.Enabled || len(bc.Placeholder.Text) > 0 { + settings["placeholder"] = bc.Placeholder + } +} + func detectConfiguredSecrets(settings config.RawNode, channelName string) []string { var m map[string]any if err := json.Unmarshal(settings, &m); err != nil { diff --git a/web/backend/api/channels_test.go b/web/backend/api/channels_test.go index cad96fc64..0208af8e7 100644 --- a/web/backend/api/channels_test.go +++ b/web/backend/api/channels_test.go @@ -27,6 +27,7 @@ func TestHandleGetChannelConfig_ReturnsSecretPresenceWithoutLeakingSecrets(t *te bcfg := decoded.(*config.FeishuSettings) bcfg.AppID = "cli_test_app" bcfg.AppSecret = *config.NewSecureString("feishu-secret-from-security") + bc.AllowFrom = config.FlexibleStringSlice{"ou_test_user"} if err := config.SaveConfig(configPath, cfg); err != nil { t.Fatalf("SaveConfig() error = %v", err) } @@ -67,6 +68,13 @@ func TestHandleGetChannelConfig_ReturnsSecretPresenceWithoutLeakingSecrets(t *te if got := resp.Config["app_id"]; got != "cli_test_app" { t.Fatalf("config.app_id = %#v, want %q", got, "cli_test_app") } + if got := resp.Config["enabled"]; got != true { + t.Fatalf("config.enabled = %#v, want true", got) + } + allowFrom, ok := resp.Config["allow_from"].([]any) + if !ok || len(allowFrom) != 1 || allowFrom[0] != "ou_test_user" { + t.Fatalf("config.allow_from = %#v, want [\"ou_test_user\"]", resp.Config["allow_from"]) + } if _, exists := resp.Config["app_secret"]; exists { t.Fatalf("config should omit app_secret, got %#v", resp.Config["app_secret"]) } @@ -91,3 +99,97 @@ func TestHandleGetChannelConfig_ReturnsNotFoundForUnknownChannel(t *testing.T) { t.Fatalf("GET /api/channels/not-a-channel/config status = %d, want %d", rec.Code, http.StatusNotFound) } } + +func TestHandleGetChannelConfig_ReturnsCommonFieldsWhenSettingsEmpty(t *testing.T) { + configPath, cleanup := setupOAuthTestEnv(t) + defer cleanup() + + cfg, err := config.LoadConfig(configPath) + if err != nil { + t.Fatalf("LoadConfig() error = %v", err) + } + bc := cfg.Channels[config.ChannelFeishu] + bc.Enabled = true + bc.AllowFrom = config.FlexibleStringSlice{"ou_common_user"} + if err := config.SaveConfig(configPath, cfg); err != nil { + t.Fatalf("SaveConfig() error = %v", err) + } + + h := NewHandler(configPath) + mux := http.NewServeMux() + h.RegisterRoutes(mux) + + req := httptest.NewRequest(http.MethodGet, "/api/channels/feishu/config", nil) + rec := httptest.NewRecorder() + mux.ServeHTTP(rec, req) + + if rec.Code != http.StatusOK { + t.Fatalf( + "GET /api/channels/feishu/config status = %d, want %d, body=%s", + rec.Code, + http.StatusOK, + rec.Body.String(), + ) + } + + var resp struct { + Config map[string]any `json:"config"` + } + if err := json.Unmarshal(rec.Body.Bytes(), &resp); err != nil { + t.Fatalf("json.Unmarshal() error = %v", err) + } + if got := resp.Config["enabled"]; got != true { + t.Fatalf("config.enabled = %#v, want true", got) + } + allowFrom, ok := resp.Config["allow_from"].([]any) + if !ok || len(allowFrom) != 1 || allowFrom[0] != "ou_common_user" { + t.Fatalf("config.allow_from = %#v, want [\"ou_common_user\"]", resp.Config["allow_from"]) + } +} + +func TestHandleGetChannelConfig_ReturnsDefaultShapeForMissingChannel(t *testing.T) { + configPath, cleanup := setupOAuthTestEnv(t) + defer cleanup() + + cfg, err := config.LoadConfig(configPath) + if err != nil { + t.Fatalf("LoadConfig() error = %v", err) + } + delete(cfg.Channels, config.ChannelIRC) + if err := config.SaveConfig(configPath, cfg); err != nil { + t.Fatalf("SaveConfig() error = %v", err) + } + + h := NewHandler(configPath) + mux := http.NewServeMux() + h.RegisterRoutes(mux) + + req := httptest.NewRequest(http.MethodGet, "/api/channels/irc/config", nil) + rec := httptest.NewRecorder() + mux.ServeHTTP(rec, req) + + if rec.Code != http.StatusOK { + t.Fatalf( + "GET /api/channels/irc/config status = %d, want %d, body=%s", + rec.Code, + http.StatusOK, + rec.Body.String(), + ) + } + + var resp struct { + Config map[string]any `json:"config"` + } + if err := json.Unmarshal(rec.Body.Bytes(), &resp); err != nil { + t.Fatalf("json.Unmarshal() error = %v", err) + } + if got := resp.Config["server"]; got != "" { + t.Fatalf("config.server = %#v, want empty string", got) + } + if got := resp.Config["nick"]; got != "picoclaw" { + t.Fatalf("config.nick = %#v, want %q", got, "picoclaw") + } + if got := resp.Config["enabled"]; got != false { + t.Fatalf("config.enabled = %#v, want false", got) + } +} diff --git a/web/backend/api/config_test.go b/web/backend/api/config_test.go index 083136bce..0e0fa5229 100644 --- a/web/backend/api/config_test.go +++ b/web/backend/api/config_test.go @@ -174,6 +174,130 @@ func TestHandlePatchConfig_AllowsInvalidExecRegexPatternsWhenExecDisabled(t *tes } } +func TestHandlePatchConfig_SavesChannelListSettingsPatch(t *testing.T) { + configPath, cleanup := setupOAuthTestEnv(t) + defer cleanup() + + h := NewHandler(configPath) + mux := http.NewServeMux() + h.RegisterRoutes(mux) + + req := httptest.NewRequest(http.MethodPatch, "/api/config", bytes.NewBufferString(`{ + "channel_list": { + "feishu": { + "enabled": true, + "allow_from": ["ou_patch_user"], + "settings": { + "app_id": "cli_patch_app", + "app_secret": "patch-secret", + "is_lark": true + } + } + } + }`)) + req.Header.Set("Content-Type", "application/json") + + rec := httptest.NewRecorder() + mux.ServeHTTP(rec, req) + if rec.Code != http.StatusOK { + t.Fatalf("PATCH /api/config status = %d, want %d, body=%s", rec.Code, http.StatusOK, rec.Body.String()) + } + + cfg, err := config.LoadConfig(configPath) + if err != nil { + t.Fatalf("LoadConfig() error = %v", err) + } + bc := cfg.Channels[config.ChannelFeishu] + if !bc.Enabled { + t.Fatal("feishu should be enabled after PATCH") + } + if len(bc.AllowFrom) != 1 || bc.AllowFrom[0] != "ou_patch_user" { + t.Fatalf("feishu allow_from = %#v, want [\"ou_patch_user\"]", bc.AllowFrom) + } + decoded, err := bc.GetDecoded() + if err != nil { + t.Fatalf("GetDecoded() error = %v", err) + } + feishuCfg := decoded.(*config.FeishuSettings) + if got := feishuCfg.AppID; got != "cli_patch_app" { + t.Fatalf("feishu app_id = %q, want %q", got, "cli_patch_app") + } + if got := feishuCfg.AppSecret.String(); got != "patch-secret" { + t.Fatalf("feishu app_secret = %q, want %q", got, "patch-secret") + } + if !feishuCfg.IsLark { + t.Fatal("feishu is_lark should be true after PATCH") + } +} + +func TestHandlePatchConfig_CreatesMissingChannelWithTypeAndSecret(t *testing.T) { + configPath, cleanup := setupOAuthTestEnv(t) + defer cleanup() + + cfg, err := config.LoadConfig(configPath) + if err != nil { + t.Fatalf("LoadConfig() error = %v", err) + } + delete(cfg.Channels, config.ChannelIRC) + if err = config.SaveConfig(configPath, cfg); err != nil { + t.Fatalf("SaveConfig() error = %v", err) + } + + h := NewHandler(configPath) + mux := http.NewServeMux() + h.RegisterRoutes(mux) + + req := httptest.NewRequest(http.MethodPatch, "/api/config", bytes.NewBufferString(`{ + "channel_list": { + "irc": { + "enabled": true, + "type": "irc", + "settings": { + "server": "irc.example.com", + "password": "irc-patch-password" + } + } + } + }`)) + req.Header.Set("Content-Type", "application/json") + + rec := httptest.NewRecorder() + mux.ServeHTTP(rec, req) + if rec.Code != http.StatusOK { + t.Fatalf("PATCH /api/config status = %d, want %d, body=%s", rec.Code, http.StatusOK, rec.Body.String()) + } + + cfg, err = config.LoadConfig(configPath) + if err != nil { + t.Fatalf("LoadConfig() error = %v", err) + } + bc := cfg.Channels[config.ChannelIRC] + if bc == nil { + t.Fatal("irc channel should exist after PATCH") + } + if got := bc.Type; got != config.ChannelIRC { + t.Fatalf("irc type = %q, want %q", got, config.ChannelIRC) + } + decoded, err := bc.GetDecoded() + if err != nil { + t.Fatalf("GetDecoded() error = %v", err) + } + ircCfg := decoded.(*config.IRCSettings) + if got := ircCfg.Server; got != "irc.example.com" { + t.Fatalf("irc server = %q, want %q", got, "irc.example.com") + } + if got := ircCfg.Password.String(); got != "irc-patch-password" { + t.Fatalf("irc password = %q, want %q", got, "irc-patch-password") + } + configData, err := os.ReadFile(configPath) + if err != nil { + t.Fatalf("ReadFile(configPath) error = %v", err) + } + if bytes.Contains(configData, []byte("irc-patch-password")) { + t.Fatalf("config file leaked irc password: %s", string(configData)) + } +} + // setupPicoEnabledEnv creates a test environment with Pico channel enabled and // its token stored only in .security.yml (not in the JSON payload). func setupPicoEnabledEnv(t *testing.T) (string, func()) { diff --git a/web/frontend/src/components/channels/channel-config-page.tsx b/web/frontend/src/components/channels/channel-config-page.tsx index 7569712c4..a235daf8d 100644 --- a/web/frontend/src/components/channels/channel-config-page.tsx +++ b/web/frontend/src/components/channels/channel-config-page.tsx @@ -48,6 +48,14 @@ function asBool(value: unknown): boolean { return value === true } +const CHANNEL_COMMON_CONFIG_KEYS = new Set([ + "allow_from", + "group_trigger", + "placeholder", + "reasoning_channel_id", + "typing", +]) + function normalizeConfig( channel: SupportedChannel, rawConfig: ChannelConfig, @@ -67,33 +75,42 @@ function buildSavePayload( editConfig: ChannelConfig, enabled: boolean, ): ChannelConfig { - const payload: ChannelConfig = { enabled } + const payload: ChannelConfig = { enabled, type: channel.config_key } + const settings: ChannelConfig = {} for (const [key, value] of Object.entries(editConfig)) { if (key.startsWith("_")) continue if (key === "enabled") continue + if (CHANNEL_COMMON_CONFIG_KEYS.has(key)) { + payload[key] = value + continue + } if (isSecretField(key)) continue - payload[key] = value + settings[key] = value } for (const [secretKey, editKey] of Object.entries(SECRET_FIELD_MAP)) { const incoming = asString(editConfig[editKey]) if (incoming !== "") { - payload[secretKey] = incoming + settings[secretKey] = incoming continue } const existing = asString(editConfig[secretKey]).trim() if (existing !== "") { - payload[secretKey] = existing + settings[secretKey] = existing } } if (channel.name === "whatsapp_native") { - payload.use_native = true + settings.use_native = true } if (channel.name === "whatsapp") { - payload.use_native = false + settings.use_native = false + } + + if (Object.keys(settings).length > 0) { + payload.settings = settings } return payload @@ -377,7 +394,7 @@ export function ChannelConfigPage({ channelName }: ChannelConfigPageProps) { setFieldErrors({}) try { await patchAppConfig({ - channels: { + channel_list: { [channel.config_key]: savePayload, }, }) diff --git a/web/frontend/src/components/channels/channel-forms/wecom-form.tsx b/web/frontend/src/components/channels/channel-forms/wecom-form.tsx index b7e6ce849..c21ac318a 100644 --- a/web/frontend/src/components/channels/channel-forms/wecom-form.tsx +++ b/web/frontend/src/components/channels/channel-forms/wecom-form.tsx @@ -130,9 +130,10 @@ export function WecomForm({ setToggleError("") try { await patchAppConfig({ - channels: { + channel_list: { wecom: { enabled: checked, + type: "wecom", }, }, })