@xen-orchestra/backups 0.61.0 → 0.61.1

package/ImportVmBackup.mjs

@@ -168,13 +168,13 @@ export class ImportVmBackup {
           vdis[vdiRef].baseVdi = snapshotCandidate
         } catch (error) {
           // can be a broken VHD chain, a vhd chain with a key backup, ....
-          // not an irrecuperable error, don't dispose parentVhd, and fallback to full restore
+          // not an irrecuperable error, don't dispose parentVhd, and fall back to full restore
           warn(`can't use differential restore`, { error })
           descendant?.close()
           negativeDisk?.close()
         }
       }
-      // didn't make a negative stream : fallback to classic stream
+      // didn't make a negative stream : fall back to classic stream
       if (disk === undefined) {
         debug('use legacy restore')
         disk = parent

package/RemoteAdapter.mjs

@@ -205,7 +205,7 @@ export class RemoteAdapter {
     })
   }
 
-  // check if we will be allowed to merge a a vhd created in this adapter
+  // check if we will be allowed to merge a vhd created in this adapter
   // with the vhd at path `path`
   async isMergeableParent(packedParentUid, path) {
     return await Disposable.use(VhdSynthetic.fromVhdChain(this.handler, path), vhd => {
@@ -776,7 +776,7 @@ export class RemoteAdapter {
     let json
     let isImmutable = false
     let remoteIsImmutable = false
-    // if the remote is immutable, check if this metadatas are also immutables
+    // if the remote is immutable, check if this metadata is also immutable
     try {
       // this file is not encrypted
       await this._handler._readFile(IMMUTABILTY_METADATA_FILENAME)
@@ -792,7 +792,7 @@ export class RemoteAdapter {
       json = await this.handler.readFile(path, { flag: 'r+' })
       // s3 handler don't respect flags
     } catch (err) {
-      // retry without triggerring immutbaility check ,only on immutable remote
+      // retry without triggering immutability check ,only on immutable remote
       if (err.code === 'EPERM' && remoteIsImmutable) {
         isImmutable = true
         json = await this._handler.readFile(path, { flag: 'r' })

package/RestoreMetadataBackup.mjs

@@ -24,7 +24,7 @@ export class RestoreMetadataBackup {
       const dataFileName = resolve('/', backupId, metadata.data ?? 'data.json').slice(1)
       const data = await handler.readFile(dataFileName)
 
-      // if data is JSON, sent it as a plain string, otherwise, consider the data as binary and encode it
+      // if data is JSON, sent it as a plain string; otherwise, consider the data as binary and encode it
       const isJson = dataFileName.endsWith('.json')
       return isJson ? data.toString() : { encoding: 'base64', data: data.toString('base64') }
     }

package/_cleanVm.mjs

@@ -512,7 +512,7 @@ export async function cleanVm(
         remove,
         mergeBlockConcurrency,
       })
-      const metadataPath = vhdsToJSons[chain[chain.length - 1]] // all the chain should have the same metada file
+      const metadataPath = vhdsToJSons[chain[chain.length - 1]] // all the chain should have the same metadata file
       metadataWithMergedVhd[metadataPath] = (metadataWithMergedVhd[metadataPath] ?? 0) + finalVhdSize
     })
   }

package/_getOldEntries.mjs

@@ -26,7 +26,7 @@ const LTR_DEFINITIONS = {
 
         copy.date(date.date() - firstDayOfWeek)
         // warning, the year in term of week may different from YYYY
-        // since the computation of the first week of a year is timezone dependant
+        // since the computation of the first week of a year is timezone dependent
         return copy.format('gggg-ww')
       }
     },
@@ -59,7 +59,7 @@ const LTR_DEFINITIONS = {
  * return the entries too old to be kept
  *  if multiple entries are i the same time bucket : keep only the most recent one
  *  if an entry is valid in any of the bucket OR the  minRetentionCount : keep it
- *  if a bucket is completly empty : it does not count as one, thus it may extend the retention
+ *  if a bucket is completely empty : it does not count as one, thus it may extend the retention
  * @returns Array<Backup>
  */
 export function getOldEntries(minRetentionCount, entries, { longTermRetention = {}, timezone } = {}) {

package/_incrementalVm.mjs

@@ -231,7 +231,7 @@ export const importIncrementalVm = defer(async function importIncrementalVm(
     cancelableMap(cancelToken, Object.entries(newVdis), async (cancelToken, [id, vdi]) => {
       for (const disk of ensureArray(disks[id])) {
         if (disk === null) {
-          // we restore a backup and reuse completly a local snapshot
+          // we restore a backup and reuse completely a local snapshot
           continue
         }
         await xapi.setField('VDI', vdi.$ref, 'name_label', `[Importing] ${vdiRecords[id].name_label}`)

package/_isValidXva.mjs

@@ -44,7 +44,7 @@ const isValidTar = async (handler, size, fd) => {
   return buf.every(_ => _ === 0)
 }
 
-// TODO: find an heuristic for compressed files
+// TODO: find a heuristic for compressed files
 export async function isValidXva(path) {
   const handler = this._handler
 

package/_otherConfig.mjs

@@ -43,7 +43,7 @@ async function getDeltaChainLength(xapi, type, ref) {
 }
 
 /**
- * set the delta chain lenght ( number of delta since last base backup) to a VM and its associated VDIs
+ * set the delta chain length ( number of delta since last base backup) to a VM and its associated VDIs
  *
  * @param {Xapi} xapi
  * @param {String} vmRef
@@ -58,7 +58,7 @@ export async function setVmDeltaChainLength(xapi, vmRef, length) {
 
 /**
  * Compute the delta chain length of a VM and its associated VDIs
- * if there is a discrependcy, use, the highest value
+ * if there is a discrepancy, use, the highest value
  * @param {Xapi} xapi
  * @param {String} vmRef
  * @returns {Promise}
@@ -92,7 +92,7 @@ export function resetVmOtherConfig(xapi, vmRef) {
 
 /**
  *
- * used to ensure compatibiliy with the previous snapshots that were having the config stored only into VM
+ * used to ensure compatibility with the previous snapshots that were having the config stored only into VM
  *
  * @param {Xapi} xapi
  * @param {String} vmRef
@@ -152,7 +152,7 @@ export async function setVmOtherConfig(xapi, vmRef, { timestamp, jobId, schedule
 }
 /**
  *
- * mark the export of he VM and its VDIs as successfull
+ * mark the export of he VM and its VDIs as successful
  *
  * @param {Xapi} xapi
  * @param {String} vmRef

package/_runners/_vmRunners/FullRemote.mjs

@@ -24,7 +24,7 @@ export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote
         writer =>
           writer.run({
             stream: forkStreamUnpipe(stream),
-            // stream will be forked and transformed, it's not safe to attach additionnal properties to it
+            // stream will be forked and transformed, it's not safe to attach additional properties to it
             streamLength: stream.length,
             maxStreamLength: stream.maxStreamLength, // on encrypted source
             timestamp: metadata.timestamp,

package/_runners/_vmRunners/FullXapi.mjs

@@ -45,8 +45,8 @@ export const FullXapi = class FullXapiVmBackupRunner extends AbstractXapi {
     for (const vdiRef of vdis) {
       const vdi = await this._xapi.getRecord('VDI', vdiRef)
 
-      // the size a of fully allocated vdi will be virtual_size  exaclty, it's a gross over evaluation
-      // of the real stream size in general, since a disk is never completly full
+      // the size a of fully allocated vdi will be virtual_size exactly, it's a gross over evaluation
+      // of the real stream size in general, since a disk is never completely full
       // vdi.physical_size seems to underevaluate a lot the real disk usage of a VDI, as of 2023-10-30
       maxStreamLength += vdi.virtual_size
     }

package/_runners/_vmRunners/IncrementalRemote.mjs

@@ -5,6 +5,7 @@ import assert from 'node:assert'
 import * as UUID from 'uuid'
 
 import { AbstractRemote } from './_AbstractRemote.mjs'
+import { forkDeltaExport } from './_forkDeltaExport.mjs'
 import { IncrementalRemoteWriter } from '../_writers/IncrementalRemoteWriter.mjs'
 import { Disposable } from 'promise-toolbox'
 import { openVhd } from 'vhd-lib'
@@ -17,7 +18,7 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
     return IncrementalRemoteWriter
   }
 
-  // we'll transfer the full list if at least one backup should be transfered
+  // we'll transfer the full list if at least one backup should be transferred
   // to ensure we don't cut the delta chain
   _filterTransferList(transferList) {
     if (transferList.some(vmBackupMetadata => this._filterPredicate(vmBackupMetadata))) {
@@ -88,18 +89,10 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
       await this._selectBaseVm(metadata)
       await this._callWriters(writer => writer.prepare({ isBase: metadata.isBase }), 'writer.prepare()')
 
-      function fork(incrementalExport, label) {
-        const { disks, ...forked } = incrementalExport
-        forked.disks = {}
-        for (const key in disks) {
-          forked.disks[key] = disks[key].fork(label)
-        }
-        return forked
-      }
       await this._callWriters(
         writer =>
           writer.transfer({
-            deltaExport: fork(incrementalExport, writer.constructor.name + ' ' + Math.random()),
+            deltaExport: forkDeltaExport(incrementalExport, writer.constructor.name),
             isVhdDifferencing,
             timestamp: metadata.timestamp,
             vm: metadata.vm,

package/_runners/_vmRunners/IncrementalXapi.mjs

@@ -2,6 +2,7 @@ import { createLogger } from '@xen-orchestra/log'
 import keyBy from 'lodash/keyBy.js'
 
 import { AbstractXapi } from './_AbstractXapi.mjs'
+import { forkDeltaExport } from './_forkDeltaExport.mjs'
 import { exportIncrementalVm } from '../../_incrementalVm.mjs'
 import { IncrementalRemoteWriter } from '../_writers/IncrementalRemoteWriter.mjs'
 import { IncrementalXapiWriter } from '../_writers/IncrementalXapiWriter.mjs'
@@ -50,21 +51,14 @@ export const IncrementalXapi = class IncrementalXapiVmBackupRunner extends Abstr
     if (useNbd) {
       Task.info('Transfer data using NBD')
     }
-    function fork(deltaExport, label) {
-      const { disks, ...forked } = deltaExport
-      forked.disks = {}
-      for (const key in disks) {
-        forked.disks[key] = disks[key].fork(label)
-      }
-      return forked
-    }
 
-    // @todo : reimplement throttle,nbsource: d use
+    // @todo : reimplement throttle
+
     const timestamp = Date.now()
     await this._callWriters(
       writer =>
         writer.transfer({
-          deltaExport: fork(deltaExport, writer.constructor.name + ' ' + Math.random()),
+          deltaExport: forkDeltaExport(deltaExport, writer.constructor.name),
           isVhdDifferencing,
           timestamp,
           vm,

package/_runners/_vmRunners/_AbstractRemote.mjs

@@ -90,7 +90,7 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
     for (const timestamp of timestamps) {
       if (remoteMetadatas[timestamp] !== nbRemotes) {
         // this backup is not present in all the remote
-        // should be retransfered if not found later
+        // should be retransferred if not found later
         transferList.push(localMetada.get(timestamp))
       } else {
         // backup is present in local and remote : the chain has already been transferred

package/_runners/_vmRunners/_AbstractXapi.mjs

@@ -195,7 +195,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
       }
     })
     await Promise.all(vmSnapshots.map(snapshot => populateVdisOtherConfig(xapi, snapshot.$ref)))
-    // end of compatibiliy handling
+    // end of compatibility handling
 
     // handle snapshot by VDI
     this._jobSnapshotVdis = []
@@ -298,7 +298,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
       // 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
+      // only delete snapshot data if the config allows it
       this._settings.cbtDestroySnapshotData
     ) {
       Task.info('will delete snapshot data')

package/_runners/_vmRunners/_forkDeltaExport.mjs

@@ -0,0 +1,16 @@
+import { SynchronizedDisk } from '@xen-orchestra/disk-transform'
+import cloneDeep from 'lodash/cloneDeep.js'
+
+export function forkDeltaExport(deltaExport, label) {
+  label += ' ' + Math.random()
+  const { disks, ...rest } = deltaExport
+  const fork = cloneDeep(rest)
+  fork.disks = {}
+  for (const [key, disk] of Object.entries(disks)) {
+    if (!(disk instanceof SynchronizedDisk)) {
+      throw new Error('Can only fork synchronized disks ')
+    }
+    fork.disks[key] = disk.fork(label)
+  }
+  return fork
+}

package/_runners/_writers/IncrementalRemoteWriter.mjs

@@ -230,7 +230,7 @@ export class IncrementalRemoteWriter extends MixinRemoteWriter(AbstractIncrement
           const path = `${this._vmBackupDir}/${vhds[diskRef]}`
           await adapter.writeVhd(path, disk, {
             // no checksum for VHDs, because they will be invalidated by
-            // merges and chainings
+            // merges and chains
             checksum: false,
             validator: tmpPath => checkVhd(handler, tmpPath),
             writeBlockConcurrency: this._config.writeBlockConcurrency,

package/_runners/_writers/IncrementalXapiWriter.mjs

@@ -21,7 +21,7 @@ export class IncrementalXapiWriter extends MixinXapiWriter(AbstractIncrementalWr
     }
 
     // @todo use an index if possible
-    // @todo : this seems similare to decorateVmMetadata
+    // @todo : this seems similar to decorateVmMetadata
     const replicatedVdis = sr.$VDIs
       .filter(vdi => {
         // REPLICATED_TO_SR_UUID is not used here since we are already filtering from sr.$VDIs

package/package.json

@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
-  "version": "0.61.0",
+  "version": "0.61.1",
   "engines": {
     "node": ">=14.18"
   },
@@ -25,7 +25,7 @@
     "@vates/decorate-with": "^2.1.0",
     "@vates/disposable": "^0.1.6",
     "@vates/fuse-vhd": "^2.1.2",
-    "@vates/generator-toolbox": "^1.0.2",
+    "@vates/generator-toolbox": "^1.0.3",
     "@vates/nbd-client": "^3.1.3",
     "@vates/parse-duration": "^0.1.1",
     "@xen-orchestra/async-map": "^0.1.2",