feat(xo-server/metadata-backups): reportWhen implementation (#4135)

packages/xo-server/src/xo-mixins/jobs/index.js

@@ -266,6 +266,11 @@ export default class Jobs {
         reportWhen: (settings && settings.reportWhen) || 'failure',
       }
     }
+    if (type === 'metadataBackup') {
+      data = {
+        reportWhen: job.settings['']?.reportWhen ?? 'failure',
+      }
+    }
 
     const logger = this._logger
     const runJobId = logger.notice(`Starting execution of ${id}.`, {

packages/xo-server/src/xo-mixins/metadata-backups.js

@@ -26,9 +26,12 @@ const compareTimestamp = (a, b) => a.timestamp - b.timestamp
 
 const DEFAULT_RETENTION = 0
 
+type ReportWhen = 'always' | 'failure' | 'never'
+
 type Settings = {|
-  retentionXoMetadata?: number,
+  reportWhen?: ReportWhen,
   retentionPoolMetadata?: number,
+  retentionXoMetadata?: number,
 |}
 
 type MetadataBackupJob = {
@@ -93,7 +96,7 @@ const deleteOldBackups = (handler, dir, retention, handleError) =>
 //
 // Task logs emitted in a metadata backup execution:
 //
-// job.start
+// job.start(data: { reportWhen: ReportWhen })
 // ├─ task.start(data: { type: 'pool', id: string, pool: <Pool />, poolMaster: <Host /> })
 // │  ├─ task.start(data: { type: 'remote', id: string })
 // │  │  └─ task.end