feat(unmasking): implement activation and plaintext retrieval for unmasking workflows with new request and response models

Author: LordofAvernus

api/dms/service/v1/unmasking_workflow.go

@@ -57,8 +57,18 @@ type UnmaskingWorkflowListItem struct {
 	ApprovalStatus biz.UnmaskingWorkflowApprovalStatus `json:"approval_status" validate:"oneof=pending approved rejected cancelled"`
 	// 使用情况
 	UsageStatus biz.UnmaskingWorkflowUsageStatus `json:"usage_status" validate:"oneof=unviewed viewed"`
-	// 过期时间 (RFC3339)
+	// 过期时间 (RFC3339)，兼容字段：批准前为激活截止，激活后为查看截止
 	ExpireTime string `json:"expire_time" example:"2024-01-16T10:30:00Z"`
+	// 激活查看时刻 (RFC3339)
+	ActivatedAt string `json:"activated_at"`
+	// 须在此时刻前激活查看 (RFC3339)
+	ActivationDeadline string `json:"activation_deadline"`
+	// 明文查看截止 (RFC3339)
+	ViewValidUntil string `json:"view_valid_until"`
+	// 申请人明文查看状态
+	ViewState biz.UnmaskingWorkflowViewState `json:"view_state"`
+	// 是否可点击激活查看
+	CanActivate bool `json:"can_activate"`
 	// 申请理由
 	ApplyReason string `json:"apply_reason"`
 	// 当前待处理人
@@ -252,3 +262,55 @@ type CancelUnmaskingWorkflowReply struct {
 	// Generic reply
 	base.GenericResp
 }
+
+// swagger:parameters ActivateUnmaskingWorkflowView
+type ActivateUnmaskingWorkflowViewReq struct {
+	// swagger:ignore
+	ProjectUid string `param:"project_uid" json:"project_uid" validate:"required"`
+	// in: path
+	// Required: true
+	WorkflowID string `param:"workflow_id" json:"workflow_id" validate:"required"`
+}
+
+// swagger:model ActivateUnmaskingWorkflowViewReply
+type ActivateUnmaskingWorkflowViewReply struct {
+	Data *ActivateUnmaskingWorkflowViewReplyData `json:"data"`
+	base.GenericResp
+}
+
+// swagger:model ActivateUnmaskingWorkflowViewReplyData
+type ActivateUnmaskingWorkflowViewReplyData struct {
+	ViewValidUntil string                       `json:"view_valid_until"`
+	ViewState      biz.UnmaskingWorkflowViewState `json:"view_state"`
+}
+
+// swagger:parameters GetUnmaskingWorkflowPlaintext
+type GetUnmaskingWorkflowPlaintextReq struct {
+	// swagger:ignore
+	ProjectUid string `param:"project_uid" json:"project_uid" validate:"required"`
+	// in: path
+	// Required: true
+	WorkflowID string `param:"workflow_id" json:"workflow_id" validate:"required"`
+}
+
+// swagger:model GetUnmaskingWorkflowPlaintextReply
+type GetUnmaskingWorkflowPlaintextReply struct {
+	Data *GetUnmaskingWorkflowPlaintext `json:"data"`
+	base.GenericResp
+}
+
+// swagger:model GetUnmaskingWorkflowPlaintext
+type GetUnmaskingWorkflowPlaintext struct {
+	ViewState      biz.UnmaskingWorkflowViewState `json:"view_state"`
+	ViewValidUntil string                         `json:"view_valid_until"`
+	UnmaskingSQLs  []*UnmaskingPlaintextSQLItem   `json:"unmasking_sqls"`
+}
+
+// swagger:model UnmaskingPlaintextSQLItem
+type UnmaskingPlaintextSQLItem struct {
+	UID           string          `json:"uid"`
+	SQLIndexID    string          `json:"sql_index_id"`
+	OriginalData  *SQLQueryResult `json:"original_data"`
+	MaskedColumns []string        `json:"masked_columns"`
+	Truncated     bool            `json:"truncated"`
+}

internal/apiserver/service/data_mask_controller.go

@@ -857,6 +857,82 @@ func (ctl *DMSController) CancelUnmaskingWorkflow(c echo.Context) error {
 	return NewOkRespWithReply(c, &aV1.CancelUnmaskingWorkflowReply{})
 }
 
+// swagger:operation POST /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/activate Masking ActivateUnmaskingWorkflowView
+//
+// Activate plaintext view window for applicant.
+//
+// ---
+// parameters:
+//   - name: project_uid
+//     in: path
+//     required: true
+//     type: string
+//   - name: workflow_id
+//     in: path
+//     required: true
+//     type: string
+//
+// responses:
+//   '200':
+//     schema:
+//       "$ref": "#/definitions/ActivateUnmaskingWorkflowViewReply"
+//   default:
+//     schema:
+//       "$ref": "#/definitions/GenericResp"
+func (ctl *DMSController) ActivateUnmaskingWorkflowView(c echo.Context) error {
+	req := &aV1.ActivateUnmaskingWorkflowViewReq{}
+	if err := bindAndValidateReq(c, req); err != nil {
+		return NewErrResp(c, err, apiError.BadRequestErr)
+	}
+	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
+	if err != nil {
+		return NewErrResp(c, err, apiError.UnauthorizedErr)
+	}
+	reply, err := ctl.DMS.ActivateUnmaskingWorkflowView(c.Request().Context(), req, currentUserUid)
+	if err != nil {
+		return NewErrResp(c, err, apiError.DMSServiceErr)
+	}
+	return NewOkRespWithReply(c, reply)
+}
+
+// swagger:operation GET /v1/dms/projects/{project_uid}/masking/unmasking-workflows/{workflow_id}/plaintext Masking GetUnmaskingWorkflowPlaintext
+//
+// Get plaintext query snapshot during active view window.
+//
+// ---
+// parameters:
+//   - name: project_uid
+//     in: path
+//     required: true
+//     type: string
+//   - name: workflow_id
+//     in: path
+//     required: true
+//     type: string
+//
+// responses:
+//   '200':
+//     schema:
+//       "$ref": "#/definitions/GetUnmaskingWorkflowPlaintextReply"
+//   default:
+//     schema:
+//       "$ref": "#/definitions/GenericResp"
+func (ctl *DMSController) GetUnmaskingWorkflowPlaintext(c echo.Context) error {
+	req := &aV1.GetUnmaskingWorkflowPlaintextReq{}
+	if err := bindAndValidateReq(c, req); err != nil {
+		return NewErrResp(c, err, apiError.BadRequestErr)
+	}
+	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
+	if err != nil {
+		return NewErrResp(c, err, apiError.UnauthorizedErr)
+	}
+	reply, err := ctl.DMS.GetUnmaskingWorkflowPlaintext(c.Request().Context(), req, currentUserUid)
+	if err != nil {
+		return NewErrResp(c, err, apiError.DMSServiceErr)
+	}
+	return NewOkRespWithReply(c, reply)
+}
+
 // swagger:route GET /v1/dms/projects/{project_uid}/masking/rules/{rule_id} Masking GetMaskingRuleDetail
 //
 // 获取脱敏规则详情。

internal/data_masking/biz/unmasking_workflow.go

@@ -229,12 +229,29 @@ const (
 	UnmaskingActionDownloadOriginalData UnmaskingAction = "download_full_original_data"
 	// 取消申请
 	UnmaskingActionCancel UnmaskingAction = "cancel"
+	// 激活查看原文（工单详情）
+	UnmaskingActionActivateView UnmaskingAction = "activate_view"
 )
 
 func (a UnmaskingAction) String() string {
 	return string(a)
 }
 
+// UnmaskingWorkflowViewState 申请人明文查看状态（详情页展示）
+// swagger:enum UnmaskingWorkflowViewState
+type UnmaskingWorkflowViewState string
+
+const (
+	UnmaskingWorkflowViewStateNotActivated      UnmaskingWorkflowViewState = "not_activated"
+	UnmaskingWorkflowViewStateActive            UnmaskingWorkflowViewState = "active"
+	UnmaskingWorkflowViewStateViewExpired       UnmaskingWorkflowViewState = "view_expired"
+	UnmaskingWorkflowViewStateActivationExpired UnmaskingWorkflowViewState = "activation_expired"
+)
+
+func (s UnmaskingWorkflowViewState) String() string {
+	return string(s)
+}
+
 // 与 DMS OpRangeType 字符串取值一致，用于 UnmaskingOpPermissionRange 判定。
 const (
 	UnmaskingOpRangeProject   = "project"

internal/dms/service/unmasking_workflow_ce.go

@@ -44,3 +44,11 @@ func (d *DMSService) RejectUnmaskingWorkflow(ctx context.Context, req *v1.Reject
 func (d *DMSService) CancelUnmaskingWorkflow(ctx context.Context, req *v1.CancelUnmaskingWorkflowReq, currentUserUid string) error {
 	return errNotSupportUnmaskingWorkflow
 }
+
+func (d *DMSService) ActivateUnmaskingWorkflowView(ctx context.Context, req *v1.ActivateUnmaskingWorkflowViewReq, currentUserUid string) (*v1.ActivateUnmaskingWorkflowViewReply, error) {
+	return nil, errNotSupportUnmaskingWorkflow
+}
+
+func (d *DMSService) GetUnmaskingWorkflowPlaintext(ctx context.Context, req *v1.GetUnmaskingWorkflowPlaintextReq, currentUserUid string) (*v1.GetUnmaskingWorkflowPlaintextReply, error) {
+	return nil, errNotSupportUnmaskingWorkflow
+}