@xen-orchestra/backups 0.51.0 → 0.52.1

package/_backupWorker.mjs

@@ -23,7 +23,7 @@ createCachedLookup().patchGlobal()
 
 const logger = createLogger('xo:backups:worker')
 catchGlobalErrors(logger)
-const { debug, info } = logger
+const { debug, info, warn } = logger
 
 class BackupWorker {
   #config
@@ -204,6 +204,13 @@ process.on('message', async message => {
       info('backup has ended')
       await ignoreErrors.call(backupWorker.debounceResource.flushAll())
       process.disconnect()
+
+      setTimeout(() => {
+        warn('worker process did not exit automatically, forcing...')
+
+        // eslint-disable-next-line n/no-process-exit
+        process.exit()
+      }, 30e3).unref()
     }
   }
 })

package/_runners/VmsXapi.mjs

@@ -15,6 +15,7 @@ const noop = Function.prototype
 
 const DEFAULT_XAPI_VM_SETTINGS = {
   bypassVdiChainsCheck: false,
+  cbtDestroySnapshotData: false,
   checkpointSnapshot: false,
   concurrency: 2,
   copyRetention: 0,

package/_runners/_vmRunners/IncrementalXapi.mjs

@@ -147,8 +147,13 @@ export const IncrementalXapi = class IncrementalXapiVmBackupRunner extends Abstr
       ...lastExportedVdis.map(({ other_config }) => Number(other_config[DELTA_CHAIN_LENGTH] ?? 0))
     )
     const fullInterval = this._settings.fullInterval
-    if ( fullInterval !== 0 && fullInterval < deltaChainLength + 1) {
-      debug('not using base VM because fullInterval reached', { fullInterval, deltaChainLength, eq: fullInterval < deltaChainLength + 1, dc1: deltaChainLength + 1 })
+    if (fullInterval !== 0 && fullInterval <= deltaChainLength + 1) {
+      debug('not using base VM because fullInterval reached', {
+        fullInterval,
+        deltaChainLength,
+        eq: fullInterval < deltaChainLength + 1,
+        dc1: deltaChainLength + 1,
+      })
       return
     }
 

package/_runners/_vmRunners/_AbstractXapi.mjs

@@ -146,6 +146,15 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
         if (!settings.bypassVdiChainsCheck) {
           await vm.$assertHealthyVdiChains()
         }
+        if (settings.preferNbd) {
+          try {
+            // enable CBT on all disks if possible
+            const diskRefs = await xapi.VM_getDisks(vm.$ref)
+            await Promise.all(diskRefs.map(diskRef => xapi.call('VDI.enable_cbt', diskRef)))
+          } catch (error) {
+            Task.info(`couldn't enable CBT`, error)
+          }
+        }
 
         const snapshotRef = await vm[settings.checkpointSnapshot ? '$checkpoint' : '$snapshot']({
           ignoredVdisTag: '[NOBAK]',
@@ -160,7 +169,6 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
           vmUuid: vm.uuid,
         })
         this._exportedVm = await xapi.getRecord('VM', snapshotRef)
-
         return this._exportedVm.uuid
       })
     } else {
@@ -208,7 +216,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
 
     const snapshotsPerSchedule = groupBy(this._jobSnapshotVdis, _ => _.other_config[SCHEDULE_ID])
     const xapi = this._xapi
-    await asyncMap(Object.entries(snapshotsPerSchedule), ([scheduleId, snapshots]) => {
+    await asyncMap(Object.entries(snapshotsPerSchedule), async ([scheduleId, snapshots]) => {
       const snapshotPerDatetime = groupBy(snapshots, _ => _.other_config[DATETIME])
 
       const datetimes = Object.keys(snapshotPerDatetime)
@@ -219,12 +227,11 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
         ...allSettings[scheduleId],
         ...allSettings[this._vm.uuid],
       }
-      // ensure we never delete the last one
-      const retention = Math.max(settings.snapshotRetention ?? 0, 1)
-
-      return asyncMap(getOldEntries(retention, datetimes), async datetime => {
+      // ensure we never delete the last one for delta
+      const minRetention = this.job.mode === 'delta' ? 1 : 0
+      const retention = Math.max(settings.snapshotRetention ?? 0, minRetention)
+      await asyncMap(getOldEntries(retention, datetimes), async datetime => {
         const vdis = snapshotPerDatetime[datetime]
-
         let vmRef
         // if there is an attached VM => destroy the VM (Non CBT backups)
         for (const vdi of vdis) {
@@ -234,8 +241,8 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
             // this will throw error for VDI still attached to control domain
             assert.strictEqual(vbds.length, 1, 'VDI must be free or attached to exactly one VM')
             const vm = vbds[0].$VM
+            assert.strictEqual(vm.is_control_domain, false, `Disk is still attached to DOM0 VM`) // don't delete a VM (especially a control domain)
             assert.strictEqual(vm.is_a_snapshot, true, `VM must be a snapshot`) // don't delete a VM (especially a control domain)
-            assert.strictEqual(vm.is_control_domain, false, `VM can't be a DOM0 VM`) // don't delete a VM (especially a control domain)
 
             const vmRefVdi = vm.$ref
             // same vm than other vdi of the same batch
@@ -257,6 +264,34 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
         }
       })
     })
+
+    // now that we use CBT, we can destroy the data of the snapshot used for this backup
+    // going back to a previous version of XO not supporting CBT will create a full backup
+    // this will only do something after snapshot and transfer
+    if (
+      // don't modify the VM
+      this._exportedVm?.is_a_snapshot &&
+      // user don't want to keep the snapshot data
+      this._settings.snapshotRetention === 0 &&
+      // preferNbd is not a guarantee that the backup used NBD, depending on the network configuration,
+      // in that case next runs will be full, but there is not an easy way to prevent that
+      this._settings.preferNbd &&
+      // only delete snapshost data if the config allows it
+      this._settings.cbtDestroySnapshotData
+    ) {
+      Task.info('will delete snapshot data')
+      const vdiRefs = await this._xapi.VM_getDisks(this._exportedVm?.$ref)
+      await xapi.call('VM.destroy', this._exportedVm.$ref)
+      for (const vdiRef of vdiRefs) {
+        try {
+          // data_destroy will fail with a VDI_NO_CBT_METADATA error if CBT is not enabled on this VDI
+          await xapi.call('VDI.data_destroy', vdiRef)
+          Task.info(`Snapshot data has been deleted`, { vdiRef })
+        } catch (error) {
+          Task.warning(`Couldn't deleted snapshot data`, { error, vdiRef })
+        }
+      }
+    }
   }
 
   async copy() {

package/_runners/_writers/IncrementalXapiWriter.mjs

@@ -19,10 +19,10 @@ export class IncrementalXapiWriter extends MixinXapiWriter(AbstractIncrementalWr
     // @todo use an index if possible
     // @todo : this seems similare to decorateVmMetadata
 
-    const replicatedVdis = sr.$VDIs
-      .filter(({ other_config }) => {
+    const replicatedVdis = sr.$VDIs 
+      .filter(vdi => {
         // REPLICATED_TO_SR_UUID is not used here since we are already filtering from sr.$VDIs
-        return baseUuidToSrcVdi.has(other_config?.[COPY_OF])
+        return baseUuidToSrcVdi.has(vdi?.other_config[COPY_OF])
       })
       .map(({ other_config }) => other_config?.[COPY_OF])
       .filter(_ => !!_)
@@ -103,10 +103,11 @@ export class IncrementalXapiWriter extends MixinXapiWriter(AbstractIncrementalWr
       .filter(_ => !!_)
     // @todo use index ?
 
-    const replicatedVdis = sr.$VDIs.filter(({ other_config }) => {
-      // REPLICATED_TO_SR_UUID is not used here since we are already filtering from sr.$VDIs
-      return sourceVdiUuids.includes(other_config?.[COPY_OF])
-    })
+    const replicatedVdis = sr.$VDIs
+      .filter(vdi => {
+        // REPLICATED_TO_SR_UUID is not used here since we are already filtering from sr.$VDIs
+        return sourceVdiUuids.includes(vdi?.other_config[COPY_OF])
+      })
 
     Object.values(backup.vdis).forEach(vdi => {
       vdi.other_config[COPY_OF] = vdi.uuid

package/package.json

@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
-  "version": "0.51.0",
+  "version": "0.52.1",
   "engines": {
     "node": ">=14.18"
   },
@@ -46,7 +46,7 @@
     "proper-lockfile": "^4.1.2",
     "tar": "^6.1.15",
     "uuid": "^9.0.0",
-    "vhd-lib": "^4.10.0",
+    "vhd-lib": "^4.11.0",
     "xen-api": "^4.0.0",
     "yazl": "^2.5.1"
   },
@@ -58,7 +58,7 @@
     "tmp": "^0.2.1"
   },
   "peerDependencies": {
-    "@xen-orchestra/xapi": "^7.0.0"
+    "@xen-orchestra/xapi": "^7.1.0"
   },
   "license": "AGPL-3.0-or-later",
   "author": {