diff --git a/contracts/configuration/types.go b/contracts/configuration/types.go new file mode 100644 index 0000000..0c71298 --- /dev/null +++ b/contracts/configuration/types.go @@ -0,0 +1,98 @@ +package configuration + +import ( + "fmt" + "git.cin.su/m/Assistant/contracts/secrets" + "git.cin.su/m/Assistant/platform/ids" +) + +type SettingDefinitionID ids.StableID +type SettingAssignmentID ids.StableID +type ConfigurationRevision ids.Revision +type ValueType string +type ResolutionMode string +type SettingLifecycle string +type SettingSource string + +const ( + ValueString ValueType = "STRING" + ValueInteger ValueType = "INTEGER" + ValueBoolean ValueType = "BOOLEAN" + ValueSecretRef ValueType = "SECRET_REF" + ResolutionMostSpecific ResolutionMode = "MOST_SPECIFIC_WINS" + ResolutionFirstHuman ResolutionMode = "FIRST_EXPLICIT_HUMAN_WINS" + ResolutionMergeList ResolutionMode = "MERGE_LIST" + SettingActive SettingLifecycle = "ACTIVE" + SettingDeprecated SettingLifecycle = "DEPRECATED" + SettingRetired SettingLifecycle = "RETIRED" + SourceHumanDirective SettingSource = "HUMAN_DIRECTIVE" + SourceMigrated SettingSource = "MIGRATED_CONFIG" + SourceSkillDefault SettingSource = "SKILL_DEFAULT" + SourceSystemDefault SettingSource = "SYSTEM_DEFAULT" + SourceGovernedChange SettingSource = "GOVERNED_CHANGE" +) + +type SettingDefinition struct { + ID SettingDefinitionID + OwnerNamespace string + StableKey string + Revision ConfigurationRevision + ValueType ValueType + DefaultValue string + Sensitivity string + Lifecycle SettingLifecycle + RecordedAtUnixMillis int64 +} +type ScopeSelector struct { + PrincipalRef string + RequiredContextBindings []string + ActivityRef string + SkillRef string + TaskRef string + SessionRef string + TemporaryOverride bool +} +type SettingAssignment struct { + ID SettingAssignmentID + PrincipalID string + DefinitionRef string + DefinitionRevision ConfigurationRevision + Revision ConfigurationRevision + Selector ScopeSelector + TypedValue string + SecretRef *secrets.CredentialRef + EffectiveFromUnixMillis int64 + EffectiveUntilUnixMillis *int64 + Source SettingSource + SourceRef string + Lifecycle SettingLifecycle + RecordedAtUnixMillis int64 +} +type EffectiveSetting struct { + DefinitionRef string + Value string + WinningAssignmentRef string + ResolutionTrace []string +} +type BootstrapConfig struct { + NodeIdentity string + ControlDatabaseLocator string + RootSecretResolverLocator string + RecoveryLocator string +} + +func (d SettingDefinition) Validate() error { + if d.ID == "" || d.OwnerNamespace == "" || d.StableKey == "" || !ids.Revision(d.Revision).Valid() || d.ValueType == "" || d.Lifecycle == "" || d.RecordedAtUnixMillis < 1 { + return fmt.Errorf("invalid setting definition") + } + return nil +} +func (a SettingAssignment) Validate() error { + if a.ID == "" || a.PrincipalID == "" || a.DefinitionRef == "" || !ids.Revision(a.Revision).Valid() || a.Source == "" || a.Lifecycle == "" || a.RecordedAtUnixMillis < 1 { + return fmt.Errorf("invalid setting assignment") + } + if a.SecretRef != nil && a.TypedValue != "" { + return fmt.Errorf("secret assignment must not contain typed value") + } + return nil +} diff --git a/database/migrations/048_configuration_foundation.sql b/database/migrations/048_configuration_foundation.sql new file mode 100644 index 0000000..a737c62 --- /dev/null +++ b/database/migrations/048_configuration_foundation.sql @@ -0,0 +1,7 @@ +BEGIN; +SET ROLE configuration_role; +CREATE TABLE IF NOT EXISTS configuration.setting_definitions (setting_definition_id TEXT PRIMARY KEY, owner_namespace TEXT NOT NULL, stable_key TEXT NOT NULL, revision BIGINT NOT NULL CHECK(revision>0), value_type TEXT NOT NULL, default_value TEXT, sensitivity TEXT NOT NULL, lifecycle TEXT NOT NULL, recorded_at_unix_millis BIGINT NOT NULL); +CREATE TABLE IF NOT EXISTS configuration.setting_assignments (setting_assignment_id TEXT PRIMARY KEY, principal_id TEXT NOT NULL, definition_ref JSONB NOT NULL, revision BIGINT NOT NULL CHECK(revision>0), selector JSONB NOT NULL, typed_value TEXT, secret_ref TEXT, effective_from_unix_millis BIGINT NOT NULL, effective_until_unix_millis BIGINT, source TEXT NOT NULL, source_ref TEXT NOT NULL, lifecycle TEXT NOT NULL, recorded_at_unix_millis BIGINT NOT NULL); +GRANT SELECT, INSERT, UPDATE ON configuration.setting_definitions, configuration.setting_assignments TO configuration_role; +RESET ROLE; +COMMIT; diff --git a/dev/ACTIVE_TASK.json b/dev/ACTIVE_TASK.json index 2f69682..4e5e8d6 100644 --- a/dev/ACTIVE_TASK.json +++ b/dev/ACTIVE_TASK.json @@ -1 +1 @@ -{"task_file":"dev/tasks/GEN2-011-cut-personalmemory-v1-to-compatibility-fallback.json","task_id":"GEN2-011","task_revision":1} \ No newline at end of file +{"task_file":"dev/tasks/GEN2-012-add-typed-scoped-versioned-configuration-owner-and-bootstrap-boundary.json","task_id":"GEN2-012","task_revision":1} diff --git a/modules/configuration/README.arch.md b/modules/configuration/README.arch.md new file mode 100644 index 0000000..9468bbf --- /dev/null +++ b/modules/configuration/README.arch.md @@ -0,0 +1,4 @@ +# configuration + +Configuration owns typed, scoped, versioned settings. ENV is limited to +bootstrap primitives; secret values are never configuration values. diff --git a/modules/configuration/domain/configuration.go b/modules/configuration/domain/configuration.go new file mode 100644 index 0000000..f4869be --- /dev/null +++ b/modules/configuration/domain/configuration.go @@ -0,0 +1,11 @@ +package domain + +import ( + "fmt" + "sort" + "git.cin.su/m/Assistant/contracts/configuration" +) + +func Resolve(definition configuration.SettingDefinition, assignments []configuration.SettingAssignment, selector configuration.ScopeSelector) (configuration.EffectiveSetting,error){if err:=definition.Validate();err!=nil{return configuration.EffectiveSetting{},err}; var matches []configuration.SettingAssignment;for _,a:=range assignments{if err:=a.Validate();err!=nil{return configuration.EffectiveSetting{},err};if a.DefinitionRef==string(definition.ID)&&a.Lifecycle==configuration.SettingActive&&a.Selector.PrincipalRef==selector.PrincipalRef&&a.Selector.SkillRef==selector.SkillRef{matches=append(matches,a)}};if len(matches)==0{return configuration.EffectiveSetting{DefinitionRef:string(definition.ID),Value:definition.DefaultValue,ResolutionTrace:[]string{"system-default"}},nil};sort.SliceStable(matches,func(i,j int)bool{return specificity(matches[i].Selector)>specificity(matches[j].Selector)});if len(matches)>1&&specificity(matches[0].Selector)==specificity(matches[1].Selector){return configuration.EffectiveSetting{},fmt.Errorf("configuration conflict")};return configuration.EffectiveSetting{DefinitionRef:string(definition.ID),Value:matches[0].TypedValue,WinningAssignmentRef:string(matches[0].ID),ResolutionTrace:[]string{"specificity-selected"}},nil} +func specificity(s configuration.ScopeSelector)int{return len(s.RequiredContextBindings)+boolInt(s.SkillRef!="")+boolInt(s.TaskRef!="")+boolInt(s.SessionRef!="")+boolInt(s.TemporaryOverride)} +func boolInt(v bool)int{if v{return 1};return 0} diff --git a/modules/configuration/domain/configuration_test.go b/modules/configuration/domain/configuration_test.go new file mode 100644 index 0000000..feaa89f --- /dev/null +++ b/modules/configuration/domain/configuration_test.go @@ -0,0 +1,3 @@ +package domain_test +import("testing"; "git.cin.su/m/Assistant/contracts/configuration"; "git.cin.su/m/Assistant/modules/configuration/domain") +func TestConfigurationResolvesCompanyAndSkillScope(t *testing.T){d:=configuration.SettingDefinition{ID:"x",OwnerNamespace:"capability",StableKey:"endpoint",Revision:1,ValueType:configuration.ValueString,Lifecycle:configuration.SettingActive,RecordedAtUnixMillis:1};a:=configuration.SettingAssignment{ID:"a",PrincipalID:"company-a",DefinitionRef:"x",Revision:1,Selector:configuration.ScopeSelector{PrincipalRef:"company-a",SkillRef:"skill"},TypedValue:"a-value",Source:configuration.SourceHumanDirective,Lifecycle:configuration.SettingActive,RecordedAtUnixMillis:1};got,err:=domain.Resolve(d,[]configuration.SettingAssignment{a},configuration.ScopeSelector{PrincipalRef:"company-a",SkillRef:"skill"});if err!=nil||got.Value!="a-value"{t.Fatalf("got %#v err=%v",got,err)}}