Feat settings cascade (#3)
Some checks failed
CI/CD / detect-changes (push) Successful in 3s
CI/CD / test-frontend (push) Successful in 5s
CI/CD / test-go-pg (push) Failing after 2m24s
CI/CD / test-sqlite (push) Successful in 2m48s
CI/CD / build-and-deploy (push) Has been skipped

Co-authored-by: Jeffrey Smith <jasafpro@gmail.com>
Co-committed-by: Jeffrey Smith <jasafpro@gmail.com>
This commit was merged in pull request #3.
This commit is contained in:
2026-03-26 18:03:44 +00:00
committed by xcaliber
parent a830ae3684
commit a36be83aaf
15 changed files with 690 additions and 49 deletions

View File

@@ -46,6 +46,10 @@ type RunContext struct {
// ChannelID is the context identifier, if any.
ChannelID string
// TeamID is the team context for settings cascade resolution (v0.2.0).
// When set, team-scoped package settings are included in the cascade.
TeamID string
}
// Runner executes Starlark package scripts with permission-gated modules.
@@ -337,12 +341,14 @@ func (r *Runner) buildModulesWithLibCtx(ctx context.Context, packageID string, m
}
// v0.30.0: settings module — always injected, no permission required.
// A package reads its own admin + user settings.
// A package reads its own admin + team + user settings (v0.2.0 cascade).
userID := ""
teamID := ""
if rc != nil {
userID = rc.UserID
teamID = rc.TeamID
}
modules["settings"] = BuildSettingsModule(ctx, r.stores, packageID, userID)
modules["settings"] = BuildSettingsModule(ctx, r.stores, packageID, userID, teamID)
// v0.38.2: lib module — always injected, no permission required.
// Allows any starlark package to load declared library dependencies.

View File

@@ -1,10 +1,12 @@
package sandbox
// settings_module.go — v0.30.0 CS2
// settings_module.go — v0.2.0
//
// The settings module lets extensions read their admin-configured and
// per-user settings. Always injected (no permission required — a package
// reads its own settings).
// The settings module lets extensions read their resolved settings via
// the three-tier cascade: global → team → user, respecting the
// user_overridable flag per setting key.
//
// Always injected (no permission required — a package reads its own settings).
//
// Starlark API:
// val = settings.get("key") # returns string, number, bool, or None
@@ -12,7 +14,6 @@ package sandbox
import (
"context"
"encoding/json"
"go.starlark.net/starlark"
"go.starlark.net/starlarkstruct"
@@ -21,16 +22,15 @@ import (
)
// BuildSettingsModule creates the "settings" Starlark module for a package.
// It reads from package_settings (admin-configured) merged with per-user
// settings when a userID is provided. Package-level settings are the base;
// user-level settings override.
func BuildSettingsModule(ctx context.Context, stores store.Stores, packageID string, userID string) *starlarkstruct.Module {
// It resolves the three-tier cascade (global → team → user) respecting
// the user_overridable flag from the package manifest.
func BuildSettingsModule(ctx context.Context, stores store.Stores, packageID, userID, teamID string) *starlarkstruct.Module {
return MakeModule("settings", starlark.StringDict{
"get": starlark.NewBuiltin("settings.get", settingsGet(ctx, stores, packageID, userID)),
"get": starlark.NewBuiltin("settings.get", settingsGet(ctx, stores, packageID, userID, teamID)),
})
}
func settingsGet(ctx context.Context, stores store.Stores, packageID string, userID string) func(*starlark.Thread, *starlark.Builtin, starlark.Tuple, []starlark.Tuple) (starlark.Value, error) {
func settingsGet(ctx context.Context, stores store.Stores, packageID, userID, teamID string) func(*starlark.Thread, *starlark.Builtin, starlark.Tuple, []starlark.Tuple) (starlark.Value, error) {
return func(_ *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
var key string
var defaultVal starlark.Value = starlark.None
@@ -38,28 +38,44 @@ func settingsGet(ctx context.Context, stores store.Stores, packageID string, use
return nil, err
}
// Load package-level settings
merged := make(map[string]any)
if stores.Packages != nil {
pkgSettings, err := stores.Packages.GetPackageSettings(ctx, packageID)
if err == nil && len(pkgSettings) > 0 {
json.Unmarshal([]byte(pkgSettings), &merged)
if stores.Packages == nil {
return defaultVal, nil
}
// Load global (admin) settings
globalSettings, err := stores.Packages.GetPackageSettings(ctx, packageID)
if err != nil {
globalSettings = nil
}
// Load team settings if team context is available
var teamSettings []byte
if teamID != "" {
ts, err := stores.Packages.GetTeamSettings(ctx, packageID, teamID)
if err == nil {
teamSettings = ts
}
}
// Overlay user-level settings if a user context is available
if userID != "" && stores.Packages != nil {
userSettings, err := stores.Packages.GetUserSettings(ctx, packageID, userID)
if err == nil && userSettings != nil && len(userSettings.Settings) > 0 {
var userMap map[string]any
if json.Unmarshal([]byte(userSettings.Settings), &userMap) == nil {
for k, v := range userMap {
merged[k] = v
}
}
// Load user settings if user context is available
var userSettings []byte
if userID != "" {
pus, err := stores.Packages.GetUserSettings(ctx, packageID, userID)
if err == nil && pus != nil {
userSettings = pus.Settings
}
}
// Parse schema from manifest for user_overridable flags
var schema []store.SettingSchema
pkg, err := stores.Packages.Get(ctx, packageID)
if err == nil && pkg != nil && pkg.Manifest != nil {
schema = store.ParseSettingsSchema(pkg.Manifest)
}
// Resolve cascade
merged := store.ResolveSettings(globalSettings, teamSettings, userSettings, schema)
val, ok := merged[key]
if !ok {
return defaultVal, nil