@xen-orchestra/backups 0.46.0 → 0.47.0

package/_backupWorker.mjs

@@ -2,7 +2,10 @@ import { createLogger } from '@xen-orchestra/log'
 import { catchGlobalErrors } from '@xen-orchestra/log/configure'
 
 import Disposable from 'promise-toolbox/Disposable'
+import humanFormat from 'human-format'
 import ignoreErrors from 'promise-toolbox/ignoreErrors'
+import mapValues from 'lodash/mapValues.js'
+import ms from 'ms'
 import { compose } from '@vates/compose'
 import { createCachedLookup } from '@vates/cached-dns.lookup'
 import { createDebounceResource } from '@vates/disposable/debounceResource.js'
@@ -20,7 +23,7 @@ createCachedLookup().patchGlobal()
 
 const logger = createLogger('xo:backups:worker')
 catchGlobalErrors(logger)
-const { debug } = logger
+const { debug, info } = logger
 
 class BackupWorker {
   #config
@@ -149,6 +152,27 @@ process.on('message', async message => {
   debug('message received', { message })
 
   if (message.action === 'run') {
+    const resourceStart = process.resourceUsage()
+    const timeStart = process.hrtime.bigint()
+    info('starting backup')
+
+    process.on('exit', exitCode => {
+      const resourceUsage = mapValues(process.resourceUsage(), (end, key) => end - resourceStart[key])
+      const cpuTotal = resourceUsage.userCPUTime + resourceUsage.systemCPUTime
+      const duration = Number((process.hrtime.bigint() - timeStart) / 1000n) // in μs
+
+      info('process will exit', {
+        duration,
+        exitCode,
+        resourceUsage,
+        summary: {
+          duration: ms(duration / 1000),
+          cpuUsage: Math.round((100 * cpuTotal) / duration) + '%',
+          memoryUsage: humanFormat.bytes(resourceUsage.maxRSS * 1024),
+        },
+      })
+    })
+
     const backupWorker = new BackupWorker(message.data)
     try {
       const result = message.runWithLogs
@@ -177,6 +201,7 @@ process.on('message', async message => {
         status: 'failure',
       })
     } finally {
+      info('backup has ended')
       await ignoreErrors.call(backupWorker.debounceResource.flushAll())
       process.disconnect()
     }

package/_runners/_vmRunners/FullRemote.mjs

@@ -1,5 +1,3 @@
-import { decorateMethodsWith } from '@vates/decorate-with'
-import { defer } from 'golike-defer'
 import { AbstractRemote } from './_AbstractRemote.mjs'
 import { FullRemoteWriter } from '../_writers/FullRemoteWriter.mjs'
 import { forkStreamUnpipe } from '../_forkStreamUnpipe.mjs'
@@ -10,15 +8,9 @@ export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote
   _getRemoteWriter() {
     return FullRemoteWriter
   }
-  async _run($defer) {
+  async _run() {
     const transferList = await this._computeTransferList(({ mode }) => mode === 'full')
 
-    await this._callWriters(async writer => {
-      await writer.beforeBackup()
-      $defer(async () => {
-        await writer.afterBackup()
-      })
-    }, 'writer.beforeBackup()')
     if (transferList.length > 0) {
       for (const metadata of transferList) {
         const stream = await this._sourceRemoteAdapter.readFullVmBackup(metadata)
@@ -46,7 +38,3 @@ export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote
     }
   }
 }
-
-decorateMethodsWith(FullRemote, {
-  _run: defer,
-})

package/_runners/_vmRunners/IncrementalRemote.mjs

@@ -1,6 +1,4 @@
 import { asyncEach } from '@vates/async-each'
-import { decorateMethodsWith } from '@vates/decorate-with'
-import { defer } from 'golike-defer'
 import assert from 'node:assert'
 import * as UUID from 'uuid'
 import isVhdDifferencingDisk from 'vhd-lib/isVhdDifferencingDisk.js'
@@ -52,14 +50,8 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
     })
     // yeah , let's go
   }
-  async _run($defer) {
+  async _run() {
     const transferList = await this._computeTransferList(({ mode }) => mode === 'delta')
-    await this._callWriters(async writer => {
-      await writer.beforeBackup()
-      $defer(async () => {
-        await writer.afterBackup()
-      })
-    }, 'writer.beforeBackup()')
 
     if (transferList.length > 0) {
       for (const metadata of transferList) {
@@ -110,6 +102,3 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
 }
 
 export const IncrementalRemote = IncrementalRemoteVmBackupRunner
-decorateMethodsWith(IncrementalRemoteVmBackupRunner, {
-  _run: defer,
-})

package/_runners/_vmRunners/_AbstractRemote.mjs

@@ -1,4 +1,6 @@
 import { asyncEach } from '@vates/async-each'
+import { decorateMethodsWith } from '@vates/decorate-with'
+import { defer } from 'golike-defer'
 import { Disposable } from 'promise-toolbox'
 
 import { getVmBackupDir } from '../../_getVmBackupDir.mjs'
@@ -90,11 +92,21 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
     return chain
   }
 
-  async run() {
+  async run($defer) {
     const handler = this._sourceRemoteAdapter._handler
     await Disposable.use(await handler.lock(getVmBackupDir(this._vmUuid)), async () => {
+      await this._callWriters(async writer => {
+        await writer.beforeBackup()
+        $defer(async () => {
+          await writer.afterBackup()
+        })
+      }, 'writer.beforeBackup()')
       await this._run()
       await this._healthCheck()
     })
   }
 }
+
+decorateMethodsWith(AbstractRemote, {
+  run: defer,
+})

package/_runners/_writers/_MixinRemoteWriter.mjs

@@ -100,7 +100,12 @@ export const MixinRemoteWriter = (BaseClass = Object) =>
               additionnalVmTag: 'xo:no-bak=Health Check',
             },
           }).run()
-          const restoredVm = xapi.getObject(restoredId)
+          let restoredVm
+          try {
+            restoredVm = xapi.getObject(restoredId)
+          } catch (err) {
+            restoredVm = await xapi.waitObject(restoredId)
+          }
           try {
             await new HealthCheckVmBackup({
               restoredVm,

package/_runners/_writers/_MixinXapiWriter.mjs

@@ -26,7 +26,8 @@ export const MixinXapiWriter = (BaseClass = Object) =>
     }
 
     healthCheck() {
-      const sr = this._healthCheckSr
+      // the SR that the VM has been replicated on
+      const sr = this._sr
       assert.notStrictEqual(sr, undefined, 'SR should be defined before making a health check')
       assert.notEqual(this._targetVmRef, undefined, 'A vm should have been transfered to be health checked')
       // copy VM
@@ -38,8 +39,12 @@ export const MixinXapiWriter = (BaseClass = Object) =>
           const { $xapi: xapi } = sr
           let healthCheckVmRef
           try {
-            const baseVm = xapi.getObject(this._targetVmRef) ?? (await xapi.waitObject(this._targetVmRef))
-
+            let baseVm
+            try {
+              baseVm = xapi.getObject(this._targetVmRef)
+            } catch (err) {
+              baseVm = await xapi.waitObject(this._targetVmRef)
+            }
             if (await this.#isAlreadyOnHealthCheckSr(baseVm)) {
               healthCheckVmRef = await Task.run(
                 { name: 'cloning-vm' },
@@ -53,11 +58,17 @@ export const MixinXapiWriter = (BaseClass = Object) =>
                 { name: 'copying-vm' },
                 async () =>
                   await xapi
-                    .callAsync('VM.copy', this._targetVmRef, `Health Check - ${baseVm.name_label}`, sr.$ref)
+                    .callAsync(
+                      'VM.copy',
+                      this._targetVmRef,
+                      `Health Check - ${baseVm.name_label}`,
+                      this._healthCheckSr.$ref
+                    )
                     .then(extractOpaqueRef)
               )
             }
-            const healthCheckVm = xapi.getObject(healthCheckVmRef) ?? (await xapi.waitObject(healthCheckVmRef))
+            const healthCheckVm =
+              xapi.getObject(healthCheckVmRef, undefined) ?? (await xapi.waitObject(healthCheckVmRef))
             await healthCheckVm.add_tags('xo:no-bak=Health Check')
             await new HealthCheckVmBackup({
               restoredVm: healthCheckVm,

package/package.json

@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
-  "version": "0.46.0",
+  "version": "0.47.0",
   "engines": {
     "node": ">=14.18"
   },
@@ -36,15 +36,17 @@
     "d3-time-format": "^4.1.0",
     "decorator-synchronized": "^0.6.0",
     "golike-defer": "^0.5.1",
+    "human-format": "^1.2.0",
     "limit-concurrency-decorator": "^0.5.0",
     "lodash": "^4.17.20",
+    "ms": "^2.1.3",
     "node-zone": "^0.4.0",
     "parse-pairs": "^2.0.0",
     "promise-toolbox": "^0.21.0",
     "proper-lockfile": "^4.1.2",
     "tar": "^6.1.15",
     "uuid": "^9.0.0",
-    "vhd-lib": "^4.9.1",
+    "vhd-lib": "^4.9.2",
     "xen-api": "^3.0.0",
     "yazl": "^2.5.1"
   },