Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor: move setting initialization to SQL schema (#18287)

Danny Xu8ffae2b8ab08
diff --git a/backend/migrator/migration/LATEST.sql b/backend/migrator/migration/LATEST.sql
index 169dd93365..55bed057a1 100644
--- a/backend/migrator/migration/LATEST.sql
+++ b/backend/migrator/migration/LATEST.sql
@@ -547,3 +547,35 @@ ALTER SEQUENCE principal_id_seq RESTART WITH 101;
INSERT INTO project (id, name, resource_id) VALUES (1, 'Default', 'default');
ALTER SEQUENCE project_id_seq RESTART WITH 101;
+
+-- Initialize settings with static values
+INSERT INTO setting (name, value) VALUES ('BRANDING_LOGO', '');
+INSERT INTO setting (name, value) VALUES ('ENTERPRISE_LICENSE', '');
+INSERT INTO setting (name, value) VALUES ('APP_IM', '{}');
+INSERT INTO setting (name, value) VALUES ('WATERMARK', '0');
+INSERT INTO setting (name, value) VALUES ('SCHEMA_TEMPLATE', '{}');
+INSERT INTO setting (name, value) VALUES ('DATA_CLASSIFICATION', '{}');
+INSERT INTO setting (name, value) VALUES ('WORKSPACE_APPROVAL', '{}');
+INSERT INTO setting (name, value) VALUES ('PASSWORD_RESTRICTION', '{"minLength":8}');
+INSERT INTO setting (name, value) VALUES ('WORKSPACE_PROFILE', '{"enableMetricCollection":true}');
+INSERT INTO setting (name, value) VALUES ('ENVIRONMENT', '{"environments":[{"title":"Test","id":"test"},{"title":"Prod","id":"prod"}]}');
+
+-- Initialize settings with dynamically generated values
+-- Generate random alphanumeric string (0-9, a-z, A-Z) compatible with Go's common.RandomString
+-- Uses built-in random() function to pick random characters
+INSERT INTO setting (name, value) VALUES (
+ 'AUTH_SECRET',
+ (SELECT string_agg(substr('0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', floor(random() * 62 + 1)::int, 1), '')
+ FROM generate_series(1, 32))
+);
+INSERT INTO setting (name, value) VALUES ('WORKSPACE_ID', gen_random_uuid()::text);
+INSERT INTO setting (name, value) VALUES (
+ 'SCIM',
+ '{"token":"' || (SELECT string_agg(substr('0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', floor(random() * 62 + 1)::int, 1), '')
+ FROM generate_series(1, 32)) || '"}'
+);
+
+-- Initialize workspace IAM policy
+-- Grant workspace member role to allUsers
+INSERT INTO policy (resource_type, resource, type, payload, inherit_from_parent, enforce)
+VALUES ('WORKSPACE', '', 'IAM', '{"bindings":[{"role":"roles/workspaceMember","members":["allUsers"]}]}', FALSE, TRUE);
diff --git a/backend/server/init.go b/backend/server/init.go
deleted file mode 100644
index 3c000a3b75..0000000000
--- a/backend/server/init.go
+++ /dev/null
@@ -1,210 +0,0 @@
-package server
-
-import (
- "context"
-
- "github.com/google/uuid"
- "github.com/pkg/errors"
- "google.golang.org/protobuf/encoding/protojson"
-
- "github.com/bytebase/bytebase/backend/common"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/metric"
- metriccollector "github.com/bytebase/bytebase/backend/metric/collector"
- "github.com/bytebase/bytebase/backend/runner/metricreport"
- "github.com/bytebase/bytebase/backend/store"
-)
-
-func (s *Server) initializeSetting(ctx context.Context) error {
- // secretLength is the length for the secret used to sign the JWT auto token.
- const secretLength = 32
-
- // initial branding
- _, firstTimeOnboarding, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_BRANDING_LOGO,
- Value: "",
- })
- if err != nil {
- return err
- }
-
- // initial JWT token
- secret, err := common.RandomString(secretLength)
- if err != nil {
- return errors.Wrap(err, "failed to generate random JWT secret")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_AUTH_SECRET,
- Value: secret,
- }); err != nil {
- return err
- }
-
- // initial workspace
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_WORKSPACE_ID,
- Value: uuid.New().String(),
- }); err != nil {
- return err
- }
-
- // Init SCIM config
- scimToken, err := common.RandomString(secretLength)
- if err != nil {
- return errors.Wrap(err, "failed to generate random SCIM secret")
- }
- scimSettingValue, err := protojson.Marshal(&storepb.SCIMSetting{
- Token: scimToken,
- })
- if err != nil {
- return errors.Wrap(err, "failed to marshal initial scim setting")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_SCIM,
- Value: string(scimSettingValue),
- }); err != nil {
- return err
- }
-
- // Init password validation
- passwordSettingValue, err := protojson.Marshal(&storepb.PasswordRestrictionSetting{
- MinLength: 8,
- RequireNumber: false,
- RequireLetter: false,
- RequireUppercaseLetter: false,
- RequireSpecialCharacter: false,
- RequireResetPasswordForFirstLogin: false,
- })
- if err != nil {
- return errors.Wrap(err, "failed to marshal initial password validation setting")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_PASSWORD_RESTRICTION,
- Value: string(passwordSettingValue),
- }); err != nil {
- return err
- }
-
- // initial license
- if _, _, err = s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_ENTERPRISE_LICENSE,
- Value: "",
- }); err != nil {
- return err
- }
-
- // initial IM app
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_APP_IM,
- Value: "{}",
- }); err != nil {
- return err
- }
-
- // initial watermark setting
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_WATERMARK,
- Value: "0",
- }); err != nil {
- return err
- }
-
- // initial schema template setting
- schemaTemplateSettingValue, err := protojson.Marshal(&storepb.SchemaTemplateSetting{})
- if err != nil {
- return errors.Wrap(err, "failed to marshal initial schema template setting")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_SCHEMA_TEMPLATE,
- Value: string(schemaTemplateSettingValue),
- }); err != nil {
- return err
- }
-
- // initial data classification setting
- dataClassificationSettingValue, err := protojson.Marshal(&storepb.DataClassificationSetting{})
- if err != nil {
- return errors.Wrap(err, "failed to marshal initial data classification setting")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_DATA_CLASSIFICATION,
- Value: string(dataClassificationSettingValue),
- }); err != nil {
- return err
- }
-
- // initial workspace approval setting
- approvalSettingValue, err := protojson.Marshal(&storepb.WorkspaceApprovalSetting{})
- if err != nil {
- return errors.Wrap(err, "failed to marshal initial workspace approval setting")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_WORKSPACE_APPROVAL,
- // Value is ""
- Value: string(approvalSettingValue),
- }); err != nil {
- return err
- }
-
- // Initialize workspace profile setting only if it doesn't exist
- workspaceProfilePayload := &storepb.WorkspaceProfileSetting{
- EnableMetricCollection: true,
- }
- bytes, err := protojson.Marshal(workspaceProfilePayload)
- if err != nil {
- return err
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_WORKSPACE_PROFILE,
- Value: string(bytes),
- }); err != nil {
- return err
- }
-
- if firstTimeOnboarding {
- // Only grant workspace member role to allUsers at the first time.
- if _, err := s.store.PatchWorkspaceIamPolicy(ctx, &store.PatchIamPolicyMessage{
- Member: common.AllUsers,
- Roles: []string{
- common.FormatRole(common.WorkspaceMember),
- },
- }); err != nil {
- return err
- }
- }
-
- // Init workspace environment setting
- environmentSettingValue, err := protojson.Marshal(&storepb.EnvironmentSetting{
- Environments: []*storepb.EnvironmentSetting_Environment{
- {
- Title: "Test",
- Id: "test",
- },
- {
- Title: "Prod",
- Id: "prod",
- },
- },
- })
- if err != nil {
- return errors.Wrapf(err, "failed to marshal initial environment setting")
- }
- if _, _, err := s.store.CreateSettingIfNotExistV2(ctx, &store.SettingMessage{
- Name: storepb.SettingName_ENVIRONMENT,
- Value: string(environmentSettingValue),
- }); err != nil {
- return err
- }
-
- return nil
-}
-
-// initMetricReporter will initial the metric scheduler.
-func (s *Server) initMetricReporter() {
- metricReporter := metricreport.NewReporter(s.store, s.licenseService, s.profile)
- metricReporter.Register(metric.InstanceCountMetricName, metriccollector.NewInstanceCountCollector(s.store))
- metricReporter.Register(metric.IssueCountMetricName, metriccollector.NewIssueCountCollector(s.store))
- metricReporter.Register(metric.ProjectCountMetricName, metriccollector.NewProjectCountCollector(s.store))
- metricReporter.Register(metric.UserCountMetricName, metriccollector.NewUserCountCollector(s.store))
- s.metricReporter = metricReporter
-}
diff --git a/backend/server/server.go b/backend/server/server.go
index c892c6192f..f73cf7844f 100644
--- a/backend/server/server.go
+++ b/backend/server/server.go
@@ -30,6 +30,8 @@ import (
"github.com/bytebase/bytebase/backend/enterprise"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
+ "github.com/bytebase/bytebase/backend/metric"
+ metriccollector "github.com/bytebase/bytebase/backend/metric/collector"
"github.com/bytebase/bytebase/backend/migrator"
"github.com/bytebase/bytebase/backend/resources/postgres"
"github.com/bytebase/bytebase/backend/runner/approval"
@@ -165,9 +167,7 @@ func NewServer(ctx context.Context, profile *config.Profile) (*Server, error) {
// Cache the license.
s.licenseService.LoadSubscription(ctx)
- if err := s.initializeSetting(ctx); err != nil {
- return nil, errors.Wrap(err, "failed to init config")
- }
+ // Settings are now initialized in the database schema (LATEST.sql)
secret, err := s.store.GetSecret(ctx)
if err != nil {
return nil, errors.Wrapf(err, "failed to get secret")
@@ -329,3 +329,12 @@ func (s *Server) Shutdown(ctx context.Context) error {
return nil
}
+
+// initMetricReporter initializes the metric reporter.
+func (s *Server) initMetricReporter() {
+ s.metricReporter = metricreport.NewReporter(s.store, s.licenseService, s.profile)
+ s.metricReporter.Register(metric.InstanceCountMetricName, metriccollector.NewInstanceCountCollector(s.store))
+ s.metricReporter.Register(metric.IssueCountMetricName, metriccollector.NewIssueCountCollector(s.store))
+ s.metricReporter.Register(metric.ProjectCountMetricName, metriccollector.NewProjectCountCollector(s.store))
+ s.metricReporter.Register(metric.UserCountMetricName, metriccollector.NewUserCountCollector(s.store))
+}