@xen-orchestra/backups 0.56.0 → 0.58.0

package/README.md

@@ -12,6 +12,19 @@ Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/backu
 npm install --save @xen-orchestra/backups
 ```
 
+## Usage
+
+## Changing the default backup configuration
+
+This library receives a backup configuration from `xo-server` or `xo-proxy`. This configuration is split between multiple properties:
+
+- `config` contains values related to the general backup configuration
+- `config.defaultSettings`, `config.vm.defaultSettings` and `config.metadata.defaultSettings` contain values related to backup jobs default settings:
+  - `config.vm.defaultSettings` is related to VM backup jobs (see [DEFAULT_XAPI_VM_SETTINGS](https://github.com/vatesfr/xen-orchestra/blob/568e14f7eec7c3ddf685d324ad4733a3ef577995/%40xen-orchestra/backups/_runners/VmsRemote.mjs#L15))
+  - `config.metadata.defaultSettings` is related to metadata backup jobs (see [DEFAULT_METADATA_SETTINGS](https://github.com/vatesfr/xen-orchestra/blob/568e14f7eec7c3ddf685d324ad4733a3ef577995/%40xen-orchestra/backups/_runners/Metadata.mjs#L12))
+  - `config.defaultSettings` is related to all backup jobs (see [DEFAULT_SETTINGS](https://github.com/vatesfr/xen-orchestra/blob/568e14f7eec7c3ddf685d324ad4733a3ef577995/%40xen-orchestra/backups/_runners/_Abstract.mjs#L7))
+  - in case of duplicate value, `config.vm.defaultSettings` and `config.metadata.defaultSettings` will prevail over `config.defaultSettings`, and a defined job setting will prevail over any `defaultSettings`
+
 ## Contributions
 
 Contributions are _very_ welcomed, either on the documentation or on

package/RemoteAdapter.mjs

@@ -700,7 +700,11 @@ export class RemoteAdapter {
     }
   }
 
-  async outputStream(path, input, { checksum = true, maxStreamLength, streamLength, validator = noop } = {}) {
+  async outputStream(
+    path,
+    input,
+    { checksum = !this._handler.isEncrypted, maxStreamLength, streamLength, validator = noop } = {}
+  ) {
     const container = watchStreamSize(input)
     await this._handler.outputStream(path, input, {
       checksum,

package/_cleanVm.mjs

@@ -575,7 +575,7 @@ export async function cleanVm(
       if (mergedSize) {
         // all disks are now key disk
         metadata.isVhdDifferencing = {}
-        for (const id of Object.values(metadata.vdis ?? {})) {
+        for (const id of Object.keys(metadata.vdis ?? {})) {
           metadata.isVhdDifferencing[`${id}.vhd`] = false
         }
       }

package/_getOldEntries.mjs

@@ -27,7 +27,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
-        return copy.format('gggg-WW')
+        return copy.format('gggg-ww')
       }
     },
     ancestor: 'daily',

package/_runners/_vmRunners/_Abstract.mjs

@@ -74,9 +74,12 @@ export const Abstract = class AbstractVmBackupRunner {
 
     // check if current VM has tags
     const tags = this._tags
-    const intersect = settings.healthCheckVmsWithTags.some(t => tags.includes(t))
 
-    if (settings.healthCheckVmsWithTags.length !== 0 && !intersect) {
+    // accept both 'xo:no-health-check' and 'xo:no-health-check=reason'
+    const vmAlwaysIgnored = tags.some(t => t.startsWith('xo:no-health-check'))
+    const intersect = !vmAlwaysIgnored && settings.healthCheckVmsWithTags.some(t => tags.includes(t))
+
+    if (vmAlwaysIgnored || (settings.healthCheckVmsWithTags.length !== 0 && !intersect)) {
       // create a task to have an info in the logs and reports
       return Task.run(
         {

package/_runners/_vmRunners/_AbstractXapi.mjs

@@ -150,7 +150,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
           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)))
+            await Promise.all(diskRefs.map(diskRef => xapi.callAsync('VDI.enable_cbt', diskRef)))
           } catch (error) {
             Task.info(`couldn't enable CBT`, error)
           }

package/package.json

@@ -8,7 +8,7 @@
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
-  "version": "0.56.0",
+  "version": "0.58.0",
   "engines": {
     "node": ">=14.18"
   },
@@ -28,7 +28,7 @@
     "@vates/nbd-client": "^3.1.2",
     "@vates/parse-duration": "^0.1.1",
     "@xen-orchestra/async-map": "^0.1.2",
-    "@xen-orchestra/fs": "^4.3.0",
+    "@xen-orchestra/fs": "^4.4.0",
     "@xen-orchestra/log": "^0.7.1",
     "@xen-orchestra/template": "^0.1.0",
     "app-conf": "^3.0.0",
@@ -49,7 +49,7 @@
     "uuid": "^9.0.0",
     "value-matcher": "^0.2.0",
     "vhd-lib": "^4.11.2",
-    "xen-api": "^4.6.0",
+    "xen-api": "^4.7.0",
     "yazl": "^2.5.1"
   },
   "devDependencies": {
@@ -59,7 +59,7 @@
     "tmp": "^0.2.1"
   },
   "peerDependencies": {
-    "@xen-orchestra/xapi": "^7.8.1"
+    "@xen-orchestra/xapi": "^7.11.0"
   },
   "license": "AGPL-3.0-or-later",
   "author": {