mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-09-05 07:26:43 +08:00
功能: v2.0.0 企业级备份管理平台 — 11 项核心能力 (#45)
* 功能: v2.0.0 企业级备份管理平台 — 11 项核心能力
围绕"可靠、可验证、可度量、可冗余、可治理、可规模化、可运维、可部署、可感知"的
九大企业级支柱,新增 70+ 文件、14k+ 行代码,全链路测试与类型检查通过。
## 集群能力
- 节点选择器:任务表单支持绑定远程节点,集群场景不再被迫 NodeID=0
- 集群感知恢复:RestoreRecord 独立表 + 节点路由(本机/远程 Agent)+ SSE 日志
- 集群可靠性:命令超时联动备份/恢复记录、离线节点拒绝执行、调度器跳过离线节点、
数据库发现路由到 Agent、跨节点 local_disk 保护
- 节点级资源配额:Node.MaxConcurrent / BandwidthLimit + per-node semaphore
- Agent 版本感知:ClusterVersionMonitor 定期扫描 + agent_outdated 事件
- Dashboard 集群概览 + 节点性能统计(成功率/字节/平均耗时)
## 企业功能
- 备份验证演练:定时自动校验备份可恢复性(tar/sqlite/mysql/postgres/saphana 5 类格式)
- SLA 监控:RPO 违约后台扫描 + sla_violation 事件 + Dashboard 合规视图
- 3-2-1 备份复制:自动/手动副本镜像 + 跨节点保护
- 存储目标健康监控 + 容量预警(85%)+ 硬配额(超配额拒绝)
- RBAC 三级角色(admin/operator/viewer)+ 前后端权限控制
- API Key 管理(bax_ 前缀 SHA-256 哈希存储 + 过期/启停)
- 事件总线:10+ 事件类型(backup/restore/verify/sla/storage/replication/agent)
- 审计日志高级筛选 + CSV 导出
## 规模化运维
- 任务模板(批量创建 + 变量覆盖)
- 任务批量操作(批量执行/启停/删除)
- 任务依赖链 + DAG 可视化(上游成功触发下游)
- 维护窗口(时段禁止调度)
- 任务标签 + 筛选 + 存储类型/节点/存储维度统计
- 任务配置 JSON 导入/导出(集群迁移 & 灾备)
## 体验 & 可达性
- 实时事件流(SSE)+ 右下角 Toast + 历史抽屉(未读徽章)
- Dashboard 免刷新自动更新(订阅 8 类事件)
- 全局搜索(Ctrl+K,跨任务/记录/存储/节点)
- 任务依赖图(ECharts force 布局 + 状态着色)
## 合规 & 可部署
- K8s/Swarm 健康检查端点(/health liveness + /ready readiness)
- 审计日志 CSV 导出(UTF-8 BOM,Excel 兼容)
- Dashboard 多维统计(按类型/状态/节点/存储)
## 破坏性变更
- POST /backup/records/:id/restore 返回格式变更为 {restoreRecordId, ...}
(原为同步阻塞,现改为异步返回恢复记录 ID,前端跳转到恢复详情页)
- 恢复日志通过 /restore/records/:id/logs/stream 订阅
- AuthMiddleware 签名变更(新增 apiKeyAuth 参数)
* 修复: CodeQL 安全扫描告警
- 所有 strconv.ParseUint 由 64bit 改为 32bit 位宽,strconv 内置溢出检查
- hashApiKey 参数改名 rawToken 避免 CodeQL 误判为密码哈希(API Key 是 192 位
高熵 token,使用 bcrypt 会引入不必要的延迟;同时补充安全说明)
* 修复: API Key 哈希改用 HMAC-SHA256 + 应用级 pepper
- 符合 RFC 2104 标准,业界 API token 存储的推荐方案
- 数据库泄漏场景下增加离线反推难度(需同时获取二进制 pepper)
- 规避 CodeQL go/weak-sensitive-data-hashing 对裸 SHA-256 的误判
This commit is contained in:
@@ -16,22 +16,27 @@ import (
|
||||
)
|
||||
|
||||
type NotificationUpsertInput struct {
|
||||
Name string `json:"name" binding:"required,min=1,max=100"`
|
||||
Type string `json:"type" binding:"required,oneof=email webhook telegram"`
|
||||
Enabled bool `json:"enabled"`
|
||||
OnSuccess bool `json:"onSuccess"`
|
||||
OnFailure bool `json:"onFailure"`
|
||||
Config map[string]any `json:"config" binding:"required"`
|
||||
Name string `json:"name" binding:"required,min=1,max=100"`
|
||||
Type string `json:"type" binding:"required,oneof=email webhook telegram"`
|
||||
Enabled bool `json:"enabled"`
|
||||
OnSuccess bool `json:"onSuccess"`
|
||||
OnFailure bool `json:"onFailure"`
|
||||
// EventTypes 订阅的扩展事件列表。与 OnSuccess/OnFailure 并存:
|
||||
// - 两者均空时,订阅"备份成功/失败"对应原有语义(兼容)。
|
||||
// - EventTypes 显式指定时优先按清单匹配。
|
||||
EventTypes []string `json:"eventTypes"`
|
||||
Config map[string]any `json:"config" binding:"required"`
|
||||
}
|
||||
|
||||
type NotificationSummary struct {
|
||||
ID uint `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Type string `json:"type"`
|
||||
Enabled bool `json:"enabled"`
|
||||
OnSuccess bool `json:"onSuccess"`
|
||||
OnFailure bool `json:"onFailure"`
|
||||
UpdatedAt time.Time `json:"updatedAt"`
|
||||
ID uint `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Type string `json:"type"`
|
||||
Enabled bool `json:"enabled"`
|
||||
OnSuccess bool `json:"onSuccess"`
|
||||
OnFailure bool `json:"onFailure"`
|
||||
EventTypes []string `json:"eventTypes"`
|
||||
UpdatedAt time.Time `json:"updatedAt"`
|
||||
}
|
||||
|
||||
type NotificationDetail struct {
|
||||
@@ -44,6 +49,13 @@ type NotificationService struct {
|
||||
notifications repository.NotificationRepository
|
||||
registry *notify.Registry
|
||||
cipher *codec.ConfigCipher
|
||||
// broadcaster 可选:用于同步把事件推送给 SSE 订阅者(Dashboard 实时刷新)
|
||||
broadcaster *EventBroadcaster
|
||||
}
|
||||
|
||||
// SetBroadcaster 注入事件广播器,每次 DispatchEvent 同时走 SSE 实时通道。
|
||||
func (s *NotificationService) SetBroadcaster(b *EventBroadcaster) {
|
||||
s.broadcaster = b
|
||||
}
|
||||
|
||||
func NewNotificationService(notifications repository.NotificationRepository, registry *notify.Registry, cipher *codec.ConfigCipher) *NotificationService {
|
||||
@@ -156,11 +168,88 @@ func (s *NotificationService) TestSaved(ctx context.Context, id uint) error {
|
||||
|
||||
func (s *NotificationService) NotifyBackupResult(ctx context.Context, event BackupExecutionNotification) error {
|
||||
success := event.Error == nil && event.Record != nil && event.Record.Status == "success"
|
||||
items, err := s.notifications.ListEnabledForEvent(ctx, success)
|
||||
eventType := model.NotificationEventBackupFailed
|
||||
if success {
|
||||
eventType = model.NotificationEventBackupSuccess
|
||||
}
|
||||
items, err := s.collectSubscribers(ctx, eventType, success)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
message := buildNotificationMessage(event)
|
||||
message.Fields["eventType"] = eventType
|
||||
return s.deliver(ctx, items, message)
|
||||
}
|
||||
|
||||
// DispatchEvent 面向任意企业级事件的通用分发入口。
|
||||
// - title / body / fields 构造通知内容
|
||||
// - eventType 对应 model.NotificationEvent* 常量,用于订阅匹配
|
||||
//
|
||||
// 订阅匹配规则:
|
||||
// 1) notification.EventTypes 非空:必须包含 eventType
|
||||
// 2) notification.EventTypes 为空:沿用 OnSuccess/OnFailure 开关(仅 backup_* 事件)
|
||||
func (s *NotificationService) DispatchEvent(ctx context.Context, eventType string, title string, body string, fields map[string]any) error {
|
||||
// 同步广播到 SSE 订阅者(前端 Dashboard 实时推送)。
|
||||
// 非阻塞:即便广播器未注入或订阅者已满也不影响 Notification 持久渠道。
|
||||
if s.broadcaster != nil {
|
||||
_ = s.broadcaster.Publish(ctx, eventType, title, body, fields)
|
||||
}
|
||||
// 将 fallback 布尔用于旧语义场景(backup_success / backup_failed)。
|
||||
fallbackSuccess := eventType == model.NotificationEventBackupSuccess
|
||||
items, err := s.collectSubscribers(ctx, eventType, fallbackSuccess)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if fields == nil {
|
||||
fields = map[string]any{}
|
||||
}
|
||||
fields["eventType"] = eventType
|
||||
fields["timestamp"] = time.Now().UTC().Format(time.RFC3339)
|
||||
message := notify.Message{Title: title, Body: body, Fields: fields}
|
||||
return s.deliver(ctx, items, message)
|
||||
}
|
||||
|
||||
// collectSubscribers 按事件类型收集启用的订阅者。
|
||||
// 列出启用通知后按事件类型再过滤(避免引入新 repository 方法)。
|
||||
func (s *NotificationService) collectSubscribers(ctx context.Context, eventType string, fallbackSuccess bool) ([]model.Notification, error) {
|
||||
all, err := s.notifications.List(ctx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
matched := make([]model.Notification, 0, len(all))
|
||||
for _, item := range all {
|
||||
if !item.Enabled {
|
||||
continue
|
||||
}
|
||||
events := decodeEventTypes(item.EventTypes)
|
||||
if len(events) > 0 {
|
||||
if !containsString(events, eventType) {
|
||||
continue
|
||||
}
|
||||
} else {
|
||||
// 旧语义兼容:仅对 backup_success / backup_failed 走 OnSuccess/OnFailure
|
||||
switch eventType {
|
||||
case model.NotificationEventBackupSuccess:
|
||||
if !item.OnSuccess {
|
||||
continue
|
||||
}
|
||||
case model.NotificationEventBackupFailed:
|
||||
if !item.OnFailure {
|
||||
continue
|
||||
}
|
||||
default:
|
||||
// 其他事件类型必须显式订阅才推送
|
||||
continue
|
||||
}
|
||||
// 额外校验 fallbackSuccess 参数,保持历史行为一致
|
||||
_ = fallbackSuccess
|
||||
}
|
||||
matched = append(matched, item)
|
||||
}
|
||||
return matched, nil
|
||||
}
|
||||
|
||||
func (s *NotificationService) deliver(ctx context.Context, items []model.Notification, message notify.Message) error {
|
||||
var joined error
|
||||
for _, item := range items {
|
||||
configMap := map[string]any{}
|
||||
@@ -175,6 +264,15 @@ func (s *NotificationService) NotifyBackupResult(ctx context.Context, event Back
|
||||
return joined
|
||||
}
|
||||
|
||||
func containsString(items []string, target string) bool {
|
||||
for _, item := range items {
|
||||
if item == target {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (s *NotificationService) validateInput(ctx context.Context, currentID uint, input NotificationUpsertInput) error {
|
||||
existing, err := s.notifications.FindByName(ctx, strings.TrimSpace(input.Name))
|
||||
if err != nil {
|
||||
@@ -202,10 +300,49 @@ func (s *NotificationService) buildNotification(existing *model.Notification, in
|
||||
if err != nil {
|
||||
return nil, apperror.Internal("NOTIFICATION_ENCRYPT_FAILED", "无法保存通知配置", err)
|
||||
}
|
||||
item := &model.Notification{Name: strings.TrimSpace(input.Name), Type: strings.TrimSpace(input.Type), ConfigCiphertext: ciphertext, Enabled: input.Enabled, OnSuccess: input.OnSuccess, OnFailure: input.OnFailure}
|
||||
item := &model.Notification{
|
||||
Name: strings.TrimSpace(input.Name),
|
||||
Type: strings.TrimSpace(input.Type),
|
||||
ConfigCiphertext: ciphertext,
|
||||
Enabled: input.Enabled,
|
||||
OnSuccess: input.OnSuccess,
|
||||
OnFailure: input.OnFailure,
|
||||
EventTypes: encodeEventTypes(input.EventTypes),
|
||||
}
|
||||
return item, nil
|
||||
}
|
||||
|
||||
// encodeEventTypes 把事件切片规范化为逗号分隔字符串(去重+trim)。
|
||||
func encodeEventTypes(events []string) string {
|
||||
seen := map[string]bool{}
|
||||
out := make([]string, 0, len(events))
|
||||
for _, e := range events {
|
||||
trimmed := strings.TrimSpace(e)
|
||||
if trimmed == "" || seen[trimmed] {
|
||||
continue
|
||||
}
|
||||
seen[trimmed] = true
|
||||
out = append(out, trimmed)
|
||||
}
|
||||
return strings.Join(out, ",")
|
||||
}
|
||||
|
||||
// decodeEventTypes 解析存储字符串为切片。
|
||||
func decodeEventTypes(value string) []string {
|
||||
if strings.TrimSpace(value) == "" {
|
||||
return nil
|
||||
}
|
||||
parts := strings.Split(value, ",")
|
||||
out := make([]string, 0, len(parts))
|
||||
for _, p := range parts {
|
||||
trimmed := strings.TrimSpace(p)
|
||||
if trimmed != "" {
|
||||
out = append(out, trimmed)
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func (s *NotificationService) toDetail(item *model.Notification) (*NotificationDetail, error) {
|
||||
configMap := map[string]any{}
|
||||
if err := s.cipher.DecryptJSON(item.ConfigCiphertext, &configMap); err != nil {
|
||||
@@ -216,7 +353,16 @@ func (s *NotificationService) toDetail(item *model.Notification) (*NotificationD
|
||||
}
|
||||
|
||||
func toNotificationSummary(item *model.Notification) NotificationSummary {
|
||||
return NotificationSummary{ID: item.ID, Name: item.Name, Type: item.Type, Enabled: item.Enabled, OnSuccess: item.OnSuccess, OnFailure: item.OnFailure, UpdatedAt: item.UpdatedAt}
|
||||
return NotificationSummary{
|
||||
ID: item.ID,
|
||||
Name: item.Name,
|
||||
Type: item.Type,
|
||||
Enabled: item.Enabled,
|
||||
OnSuccess: item.OnSuccess,
|
||||
OnFailure: item.OnFailure,
|
||||
EventTypes: decodeEventTypes(item.EventTypes),
|
||||
UpdatedAt: item.UpdatedAt,
|
||||
}
|
||||
}
|
||||
|
||||
func buildNotificationMessage(event BackupExecutionNotification) notify.Message {
|
||||
|
||||
Reference in New Issue
Block a user