Skip to content

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

refactor: change SettingMessage.Value from string to proto.Message and rename GetWorkspaceGeneralSetting (#18352)

Danny Xu361219cef6ce
diff --git a/backend/api/auth/header.go b/backend/api/auth/header.go
index 88b9a0df7f..d232db57ad 100644
--- a/backend/api/auth/header.go
+++ b/backend/api/auth/header.go
@@ -74,7 +74,7 @@ func GetTokenDuration(ctx context.Context, store *store.Store, licenseService *e
return tokenDuration
}
- workspaceProfile, err := store.GetWorkspaceGeneralSetting(ctx)
+ workspaceProfile, err := store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return tokenDuration
}
diff --git a/backend/api/directory-sync/webhook.go b/backend/api/directory-sync/webhook.go
index 4d0d4c49f5..7d342ea4b0 100644
--- a/backend/api/directory-sync/webhook.go
+++ b/backend/api/directory-sync/webhook.go
@@ -605,7 +605,7 @@ func (s *Service) validRequestURL(ctx context.Context, c echo.Context) error {
return errors.Errorf("missing authorization token")
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return err
}
@@ -626,7 +626,7 @@ func (s *Service) validRequestURL(ctx context.Context, c echo.Context) error {
return errors.Errorf("invalid workspace id %q, my ID %q", workspaceID, myWorkspaceID)
}
- workspaceProfileSetting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ workspaceProfileSetting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return errors.Wrapf(err, "failed to get workspace profile setting")
}
diff --git a/backend/api/v1/actuator_service.go b/backend/api/v1/actuator_service.go
index 9f6cbac882..d1086a3352 100644
--- a/backend/api/v1/actuator_service.go
+++ b/backend/api/v1/actuator_service.go
@@ -103,7 +103,7 @@ func (s *ActuatorService) GetResourcePackage(
ctx context.Context,
_ *connect.Request[v1pb.GetResourcePackageRequest],
) (*connect.Response[v1pb.ResourcePackage], error) {
- workspaceProfileSetting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ workspaceProfileSetting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to find workspace profile setting"))
}
@@ -138,7 +138,7 @@ func (s *ActuatorService) getServerInfo(ctx context.Context) (*v1pb.ActuatorInfo
return nil, connect.NewError(connect.CodeInternal, err)
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to find workspace setting"))
}
@@ -230,7 +230,7 @@ func (s *ActuatorService) getUsedFeatures(ctx context.Context) ([]v1pb.PlanFeatu
features = append(features, v1pb.PlanFeature_FEATURE_ENTERPRISE_SSO)
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, errors.Wrapf(err, "failed to get workspace general setting")
}
diff --git a/backend/api/v1/auth_service.go b/backend/api/v1/auth_service.go
index c51841b96f..0187f3dbc1 100644
--- a/backend/api/v1/auth_service.go
+++ b/backend/api/v1/auth_service.go
@@ -149,7 +149,7 @@ func (s *AuthService) Login(ctx context.Context, req *connect.Request[v1pb.Login
return nil, connect.NewError(connect.CodeUnauthenticated, errors.Errorf("user has been deactivated by administrators"))
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to find workspace setting, error"))
}
@@ -247,7 +247,7 @@ func (s *AuthService) needResetPassword(ctx context.Context, user *store.UserMes
return false
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
slog.Error("failed to get workspace setting", log.BBError(err))
return false
@@ -335,7 +335,7 @@ func (s *AuthService) getOrCreateUserWithIDP(ctx context.Context, request *v1pb.
return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("identity provider not found"))
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get workspace setting"))
}
diff --git a/backend/api/v1/idp_service.go b/backend/api/v1/idp_service.go
index 15ff503b1f..2329a969f5 100644
--- a/backend/api/v1/idp_service.go
+++ b/backend/api/v1/idp_service.go
@@ -70,7 +70,7 @@ func (s *IdentityProviderService) CreateIdentityProvider(ctx context.Context, re
return nil, err
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get workspace setting"))
}
@@ -229,7 +229,7 @@ func (s *IdentityProviderService) TestIdentityProvider(ctx context.Context, req
return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("identity provider not found"))
}
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get workspace setting"))
}
diff --git a/backend/api/v1/project_service.go b/backend/api/v1/project_service.go
index a92b0e9fef..f3eb232ada 100644
--- a/backend/api/v1/project_service.go
+++ b/backend/api/v1/project_service.go
@@ -959,7 +959,7 @@ func (s *ProjectService) RemoveWebhook(ctx context.Context, req *connect.Request
// TestWebhook tests a webhook.
func (s *ProjectService) TestWebhook(ctx context.Context, req *connect.Request[v1pb.TestWebhookRequest]) (*connect.Response[v1pb.TestWebhookResponse], error) {
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get workspace setting"))
}
@@ -1083,13 +1083,13 @@ func validateIAMPolicy(
return false, connect.NewError(connect.CodeInvalidArgument, errors.New("IAM Binding is empty"))
}
- generalSetting, err := stores.GetWorkspaceGeneralSetting(ctx)
+ workspaceProfileSetting, err := stores.GetWorkspaceProfileSetting(ctx)
if err != nil {
- return false, connect.NewError(connect.CodeInternal, errors.New("failed to get workspace general setting"))
+ return false, connect.NewError(connect.CodeInternal, errors.New("failed to get workspace profile setting"))
}
var maximumRoleExpiration *durationpb.Duration
- if generalSetting != nil {
- maximumRoleExpiration = generalSetting.MaximumRoleExpiration
+ if workspaceProfileSetting != nil {
+ maximumRoleExpiration = workspaceProfileSetting.MaximumRoleExpiration
}
roleMessages, err := stores.ListRoles(ctx)
diff --git a/backend/api/v1/setting_service.go b/backend/api/v1/setting_service.go
index c7b764f4d1..87884c93c0 100644
--- a/backend/api/v1/setting_service.go
+++ b/backend/api/v1/setting_service.go
@@ -9,7 +9,8 @@ import (
"connectrpc.com/connect"
"github.com/google/uuid"
"github.com/pkg/errors"
- "google.golang.org/protobuf/encoding/protojson"
+
+ "google.golang.org/protobuf/proto" // Added
"google.golang.org/protobuf/types/known/anypb"
"github.com/bytebase/bytebase/backend/common"
@@ -55,7 +56,7 @@ func NewSettingService(
// ListSettings lists all settings.
func (s *SettingService) ListSettings(ctx context.Context, _ *connect.Request[v1pb.ListSettingsRequest]) (*connect.Response[v1pb.ListSettingsResponse], error) {
- settings, err := s.store.ListSettingV2(ctx, &store.FindSettingMessage{})
+ settings, err := s.store.ListSettingV2(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list settings: %v", err))
}
@@ -150,7 +151,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
setServiceData(p)
}
- var storeSettingValue string
+ var storeSettingValue proto.Message
var resetAuditLogStdout bool
var resetClassification bool
@@ -160,7 +161,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("update mask is required"))
}
payload := convertWorkspaceProfileSetting(request.Msg.Setting.Value.GetWorkspaceProfile())
- oldSetting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ oldSetting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to find setting %s with error: %v", apiSettingName, err))
}
@@ -303,11 +304,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
if len(oldSetting.Domains) == 0 && oldSetting.EnforceIdentityDomain {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("identity domain can be enforced only when workspace domains are set"))
}
- bytes, err := protojson.Marshal(oldSetting)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s with error: %v", apiSettingName, err))
- }
- storeSettingValue = string(bytes)
+ storeSettingValue = oldSetting
case storepb.SettingName_WORKSPACE_APPROVAL:
if err := s.licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_APPROVAL_WORKFLOW); err != nil {
return nil, connect.NewError(connect.CodePermissionDenied, err)
@@ -346,11 +343,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
},
})
}
- bytes, err := protojson.Marshal(payload)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s with error: %v", apiSettingName, err))
- }
- storeSettingValue = string(bytes)
+ storeSettingValue = payload
case storepb.SettingName_APP_IM:
payload, err := convertAppIMSetting(request.Msg.Setting.Value.GetAppIm())
if err != nil {
@@ -428,11 +421,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
}
}
- bytes, err := protojson.Marshal(payload)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s, error: %v", apiSettingName, err))
- }
- storeSettingValue = string(bytes)
+ storeSettingValue = payload
case storepb.SettingName_DATA_CLASSIFICATION:
if err := s.licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_DATA_CLASSIFICATION); err != nil {
@@ -446,12 +435,8 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
if len(payload.Configs) == 1 && len(payload.Configs[0].Classification) == 0 {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("missing classification map"))
}
- bytes, err := protojson.Marshal(payload)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s with error: %v", apiSettingName, err))
- }
resetClassification = true
- storeSettingValue = string(bytes)
+ storeSettingValue = payload
case storepb.SettingName_SEMANTIC_TYPES:
storeSemanticTypeSetting := convertSemanticTypeSetting(request.Msg.Setting.Value.GetSemanticType())
idMap := make(map[string]bool)
@@ -470,11 +455,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
}
idMap[tp.Id] = true
}
- bytes, err := protojson.Marshal(storeSemanticTypeSetting)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s with error: %v", apiSettingName, err))
- }
- storeSettingValue = string(bytes)
+ storeSettingValue = storeSemanticTypeSetting
case storepb.SettingName_AI:
aiSetting := convertAISetting(request.Msg.Setting.Value.GetAi())
if aiSetting.Enabled {
@@ -495,11 +476,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
}
}
- bytes, err := protojson.Marshal(aiSetting)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s with error: %v", apiSettingName, err))
- }
- storeSettingValue = string(bytes)
+ storeSettingValue = aiSetting
case storepb.SettingName_ENVIRONMENT:
if serr := s.validateEnvironments(request.Msg.Setting.Value.GetEnvironment().GetEnvironments()); serr != nil {
return nil, serr
@@ -533,11 +510,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
}
}
- bytes, err := protojson.Marshal(environmentSetting)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to marshal setting for %s with error: %v", apiSettingName, err))
- }
- storeSettingValue = string(bytes)
+ storeSettingValue = environmentSetting
default:
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("unsupported setting %v", apiSettingName))
}
@@ -559,7 +532,7 @@ func (s *SettingService) UpdateSetting(ctx context.Context, request *connect.Req
// Dynamically update audit logger runtime flag if enable_audit_log_stdout was changed
if resetAuditLogStdout {
- workspaceProfile, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ workspaceProfile, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get workspace setting message: %v", err))
}
diff --git a/backend/api/v1/setting_service_converter.go b/backend/api/v1/setting_service_converter.go
index e1eb342e9f..fbac156c9a 100644
--- a/backend/api/v1/setting_service_converter.go
+++ b/backend/api/v1/setting_service_converter.go
@@ -17,9 +17,9 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
settingName := fmt.Sprintf("%s%s", common.SettingNamePrefix, convertStoreSettingNameToV1(setting.Name).String())
switch setting.Name {
case storepb.SettingName_APP_IM:
- storeValue := new(storepb.AppIMSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.AppIMSetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
v1Value := convertToAppIMSetting(storeValue)
return &v1pb.Setting{
@@ -31,9 +31,9 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
}, nil
case storepb.SettingName_WORKSPACE_PROFILE:
- storeValue := new(storepb.WorkspaceProfileSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.WorkspaceProfileSetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
v1Value := convertToWorkspaceProfileSetting(storeValue)
v1Value.DisallowSignup = v1Value.DisallowSignup || profile.SaaS
@@ -46,9 +46,9 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
}, nil
case storepb.SettingName_WORKSPACE_APPROVAL:
- storeValue := new(storepb.WorkspaceApprovalSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.WorkspaceApprovalSetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
v1Value := &v1pb.WorkspaceApprovalSetting{}
for _, rule := range storeValue.Rules {
@@ -68,9 +68,9 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
}, nil
case storepb.SettingName_DATA_CLASSIFICATION:
- storeValue := new(storepb.DataClassificationSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.DataClassificationSetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
return &v1pb.Setting{
Name: settingName,
@@ -81,9 +81,9 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
}, nil
case storepb.SettingName_SEMANTIC_TYPES:
- storeValue := new(storepb.SemanticTypeSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.SemanticTypeSetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
return &v1pb.Setting{
Name: settingName,
@@ -94,9 +94,9 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
}, nil
case storepb.SettingName_AI:
- storeValue := new(storepb.AISetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), storeValue); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to unmarshal setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.AISetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
// DO NOT expose the api key.
storeValue.ApiKey = ""
@@ -109,15 +109,16 @@ func convertToSettingMessage(setting *store.SettingMessage, profile *config.Prof
},
}, nil
case storepb.SettingName_ENVIRONMENT:
- storeValue, err := convertToEnvironmentSetting(setting.Value)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to convert setting value for %s with error: %v", setting.Name, err))
+ storeValue, ok := setting.Value.(*storepb.EnvironmentSetting)
+ if !ok {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("invalid setting value type for %s", setting.Name))
}
+ v1Value := convertToEnvironmentSetting(storeValue)
return &v1pb.Setting{
Name: settingName,
Value: &v1pb.SettingValue{
Value: &v1pb.SettingValue_Environment{
- Environment: storeValue,
+ Environment: v1Value,
},
},
}, nil
@@ -192,19 +193,18 @@ func convertV1SettingNameToStore(v1Name v1pb.Setting_SettingName) storepb.Settin
}
}
-func convertToEnvironmentSetting(value string) (*v1pb.EnvironmentSetting, error) {
- var setting storepb.EnvironmentSetting
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(value), &setting); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal environment setting")
+func convertToEnvironmentSetting(storeValue *storepb.EnvironmentSetting) *v1pb.EnvironmentSetting {
+ if storeValue == nil {
+ return nil
}
var environments []*v1pb.EnvironmentSetting_Environment
- for _, e := range setting.Environments {
+ for _, e := range storeValue.Environments {
environments = append(environments, convertToEnvironment(e))
}
return &v1pb.EnvironmentSetting{
Environments: environments,
- }, nil
+ }
}
func convertToEnvironment(e *storepb.EnvironmentSetting_Environment) *v1pb.EnvironmentSetting_Environment {
diff --git a/backend/api/v1/user_service.go b/backend/api/v1/user_service.go
index b0b8223e9c..a9e3994074 100644
--- a/backend/api/v1/user_service.go
+++ b/backend/api/v1/user_service.go
@@ -169,7 +169,7 @@ func (s *UserService) ListUsers(ctx context.Context, request *connect.Request[v1
// CreateUser creates a user.
func (s *UserService) CreateUser(ctx context.Context, request *connect.Request[v1pb.CreateUserRequest]) (*connect.Response[v1pb.User], error) {
if err := s.licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_DISALLOW_SELF_SERVICE_SIGNUP); err == nil {
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to find workspace setting, error: %v", err))
}
@@ -303,7 +303,7 @@ func (s *UserService) CreateUser(ctx context.Context, request *connect.Request[v
}
func (s *UserService) validatePassword(ctx context.Context, password string) error {
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to get password restriction with error: %v", err))
}
@@ -430,7 +430,7 @@ func (s *UserService) UpdateUser(ctx context.Context, request *connect.Request[v
TempOtpSecretCreatedTime: nil,
}
} else {
- setting, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := s.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to find workspace setting, error: %v", err))
}
@@ -730,7 +730,7 @@ func validateEmailWithDomains(ctx context.Context, licenseService *enterprise.Li
}
return nil
}
- setting, err := stores.GetWorkspaceGeneralSetting(ctx)
+ setting, err := stores.GetWorkspaceProfileSetting(ctx)
if err != nil {
return connect.NewError(connect.CodeInternal, errors.Errorf("failed to find workspace setting, error: %v", err))
}
diff --git a/backend/component/webhook/manager.go b/backend/component/webhook/manager.go
index c7e0bdd588..acbe2a7c56 100644
--- a/backend/component/webhook/manager.go
+++ b/backend/component/webhook/manager.go
@@ -73,7 +73,7 @@ func (m *Manager) getWebhookContextFromEvent(ctx context.Context, e *Event, even
var webhookCtx webhook.Context
var mentionUsers []*store.UserMessage
- setting, err := m.store.GetWorkspaceGeneralSetting(ctx)
+ setting, err := m.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
return nil, errors.Wrapf(err, "failed to get workspace setting")
}
diff --git a/backend/runner/metricreport/reporter.go b/backend/runner/metricreport/reporter.go
index ff17a36221..929ab9409b 100644
--- a/backend/runner/metricreport/reporter.go
+++ b/backend/runner/metricreport/reporter.go
@@ -14,7 +14,7 @@ import (
"github.com/bytebase/bytebase/backend/common/log"
"github.com/bytebase/bytebase/backend/component/config"
"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/plugin/metric"
"github.com/bytebase/bytebase/backend/plugin/metric/segment"
@@ -167,25 +167,13 @@ func (m *Reporter) isMetricCollectionEnabled(ctx context.Context) bool {
}
// Get workspace profile setting
- setting, err := m.store.GetSettingV2(ctx, storepb.SettingName_WORKSPACE_PROFILE)
+ workspaceProfile, err := m.store.GetWorkspaceProfileSetting(ctx)
if err != nil {
// If we can't get the setting, default to enabled for backward compatibility
slog.Debug("Failed to get workspace profile setting for metric collection", log.BBError(err))
return true
}
- if setting == nil {
- // Default to enabled if setting is not found
- return true
- }
-
- var workspaceProfile storepb.WorkspaceProfileSetting
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), &workspaceProfile); err != nil {
- slog.Debug("Failed to unmarshal workspace profile setting", log.BBError(err))
- // Default to enabled if we can't parse the setting
- return true
- }
-
return workspaceProfile.EnableMetricCollection
}
diff --git a/backend/server/server.go b/backend/server/server.go
index f73cf7844f..f4cd844966 100644
--- a/backend/server/server.go
+++ b/backend/server/server.go
@@ -251,7 +251,7 @@ func (s *Server) Run(ctx context.Context, port int) error {
go mmm.Run(ctx, &s.runnerWG)
// Check workspace setting and set audit logger runtime flag
- workspaceProfile, err := s.store.GetWorkspaceGeneralSetting(ctx)
+ workspaceProfile, err := s.store.GetWorkspaceProfileSetting(ctx)
if err == nil && workspaceProfile.GetEnableAuditLogStdout() {
// Validate license before enabling (prevents usage after license downgrade/expiry)
if err := s.licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_AUDIT_LOG); err != nil {
diff --git a/backend/store/setting.go b/backend/store/setting.go
index b55d2ee8d9..5d2941610f 100644
--- a/backend/store/setting.go
+++ b/backend/store/setting.go
@@ -6,31 +6,50 @@ import (
"github.com/pkg/errors"
"google.golang.org/protobuf/encoding/protojson"
+ "google.golang.org/protobuf/proto"
"github.com/bytebase/bytebase/backend/common"
"github.com/bytebase/bytebase/backend/common/qb"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
)
-// FindSettingMessage is the message for finding setting.
-type FindSettingMessage struct {
- Name *storepb.SettingName
-}
-
// SetSettingMessage is the message for updating setting.
type SetSettingMessage struct {
Name storepb.SettingName
- Value string
+ Value proto.Message
}
// SettingMessage is the message of setting.
type SettingMessage struct {
Name storepb.SettingName
- Value string
+ Value proto.Message
}
-// GetWorkspaceGeneralSetting gets the workspace general setting payload.
-func (s *Store) GetWorkspaceGeneralSetting(ctx context.Context) (*storepb.WorkspaceProfileSetting, error) {
+func getSettingMessage(name storepb.SettingName) (proto.Message, error) {
+ switch name {
+ case storepb.SettingName_WORKSPACE_PROFILE:
+ return &storepb.WorkspaceProfileSetting{}, nil
+ case storepb.SettingName_APP_IM:
+ return &storepb.AppIMSetting{}, nil
+ case storepb.SettingName_SYSTEM:
+ return &storepb.SystemSetting{}, nil
+ case storepb.SettingName_WORKSPACE_APPROVAL:
+ return &storepb.WorkspaceApprovalSetting{}, nil
+ case storepb.SettingName_SEMANTIC_TYPES:
+ return &storepb.SemanticTypeSetting{}, nil
+ case storepb.SettingName_DATA_CLASSIFICATION:
+ return &storepb.DataClassificationSetting{}, nil
+ case storepb.SettingName_AI:
+ return &storepb.AISetting{}, nil
+ case storepb.SettingName_ENVIRONMENT:
+ return &storepb.EnvironmentSetting{}, nil
+ default:
+ return nil, errors.Errorf("unknown setting name: %v", name)
+ }
+}
+
+// GetWorkspaceProfileSetting gets the workspace profile setting payload.
+func (s *Store) GetWorkspaceProfileSetting(ctx context.Context) (*storepb.WorkspaceProfileSetting, error) {
setting, err := s.GetSettingV2(ctx, storepb.SettingName_WORKSPACE_PROFILE)
if err != nil {
return nil, errors.Wrapf(err, "failed to get setting %v", storepb.SettingName_WORKSPACE_PROFILE)
@@ -39,11 +58,11 @@ func (s *Store) GetWorkspaceGeneralSetting(ctx context.Context) (*storepb.Worksp
return nil, errors.Errorf("cannot find setting %v", storepb.SettingName_WORKSPACE_PROFILE)
}
- payload := new(storepb.WorkspaceProfileSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), payload); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.WorkspaceProfileSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_WORKSPACE_PROFILE)
}
- return payload, nil
+ return val, nil
}
func (s *Store) GetAppIMSetting(ctx context.Context) (*storepb.AppIMSetting, error) {
@@ -55,11 +74,11 @@ func (s *Store) GetAppIMSetting(ctx context.Context) (*storepb.AppIMSetting, err
return nil, errors.Errorf("cannot find setting %v", storepb.SettingName_APP_IM)
}
- payload := new(storepb.AppIMSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), payload); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.AppIMSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_APP_IM)
}
- return payload, nil
+ return val, nil
}
func (s *Store) GetSystemSetting(ctx context.Context) (*storepb.SystemSetting, error) {
@@ -71,11 +90,11 @@ func (s *Store) GetSystemSetting(ctx context.Context) (*storepb.SystemSetting, e
return nil, errors.Errorf("cannot find setting %v", storepb.SettingName_SYSTEM)
}
- payload := new(storepb.SystemSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), payload); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.SystemSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_SYSTEM)
}
- return payload, nil
+ return val, nil
}
// UpsertEnterpriseLicense updates the enterprise license in SYSTEM setting.
@@ -85,23 +104,22 @@ func (s *Store) UpsertEnterpriseLicense(ctx context.Context, license string) err
return errors.Wrap(err, "failed to get system setting")
}
- systemSetting := &storepb.SystemSetting{}
+ var systemSetting *storepb.SystemSetting
if setting != nil {
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), systemSetting); err != nil {
- return errors.Wrap(err, "failed to unmarshal system setting")
+ val, ok := setting.Value.(*storepb.SystemSetting)
+ if !ok {
+ return errors.Errorf("invalid setting value type for %s", storepb.SettingName_SYSTEM)
}
+ systemSetting = val
+ } else {
+ systemSetting = &storepb.SystemSetting{}
}
systemSetting.License = license
- value, err := protojson.Marshal(systemSetting)
- if err != nil {
- return errors.Wrap(err, "failed to marshal system setting")
- }
-
if _, err := s.UpsertSettingV2(ctx, &SetSettingMessage{
Name: storepb.SettingName_SYSTEM,
- Value: string(value),
+ Value: systemSetting,
}); err != nil {
return errors.Wrap(err, "failed to upsert system setting")
}
@@ -119,11 +137,11 @@ func (s *Store) GetWorkspaceApprovalSetting(ctx context.Context) (*storepb.Works
return nil, errors.Errorf("cannot find setting %v", storepb.SettingName_WORKSPACE_APPROVAL)
}
- payload := new(storepb.WorkspaceApprovalSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), payload); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.WorkspaceApprovalSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_WORKSPACE_APPROVAL)
}
- return payload, nil
+ return val, nil
}
// GetSemanticTypesSetting gets the semantic types setting.
@@ -136,11 +154,11 @@ func (s *Store) GetSemanticTypesSetting(ctx context.Context) (*storepb.SemanticT
return &storepb.SemanticTypeSetting{}, nil
}
- payload := new(storepb.SemanticTypeSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), payload); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.SemanticTypeSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_SEMANTIC_TYPES)
}
- return payload, nil
+ return val, nil
}
// GetDataClassificationSetting gets the data classification setting.
@@ -153,43 +171,43 @@ func (s *Store) GetDataClassificationSetting(ctx context.Context) (*storepb.Data
return &storepb.DataClassificationSetting{}, nil
}
- payload := new(storepb.DataClassificationSetting)
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), payload); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.DataClassificationSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_DATA_CLASSIFICATION)
}
- return payload, nil
+ return val, nil
}
func (s *Store) GetAISetting(ctx context.Context) (*storepb.AISetting, error) {
- aiSetting := &storepb.AISetting{}
setting, err := s.GetSettingV2(ctx, storepb.SettingName_AI)
if err != nil {
return nil, err
}
if setting == nil {
- return aiSetting, nil
+ return &storepb.AISetting{}, nil
}
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), aiSetting); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.AISetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_AI)
}
- return aiSetting, nil
+ return val, nil
}
func (s *Store) GetEnvironment(ctx context.Context) (*storepb.EnvironmentSetting, error) {
- envSetting := &storepb.EnvironmentSetting{}
setting, err := s.GetSettingV2(ctx, storepb.SettingName_ENVIRONMENT)
if err != nil {
return nil, err
}
if setting == nil {
- return envSetting, nil
+ return &storepb.EnvironmentSetting{}, nil
}
- if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(setting.Value), envSetting); err != nil {
- return nil, err
+ val, ok := setting.Value.(*storepb.EnvironmentSetting)
+ if !ok {
+ return nil, errors.Errorf("invalid setting value type for %s", storepb.SettingName_ENVIRONMENT)
}
- return envSetting, nil
+ return val, nil
}
// GetSettingV2 returns the setting by name.
@@ -204,9 +222,7 @@ func (s *Store) GetSettingV2(ctx context.Context, name storepb.SettingName) (*Se
}
defer tx.Rollback()
- settings, err := listSettingV2Impl(ctx, tx, &FindSettingMessage{
- Name: &name,
- })
+ settings, err := listSettingV2Impl(ctx, tx, &name)
if err != nil {
return nil, errors.Wrap(err, "failed to list setting")
}
@@ -224,13 +240,13 @@ func (s *Store) GetSettingV2(ctx context.Context, name storepb.SettingName) (*Se
}
// ListSettingV2 returns a list of settings.
-func (s *Store) ListSettingV2(ctx context.Context, find *FindSettingMessage) ([]*SettingMessage, error) {
+func (s *Store) ListSettingV2(ctx context.Context) ([]*SettingMessage, error) {
tx, err := s.GetDB().BeginTx(ctx, &sql.TxOptions{ReadOnly: true})
if err != nil {
return nil, errors.Wrap(err, "failed to begin transaction")
}
defer tx.Rollback()
- settings, err := listSettingV2Impl(ctx, tx, find)
+ settings, err := listSettingV2Impl(ctx, tx, nil)
if err != nil {
return nil, errors.Wrap(err, "failed to list setting")
}
@@ -258,12 +274,17 @@ func (s *Store) GetSecret(ctx context.Context) (string, error) {
// UpsertSettingV2 upserts the setting by name.
func (s *Store) UpsertSettingV2(ctx context.Context, update *SetSettingMessage) (*SettingMessage, error) {
+ valueBytes, err := protojson.Marshal(update.Value)
+ if err != nil {
+ return nil, errors.Wrap(err, "failed to marshal setting value")
+ }
+
q := qb.Q().Space(`
INSERT INTO setting (name, value)
VALUES (?, ?)
ON CONFLICT (name) DO UPDATE SET value = EXCLUDED.value
RETURNING name, value
- `, update.Name.String(), update.Value)
+ `, update.Name.String(), string(valueBytes))
query, args, err := q.ToSQL()
if err != nil {
@@ -278,9 +299,10 @@ func (s *Store) UpsertSettingV2(ctx context.Context, update *SetSettingMessage)
var setting SettingMessage
var nameString string
+ var valueString string
if err := tx.QueryRowContext(ctx, query, args...).Scan(
&nameString,
- &setting.Value,
+ &valueString,
); err != nil {
if err == sql.ErrNoRows {
return nil, &common.Error{Code: common.NotFound, Err: errors.Errorf("setting not found: %s", update.Name)}
@@ -293,6 +315,15 @@ func (s *Store) UpsertSettingV2(ctx context.Context, update *SetSettingMessage)
}
setting.Name = storepb.SettingName(value)
+ msg, err := getSettingMessage(setting.Name)
+ if err != nil {
+ return nil, err
+ }
+ if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(valueString), msg); err != nil {
+ return nil, err
+ }
+ setting.Value = msg
+
if err := tx.Commit(); err != nil {
return nil, errors.Wrap(err, "failed to commit transaction")
}
@@ -326,7 +357,7 @@ func (s *Store) DeleteSettingV2(ctx context.Context, name storepb.SettingName) e
return nil
}
-func listSettingV2Impl(ctx context.Context, txn *sql.Tx, find *FindSettingMessage) ([]*SettingMessage, error) {
+func listSettingV2Impl(ctx context.Context, txn *sql.Tx, name *storepb.SettingName) ([]*SettingMessage, error) {
q := qb.Q().Space(`
SELECT
name,
@@ -334,8 +365,8 @@ func listSettingV2Impl(ctx context.Context, txn *sql.Tx, find *FindSettingMessag
FROM setting
WHERE TRUE
`)
- if v := find.Name; v != nil {
- q.And("name = ?", v.String())
+ if name != nil {
+ q.And("name = ?", name.String())
}
query, args, err := q.ToSQL()
if err != nil {
@@ -351,9 +382,10 @@ func listSettingV2Impl(ctx context.Context, txn *sql.Tx, find *FindSettingMessag
for rows.Next() {
var settingMessage SettingMessage
var nameString string
+ var valueString string
if err := rows.Scan(
&nameString,
- &settingMessage.Value,
+ &valueString,
); err != nil {
return nil, err
}
@@ -362,6 +394,16 @@ func listSettingV2Impl(ctx context.Context, txn *sql.Tx, find *FindSettingMessag
return nil, errors.Errorf("invalid setting name string: %s", nameString)
}
settingMessage.Name = storepb.SettingName(value)
+
+ msg, err := getSettingMessage(settingMessage.Name)
+ if err != nil {
+ return nil, err
+ }
+ if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(valueString), msg); err != nil {
+ return nil, err
+ }
+ settingMessage.Value = msg
+
settingMessages = append(settingMessages, &settingMessage)
}
if err := rows.Err(); err != nil {