diff --git a/internal/app/archiemessaging/compose.go b/internal/app/archiemessaging/compose.go index 3b5c00f19..79c453788 100644 --- a/internal/app/archiemessaging/compose.go +++ b/internal/app/archiemessaging/compose.go @@ -64,6 +64,9 @@ type channelInstance struct { chat messaging.ChatContract // plan is what an org's channel was built from. plan *orgChannelPlan + // needs names the required settings an enabled channel lacks; such a + // channel is reported stopped with it rather than started to fail. + needs string mu sync.Mutex channel channels.Channel diff --git a/internal/app/archiemessaging/extension_channels.go b/internal/app/archiemessaging/extension_channels.go index 7fc017093..80bc113e7 100644 --- a/internal/app/archiemessaging/extension_channels.go +++ b/internal/app/archiemessaging/extension_channels.go @@ -2,6 +2,7 @@ package archiemessaging import ( "context" + "errors" "fmt" "log/slog" "maps" @@ -114,6 +115,17 @@ func openExtensionChannels(ctx context.Context, source extension.Source, secrets if index < 0 { continue } + if missing := pkg.Descriptor.MissingSettings(setting.Settings); len(missing) > 0 { + needs := "Missing " + strings.Join(missing, ", ") + log.WarnContext(ctx, "channel extension not started: required settings missing", "channel", pkg.Name, "missing", missing) + instances = append(instances, &channelInstance{ + name: pkg.Name, + needs: needs, + rebuild: func(ResolvedConfig) (channels.Channel, error) { return nil, errors.New(needs) }, + }) + built[pkg.Name] = true + continue + } ch, err := factory.build(ctx, pkg, pkg.Descriptor.Contributes.Extensions[index].Path, pkg.Name, setting.Settings) if err != nil { log.WarnContext(ctx, "channel extension not started", "channel", pkg.Name, "err", err) diff --git a/internal/app/archiemessaging/supervise.go b/internal/app/archiemessaging/supervise.go index cc614a287..ccb2f47f6 100644 --- a/internal/app/archiemessaging/supervise.go +++ b/internal/app/archiemessaging/supervise.go @@ -26,7 +26,7 @@ func (s *Service) runChannel(ctx context.Context, c *channelInstance) { if ch == nil { // Disabled: there is no channel to run until an enable builds one. c.mu.Unlock() - s.status.MarkStopped(c.name, "") + s.status.MarkStopped(c.name, c.needs) if s.awaitChannel(ctx, c, 0) == channelShutdown { return } diff --git a/internal/domain/storepkg/descriptor.go b/internal/domain/storepkg/descriptor.go index 641b421e7..c08eeb836 100644 --- a/internal/domain/storepkg/descriptor.go +++ b/internal/domain/storepkg/descriptor.go @@ -27,6 +27,51 @@ type Descriptor struct { Requires []PackageRef `yaml:"requires"` Authority Authority `yaml:"authority"` Files []File `yaml:"files"` + // Settings are what an operator enters for the package's extensions to + // run, which the dashboard renders as a form. + Settings []Setting `yaml:"settings"` +} + +// Setting is one value an extension reads from its operator-entered settings. +// A secret setting holds an engine:key reference, never the secret, and its +// key ends in "_ref" so the host resolves it before the extension starts. +type Setting struct { + Key string `yaml:"key" json:"key"` + Label string `yaml:"label" json:"label"` + Description string `yaml:"description" json:"description,omitempty"` + Secret bool `yaml:"secret" json:"secret,omitempty"` + Required bool `yaml:"required" json:"required,omitempty"` +} + +var settingKeyPattern = regexp.MustCompile(`^[a-z][a-z0-9_]*$`) + +// MissingSettings returns the labels of the required settings values lacks. +func (d Descriptor) MissingSettings(values map[string]string) []string { + var missing []string + for _, setting := range d.Settings { + if setting.Required && strings.TrimSpace(values[setting.Key]) == "" { + missing = append(missing, setting.Label) + } + } + return missing +} + +func (d Descriptor) validateSettings() error { + seen := make(map[string]bool, len(d.Settings)) + for i, setting := range d.Settings { + switch { + case !settingKeyPattern.MatchString(setting.Key): + return fmt.Errorf("setting %d: key %q must be lower-case letters, digits and underscores", i, setting.Key) + case seen[setting.Key]: + return fmt.Errorf("setting %q is declared twice", setting.Key) + case strings.TrimSpace(setting.Label) == "": + return fmt.Errorf("setting %q: label is required", setting.Key) + case setting.Secret != strings.HasSuffix(setting.Key, "_ref"): + return fmt.Errorf("setting %q: a secret setting's key ends in _ref, and only a secret's does", setting.Key) + } + seen[setting.Key] = true + } + return nil } // Contributions names the declarative families supplied by a package. @@ -138,6 +183,9 @@ func (d Descriptor) Validate() error { if err := d.Authority.Validate(); err != nil { return err } + if err := d.validateSettings(); err != nil { + return err + } executable, err := d.validateExtensions() if err != nil { return err diff --git a/internal/webui/extensions.go b/internal/webui/extensions.go index 217b66448..4e0d90297 100644 --- a/internal/webui/extensions.go +++ b/internal/webui/extensions.go @@ -4,6 +4,7 @@ import ( "context" "encoding/json" "errors" + "fmt" "log/slog" "net/http" "slices" @@ -37,6 +38,7 @@ func (a *extensionsAPI) register(mux *http.ServeMux) { mux.HandleFunc("POST /api/extensions/{name}/rollback", a.handleExtensionRollback) mux.HandleFunc("PUT /api/extensions/{name}/update-policy", a.handleExtensionUpdatePolicy) mux.HandleFunc("PUT /api/extensions/{name}/enabled", a.handleExtensionEnabled) + mux.HandleFunc("PUT /api/extensions/{name}/settings", a.handleExtensionSettings) mux.HandleFunc("DELETE /api/extensions/{name}", a.handleExtensionRemove) } @@ -57,9 +59,9 @@ func authorityOf(a storepkg.Authority) authorityView { } } -func orEmpty(s []string) []string { +func orEmpty[T any](s []T) []T { if s == nil { - return []string{} + return []T{} } return s } @@ -83,6 +85,10 @@ type ExtensionView struct { CanRollback bool `json:"can_rollback"` // UpdatePolicy is "manual" or "auto". UpdatePolicy string `json:"update_policy"` + // SettingsSchema is what the package declares an operator enters, and + // Settings the values entered; a secret's value is its reference. + SettingsSchema []storepkg.Setting `json:"settings_schema"` + Settings map[string]string `json:"settings"` } type pendingView struct { @@ -114,6 +120,7 @@ func extensionView(p storepkg.Installed, enabled bool) ExtensionView { Name: p.Name, DisplayName: p.Descriptor.DisplayName, Description: p.Descriptor.Description, Version: p.Descriptor.Version, Reference: p.Reference, Digest: p.Digest, Surfaces: []string{}, Declared: authorityOf(p.Descriptor.Authority), Enabled: enabled, + SettingsSchema: orEmpty(p.Descriptor.Settings), Settings: map[string]string{}, } for _, extension := range p.Descriptor.Contributes.Extensions { if !slices.Contains(view.Surfaces, extension.Surface) { @@ -227,13 +234,17 @@ func (a *extensionsAPI) handleExtensions(w http.ResponseWriter, r *http.Request) writeControlPlaneError(w, err) return } - enabled := make(map[string]bool, len(doc.Extensions)) + stored := make(map[string]controlplanerpc.ExtensionSetting, len(doc.Extensions)) for _, setting := range doc.Extensions { - enabled[setting.Name] = setting.Enabled + stored[setting.Name] = setting } views := make([]ExtensionView, 0, len(installed)) for _, p := range installed { - views = append(views, extensionView(p, enabled[p.Name])) + view := extensionView(p, stored[p.Name].Enabled) + if values := stored[p.Name].Settings; values != nil { + view.Settings = values + } + views = append(views, view) } writeJSON(w, map[string]any{"extensions": views}) } @@ -365,6 +376,86 @@ func (a *extensionsAPI) handleExtensionEnabled(w http.ResponseWriter, r *http.Re writeJSON(w, map[string]any{"name": name, "enabled": request.Enabled}) } +type extensionSettingsRequest struct { + Settings map[string]string `json:"settings"` +} + +// handleExtensionSettings replaces the settings an installed extension runs +// with. Only the keys its package declares are accepted, and a secret is +// accepted only as an engine:key reference. +func (a *extensionsAPI) handleExtensionSettings(w http.ResponseWriter, r *http.Request) { + if !a.extensionsReady(w) { + return + } + request, ok := decodeBody[extensionSettingsRequest](w, r) + if !ok { + return + } + name := r.PathValue("name") + installed, err := a.packages.GetInstalled(r.Context(), name) + if err != nil { + writePackageError(w, err) + return + } + values, err := declaredSettings(installed.Descriptor.Settings, request.Settings) + if err != nil { + http.Error(w, err.Error(), http.StatusBadRequest) + return + } + doc, version, err := a.extensionSettings(r.Context()) + if err != nil { + writeControlPlaneError(w, err) + return + } + if err := a.putExtensionSettings(r.Context(), withSettings(doc, name, values), version); err != nil { + writeControlPlaneError(w, err) + return + } + writeJSON(w, map[string]any{"name": name, "settings": values}) +} + +// declaredSettings checks values against the package's declared settings and +// returns them trimmed, with empty values dropped. +func declaredSettings(schema []storepkg.Setting, values map[string]string) (map[string]string, error) { + declared := make(map[string]storepkg.Setting, len(schema)) + for _, setting := range schema { + declared[setting.Key] = setting + } + out := make(map[string]string, len(values)) + for key, value := range values { + setting, ok := declared[key] + if !ok { + return nil, fmt.Errorf("setting %q is not declared by the package", key) + } + value = strings.TrimSpace(value) + if value == "" { + continue + } + if setting.Secret { + engine, ref, found := strings.Cut(value, ":") + if !found || engine == "" || ref == "" { + return nil, fmt.Errorf("%s must be a secret reference (engine:key)", setting.Label) + } + } + out[key] = value + } + return out, nil +} + +// withSettings returns doc with the named extension's settings replaced, +// keeping whether it is enabled. +func withSettings(doc controlplanerpc.ExtensionSettings, name string, values map[string]string) controlplanerpc.ExtensionSettings { + next := controlplanerpc.ExtensionSettings{Extensions: slices.Clone(doc.Extensions)} + for i := range next.Extensions { + if next.Extensions[i].Name == name { + next.Extensions[i].Settings = values + return next + } + } + next.Extensions = append(next.Extensions, controlplanerpc.ExtensionSetting{Name: name, Settings: values}) + return next +} + // handleExtensionRemove uninstalls an extension and drops its setting, so a // later reinstall does not start enabled. func (a *extensionsAPI) handleExtensionRemove(w http.ResponseWriter, r *http.Request) { diff --git a/internal/webui/extensions_test.go b/internal/webui/extensions_test.go new file mode 100644 index 000000000..5ecca4a54 --- /dev/null +++ b/internal/webui/extensions_test.go @@ -0,0 +1,41 @@ +package webui + +import ( + "maps" + "testing" + + "github.com/samcharles93/archie-core/internal/domain/storepkg" +) + +// An extension's settings accept only what its package declares, and a secret +// only as a reference: a pasted credential must never reach stored settings. +func TestDeclaredSettings(t *testing.T) { + schema := []storepkg.Setting{ + {Key: "imap_addr", Label: "IMAP address", Required: true}, + {Key: "password_ref", Label: "Password", Secret: true, Required: true}, + } + tests := []struct { + name string + give map[string]string + want map[string]string + wantErr bool + }{ + {name: "declared values are trimmed", give: map[string]string{"imap_addr": " mail:993 ", "password_ref": "bws:mail"}, want: map[string]string{"imap_addr": "mail:993", "password_ref": "bws:mail"}}, + {name: "empty values are dropped", give: map[string]string{"imap_addr": "", "password_ref": " "}, want: map[string]string{}}, + {name: "undeclared key", give: map[string]string{"smtp_addr": "mail:587"}, wantErr: true}, + {name: "raw secret", give: map[string]string{"password_ref": "hunter2"}, wantErr: true}, + {name: "reference without a key", give: map[string]string{"password_ref": "bws:"}, wantErr: true}, + {name: "reference without an engine", give: map[string]string{"password_ref": ":mail"}, wantErr: true}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := declaredSettings(schema, tt.give) + if (err != nil) != tt.wantErr { + t.Fatalf("err = %v, wantErr %v", err, tt.wantErr) + } + if !tt.wantErr && !maps.Equal(got, tt.want) { + t.Fatalf("got %v, want %v", got, tt.want) + } + }) + } +} diff --git a/ui/src/channels/ChannelsPage.vue b/ui/src/channels/ChannelsPage.vue index e276928cb..84aef58a2 100644 --- a/ui/src/channels/ChannelsPage.vue +++ b/ui/src/channels/ChannelsPage.vue @@ -1,23 +1,14 @@ - + Runs as
@@ -193,17 +187,6 @@ function setModels(list: string[]) { {{ agentsError }} - - - - Bot token - Empty disables Telegram. - -
-
-
-
-
Allowed users @@ -219,113 +202,17 @@ function setModels(list: string[]) {
- + - Show tool calls + Show tool calls
- +
-
- - - - - - Workspace - Empty disables file tools. - -
- -
-
-
- - - Unrestricted filesystem -
- -
-
-
- - - Show tool calls -
- -
-
-
- - - - Max steps - 0 = default (100). - -
- - - - - - - -
-
-
- - - Rate limit - Per sender. Off while either is 0. - -
-
- - - - - - - - requests per - - - -
-
-
- - - Models - Empty: role models. - -
-
- - - - - -
-
-
- - - Operator -
- -
-
-
-
-
diff --git a/ui/src/lib/nav.ts b/ui/src/lib/nav.ts index c34a46957..e7c1125d0 100644 --- a/ui/src/lib/nav.ts +++ b/ui/src/lib/nav.ts @@ -64,6 +64,7 @@ const settings: NavSpec = { { label: "Connections & channels", paths: [ + "/settings/channels", "/settings/tools", "/settings/extensions", "/settings/plugins", diff --git a/ui/src/router/index.ts b/ui/src/router/index.ts index fedf71c9d..c654478b4 100644 --- a/ui/src/router/index.ts +++ b/ui/src/router/index.ts @@ -328,7 +328,6 @@ const routes = [ "/settings/schedules": "/org/schedules", "/settings/playbooks": "/org/playbooks", "/settings/scheduling-policy": "/org/scheduling-policy", - "/settings/channels": "/org/channels", "/settings/appearance": "/account/appearance", }).map(([path, redirect]) => ({ path, redirect, meta: { nav: false } })), { @@ -343,6 +342,12 @@ const routes = [ section: "settings", }, }, + { + path: "/settings/channels", + name: "settings-channels", + component: () => import("@/settings/ChannelSettingsPage.vue"), + meta: { navPath: "/settings", settings: true, label: "Channels", description: "Chat channel connections and session defaults.", section: "channels" }, + }, { path: "/settings/extensions", name: "settings-extensions", diff --git a/ui/src/settings/ChannelSettingsPage.vue b/ui/src/settings/ChannelSettingsPage.vue new file mode 100644 index 000000000..b576fb358 --- /dev/null +++ b/ui/src/settings/ChannelSettingsPage.vue @@ -0,0 +1,294 @@ + + + diff --git a/ui/src/settings/ExtensionChannelSettings.vue b/ui/src/settings/ExtensionChannelSettings.vue new file mode 100644 index 000000000..556dbc7f6 --- /dev/null +++ b/ui/src/settings/ExtensionChannelSettings.vue @@ -0,0 +1,86 @@ + + + diff --git a/ui/src/stores/extensions.ts b/ui/src/stores/extensions.ts index fb083b96b..143dabf4f 100644 --- a/ui/src/stores/extensions.ts +++ b/ui/src/stores/extensions.ts @@ -25,6 +25,18 @@ export interface Extension { pending: { digest: string; added: Authority } | null; can_rollback: boolean; update_policy: "manual" | "auto"; + /** What the package declares an operator enters, and what was entered. A + * secret's value is its engine:key reference. */ + settings_schema: ExtensionSettingSpec[]; + settings: Record; +} + +export interface ExtensionSettingSpec { + key: string; + label: string; + description?: string; + secret?: boolean; + required?: boolean; } /** A package the verified catalogue offers. */ @@ -144,6 +156,8 @@ export const useExtensionsStore = defineStore("extensions", () => { rollback: (name: string) => mutate(name, () => call(`${path(name)}/rollback`, { method: "POST" })), setEnabled: (name: string, enabled: boolean) => mutate(name, () => call(`${path(name)}/enabled`, { method: "PUT", body: JSON.stringify({ enabled }) })), + saveSettings: (name: string, settings: Record) => + mutate(name, () => call(`${path(name)}/settings`, { method: "PUT", body: JSON.stringify({ settings }) })), remove: (name: string) => mutate(name, () => call(path(name), { method: "DELETE" })), }; });