feat: add CONDITION_SNAPSHOT_WARNING hook triggered by any warning st…

…atus at the completion of a snapshot
garethgeorge · May 5, 2024 · f0ee20f · f0ee20f
1 parent 5a996d7
commit f0ee20f
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 14 deletions.
diff --git a/gen/go/v1/config.pb.go b/gen/go/v1/config.pb.go
diff --git a/internal/hook/hookvars.go b/internal/hook/hookvars.go
@@ -97,6 +97,8 @@ func (v HookVars) Summary() (string, error) {
 		return v.renderTemplate(templateForError)
 	case v1.Hook_CONDITION_SNAPSHOT_ERROR:
 		return v.renderTemplate(templateForError)
+	case v1.Hook_CONDITION_SNAPSHOT_WARNING:
+		return v.renderTemplate(templateForError)
 	default:
 		return "unknown event", nil
 	}
@@ -151,7 +153,10 @@ Backrest Notification for Error
 Task: "{{ .Task }}" at {{ .FormatTime .CurTime }}
 {{ if .Error -}}
 Error: {{ .Error }}
-{{ end }}`
+{{ end }}
+{{ if .Items -}}
+
+`
 
 var templateForSnapshotStart = `
 Backrest Notification for Snapshot Start

diff --git a/internal/orchestrator/tasks/taskbackup.go b/internal/orchestrator/tasks/taskbackup.go
@@ -178,6 +178,11 @@ func (t *BackupTask) Run(ctx context.Context, st ScheduledTask, runner TaskRunne
 				v1.Hook_CONDITION_ANY_ERROR,
 			}, vars)
 			return err
+		} else {
+			vars.Error = fmt.Sprintf("partial backup, %d files may not have been read completely.", len(backupOp.OperationBackup.Errors))
+			runner.ExecuteHooks([]v1.Hook_Condition{
+				v1.Hook_CONDITION_SNAPSHOT_WARNING,
+			}, vars)
 		}
 		op.Status = v1.OperationStatus_STATUS_WARNING
 		op.DisplayMessage = "Partial backup, some files may not have been read completely."

diff --git a/proto/v1/config.proto b/proto/v1/config.proto
@@ -84,6 +84,7 @@ message Hook {
     CONDITION_SNAPSHOT_START = 2; // backup started.
     CONDITION_SNAPSHOT_END = 3; // backup completed (success or fail).
     CONDITION_SNAPSHOT_ERROR = 4; // snapshot failed.
+    CONDITION_SNAPSHOT_WARNING = 5; // snapshot completed with warnings.
   }
 
   enum OnError {

diff --git a/webui/gen/ts/v1/config_pb.ts b/webui/gen/ts/v1/config_pb.ts
@@ -653,6 +653,13 @@ export enum Hook_Condition {
    * @generated from enum value: CONDITION_SNAPSHOT_ERROR = 4;
    */
   SNAPSHOT_ERROR = 4,
+
+  /**
+   * snapshot completed with warnings.
+   *
+   * @generated from enum value: CONDITION_SNAPSHOT_WARNING = 5;
+   */
+  SNAPSHOT_WARNING = 5,
 }
 // Retrieve enum metadata with: proto3.getEnumType(Hook_Condition)
 proto3.util.setEnumType(Hook_Condition, "v1.Hook.Condition", [
@@ -661,6 +668,7 @@ proto3.util.setEnumType(Hook_Condition, "v1.Hook.Condition", [
   { no: 2, name: "CONDITION_SNAPSHOT_START" },
   { no: 3, name: "CONDITION_SNAPSHOT_END" },
   { no: 4, name: "CONDITION_SNAPSHOT_ERROR" },
+  { no: 5, name: "CONDITION_SNAPSHOT_WARNING" },
 ]);
 
 /**