Skip to content

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

refactor: move SQLReviewRuleLevel to SQLReviewRule.Level (#18363)

Danny Xu9e03efbaccd6
diff --git a/backend/api/v1/org_policy_service_converter.go b/backend/api/v1/org_policy_service_converter.go
index 0e4c1f55c9..347ebe7e61 100644
--- a/backend/api/v1/org_policy_service_converter.go
+++ b/backend/api/v1/org_policy_service_converter.go
@@ -14,12 +14,12 @@ import (
func convertToV1PBSQLReviewRules(ruleList []*storepb.SQLReviewRule) []*v1pb.SQLReviewRule {
var rules []*v1pb.SQLReviewRule
for _, rule := range ruleList {
- level := v1pb.SQLReviewRuleLevel_LEVEL_UNSPECIFIED
+ level := v1pb.SQLReviewRule_LEVEL_UNSPECIFIED
switch rule.Level {
- case storepb.SQLReviewRuleLevel_ERROR:
- level = v1pb.SQLReviewRuleLevel_ERROR
- case storepb.SQLReviewRuleLevel_WARNING:
- level = v1pb.SQLReviewRuleLevel_WARNING
+ case storepb.SQLReviewRule_ERROR:
+ level = v1pb.SQLReviewRule_ERROR
+ case storepb.SQLReviewRule_WARNING:
+ level = v1pb.SQLReviewRule_WARNING
default:
}
rules = append(rules, &v1pb.SQLReviewRule{
@@ -36,12 +36,12 @@ func convertToV1PBSQLReviewRules(ruleList []*storepb.SQLReviewRule) []*v1pb.SQLR
func convertToSQLReviewRules(rules []*v1pb.SQLReviewRule) ([]*storepb.SQLReviewRule, error) {
var ruleList []*storepb.SQLReviewRule
for _, rule := range rules {
- var level storepb.SQLReviewRuleLevel
+ var level storepb.SQLReviewRule_Level
switch rule.Level {
- case v1pb.SQLReviewRuleLevel_ERROR:
- level = storepb.SQLReviewRuleLevel_ERROR
- case v1pb.SQLReviewRuleLevel_WARNING:
- level = storepb.SQLReviewRuleLevel_WARNING
+ case v1pb.SQLReviewRule_ERROR:
+ level = storepb.SQLReviewRule_ERROR
+ case v1pb.SQLReviewRule_WARNING:
+ level = storepb.SQLReviewRule_WARNING
default:
return nil, errors.Errorf("invalid rule level %v", rule.Level)
}
diff --git a/backend/api/v1/review_config_service.go b/backend/api/v1/review_config_service.go
index 50698ae7f7..cf528da963 100644
--- a/backend/api/v1/review_config_service.go
+++ b/backend/api/v1/review_config_service.go
@@ -292,7 +292,7 @@ func validateSQLReviewRules(rules []*v1pb.SQLReviewRule) error {
return errors.Errorf("invalid payload, rule list cannot be empty")
}
for _, rule := range rules {
- if rule.Level == v1pb.SQLReviewRuleLevel_LEVEL_UNSPECIFIED {
+ if rule.Level == v1pb.SQLReviewRule_LEVEL_UNSPECIFIED {
return errors.Errorf("invalid rule level: LEVEL_UNSPECIFIED is not allowed for rule %q", rule.Type)
}
ruleType := advisor.SQLReviewRuleType(rule.Type)
diff --git a/backend/api/v1/review_config_service_test.go b/backend/api/v1/review_config_service_test.go
index fd21ec004a..4860dae102 100644
--- a/backend/api/v1/review_config_service_test.go
+++ b/backend/api/v1/review_config_service_test.go
@@ -26,7 +26,7 @@ func TestValidateSQLReviewRules(t *testing.T) {
rules: []*v1pb.SQLReviewRule{
{
Type: "table.require-pk",
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
Payload: "",
},
@@ -38,7 +38,7 @@ func TestValidateSQLReviewRules(t *testing.T) {
rules: []*v1pb.SQLReviewRule{
{
Type: "table.require-pk",
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
Payload: "",
},
@@ -50,7 +50,7 @@ func TestValidateSQLReviewRules(t *testing.T) {
rules: []*v1pb.SQLReviewRule{
{
Type: "table.require-pk",
- Level: v1pb.SQLReviewRuleLevel_LEVEL_UNSPECIFIED,
+ Level: v1pb.SQLReviewRule_LEVEL_UNSPECIFIED,
Engine: v1pb.Engine_POSTGRES,
Payload: "",
},
@@ -63,13 +63,13 @@ func TestValidateSQLReviewRules(t *testing.T) {
rules: []*v1pb.SQLReviewRule{
{
Type: "table.require-pk",
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
Payload: "",
},
{
Type: "table.no-foreign-key",
- Level: v1pb.SQLReviewRuleLevel_LEVEL_UNSPECIFIED,
+ Level: v1pb.SQLReviewRule_LEVEL_UNSPECIFIED,
Engine: v1pb.Engine_POSTGRES,
Payload: "",
},
diff --git a/backend/generated-go/store/review_config.pb.go b/backend/generated-go/store/review_config.pb.go
index de09bbe81f..8d7d2a16ac 100644
--- a/backend/generated-go/store/review_config.pb.go
+++ b/backend/generated-go/store/review_config.pb.go
@@ -21,53 +21,57 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-type SQLReviewRuleLevel int32
+// The severity level for SQL review rules.
+type SQLReviewRule_Level int32
const (
- SQLReviewRuleLevel_LEVEL_UNSPECIFIED SQLReviewRuleLevel = 0
- SQLReviewRuleLevel_ERROR SQLReviewRuleLevel = 1
- SQLReviewRuleLevel_WARNING SQLReviewRuleLevel = 2
+ // Unspecified level.
+ SQLReviewRule_LEVEL_UNSPECIFIED SQLReviewRule_Level = 0
+ // Rule violation is an error.
+ SQLReviewRule_ERROR SQLReviewRule_Level = 1
+ // Rule violation is a warning.
+ SQLReviewRule_WARNING SQLReviewRule_Level = 2
)
-// Enum value maps for SQLReviewRuleLevel.
+// Enum value maps for SQLReviewRule_Level.
var (
- SQLReviewRuleLevel_name = map[int32]string{
+ SQLReviewRule_Level_name = map[int32]string{
0: "LEVEL_UNSPECIFIED",
1: "ERROR",
2: "WARNING",
}
- SQLReviewRuleLevel_value = map[string]int32{
+ SQLReviewRule_Level_value = map[string]int32{
"LEVEL_UNSPECIFIED": 0,
"ERROR": 1,
"WARNING": 2,
}
)
-func (x SQLReviewRuleLevel) Enum() *SQLReviewRuleLevel {
- p := new(SQLReviewRuleLevel)
+func (x SQLReviewRule_Level) Enum() *SQLReviewRule_Level {
+ p := new(SQLReviewRule_Level)
*p = x
return p
}
-func (x SQLReviewRuleLevel) String() string {
+func (x SQLReviewRule_Level) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
-func (SQLReviewRuleLevel) Descriptor() protoreflect.EnumDescriptor {
+func (SQLReviewRule_Level) Descriptor() protoreflect.EnumDescriptor {
return file_store_review_config_proto_enumTypes[0].Descriptor()
}
-func (SQLReviewRuleLevel) Type() protoreflect.EnumType {
+func (SQLReviewRule_Level) Type() protoreflect.EnumType {
return &file_store_review_config_proto_enumTypes[0]
}
-func (x SQLReviewRuleLevel) Number() protoreflect.EnumNumber {
+func (x SQLReviewRule_Level) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
-// Deprecated: Use SQLReviewRuleLevel.Descriptor instead.
-func (SQLReviewRuleLevel) EnumDescriptor() ([]byte, []int) {
- return file_store_review_config_proto_rawDescGZIP(), []int{0}
+// Deprecated: Use SQLReviewRule_Level.Descriptor instead.
+func (SQLReviewRule_Level) EnumDescriptor() ([]byte, []int) {
+ return file_store_review_config_proto_rawDescGZIP(), []int{1, 0}
}
type ReviewConfigPayload struct {
@@ -117,7 +121,7 @@ func (x *ReviewConfigPayload) GetSqlReviewRules() []*SQLReviewRule {
type SQLReviewRule struct {
state protoimpl.MessageState `protogen:"open.v1"`
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
- Level SQLReviewRuleLevel `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.store.SQLReviewRuleLevel" json:"level,omitempty"`
+ Level SQLReviewRule_Level `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.store.SQLReviewRule_Level" json:"level,omitempty"`
Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
Engine Engine `protobuf:"varint,4,opt,name=engine,proto3,enum=bytebase.store.Engine" json:"engine,omitempty"`
unknownFields protoimpl.UnknownFields
@@ -161,11 +165,11 @@ func (x *SQLReviewRule) GetType() string {
return ""
}
-func (x *SQLReviewRule) GetLevel() SQLReviewRuleLevel {
+func (x *SQLReviewRule) GetLevel() SQLReviewRule_Level {
if x != nil {
return x.Level
}
- return SQLReviewRuleLevel_LEVEL_UNSPECIFIED
+ return SQLReviewRule_LEVEL_UNSPECIFIED
}
func (x *SQLReviewRule) GetPayload() string {
@@ -188,13 +192,13 @@ const file_store_review_config_proto_rawDesc = "" +
"\n" +
"\x19store/review_config.proto\x12\x0ebytebase.store\x1a\x12store/common.proto\"^\n" +
"\x13ReviewConfigPayload\x12G\n" +
- "\x10sql_review_rules\x18\x01 \x03(\v2\x1d.bytebase.store.SQLReviewRuleR\x0esqlReviewRules\"\xa7\x01\n" +
+ "\x10sql_review_rules\x18\x01 \x03(\v2\x1d.bytebase.store.SQLReviewRuleR\x0esqlReviewRules\"\xe0\x01\n" +
"\rSQLReviewRule\x12\x12\n" +
- "\x04type\x18\x01 \x01(\tR\x04type\x128\n" +
- "\x05level\x18\x02 \x01(\x0e2\".bytebase.store.SQLReviewRuleLevelR\x05level\x12\x18\n" +
+ "\x04type\x18\x01 \x01(\tR\x04type\x129\n" +
+ "\x05level\x18\x02 \x01(\x0e2#.bytebase.store.SQLReviewRule.LevelR\x05level\x12\x18\n" +
"\apayload\x18\x03 \x01(\tR\apayload\x12.\n" +
- "\x06engine\x18\x04 \x01(\x0e2\x16.bytebase.store.EngineR\x06engine*C\n" +
- "\x12SQLReviewRuleLevel\x12\x15\n" +
+ "\x06engine\x18\x04 \x01(\x0e2\x16.bytebase.store.EngineR\x06engine\"6\n" +
+ "\x05Level\x12\x15\n" +
"\x11LEVEL_UNSPECIFIED\x10\x00\x12\t\n" +
"\x05ERROR\x10\x01\x12\v\n" +
"\aWARNING\x10\x02B\x94\x01\n" +
@@ -215,14 +219,14 @@ func file_store_review_config_proto_rawDescGZIP() []byte {
var file_store_review_config_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
var file_store_review_config_proto_msgTypes = make([]protoimpl.MessageInfo, 2)
var file_store_review_config_proto_goTypes = []any{
- (SQLReviewRuleLevel)(0), // 0: bytebase.store.SQLReviewRuleLevel
+ (SQLReviewRule_Level)(0), // 0: bytebase.store.SQLReviewRule.Level
(*ReviewConfigPayload)(nil), // 1: bytebase.store.ReviewConfigPayload
(*SQLReviewRule)(nil), // 2: bytebase.store.SQLReviewRule
(Engine)(0), // 3: bytebase.store.Engine
}
var file_store_review_config_proto_depIdxs = []int32{
2, // 0: bytebase.store.ReviewConfigPayload.sql_review_rules:type_name -> bytebase.store.SQLReviewRule
- 0, // 1: bytebase.store.SQLReviewRule.level:type_name -> bytebase.store.SQLReviewRuleLevel
+ 0, // 1: bytebase.store.SQLReviewRule.level:type_name -> bytebase.store.SQLReviewRule.Level
3, // 2: bytebase.store.SQLReviewRule.engine:type_name -> bytebase.store.Engine
3, // [3:3] is the sub-list for method output_type
3, // [3:3] is the sub-list for method input_type
diff --git a/backend/generated-go/v1/review_config_service.pb.go b/backend/generated-go/v1/review_config_service.pb.go
index 5fb498bcab..7567abe08c 100644
--- a/backend/generated-go/v1/review_config_service.pb.go
+++ b/backend/generated-go/v1/review_config_service.pb.go
@@ -26,56 +26,56 @@ const (
)
// The severity level for SQL review rules.
-type SQLReviewRuleLevel int32
+type SQLReviewRule_Level int32
const (
// Unspecified level.
- SQLReviewRuleLevel_LEVEL_UNSPECIFIED SQLReviewRuleLevel = 0
+ SQLReviewRule_LEVEL_UNSPECIFIED SQLReviewRule_Level = 0
// Rule violation is an error.
- SQLReviewRuleLevel_ERROR SQLReviewRuleLevel = 1
+ SQLReviewRule_ERROR SQLReviewRule_Level = 1
// Rule violation is a warning.
- SQLReviewRuleLevel_WARNING SQLReviewRuleLevel = 2
+ SQLReviewRule_WARNING SQLReviewRule_Level = 2
)
-// Enum value maps for SQLReviewRuleLevel.
+// Enum value maps for SQLReviewRule_Level.
var (
- SQLReviewRuleLevel_name = map[int32]string{
+ SQLReviewRule_Level_name = map[int32]string{
0: "LEVEL_UNSPECIFIED",
1: "ERROR",
2: "WARNING",
}
- SQLReviewRuleLevel_value = map[string]int32{
+ SQLReviewRule_Level_value = map[string]int32{
"LEVEL_UNSPECIFIED": 0,
"ERROR": 1,
"WARNING": 2,
}
)
-func (x SQLReviewRuleLevel) Enum() *SQLReviewRuleLevel {
- p := new(SQLReviewRuleLevel)
+func (x SQLReviewRule_Level) Enum() *SQLReviewRule_Level {
+ p := new(SQLReviewRule_Level)
*p = x
return p
}
-func (x SQLReviewRuleLevel) String() string {
+func (x SQLReviewRule_Level) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
-func (SQLReviewRuleLevel) Descriptor() protoreflect.EnumDescriptor {
+func (SQLReviewRule_Level) Descriptor() protoreflect.EnumDescriptor {
return file_v1_review_config_service_proto_enumTypes[0].Descriptor()
}
-func (SQLReviewRuleLevel) Type() protoreflect.EnumType {
+func (SQLReviewRule_Level) Type() protoreflect.EnumType {
return &file_v1_review_config_service_proto_enumTypes[0]
}
-func (x SQLReviewRuleLevel) Number() protoreflect.EnumNumber {
+func (x SQLReviewRule_Level) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
-// Deprecated: Use SQLReviewRuleLevel.Descriptor instead.
-func (SQLReviewRuleLevel) EnumDescriptor() ([]byte, []int) {
- return file_v1_review_config_service_proto_rawDescGZIP(), []int{0}
+// Deprecated: Use SQLReviewRule_Level.Descriptor instead.
+func (SQLReviewRule_Level) EnumDescriptor() ([]byte, []int) {
+ return file_v1_review_config_service_proto_rawDescGZIP(), []int{7, 0}
}
type ListReviewConfigsRequest struct {
@@ -451,7 +451,7 @@ type SQLReviewRule struct {
// The type of SQL review rule.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// The severity level of the rule.
- Level SQLReviewRuleLevel `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.v1.SQLReviewRuleLevel" json:"level,omitempty"`
+ Level SQLReviewRule_Level `protobuf:"varint,2,opt,name=level,proto3,enum=bytebase.v1.SQLReviewRule_Level" json:"level,omitempty"`
// The payload is a JSON string that varies by rule type.
Payload string `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
// The database engine this rule applies to.
@@ -497,11 +497,11 @@ func (x *SQLReviewRule) GetType() string {
return ""
}
-func (x *SQLReviewRule) GetLevel() SQLReviewRuleLevel {
+func (x *SQLReviewRule) GetLevel() SQLReviewRule_Level {
if x != nil {
return x.Level
}
- return SQLReviewRuleLevel_LEVEL_UNSPECIFIED
+ return SQLReviewRule_LEVEL_UNSPECIFIED
}
func (x *SQLReviewRule) GetPayload() string {
@@ -545,13 +545,13 @@ const file_v1_review_config_service_proto_rawDesc = "" +
"\aenabled\x18\x03 \x01(\bR\aenabled\x120\n" +
"\x05rules\x18\a \x03(\v2\x1a.bytebase.v1.SQLReviewRuleR\x05rules\x12\x1c\n" +
"\tresources\x18\b \x03(\tR\tresources:<\xeaA9\n" +
- "\x19bytebase.com/ReviewConfig\x12\x1creviewConfigs/{reviewConfig}\"\xa1\x01\n" +
+ "\x19bytebase.com/ReviewConfig\x12\x1creviewConfigs/{reviewConfig}\"\xda\x01\n" +
"\rSQLReviewRule\x12\x12\n" +
- "\x04type\x18\x01 \x01(\tR\x04type\x125\n" +
- "\x05level\x18\x02 \x01(\x0e2\x1f.bytebase.v1.SQLReviewRuleLevelR\x05level\x12\x18\n" +
+ "\x04type\x18\x01 \x01(\tR\x04type\x126\n" +
+ "\x05level\x18\x02 \x01(\x0e2 .bytebase.v1.SQLReviewRule.LevelR\x05level\x12\x18\n" +
"\apayload\x18\x03 \x01(\tR\apayload\x12+\n" +
- "\x06engine\x18\x04 \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine*C\n" +
- "\x12SQLReviewRuleLevel\x12\x15\n" +
+ "\x06engine\x18\x04 \x01(\x0e2\x13.bytebase.v1.EngineR\x06engine\"6\n" +
+ "\x05Level\x12\x15\n" +
"\x11LEVEL_UNSPECIFIED\x10\x00\x12\t\n" +
"\x05ERROR\x10\x01\x12\v\n" +
"\aWARNING\x10\x022\xed\x06\n" +
@@ -578,7 +578,7 @@ func file_v1_review_config_service_proto_rawDescGZIP() []byte {
var file_v1_review_config_service_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
var file_v1_review_config_service_proto_msgTypes = make([]protoimpl.MessageInfo, 8)
var file_v1_review_config_service_proto_goTypes = []any{
- (SQLReviewRuleLevel)(0), // 0: bytebase.v1.SQLReviewRuleLevel
+ (SQLReviewRule_Level)(0), // 0: bytebase.v1.SQLReviewRule.Level
(*ListReviewConfigsRequest)(nil), // 1: bytebase.v1.ListReviewConfigsRequest
(*ListReviewConfigsResponse)(nil), // 2: bytebase.v1.ListReviewConfigsResponse
(*CreateReviewConfigRequest)(nil), // 3: bytebase.v1.CreateReviewConfigRequest
@@ -597,7 +597,7 @@ var file_v1_review_config_service_proto_depIdxs = []int32{
7, // 2: bytebase.v1.UpdateReviewConfigRequest.review_config:type_name -> bytebase.v1.ReviewConfig
9, // 3: bytebase.v1.UpdateReviewConfigRequest.update_mask:type_name -> google.protobuf.FieldMask
8, // 4: bytebase.v1.ReviewConfig.rules:type_name -> bytebase.v1.SQLReviewRule
- 0, // 5: bytebase.v1.SQLReviewRule.level:type_name -> bytebase.v1.SQLReviewRuleLevel
+ 0, // 5: bytebase.v1.SQLReviewRule.level:type_name -> bytebase.v1.SQLReviewRule.Level
10, // 6: bytebase.v1.SQLReviewRule.engine:type_name -> bytebase.v1.Engine
3, // 7: bytebase.v1.ReviewConfigService.CreateReviewConfig:input_type -> bytebase.v1.CreateReviewConfigRequest
1, // 8: bytebase.v1.ReviewConfigService.ListReviewConfigs:input_type -> bytebase.v1.ListReviewConfigsRequest
diff --git a/backend/migrator/migration/3.11/0015##remove_disabled_sql_review_rules.sql b/backend/migrator/migration/3.11/0015##remove_disabled_sql_review_rules.sql
index f2e8fae9c4..d7aebd5cb2 100644
--- a/backend/migrator/migration/3.11/0015##remove_disabled_sql_review_rules.sql
+++ b/backend/migrator/migration/3.11/0015##remove_disabled_sql_review_rules.sql
@@ -1,6 +1,6 @@
-- Remove DISABLED rules from SQL review configurations.
--
--- Context: SQLReviewRuleLevel enum previously had DISABLED as an option.
+-- Context: SQLReviewRule_Level enum previously had DISABLED as an option.
-- This has been removed - rules should either be in the policy (ERROR/WARNING) or absent.
--
-- This migration filters out any rules with level = "DISABLED" from the sqlReviewRules array
diff --git a/backend/plugin/advisor/advisor.go b/backend/plugin/advisor/advisor.go
index fd17f01a84..832f68a196 100644
--- a/backend/plugin/advisor/advisor.go
+++ b/backend/plugin/advisor/advisor.go
@@ -23,11 +23,11 @@ const (
)
// NewStatusBySQLReviewRuleLevel returns status by SQLReviewRuleLevel.
-func NewStatusBySQLReviewRuleLevel(level storepb.SQLReviewRuleLevel) (storepb.Advice_Status, error) {
+func NewStatusBySQLReviewRuleLevel(level storepb.SQLReviewRule_Level) (storepb.Advice_Status, error) {
switch level {
- case storepb.SQLReviewRuleLevel_ERROR:
+ case storepb.SQLReviewRule_ERROR:
return storepb.Advice_ERROR, nil
- case storepb.SQLReviewRuleLevel_WARNING:
+ case storepb.SQLReviewRule_WARNING:
return storepb.Advice_WARNING, nil
default:
return storepb.Advice_STATUS_UNSPECIFIED, errors.Errorf("unexpected rule level type: %s", level)
diff --git a/backend/plugin/advisor/builtin_rules.go b/backend/plugin/advisor/builtin_rules.go
index d245164156..14f17caf67 100644
--- a/backend/plugin/advisor/builtin_rules.go
+++ b/backend/plugin/advisor/builtin_rules.go
@@ -12,7 +12,7 @@ func GetBuiltinRules(engine storepb.Engine) []*storepb.SQLReviewRule {
return []*storepb.SQLReviewRule{
{
Type: string(BuiltinRulePriorBackupCheck),
- Level: storepb.SQLReviewRuleLevel_ERROR,
+ Level: storepb.SQLReviewRule_ERROR,
Payload: "",
Engine: engine,
},
diff --git a/backend/plugin/advisor/pg/test_helper.go b/backend/plugin/advisor/pg/test_helper.go
index c29d9636be..61948e8d3e 100644
--- a/backend/plugin/advisor/pg/test_helper.go
+++ b/backend/plugin/advisor/pg/test_helper.go
@@ -103,7 +103,7 @@ func RunANTLRAdvisorRuleTest(t *testing.T, rule advisor.SQLReviewRuleType, dbTyp
ruleList := []*storepb.SQLReviewRule{
{
Type: string(rule),
- Level: storepb.SQLReviewRuleLevel_WARNING,
+ Level: storepb.SQLReviewRule_WARNING,
Payload: payload,
},
}
diff --git a/backend/plugin/advisor/utils_for_tests.go b/backend/plugin/advisor/utils_for_tests.go
index 2165d56171..73fb1b4bde 100644
--- a/backend/plugin/advisor/utils_for_tests.go
+++ b/backend/plugin/advisor/utils_for_tests.go
@@ -230,7 +230,7 @@ func RunSQLReviewRuleTest(t *testing.T, rule SQLReviewRuleType, dbType storepb.E
ruleList := []*storepb.SQLReviewRule{
{
Type: string(rule),
- Level: storepb.SQLReviewRuleLevel_WARNING,
+ Level: storepb.SQLReviewRule_WARNING,
Payload: string(payload),
},
}
diff --git a/backend/tests/sql_review_test.go b/backend/tests/sql_review_test.go
index e8a6dc035f..8b916a0b4c 100644
--- a/backend/tests/sql_review_test.go
+++ b/backend/tests/sql_review_test.go
@@ -533,153 +533,153 @@ func prodTemplateReviewConfigForPostgreSQL() (*v1pb.ReviewConfig, error) {
// Naming
{
Type: string(advisor.SchemaRuleTableNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleColumnNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleIDXNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRulePKNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleUKNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleFKNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
// Statement
{
Type: string(advisor.SchemaRuleStatementNoSelectAll),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleStatementRequireWhereForSelect),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleStatementRequireWhereForUpdateDelete),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleStatementNoLeadingWildcardLike),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleStatementDisallowCommit),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleStatementMergeAlterTable),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleStatementInsertDisallowOrderByRand),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
// TABLE
{
Type: string(advisor.SchemaRuleTableRequirePK),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleTableNoFK),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleTableDropNamingConvention),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleTableCommentConvention),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleTableDisallowPartition),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
// COLUMN
{
Type: string(advisor.SchemaRuleRequiredColumn),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleColumnNotNull),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleColumnDisallowChangeType),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleColumnTypeDisallowList),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleColumnMaximumCharacterLength),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
// SCHEMA
{
Type: string(advisor.SchemaRuleSchemaBackwardCompatibility),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
// INDEX
{
Type: string(advisor.SchemaRuleIndexNoDuplicateColumn),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleIndexKeyNumberLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleIndexTotalNumberLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
// SYSTEM
{
Type: string(advisor.SchemaRuleCharsetAllowlist),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
{
Type: string(advisor.SchemaRuleCollationAllowlist),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_POSTGRES,
},
},
@@ -704,260 +704,260 @@ func prodTemplateReviewConfigForMySQL() (*v1pb.ReviewConfig, error) {
// Engine
{
Type: string(advisor.SchemaRuleMySQLEngine),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
// Naming
{
Type: string(advisor.SchemaRuleTableNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleIDXNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleUKNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleFKNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleAutoIncrementColumnNaming),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
// Statement
{
Type: string(advisor.SchemaRuleStatementNoSelectAll),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementRequireWhereForSelect),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementRequireWhereForUpdateDelete),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementNoLeadingWildcardLike),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementDisallowCommit),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementDisallowLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementDisallowOrderBy),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementMergeAlterTable),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementInsertRowLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementInsertMustSpecifyColumn),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementInsertDisallowOrderByRand),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementAffectedRowLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleStatementDMLDryRun),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
// TABLE
{
Type: string(advisor.SchemaRuleTableRequirePK),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleTableNoFK),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleTableDropNamingConvention),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleTableCommentConvention),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleTableDisallowPartition),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
// COLUMN
{
Type: string(advisor.SchemaRuleRequiredColumn),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnNotNull),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnDisallowDropInIndex),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnDisallowChangeType),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnSetDefaultForNotNull),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnDisallowChange),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnDisallowChangingOrder),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnCommentConvention),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnAutoIncrementMustInteger),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnTypeDisallowList),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnDisallowSetCharset),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnMaximumCharacterLength),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnAutoIncrementInitialValue),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnAutoIncrementMustUnsigned),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleCurrentTimeColumnCountLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleColumnRequireDefault),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
// SCHEMA
{
Type: string(advisor.SchemaRuleSchemaBackwardCompatibility),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
// DATABASE
{
Type: string(advisor.SchemaRuleDropEmptyDatabase),
- Level: v1pb.SQLReviewRuleLevel_ERROR,
+ Level: v1pb.SQLReviewRule_ERROR,
Engine: v1pb.Engine_MYSQL,
},
// INDEX
{
Type: string(advisor.SchemaRuleIndexNoDuplicateColumn),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleIndexKeyNumberLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleIndexPKTypeLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleIndexTypeNoBlob),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleIndexTotalNumberLimit),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
// SYSTEM
{
Type: string(advisor.SchemaRuleCharsetAllowlist),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
{
Type: string(advisor.SchemaRuleCollationAllowlist),
- Level: v1pb.SQLReviewRuleLevel_WARNING,
+ Level: v1pb.SQLReviewRule_WARNING,
Engine: v1pb.Engine_MYSQL,
},
},
diff --git a/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue b/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue
index e761c4d9fb..2d2624c2fc 100644
--- a/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue
+++ b/frontend/src/components/PlanCheckRun/PlanCheckRunDetail.vue
@@ -265,7 +265,7 @@ import {
PlanCheckRun_ResultSchema,
PlanCheckRun_Status,
} from "@/types/proto-es/v1/plan_service_pb";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import { Advice_Level } from "@/types/proto-es/v1/sql_service_pb";
import { convertPositionLineToMonacoLine } from "@/utils/v1/position";
import { usePlanCheckRunContext } from "./context";
@@ -360,12 +360,12 @@ const isBuiltinRule = (type: string) => {
return type.startsWith("builtin.");
};
-const builtinRuleLevel = (type: string): SQLReviewRuleLevel => {
+const builtinRuleLevel = (type: string): SQLReviewRule_Level => {
switch (type) {
case "builtin.prior-backup-check":
- return SQLReviewRuleLevel.ERROR;
+ return SQLReviewRule_Level.ERROR;
default:
- return SQLReviewRuleLevel.ERROR;
+ return SQLReviewRule_Level.ERROR;
}
};
diff --git a/frontend/src/components/SQLReview/components/RuleLevelSwitch.vue b/frontend/src/components/SQLReview/components/RuleLevelSwitch.vue
index 98a7ff46c6..473413ebf3 100644
--- a/frontend/src/components/SQLReview/components/RuleLevelSwitch.vue
+++ b/frontend/src/components/SQLReview/components/RuleLevelSwitch.vue
@@ -15,11 +15,11 @@
<script lang="ts" setup>
import { computed } from "vue";
import { useI18n } from "vue-i18n";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
const props = withDefaults(
defineProps<{
- level: SQLReviewRuleLevel;
+ level: SQLReviewRule_Level;
disabled?: boolean;
editable?: boolean;
}>(),
@@ -30,7 +30,7 @@ const props = withDefaults(
);
defineEmits<{
- (event: "level-change", level: SQLReviewRuleLevel): void;
+ (event: "level-change", level: SQLReviewRule_Level): void;
}>();
const { t } = useI18n();
@@ -38,12 +38,12 @@ const { t } = useI18n();
const availableLevel = computed(() => {
return [
{
- level: SQLReviewRuleLevel.ERROR,
+ level: SQLReviewRule_Level.ERROR,
title: t("sql-review.level.error"),
class: "error",
},
{
- level: SQLReviewRuleLevel.WARNING,
+ level: SQLReviewRule_Level.WARNING,
title: t("sql-review.level.warning"),
class: "warning",
},
diff --git a/frontend/src/components/SQLReview/components/SQLReviewLevelFilter.vue b/frontend/src/components/SQLReview/components/SQLReviewLevelFilter.vue
index 0eaba94359..6b2b5874dd 100644
--- a/frontend/src/components/SQLReview/components/SQLReviewLevelFilter.vue
+++ b/frontend/src/components/SQLReview/components/SQLReviewLevelFilter.vue
@@ -25,16 +25,16 @@
<script lang="ts" setup>
import { NCheckbox } from "naive-ui";
import { computed } from "vue";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import type { RuleListWithCategory } from "./SQLReviewCategoryTabFilter.vue";
import SQLRuleLevelBadge from "./SQLRuleLevelBadge.vue";
-const LEVEL_LIST = [SQLReviewRuleLevel.ERROR, SQLReviewRuleLevel.WARNING];
+const LEVEL_LIST = [SQLReviewRule_Level.ERROR, SQLReviewRule_Level.WARNING];
const props = withDefaults(
defineProps<{
ruleList: RuleListWithCategory[];
- isCheckedLevel?: (level: SQLReviewRuleLevel) => boolean;
+ isCheckedLevel?: (level: SQLReviewRule_Level) => boolean;
}>(),
{
isCheckedLevel: () => false,
@@ -42,14 +42,18 @@ const props = withDefaults(
);
defineEmits<{
- (event: "toggle-checked-level", level: SQLReviewRuleLevel, on: boolean): void;
+ (
+ event: "toggle-checked-level",
+ level: SQLReviewRule_Level,
+ on: boolean
+ ): void;
}>();
const errorLevelList = computed(() => {
const map = LEVEL_LIST.reduce((m, level) => {
m.set(level, 0);
return m;
- }, new Map<SQLReviewRuleLevel, number>());
+ }, new Map<SQLReviewRule_Level, number>());
for (const ruleWithCategory of props.ruleList) {
for (const rule of ruleWithCategory.ruleList) {
@@ -60,14 +64,14 @@ const errorLevelList = computed(() => {
return map;
});
-// Helper function to convert SQLReviewRuleLevel to string
-const sqlReviewRuleLevelToString = (level: SQLReviewRuleLevel): string => {
+// Helper function to convert SQLReviewRule_Level to string
+const sqlReviewRuleLevelToString = (level: SQLReviewRule_Level): string => {
switch (level) {
- case SQLReviewRuleLevel.LEVEL_UNSPECIFIED:
+ case SQLReviewRule_Level.LEVEL_UNSPECIFIED:
return "LEVEL_UNSPECIFIED";
- case SQLReviewRuleLevel.ERROR:
+ case SQLReviewRule_Level.ERROR:
return "ERROR";
- case SQLReviewRuleLevel.WARNING:
+ case SQLReviewRule_Level.WARNING:
return "WARNING";
default:
return "UNKNOWN";
diff --git a/frontend/src/components/SQLReview/components/SQLRuleEditDialog.vue b/frontend/src/components/SQLReview/components/SQLRuleEditDialog.vue
index d13f91c6b2..9efd12c4f1 100644
--- a/frontend/src/components/SQLReview/components/SQLRuleEditDialog.vue
+++ b/frontend/src/components/SQLReview/components/SQLRuleEditDialog.vue
@@ -72,14 +72,14 @@ import { nextTick, reactive, ref, watch } from "vue";
import { BBModal } from "@/bbkit";
import { payloadValueListToComponentList } from "@/components/SQLReview/components";
import { RichEngineName } from "@/components/v2";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import type { RuleTemplateV2 } from "@/types/sqlReview";
import { getRuleLocalization } from "@/types/sqlReview";
import RuleConfig from "./RuleConfigComponents/RuleConfig.vue";
import RuleLevelSwitch from "./RuleLevelSwitch.vue";
type LocalState = {
- level: SQLReviewRuleLevel;
+ level: SQLReviewRule_Level;
};
const props = defineProps<{
diff --git a/frontend/src/components/SQLReview/components/SQLRuleFilter.vue b/frontend/src/components/SQLReview/components/SQLRuleFilter.vue
index bc50eae39c..aa5c4f7f3a 100644
--- a/frontend/src/components/SQLReview/components/SQLRuleFilter.vue
+++ b/frontend/src/components/SQLReview/components/SQLRuleFilter.vue
@@ -54,7 +54,7 @@ import { NCheckbox, NDivider } from "naive-ui";
import { SearchBox } from "@/components/v2";
import type { RuleTemplateV2 } from "@/types";
import { getRuleLocalization } from "@/types";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import type { RuleListWithCategory } from "./SQLReviewCategoryTabFilter.vue";
import SQLReviewCategoryTabFilter from "./SQLReviewCategoryTabFilter.vue";
import SQLReviewLevelFilter from "./SQLReviewLevelFilter.vue";
@@ -76,7 +76,7 @@ const props = withDefaults(
);
defineEmits<{
- (event: "toggle-checked-level", level: SQLReviewRuleLevel): void;
+ (event: "toggle-checked-level", level: SQLReviewRule_Level): void;
(event: "toggle-select-all", select: boolean): void;
(event: "change-category", category: string): void;
(event: "change-search-text", keyword: string): void;
diff --git a/frontend/src/components/SQLReview/components/SQLRuleLevelBadge.vue b/frontend/src/components/SQLReview/components/SQLRuleLevelBadge.vue
index 0c953810fd..b7c33c08c5 100644
--- a/frontend/src/components/SQLReview/components/SQLRuleLevelBadge.vue
+++ b/frontend/src/components/SQLReview/components/SQLRuleLevelBadge.vue
@@ -12,11 +12,11 @@ import { computed } from "vue";
import { useI18n } from "vue-i18n";
import { BBBadge } from "@/bbkit";
import type { BBBadgeStyle } from "@/bbkit/BBBadge.vue";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
const props = withDefaults(
defineProps<{
- level: SQLReviewRuleLevel;
+ level: SQLReviewRule_Level;
suffix?: string;
}>(),
{
@@ -28,23 +28,23 @@ const { t } = useI18n();
const style = computed((): BBBadgeStyle => {
switch (props.level) {
- case SQLReviewRuleLevel.ERROR:
+ case SQLReviewRule_Level.ERROR:
return "CRITICAL";
- case SQLReviewRuleLevel.WARNING:
+ case SQLReviewRule_Level.WARNING:
return "WARN";
default:
return "DISABLED";
}
});
-// Helper function to convert SQLReviewRuleLevel to string
-const sqlReviewRuleLevelToString = (level: SQLReviewRuleLevel): string => {
+// Helper function to convert SQLReviewRule_Level to string
+const sqlReviewRuleLevelToString = (level: SQLReviewRule_Level): string => {
switch (level) {
- case SQLReviewRuleLevel.LEVEL_UNSPECIFIED:
+ case SQLReviewRule_Level.LEVEL_UNSPECIFIED:
return "LEVEL_UNSPECIFIED";
- case SQLReviewRuleLevel.ERROR:
+ case SQLReviewRule_Level.ERROR:
return "ERROR";
- case SQLReviewRuleLevel.WARNING:
+ case SQLReviewRule_Level.WARNING:
return "WARNING";
default:
return "UNKNOWN";
diff --git a/frontend/src/components/SQLReview/components/SQLRuleTable.vue b/frontend/src/components/SQLReview/components/SQLRuleTable.vue
index 8b514cdd8d..91d3866f80 100644
--- a/frontend/src/components/SQLReview/components/SQLRuleTable.vue
+++ b/frontend/src/components/SQLReview/components/SQLRuleTable.vue
@@ -103,7 +103,7 @@ import { computed, reactive } from "vue";
import { useI18n } from "vue-i18n";
import type { RuleTemplateV2 } from "@/types";
import { getRuleLocalization } from "@/types";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import RuleConfig from "./RuleConfigComponents/RuleConfig.vue";
import RuleLevelSwitch from "./RuleLevelSwitch.vue";
import type { RuleListWithCategory } from "./SQLReviewCategoryTabFilter.vue";
@@ -294,7 +294,7 @@ const onRuleChanged = (update: Partial<RuleTemplateV2>) => {
emit("rule-upsert", state.activeRule, update);
};
-const updateLevel = (rule: RuleTemplateV2, level: SQLReviewRuleLevel) => {
+const updateLevel = (rule: RuleTemplateV2, level: SQLReviewRule_Level) => {
emit("rule-upsert", rule, { level });
};
</script>
diff --git a/frontend/src/components/SQLReview/components/useSQLRuleFilter.ts b/frontend/src/components/SQLReview/components/useSQLRuleFilter.ts
index 9800987c11..fd9324a1a6 100644
--- a/frontend/src/components/SQLReview/components/useSQLRuleFilter.ts
+++ b/frontend/src/components/SQLReview/components/useSQLRuleFilter.ts
@@ -1,9 +1,9 @@
import { reactive } from "vue";
import { useRoute } from "vue-router";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
export type SQLRuleFilterParams = {
- checkedLevel: Set<SQLReviewRuleLevel>;
+ checkedLevel: Set<SQLReviewRule_Level>;
selectedCategory: string;
searchText: string;
};
@@ -18,7 +18,7 @@ export const useSQLRuleFilter = () => {
searchText: "",
});
const events = {
- toggleCheckedLevel(level: SQLReviewRuleLevel) {
+ toggleCheckedLevel(level: SQLReviewRule_Level) {
if (params.checkedLevel.has(level)) {
params.checkedLevel.delete(level);
} else {
diff --git a/frontend/src/plugins/i18n.test.ts b/frontend/src/plugins/i18n.test.ts
index b8d725a232..15e85e9806 100644
--- a/frontend/src/plugins/i18n.test.ts
+++ b/frontend/src/plugins/i18n.test.ts
@@ -1,6 +1,6 @@
import { describe, expect, test } from "vitest";
import { Engine } from "@/types/proto-es/v1/common_pb";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import { getRuleLocalizationKey, TEMPLATE_LIST_V2 } from "../types/sqlReview";
import { mergedLocalMessage } from "./i18n-messages";
@@ -88,14 +88,14 @@ describe("Test i18n for SQL review", () => {
}
});
-// Helper function to convert SQLReviewRuleLevel to string
-const sqlReviewRuleLevelToString = (level: SQLReviewRuleLevel): string => {
+// Helper function to convert SQLReviewRule_Level to string
+const sqlReviewRuleLevelToString = (level: SQLReviewRule_Level): string => {
switch (level) {
- case SQLReviewRuleLevel.LEVEL_UNSPECIFIED:
+ case SQLReviewRule_Level.LEVEL_UNSPECIFIED:
return "LEVEL_UNSPECIFIED";
- case SQLReviewRuleLevel.ERROR:
+ case SQLReviewRule_Level.ERROR:
return "ERROR";
- case SQLReviewRuleLevel.WARNING:
+ case SQLReviewRule_Level.WARNING:
return "WARNING";
default:
return "UNKNOWN";
diff --git a/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts b/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts
index 8edbe1c244..8b76b3d746 100644
--- a/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/review_config_service_pb.d.ts
@@ -197,9 +197,9 @@ export declare type SQLReviewRule = Message<"bytebase.v1.SQLReviewRule"> & {
/**
* The severity level of the rule.
*
- * @generated from field: bytebase.v1.SQLReviewRuleLevel level = 2;
+ * @generated from field: bytebase.v1.SQLReviewRule.Level level = 2;
*/
- level: SQLReviewRuleLevel;
+ level: SQLReviewRule_Level;
/**
* The payload is a JSON string that varies by rule type.
@@ -225,9 +225,9 @@ export declare const SQLReviewRuleSchema: GenMessage<SQLReviewRule>;
/**
* The severity level for SQL review rules.
*
- * @generated from enum bytebase.v1.SQLReviewRuleLevel
+ * @generated from enum bytebase.v1.SQLReviewRule.Level
*/
-export enum SQLReviewRuleLevel {
+export enum SQLReviewRule_Level {
/**
* Unspecified level.
*
@@ -251,9 +251,9 @@ export enum SQLReviewRuleLevel {
}
/**
- * Describes the enum bytebase.v1.SQLReviewRuleLevel.
+ * Describes the enum bytebase.v1.SQLReviewRule.Level.
*/
-export declare const SQLReviewRuleLevelSchema: GenEnum<SQLReviewRuleLevel>;
+export declare const SQLReviewRule_LevelSchema: GenEnum<SQLReviewRule_Level>;
/**
* ReviewConfigService manages approval flow configurations.
diff --git a/frontend/src/types/proto-es/v1/review_config_service_pb.js b/frontend/src/types/proto-es/v1/review_config_service_pb.js
index 34534feeed..e9bafb4dce 100644
--- a/frontend/src/types/proto-es/v1/review_config_service_pb.js
+++ b/frontend/src/types/proto-es/v1/review_config_service_pb.js
@@ -16,7 +16,7 @@ import { file_v1_common } from "./common_pb";
* Describes the file v1/review_config_service.proto.
*/
export const file_v1_review_config_service = /*@__PURE__*/
- fileDesc("Ch52MS9yZXZpZXdfY29uZmlnX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIhoKGExpc3RSZXZpZXdDb25maWdzUmVxdWVzdCJOChlMaXN0UmV2aWV3Q29uZmlnc1Jlc3BvbnNlEjEKDnJldmlld19jb25maWdzGAEgAygLMhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIlIKGUNyZWF0ZVJldmlld0NvbmZpZ1JlcXVlc3QSNQoNcmV2aWV3X2NvbmZpZxgBIAEoCzIZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZ0ID4EECIpoBChlVcGRhdGVSZXZpZXdDb25maWdSZXF1ZXN0EjUKDXJldmlld19jb25maWcYASABKAsyGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWdCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJJChZHZXRSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyJMChlEZWxldGVSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyLHAQoMUmV2aWV3Q29uZmlnEhEKBG5hbWUYASABKAlCA+BBAxIXCgV0aXRsZRgCIAEoCUIIukgFcgMYyAESDwoHZW5hYmxlZBgDIAEoCBIpCgVydWxlcxgHIAMoCzIaLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUSEQoJcmVzb3VyY2VzGAggAygJOjzqQTkKGWJ5dGViYXNlLmNvbS9SZXZpZXdDb25maWcSHHJldmlld0NvbmZpZ3Mve3Jldmlld0NvbmZpZ30igwEKDVNRTFJldmlld1J1bGUSDAoEdHlwZRgBIAEoCRIuCgVsZXZlbBgCIAEoDjIfLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGVMZXZlbBIPCgdwYXlsb2FkGAMgASgJEiMKBmVuZ2luZRgEIAEoDjITLmJ5dGViYXNlLnYxLkVuZ2luZSpDChJTUUxSZXZpZXdSdWxlTGV2ZWwSFQoRTEVWRUxfVU5TUEVDSUZJRUQQABIJCgVFUlJPUhABEgsKB1dBUk5JTkcQAjLtBgoTUmV2aWV3Q29uZmlnU2VydmljZRKjAQoSQ3JlYXRlUmV2aWV3Q29uZmlnEiYuYnl0ZWJhc2UudjEuQ3JlYXRlUmV2aWV3Q29uZmlnUmVxdWVzdBoZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZyJK2kEAiuowF2JiLnJldmlld0NvbmZpZ3MuY3JlYXRlkOowAYLT5JMCIjoNcmV2aWV3X2NvbmZpZyIRL3YxL3Jldmlld0NvbmZpZ3MSnQEKEUxpc3RSZXZpZXdDb25maWdzEiUuYnl0ZWJhc2UudjEuTGlzdFJldmlld0NvbmZpZ3NSZXF1ZXN0GiYuYnl0ZWJhc2UudjEuTGlzdFJldmlld0NvbmZpZ3NSZXNwb25zZSI52kEAiuowFWJiLnJldmlld0NvbmZpZ3MubGlzdJDqMAGC0+STAhMSES92MS9yZXZpZXdDb25maWdzEpgBCg9HZXRSZXZpZXdDb25maWcSIy5ieXRlYmFzZS52MS5HZXRSZXZpZXdDb25maWdSZXF1ZXN0GhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIkXaQQRuYW1liuowFGJiLnJldmlld0NvbmZpZ3MuZ2V0kOowAYLT5JMCHBIaL3YxL3tuYW1lPXJldmlld0NvbmZpZ3MvKn0S0wEKElVwZGF0ZVJldmlld0NvbmZpZxImLmJ5dGViYXNlLnYxLlVwZGF0ZVJldmlld0NvbmZpZ1JlcXVlc3QaGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWcietpBGXJldmlld19jb25maWcsdXBkYXRlX21hc2uK6jAXYmIucmV2aWV3Q29uZmlncy51cGRhdGWQ6jABgtPkkwI5Og1yZXZpZXdfY29uZmlnMigvdjEve3Jldmlld19jb25maWcubmFtZT1yZXZpZXdDb25maWdzLyp9Ep4BChJEZWxldGVSZXZpZXdDb25maWcSJi5ieXRlYmFzZS52MS5EZWxldGVSZXZpZXdDb25maWdSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5IkjaQQRuYW1liuowF2JiLnJldmlld0NvbmZpZ3MuZGVsZXRlkOowAYLT5JMCHCoaL3YxL3tuYW1lPXJldmlld0NvbmZpZ3MvKn1CrgEKD2NvbS5ieXRlYmFzZS52MUIYUmV2aWV3Q29uZmlnU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation, file_v1_common]);
+ fileDesc("Ch52MS9yZXZpZXdfY29uZmlnX3NlcnZpY2UucHJvdG8SC2J5dGViYXNlLnYxIhoKGExpc3RSZXZpZXdDb25maWdzUmVxdWVzdCJOChlMaXN0UmV2aWV3Q29uZmlnc1Jlc3BvbnNlEjEKDnJldmlld19jb25maWdzGAEgAygLMhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIlIKGUNyZWF0ZVJldmlld0NvbmZpZ1JlcXVlc3QSNQoNcmV2aWV3X2NvbmZpZxgBIAEoCzIZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZ0ID4EECIpoBChlVcGRhdGVSZXZpZXdDb25maWdSZXF1ZXN0EjUKDXJldmlld19jb25maWcYASABKAsyGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWdCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJJChZHZXRSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyJMChlEZWxldGVSZXZpZXdDb25maWdSZXF1ZXN0Ei8KBG5hbWUYASABKAlCIeBBAvpBGwoZYnl0ZWJhc2UuY29tL1Jldmlld0NvbmZpZyLHAQoMUmV2aWV3Q29uZmlnEhEKBG5hbWUYASABKAlCA+BBAxIXCgV0aXRsZRgCIAEoCUIIukgFcgMYyAESDwoHZW5hYmxlZBgDIAEoCBIpCgVydWxlcxgHIAMoCzIaLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUSEQoJcmVzb3VyY2VzGAggAygJOjzqQTkKGWJ5dGViYXNlLmNvbS9SZXZpZXdDb25maWcSHHJldmlld0NvbmZpZ3Mve3Jldmlld0NvbmZpZ30ivAEKDVNRTFJldmlld1J1bGUSDAoEdHlwZRgBIAEoCRIvCgVsZXZlbBgCIAEoDjIgLmJ5dGViYXNlLnYxLlNRTFJldmlld1J1bGUuTGV2ZWwSDwoHcGF5bG9hZBgDIAEoCRIjCgZlbmdpbmUYBCABKA4yEy5ieXRlYmFzZS52MS5FbmdpbmUiNgoFTGV2ZWwSFQoRTEVWRUxfVU5TUEVDSUZJRUQQABIJCgVFUlJPUhABEgsKB1dBUk5JTkcQAjLtBgoTUmV2aWV3Q29uZmlnU2VydmljZRKjAQoSQ3JlYXRlUmV2aWV3Q29uZmlnEiYuYnl0ZWJhc2UudjEuQ3JlYXRlUmV2aWV3Q29uZmlnUmVxdWVzdBoZLmJ5dGViYXNlLnYxLlJldmlld0NvbmZpZyJK2kEAiuowF2JiLnJldmlld0NvbmZpZ3MuY3JlYXRlkOowAYLT5JMCIjoNcmV2aWV3X2NvbmZpZyIRL3YxL3Jldmlld0NvbmZpZ3MSnQEKEUxpc3RSZXZpZXdDb25maWdzEiUuYnl0ZWJhc2UudjEuTGlzdFJldmlld0NvbmZpZ3NSZXF1ZXN0GiYuYnl0ZWJhc2UudjEuTGlzdFJldmlld0NvbmZpZ3NSZXNwb25zZSI52kEAiuowFWJiLnJldmlld0NvbmZpZ3MubGlzdJDqMAGC0+STAhMSES92MS9yZXZpZXdDb25maWdzEpgBCg9HZXRSZXZpZXdDb25maWcSIy5ieXRlYmFzZS52MS5HZXRSZXZpZXdDb25maWdSZXF1ZXN0GhkuYnl0ZWJhc2UudjEuUmV2aWV3Q29uZmlnIkXaQQRuYW1liuowFGJiLnJldmlld0NvbmZpZ3MuZ2V0kOowAYLT5JMCHBIaL3YxL3tuYW1lPXJldmlld0NvbmZpZ3MvKn0S0wEKElVwZGF0ZVJldmlld0NvbmZpZxImLmJ5dGViYXNlLnYxLlVwZGF0ZVJldmlld0NvbmZpZ1JlcXVlc3QaGS5ieXRlYmFzZS52MS5SZXZpZXdDb25maWcietpBGXJldmlld19jb25maWcsdXBkYXRlX21hc2uK6jAXYmIucmV2aWV3Q29uZmlncy51cGRhdGWQ6jABgtPkkwI5Og1yZXZpZXdfY29uZmlnMigvdjEve3Jldmlld19jb25maWcubmFtZT1yZXZpZXdDb25maWdzLyp9Ep4BChJEZWxldGVSZXZpZXdDb25maWcSJi5ieXRlYmFzZS52MS5EZWxldGVSZXZpZXdDb25maWdSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5IkjaQQRuYW1liuowF2JiLnJldmlld0NvbmZpZ3MuZGVsZXRlkOowAYLT5JMCHCoaL3YxL3tuYW1lPXJldmlld0NvbmZpZ3MvKn1CrgEKD2NvbS5ieXRlYmFzZS52MUIYUmV2aWV3Q29uZmlnU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation, file_v1_common]);
/**
* Describes the message bytebase.v1.ListReviewConfigsRequest.
@@ -75,18 +75,18 @@ export const SQLReviewRuleSchema = /*@__PURE__*/
messageDesc(file_v1_review_config_service, 7);
/**
- * Describes the enum bytebase.v1.SQLReviewRuleLevel.
+ * Describes the enum bytebase.v1.SQLReviewRule.Level.
*/
-export const SQLReviewRuleLevelSchema = /*@__PURE__*/
- enumDesc(file_v1_review_config_service, 0);
+export const SQLReviewRule_LevelSchema = /*@__PURE__*/
+ enumDesc(file_v1_review_config_service, 7, 0);
/**
* The severity level for SQL review rules.
*
- * @generated from enum bytebase.v1.SQLReviewRuleLevel
+ * @generated from enum bytebase.v1.SQLReviewRule.Level
*/
-export const SQLReviewRuleLevel = /*@__PURE__*/
- tsEnum(SQLReviewRuleLevelSchema);
+export const SQLReviewRule_Level = /*@__PURE__*/
+ tsEnum(SQLReviewRule_LevelSchema);
/**
* ReviewConfigService manages approval flow configurations.
diff --git a/frontend/src/types/sqlReview.test.ts b/frontend/src/types/sqlReview.test.ts
index fdff43b8ab..8e8a462322 100644
--- a/frontend/src/types/sqlReview.test.ts
+++ b/frontend/src/types/sqlReview.test.ts
@@ -1,5 +1,5 @@
import { describe, expect, test } from "vitest";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import sqlReviewDevTemplate from "./sql-review.dev.yaml";
import sqlReviewProdTemplate from "./sql-review.prod.yaml";
import sqlReviewSampleTemplate from "./sql-review.sample.yaml";
@@ -70,11 +70,11 @@ describe("SQL Review YAML Templates Validation", () => {
});
});
- test("all rules must be convertible to SQLReviewRuleLevel enum", () => {
+ test("all rules must be convertible to SQLReviewRule_Level enum", () => {
data.ruleList.forEach((rule: any, index: number) => {
const ruleDesc = `rule[${index}] (${rule.type})`;
- const levelKey = rule.level as keyof typeof SQLReviewRuleLevel;
- const levelValue = SQLReviewRuleLevel[levelKey];
+ const levelKey = rule.level as keyof typeof SQLReviewRule_Level;
+ const levelValue = SQLReviewRule_Level[levelKey];
expect(
levelValue,
@@ -83,7 +83,7 @@ describe("SQL Review YAML Templates Validation", () => {
expect(
levelValue,
`${ruleDesc} level must not be LEVEL_UNSPECIFIED (0)`
- ).not.toBe(SQLReviewRuleLevel.LEVEL_UNSPECIFIED);
+ ).not.toBe(SQLReviewRule_Level.LEVEL_UNSPECIFIED);
});
});
});
diff --git a/frontend/src/types/sqlReview.ts b/frontend/src/types/sqlReview.ts
index 80631d5dbc..a308fbd627 100644
--- a/frontend/src/types/sqlReview.ts
+++ b/frontend/src/types/sqlReview.ts
@@ -1,6 +1,6 @@
import { t, te } from "@/plugins/i18n";
import { Engine } from "@/types/proto-es/v1/common_pb";
-import { SQLReviewRuleLevel } from "@/types/proto-es/v1/review_config_service_pb";
+import { SQLReviewRule_Level } from "@/types/proto-es/v1/review_config_service_pb";
import sqlReviewDevTemplate from "./sql-review.dev.yaml";
import sqlReviewProdTemplate from "./sql-review.prod.yaml";
import sqlReviewSampleTemplate from "./sql-review.sample.yaml";
@@ -102,7 +102,7 @@ interface CasePayload {
// Used by the backend
export interface SchemaPolicyRule {
type: string;
- level: SQLReviewRuleLevel;
+ level: SQLReviewRule_Level;
engine: Engine;
payload?:
| NamingFormatPayload
@@ -133,7 +133,7 @@ interface RuleTemplateV2Raw {
type: string;
category: string;
engine: string; // keyof typeof Engine
- level: string; // keyof typeof SQLReviewRuleLevel
+ level: string; // keyof typeof SQLReviewRule_Level
componentList: RuleConfigComponent[];
}
@@ -142,7 +142,7 @@ export interface RuleTemplateV2 {
type: string;
category: string;
engine: Engine;
- level: SQLReviewRuleLevel;
+ level: SQLReviewRule_Level;
componentList: RuleConfigComponent[];
}
@@ -180,7 +180,7 @@ const convertRuleTemplateV2Raw = (
// Schema rules from YAML don't have levels (enforced by tests).
// WARNING is the default severity when users add these rules to their policies.
- const level = SQLReviewRuleLevel.WARNING;
+ const level = SQLReviewRule_Level.WARNING;
return {
...rawRule,
@@ -207,7 +207,7 @@ export const TEMPLATE_LIST_V2: SQLReviewPolicyTemplateV2[] = (function () {
id: string;
ruleList: {
type: string;
- level: string; // keyof typeof SQLReviewRuleLevel
+ level: string; // keyof typeof SQLReviewRule_Level
payload?: PayloadObject;
engine: string; // keyof typeof Engine
}[];
@@ -232,8 +232,8 @@ export const TEMPLATE_LIST_V2: SQLReviewPolicyTemplateV2[] = (function () {
`Template rule ${rule.type} is missing required 'level' field in template ${template.id}`
);
}
- const levelKey = rule.level as keyof typeof SQLReviewRuleLevel;
- const level = SQLReviewRuleLevel[levelKey];
+ const levelKey = rule.level as keyof typeof SQLReviewRule_Level;
+ const level = SQLReviewRule_Level[levelKey];
if (level === undefined) {
throw new Error(
`Template rule ${rule.type} has invalid level '${rule.level}' in template ${template.id}`
diff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.md
index 105c1e8cf6..589e39affa 100644
--- a/proto/gen/grpc-doc/store/README.md
+++ b/proto/gen/grpc-doc/store/README.md
@@ -245,7 +245,7 @@
- [ReviewConfigPayload](#bytebase-store-ReviewConfigPayload)
- [SQLReviewRule](#bytebase-store-SQLReviewRule)
- - [SQLReviewRuleLevel](#bytebase-store-SQLReviewRuleLevel)
+ - [SQLReviewRule.Level](#bytebase-store-SQLReviewRule-Level)
- [store/revision.proto](#store_revision-proto)
- [RevisionPayload](#bytebase-store-RevisionPayload)
@@ -4008,7 +4008,7 @@ ISSUE_CREATE represents creating an issue. |
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [string](#string) | | |
-| level | [SQLReviewRuleLevel](#bytebase-store-SQLReviewRuleLevel) | | |
+| level | [SQLReviewRule.Level](#bytebase-store-SQLReviewRule-Level) | | |
| payload | [string](#string) | | |
| engine | [Engine](#bytebase-store-Engine) | | |
@@ -4019,16 +4019,16 @@ ISSUE_CREATE represents creating an issue. |
-<a name="bytebase-store-SQLReviewRuleLevel"></a>
-
-### SQLReviewRuleLevel
+<a name="bytebase-store-SQLReviewRule-Level"></a>
+### SQLReviewRule.Level
+The severity level for SQL review rules.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| LEVEL_UNSPECIFIED | 0 | |
-| ERROR | 1 | |
-| WARNING | 2 | |
+| LEVEL_UNSPECIFIED | 0 | Unspecified level. |
+| ERROR | 1 | Rule violation is an error. |
+| WARNING | 2 | Rule violation is a warning. |
diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.html
index d936a643dd..4f7c05803a 100644
--- a/proto/gen/grpc-doc/store/index.html
+++ b/proto/gen/grpc-doc/store/index.html
@@ -1147,7 +1147,7 @@
<li>
- <a href="#bytebase.store.SQLReviewRuleLevel"><span class="badge">E</span>SQLReviewRuleLevel</a>
+ <a href="#bytebase.store.SQLReviewRule.Level"><span class="badge">E</span>SQLReviewRule.Level</a>
</li>
@@ -10829,7 +10829,7 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tr>
<td>level</td>
- <td><a href="#bytebase.store.SQLReviewRuleLevel">SQLReviewRuleLevel</a></td>
+ <td><a href="#bytebase.store.SQLReviewRule.Level">SQLReviewRule.Level</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -10857,8 +10857,8 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.store.SQLReviewRuleLevel">SQLReviewRuleLevel</h3>
- <p></p>
+ <h3 id="bytebase.store.SQLReviewRule.Level">SQLReviewRule.Level</h3>
+ <p>The severity level for SQL review rules.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -10868,19 +10868,19 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tr>
<td>LEVEL_UNSPECIFIED</td>
<td>0</td>
- <td><p></p></td>
+ <td><p>Unspecified level.</p></td>
</tr>
<tr>
<td>ERROR</td>
<td>1</td>
- <td><p></p></td>
+ <td><p>Rule violation is an error.</p></td>
</tr>
<tr>
<td>WARNING</td>
<td>2</td>
- <td><p></p></td>
+ <td><p>Rule violation is a warning.</p></td>
</tr>
</tbody>
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index 647808c345..5cb870515f 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -549,7 +549,7 @@
- [SQLReviewRule](#bytebase-v1-SQLReviewRule)
- [UpdateReviewConfigRequest](#bytebase-v1-UpdateReviewConfigRequest)
- - [SQLReviewRuleLevel](#bytebase-v1-SQLReviewRuleLevel)
+ - [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level)
- [ReviewConfigService](#bytebase-v1-ReviewConfigService)
@@ -9004,7 +9004,7 @@ SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for d
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [string](#string) | | The type of SQL review rule. |
-| level | [SQLReviewRuleLevel](#bytebase-v1-SQLReviewRuleLevel) | | The severity level of the rule. |
+| level | [SQLReviewRule.Level](#bytebase-v1-SQLReviewRule-Level) | | The severity level of the rule. |
| payload | [string](#string) | | The payload is a JSON string that varies by rule type. |
| engine | [Engine](#bytebase-v1-Engine) | | The database engine this rule applies to. |
@@ -9034,9 +9034,9 @@ The name field is used to identify the SQL review config to update. |
-<a name="bytebase-v1-SQLReviewRuleLevel"></a>
+<a name="bytebase-v1-SQLReviewRule-Level"></a>
-### SQLReviewRuleLevel
+### SQLReviewRule.Level
The severity level for SQL review rules.
| Name | Number | Description |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 5aa1102d11..7c0ea4d632 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -2274,7 +2274,7 @@
<li>
- <a href="#bytebase.v1.SQLReviewRuleLevel"><span class="badge">E</span>SQLReviewRuleLevel</a>
+ <a href="#bytebase.v1.SQLReviewRule.Level"><span class="badge">E</span>SQLReviewRule.Level</a>
</li>
@@ -25224,7 +25224,7 @@ Format: {resource}/{resource id}, e.g., environments/test. </p></td>
<tr>
<td>level</td>
- <td><a href="#bytebase.v1.SQLReviewRuleLevel">SQLReviewRuleLevel</a></td>
+ <td><a href="#bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</a></td>
<td></td>
<td><p>The severity level of the rule. </p></td>
</tr>
@@ -25293,7 +25293,7 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.SQLReviewRuleLevel">SQLReviewRuleLevel</h3>
+ <h3 id="bytebase.v1.SQLReviewRule.Level">SQLReviewRule.Level</h3>
<p>The severity level for SQL review rules.</p>
<table class="enum-table">
<thead>
diff --git a/proto/store/store/review_config.proto b/proto/store/store/review_config.proto
index 728a8dcc29..d1282d9102 100644
--- a/proto/store/store/review_config.proto
+++ b/proto/store/store/review_config.proto
@@ -11,14 +11,18 @@ message ReviewConfigPayload {
}
message SQLReviewRule {
+ // The severity level for SQL review rules.
+ enum Level {
+ // Unspecified level.
+ LEVEL_UNSPECIFIED = 0;
+ // Rule violation is an error.
+ ERROR = 1;
+ // Rule violation is a warning.
+ WARNING = 2;
+ }
+
string type = 1;
- SQLReviewRuleLevel level = 2;
+ Level level = 2;
string payload = 3;
Engine engine = 4;
}
-
-enum SQLReviewRuleLevel {
- LEVEL_UNSPECIFIED = 0;
- ERROR = 1;
- WARNING = 2;
-}
diff --git a/proto/v1/v1/review_config_service.proto b/proto/v1/v1/review_config_service.proto
index feee7fb5f8..a24497187b 100644
--- a/proto/v1/v1/review_config_service.proto
+++ b/proto/v1/v1/review_config_service.proto
@@ -139,23 +139,23 @@ message ReviewConfig {
// SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
message SQLReviewRule {
+ // The severity level for SQL review rules.
+ enum Level {
+ // Unspecified level.
+ LEVEL_UNSPECIFIED = 0;
+ // Rule violation is an error.
+ ERROR = 1;
+ // Rule violation is a warning.
+ WARNING = 2;
+ }
+
// The type of SQL review rule.
string type = 1;
// The severity level of the rule.
- SQLReviewRuleLevel level = 2;
+ Level level = 2;
// The payload is a JSON string that varies by rule type.
string payload = 3;
// The database engine this rule applies to.
Engine engine = 4;
}
-
-// The severity level for SQL review rules.
-enum SQLReviewRuleLevel {
- // Unspecified level.
- LEVEL_UNSPECIFIED = 0;
- // Rule violation is an error.
- ERROR = 1;
- // Rule violation is a warning.
- WARNING = 2;
-}