Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix: rename approval approver principalId to principal and migrate to email format (#18435)
Danny Xu128cc628704b
diff --git a/backend/api/v1/issue_service.go b/backend/api/v1/issue_service.goindex 5bcd2c0c89..275382c4c9 100644--- a/backend/api/v1/issue_service.go+++ b/backend/api/v1/issue_service.go@@ -746,8 +746,8 @@ func (s *IssueService) ApproveIssue(ctx context.Context, req *connect.Request[v1}payload.Approval.Approvers = append(payload.Approval.Approvers, &storepb.IssuePayloadApproval_Approver{- Status: storepb.IssuePayloadApproval_Approver_APPROVED,- PrincipalId: int32(user.ID),+ Status: storepb.IssuePayloadApproval_Approver_APPROVED,+ Principal: common.FormatUserEmail(user.Email),})approved, err := utils.CheckApprovalApproved(payload.Approval)@@ -929,8 +929,8 @@ func (s *IssueService) RejectIssue(ctx context.Context, req *connect.Request[v1preturn nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot reject because the user does not have the required permission"))}payload.Approval.Approvers = append(payload.Approval.Approvers, &storepb.IssuePayloadApproval_Approver{- Status: storepb.IssuePayloadApproval_Approver_REJECTED,- PrincipalId: int32(user.ID),+ Status: storepb.IssuePayloadApproval_Approver_REJECTED,+ Principal: common.FormatUserEmail(user.Email),})issue, err = s.store.UpdateIssue(ctx, issue.UID, &store.UpdateIssueMessage{diff --git a/backend/api/v1/issue_service_converter.go b/backend/api/v1/issue_service_converter.goindex 3cdbda373c..71369e76ac 100644--- a/backend/api/v1/issue_service_converter.go+++ b/backend/api/v1/issue_service_converter.go@@ -117,12 +117,10 @@ func (s *IssueService) convertToIssue(ctx context.Context, issue *store.IssueMesissueV1.ApprovalTemplate = convertToApprovalTemplate(template)}for _, approver := range approval.GetApprovers() {- convertedApprover := &v1pb.Issue_Approver{Status: v1pb.Issue_Approver_Status(approver.GetStatus())}- user, err := s.store.GetUserByID(ctx, int(approver.GetPrincipalId()))- if err != nil {- return nil, errors.Wrapf(err, "failed to find user by id %v", approver.GetPrincipalId())+ convertedApprover := &v1pb.Issue_Approver{+ Status: v1pb.Issue_Approver_Status(approver.GetStatus()),+ Principal: approver.GetPrincipal(),}- convertedApprover.Principal = fmt.Sprintf("users/%s", user.Email)issueV1.Approvers = append(issueV1.Approvers, convertedApprover)}issueV1.ApprovalStatus = computeApprovalStatus(approval)diff --git a/backend/generated-go/store/approval.pb.go b/backend/generated-go/store/approval.pb.goindex b3325ebb9f..334f26f5f8 100644--- a/backend/generated-go/store/approval.pb.go+++ b/backend/generated-go/store/approval.pb.go@@ -266,8 +266,9 @@ type IssuePayloadApproval_Approver struct {state protoimpl.MessageState `protogen:"open.v1"`// The current approval status.Status IssuePayloadApproval_Approver_Status `protobuf:"varint,1,opt,name=status,proto3,enum=bytebase.store.IssuePayloadApproval_Approver_Status" json:"status,omitempty"`- // The ID of the principal who is the approver.- PrincipalId int32 `protobuf:"varint,2,opt,name=principal_id,json=principalId,proto3" json:"principal_id,omitempty"`+ // The principal who is the approver.+ // Format: users/{email}.+ Principal string `protobuf:"bytes,2,opt,name=principal,proto3" json:"principal,omitempty"`unknownFields protoimpl.UnknownFieldssizeCache protoimpl.SizeCache}@@ -309,26 +310,26 @@ func (x *IssuePayloadApproval_Approver) GetStatus() IssuePayloadApproval_Approvereturn IssuePayloadApproval_Approver_STATUS_UNSPECIFIED}-func (x *IssuePayloadApproval_Approver) GetPrincipalId() int32 {+func (x *IssuePayloadApproval_Approver) GetPrincipal() string {if x != nil {- return x.PrincipalId+ return x.Principal}- return 0+ return ""}var File_store_approval_proto protoreflect.FileDescriptorconst file_store_approval_proto_rawDesc = "" +"\n" +- "\x14store/approval.proto\x12\x0ebytebase.store\"\xf7\x03\n" ++ "\x14store/approval.proto\x12\x0ebytebase.store\"\xf2\x03\n" +"\x14IssuePayloadApproval\x12M\n" +"\x11approval_template\x18\x01 \x01(\v2 .bytebase.store.ApprovalTemplateR\x10approvalTemplate\x12K\n" +"\tapprovers\x18\x02 \x03(\v2-.bytebase.store.IssuePayloadApproval.ApproverR\tapprovers\x122\n" +"\x15approval_finding_done\x18\x03 \x01(\bR\x13approvalFindingDone\x124\n" +- "\x16approval_finding_error\x18\x04 \x01(\tR\x14approvalFindingError\x1a\xc6\x01\n" ++ "\x16approval_finding_error\x18\x04 \x01(\tR\x14approvalFindingError\x1a\xc1\x01\n" +"\bApprover\x12L\n" +- "\x06status\x18\x01 \x01(\x0e24.bytebase.store.IssuePayloadApproval.Approver.StatusR\x06status\x12!\n" +- "\fprincipal_id\x18\x02 \x01(\x05R\vprincipalId\"I\n" ++ "\x06status\x18\x01 \x01(\x0e24.bytebase.store.IssuePayloadApproval.Approver.StatusR\x06status\x12\x1c\n" ++ "\tprincipal\x18\x02 \x01(\tR\tprincipal\"I\n" +"\x06Status\x12\x16\n" +"\x12STATUS_UNSPECIFIED\x10\x00\x12\v\n" +"\aPENDING\x10\x01\x12\f\n" +diff --git a/backend/generated-go/store/approval_equal.pb.go b/backend/generated-go/store/approval_equal.pb.goindex 6f5000f887..aa68c4d7f8 100644--- a/backend/generated-go/store/approval_equal.pb.go+++ b/backend/generated-go/store/approval_equal.pb.go@@ -13,7 +13,7 @@ func (x *IssuePayloadApproval_Approver) Equal(y *IssuePayloadApproval_Approver)if x.Status != y.Status {return false}- if x.PrincipalId != y.PrincipalId {+ if x.Principal != y.Principal {return false}return truediff --git a/backend/migrator/migration/3.13/0021##migrate_user_id_to_email.sql b/backend/migrator/migration/3.13/0021##migrate_user_id_to_email.sqlindex 1710d79fda..c0315fc1ce 100644--- a/backend/migrator/migration/3.13/0021##migrate_user_id_to_email.sql+++ b/backend/migrator/migration/3.13/0021##migrate_user_id_to_email.sql@@ -175,7 +175,7 @@ WHERE payload->'grantRequest'->>'user' LIKE 'users/%'AND payload->'grantRequest'->>'user' NOT LIKE 'users/%@%';-- ============================================================================--- 5. Update issue table - Approval approvers (principalId field)+-- 5. Update issue table - Approval approvers (rename principalId to principal and convert value)-- ============================================================================UPDATE issueSET payload = (@@ -186,11 +186,11 @@ SET payload = ((SELECT jsonb_agg(CASE- WHEN approver->>'principalId' ~ '^\d+$' THEN- jsonb_set(- approver,- '{principalId}',- to_jsonb(COALESCE(+ -- If principalId exists and is numeric, convert to principal with email format+ WHEN approver ? 'principalId' AND approver->>'principalId' ~ '^\d+$' THEN+ jsonb_build_object(+ 'status', approver->'status',+ 'principal', to_jsonb(COALESCE((SELECT u.email_formatFROM user_id_to_email u@@ -199,6 +199,13 @@ SET payload = ('users/' || (approver->>'principalId'))))+ -- If principalId exists but is already email format, rename to principal+ WHEN approver ? 'principalId' THEN+ jsonb_build_object(+ 'status', approver->'status',+ 'principal', approver->'principalId'+ )+ -- Otherwise keep as-is (already has principal field or no field)ELSE approverEND)@@ -212,7 +219,7 @@ WHERE payload->'approval' ? 'approvers'AND EXISTS (SELECT 1FROM jsonb_array_elements(payload->'approval'->'approvers') AS approver- WHERE approver->>'principalId' ~ '^\d+$'+ WHERE approver ? 'principalId');-- ============================================================================diff --git a/backend/store/principal.go b/backend/store/principal.goindex 6584970177..401470fa19 100644--- a/backend/store/principal.go+++ b/backend/store/principal.go@@ -574,6 +574,41 @@ func (s *Store) UpdateUserEmail(ctx context.Context, user *UserMessage, newEmailreturn nil, errors.Wrapf(err, "failed to update issue grant request")}+ // 2b. Update Approval approvers in Issue payload+ // The principal in approvers is stored as "users/{email}" within the JSON payload.+ // We need to update each approver's principal field if it matches the old user reference.+ approverSQL := `+ UPDATE issue+ SET payload = (+ SELECT jsonb_set(+ issue.payload,+ '{approval,approvers}',+ COALESCE(+ (+ SELECT jsonb_agg(+ CASE+ WHEN approver->>'principal' = $1 THEN+ jsonb_set(approver, '{principal}', to_jsonb($2::text))+ ELSE approver+ END+ )+ FROM jsonb_array_elements(issue.payload->'approval'->'approvers') AS approver+ ),+ '[]'::jsonb+ )+ )+ )+ WHERE payload->'approval' ? 'approvers'+ AND EXISTS (+ SELECT 1+ FROM jsonb_array_elements(payload->'approval'->'approvers') AS approver+ WHERE approver->>'principal' = $1+ )`++ if _, err := tx.ExecContext(ctx, approverSQL, oldUserRef, newUserRef); err != nil {+ return nil, errors.Wrapf(err, "failed to update issue approval approvers")+ }+// 3. Update Policies// Update IAM policies: bindings->members array contains user references// Update MASKING_EXCEPTION policies: maskingExceptions->member field contains user referencesdiff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.mdindex ad11a8dcc5..5c6d5a945b 100644--- a/proto/gen/grpc-doc/store/README.md+++ b/proto/gen/grpc-doc/store/README.md@@ -654,7 +654,7 @@ Approver represents a user who can approve or reject an issue.| Field | Type | Label | Description || ----- | ---- | ----- | ----------- || status | [IssuePayloadApproval.Approver.Status](#bytebase-store-IssuePayloadApproval-Approver-Status) | | The current approval status. |-| principal_id | [int32](#int32) | | The ID of the principal who is the approver. |+| principal | [string](#string) | | The principal who is the approver. Format: users/{email}. |diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.htmlindex 22a31ebb83..ea81570d35 100644--- a/proto/gen/grpc-doc/store/index.html+++ b/proto/gen/grpc-doc/store/index.html@@ -2294,10 +2294,11 @@ False means the backend is still searching for matching templates. </p></td></tr><tr>- <td>principal_id</td>- <td><a href="#int32">int32</a></td>+ <td>principal</td>+ <td><a href="#string">string</a></td><td></td>- <td><p>The ID of the principal who is the approver. </p></td>+ <td><p>The principal who is the approver.+Format: users/{email}. </p></td></tr></tbody>diff --git a/proto/store/store/approval.proto b/proto/store/store/approval.protoindex f8ff7f66de..7db73da9e0 100644--- a/proto/store/store/approval.proto+++ b/proto/store/store/approval.proto@@ -21,8 +21,9 @@ message IssuePayloadApproval {// The current approval status.Status status = 1;- // The ID of the principal who is the approver.- int32 principal_id = 2;+ // The principal who is the approver.+ // Format: users/{email}.+ string principal = 2;}// The approval template being used for this issue.