feat(hyper-v): technical exploration

* show a toggle on remote/sr selectors
* toggle is disabled if 1 or less targets are selected
* for backup and mirror backup forms
* show the details in the job list

.eslintrc.js

@@ -171,7 +171,6 @@ module.exports = {
         'vue/no-empty-component-block': 'error',
         'vue/no-multiple-objects-in-class': 'error',
         'vue/no-ref-object-reactivity-loss': 'error',
-        'vue/no-required-prop-with-default': 'error',
         'vue/no-static-inline-styles': 'error',
         'vue/no-template-target-blank': 'error',
         'vue/no-undef-components': ['error', { ignorePatterns: ['RouterLink', 'RouterView', 'I18nT'] }],
@@ -192,18 +191,14 @@ module.exports = {
     // Specific rules for XO i18n-related files
     {
       files: [
-        '@xen-orchestra/lite/**/*.{vue,ts,json}',
-        '@xen-orchestra/web/**/*.{vue,ts,json}',
+        '@xen-orchestra/lite/**/*.{vue,ts}',
+        '@xen-orchestra/web/**/*.{vue,ts}',
         '@xen-orchestra/web-core/**/*.{vue,ts,json}',
       ],
       extends: ['plugin:@intlify/vue-i18n/base'],
       settings: {
         'vue-i18n': {
-          localeDir: [
-            '@xen-orchestra/lite/src/locales/*.json',
-            '@xen-orchestra/web/src/locales/*.json',
-            '@xen-orchestra/web-core/lib/locales/*.json',
-          ],
+          localeDir: ['@xen-orchestra/web-core/lib/locales/*.json'],
           messageSyntaxVersion: '^9.9.0',
         },
       },
@@ -221,13 +216,44 @@ module.exports = {
         '@intlify/vue-i18n/no-raw-text': [
           'error',
           {
-            ignoreText: ['Xen Orchestra Lite', 'Xen Orchestra', 'XO Lite', 'XCP-ng', 'XO 5', '404', '⚠️'],
+            ignoreText: [
+              'Xen Orchestra Lite',
+              'Xen Orchestra',
+              'Xen Orchestra Appliance',
+              'XO Lite',
+              'XCP-ng',
+              'XO 5',
+              '404',
+              '⚠️',
+            ],
           },
         ],
         '@intlify/vue-i18n/no-v-html': 'error',
         '@intlify/vue-i18n/valid-message-syntax': 'error',
         '@intlify/vue-i18n/no-duplicate-keys-in-locale': 'error',
-        '@intlify/vue-i18n/no-missing-keys-in-other-locales': ['error', { ignoreLocales: ['de', 'fa', 'cs'] }],
+        '@intlify/vue-i18n/no-missing-keys-in-other-locales': [
+          'error',
+          {
+            ignoreLocales: [
+              'de',
+              'fa',
+              'cs',
+              'es',
+              'sv',
+              'it',
+              'ru',
+              'uk',
+              'nl',
+              'pt-BR',
+              'da',
+              'ko',
+              'nb-NO',
+              'ja',
+              'fi',
+              'pl',
+            ],
+          },
+        ],
       },
     },
     // Specific rules for XO dev-related files

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -40,8 +40,8 @@ body:
   - type: markdown
     attributes:
       value: |
-        - Don't forget to [read this first](https://xen-orchestra.com/docs/community.html)
-        - As well as follow [this guide](https://xen-orchestra.com/docs/community.html#report-a-bug)
+        - Don't forget to [read this first](https://docs.xen-orchestra.com/community)
+        - As well as follow [this guide](https://docs.xen-orchestra.com/community#report-a-bug)
   - type: input
     id: xo-sources-commit-number
     attributes:

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Continous Integration
+name: Continuous Integration
 on: push
 jobs:
   CI:

.gitignore

@@ -7,6 +7,8 @@
 /@vates/*/node_modules/
 /@xen-orchestra/*/dist/
 /@xen-orchestra/*/node_modules/
+/@xen-orchestra/rest-api/open-api/spec/swagger.json
+/@xen-orchestra/rest-api/src/open-api/routes/routes.ts
 /packages/*/dist/
 /packages/*/node_modules/
 

@vates/async-each/.USAGE.md

@@ -16,7 +16,7 @@ Returns a promise wich rejects as soon as a call to `iteratee` throws or a promi
 
 - `concurrency`: a number which indicates the maximum number of parallel call to `iteratee`, defaults to `10`. The value `0` means no concurrency limit.
 - `signal`: an abort signal to stop the iteration
-- `stopOnError`: wether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
+- `stopOnError`: whether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
 
 ```js
 import { asyncEach } from '@vates/async-each'

@vates/async-each/README.md

@@ -34,7 +34,7 @@ Returns a promise wich rejects as soon as a call to `iteratee` throws or a promi
 
 - `concurrency`: a number which indicates the maximum number of parallel call to `iteratee`, defaults to `10`. The value `0` means no concurrency limit.
 - `signal`: an abort signal to stop the iteration
-- `stopOnError`: wether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
+- `stopOnError`: whether to stop iteration of first error, or wait for all calls to finish and throw an `AggregateError`, defaults to `true`
 
 ```js
 import { asyncEach } from '@vates/async-each'

@vates/async-each/index.js

@@ -11,8 +11,8 @@ class AggregateError extends Error {
 
 /**
  * @template Item
- * @param {Iterable<Item>} iterable
- * @param {(item: Item, index: number, iterable: Iterable<Item>) => Promise<void>} iteratee
+ * @param {Iterable<Item>|AsyncIterable<Item>} iterable
+ * @param {(item: Item, index: number, iterable: Iterable<Item>|AsyncIterable<Item>) => Promise<void>} iteratee
  * @returns {Promise<void>}
  */
 exports.asyncEach = function asyncEach(iterable, iteratee, { concurrency = 10, signal, stopOnError = true } = {}) {
@@ -73,20 +73,20 @@ exports.asyncEach = function asyncEach(iterable, iteratee, { concurrency = 10, s
       }
       nextIsRunning = true
       if (running < concurrency) {
-        const cursor = await it.next()
-        if (cursor.done) {
-          next = () => {
-            if (running === 0) {
-              if (errors.length === 0) {
-                resolve()
-              } else {
-                reject(new AggregateError(errors))
+        try {
+          const cursor = await it.next()
+          if (cursor.done) {
+            next = () => {
+              if (running === 0) {
+                if (errors.length === 0) {
+                  resolve()
+                } else {
+                  reject(new AggregateError(errors))
+                }
               }
             }
-          }
-        } else {
-          ++running
-          try {
+          } else {
+            ++running
             const result = iteratee.call(this, cursor.value, index++, iterable)
             let then
             if (result != null && typeof result === 'object' && typeof (then = result.then) === 'function') {
@@ -94,9 +94,9 @@ exports.asyncEach = function asyncEach(iterable, iteratee, { concurrency = 10, s
             } else {
               onFulfilled(result)
             }
-          } catch (error) {
-            onRejected(error)
           }
+        } catch (error) {
+          onRejected(error)
         }
         nextIsRunning = false
         return next()

@vates/async-each/index.test.js

@@ -114,6 +114,20 @@ describe('asyncEach', () => {
 
         tracker.verify()
       })
+
+      it('handle error on iterable', async () => {
+        const iteratee = spy(async () => {})
+        const iterable = async function* () {
+          for (const value of [1, 2, 3]) {
+            if (value === 2) {
+              throw new Error('iterator error')
+            }
+            await randomDelay()
+            yield value
+          }
+        }
+        await assert.rejects(() => asyncEach(iterable(), iteratee, { concurrency: 1 }), { message: 'iterator error' })
+      })
     })
   )
 })

@vates/async-each/package.json

@@ -24,7 +24,7 @@
     "url": "https://vates.fr"
   },
   "license": "ISC",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "engines": {
     "node": ">=8.10"
   },

@vates/diff/index.js

@@ -7,7 +7,7 @@
  * @param {Array|Buffer|string} data1 - The first data array or buffer to compare.
  * @param {T} data2 - The second data array or buffer to compare.
  * @param {(index: number, diff: T) => void} [cb] - The callback function to invoke for each difference. If not provided, an array of differences will be returned.
- * @returns {Array<number|T>|undefined} - An array of differences if no callback is provided, otherwise undefined.
+ * @returns {Array<number|T>|undefined} - An array of differences if no callback is provided; otherwise, undefined.
  */
 module.exports = function diff(data1, data2, cb) {
   let result

@vates/disposable/.USAGE.md

@@ -14,7 +14,7 @@ import { deduped } from '@vates/disposable/deduped'
 // the connection with the passed host will be established once at the first call, then, it will be shared with the next calls
 const getConnection = deduped(async function (host)) {
   const connection = new Connection(host)
-  return new Disposabe(connection, () => connection.close())
+  return new Disposable(connection, () => connection.close())
 }, host => [host])
 ```
 

@vates/disposable/README.md

@@ -32,7 +32,7 @@ import { deduped } from '@vates/disposable/deduped'
 // the connection with the passed host will be established once at the first call, then, it will be shared with the next calls
 const getConnection = deduped(async function (host)) {
   const connection = new Connection(host)
-  return new Disposabe(connection, () => connection.close())
+  return new Disposable(connection, () => connection.close())
 }, host => [host])
 ```
 

@vates/fatfs/.gitignore

@@ -1,3 +0,0 @@
-.DS_Store
-.vscode/
-node_modules/

@vates/fatfs/README.md

@@ -28,7 +28,7 @@ fs.stat('autoexec.bat', function (e, stats) {
 
 ## API
 
-- `fs = fatfs.createFileSystem(vol, [opts], [cb])` — Simply pass in a block driver (see below) mapped to a FAT partition somewhere, and get back the API documented [here](http://nodejs.org/api/fs.html). An options dictionary can be provided, details are in the next section. You may also optionally provide a callback `cb(err)` which will be automatically registered for the on `'ready'` or `'error'` event.
+- `fs = fatfs.createFileSystem(vol, [opts], [cb])` — Simply pass in a block driver (see below) mapped to a FAT partition somewhere, and get back an instance of an [`fs`](http://nodejs.org/api/fs.html). An options dictionary can be provided, details are in the next section. You may also optionally provide a callback `cb(err)` which will be automatically registered for the on `'ready'` or `'error'` event.
 - `'ready'` event — fired on `fs` when initial volume information has been determined and the API is ready to use. It is safe to call other `fs` methods before this fires **only if** you are sure the first sector will be readable and represents a valid FAT volume.
 - `'error'` event — fired if initialization fails for whatever reason.
 
@@ -36,7 +36,7 @@ fs.stat('autoexec.bat', function (e, stats) {
 
 The `opts` dictionary you pass to `fatfs.createFileSystem` can contain any of the following options:
 
-- `ro` — Enables readonly mode if `true`. It defaults to `false`, but if your volume driver does not provide a `writeSectors` method it will be overriden to `true`.
+- `ro` — Enables readonly mode if `true`. It defaults to `false`, but if your volume driver does not provide a `writeSectors` method it will be overridden to `true`.
 - `noatime` — The FAT filesystem can track the last access time (just a date, actually) but this means every read operation would also incur some write overhead. Defaults to `true`, meaning by default access times will **not** be updated on reads. Set this to `false` to track access times.
 - `modmode` — chooses how `fs.chmod` (and the mode field from `fs.stat`–family calls) should map FAT attributes to POSIX permissions. Set to the number `0111` to map the readonly flag to the user's write bit being unset, and the archive/system/hidden flags to the user/group/other executable bits respectively. Set to the number `07000` to map the readonly flag to _all_ write bits being unset, and the archive/system/hidden flags to the sticky/setgid/setuid bits respectively. Set to `null` for readonly mapping. Defaults to `0111`.
 - `umask` — any bits _set_ in this octal number will be _unset_ in the 'mode' field from `fs.stat`–family calls. It does not affect anything else. Defaults to `process.umask()`, or `0022` if that is unavailable.
@@ -53,7 +53,7 @@ Well, sort of…
 
 ### Temporary
 
-- **BETA** **BETA** **BETA**. Seriously, this is a _brand new_, _from scratch_, _completely unproven_ filesystem implementation. It does not have full automated test coverage, and it has not been manually tested very much either. Please please please **make sure you have a backup** of any important drive/image/card you unleash this upon.
+- **BETA** **BETA** **BETA**. Seriously, this is a _brand new_, _from scratch_, _completely unproven_ filesystem implementation. It does not have full automated test coverage, and it has not been manually tested very much either. Please, please, please, **make sure you have a backup** of any important drive/image/card you unleash this upon.
 - A few methods are not quite implemented, either: `fs.rename`, `fs.unlink` and `fs.rmdir`, as well as `fs.watchFile`/`fs.unwatchFile` and `fs.watch`. These are Coming Soon™.
 - There are several internal housekeeping items (redundant FAT tables, extra FAT32 information, etc.) that are not done. These do not seem to affect interop, but you may see warnings when repairing a filesystem written by this module.
 - Oh, and not to scare you, but if an IO error happens while writing, the library usually just bails — bubbling an error up to your callback as if it were a hot potato. Although some attempt has been made to do separate writes in the safest order (e.g. allocating an additional file cluster, then appending data into it, and then finally updating the file's size), but this behavior has not been thoroughly audited for all operations. There's certainly no attempt to retry/cleanup/rollback if a multi-step change runs into trouble partway through.

@vates/fatfs/helpers.js

@@ -62,7 +62,7 @@ exports.parseFlags = function (flags) {
         case 'ax':  info = {read:false, write:true, create:true, append:true, exclusive:true}; break;
         case 'a+':  info = {read:true, write:true, create:true, append:true}; break;
         case 'ax+': info = {read:true, write:true, create:true, append:true, exclusive:true}; break;
-        default: throw Error("Uknown mode: "+flags);       // TODO: throw as `S.err.INVAL`
+        default: throw Error("Unknown mode: "+flags);       // TODO: throw as `S.err.INVAL`
     }
     if (info.sync) throw Error("Mode not implemented.");    // TODO: what would this require of us?
     if (_dir) info._openDir = true;

@vates/fatfs/package.json

@@ -1,15 +1,16 @@
 {
   "private": false,
   "name": "@vates/fatfs",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "fs implementation on top of raw FAT16/FAT32 block source",
   "main": "index.js",
   "scripts": {
     "postversion": "npm publish --access public"
   },
   "repository": {
+    "directory": "@vates/fatfs",
     "type": "git",
-    "url": "https://github.com/vatesfr/xen-orchestra"
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
   "keywords": [
     "filesystem",
@@ -20,13 +21,14 @@
   ],
   "author": "Vates SAS",
   "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/vatesfr/xen-orchestra/issues"
-  },
-  "homepage": "https://github.com/vatesfr/xen-orchestra",
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/fatfs",
   "dependencies": {
     "fifolock": "^1.0.0",
     "struct-fu": "^1.2.1",
     "xok": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=18"
   }
 }

@vates/fatfs/test.js

@@ -90,7 +90,7 @@ function startTests(vol, waitTime) {
                 assert(path === file, "Fixed fluffy path matches normal one.");
             });
             fs.realpath([BASE_DIR,"non","existent","path"].join('/'), function (e) {
-                assert(e, "Expected error calling fs.realpath on non-existent file.");
+                assert(e, "Expected error calling fs.realpath on nonexistent file.");
             });
             
             fs.readdir(BASE_DIR, function (e, arr) {

@vates/fuse-vhd/.USAGE.md

@@ -13,7 +13,7 @@ await mount(handler, diskId, mountPoint)
 
 ### cli
 
-From the install folder :
+From the install folder:
 
 ```
 cli.mjs <remoteUrl> <vhdPathInRemote> <mountPoint>
@@ -25,4 +25,25 @@ After installing the package
 xo-fuse-vhd <remoteUrl> <vhdPathInRemote> <mountPoint>
 ```
 
-remoteUrl can be found by using cli in `@xen-orchestra/fs` , for example a local remote will have a url like `file:///path/to/remote/root`
+The `remoteUrl` can be found using the following command from the XOA CLI, and then picking the right `url` property:
+
+`xo-server-db ls remote`
+
+The `vhdPathInRemote` follows a file structure described in [VM backups](https://github.com/vatesfr/xen-orchestra/blob/master/%40xen-orchestra/backups/docs/VM%20backups/README.md).
+
+## Restore a file from a VHD using `fuse-vhd` CLI
+
+1. Mount a VHD to the Filesystem (see **Usage**).
+2. Verify the VHD is Correctly Mounted:
+
+`mount | grep fuse`
+
+3. Get the `START` and `SIZE` of the disk whose file you want to restore. Multiply `START` by 512 (block size) to get the offset value. (`mountedVhdPath` is the `mountPoint` value from earlier, followed by `/vhd0`, for example). Depending on the partition type, you may need to do some additional setup to discover the partitions.
+
+`partx --bytes --output=NR,START,SIZE,NAME,UUID,TYPE --pairs <mountedVhdPath>`
+
+4.  Mount the disk. Depending on the partition type, you may need to add some additional options. The `norecovery` option is used for ext3/ext4/xfs file systems; otherwise, remove this option.
+
+`mount --options=loop,ro,norecovery,sizelimit=<SIZE>,offset=<START*512>  --source=<mountedVhdPath> --target=<diskMountPoint>`
+
+5. Copy your files from the mounted partition, then unmount the partition.

@vates/fuse-vhd/README.md

@@ -29,7 +29,7 @@ await mount(handler, diskId, mountPoint)
 
 ### cli
 
-From the install folder :
+From the install folder:
 
 ```
 cli.mjs <remoteUrl> <vhdPathInRemote> <mountPoint>
@@ -41,7 +41,28 @@ After installing the package
 xo-fuse-vhd <remoteUrl> <vhdPathInRemote> <mountPoint>
 ```
 
-remoteUrl can be found by using cli in `@xen-orchestra/fs` , for example a local remote will have a url like `file:///path/to/remote/root`
+The `remoteUrl` can be found using the following command from the XOA CLI, and then picking the right `url` property:
+
+`xo-server-db ls remote`
+
+The `vhdPathInRemote` follows a file structure described in [VM backups](https://github.com/vatesfr/xen-orchestra/blob/master/%40xen-orchestra/backups/docs/VM%20backups/README.md).
+
+## Restore a file from a VHD using `fuse-vhd` CLI
+
+1. Mount a VHD to the Filesystem (see **Usage**).
+2. Verify the VHD is Correctly Mounted:
+
+`mount | grep fuse`
+
+3. Get the `START` and `SIZE` of the disk whose file you want to restore. Multiply `START` by 512 (block size) to get the offset value. (`mountedVhdPath` is the `mountPoint` value from earlier, followed by `/vhd0`, for example). Depending on the partition type, you may need to do some additional setup to discover the partitions.
+
+`partx --bytes --output=NR,START,SIZE,NAME,UUID,TYPE --pairs <mountedVhdPath>`
+
+4.  Mount the disk. Depending on the partition type, you may need to add some additional options. The `norecovery` option is used for ext3/ext4/xfs file systems; otherwise, remove this option.
+
+`mount --options=loop,ro,norecovery,sizelimit=<SIZE>,offset=<START*512>  --source=<mountedVhdPath> --target=<diskMountPoint>`
+
+5. Copy your files from the mounted partition, then unmount the partition.
 
 ## Contributions
 

@vates/fuse-vhd/package.json

@@ -19,12 +19,12 @@
   },
   "main": "./index.mjs",
   "dependencies": {
-    "@xen-orchestra/fs": "^4.3.0",
+    "@xen-orchestra/fs": "^4.6.6",
     "@xen-orchestra/log": "^0.7.1",
     "fuse-native": "^2.2.6",
     "lru-cache": "^7.14.0",
     "promise-toolbox": "^0.21.0",
-    "vhd-lib": "^4.11.2"
+    "vhd-lib": "^4.14.7"
   },
   "bin": {
     "xo-fuse-vhd": "./cli.mjs"

@vates/generator-toolbox/.USAGE.md

@@ -0,0 +1,58 @@
+A toolbox to ease the use of generator
+
+### Timeout
+
+wrap a source async generator to have it throw an error when timeout is reached
+timeout is a positive number in milliseconds
+
+```js
+import { Timeout } from '@vates/generator-toolbox'
+
+const wrappedGenerator = new Timeout(sourceGenerator, timeout)
+```
+
+### Throttle
+
+wrap a source async generator to have it respect a max speed ( in bytes per seconds).
+speed is either a strictly positive number or a function returning a strictly positive number. A speed change will be used for the next emitted packet.
+
+The source generator must yield object with a length property.
+
+Optimized for small yields regarding to the speed, since it won't split incoming packet.
+
+If the generator reached the max speed it will be paused, limiting memory consumption.
+
+```js
+import { Throttle } from '@vates/generator-toolbox'
+
+const wrappedGenerator = new Throttle(sourceGenerator, speed)
+```
+
+### Synchronized
+
+Fork a generator. The rules are:
+
+- if the source returns, all the forks return
+- if the forks error, all the forks error with the same error
+- if a fork returns, it is stopped, but the generator continue with the other
+- if a fork errors, it is stopped, but the generator continue with the other
+- if all the forks return, the source is stopped
+- if all the forks error, the source is errored with the last error
+- the source start producing a packet when the fastest forked ask for it
+- the source forks get the packet only when all the forks asked for it, no buffer stores in memory
+
+```ts
+import { Synchronized } from '@vates/generator-toolbox'
+
+async function consume(generator: AsyncGenerator) {
+  for await (const val of generator) {
+    console.log({ val })
+  }
+}
+const forker = new Synchronized(generator)
+const first = forker.fork('first')
+const second = forker.fork('second')
+await Promise.all([consume(first), consume(second)])
+```
+
+Note: you can stop early a generator by calling `generator.return()`, and you can stop in in error by calling `generator.throw(error)`

@vates/generator-toolbox/.npmignore

@@ -0,0 +1 @@
+../../scripts/npmignore

@vates/generator-toolbox/README.md

@@ -0,0 +1,89 @@
+<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->
+
+# @vates/generator-toolbox
+
+[![Package Version](https://badgen.net/npm/v/@vates/generator-toolbox)](https://npmjs.org/package/@vates/generator-toolbox) ![License](https://badgen.net/npm/license/@vates/generator-toolbox) [![PackagePhobia](https://badgen.net/bundlephobia/minzip/@vates/generator-toolbox)](https://bundlephobia.com/result?p=@vates/generator-toolbox) [![Node compatibility](https://badgen.net/npm/node/@vates/generator-toolbox)](https://npmjs.org/package/@vates/generator-toolbox)
+
+## Install
+
+Installation of the [npm package](https://npmjs.org/package/@vates/generator-toolbox):
+
+```sh
+npm install --save @vates/generator-toolbox
+```
+
+## Usage
+
+A toolbox to ease the use of generator
+
+### Timeout
+
+wrap a source async generator to have it throw an error when timeout is reached
+timeout is a positive number in milliseconds
+
+```js
+import { Timeout } from '@vates/generator-toolbox'
+
+const wrappedGenerator = new Timeout(sourceGenerator, timeout)
+```
+
+### Throttle
+
+wrap a source async generator to have it respect a max speed ( in bytes per seconds).
+speed is either a strictly positive number or a function returning a strictly positive number. A speed change will be used for the next emitted packet.
+
+The source generator must yield object with a length property.
+
+Optimized for small yields regarding to the speed, since it won't split incoming packet.
+
+If the generator reached the max speed it will be paused, limiting memory consumption.
+
+```js
+import { Throttle } from '@vates/generator-toolbox'
+
+const wrappedGenerator = new Throttle(sourceGenerator, speed)
+```
+
+### Synchronized
+
+Fork a generator. The rules are:
+
+- if the source returns, all the forks return
+- if the forks error, all the forks error with the same error
+- if a fork returns, it is stopped, but the generator continue with the other
+- if a fork errors, it is stopped, but the generator continue with the other
+- if all the forks return, the source is stopped
+- if all the forks error, the source is errored with the last error
+- the source start producing a packet when the fastest forked ask for it
+- the source forks get the packet only when all the forks asked for it, no buffer stores in memory
+
+```ts
+import { Synchronized } from '@vates/generator-toolbox'
+
+async function consume(generator: AsyncGenerator) {
+  for await (const val of generator) {
+    console.log({ val })
+  }
+}
+const forker = new Synchronized(generator)
+const first = forker.fork('first')
+const second = forker.fork('second')
+await Promise.all([consume(first), consume(second)])
+```
+
+Note: you can stop early a generator by calling `generator.return()`, and you can stop in in error by calling `generator.throw(error)`
+
+## Contributions
+
+Contributions are _very_ welcomed, either on the documentation or on
+the code.
+
+You may:
+
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
+  you've encountered;
+- fork and create a pull request.
+
+## License
+
+[MIT](https://spdx.org/licenses/MIT) © [Vates SAS](https://vates.fr)

@vates/generator-toolbox/eslint.config.mjs

@@ -0,0 +1,6 @@
+// @ts-check
+
+import eslint from '@eslint/js'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(eslint.configs.recommended, tseslint.configs.recommended)

@vates/generator-toolbox/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@vates/generator-toolbox",
+  "version": "1.1.0",
+  "main": "dist/index.mjs",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "devDependencies": {
+    "@eslint/js": "^9.19.0",
+    "rimraf": "^6.0.1",
+    "@types/node": "^20.6",
+    "typescript": "~5.6",
+    "typescript-eslint": "^8.23.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "postversion": "npm publish --access public",
+    "prebuild": "rimraf dist/",
+    "predev": "yarn run prebuild",
+    "test": "tsc && node --test **/*.test.mjs",
+    "clean": "rimraf dist/"
+  },
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/generator-toolbox",
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "repository": {
+    "directory": "@vates/generator-toolbox",
+    "type": "git",
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "author": {
+    "name": "Vates SAS",
+    "url": "https://vates.fr"
+  },
+  "engines": {
+    "node": ">=20.18"
+  }
+}

@vates/generator-toolbox/src/index.mts

@@ -0,0 +1,3 @@
+export { Synchronized } from './synchronized.mjs'
+export { Throttle } from './throttle.mjs'
+export { Timeout } from './timeout.mjs'

@vates/generator-toolbox/src/synchronized.mts

@@ -0,0 +1,157 @@
+import assert from 'node:assert'
+
+export class Synchronized<T, TReturn, TNext> {
+  #source: AsyncGenerator<T, TReturn, TNext>
+  #forks = new Map<string, Forked<T, TReturn, TNext>>()
+  #removedForks = new Set<string>()
+  #waitingForks = new Set<string>()
+  #started = false
+
+  #nextValueForksReady?: {
+    promise: Promise<IteratorResult<T>>
+    forksWaitingReject: (error: Error) => void
+    forksWaitingResolve: () => void
+  }
+
+  constructor(source: AsyncGenerator<T, TReturn, TNext>) {
+    this.#source = source
+  }
+
+  fork(uid: string): AsyncGenerator<T, TReturn, TNext> {
+    assert.strictEqual(this.#started, false, `can't create a fork after consuming the data`)
+    assert.strictEqual(this.#forks.has(uid), false, `a fork with id ${uid} already exists`)
+
+    const fork = new Forked<T, TReturn, TNext>(this, uid)
+    this.#forks.set(uid, fork)
+    return fork
+  }
+
+  async #resolveWhenAllForksReady(): Promise<IteratorResult<T>> {
+    if (!this.#nextValueForksReady) {
+      throw new Error('Can t wait forks if there are noone waiting')
+    }
+    const { promise, forksWaitingResolve } = this.#nextValueForksReady
+    if (this.#waitingForks.size === this.#forks.size) {
+      // reset value
+      this.#waitingForks.clear()
+      this.#nextValueForksReady = undefined
+      forksWaitingResolve() // for the other forks waiting
+    }
+    return promise
+  }
+
+  async next(uid: string): Promise<IteratorResult<T>> {
+    if (this.#removedForks.has(uid)) {
+      return { done: true, value: undefined }
+    }
+    if (!this.#forks.has(uid)) {
+      throw new Error(`trying to advance fork ${uid} that is not a fork of this one`)
+    }
+
+    if (this.#waitingForks.has(uid)) {
+      throw new Error(`Fork ${uid} is already waiting`)
+    }
+
+    this.#started = true
+    if (this.#nextValueForksReady === undefined) {
+      let forksWaitingResolve = () => {}
+      let forksWaitingReject: (reason?: Error) => void = () => {}
+      const next = this.#source.next().catch(async error => {
+        const e = new Error(`Error in the source generator ${error.message}`, { cause: error })
+        forksWaitingReject(e)
+        // source has failed, kill everything, and stop the forks
+        for (const uid of [...this.#forks.keys()]) {
+          await this.remove(uid, error)
+        }
+      })
+      const promise = Promise.all([
+        next,
+        new Promise((_resolve, _reject) => {
+          forksWaitingResolve = () => _resolve(undefined)
+          forksWaitingReject = _reject
+        }),
+      ]).then(([_]) => _ as IteratorResult<T>)
+
+      this.#nextValueForksReady = { promise, forksWaitingResolve, forksWaitingReject }
+    }
+    this.#waitingForks.add(uid)
+    return this.#resolveWhenAllForksReady()
+  }
+
+  async remove(uid: string, error?: Error): Promise<IteratorResult<T>> {
+    const fork = this.#forks.get(uid)
+    if (fork === undefined) {
+      if (this.#removedForks.has(uid)) {
+        // already removed
+        return { done: true, value: undefined }
+      }
+      throw new Error(`trying to remove fork with uid ${uid} that is not a fork of this one`)
+    }
+    this.#forks.delete(uid)
+    this.#waitingForks.delete(uid)
+    this.#removedForks.add(uid)
+    try {
+      if (error === undefined) {
+        await fork.return()
+      } else {
+        await fork.throw(error)
+      }
+    } catch (cleaningError) {
+      console.error('Error while cleaning the forked', {
+        cleaningError,
+        sourceError: error,
+      })
+    }
+
+    if (this.#forks.size === 0) {
+      if (error === undefined) {
+        await this.#source.return(undefined as TReturn)
+      } else {
+        await this.#source.throw(error)
+      }
+      // Reject any pending forks waiting for the next value
+      if (this.#nextValueForksReady) {
+        this.#nextValueForksReady.forksWaitingReject(new Error('Source generator terminated.', { cause: error }))
+        this.#nextValueForksReady = undefined
+      }
+      // clear state
+      this.#removedForks.clear()
+      this.#waitingForks.clear()
+    } else {
+      // this fork was maybe blocking the others
+      if (this.#nextValueForksReady) {
+        await this.#resolveWhenAllForksReady()
+      }
+    }
+    return { done: true, value: undefined }
+  }
+}
+
+class Forked<T, TReturn, TNext> implements AsyncGenerator<T, TReturn, TNext> {
+  #parent: Synchronized<T, TReturn, TNext>
+  #uid: string
+  constructor(parent: Synchronized<T, TReturn, TNext>, uid: string) {
+    this.#parent = parent
+    this.#uid = uid
+  }
+  next(): Promise<IteratorResult<T>> {
+    return this.#parent.next(this.#uid)
+  }
+  async return(): Promise<IteratorResult<T>> {
+    return this.#parent.remove(this.#uid)
+  }
+  async throw(e: Error): Promise<IteratorResult<T>> {
+    return this.#parent.remove(this.#uid, e)
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<T> {
+    while (true) {
+      const res = await this.next()
+      if (res.done) {
+        break
+      }
+
+      yield res.value
+    }
+  }
+}

@vates/generator-toolbox/src/synchronized.test.mts

@@ -0,0 +1,150 @@
+import assert from 'node:assert'
+import { suite, test } from 'node:test'
+import { Synchronized } from './synchronized.mjs'
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+async function* makeRangeGenerator(end = Infinity, progress = { yielded: 0 }, onYielded = (val: unknown) => {}) {
+  for (let i = 0; i < end; i++) {
+    await new Promise(resolve => setTimeout(resolve, 10))
+    yield i
+    onYielded(i)
+    progress.yielded = i
+  }
+  return progress
+}
+
+async function consume(
+  iterable: AsyncGenerator,
+  delay = 2500,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  onConsumed = (val: unknown, iterable: AsyncGenerator) => Promise.resolve(false)
+) {
+  for await (const val of iterable) {
+    await new Promise(resolve => setTimeout(resolve, delay))
+    if (await onConsumed(val, iterable)) {
+      iterable.return(undefined)
+    }
+  }
+}
+
+suite('success', () => {
+  test('if works with multiple consumer', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(3, progress)
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    const second = forker.fork('second')
+    await Promise.all([consume(first, 50), consume(second, 500)])
+    assert.strictEqual(progress.yielded, 2)
+  })
+
+  test('if works with one consumer returning', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(10, progress)
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    const second = forker.fork('second')
+    await new Promise(resolve => setTimeout(resolve, 500))
+    await Promise.all([
+      consume(first, 1),
+      consume(second, 1, async (val: unknown) => {
+        return Promise.resolve(val === 2)
+      }),
+    ])
+    assert.strictEqual(progress.yielded, 9)
+  })
+  test('if works with all consumers returning', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(10, progress)
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    const second = forker.fork('second')
+    await new Promise(resolve => setTimeout(resolve, 500))
+    await Promise.all([
+      consume(first, 1, async (val: unknown) => {
+        return Promise.resolve(val === 5)
+      }),
+      consume(second, 1, async (val: unknown) => {
+        return Promise.resolve(val === 2)
+      }),
+    ])
+    assert.strictEqual(progress.yielded, 4)
+  })
+})
+
+suite('error', () => {
+  test('it fails all if error on source', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(5, progress, (val: unknown) => {
+      if (val === 2) {
+        throw new Error('source stop')
+      }
+    })
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    const second = forker.fork('second')
+    await assert.rejects(Promise.all([consume(first, 1), consume(second, 1)]))
+
+    assert.strictEqual(progress.yielded, 1)
+  })
+  test('it flows until the end if one consumer throws', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(10, progress)
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    const second = forker.fork('second')
+
+    const firstConsume = consume(first, 1)
+
+    const secondConsume = assert.rejects(() =>
+      consume(second, 1, async (val: unknown, iterable) => {
+        if (val === 1) {
+          await iterable.throw(new Error('error on second'))
+        }
+        return false
+      })
+    )
+    await Promise.allSettled([firstConsume, secondConsume])
+    assert.strictEqual(progress.yielded, 9)
+  })
+  test('it throw if ALL consumer throws', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(5, progress)
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    const second = forker.fork('second')
+
+    const firstConsume = consume(first, 1, async (val: unknown, iterable) => {
+      if (val === 3) {
+        await iterable.throw(new Error('error on first'))
+      }
+      return false
+    })
+    const secondConsume = consume(second, 1, async (val: unknown, iterable) => {
+      if (val === 1) {
+        await iterable.throw(new Error('error on second'))
+      }
+      return false
+    })
+
+    await assert.rejects(Promise.all([firstConsume, secondConsume]))
+    assert.strictEqual(progress.yielded, 2)
+  })
+
+  test('It should not allow a new fork after the start', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(5, progress)
+    const forker = new Synchronized(generator)
+    const first = forker.fork('first')
+    await first.next()
+    assert.throws(() => forker.fork('second'))
+  })
+  test('It should not allow fork with the same uid', async () => {
+    const progress = { yielded: 0 }
+    const generator = makeRangeGenerator(5, progress)
+    const forker = new Synchronized(generator)
+    forker.fork('first')
+    forker.fork('second')
+    assert.throws(() => forker.fork('first'))
+  })
+})

@vates/generator-toolbox/src/throttle.mts

@@ -0,0 +1,68 @@
+import assert from 'node:assert'
+
+/**
+ *
+ * This class will throttle the production of a group of generators
+ *
+ * limits: depends on the event loop, so don't expect it to be very precise
+ * works better with more small blocks
+ * The source generator must yield object with a length property
+ * Changing the speed will only be takin into account fot the next packets asked
+ */
+export class Throttle {
+  #previousSlot = 0
+  #bytesPerSecond: number | (() => number)
+  get speed(): number {
+    let speed: number
+    if (typeof this.#bytesPerSecond === 'function') {
+      speed = this.#bytesPerSecond()
+    } else {
+      speed = this.#bytesPerSecond
+    }
+    assert.ok(speed >= 0, `speed must be positive, ${speed} computed`)
+    return speed
+  }
+  constructor(speed: number | (() => number)) {
+    this.#bytesPerSecond = speed
+  }
+
+  getNextSlot(length: number): { timeout?: ReturnType<typeof setTimeout>; promise?: Promise<unknown> } {
+    assert.notStrictEqual(length, undefined, `throttled stream need to expose a length property }`)
+    assert.ok(length > 0, `throttled stream must expose a positive length property , ${length} given }`)
+    if (this.speed === 0) {
+      return {}
+    }
+    const previous = this.#previousSlot
+    const nextSlot = Math.round(previous + (length * 1000) / this.speed)
+    if (nextSlot < Date.now()) {
+      // we're above the limit, go now
+      this.#previousSlot = Date.now()
+      return {}
+    }
+    this.#previousSlot = nextSlot
+    // wait till the next slot
+    // it won't be extremely precise since the event loop is not
+    let timeout: ReturnType<typeof setTimeout> | undefined = undefined
+    const promise = new Promise(function (resolve) {
+      timeout = setTimeout(resolve, nextSlot - Date.now())
+    })
+    return { promise, timeout }
+  }
+
+  async *createThrottledGenerator(source: AsyncGenerator<{ length: number }>): AsyncGenerator<{ length: number }> {
+    let timeout: ReturnType<typeof setTimeout> | undefined
+    try {
+      for await (const value of source) {
+        const res = this.getNextSlot(value.length)
+        timeout = res.timeout
+        // wait for the time slot before yielding the data
+        if (res.promise !== undefined) {
+          await res.promise
+        }
+        yield value
+      }
+    } finally {
+      clearTimeout(timeout)
+    }
+  }
+}

@vates/generator-toolbox/src/throttle.test.mts

@@ -0,0 +1,63 @@
+import { Throttle } from './throttle.mjs'
+import { suite, test } from 'node:test'
+import assert from 'node:assert'
+
+async function* makeGenerator(chunkSize = 1024 * 1024, nbChunks = 100) {
+  for (let i = 0; i < nbChunks; i++) {
+    yield Buffer.allocUnsafe(chunkSize)
+  }
+}
+
+async function consumes(generator: AsyncGenerator) {
+  // eslint-disable-next-line no-empty,@typescript-eslint/no-unused-vars
+  for await (const data of generator) {
+  }
+}
+
+suite('it throttle one', () => {
+  test('base test', async () => {
+    // 10MB/s
+    const throttler = new Throttle(10 * 1024 * 1024)
+    const throttled = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 20))
+
+    const start = Date.now()
+    await consumes(throttled)
+    const end = Date.now()
+    assert.strictEqual(Math.round((end - start) / 1000), 2)
+  })
+  test('variable speed test', async () => {
+    // 10MB/s
+    const throttler = new Throttle(() => 10 * 1024 * 1024)
+    const throttled = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 20))
+
+    const start = Date.now()
+    await consumes(throttled)
+    const end = Date.now()
+    assert.strictEqual(Math.round((end - start) / 1000), 2)
+  })
+  test('multiple generator test', async () => {
+    // 10MB/s
+    const throttler = new Throttle(10 * 1024 * 1024)
+    const first = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
+    const second = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
+    const start = Date.now()
+
+    await Promise.all([consumes(first), consumes(second)])
+    const end = Date.now()
+    assert.strictEqual(Math.round((end - start) / 1000), 2)
+  })
+  test(`it doesn't accept negative value`, async () => {
+    // 10MB/s
+    let throttler = new Throttle(-10 * 1024 * 1024)
+    let generator = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
+    await assert.rejects(() => consumes(generator))
+
+    let index = 5
+    throttler = new Throttle(() => {
+      index--
+      return index > 0 ? 10 * 1024 * 1024 : -10 * 1024 * 1024
+    })
+    generator = throttler.createThrottledGenerator(makeGenerator(1024 * 1024, 10))
+    await assert.rejects(() => consumes(generator))
+  })
+})

@vates/generator-toolbox/src/timeout.mts

@@ -0,0 +1,37 @@
+import assert from 'node:assert'
+export class Timeout<T> implements AsyncGenerator {
+  #source: AsyncGenerator<T>
+  #timeout: number
+  constructor(source: AsyncGenerator<T>, timeout: number) {
+    assert.ok(timeout > 0, `Timeout value must be positive, ${timeout} received`)
+    this.#source = source
+    this.#timeout = timeout
+  }
+  async next(): Promise<IteratorResult<T>> {
+    let timeout: ReturnType<typeof setTimeout>
+    const promiseTimeout = new Promise((_, reject) => {
+      timeout = setTimeout(() => {
+        reject(new Error('Timeout reached '))
+      }, this.#timeout)
+    })
+    const promiseNext = new Promise((resolve, reject) => {
+      this.#source.next().then(res => {
+        // ensure timetout won't fire later
+        clearTimeout(timeout)
+        resolve(res)
+      }, reject)
+    })
+    // promiseTimeout will never resolve
+    return Promise.race([promiseNext, promiseTimeout]) as Promise<IteratorResult<T>>
+  }
+  return(): Promise<IteratorResult<T>> {
+    return this.#source.return(undefined)
+  }
+  throw(e: Error): Promise<IteratorResult<T>> {
+    return this.#source.throw(e)
+  }
+
+  [Symbol.asyncIterator](): AsyncGenerator<T> {
+    return this
+  }
+}

@vates/generator-toolbox/src/timeout.test.mts

@@ -0,0 +1,67 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert'
+import { Timeout } from './timeout.mjs'
+
+describe('Timeout class', () => {
+  it('should reject a timeout with a negative or zero value ', async () => {
+    // Create a mock async generator that never resolves
+    const mockGenerator = (async function* () {
+      yield 1
+    })()
+
+    assert.throws(() => new Timeout(mockGenerator, 0))
+    assert.throws(() => new Timeout(mockGenerator, -10))
+  })
+  it('should resolve with the value from the source generator if it completes before the timeout', async () => {
+    // Create a mock async generator that resolves immediately
+    const mockGenerator = (async function* () {
+      yield 1
+    })()
+
+    const timeout = new Timeout(mockGenerator, 100) // 100ms timeout
+
+    const result = await timeout.next()
+    assert.strictEqual(result.value, 1)
+    assert.strictEqual(result.done, false)
+  })
+
+  it('should reject with a timeout error if the source generator takes too long', async () => {
+    // Create a mock async generator that never resolves
+    // eslint-disable-next-line require-yield
+    const mockGenerator = (async function* () {
+      await new Promise(() => {}) // Never resolves
+    })()
+
+    const timeout = new Timeout(mockGenerator, 10) // 10ms timeout
+
+    await assert.rejects(timeout.next(), 'Expected timeout error was not thrown')
+  })
+  it('should allow iteration using for-await-of', async () => {
+    // Create a mock async generator that yields values
+    const mockGenerator: AsyncGenerator<number> = (async function* () {
+      yield 1
+      yield 2
+      yield 3
+    })()
+
+    const timeout = new Timeout(mockGenerator, 100) // 100ms timeout
+
+    const results: Array<number> = []
+    for await (const value of timeout) {
+      results.push(value as number)
+    }
+
+    assert.deepStrictEqual(results, [1, 2, 3])
+  })
+
+  it('should handle the throw method correctly', async () => {
+    // Create a mock async generator with a throw method
+    const mockGenerator = (async function* () {
+      yield 1
+    })()
+
+    const timeout = new Timeout(mockGenerator, 100) // 100ms timeout
+
+    await assert.rejects(timeout.throw(new Error('Test error')), 'Expected error was not thrown')
+  })
+})

@vates/generator-toolbox/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es2023",
+    "module": "ESNext",
+    "types": ["node"], // Only use types from Node.js and packages that are explicitly imported
+    "moduleResolution": "bundler",
+    "strict": true,
+    "declaration": true, // Generates `.d.ts` files for type safety
+    "outDir": "dist" // Outputs compiled code to the `dist` directory
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

@vates/json-hash/.USAGE.md

@@ -1,4 +1,4 @@
-The use for this librariy is to create a composite key from a JSON value, ignoring objects identity and properties order.
+The use for this library is to create a composite key from a JSON value, ignoring objects identity and properties order.
 
 The hash algorithm used is intended to be fast and with low collisions and is not guaranteed to be be secure.
 

@vates/json-hash/README.md

@@ -16,7 +16,7 @@ npm install --save @vates/json-hash
 
 ## Usage
 
-The use for this librariy is to create a composite key from a JSON value, ignoring objects identity and properties order.
+The use for this library is to create a composite key from a JSON value, ignoring objects identity and properties order.
 
 The hash algorithm used is intended to be fast and with low collisions and is not guaranteed to be be secure.
 

@vates/nbd-client/NbdDisk.mjs

@@ -0,0 +1,132 @@
+import { RandomAccessDisk } from '@xen-orchestra/disk-transform'
+import NbdClient from '@vates/nbd-client'
+
+/**
+ * @typedef {{ offset: number, length: number }} DataRange
+ */
+
+/**
+ * @extends {RandomAccessDisk}
+ */
+export class NbdDisk extends RandomAccessDisk {
+  #nbdInfos
+  /** @type {NbdClient|undefined} */
+  #nbdClient
+
+  /** @type {Array<DataRange> | undefined} */
+  #dataMap
+
+  /** @type {number} */
+  #blockSize
+
+  constructor(nbdInfos, blockSize, { dataMap } = {}) {
+    super()
+    this.#blockSize = blockSize
+    this.#nbdInfos = nbdInfos
+    this.#dataMap = dataMap && this.#processDatamap(dataMap)
+  }
+
+  #processDatamap(rawDataMap) {
+    return rawDataMap
+      .filter(({ type }) => type === 0)
+      .map(({ offset, length }) => ({ offset, length }))
+      .sort(({ offset: offset1 }, { offset: offset2 }) => offset1 - offset2)
+  }
+  /**
+   * @param {number} index
+   * @returns {Promise<DiskBlock>}
+   */
+  async readBlock(index) {
+    if (!this.#nbdClient) {
+      throw new Error("can't readBlock before init")
+    }
+    let data = await this.#nbdClient.readBlock(index, this.getBlockSize())
+    if (data.length !== this.getBlockSize()) {
+      // this condition only work on non aligned disks
+      // we won't accept truncated block from unaligned disks
+      if (index === Math.ceil(this.getVirtualSize() / this.getBlockSize()) - 1) {
+        // last block add zeros at the end
+        data = Buffer.concat([data], this.getBlockSize())
+      } else {
+        throw new Error(`Block ${index} is not at the right size, expecting ${this.getBlockSize()}, got ${data.length}`)
+      }
+    }
+    return {
+      index,
+      data,
+    }
+  }
+
+  /**
+   * @returns {number}
+   */
+  getVirtualSize() {
+    if (!this.#nbdClient) {
+      throw new Error("can't get size before init")
+    }
+    return Number(this.#nbdClient.exportSize)
+  }
+
+  /**
+   * @returns {number}
+   */
+  getBlockSize() {
+    return this.#blockSize
+  }
+
+  /**
+   * @returns {Promise<void>}
+   */
+  async init() {
+    this.#nbdClient = new NbdClient(this.#nbdInfos)
+    await this.#nbdClient.connect()
+    if (this.#dataMap === undefined) {
+      this.#dataMap = this.#processDatamap(await this.#nbdClient.getMap())
+    }
+  }
+
+  /**
+   * @returns {Promise<void>}
+   */
+  async close() {
+    await this.#nbdClient?.disconnect()
+  }
+
+  /**
+   * @returns {boolean}
+   */
+  isDifferencing() {
+    return false
+  }
+
+  /**
+   * @returns {Array<number>}
+   */
+  getBlockIndexes() {
+    const indexes = new Set()
+    this.#dataMap?.forEach(({ offset, length }) => {
+      if (length === 0) return
+
+      const firstBlockIndex = Math.floor(offset / this.getBlockSize())
+      const lastBlockIndex = Math.floor((offset + length - 1) / this.getBlockSize())
+
+      for (let blockIndex = firstBlockIndex; blockIndex <= lastBlockIndex; blockIndex++) {
+        indexes.add(blockIndex)
+      }
+    })
+    return [...indexes].sort((a, b) => a - b)
+  }
+
+  /**
+   * @param {number} index
+   * @returns {boolean}
+   */
+  hasBlock(index) {
+    if (!this.#dataMap) {
+      throw new Error("can't hasBlock before init")
+    }
+    const blockStart = index * this.getBlockSize()
+    const blockEnd = (index + 1) * this.getBlockSize()
+    return this.#dataMap.some(({ offset, length }) => offset + length > blockStart && offset < blockEnd)
+  }
+}

@vates/nbd-client/constants.mjs

@@ -1,6 +1,6 @@
 export const INIT_PASSWD = Buffer.from('NBDMAGIC') // "NBDMAGIC" ensure we're connected to a nbd server
 export const OPTS_MAGIC = Buffer.from('IHAVEOPT') // "IHAVEOPT" start an option block
-export const NBD_OPT_REPLY_MAGIC = 1100100111001001n // magic received during negociation
+export const NBD_OPT_REPLY_MAGIC = 1100100111001001n // magic received during negotiation
 export const NBD_OPT_EXPORT_NAME = 1
 export const NBD_OPT_ABORT = 2
 export const NBD_OPT_LIST = 3

@vates/nbd-client/index.mjs

@@ -1,7 +1,7 @@
 import assert from 'node:assert'
 import { Socket } from 'node:net'
 import { connect } from 'node:tls'
-import { fromCallback, pRetry, pDelay, pTimeout, pFromCallback } from 'promise-toolbox'
+import { pRetry, pDelay, pTimeout, pFromCallback } from 'promise-toolbox'
 import { readChunkStrict } from '@vates/read-chunk'
 import { createLogger } from '@xen-orchestra/log'
 import {
@@ -20,6 +20,8 @@ import {
   OPTS_MAGIC,
   NBD_CMD_DISC,
 } from './constants.mjs'
+import { spawn } from 'node:child_process'
+
 const { warn } = createLogger('vates:nbd-client')
 
 // documentation is here : https://github.com/NetworkBlockDevice/nbd/blob/master/doc/proto.md
@@ -42,9 +44,9 @@ export default class NbdClient {
   // AFAIK, there is no guaranty the server answers in the same order as the queries
   // so we handle a backlog of command waiting for response and handle concurrency manually
 
-  #waitingForResponse // there is already a listenner waiting for a response
+  #waitingForResponse // there is already a listener waiting for a response
   #nextCommandQueryId = BigInt(0)
-  #commandQueryBacklog // map of command waiting for an response queryId => { size/*in byte*/, resolve, reject}
+  #commandQueryBacklog // map of command waiting for a response queryId => { size/*in byte*/, resolve, reject}
   #connected = false
 
   #reconnectingPromise
@@ -195,7 +197,7 @@ export default class NbdClient {
     }
 
     // send export name we want to access.
-    // it's  implictly closing the negociation phase.
+    // it's implicitly closing the negotiation phase.
     await this.#write(OPTS_MAGIC)
     await this.#writeInt32(NBD_OPT_EXPORT_NAME)
     const exportNameBuffer = Buffer.from(this.#exportName)
@@ -218,8 +220,22 @@ export default class NbdClient {
   }
 
   #write(buffer) {
-    const promise = fromCallback.call(this.#serverSocket, 'write', buffer)
-    return pTimeout.call(promise, this.#messageTimeout)
+    let timeout
+    const messageTimeout = this.#messageTimeout
+    const socket = this.#serverSocket
+    return Promise.race([
+      new Promise((resolve, reject) => {
+        timeout = setTimeout(() => {
+          reject(new Error('timeout'))
+        }, messageTimeout)
+      }),
+      new Promise(resolve =>
+        socket.write(buffer, () => {
+          clearTimeout(timeout)
+          resolve()
+        })
+      ),
+    ])
   }
 
   async #readInt32() {
@@ -343,4 +359,40 @@ export default class NbdClient {
       },
     })
   }
+
+  /**
+   *  returns the map of the file with holes, zeros and data, useful to handle efficiently sparse source
+   * to implement this internally: use structure response if the server supports it, and then ask for BLOCK_STATUS   *
+   *
+   * @returns {Promise<{ offset: number, length: number, type: number }[]>}
+   * A promise that resolves to an array where each object represents a segment:
+   * - `offset` — The byte offset from the start.
+   * - `length` — The size of the segment in bytes.
+   * - `type` — A numeric code indicating the segment type ( 0 means data).
+   */
+  /* async */ getMap() {
+    return new Promise((resolve, reject) => {
+      const process = spawn('nbdinfo', [
+        '--json',
+        '--map',
+        `nbd://${this.#serverAddress}:${this.#serverPort}/${encodeURIComponent(this.#exportName)}`,
+      ])
+      let text = ''
+      let errText = ''
+      process.stdout.on('data', data => (text += data))
+      process.stderr.on('data', data => (errText += data))
+      process.on('error', reject)
+      process.on('close', code => {
+        if (code !== 0) {
+          return reject(new Error(`Error during getMap (code: ${code}): ${errText}`))
+        }
+        try {
+          const json = JSON.parse(text)
+          resolve(json)
+        } catch (error) {
+          reject(new Error(`${error} ${text}`))
+        }
+      })
+    })
+  }
 }

@vates/nbd-client/multi.mjs

@@ -30,6 +30,8 @@ export default class MultiNbdClient {
    * open nbdConcurrency connections to NBD servers
    * it must obtain at least one connection to succeed
    * it tries to spread connections on multiple host
+   *
+   * @returns {Promise<void>}
    */
   async connect() {
     const candidates = [...this.#settings]
@@ -68,7 +70,9 @@ export default class MultiNbdClient {
       await _connect()
     }
     if (this.#clients.length === 0) {
-      throw new Error(`Fail to connect to any Nbd client`)
+      const error = new Error(`Fail to connect to any Nbd client`, { nbdInfos: this.#settings })
+      error.code = 'NO_NBD_AVAILABLE'
+      throw error
     }
     if (this.#clients.length < this.#nbdConcurrency) {
       warn(
@@ -77,17 +81,30 @@ export default class MultiNbdClient {
     }
   }
 
+  /**
+   * @returns {Promise<void>}
+   */
   async disconnect() {
     await asyncEach(this.#clients, client => client.disconnect(), {
       stopOnError: false,
     })
   }
 
+  /**
+   *
+   * @param {number} index
+   * @param {number} size
+   * @returns {Promise<Buffer>}
+   */
   async readBlock(index, size = NBD_DEFAULT_BLOCK_SIZE) {
     const clientId = index % this.#clients.length
     return this.#clients[clientId].readBlock(index, size)
   }
 
+  /**
+   *
+   * @param {AsyncGenerator<Buffer>} indexGenerator
+   */
   async *readBlocks(indexGenerator) {
     // default : read all blocks
     const readAhead = []
@@ -112,4 +129,17 @@ export default class MultiNbdClient {
       yield readAhead.shift()
     }
   }
+  /**
+   *  returns the map of the file with holes, zeros and data, useful to handle efficiently sparse source   *
+   *
+   * @returns {Promise<{ offset: number, length: number, type: number }[]>}
+   * A promise that resolves to an array where each object represents a segment:
+   * - `offset` — The byte offset from the start.
+   * - `length` — The size of the segment in bytes.
+   * - `type` — A numeric code indicating the segment type (0 means no data).
+   */
+  async getMap() {
+    // ask the map from one of the connected client
+    return this.#clients[Math.floor(this.#clients.length * Math.random())].getMap()
+  }
 }

@vates/nbd-client/package.json

@@ -13,18 +13,19 @@
     "url": "https://vates.fr"
   },
   "license": "ISC",
-  "version": "3.1.2",
+  "version": "3.2.3",
   "engines": {
     "node": ">=14.0"
   },
   "main": "./index.mjs",
   "dependencies": {
-    "@vates/async-each": "^1.0.0",
-    "@vates/read-chunk": "^1.2.0",
+    "@vates/async-each": "^1.0.1",
+    "@vates/read-chunk": "^1.2.1",
     "@xen-orchestra/async-map": "^0.1.2",
+    "@xen-orchestra/disk-transform": "^1.2.1",
     "@xen-orchestra/log": "^0.7.1",
     "promise-toolbox": "^0.21.0",
-    "xen-api": "^4.7.0"
+    "xen-api": "^4.7.6"
   },
   "devDependencies": {
     "tap": "^18.7.0",

@vates/node-vsphere-soap/README.md

@@ -24,7 +24,7 @@ $ npm install node-vsphere-soap --save
 
 ## Sample Code
 
-### To connect to a vCenter server:
+### To connect to a vCenter server
 
     var nvs = require('node-vsphere-soap');
     var vc = new nvs.Client(host, user, password, sslVerify);
@@ -54,7 +54,7 @@ $ npm install node-vsphere-soap --save
 - userName - username of authenticated user
 - fullName - full name of authenticated user
 
-### To run a command:
+### To run a command
 
     var vcCmd = vc.runCommand( commandToRun, arguments );
     vcCmd.once('result', function( result, raw, soapHeader) {

@vates/node-vsphere-soap/lib/client.mjs

@@ -7,7 +7,7 @@
   This file creates the Client class
 
   - when the class is instantiated, a connection will be made to the ESXi/vCenter server to verify that the creds are good
-  - upon a bad login, the connnection will be terminated
+  - upon a bad login, the connection will be terminated
 
 */
 

@vates/node-vsphere-soap/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vates/node-vsphere-soap",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "interface to vSphere SOAP/WSDL from node for interfacing with vCenter or ESXi, forked from node-vsphere-soap",
   "main": "lib/client.mjs",
   "author": "reedog117",
@@ -12,7 +12,7 @@
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "dependencies": {
     "@xen-orchestra/log": "^0.7.1",
-    "axios": "^1.4.0",
+    "axios": "^1.8.0",
     "soap": "^1.0.0",
     "soap-cookie": "^0.10.1"
   },

@vates/otp/.USAGE.md

@@ -1,6 +1,6 @@
 ### Usual workflow
 
-> This section presents how this library should be used to implement a classic two factor authentification.
+> This section presents how this library should be used to implement a classic two factor authentication.
 
 #### Setup
 

@vates/otp/README.md

@@ -18,7 +18,7 @@ npm install --save @vates/otp
 
 ### Usual workflow
 
-> This section presents how this library should be used to implement a classic two factor authentification.
+> This section presents how this library should be used to implement a classic two factor authentication.
 
 #### Setup
 

@vates/read-chunk/index.js

@@ -71,13 +71,17 @@ exports.readChunk = readChunk
  * If `size` bytes are not available to be read, the returned promise is rejected.
  *
  * @param {Readable} stream - A readable stream to read from.
- * @param {number} [size] - The number of bytes to read for binary streams (ignored for object streams).
+ * @param {number?} [size] - The number of bytes to read for binary streams (ignored for object streams).
  * @returns {Promise<Buffer|string|unknown>} - A Promise that resolves to the read chunk.
  */
 exports.readChunkStrict = async function readChunkStrict(stream, size) {
   const chunk = await readChunk(stream, size)
   if (chunk === null) {
-    throw new Error('stream has ended without data')
+    if (size === undefined) {
+      throw new Error(`stream has ended without data`)
+    } else {
+      throw new Error(`stream has ended without data, was looking for ${size} bytes`)
+    }
   }
 
   if (size !== undefined && chunk.length !== size) {

@vates/read-chunk/package.json

@@ -19,7 +19,7 @@
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
-  "version": "1.2.0",
+  "version": "1.2.1",
   "engines": {
     "node": ">=8.10"
   },

@vates/task/.USAGE.md

@@ -63,16 +63,16 @@ task.failure(error)
 Inside a task:
 
 ```js
-// the abort signal of the current task if any, otherwise is `undefined`
+// the abort signal of the current task if any; otherwise, is `undefined`
 Task.abortSignal
 
-// sends an info on the current task if any, otherwise does nothing
+// sends an info on the current task if any; otherwise, does nothing
 Task.info(message, data)
 
-// sends an info on the current task if any, otherwise does nothing
+// sends an info on the current task if any; otherwise, does nothing
 Task.warning(message, data)
 
-// attaches a property to the current task if any, otherwise does nothing
+// attaches a property to the current task if any; otherwise, does nothing
 //
 // the latest value takes precedence
 //
@@ -149,7 +149,7 @@ const onProgress = makeOnProgress({
 
   // This function is called each time a root task or a subtask is updated.
   //
-  // `taskLog.$root` can be used to uncondionally access the root task.
+  // `taskLog.$root` can be used to unconditionally access the root task.
   onTaskUpdate(taskLog) {},
 })
 

@vates/task/README.md

@@ -79,16 +79,16 @@ task.failure(error)
 Inside a task:
 
 ```js
-// the abort signal of the current task if any, otherwise is `undefined`
+// the abort signal of the current task if any; otherwise, is `undefined`
 Task.abortSignal
 
-// sends an info on the current task if any, otherwise does nothing
+// sends an info on the current task if any; otherwise, does nothing
 Task.info(message, data)
 
-// sends an info on the current task if any, otherwise does nothing
+// sends an info on the current task if any; otherwise, does nothing
 Task.warning(message, data)
 
-// attaches a property to the current task if any, otherwise does nothing
+// attaches a property to the current task if any; otherwise, does nothing
 //
 // the latest value takes precedence
 //
@@ -165,7 +165,7 @@ const onProgress = makeOnProgress({
 
   // This function is called each time a root task or a subtask is updated.
   //
-  // `taskLog.$root` can be used to uncondionally access the root task.
+  // `taskLog.$root` can be used to unconditionally access the root task.
   onTaskUpdate(taskLog) {},
 })
 

@vates/task/index.js

@@ -29,7 +29,7 @@ class Task {
   static get abortSignal() {
     const task = getTask()
     if (task !== undefined) {
-      return task.#abortController.signal
+      return task._abortController.signal
     }
   }
 
@@ -65,8 +65,11 @@ class Task {
     }
   }
 
-  #abortController = new AbortController()
-  #onProgress
+  // These two properties should not be used outside the class
+  //
+  // To ensure compatibility between multiple versions of this lib, they are kept public for now
+  _abortController = new AbortController()
+  _onProgress
 
   get id() {
     return (this.id = Math.random().toString(36).slice(2))
@@ -86,23 +89,23 @@ class Task {
     this.#startData = { properties }
 
     if (onProgress !== undefined) {
-      this.#onProgress = onProgress
+      this._onProgress = onProgress
     } else {
       const parent = getTask()
       if (parent !== undefined) {
-        const { signal } = parent.#abortController
+        const { signal } = parent._abortController
         signal.addEventListener('abort', () => {
-          this.#abortController.abort(signal.reason)
+          this._abortController.abort(signal.reason)
         })
 
-        this.#onProgress = parent.#onProgress
+        this._onProgress = parent._onProgress
         this.#startData.parentId = parent.id
       } else {
-        this.#onProgress = noop
+        this._onProgress = noop
       }
     }
 
-    const { signal } = this.#abortController
+    const { signal } = this._abortController
     signal.addEventListener('abort', () => {
       if (this.status === PENDING) {
         this.#maybeStart()
@@ -117,7 +120,7 @@ class Task {
   }
 
   abort(reason) {
-    this.#abortController.abort(reason)
+    this._abortController.abort(reason)
   }
 
   #emit(type, data) {
@@ -126,7 +129,7 @@ class Task {
     data.id = this.id
     data.timestamp = Date.now()
     data.type = type
-    this.#onProgress(data)
+    this._onProgress(data)
   }
 
   #end(status, result) {
@@ -134,7 +137,7 @@ class Task {
     assert.equal(this.#running, false)
 
     this.#emit('end', { status, result })
-    this.#onProgress = alreadyEnded
+    this._onProgress = alreadyEnded
     this.#status = status
   }
 

@vates/task/index.test.js

@@ -29,7 +29,7 @@ function createTask(opts) {
 }
 
 describe('Task', function () {
-  describe('contructor', function () {
+  describe('constructor', function () {
     it('data properties are passed to the start event', async function () {
       const properties = { foo: 0, bar: 1 }
       const task = createTask({ properties })
@@ -265,7 +265,7 @@ describe('Task', function () {
       assert.throws(() => task.set(name, value), { message: /^task has not started yet\b/ })
     })
 
-    it(`emits an property message`, async function () {
+    it(`emits a property message`, async function () {
       const task = createTask()
       await task.run(async () => {
         await Task.run(() => {
@@ -339,7 +339,7 @@ describe('Task', function () {
       Task.warning('foo')
     })
 
-    it('emits an warning message when run inside a task', async function () {
+    it('emits a warning message when run inside a task', async function () {
       const task = createTask()
       await task.run(() => {
         Task.warning('foo')

@vates/task/package.json

@@ -13,7 +13,7 @@
     "url": "https://vates.fr"
   },
   "license": "ISC",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "engines": {
     "node": ">=14"
   },

@vates/types/.npmignore

@@ -0,0 +1 @@
+../../scripts/npmignore

@vates/types/eslint.config.mjs

@@ -0,0 +1,21 @@
+// @ts-check
+
+import eslint from '@eslint/js'
+import tseslint from 'typescript-eslint'
+import { fileURLToPath } from 'node:url'
+import path from 'node:path'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+export default tseslint.config(eslint.configs.recommended, tseslint.configs.recommended, {
+  languageOptions: {
+    parserOptions: {
+      tsconfigRootDir: __dirname,
+    },
+  },
+  ignores: ['dist'],
+  rules: {
+    // Allow empty interface for recursive generic typing (E.g. interface XenApiNetworkWrapped)
+    '@typescript-eslint/no-empty-object-type': 'off',
+  },
+})

@vates/types/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@vates/types",
+  "private": false,
+  "version": "1.19.0",
+  "main": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "default": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    },
+    "./xo": "./dist/xo.d.mts",
+    "./xo-app": "./dist/xo-app.d.mts",
+    "./xen-api": "./dist/xen-api.d.mts",
+    "./common": {
+      "default": "./dist/common.mjs",
+      "types": "./dist/common.d.mts"
+    },
+    "./lib/vates/*": {
+      "default": "./dist/lib/vates-*.mjs",
+      "type": "./dist/lib/vates-*.d.mts"
+    },
+    "./lib/xen-orchestra/*": {
+      "default": "./dist/lib/xen-orchestra-*.mjs",
+      "type": "./dist/lib/xen-orchestra-*.d.mts"
+    },
+    "./lib/complex-matcher": {
+      "default": "./dist/lib/complex-matcher.mjs",
+      "type": "./dist/lib/complex-matcher.d.mts"
+    }
+  },
+  "type": "module",
+  "devDependencies": {
+    "@eslint/js": "^9.19.0",
+    "typescript": "~5.6.3",
+    "typescript-eslint": "^8.23.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish --access public"
+  },
+  "license": "AGPL-3.0-or-later",
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@vates/types",
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "repository": {
+    "directory": "@vates/types",
+    "type": "git",
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "author": {
+    "name": "Vates SAS",
+    "url": "https://vates.fr"
+  },
+  "engines": {
+    "node": ">=18.18"
+  }
+}

@vates/types/src/common.mts

@@ -0,0 +1,742 @@
+import type { XoHost } from './xo.mjs'
+
+declare const __brand: unique symbol
+
+export type Branded<TBrand extends string, TType = string> = TType & { [__brand]: TBrand }
+
+export const HOST_POWER_STATE = {
+  RUNNING: 'Running',
+  HALTED: 'Halted',
+  UNKNOWN: 'Unknown',
+} as const
+
+export type HOST_POWER_STATE = (typeof HOST_POWER_STATE)[keyof typeof HOST_POWER_STATE]
+
+export const TASK_ALLOWED_OPERATIONS = {
+  CANCEL: 'cancel',
+  DESTROY: 'destroy',
+} as const
+
+export type TASK_ALLOWED_OPERATIONS = (typeof TASK_ALLOWED_OPERATIONS)[keyof typeof TASK_ALLOWED_OPERATIONS]
+
+export const TASK_STATUS_TYPE = {
+  CANCELLED: 'cancelled',
+  CANCELLING: 'cancelling',
+  FAILURE: 'failure',
+  PENDING: 'pending',
+  SUCCESS: 'success',
+} as const
+
+export type TASK_STATUS_TYPE = (typeof TASK_STATUS_TYPE)[keyof typeof TASK_STATUS_TYPE]
+
+export const EVENT_OPERATION = {
+  ADD: 'add',
+  DEL: 'del',
+  MOD: 'mod',
+} as const
+
+export type EVENT_OPERATION = (typeof EVENT_OPERATION)[keyof typeof EVENT_OPERATION]
+
+export const POOL_ALLOWED_OPERATIONS = {
+  APPLY_UPDATES: 'apply_updates',
+  CERT_REFRESH: 'cert_refresh',
+  CLUSTER_CREATE: 'cluster_create',
+  CONFIGURE_REPOSITORIES: 'configure_repositories',
+  COPY_PRIMARY_HOST_CERTS: 'copy_primary_host_certs',
+  DESIGNATE_NEW_MASTER: 'designate_new_master',
+  EJECT: 'eject',
+  EXCHANGE_CA_CERTIFICATES_ON_JOIN: 'exchange_ca_certificates_on_join',
+  EXCHANGE_CERTIFICATES_ON_JOIN: 'exchange_certificates_on_join',
+  GET_UPDATES: 'get_updates',
+  HA_DISABLE: 'ha_disable',
+  HA_ENABLE: 'ha_enable',
+  SYNC_UPDATES: 'sync_updates',
+  TLS_VERIFICATION_ENABLE: 'tls_verification_enable',
+} as const
+
+export type POOL_ALLOWED_OPERATIONS = (typeof POOL_ALLOWED_OPERATIONS)[keyof typeof POOL_ALLOWED_OPERATIONS]
+
+export const TELEMETRY_FREQUENCY = {
+  DAILY: 'daily',
+  MONTHLY: 'monthly',
+  WEEKLY: 'weekly',
+} as const
+
+export type TELEMETRY_FREQUENCY = (typeof TELEMETRY_FREQUENCY)[keyof typeof TELEMETRY_FREQUENCY]
+
+export const UPDATE_SYNC_FREQUENCY = {
+  DAILY: 'daily',
+  WEEKLY: 'weekly',
+} as const
+
+export type UPDATE_SYNC_FREQUENCY = (typeof UPDATE_SYNC_FREQUENCY)[keyof typeof UPDATE_SYNC_FREQUENCY]
+
+export const AFTER_APPLY_GUIDANCE = {
+  RESTART_HOST: 'restartHost',
+  RESTART_HVM: 'restartHVM',
+  RESTART_PV: 'restartPV',
+  RESTART_XAPI: 'restartXAPI',
+} as const
+
+export type AFTER_APPLY_GUIDANCE = (typeof AFTER_APPLY_GUIDANCE)[keyof typeof AFTER_APPLY_GUIDANCE]
+
+export const UPDATE_AFTER_APPLY_GUIDANCE = {
+  RESTART_HOST: 'restartHost',
+  RESTART_HVM: 'restartHVM',
+  RESTART_PV: 'restartPV',
+  RESTART_XAPI: 'restartXAPI',
+} as const
+
+export type UPDATE_AFTER_APPLY_GUIDANCE = (typeof UPDATE_AFTER_APPLY_GUIDANCE)[keyof typeof UPDATE_AFTER_APPLY_GUIDANCE]
+
+export const LIVEPATCH_STATUS = {
+  OK: 'ok',
+  OK_LIVEPATCH_COMPLETE: 'ok_livepatch_complete',
+  OK_LIVEPATCH_INCOMPLETE: 'ok_livepatch_incomplete',
+} as const
+
+export type LIVEPATCH_STATUS = (typeof LIVEPATCH_STATUS)[keyof typeof LIVEPATCH_STATUS]
+
+export const VM_POWER_STATE = {
+  HALTED: 'Halted',
+  PAUSED: 'Paused',
+  RUNNING: 'Running',
+  SUSPENDED: 'Suspended',
+} as const
+
+export type VM_POWER_STATE = (typeof VM_POWER_STATE)[keyof typeof VM_POWER_STATE]
+
+export const UPDATE_GUIDANCES = {
+  REBOOT_HOST: 'reboot_host',
+  REBOOT_HOST_ON_KERNEL_LIVEPATCH_FAILURE: 'reboot_host_on_kernel_livepatch_failure',
+  REBOOT_HOST_ON_LIVEPATCH_FAILURE: 'reboot_host_on_livepatch_failure',
+  REBOOT_HOST_ON_XEN_LIVEPATCH_FAILURE: 'reboot_host_on_xen_livepatch_failure',
+  RESTART_DEVICE_MODEL: 'restart_device_model',
+  RESTART_TOOLSTACK: 'restart_toolstack',
+  RESTART_VM: 'restart_vm',
+} as const
+
+export type UPDATE_GUIDANCES = (typeof UPDATE_GUIDANCES)[keyof typeof UPDATE_GUIDANCES]
+
+export const ON_SOFTREBOOT_BEHAVIOR = {
+  DESTROY: 'destroy',
+  PRESERVE: 'preserve',
+  RESTART: 'restart',
+  SOFT_REBOOT: 'soft_reboot',
+} as const
+
+export type ON_SOFTREBOOT_BEHAVIOR = (typeof ON_SOFTREBOOT_BEHAVIOR)[keyof typeof ON_SOFTREBOOT_BEHAVIOR]
+
+export const ON_NORMAL_EXIT = {
+  DESTROY: 'destroy',
+  RESTART: 'restart',
+} as const
+
+export type ON_NORMAL_EXIT = (typeof ON_NORMAL_EXIT)[keyof typeof ON_NORMAL_EXIT]
+
+export const VM_OPERATIONS = {
+  ASSERT_OPERATION_VALID: 'assert_operation_valid',
+  AWAITING_MEMORY_LIVE: 'awaiting_memory_live',
+  CALL_PLUGIN: 'call_plugin',
+  CHANGING_DYNAMIC_RANGE: 'changing_dynamic_range',
+  CHANGING_MEMORY_LIMITS: 'changing_memory_limits',
+  CHANGING_MEMORY_LIVE: 'changing_memory_live',
+  CHANGING_NVRAM: 'changing_NVRAM',
+  CHANGING_SHADOW_MEMORY: 'changing_shadow_memory',
+  CHANGING_SHADOW_MEMORY_LIVE: 'changing_shadow_memory_live',
+  CHANGING_STATIC_RANGE: 'changing_static_range',
+  CHANGING_VCPUS: 'changing_VCPUs',
+  CHANGING_VCPUS_LIVE: 'changing_VCPUs_live',
+  CHECKPOINT: 'checkpoint',
+  CLEAN_REBOOT: 'clean_reboot',
+  CLEAN_SHUTDOWN: 'clean_shutdown',
+  CLONE: 'clone',
+  COPY: 'copy',
+  CREATE_TEMPLATE: 'create_template',
+  CREATE_VTPM: 'create_vtpm',
+  CSVM: 'csvm',
+  DATA_SOURCE_OP: 'data_source_op',
+  DESTROY: 'destroy',
+  EXPORT: 'export',
+  GET_BOOT_RECORD: 'get_boot_record',
+  HARD_REBOOT: 'hard_reboot',
+  HARD_SHUTDOWN: 'hard_shutdown',
+  IMPORT: 'import',
+  MAKE_INTO_TEMPLATE: 'make_into_template',
+  METADATA_EXPORT: 'metadata_export',
+  MIGRATE_SEND: 'migrate_send',
+  PAUSE: 'pause',
+  POOL_MIGRATE: 'pool_migrate',
+  POWER_STATE_RESET: 'power_state_reset',
+  PROVISION: 'provision',
+  QUERY_SERVICES: 'query_services',
+  RESUME: 'resume',
+  RESUME_ON: 'resume_on',
+  REVERT: 'revert',
+  REVERTING: 'reverting',
+  SEND_SYSRQ: 'send_sysrq',
+  SEND_TRIGGER: 'send_trigger',
+  SHUTDOWN: 'shutdown',
+  SNAPSHOT: 'snapshot',
+  SNAPSHOT_WITH_QUIESCE: 'snapshot_with_quiesce',
+  START: 'start',
+  START_ON: 'start_on',
+  SUSPEND: 'suspend',
+  UNPAUSE: 'unpause',
+  UPDATE_ALLOWED_OPERATIONS: 'update_allowed_operations',
+} as const
+
+export type VM_OPERATIONS = (typeof VM_OPERATIONS)[keyof typeof VM_OPERATIONS]
+
+export const ON_CRASH_BEHAVIOUR = {
+  COREDUMP_AND_DESTROY: 'coredump_and_destroy',
+  COREDUMP_AND_RESTART: 'coredump_and_restart',
+  DESTROY: 'destroy',
+  PRESERVE: 'preserve',
+  RENAME_RESTART: 'rename_restart',
+  RESTART: 'restart',
+} as const
+
+export type ON_CRASH_BEHAVIOUR = (typeof ON_CRASH_BEHAVIOUR)[keyof typeof ON_CRASH_BEHAVIOUR]
+
+export const DOMAIN_TYPE = {
+  HVM: 'hvm',
+  PV: 'pv',
+  PVH: 'pvh',
+  PV_IN_PVH: 'pv_in_pvh',
+  UNSPECIFIED: 'unspecified',
+} as const
+
+export type DOMAIN_TYPE = (typeof DOMAIN_TYPE)[keyof typeof DOMAIN_TYPE]
+
+export const TRISTATE_TYPE = {
+  NO: 'no',
+  UNSPECIFIED: 'unspecified',
+  YES: 'yes',
+} as const
+
+export type TRISTATE_TYPE = (typeof TRISTATE_TYPE)[keyof typeof TRISTATE_TYPE]
+
+export const VMPP_BACKUP_TYPE = {
+  CHECKPOINT: 'checkpoint',
+  SNAPSHOT: 'snapshot',
+} as const
+
+export type VMPP_BACKUP_TYPE = (typeof VMPP_BACKUP_TYPE)[keyof typeof VMPP_BACKUP_TYPE]
+
+export const VMPP_BACKUP_FREQUENCY = {
+  DAILY: 'daily',
+  HOURLY: 'hourly',
+  WEEKLY: 'weekly',
+} as const
+
+export type VMPP_BACKUP_FREQUENCY = (typeof VMPP_BACKUP_FREQUENCY)[keyof typeof VMPP_BACKUP_FREQUENCY]
+
+export const VMPP_ARCHIVE_FREQUENCY = {
+  ALWAYS_AFTER_BACKUP: 'always_after_backup',
+  DAILY: 'daily',
+  NEVER: 'never',
+  WEEKLY: 'weekly',
+} as const
+
+export type VMPP_ARCHIVE_FREQUENCY = (typeof VMPP_ARCHIVE_FREQUENCY)[keyof typeof VMPP_ARCHIVE_FREQUENCY]
+
+export const VMPP_ARCHIVE_TARGET_TYPE = {
+  CIFS: 'cifs',
+  NFS: 'nfs',
+  NONE: 'none',
+} as const
+
+export type VMPP_ARCHIVE_TARGET_TYPE = (typeof VMPP_ARCHIVE_TARGET_TYPE)[keyof typeof VMPP_ARCHIVE_TARGET_TYPE]
+
+export const VMSS_FREQUENCY = {
+  DAILY: 'daily',
+  HOURLY: 'hourly',
+  WEEKLY: 'weekly',
+} as const
+
+export type VMSS_FREQUENCY = (typeof VMSS_FREQUENCY)[keyof typeof VMSS_FREQUENCY]
+
+export const VMSS_TYPE = {
+  CHECKPOINT: 'checkpoint',
+  SNAPSHOT: 'snapshot',
+  SNAPSHOT_WITH_QUIESCE: 'snapshot_with_quiesce',
+} as const
+
+export type VMSS_TYPE = (typeof VMSS_TYPE)[keyof typeof VMSS_TYPE]
+
+export const VM_APPLIANCE_OPERATION = {
+  CLEAN_SHUTDOWN: 'clean_shutdown',
+  HARD_SHUTDOWN: 'hard_shutdown',
+  SHUTDOWN: 'shutdown',
+  START: 'start',
+} as const
+
+export type VM_APPLIANCE_OPERATION = (typeof VM_APPLIANCE_OPERATION)[keyof typeof VM_APPLIANCE_OPERATION]
+
+export const HOST_ALLOWED_OPERATIONS = {
+  APPLY_UPDATES: 'apply_updates',
+  ENABLE: 'enable',
+  EVACUATE: 'evacuate',
+  POWER_ON: 'power_on',
+  PROVISION: 'provision',
+  REBOOT: 'reboot',
+  SHUTDOWN: 'shutdown',
+  VM_MIGRATE: 'vm_migrate',
+  VM_RESUME: 'vm_resume',
+  VM_START: 'vm_start',
+} as const
+
+export type HOST_ALLOWED_OPERATIONS = (typeof HOST_ALLOWED_OPERATIONS)[keyof typeof HOST_ALLOWED_OPERATIONS]
+
+export const LATEST_SYNCED_UPDATES_APPLIED_STATE = {
+  NO: 'no',
+  UNKNOWN: 'unknown',
+  YES: 'yes',
+} as const
+
+export type LATEST_SYNCED_UPDATES_APPLIED_STATE =
+  (typeof LATEST_SYNCED_UPDATES_APPLIED_STATE)[keyof typeof LATEST_SYNCED_UPDATES_APPLIED_STATE]
+
+export const HOST_DISPLAY = {
+  DISABLED: 'disabled',
+  DISABLE_ON_REBOOT: 'disable_on_reboot',
+  ENABLED: 'enabled',
+  ENABLE_ON_REBOOT: 'enable_on_reboot',
+} as const
+
+export type HOST_DISPLAY = (typeof HOST_DISPLAY)[keyof typeof HOST_DISPLAY]
+
+export const HOST_SCHED_GRAN = {
+  CORE: 'core',
+  CPU: 'cpu',
+  SOCKET: 'socket',
+} as const
+
+export type HOST_SCHED_GRAN = (typeof HOST_SCHED_GRAN)[keyof typeof HOST_SCHED_GRAN]
+
+export const HOST_NUMA_AFFINITY_POLICY = {
+  ANY: 'any',
+  BEST_EFFORT: 'best_effort',
+  DEFAULT_POLICY: 'default_policy',
+} as const
+
+export type HOST_NUMA_AFFINITY_POLICY = (typeof HOST_NUMA_AFFINITY_POLICY)[keyof typeof HOST_NUMA_AFFINITY_POLICY]
+
+export const NETWORK_OPERATIONS = {
+  ATTACHING: 'attaching',
+} as const
+
+export type NETWORK_OPERATIONS = (typeof NETWORK_OPERATIONS)[keyof typeof NETWORK_OPERATIONS]
+
+export const NETWORK_DEFAULT_LOCKING_MODE = {
+  DISABLED: 'disabled',
+  UNLOCKED: 'unlocked',
+} as const
+
+export type NETWORK_DEFAULT_LOCKING_MODE =
+  (typeof NETWORK_DEFAULT_LOCKING_MODE)[keyof typeof NETWORK_DEFAULT_LOCKING_MODE]
+
+export const NETWORK_PURPOSE = {
+  INSECURE_NBD: 'insecure_nbd',
+  NBD: 'nbd',
+} as const
+
+export type NETWORK_PURPOSE = (typeof NETWORK_PURPOSE)[keyof typeof NETWORK_PURPOSE]
+
+export const VIF_OPERATIONS = {
+  ATTACH: 'attach',
+  PLUG: 'plug',
+  UNPLUG: 'unplug',
+} as const
+
+export type VIF_OPERATIONS = (typeof VIF_OPERATIONS)[keyof typeof VIF_OPERATIONS]
+
+export const VIF_LOCKING_MODE = {
+  DISABLED: 'disabled',
+  LOCKED: 'locked',
+  NETWORK_DEFAULT: 'network_default',
+  UNLOCKED: 'unlocked',
+} as const
+
+export type VIF_LOCKING_MODE = (typeof VIF_LOCKING_MODE)[keyof typeof VIF_LOCKING_MODE]
+
+export const VIF_IPV4_CONFIGURATION_MODE = {
+  NONE: 'None',
+  STATIC: 'Static',
+} as const
+
+export type VIF_IPV4_CONFIGURATION_MODE = (typeof VIF_IPV4_CONFIGURATION_MODE)[keyof typeof VIF_IPV4_CONFIGURATION_MODE]
+
+export const VIF_IPV6_CONFIGURATION_MODE = {
+  NONE: 'None',
+  STATIC: 'Static',
+} as const
+
+export type VIF_IPV6_CONFIGURATION_MODE = (typeof VIF_IPV6_CONFIGURATION_MODE)[keyof typeof VIF_IPV6_CONFIGURATION_MODE]
+
+export const PIF_IGMP_STATUS = {
+  DISABLED: 'disabled',
+  ENABLED: 'enabled',
+  UNKNOWN: 'unknown',
+} as const
+
+export type PIF_IGMP_STATUS = (typeof PIF_IGMP_STATUS)[keyof typeof PIF_IGMP_STATUS]
+
+export const IP_CONFIGURATION_MODE = {
+  DHCP: 'DHCP',
+  NONE: 'None',
+  STATIC: 'Static',
+} as const
+
+export type IP_CONFIGURATION_MODE = (typeof IP_CONFIGURATION_MODE)[keyof typeof IP_CONFIGURATION_MODE]
+
+export const IPV6_CONFIGURATION_MODE = {
+  AUTOCONF: 'Autoconf',
+  DHCP: 'DHCP',
+  NONE: 'None',
+  STATIC: 'Static',
+} as const
+
+export type IPV6_CONFIGURATION_MODE = (typeof IPV6_CONFIGURATION_MODE)[keyof typeof IPV6_CONFIGURATION_MODE]
+
+export const PRIMARY_ADDRESS_TYPE = {
+  IPV4: 'IPv4',
+  IPV6: 'IPv6',
+} as const
+
+export type PRIMARY_ADDRESS_TYPE = (typeof PRIMARY_ADDRESS_TYPE)[keyof typeof PRIMARY_ADDRESS_TYPE]
+
+export const BOND_MODE = {
+  ACTIVE_BACKUP: 'active-backup',
+  BALANCE_SLB: 'balance-slb',
+  LACP: 'lacp',
+} as const
+
+export type BOND_MODE = (typeof BOND_MODE)[keyof typeof BOND_MODE]
+
+export const STORAGE_OPERATIONS = {
+  DESTROY: 'destroy',
+  FORGET: 'forget',
+  PBD_CREATE: 'pbd_create',
+  PBD_DESTROY: 'pbd_destroy',
+  PLUG: 'plug',
+  SCAN: 'scan',
+  UNPLUG: 'unplug',
+  UPDATE: 'update',
+  VDI_CLONE: 'vdi_clone',
+  VDI_CREATE: 'vdi_create',
+  VDI_DATA_DESTROY: 'vdi_data_destroy',
+  VDI_DESTROY: 'vdi_destroy',
+  VDI_DISABLE_CBT: 'vdi_disable_cbt',
+  VDI_ENABLE_CBT: 'vdi_enable_cbt',
+  VDI_INTRODUCE: 'vdi_introduce',
+  VDI_LIST_CHANGED_BLOCKS: 'vdi_list_changed_blocks',
+  VDI_MIRROR: 'vdi_mirror',
+  VDI_RESIZE: 'vdi_resize',
+  VDI_SET_ON_BOOT: 'vdi_set_on_boot',
+  VDI_SNAPSHOT: 'vdi_snapshot',
+} as const
+
+export type STORAGE_OPERATIONS = (typeof STORAGE_OPERATIONS)[keyof typeof STORAGE_OPERATIONS]
+
+export const SR_HEALTH = {
+  HEALTHY: 'healthy',
+  RECOVERING: 'recovering',
+} as const
+
+export type SR_HEALTH = (typeof SR_HEALTH)[keyof typeof SR_HEALTH]
+
+export const VDI_OPERATIONS = {
+  BLOCKED: 'blocked',
+  CLONE: 'clone',
+  COPY: 'copy',
+  DATA_DESTROY: 'data_destroy',
+  DESTROY: 'destroy',
+  DISABLE_CBT: 'disable_cbt',
+  ENABLE_CBT: 'enable_cbt',
+  FORCE_UNLOCK: 'force_unlock',
+  FORGET: 'forget',
+  GENERATE_CONFIG: 'generate_config',
+  LIST_CHANGED_BLOCKS: 'list_changed_blocks',
+  MIRROR: 'mirror',
+  RESIZE: 'resize',
+  RESIZE_ONLINE: 'resize_online',
+  SET_ON_BOOT: 'set_on_boot',
+  SNAPSHOT: 'snapshot',
+  UPDATE: 'update',
+} as const
+
+export type VDI_OPERATIONS = (typeof VDI_OPERATIONS)[keyof typeof VDI_OPERATIONS]
+
+export const VDI_TYPE = {
+  CBT_METADATA: 'cbt_metadata',
+  CRASHDUMP: 'crashdump',
+  EPHEMERAL: 'ephemeral',
+  HA_STATEFILE: 'ha_statefile',
+  METADATA: 'metadata',
+  PVS_CACHE: 'pvs_cache',
+  REDO_LOG: 'redo_log',
+  RRD: 'rrd',
+  SUSPEND: 'suspend',
+  SYSTEM: 'system',
+  USER: 'user',
+} as const
+
+export type VDI_TYPE = (typeof VDI_TYPE)[keyof typeof VDI_TYPE]
+
+export const ON_BOOT = {
+  PERSIST: 'persist',
+  RESET: 'reset',
+} as const
+
+export type ON_BOOT = (typeof ON_BOOT)[keyof typeof ON_BOOT]
+
+export const VBD_OPERATIONS = {
+  ATTACH: 'attach',
+  EJECT: 'eject',
+  INSERT: 'insert',
+  PAUSE: 'pause',
+  PLUG: 'plug',
+  UNPAUSE: 'unpause',
+  UNPLUG: 'unplug',
+  UNPLUG_FORCE: 'unplug_force',
+} as const
+
+export type VBD_OPERATIONS = (typeof VBD_OPERATIONS)[keyof typeof VBD_OPERATIONS]
+
+export const VBD_TYPE = {
+  CD: 'CD',
+  DISK: 'Disk',
+  FLOPPY: 'Floppy',
+} as const
+
+export type VBD_TYPE = (typeof VBD_TYPE)[keyof typeof VBD_TYPE]
+
+export const VBD_MODE = {
+  RO: 'RO',
+  RW: 'RW',
+} as const
+
+export type VBD_MODE = (typeof VBD_MODE)[keyof typeof VBD_MODE]
+
+export const VTPM_OPERATIONS = {
+  DESTROY: 'destroy',
+} as const
+
+export type VTPM_OPERATIONS = (typeof VTPM_OPERATIONS)[keyof typeof VTPM_OPERATIONS]
+
+export const PERSISTENCE_BACKEND = {
+  XAPI: 'xapi',
+} as const
+
+export type PERSISTENCE_BACKEND = (typeof PERSISTENCE_BACKEND)[keyof typeof PERSISTENCE_BACKEND]
+
+export const CONSOLE_PROTOCOL = {
+  RDP: 'rdp',
+  RFB: 'rfb',
+  VT100: 'vt100',
+} as const
+
+export type CONSOLE_PROTOCOL = (typeof CONSOLE_PROTOCOL)[keyof typeof CONSOLE_PROTOCOL]
+
+export const CLS = {
+  CERTIFICATE: 'Certificate',
+  HOST: 'Host',
+  POOL: 'Pool',
+  PVS_PROXY: 'PVS_proxy',
+  SR: 'SR',
+  VDI: 'VDI',
+  VM: 'VM',
+  VMPP: 'VMPP',
+  VMSS: 'VMSS',
+} as const
+
+export type CLS = (typeof CLS)[keyof typeof CLS]
+
+export const TUNNEL_PROTOCOL = {
+  GRE: 'gre',
+  VXLAN: 'vxlan',
+} as const
+
+export type TUNNEL_PROTOCOL = (typeof TUNNEL_PROTOCOL)[keyof typeof TUNNEL_PROTOCOL]
+
+export const SRIOV_CONFIGURATION_MODE = {
+  MANUAL: 'manual',
+  MODPROBE: 'modprobe',
+  SYSFS: 'sysfs',
+  UNKNOWN: 'unknown',
+} as const
+
+export type SRIOV_CONFIGURATION_MODE = (typeof SRIOV_CONFIGURATION_MODE)[keyof typeof SRIOV_CONFIGURATION_MODE]
+
+export const PGPU_DOM0_ACCESS = {
+  DISABLED: 'disabled',
+  DISABLE_ON_REBOOT: 'disable_on_reboot',
+  ENABLED: 'enabled',
+  ENABLE_ON_REBOOT: 'enable_on_reboot',
+} as const
+
+export type PGPU_DOM0_ACCESS = (typeof PGPU_DOM0_ACCESS)[keyof typeof PGPU_DOM0_ACCESS]
+
+export const ALLOCATION_ALGORITHM = {
+  BREADTH_FIRST: 'breadth_first',
+  DEPTH_FIRST: 'depth_first',
+} as const
+
+export type ALLOCATION_ALGORITHM = (typeof ALLOCATION_ALGORITHM)[keyof typeof ALLOCATION_ALGORITHM]
+
+export const VGPU_TYPE_IMPLEMENTATION = {
+  GVT_G: 'gvt_g',
+  MXGPU: 'mxgpu',
+  NVIDIA: 'nvidia',
+  NVIDIA_SRIOV: 'nvidia_sriov',
+  PASSTHROUGH: 'passthrough',
+} as const
+
+export type VGPU_TYPE_IMPLEMENTATION = (typeof VGPU_TYPE_IMPLEMENTATION)[keyof typeof VGPU_TYPE_IMPLEMENTATION]
+
+export const PVS_PROXY_STATUS = {
+  CACHING: 'caching',
+  INCOMPATIBLE_PROTOCOL_VERSION: 'incompatible_protocol_version',
+  INCOMPATIBLE_WRITE_CACHE_MODE: 'incompatible_write_cache_mode',
+  INITIALISED: 'initialised',
+  STOPPED: 'stopped',
+} as const
+
+export type PVS_PROXY_STATUS = (typeof PVS_PROXY_STATUS)[keyof typeof PVS_PROXY_STATUS]
+
+export const SDN_CONTROLLER_PROTOCOL = {
+  PSSL: 'pssl',
+  SSL: 'ssl',
+} as const
+
+export type SDN_CONTROLLER_PROTOCOL = (typeof SDN_CONTROLLER_PROTOCOL)[keyof typeof SDN_CONTROLLER_PROTOCOL]
+
+export const VUSB_OPERATIONS = {
+  ATTACH: 'attach',
+  PLUG: 'plug',
+  UNPLUG: 'unplug',
+} as const
+
+export type VUSB_OPERATIONS = (typeof VUSB_OPERATIONS)[keyof typeof VUSB_OPERATIONS]
+
+export const CLUSTER_OPERATION = {
+  ADD: 'add',
+  DESTROY: 'destroy',
+  DISABLE: 'disable',
+  ENABLE: 'enable',
+  REMOVE: 'remove',
+} as const
+
+export type CLUSTER_OPERATION = (typeof CLUSTER_OPERATION)[keyof typeof CLUSTER_OPERATION]
+
+export const CLUSTER_HOST_OPERATION = {
+  DESTROY: 'destroy',
+  DISABLE: 'disable',
+  ENABLE: 'enable',
+} as const
+
+export type CLUSTER_HOST_OPERATION = (typeof CLUSTER_HOST_OPERATION)[keyof typeof CLUSTER_HOST_OPERATION]
+
+export const CERTIFICATE_TYPE = {
+  CA: 'ca',
+  HOST: 'host',
+  HOST_INTERNAL: 'host_internal',
+} as const
+
+export type CERTIFICATE_TYPE = (typeof CERTIFICATE_TYPE)[keyof typeof CERTIFICATE_TYPE]
+
+export const OPAQUE_REF = { EMPTY: 'OpaqueRef:NULL' } as const
+
+export type OPAQUE_REF_NULL = (typeof OPAQUE_REF)['EMPTY']
+
+export const BACKUP_TYPE = { backup: 'backup', metadata: 'metadataBackup', mirror: 'mirrorBackup' } as const
+
+export type BACKUP_TYPE = (typeof BACKUP_TYPE)[keyof typeof BACKUP_TYPE]
+
+export const SUPPORTED_VDI_FORMAT = {
+  raw: 'raw',
+  vhd: 'vhd',
+  qcow2: 'qcow2',
+} as const
+
+export type SUPPORTED_VDI_FORMAT = (typeof SUPPORTED_VDI_FORMAT)[keyof typeof SUPPORTED_VDI_FORMAT]
+
+// ----- XAPI Stats
+
+type XapiStatsResponse<T> = {
+  endTimestamp: number
+  interval: number
+  stats: T
+}
+type StatValues = (number | null)[]
+type RecordStatValues = Record<string, StatValues>
+
+export type XapiStatsGranularity = 'seconds' | 'minutes' | 'hours' | 'days'
+
+export type XapiHostStatsRaw = {
+  cpus?: RecordStatValues
+  ioThroughput?: {
+    r: RecordStatValues
+    w: RecordStatValues
+  }
+  iops?: {
+    r: RecordStatValues
+    w: RecordStatValues
+  }
+  iowait?: RecordStatValues
+  latency?: {
+    r: RecordStatValues
+    w: RecordStatValues
+  }
+  load?: StatValues
+  memory?: StatValues
+  memoryFree?: StatValues
+  pifs?: {
+    rx: RecordStatValues
+    tx: RecordStatValues
+  }
+}
+export type XapiHostStats = XapiStatsResponse<XapiHostStatsRaw>
+
+export type XapiVmStatsRaw = {
+  cpus?: RecordStatValues
+  cpuUsage?: StatValues
+  runstateFullrun?: StatValues
+  runstateFullContention?: StatValues
+  runstatePartialRun?: StatValues
+  runstatePartialContention?: StatValues
+  runstateConcurrencyHazard?: StatValues
+  runstateBlocked?: StatValues
+  iops?: {
+    r: RecordStatValues
+    w: RecordStatValues
+  }
+  memory?: StatValues
+  memoryFree?: StatValues
+  memoryTarget?: StatValues
+  vifs?: {
+    rx: RecordStatValues
+    tx: RecordStatValues
+  }
+  vifErrors?: {
+    rx: RecordStatValues
+    tx: RecordStatValues
+  }
+  xvds?: {
+    w?: RecordStatValues
+    r?: RecordStatValues
+    total?: RecordStatValues
+  }
+  vbdLatency?: {
+    w: RecordStatValues
+    r: RecordStatValues
+  }
+  vbdIowait?: RecordStatValues
+  vbdInflight?: RecordStatValues
+  vbdAvgquSz?: RecordStatValues
+}
+export type XapiVmStats = XapiStatsResponse<XapiVmStatsRaw>
+
+export type XapiPoolStats = Record<XoHost['id'], XapiHostStats | { error: Record<string, unknown> }>

@vates/types/src/index.mts

@@ -0,0 +1,6 @@
+export * from './common.mjs'
+export * from './xen-api.mjs'
+export * from './xo.mjs'
+export * from './xo-app.mjs'
+export * from './lib/xen-orchestra-xapi.mjs'
+export * from './lib/complex-matcher.mjs'

@vates/types/src/lib/complex-matcher.mts

@@ -0,0 +1,5 @@
+export type Or<T> = Id<{ __or: T[] }>
+
+export type Id<T> = { id: T }
+
+export type IdOr<T> = Id<T> | Or<T>

@vates/types/src/lib/vates-task.mts

@@ -0,0 +1,21 @@
+import { Branded } from '../common.mjs'
+
+export interface VatesTask {
+  _abortController: AbortController
+  _onProgress(data?: unknown): void
+
+  id: Branded<'vates-task'>
+  status: 'failure' | 'pending' | 'success'
+
+  abort(reason?: unknown): void
+  failure(error?: unknown): void
+  info(message: string, data: unknown): void
+  run<T>(fn: () => T | (() => Promise<T>)): Promise<T>
+  runInside<T>(fn: () => T | (() => Promise<T>)): Promise<T>
+  set(name: string, value: unknown): void
+  start(): void
+  success(result?: unknown): void
+  warning(message: string, data: unknown): void
+  wrap<T>(fn: () => T | (() => Promise<T>)): Promise<T>
+  wrapInside<T>(fn: () => T | (() => Promise<T>)): Promise<T>
+}

@vates/types/src/lib/xen-orchestra-xapi.mts

@@ -0,0 +1,270 @@
+import {
+  WrappedXenApiRecord,
+  XenApiHost,
+  XenApiNetwork,
+  XenApiNetworkWrapped,
+  XenApiRecord,
+  XenApiSr,
+  XenApiTask,
+  XenApiVbd,
+  XenApiVdi,
+  XenApiVif,
+  XenApiVm,
+  XenApiVmWrapped,
+  XenApiVtpm,
+} from '../xen-api.mjs'
+import type { OPAQUE_REF_NULL, SUPPORTED_VDI_FORMAT, VBD_MODE, VBD_TYPE, VIF_LOCKING_MODE } from '../common.mjs'
+import type { PassThrough, Readable } from 'node:stream'
+import type {
+  XoGpuGroup,
+  XoHost,
+  XoNetwork,
+  XoPif,
+  XoSr,
+  XoUser,
+  XoVdi,
+  XoVgpuType,
+  XoVm,
+  XoVmTemplate,
+  XoVif,
+} from '../xo.mjs'
+
+export type XcpPatches = {
+  changelog?: {
+    author: string
+    date: number
+    description: string
+  }
+  description: string
+  license: string
+  name: string
+  release: string
+  size: number
+  url: string
+  version: string
+}
+export type XsPatches = {
+  conflicts?: string[]
+  date: string
+  description: string
+  documentationUrl?: string
+  guidances: string
+  name: string
+  id?: string
+  paid?: boolean
+  requirements?: string[]
+  upgrade?: boolean
+  url?: string
+  uuid?: string
+}
+
+export interface Xapi {
+  call: <ReturnType>(...args: unknown[]) => Promise<ReturnType>
+  callAsync: <ReturnType>(...args: unknown[]) => Promise<ReturnType>
+
+  barrier<T extends XenApiRecord>(ref: T['$ref']): Promise<Extract<WrappedXenApiRecord, { $ref: T['$ref'] }>>
+  getField<T extends XenApiRecord, K extends keyof T>(
+    type: Extract<WrappedXenApiRecord, T>['$type'],
+    ref: T['$ref'],
+    field: K
+  ): Promise<T[K]>
+  createNetwork(
+    params:
+      | {
+          name: string
+          description?: string
+          mtu?: number
+        }
+      | {
+          name: string
+          description?: string
+          pifId: XoPif['id']
+          mtu?: number
+          /* between 0 and 4094 */
+          vlan: number
+        }
+  ): Promise<XenApiNetworkWrapped>
+  deleteNetwork(id: XoNetwork['id']): Promise<void>
+  deleteVif(vifId: XoVif['id']): Promise<void>
+  exportVmOva(vmRef: XenApiVm['$ref']): Promise<PassThrough>
+  migrateVm(
+    vmId: XoVm['id'],
+    hostXapi: Xapi,
+    hostId: XoHost['id'],
+    opts?: {
+      force?: boolean
+      mapVdisSrs?: Record<XoVdi['id'], XoSr['id']>
+      mapVifsNetworks?: Record<XoVif['id'], XoNetwork['id']>
+      migrationNetworkId?: XoNetwork['id']
+      sr?: XoSr['id']
+      bypassAssert?: boolean
+    }
+  ): Promise<void>
+  listMissingPatches(host: XoHost['id']): Promise<XcpPatches[] | XsPatches[]>
+  pool_emergencyShutdown(): Promise<void>
+  resumeVm(id: XoVm['id']): Promise<void>
+  unpauseVm(id: XoVm['id']): Promise<void>
+  SR_importVdi(
+    ref: XenApiSr['$ref'],
+    stream: Readable,
+    opts?: {
+      format?: SUPPORTED_VDI_FORMAT
+      name_description?: XoVdi['name_description']
+      name_label?: XoVdi['name_label']
+      other_config?: XoVdi['other_config']
+      read_only?: boolean
+      sharable?: boolean
+      SR?: XenApiSr['$ref']
+      tags?: XoVdi['tags']
+      type?: XoVdi['type']
+      virtual_size?: XoVdi['size']
+      xenstore_data?: Record<string, string>
+    }
+  ): Promise<XenApiVdi['$ref']>
+  startVm(
+    id: XoVm['id'],
+    opts?: {
+      bypassMacAddressesCheck?: boolean
+      force?: boolean
+      hostId?: XoHost['id']
+      /**
+       * if startOnly is true and the VM is not halted, throw VM_BAD_POWER_STATE
+       * otherwise, unpause/resume the VM
+       *
+       * @default false
+       */
+      startOnly?: boolean
+    }
+  ): Promise<void>
+  VM_export(
+    vmRef: XenApiVm['$ref'],
+    opts?: { cancelToken?: unknown; compress?: boolean; useSnapshot?: boolean }
+  ): ReturnType<Xapi['getResource']>
+  VM_import(
+    stream: Readable,
+    srRef?: XenApiSr['$ref'],
+    onVmCreation?: null | ((vm: XenApiVm) => unknown)
+  ): Promise<XenApiVm['$ref']>
+  createVm(
+    templateUuid: XoVmTemplate['uuid'],
+    metadataVm: {
+      affinityHost?: XoHost['id']
+      autoPoweron?: boolean
+      memory?: number
+      name_description?: string
+      name_label: string
+      nameLabel?: string
+      clone?: boolean
+      installRepository?: XoVdi['id'] | '' | null
+      vdis?: (
+        | /** Create VDI */ {
+            name_label: string
+            size: number
+            sr?: XoSr['id']
+            name_description?: string
+          }
+        | /** Update VDI*/ {
+            userdevice: string
+            name_label?: string
+            size?: number
+            sr?: XoSr['id']
+            name_description?: string
+          }
+        | /** Destroy VDI*/ { destroy: true; userdevice: string }
+      )[]
+      vifs?: (
+        | /** Create/update VIF */ {
+            device?: string
+            ipv4_allowed?: string[]
+            ipv6_allowed?: string[]
+            mac?: string
+            mtu?: number
+            network: string
+          }
+        | /** Destroy VIF */ { destroy: true; device: string }
+      )[]
+      existingVdis?: {
+        $SR: XoSr['id']
+        size: number
+        userdevice: string
+      }[]
+      vgpuType?: XoVgpuType['id']
+      gpuGroup?: XoGpuGroup['id']
+      copyHostBiosStrings?: boolean
+      hvmBootFirmware?: 'uefi' | 'bios'
+      secureBoot?: boolean
+    },
+    checkLimits?: boolean,
+    creatorId?: XoUser['id'],
+    opts?: { destroyAllVifs: boolean }
+  ): Promise<XenApiVmWrapped>
+  moveVdi(
+    vdiId: XenApiVdi['$ref'] | XoVdi['id'],
+    srId: XenApiSr['$ref'] | XoSr['id'],
+    opts?: { _failOnCbtError?: boolean }
+  ): Promise<XenApiVdi>
+  VBD_create(params: {
+    bootable?: boolean
+    empty?: boolean
+    mode?: VBD_MODE
+    other_config?: Record<string, string>
+    qos_algorithm_params?: Record<string, string>
+    qos_algorithm_type?: string
+    type?: VBD_TYPE
+    unpluggable?: boolean
+    userdevice?: string
+    VDI: XenApiVdi['$ref'] | OPAQUE_REF_NULL
+    VM: XenApiVm['$ref']
+  }): Promise<XenApiVbd['$ref']>
+  VBD_destroy(vbdRef: XenApiVbd['$ref']): Promise<void>
+  VBD_unplug(vbdRef: XenApiVbd['$ref']): Promise<void>
+  VDI_destroy(vdiRef: XenApiVdi['$ref']): Promise<void>
+  VDI_destroyCloudInitConfig(vdiRef: XenApiVdi['$ref'], opts?: { timeLimit?: number }): Promise<void>
+  VDI_exportContent(
+    vdiRef: XenApiVdi['$ref'],
+    opts: { baseRef?: string; cancelToken?: unknown; format: SUPPORTED_VDI_FORMAT }
+  ): Promise<Readable & { length?: number }>
+  VDI_importContent(
+    vdiRef: XenApiVdi['$ref'],
+    stream: Readable,
+    opts: { cancelToken?: unknown; format: SUPPORTED_VDI_FORMAT }
+  ): Promise<void>
+  VIF_create(
+    options: {
+      currently_attached?: boolean
+      device?: string
+      ipv4_allowed?: string[]
+      ipv6_allowed?: string[]
+      locking_mode?: VIF_LOCKING_MODE
+      MTU?: number
+      network: XenApiNetwork['$ref']
+      other_config?: Record<string, string>
+      qos_algorithm_params?: Record<string, string>
+      qos_algorithm_type?: string
+      VM: XenApiVm['$ref']
+    },
+    extraOptions?: {
+      MAC?: string
+    }
+  ): Promise<XenApiVif['$ref']>
+  VM_createCloudInitConfig(
+    vmRef: XenApiVm['$ref'],
+    cloudConfig: string,
+    opts?: { networkConfig?: string }
+  ): Promise<XoVdi['uuid']>
+  VM_destroy(
+    vmRef: XenApiVm['$ref'],
+    opts?: {
+      deleteDisks?: boolean
+      force?: boolean
+      bypassBlockedOperation?: boolean
+      forceDeleteDefaultTemplate?: boolean
+    }
+  ): Promise<void>
+  getResource(
+    pathname: string,
+    params?: { host?: XenApiHost; query?: Record<string, unknown>; task?: boolean | XenApiTask['$ref'] }
+  ): Promise<{ body: Readable }>
+  isHyperThreadingEnabled(hostId: XoHost['id']): Promise<boolean | null>
+  VTPM_create(params: { VM: XenApiVm['$ref']; is_unique?: boolean; contents?: string }): Promise<XenApiVtpm['$ref']>
+}

@vates/types/src/xo-app.mts

@@ -0,0 +1,257 @@
+import { EventEmitter } from 'node:stream'
+import type {
+  AnyXoBackupJob,
+  AnyXoJob,
+  AnyXoLog,
+  XapiXoRecord,
+  XoAuthenticationToken,
+  XoBackupRepository,
+  XoConfigBackupArchive,
+  XoGroup,
+  XoHost,
+  XoPool,
+  XoPoolBackupArchive,
+  XoProxy,
+  XoSchedule,
+  XoServer,
+  XoTask,
+  XoUser,
+  XoVm,
+  XoVmBackupArchive,
+} from './xo.mjs'
+import { VatesTask } from './lib/vates-task.mjs'
+import {
+  Xapi,
+  XapiHostStats,
+  XapiPoolStats,
+  XapiStatsGranularity,
+  XapiVmStats,
+  XenApiGpuGroupWrapped,
+  XenApiHostWrapped,
+  XenApiMessageWrapped,
+  XenApiNetworkWrapped,
+  XenApiPbdWrapped,
+  XenApiPciWrapped,
+  XenApiPgpuWrapped,
+  XenApiPifWrapped,
+  XenApiPoolWrapped,
+  XenApiSmWrapped,
+  XenApiSrWrapped,
+  XenApiVbdWrapped,
+  XenApiVdiWrapped,
+  XenApiVgpuTypeWrapped,
+  XenApiVgpuWrapped,
+  XenApiVifWrapped,
+  XenApiVmWrapped,
+  XenApiVtpmWrapped,
+} from './index.mjs'
+
+export type XapiConnection = Xapi & {
+  status: string
+  pool?: { uuid: string }
+  sessionId: string
+  _url?: { protocol: string; hostname: string; port?: string }
+}
+
+type XapiRecordByXapiXoRecord = {
+  gpuGroup: XenApiGpuGroupWrapped
+  host: XenApiHostWrapped
+  message: XenApiMessageWrapped
+  network: XenApiNetworkWrapped
+  PBD: XenApiPbdWrapped
+  PCI: XenApiPciWrapped
+  PGPU: XenApiPgpuWrapped
+  PIF: XenApiPifWrapped
+  pool: XenApiPoolWrapped
+  SR: XenApiSrWrapped
+  SM: XenApiSmWrapped
+  VBD: XenApiVbdWrapped
+  VDI: XenApiVdiWrapped
+  'VDI-snapshot': XenApiVdiWrapped
+  'VDI-unmanaged': XenApiVdiWrapped
+  vgpu: XenApiVgpuWrapped
+  vgpuType: XenApiVgpuTypeWrapped
+  VIF: XenApiVifWrapped
+  VM: XenApiVmWrapped
+  'VM-controller': XenApiVmWrapped
+  'VM-snapshot': XenApiVmWrapped
+  'VM-template': XenApiVmWrapped
+  VTPM: XenApiVtpmWrapped
+}
+export type XoApp = {
+  config: {
+    get<T = string>(path: string): T
+    getOptional(path: string): Record<string, string> | undefined
+    getOptionalDuration(path: string): number | undefined
+    getGuiRoutes(): Promise<{
+      default: {
+        url: string
+        path: string
+      }
+      v5?: {
+        url: string
+        path: string
+      }
+      v6?: {
+        url: string
+        path: string
+      }
+      [key: string]:
+        | undefined
+        | {
+            url: string
+            path: string
+          }
+    }>
+  }
+
+  objects: EventEmitter & {
+    allIndexes: {
+      type: {
+        getEventEmitterByType(type: XapiXoRecord['type']): EventEmitter
+      }
+    }
+  }
+
+  tasks: EventEmitter & {
+    abort(id: XoTask['id'], reason?: string): Promise<void>
+    clearLogs(): Promise<void>
+    create: (params: { name: string; objectId?: string; type?: string }) => VatesTask
+    deleteLog(id: XoTask['id']): Promise<void>
+    get(id: XoTask['id']): Promise<XoTask>
+    list(opts?: { filter?: string | ((obj: XoTask) => boolean); limit?: number }): AsyncGenerator<XoTask>
+    watch(id: XoTask['id'], cb: (task: XoTask) => void): Promise<() => void>
+  }
+  apiContext: {
+    user?: XoUser
+    permission?: XoUser['permission'] | 'none' | null
+  }
+
+  // methods ------------
+  addUserToGroup: (userId: XoUser['id'], groupId: XoGroup['id']) => Promise<void>
+  authenticateUser: (
+    credentials: { token?: string; username?: string; password?: string },
+    userData?: { ip?: string },
+    opts?: { bypassOtp?: boolean; bypassTaskCreation?: boolean }
+  ) => Promise<{ bypassOtp: boolean; expiration: number; user: XoUser }>
+  /* Throw if no authorization */
+  checkFeatureAuthorization(featureCode: string): Promise<void>
+  /* connect a server (XCP-ng/XenServer) */
+  connectXenServer(id: XoServer['id']): Promise<void>
+  createAuthenticationToken(opts: {
+    client?: {
+      id?: string
+      [key: string]: unknown
+    }
+    description?: string
+    expiresIn?: string | number
+    userId: XoUser['id']
+  }): Promise<XoAuthenticationToken>
+  createUser(params: { name?: string; password?: string; [key: string]: unknown }): Promise<XoUser>
+  deleteGroup(id: XoGroup['id']): Promise<void>
+  deleteUser(id: XoUser['id']): Promise<void>
+  createGroup(params: { name: string; provider?: string; providerGroup?: string }): Promise<XoGroup>
+  /* disconnect a server (XCP-ng/XenServer) */
+  disconnectXenServer(id: XoServer['id']): Promise<void>
+  getAllGroups(): Promise<XoGroup[]>
+  getAllProxies(): Promise<XoProxy[]>
+  getAllJobs<T extends AnyXoBackupJob['type']>(type: T): Promise<Extract<AnyXoBackupJob, { type: T }>[]>
+  getAllJobs(type?: string): Promise<AnyXoJob[]>
+  getProxy(id: XoProxy['id']): Promise<XoProxy>
+  getRemote(id: XoBackupRepository['id']): Promise<XoBackupRepository>
+  getAllRemotes(): Promise<XoBackupRepository[]>
+  getAllRemotesInfo(): Promise<
+    Record<
+      XoBackupRepository['id'],
+      {
+        size?: number
+        used?: number
+        available?: number
+        encryption?: {
+          algorithm: string
+          isLegacy: boolean
+          recommanded: string
+        }
+      }
+    >
+  >
+  getAllSchedules(): Promise<XoSchedule[]>
+  getAllUsers(): Promise<XoUser[]>
+  getAllXenServers(): Promise<XoServer[]>
+  getAuthenticationTokensForUser(userId: XoUser['id']): Promise<XoAuthenticationToken[]>
+  getBackupNgLogs(): Promise<Record<string, AnyXoLog>>
+  getBackupNgLogs(id: AnyXoLog['id']): Promise<AnyXoLog>
+  getBackupNgLogsSorted(opts: {
+    after?: number
+    before?: number
+    filter: (log: AnyXoLog) => boolean
+    limit?: number
+  }): Promise<AnyXoLog[]>
+  getGroup(id: XoGroup['id']): Promise<XoGroup>
+  getHVSupportedVersions: undefined | (() => Promise<{ [key: XoHost['productBrand']]: string }>)
+  getJob<T extends AnyXoJob>(id: T['id']): Promise<T>
+  getObject: <T extends XapiXoRecord>(id: T['id'], type?: T['type'] | T['type'][]) => T
+  getObjectsByType: <T extends XapiXoRecord>(
+    type: T['type'],
+    opts?: { filter?: string | ((obj: T) => boolean); limit?: number }
+  ) => Record<T['id'], T> | undefined
+  getTotalBackupSizeOnRemote(id: XoBackupRepository['id']): Promise<{ onDisk: number }>
+  getSchedule(id: XoSchedule['id']): Promise<XoSchedule>
+  getUser: (id: XoUser['id']) => Promise<XoUser>
+  getXapi(maybeId: XapiXoRecord['id'] | XapiXoRecord): Xapi
+  getXapiHostStats: (hostId: XoHost['id'], granularity?: XapiStatsGranularity) => Promise<XapiHostStats>
+  getXapiObject: <T extends XapiXoRecord>(
+    maybeId: T['id'] | T,
+    type: T['type'] | T['type'][]
+  ) => XapiRecordByXapiXoRecord[T['type']]
+  getXapiPoolStats(poolId: XoPool['id'], granularity?: XapiStatsGranularity): Promise<XapiPoolStats>
+  getXapiVmStats: (vmId: XoVm['id'], granularity?: XapiStatsGranularity) => Promise<XapiVmStats>
+  getXenServer(id: XoServer['id']): Promise<XoServer>
+  hasFeatureAuthorization(featureCode: string): Promise<boolean>
+  hasObject<T extends XapiXoRecord>(id: T['id'], type: T['type']): boolean
+  listMetadataBackups(backupRepositoryIds: XoBackupRepository['id'][]): Promise<{
+    xo: Record<XoBackupRepository['id'], XoConfigBackupArchive[]>
+    pool: Record<XoBackupRepository['id'], Record<XoPool['id'], XoPoolBackupArchive[]>>
+  }>
+  listVmBackupsNg(
+    backupRepositoryIds: XoBackupRepository['id'][],
+    opts?: { _forceRefresh?: boolean; vmId: XoVm['id'] }
+  ): Promise<Record<XoBackupRepository['id'], Record<XoVm['id'], XoVmBackupArchive[]>>>
+  /** Allow to add a new server in the DB (XCP-ng/XenServer) */
+  registerXenServer(
+    body: Pick<XoServer, 'host' | 'httpProxy' | 'label' | 'username'> & {
+      allowUnauthorized?: XoServer['allowUnauthorized']
+      password: string
+      readOnly?: XoServer['readOnly']
+    }
+  ): Promise<XoServer>
+  rollingPoolReboot(pool: XoPool, opts?: { parentTask?: VatesTask }): Promise<void>
+  rollingPoolUpdate(pool: XoPool, opts?: { rebootVm?: boolean; parentTask?: VatesTask }): Promise<void>
+  removeUserFromGroup(userId: XoUser['id'], id: XoGroup['id']): Promise<void>
+  runJob(job: AnyXoJob, schedule: XoSchedule): void
+  runWithApiContext: (user: XoUser | undefined, fn: () => void) => Promise<unknown>
+  /** Remove a server from the DB (XCP-ng/XenServer) */
+  unregisterXenServer(id: XoServer['id']): Promise<void>
+  updateUser(
+    id: XoUser['id'],
+    updates: {
+      /**
+       * @deprecated
+       */
+      email?: string
+      authProviders?: Record<string, string>
+      name?: string
+      password?: string
+      permission?: string
+      preferences?: Record<string, string>
+    }
+  ): Promise<void>
+  updateGroup(
+    id: XoGroup['id'],
+    updates: {
+      name?: string
+    }
+  ): void
+  getAllXapis(): Record<string, XapiConnection>
+  getObjects(opts?: { filter?: Record<string, unknown>; limit?: number }): Record<string, XapiXoRecord>
+}

@vates/types/src/xo.mts

@@ -0,0 +1,875 @@
+// Types based on xapi-object-to-xo
+
+import type {
+  Branded,
+  DOMAIN_TYPE,
+  HOST_ALLOWED_OPERATIONS,
+  HOST_POWER_STATE,
+  IP_CONFIGURATION_MODE,
+  IPV6_CONFIGURATION_MODE,
+  NETWORK_OPERATIONS,
+  PGPU_DOM0_ACCESS,
+  POOL_ALLOWED_OPERATIONS,
+  PRIMARY_ADDRESS_TYPE,
+  STORAGE_OPERATIONS,
+  VDI_OPERATIONS,
+  VDI_TYPE,
+  VIF_LOCKING_MODE,
+  VM_OPERATIONS,
+  VM_POWER_STATE,
+} from './common.mjs'
+import type * as CMType from './lib/complex-matcher.mjs'
+import type { XenApiHost, XenApiPool } from './xen-api.mjs'
+
+type BaseXapiXo = {
+  $pool: XoPool['id']
+  /**
+   * @deprecated use $pool instead
+   */
+  $poolId: XoPool['id']
+
+  _xapiRef: string
+
+  uuid: string
+}
+
+type BaseXoVm = BaseXapiXo & {
+  $VBDs: XoVbd['id'][]
+  $VGPUs: XoVgpu['id'][]
+
+  $container: XoPool['id'] | XoHost['id']
+
+  CPUs: {
+    max: number
+    number: number
+  }
+  PV_args?: string
+  VGPUs: XoVgpu['id'][]
+  VIFs: XoVif['id'][]
+  VTPMs: XoVtpm['id'][]
+
+  addresses: Record<string, string>
+  affinityHost?: XoHost['id']
+  attachedPcis?: string[]
+  auto_poweron: boolean
+  bios_strings: Record<string, string>
+  blockedOperations: Record<VM_OPERATIONS, string>
+  boot: Record<string, string>
+  coresPerSocket?: number
+  cpuCap?: number
+  cpuMask?: number[]
+  cpuWeight?: number
+  creation: Record<string, string>
+  current_operations: Record<string, VM_OPERATIONS>
+  docker?: {
+    containers?: string[]
+    enabled: boolean
+    info?: string
+    /** @deprecated */
+    process?: string
+    version?: string
+  }
+  /**
+   * @deprecated use isNestedVirtEnabled instead
+   */
+  expNestedHvm: boolean
+  isNestedVirtEnabled: boolean
+  hasVendorDevice: boolean
+  high_availability: string
+  installTime?: number | null
+  isFirmwareSupported: boolean
+  memory: {
+    dynamic: number[]
+    size: number
+    static: number[]
+    usage?: number
+  }
+  mainIpAddress?: string
+  managementAgentDetected?: boolean
+  name_description: string
+  name_label: string
+  needsVtpm: boolean
+  nicType?: string
+  notes?: string
+  os_version: Record<string, string> | null
+  other: Record<string, string>
+  parent?: XoVm['id']
+  power_state: VM_POWER_STATE
+  pvDriversDetected?: boolean
+  pvDriversUpToDate?: boolean
+  pvDriversVersion?: string
+  resourceSet?: string
+  secureBoot: boolean
+  snapshots: XoVmSnapshot['id'][]
+  startDelay: number
+  startTime?: number | null
+  suspendSr?: XoSr['id']
+  tags: string[]
+  vga?: string
+  videoram?: number
+  viridian: boolean
+  virtualizationMode: DOMAIN_TYPE
+  xenStoreData: Record<string, string>
+  /**
+   * @deprecated use pvDriversVersion instead
+   */
+  xentools?:
+    | false
+    | {
+        major: null | number
+        minor: null | number
+        version: null | string
+      }
+}
+
+export type XoAlarm = Omit<XoMessage, '$object' | 'body'> & {
+  body: {
+    value?: string
+    name: string
+  }
+  object: {
+    type: XapiXoRecord['type'] | 'unknown'
+    uuid: XapiXoRecord['uuid']
+    href?: string
+  }
+}
+
+// TODO: to be typed when Bastien.N has finished working on the XO task
+type BaseXoLog = {
+  id: Branded<'xo-log'>
+  infos?: { data: unknown; message: string }[]
+  [key: string]: unknown
+}
+export type XoBackupLog = BaseXoLog & {
+  status: 'success' | 'skipped' | 'interrupted' | 'failure' | 'pending'
+  message: 'backup'
+  start: number
+  end?: number
+  tasks?: XoTask[]
+  jobId?: AnyXoBackupJob['id']
+}
+export type XoRestoreLog = BaseXoLog & {
+  message: 'restore'
+}
+export type XoVmBackupArchive = {
+  id: Branded<'vm-backup-archive'>
+  type: 'xo-vm-backup'
+  backupRepository: XoBackupRepository['id']
+  disks: { id: string; name: string; uuid: XoVdiSnapshot['uuid'] }[]
+  isImmutable?: boolean
+  jobId: XoVmBackupJob['id']
+  mode: XoVmBackupJob['mode']
+  scheduleId: XoSchedule['id']
+  size: number
+  timestamp: number
+  vm: {
+    uuid: XoVm['uuid']
+    name_description: string
+    name_label: string
+    tags: XoVm['tags']
+  }
+  differencingVhds?: number
+  dynamicVhds?: number
+  withMemory: boolean
+}
+
+type XoMetadataBackupArchive = {
+  id: Branded<'metadata-backup-archive'>
+  backupRepository: XoBackupRepository['id']
+  jobId: XoVmBackupJob['id']
+  jobName: XoVmBackupJob['name']
+  scheduleId: XoSchedule['id']
+  scheduleName: XoSchedule['name']
+  timestamp: number
+}
+export type XoConfigBackupArchive = XoMetadataBackupArchive & {
+  id: Branded<'config-backup-archive'>
+  data: string
+  type: 'xo-config-backup'
+}
+
+export type XoPoolBackupArchive = XoMetadataBackupArchive & {
+  id: Branded<'pool-backup-archive'>
+  pool: XenApiPool
+  poolMaster: XenApiHost
+  type: 'xo-pool-metadata-backup'
+}
+
+export type XoBackupRepository = {
+  benchmarks?: { readRate: number; timestamp: number; writeRate: number }[]
+  enabled: boolean
+  error?: Record<string, unknown>
+  id: Branded<'backup-repository'>
+  name: string
+  options?: string
+  proxy?: XoProxy['id']
+  url: string
+}
+
+export type XoGpuGroup = BaseXapiXo & {
+  id: Branded<'gpu-group'>
+  type: 'gpuGroup'
+}
+
+export type XoGroup = {
+  id: Branded<'group'>
+  name: string
+  provider?: string
+  providerGroupId?: string
+  users: XoUser['id'][]
+}
+
+export type XoHost = BaseXapiXo & {
+  $PBDs: XoPbd['id'][]
+  $PCIs: XoPci['id'][]
+  $PGPUs: XoPgpu['id'][]
+  $PIFs: XoPif['id'][]
+
+  PCIs: XoPci['id'][]
+  PGPUs: XoPgpu['id'][]
+  PIFs: XoPif['id'][]
+  /**
+   * @deprecated use cpus instead
+   */
+  CPUs: Record<string, string>
+
+  address: string
+  agentStartTime: null | number
+  bios_strings: Record<string, string>
+  build: string
+  certificates?: {
+    fingerprint: string
+    notAfter: number
+  }[]
+  chipset_info: {
+    iommu?: boolean
+  }
+  controlDomain?: XoVmController['id']
+  cpus: {
+    cores?: number
+    sockets?: number
+  }
+  current_operations: Record<string, HOST_ALLOWED_OPERATIONS>
+  enabled: boolean
+  hostname: string
+  hvmCapable: boolean
+  id: Branded<'host'>
+  iscsiIqn: string
+  license_expiry: null | number
+  license_params: Record<string, string>
+  license_server: Record<string, string>
+  logging: Record<string, string>
+  memory: {
+    size: number
+    /**
+     * @deprecated
+     */
+    total?: number
+    usage: number
+  }
+  multipathing: boolean
+  name_description: string
+  name_label: string
+  otherConfig: Record<string, string>
+  /**
+   * @deprecated
+   */
+  patches: XoHostPatch['id'][]
+  power_state: HOST_POWER_STATE
+  powerOnMode: string
+  productBrand: string
+  rebootRequired: boolean
+  residentVms: XoVm['id'][]
+  startTime: null | number
+  supplementalPacks:
+    | {
+        author: string
+        description: string
+        guidance: string
+        hosts: XoHost['id'][]
+        name: string
+        size: number
+        version: string
+        vdi: XoVdi['id']
+      }[]
+    | {
+        author: string
+        description: string
+        name: string
+        version: string
+      }[]
+  tags: string[]
+  type: 'host'
+  version: string
+  zstdSupported: boolean
+}
+
+export type XoHostPatch = BaseXapiXo & {
+  id: Branded<'host_patch'>
+  type: 'host_patch'
+}
+
+export type XoMessage = BaseXapiXo & {
+  $object: XapiXoRecord['id']
+
+  body: string
+  id: Branded<'message'>
+  name: string
+  time: number
+  type: 'message'
+}
+
+export type XoNetwork = BaseXapiXo & {
+  MTU: number
+  PIFs: XoPif['id'][]
+  VIFs: XoVif['id'][]
+
+  automatic: boolean
+  bridge: string
+  current_operations: Record<string, NETWORK_OPERATIONS>
+  defaultIsLocked: boolean
+  id: Branded<'network'>
+  insecureNbd?: boolean
+  name_description: string
+  name_label: string
+  nbd?: boolean
+  other_config: Record<string, string>
+  tags: string[]
+  type: 'network'
+}
+
+export type XoPbd = BaseXapiXo & {
+  attached: boolean
+  device_config:
+    | { device: string }
+    | { location: string }
+    | { path: string; location: string; legacy_mode: string }
+    | { provisioning: string; redundancy: string; 'group-name': string }
+    | { server: string; serverpath: string }
+    | { type: string; location: string }
+    | Record<string, string>
+  host: XoHost['id']
+  id: Branded<'PBD'>
+  otherConfig: Record<string, string>
+  SR: XoSr['id']
+  type: 'PBD'
+}
+
+export type XoPci = BaseXapiXo & {
+  $host?: XoHost['id']
+
+  class_name: string
+  device_name: string
+  id: Branded<'PCI'>
+  pci_id: string
+  type: 'PCI'
+}
+
+export type XoPgpu = BaseXapiXo & {
+  $host: XoHost['id']
+  $vgpus: XoVgpu['id'][]
+
+  dom0Access: PGPU_DOM0_ACCESS
+  enabledVgpuTypes: XoVgpuType['id'][]
+  gpuGroup?: XoGpuGroup['id']
+  host: XoHost['id']
+  id: Branded<'PGPU'>
+  isSystemDisplayDevice: boolean
+  pci?: XoPci['id']
+  // it seems that supportedVgpuMaxCapcities always return undefined (See: xapi-objet-to-xo)
+  /**
+   * @deprecated
+   */
+  supportedVgpuMaxCapcities?: never
+  supportedVgpuTypes: XoVgpuType['id'][]
+  type: 'PGPU'
+  vgpus: XoVgpu['id'][]
+}
+
+export type XoPif = BaseXapiXo & {
+  $host: XoHost['id']
+  $network: XoNetwork['id']
+
+  attached: boolean
+  bondMaster?: XoPif['id']
+  bondSlaves?: XoPif['id'][]
+  carrier: boolean
+  device: string
+  deviceName?: string
+  disallowUnplug: boolean
+  dns: string
+  gateway: string
+  id: Branded<'PIF'>
+  ip: string
+  ipv6: string[]
+  ipv6Mode: IPV6_CONFIGURATION_MODE
+  isBondMaster: boolean
+  isBondSlave: boolean
+  mac: string
+  management: boolean
+  mode: IP_CONFIGURATION_MODE
+  mtu: number
+  netmask: string
+  physical: boolean
+  primaryAddressType: PRIMARY_ADDRESS_TYPE
+  speed?: number
+  type: 'PIF'
+  vlan: number
+}
+
+export type XoPool = BaseXapiXo & {
+  auto_poweron: boolean
+  cpus: {
+    cores?: number
+    sockets?: number
+  }
+  crashDumpSr?: XoSr['id']
+  current_operations: Record<string, POOL_ALLOWED_OPERATIONS>
+  default_SR?: XoSr['id']
+  HA_enabled: boolean
+  haSrs: XoSr['id'][]
+  id: Branded<'pool'>
+  master: XoHost['id']
+  migrationCompression?: boolean
+  name_description: string
+  name_label: string
+  otherConfig: Record<string, string>
+  platform_version: string
+  suspendSr?: XoSr['id']
+  tags: string[]
+  type: 'pool'
+  vtpmSupported: boolean
+  zstdSupported: boolean
+}
+
+export type XoProxy = {
+  id: Branded<'proxy'>
+  url: string
+  version?: string
+  name: string
+} & (
+  | { address?: undefined; vmUuid: XoVm['id'] }
+  | { address: string; vmUuid?: undefined }
+  | { address: string; vmUuid: XoVm['id'] }
+)
+
+type BaseXoJob = {
+  id: Branded<'job'>
+  name?: string
+}
+
+type XoBackupJobGeneralSettings = {
+  backupReportTpl?: 'compactMjml' | 'mjml'
+  reportWhen?: 'always' | 'error' | 'failure' | 'never'
+  reportRecipients?: string[]
+  hideSuccessfulItems?: boolean
+  [key: string]: unknown
+}
+
+export type XoVmBackupJobGeneralSettings = XoBackupJobGeneralSettings & {
+  cbtDestroySnapshotData?: boolean
+  concurrency?: number
+  longTermRetention?: {
+    daily?: { retention: number; settings: Record<string, unknown> }
+    weekly?: { retention: number; settings: Record<string, unknown> }
+    monthly?: { retention: number; settings: Record<string, unknown> }
+    yearly?: { retention: number; settings: Record<string, unknown> }
+  }
+  checkpointSnapshot?: boolean
+  offlineSnapshot?: boolean
+  maxExportRate?: number
+  nbdConcurrency?: number
+  nRetriesVmBackupFailures?: number
+  preferNbd?: boolean
+  timezone?: string
+  mergeBackupsSynchronously?: boolean
+  offlineBackup?: boolean
+  timeout?: number
+}
+export type XoVmBackupJobScheduleSettings = {
+  exportRetention?: number
+  healthCheckVmsWithTags?: XoVm['tags']
+  fullInterval?: number
+  copyRetention?: number
+  snapshotRetention?: number
+  cbtDestroySnapshotData?: boolean
+  healthCheckSr?: XoSr['id']
+  [key: string]: unknown
+}
+export type XoVmBackupJob = BaseXoJob & {
+  compression?: 'native' | 'zstd' | ''
+  proxy?: XoProxy['id']
+  mode: 'full' | 'delta'
+  remotes?: CMType.IdOr<XoBackupRepository['id']>
+  vms: CMType.IdOr<XoVm['id']> | Record<string, unknown>
+  srs?: CMType.IdOr<XoSr['id']>
+  type: 'backup'
+  settings: {
+    '': XoVmBackupJobGeneralSettings
+    [key: XoSchedule['id']]: XoVmBackupJobScheduleSettings | undefined
+  }
+}
+
+export type XoMetadataBackupJobGeneralSettings = XoBackupJobGeneralSettings
+export type XoMetadataBackupJobScheduleSettings = {
+  retentionPoolMetadata?: number
+  retentionXoMetadata?: number
+  [key: string]: unknown
+}
+export type XoMetadataBackupJob = BaseXoJob & {
+  type: 'metadataBackup'
+  pools?: CMType.IdOr<XoPool['id']>
+  remotes: CMType.IdOr<XoBackupRepository['id']>
+  settings: {
+    ''?: XoMetadataBackupJobGeneralSettings
+    [scheduleId: XoSchedule['id']]: XoMetadataBackupJobScheduleSettings | undefined
+  }
+  xoMetadata?: boolean
+  userId: XoUser['id']
+  proxy?: XoProxy['id']
+}
+
+export type XoMirrorBackupGeneralSettings = XoBackupJobGeneralSettings & {
+  concurrency?: number
+  nRetriesVmBackupFailures?: number
+  mergeBackupsSynchronously?: boolean
+  timeout?: number
+  maxExportRate?: number
+  backupReportTpl?: 'compactMjml'
+  reportWhen: 'failure'
+}
+export type XoMirrorBackupScheduleSettings = {
+  exportRetention?: number
+  healthCheckVmsWithTags?: XoVm['tags']
+  healthCheckSr?: XoSr['id']
+  [key: string]: unknown
+}
+export type XoMirrorBackupJob = BaseXoJob & {
+  type: 'mirrorBackup'
+  mode: 'full' | 'delta'
+  sourceRemote: XoBackupRepository['id']
+  remotes: CMType.IdOr<XoBackupRepository['id']>
+  proxy?: XoProxy['id']
+  settings: {
+    '': XoMirrorBackupGeneralSettings
+    [scheduleId: XoSchedule['id']]: XoMirrorBackupScheduleSettings | undefined
+  }
+}
+
+export type XoJob = BaseXoJob & {
+  type: 'call'
+}
+
+export type XoSchedule = {
+  cron: string
+  enabled: boolean
+  id: Branded<'schedule'>
+  jobId: AnyXoJob['id']
+  name?: string
+  timezone?: string
+}
+
+export type XoServer = {
+  allowUnauthorized: boolean
+  enabled: boolean
+  error?: Record<string, unknown>
+  host: string
+  httpProxy?: string
+  id: Branded<'server'>
+  label?: string
+  master?: XoHost['id']
+  poolId?: XoPool['id']
+  poolNameDescription?: string
+  poolNameLabel?: string
+  readOnly: boolean
+  status: 'connected' | 'disconnected' | 'connecting'
+  username: string
+}
+
+export type XoSr = BaseXapiXo & {
+  $PBDs: XoPbd['id'][]
+
+  $container: XoPool['id'] | XoHost['id']
+
+  VDIs: AnyXoVdi['id'][]
+
+  allocationStrategy?: 'thin' | 'thick' | 'unknown'
+  content_type: string
+  current_operations: Record<string, STORAGE_OPERATIONS>
+  id: Branded<'SR'>
+  inMaintenanceMode: boolean
+  name_description: string
+  name_label: string
+  other_config: Record<string, string>
+  physical_usage: number
+  shared: boolean
+  size: number
+  sm_config: Record<string, string>
+  SR_type: string
+  tags: string[]
+  type: 'SR'
+  usage: number
+}
+
+export type XoSm = BaseXapiXo & {
+  id: Branded<'SM'>
+
+  SM_type: string
+  vendor: string
+  name_label: string
+  name_description: string
+  configuration: Record<string, string>
+  features: Record<string, number>
+  driver_filename: string
+  required_cluster_stack: string[]
+  supported_image_formats: string[]
+  type: 'SM'
+}
+
+export type XoTask = {
+  abortionRequestedAt?: number
+  data?: Record<string, string>
+  end?: number
+  id: Branded<'task'>
+  infos?: { data: unknown; message: string }[]
+  progress?: number
+  properties: {
+    method?: string
+    name?: string
+    objectId?: string
+    objectType?:
+      | XapiXoRecord['type']
+      | 'backup'
+      | 'backup-archive'
+      | 'backup-job'
+      | 'backup-log'
+      | 'backup-repository'
+      | 'group'
+      | 'proxy'
+      | 'restore'
+      | 'restore-log'
+      | 'schedule'
+      | 'server'
+      | 'task'
+      | 'user'
+    params?: Record<string, unknown>
+    progress?: number
+    type?: string
+    userId?: string
+    [key: string]: unknown | undefined
+  }
+  result: Record<string, unknown>
+  start: number
+  status: 'failure' | 'interrupted' | 'pending' | 'success'
+  tasks?: XoTask[]
+  updatedAt?: number
+  warnings?: { data: unknown; message: string }[]
+}
+
+export type XoUser = {
+  authProviders?: Record<string, string>
+  email: string
+  groups: XoGroup['id'][]
+  id: Branded<'user'>
+  name?: string
+  permission: string
+  pw_hash?: string
+  preferences: Record<string, string>
+}
+
+export type XoAuthenticationToken = {
+  client?: {
+    id: string
+    [key: string]: unknown
+  }
+  created_at?: number
+  description?: string
+  user_id: XoUser['id']
+  expiration: number
+  last_uses?: Record<string, { timestamp: number }>
+  id: Branded<'authentication-token'>
+}
+
+export type XoVbd = BaseXapiXo & {
+  attached: boolean
+  bootable: boolean
+  device: string | null
+  id: Branded<'VBD'>
+  is_cd_drive: boolean
+  position: string
+  read_only: boolean
+  type: 'VBD'
+  VDI?: XoVdi['id'] | XoVdiSnapshot['id']
+  VM: AnyXoVm['id']
+}
+
+type BaseXoVdi = BaseXapiXo & {
+  $SR: XoSr['id']
+  $VBDs: XoVbd['id'][]
+
+  VDI_type: VDI_TYPE
+
+  cbt_enabled?: boolean
+  current_operations: Record<string, VDI_OPERATIONS>
+  missing: boolean
+  name_description: string
+  name_label: string
+  other_config: Record<string, string>
+  parent?: XoVdiUnmanaged['id']
+  image_format?: string
+  size: number
+  snapshots: XoVdiSnapshot['id'][]
+  tags: string[]
+  usage: number
+}
+
+export type XoVdi = BaseXoVdi & {
+  id: Branded<'VDI'>
+  type: 'VDI'
+}
+
+export type XoVdiSnapshot = BaseXoVdi & {
+  id: Branded<'VDI-snapshot'>
+  snapshot_time: number
+  $snapshot_of?: XoVdi['id']
+  type: 'VDI-snapshot'
+}
+
+export type XoVdiUnmanaged = Omit<BaseXoVdi, '$VBDs'> & {
+  id: Branded<'VDI-unmanaged'>
+  type: 'VDI-unmanaged'
+
+  /**
+   * Unmanaged VDI have no VBDs
+   */
+  $VBDs: never[]
+}
+
+export type XoVgpu = BaseXapiXo & {
+  id: Branded<'VGPU'>
+  type: 'vgpu'
+}
+
+export type XoVgpuType = BaseXapiXo & {
+  id: Branded<'vgpu-type'>
+  type: 'vgpuType'
+}
+
+export type XoVif = BaseXapiXo & {
+  $VM: XoVm['id']
+
+  $network: XoNetwork['id']
+
+  allowedIpv4Addresses: string[]
+  allowedIpv6Addresses: string[]
+  attached: boolean
+  device: string
+  id: Branded<'VIF'>
+  lockingMode: VIF_LOCKING_MODE
+  MAC: string
+  MTU: number
+  other_config: Record<string, string>
+  /**
+   * In kB/s
+   */
+  rateLimit?: number
+  txChecksumming: boolean
+  type: 'VIF'
+}
+
+export type XoVm = BaseXoVm & {
+  id: Branded<'VM'>
+  type: 'VM'
+  vulnerabilities: { xsa468: boolean | { reason: string; driver?: string; version?: string } }
+}
+
+export type XoVmController = BaseXoVm & {
+  id: Branded<'VM-controller'>
+  type: 'VM-controller'
+}
+
+export type XoVmSnapshot = BaseXoVm & {
+  $snapshot_of: XoVm['id']
+
+  id: Branded<'VM-snapshot'>
+  snapshot_time: number
+  suspendVdi?: XoVdi['id']
+  type: 'VM-snapshot'
+}
+
+export type XoVmTemplate = BaseXoVm & {
+  id: Branded<'VM-template'>
+  isDefaultTemplate: boolean
+  template_info: {
+    arch?: string
+    disks: {
+      bootable: true
+      size: number
+      SR: string
+      type: string
+    }[]
+    install_methods: string[]
+    install_repository?: string
+  }
+  type: 'VM-template'
+}
+
+export type XoVtpm = BaseXapiXo & {
+  id: Branded<'VTPM'>
+  type: 'VTPM'
+}
+
+export type XapiXoRecord =
+  | XoAlarm
+  | XoGpuGroup
+  | XoHost
+  | XoMessage
+  | XoNetwork
+  | XoPbd
+  | XoPci
+  | XoPgpu
+  | XoPif
+  | XoPool
+  | XoSr
+  | XoVbd
+  | XoVdi
+  | XoVdiSnapshot
+  | XoVdiUnmanaged
+  | XoVgpu
+  | XoVgpuType
+  | XoVif
+  | XoVm
+  | XoVmController
+  | XoVmSnapshot
+  | XoVmTemplate
+  | XoVtpm
+  | XoSm
+
+export type NonXapiXoRecord =
+  | AnyXoBackupArchive
+  | AnyXoJob
+  | AnyXoLog
+  | XoGroup
+  | XoProxy
+  | XoGroup
+  | XoProxy
+  | XoJob
+  | XoBackupRepository
+  | XoSchedule
+  | XoServer
+  | XoTask
+  | XoUser
+
+export type XoRecord = XapiXoRecord | NonXapiXoRecord
+
+export type AnyXoVm = XoVm | XoVmSnapshot | XoVmTemplate | XoVmController
+
+export type AnyXoVdi = XoVdi | XoVdiSnapshot | XoVdiUnmanaged
+
+export type AnyXoJob = XoJob | AnyXoBackupJob
+
+export type AnyXoBackupJob = XoVmBackupJob | XoMetadataBackupJob | XoMirrorBackupJob
+
+export type AnyXoLog = XoBackupLog | XoRestoreLog
+
+export type AnyXoBackupArchive = XoVmBackupArchive | XoConfigBackupArchive | XoPoolBackupArchive

@vates/types/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "declaration": true,
+    "strict": true,
+    "module": "ESNext",
+    "target": "ES2022",
+    "skipLibCheck": true,
+    "types": ["node"] // Only use types from Node.js and packages that are explicitly imported
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

@vates/xml/cli.js

@@ -20,7 +20,7 @@ function main([inputPath = 0]) {
   try {
     data = JSON.parse(input)
   } catch (error) {
-    // fallback to XML
+    // fall back to XML
     log(parseXml(input))
     return
   }

@xen-orchestra/audit-core/index.js

@@ -98,6 +98,17 @@ class AuditCore {
     return record
   }
 
+  async _importRecord(record) {
+    if (!record.id || !record.previousId) {
+      throw new Error('Invalid record')
+    }
+    await this._storage.put(record)
+    return {
+      id: record.id,
+      isValid: record.id === createHash(record),
+    }
+  }
+
   async checkIntegrity(oldest, newest) {
     const storage = this._storage
 

@xen-orchestra/audit-core/package.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
-  "version": "0.3.1",
+  "version": "0.4.0",
   "engines": {
     "node": ">=14"
   },

@xen-orchestra/backups-cli/.USAGE.md

@@ -4,6 +4,10 @@ Usage:
 
     xo-backups clean-vms [--merge] [--remove] xo-vm-backups/*
 
+    alternatively you can target the full remote, thus handling S3/Azure or encrypted remotes
+
+    xo-backups clean-vms [--merge] [--remove] --remote=REMOTEURL
+
       Detects and repair issues with VM backups.
 
       Options:

@xen-orchestra/backups-cli/README.md

@@ -20,6 +20,10 @@ Usage:
 
     xo-backups clean-vms [--merge] [--remove] xo-vm-backups/*
 
+    alternatively you can target the full remote, thus handling S3/Azure or encrypted remotes
+
+    xo-backups clean-vms [--merge] [--remove] --remote=REMOTEURL
+
       Detects and repair issues with VM backups.
 
       Options:

@xen-orchestra/backups-cli/commands/clean-vms.mjs

@@ -1,13 +1,81 @@
-import { asyncMap } from '@xen-orchestra/async-map'
+import { asyncEach } from '@vates/async-each'
 import { RemoteAdapter } from '@xen-orchestra/backups/RemoteAdapter.mjs'
 import { getSyncedHandler } from '@xen-orchestra/fs'
 import getopts from 'getopts'
-import { basename, dirname } from 'path'
+import { basename, dirname, join } from 'path'
 import Disposable from 'promise-toolbox/Disposable'
 import { pathToFileURL } from 'url'
 
+async function cleanFiles(vmDirs, { fix, merge, remove }) {
+  let nbSucceed = 0
+  let nbFailed = 0
+  let nbStarted = 0
+  const total = vmDirs.length
+  // don't assume all the files uses the same remote
+  await asyncEach(
+    vmDirs,
+    vmDir =>
+      Disposable.use(getSyncedHandler({ url: pathToFileURL(dirname(vmDir)).href }), async handler => {
+        try {
+          nbStarted++
+          await new RemoteAdapter(handler).cleanVm(basename(vmDir), {
+            fixMetadata: fix,
+            remove,
+            merge,
+            logInfo: (...args) => console.log(...args),
+            logWarn: (...args) => console.warn(...args),
+          })
+          nbSucceed++
+        } catch (error) {
+          nbFailed++
+          console.error('adapter.cleanVm', vmDir, error, { nbStarted, nbSucceed, nbFailed, total })
+        }
+      }),
+    { concurrency: 2 }
+  )
+  console.log('done', { nbSucceed, nbFailed })
+}
+
+async function cleanRemote(url, { fix, merge, remove }) {
+  let nbSucceed = 0
+  let nbFailed = 0
+  let nbStarted = 0
+  await Disposable.use(getSyncedHandler({ url }), async handler => {
+    const remoteAdapter = new RemoteAdapter(handler)
+    const vmUuids = await remoteAdapter.listAllVms()
+    const total = vmUuids.length
+    await asyncEach(
+      vmUuids,
+      async vmUuid => {
+        try {
+          nbStarted++
+          await remoteAdapter.cleanVm(join('xo-vm-backups', vmUuid), {
+            fixMetadata: fix,
+            remove,
+            merge,
+            logInfo: (...args) => console.log(...args),
+            logWarn: (...args) => console.warn(...args),
+          })
+          nbSucceed++
+        } catch (error) {
+          nbFailed++
+          console.error('adapter.cleanVm', vmUuid, error, { nbStarted, nbSucceed, nbFailed, total })
+        }
+      },
+      { concurrency: 2 }
+    )
+  })
+  console.log('done', { nbSucceed, nbFailed })
+}
+
 export default async function cleanVms(args) {
-  const { _, fix, remove, merge } = getopts(args, {
+  const {
+    _: vmDirs,
+    fix,
+    remote,
+    remove,
+    merge,
+  } = getopts(args, {
     alias: {
       fix: 'f',
       remove: 'r',
@@ -20,19 +88,9 @@ export default async function cleanVms(args) {
     },
   })
 
-  await asyncMap(_, vmDir =>
-    Disposable.use(getSyncedHandler({ url: pathToFileURL(dirname(vmDir)).href }), async handler => {
-      try {
-        await new RemoteAdapter(handler).cleanVm(basename(vmDir), {
-          fixMetadata: fix,
-          remove,
-          merge,
-          logInfo: (...args) => console.log(...args),
-          logWarn: (...args) => console.warn(...args),
-        })
-      } catch (error) {
-        console.error('adapter.cleanVm', vmDir, error)
-      }
-    })
-  )
+  if (remote) {
+    return cleanRemote(remote, { fix, merge, remove })
+  } else {
+    return cleanFiles(vmDirs, { fix, merge, remove })
+  }
 }

@xen-orchestra/backups-cli/package.json

@@ -6,9 +6,10 @@
   "preferGlobal": true,
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "dependencies": {
+    "@vates/async-each": "^1.0.1",
     "@xen-orchestra/async-map": "^0.1.2",
-    "@xen-orchestra/backups": "^0.57.0",
-    "@xen-orchestra/fs": "^4.3.0",
+    "@xen-orchestra/backups": "^0.68.2",
+    "@xen-orchestra/fs": "^4.6.6",
     "filenamify": "^6.0.0",
     "getopts": "^2.2.5",
     "lodash": "^4.17.15",
@@ -27,7 +28,7 @@
   "scripts": {
     "postversion": "npm publish --access public"
   },
-  "version": "1.0.28",
+  "version": "1.1.7",
   "license": "AGPL-3.0-or-later",
   "author": {
     "name": "Vates SAS",

@xen-orchestra/backups/ImportVmBackup.mjs

@@ -4,12 +4,14 @@ import { formatFilenameDate } from './_filenameDate.mjs'
 import { importIncrementalVm } from './_incrementalVm.mjs'
 import { Task } from './Task.mjs'
 import { watchStreamSize } from './_watchStreamSize.mjs'
-import { VhdNegative, VhdSynthetic } from 'vhd-lib'
 import { decorateClass } from '@vates/decorate-with'
 import { createLogger } from '@xen-orchestra/log'
 import { dirname, join } from 'node:path'
 import pickBy from 'lodash/pickBy.js'
 import { defer } from 'golike-defer'
+import { NegativeDisk } from '@xen-orchestra/disk-transform'
+import { openDiskChain } from './disks/openDiskChain.mjs'
+import { resetVmOtherConfig } from './_otherConfig.mjs'
 
 const { debug, info, warn } = createLogger('xo:backups:importVmBackup')
 async function resolveUuid(xapi, cache, uuid, type) {
@@ -28,10 +30,10 @@ export class ImportVmBackup {
     metadata,
     srUuid,
     xapi,
-    settings: { additionnalVmTag, newMacAddresses, mapVdisSrs = {}, useDifferentialRestore = false } = {},
+    settings: { additionalVmTag, newMacAddresses, mapVdisSrs = {}, useDifferentialRestore = false } = {},
   }) {
     this._adapter = adapter
-    this._importIncrementalVmSettings = { additionnalVmTag, newMacAddresses, mapVdisSrs, useDifferentialRestore }
+    this._importIncrementalVmSettings = { additionalVmTag, newMacAddresses, mapVdisSrs, useDifferentialRestore }
     this._metadata = metadata
     this._srUuid = srUuid
     this._xapi = xapi
@@ -59,12 +61,12 @@ export class ImportVmBackup {
     const metadata = this._metadata
     const { mapVdisSrs } = this._importIncrementalVmSettings
     const { vbds, vhds, vifs, vm, vmSnapshot, vtpms } = metadata
-    const streams = {}
-    const metdataDir = dirname(metadata._filename)
+    const disks = {}
+    const metadataDir = dirname(metadata._filename)
     const vdis = ignoredVdis === undefined ? metadata.vdis : pickBy(metadata.vdis, vdi => !ignoredVdis.has(vdi.uuid))
 
     for (const [vdiRef, vdi] of Object.entries(vdis)) {
-      const vhdPath = join(metdataDir, vhds[vdiRef])
+      const vhdPath = join(metadataDir, vhds[vdiRef])
 
       let xapiDisk
       try {
@@ -76,7 +78,7 @@ export class ImportVmBackup {
 
       let snapshotCandidate, backupCandidate
       if (xapiDisk !== undefined) {
-        debug('found disks, wlll search its snapshots', { snapshots: xapiDisk.snapshots })
+        debug('found disks, will search its snapshots', { snapshots: xapiDisk.snapshots })
         for (const snapshotRef of xapiDisk.snapshots) {
           const snapshot = await this._xapi.getRecord('VDI', snapshotRef)
 
@@ -95,7 +97,7 @@ export class ImportVmBackup {
           // have a corresponding backup more recent than metadata ?
           const pathToSnapshotData = await this.#getPathOfVdiSnapshot(snapshot.uuid)
           if (pathToSnapshotData === undefined) {
-            debug('no backup linked to this snaphot')
+            debug('no backup linked to this snapshot')
             continue
           }
           if (snapshot.$SR.uuid !== (mapVdisSrs[vdi.$snapshot_of$uuid] ?? this._srUuid)) {
@@ -110,20 +112,21 @@ export class ImportVmBackup {
         }
       }
 
-      let stream
-      const backupWithSnapshotPath = join(metdataDir, backupCandidate ?? '')
+      let disk
+      const backupWithSnapshotPath = join(metadataDir, backupCandidate ?? '')
       if (vhdPath === backupWithSnapshotPath) {
         // all the data are already on the host
         debug('direct reuse of a snapshot')
-        stream = null
+        disk = null
         vdis[vdiRef].baseVdi = snapshotCandidate
         // go next disk , we won't use this stream
         continue
       }
 
-      let disposableDescendants
-
-      const disposableSynthetic = await VhdSynthetic.fromVhdChain(this._adapter._handler, vhdPath)
+      const parent = await openDiskChain({
+        handler: this._adapter._handler,
+        path: vhdPath,
+      })
 
       // this will also clean if another disk of this VM backup fails
       // if user really only need to restore non failing disks he can retry with ignoredVdis
@@ -132,8 +135,7 @@ export class ImportVmBackup {
         if (!disposed) {
           disposed = true
           try {
-            await disposableDescendants?.dispose()
-            await disposableSynthetic?.dispose()
+            await parent?.close()
           } catch (error) {
             warn('openVhd: failed to dispose VHDs', { error })
           }
@@ -141,11 +143,10 @@ export class ImportVmBackup {
       }
       $defer.onFailure(() => disposeOnce())
 
-      const parentVhd = disposableSynthetic.value
-      await parentVhd.readBlockAllocationTable()
-      debug('got vhd synthetic of parents', parentVhd.length)
+      debug('got vhd synthetic of parents', parent)
 
       if (snapshotCandidate !== undefined) {
+        let descendant, negativeDisk
         try {
           debug('will try to use differential restore', {
             backupWithSnapshotPath,
@@ -153,39 +154,37 @@ export class ImportVmBackup {
             vdiRef,
           })
 
-          disposableDescendants = await VhdSynthetic.fromVhdChain(this._adapter._handler, backupWithSnapshotPath, {
+          descendant = await openDiskChain({
+            handler: this._adapter._handler,
+            path: backupWithSnapshotPath,
             until: vhdPath,
           })
-          const descendantsVhd = disposableDescendants.value
-          await descendantsVhd.readBlockAllocationTable()
+
           debug('got vhd synthetic of descendants')
-          const negativeVhd = new VhdNegative(parentVhd, descendantsVhd)
+          negativeDisk = new NegativeDisk(parent, descendant)
           debug('got vhd negative')
 
           // update the stream with the negative vhd stream
-          stream = await negativeVhd.stream()
+          disk = negativeDisk
           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 })
-          disposableDescendants?.dispose()
+          descendant?.close()
+          negativeDisk?.close()
         }
       }
-      // didn't make a negative stream : fallback to classic stream
-      if (stream === undefined) {
+      // didn't make a negative stream : fall back to classic stream
+      if (disk === undefined) {
         debug('use legacy restore')
-        stream = await parentVhd.stream()
+        disk = parent
       }
-
-      stream.on('end', disposeOnce)
-      stream.on('close', disposeOnce)
-      stream.on('error', disposeOnce)
-      info('everything is ready, will transfer', stream.length)
-      streams[`${vdiRef}.vhd`] = stream
+      info('everything is ready, will transfer', disk)
+      disks[vdiRef] = disk
     }
     return {
-      streams,
+      disks,
       vbds,
       vdis,
       version: '1.0.0',
@@ -196,7 +195,7 @@ export class ImportVmBackup {
   }
 
   async #decorateIncrementalVmMetadata() {
-    const { additionnalVmTag, mapVdisSrs, useDifferentialRestore } = this._importIncrementalVmSettings
+    const { additionalVmTag, mapVdisSrs, useDifferentialRestore } = this._importIncrementalVmSettings
 
     const ignoredVdis = new Set(
       Object.entries(mapVdisSrs)
@@ -213,8 +212,8 @@ export class ImportVmBackup {
 
     const cache = new Map()
     const mapVdisSrRefs = {}
-    if (additionnalVmTag !== undefined) {
-      backup.vm.tags.push(additionnalVmTag)
+    if (additionalVmTag !== undefined) {
+      backup.vm.tags.push(additionalVmTag)
     }
     for (const [vdiUuid, srUuid] of Object.entries(mapVdisSrs)) {
       mapVdisSrRefs[vdiUuid] = await resolveUuid(xapi, cache, srUuid, 'SR')
@@ -241,7 +240,6 @@ export class ImportVmBackup {
       assert.strictEqual(metadata.mode, 'delta')
 
       backup = await this.#decorateIncrementalVmMetadata()
-      Object.values(backup.streams).forEach(stream => watchStreamSize(stream, sizeContainer))
     }
 
     return Task.run(
@@ -257,7 +255,14 @@ export class ImportVmBackup {
           : await importIncrementalVm(backup, await xapi.getRecord('SR', srRef), {
               newMacAddresses,
             })
-
+        const remoteName = adapter._handler._remote.name
+        let desc = `Restored on ${formatFilenameDate(+new Date())}`
+        if (remoteName !== undefined) {
+          desc += ` from ${remoteName}`
+        }
+        if (metadata.vm.name_description) {
+          desc += ` - ${metadata.vm.name_description}`
+        }
         await Promise.all([
           xapi.call('VM.add_tags', vmRef, 'restored from backup'),
           xapi.call(
@@ -265,13 +270,8 @@ export class ImportVmBackup {
             vmRef,
             `${metadata.vm.name_label} (${formatFilenameDate(metadata.timestamp)})`
           ),
-          xapi.call(
-            'VM.set_name_description',
-            vmRef,
-            `Restored on ${formatFilenameDate(+new Date())} from ${adapter._handler._remote.name} -
-             ${metadata.vm.name_description}
-            `
-          ),
+          xapi.call('VM.set_name_description', vmRef, desc),
+          resetVmOtherConfig(xapi, vmRef),
         ])
 
         return {

@xen-orchestra/backups/RemoteAdapter.mjs

@@ -2,7 +2,7 @@ import { asyncEach } from '@vates/async-each'
 import { asyncMap, asyncMapSettled } from '@xen-orchestra/async-map'
 import { compose } from '@vates/compose'
 import { createLogger } from '@xen-orchestra/log'
-import { createVhdDirectoryFromStream, openVhd, VhdAbstract, VhdDirectory, VhdSynthetic } from 'vhd-lib'
+import { VhdDirectory, VhdSynthetic } from 'vhd-lib'
 import { decorateMethodsWith } from '@vates/decorate-with'
 import { deduped } from '@vates/disposable/deduped.js'
 import { dirname, join, resolve } from 'node:path'
@@ -10,7 +10,6 @@ import { execFile } from 'child_process'
 import { mount } from '@vates/fuse-vhd'
 import { readdir, lstat } from 'node:fs/promises'
 import { synchronized } from 'decorator-synchronized'
-import { v4 as uuidv4 } from 'uuid'
 import { ZipFile } from 'yazl'
 import Disposable from 'promise-toolbox/Disposable'
 import fromCallback from 'promise-toolbox/fromCallback'
@@ -19,7 +18,7 @@ import groupBy from 'lodash/groupBy.js'
 import pDefer from 'promise-toolbox/defer'
 import pickBy from 'lodash/pickBy.js'
 import reduce from 'lodash/reduce.js'
-import tar from 'tar'
+import * as tar from 'tar'
 import zlib from 'zlib'
 
 import { BACKUP_DIR } from './_getVmBackupDir.mjs'
@@ -28,19 +27,24 @@ import { formatFilenameDate } from './_filenameDate.mjs'
 import { getTmpDir } from './_getTmpDir.mjs'
 import { isMetadataFile } from './_backupType.mjs'
 import { isValidXva } from './_isValidXva.mjs'
-import { listPartitions, LVM_PARTITION_TYPE } from './_listPartitions.mjs'
+import { listPartitions, LVM_PARTITION_TYPE_MBR, LVM_PARTITION_TYPE_GPT } from './_listPartitions.mjs'
 import { lvs, pvs } from './_lvm.mjs'
 import { watchStreamSize } from './_watchStreamSize.mjs'
 
+import { RemoteVhd } from './disks/RemoteVhd.mjs'
+import { openDiskChain } from './disks/openDiskChain.mjs'
+import { toVhdStream, writeToVhdDirectory } from 'vhd-lib/disk-consumer/index.mjs'
+import { ReadAhead } from '@xen-orchestra/disk-transform'
+
 export const DIR_XO_CONFIG_BACKUPS = 'xo-config-backups'
 
 export const DIR_XO_POOL_METADATA_BACKUPS = 'xo-pool-metadata-backups'
 
-const IMMUTABILTY_METADATA_FILENAME = '/immutability.json'
+const IMMUTABILITY_METADATA_FILENAME = '/immutability.json'
 
 const { debug, warn } = createLogger('xo:backups:RemoteAdapter')
 
-const compareTimestamp = (a, b) => a.timestamp - b.timestamp
+export const compareTimestamp = (a, b) => a.timestamp - b.timestamp
 
 const noop = Function.prototype
 
@@ -201,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 => {
@@ -308,8 +312,8 @@ export class RemoteAdapter {
   }
 
   async deleteVmBackups(files) {
-    const metadatas = await asyncMap(files, file => this.readVmBackupMetadata(file))
-    const { delta, full, ...others } = groupBy(metadatas, 'mode')
+    const metadata = await asyncMap(files, file => this.readVmBackupMetadata(file))
+    const { delta, full, ...others } = groupBy(metadata, 'mode')
 
     const unsupportedModes = Object.keys(others)
     if (unsupportedModes.length !== 0) {
@@ -423,12 +427,20 @@ export class RemoteAdapter {
   async listAllVms() {
     const handler = this._handler
     const vmsUuids = []
-    await asyncEach(await handler.list(BACKUP_DIR), async entry => {
-      // ignore hidden and lock files
-      if (entry[0] !== '.' && !entry.endsWith('.lock')) {
-        vmsUuids.push(entry)
+    try {
+      await asyncEach(await handler.list(BACKUP_DIR), async entry => {
+        // ignore hidden and lock files
+        if (entry[0] !== '.' && !entry.endsWith('.lock')) {
+          vmsUuids.push(entry)
+        }
+      })
+    } catch (error) {
+      // remote without any VM backup are ok
+      if (error.code !== 'ENOENT') {
+        throw error
       }
-    })
+    }
+
     return vmsUuids
   }
 
@@ -486,7 +498,7 @@ export class RemoteAdapter {
 
       const results = []
       await asyncMapSettled(partitions, partition =>
-        partition.type === LVM_PARTITION_TYPE
+        partition.type === LVM_PARTITION_TYPE_MBR || partition.type === LVM_PARTITION_TYPE_GPT
           ? this._listLvmLogicalVolumes(devicePath, partition, results)
           : results.push(partition)
       )
@@ -563,7 +575,7 @@ export class RemoteAdapter {
     }
   }
 
-  async #getCachabledDataListVmBackups(dir) {
+  async #getCacheableDataListVmBackups(dir) {
     debug('generating cache', { path: dir })
 
     const handler = this._handler
@@ -601,6 +613,11 @@ export class RemoteAdapter {
   // if cache is missing  or broken  => regenerate it and return
 
   async _readCacheListVmBackups(vmUuid) {
+    // immutable remote can't use any caching
+    // since the cache file may be non modifiable
+    if (this._handler.isImmutable()) {
+      return this.#getCacheableDataListVmBackups(`${BACKUP_DIR}/${vmUuid}`)
+    }
     const path = this.#getVmBackupsCache(vmUuid)
 
     const cache = await this._readCache(path)
@@ -610,7 +627,7 @@ export class RemoteAdapter {
     }
 
     // nothing cached, or cache unreadable => regenerate it
-    const backups = await this.#getCachabledDataListVmBackups(`${BACKUP_DIR}/${vmUuid}`)
+    const backups = await this.#getCacheableDataListVmBackups(`${BACKUP_DIR}/${vmUuid}`)
     if (backups === undefined) {
       return
     }
@@ -681,26 +698,32 @@ export class RemoteAdapter {
     return path
   }
 
-  async writeVhd(path, input, { checksum = true, validator = noop, writeBlockConcurrency } = {}) {
+  async writeVhd(path, disk, { validator = noop, writeBlockConcurrency } = {}) {
     const handler = this._handler
+
     if (this.useVhdDirectory()) {
-      const dataPath = `${dirname(path)}/data/${uuidv4()}.vhd`
-      const size = await createVhdDirectoryFromStream(handler, dataPath, input, {
-        concurrency: writeBlockConcurrency,
-        compression: this.#getCompressionType(),
-        async validator() {
-          await input.task
-          return validator.apply(this, arguments)
+      await writeToVhdDirectory({
+        disk,
+        target: {
+          handler,
+          path,
+          concurrency: writeBlockConcurrency,
+          validator,
+          compression: 'brotli',
         },
       })
-      await VhdAbstract.createAlias(handler, path, dataPath)
-      return size
     } else {
-      return this.outputStream(path, input, { checksum, validator })
+      const stream = await toVhdStream(disk)
+      await this.outputStream(path, stream, { validator, checksum: false })
+      await validator(path)
     }
   }
 
-  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,
@@ -716,30 +739,16 @@ export class RemoteAdapter {
   }
 
   // open the  hierarchy of ancestors until we find a full one
-  async _createVhdStream(handler, path, { useChain }) {
-    const disposableSynthetic = useChain ? await VhdSynthetic.fromVhdChain(handler, path) : await openVhd(handler, path)
-    // I don't want the vhds to be disposed on return
-    // but only when the stream is done ( or failed )
-
-    let disposed = false
-    const disposeOnce = async () => {
-      if (!disposed) {
-        disposed = true
-        try {
-          await disposableSynthetic.dispose()
-        } catch (error) {
-          warn('openVhd: failed to dispose VHDs', { error })
-        }
-      }
+  async _createVhdDisk(handler, path, { useChain }) {
+    let disk
+    if (useChain) {
+      disk = await openDiskChain({ handler, path })
+    } else {
+      disk = new RemoteVhd({ handler, path })
+      await disk.init()
     }
-    const synthetic = disposableSynthetic.value
-    await synthetic.readBlockAllocationTable()
-    const stream = await synthetic.stream()
-
-    stream.on('end', disposeOnce)
-    stream.on('close', disposeOnce)
-    stream.on('error', disposeOnce)
-    return stream
+    disk = new ReadAhead(disk)
+    return disk
   }
 
   async readIncrementalVmBackup(metadata, ignoredVdis, { useChain = true } = {}) {
@@ -747,14 +756,14 @@ export class RemoteAdapter {
     const { vbds, vhds, vifs, vm, vmSnapshot, vtpms } = metadata
     const dir = dirname(metadata._filename)
     const vdis = ignoredVdis === undefined ? metadata.vdis : pickBy(metadata.vdis, vdi => !ignoredVdis.has(vdi.uuid))
-
-    const streams = {}
+    const disks = {}
     await asyncMapSettled(Object.keys(vdis), async ref => {
-      streams[`${ref}.vhd`] = await this._createVhdStream(handler, join(dir, vhds[ref]), { useChain })
+      delete vdis[ref].baseVdi
+      disks[ref] = await this._createVhdDisk(handler, join(dir, vhds[ref]), { useChain })
     })
 
     return {
-      streams,
+      disks,
       vbds,
       vdis,
       version: '1.0.0',
@@ -772,10 +781,10 @@ 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)
+      await this._handler._readFile(IMMUTABILITY_METADATA_FILENAME)
       remoteIsImmutable = true
     } catch (error) {
       if (error.code !== 'ENOENT') {
@@ -788,7 +797,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' })

@xen-orchestra/backups/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') }
     }

@xen-orchestra/backups/_backupType.mjs

@@ -1,4 +1,5 @@
 export const isMetadataFile = filename => filename.endsWith('.json')
 export const isVhdFile = filename => filename.endsWith('.vhd')
+export const isVhdSumFile = filename => filename.endsWith('.vhd.checksum')
 export const isXvaFile = filename => filename.endsWith('.xva')
 export const isXvaSumFile = filename => filename.endsWith('.xva.checksum')

@xen-orchestra/backups/_cleanVm.integ.mjs

@@ -83,12 +83,12 @@ test('It remove broken vhd', async () => {
 
   await handler.writeFile(`${basePath}/notReallyAVhd.vhd`, 'I AM NOT A VHD')
   assert.equal((await handler.list(basePath)).length, 1)
-  let loggued = ''
+  let logged = ''
   const logInfo = message => {
-    loggued += message
+    logged += message
   }
   await adapter.cleanVm(rootPath, { remove: false, logInfo, logWarn: logInfo, lock: false })
-  assert.equal(loggued, `VHD check error`)
+  assert.equal(logged, `VHD check error`)
   // not removed
   assert.deepEqual(await handler.list(basePath), ['notReallyAVhd.vhd'])
   // really remove it
@@ -98,7 +98,7 @@ test('It remove broken vhd', async () => {
 
 test('it remove vhd with missing or multiple ancestors', async () => {
   // one with a broken parent, should be deleted
-  await generateVhd(`${basePath}/abandonned.vhd`, {
+  await generateVhd(`${basePath}/abandoned.vhd`, {
     header: {
       parentUnicodeName: 'gone.vhd',
       parentUuid: uniqueIdBuffer(),
@@ -118,21 +118,21 @@ test('it remove vhd with missing or multiple ancestors', async () => {
     `metadata.json`,
     JSON.stringify({
       mode: 'delta',
-      vhds: [`${basePath}/child.vhd`, `${basePath}/abandonned.vhd`],
+      vhds: [`${basePath}/child.vhd`, `${basePath}/abandoned.vhd`],
     }),
     { flags: 'w' }
   )
   // clean
-  let loggued = ''
+  let logged = ''
   const logInfo = message => {
-    loggued += message + '\n'
+    logged += message + '\n'
   }
   await adapter.cleanVm(rootPath, { remove: true, logInfo, logWarn: logInfo, lock: false })
 
-  const deletedOrphanVhd = loggued.match(/deleting orphan VHD/g) || []
+  const deletedOrphanVhd = logged.match(/deleting orphan VHD/g) || []
   assert.equal(deletedOrphanVhd.length, 1) // only one vhd should have been deleted
 
-  // we don't test the filew on disk, since they will all be marker as unused and deleted without a metadata.json file
+  // we don't test the file on disk, since they will all be marker as unused and deleted without a metadata.json file
 })
 
 test('it remove backup meta data referencing a missing vhd in delta backup', async () => {
@@ -144,12 +144,12 @@ test('it remove backup meta data referencing a missing vhd in delta backup', asy
       vhds: [
         `${relativePath}/orphan.vhd`,
         `${relativePath}/child.vhd`,
-        // abandonned.json is not here
+        // abandoned.json is not here
       ],
     })
   )
 
-  await generateVhd(`${basePath}/abandonned.vhd`)
+  await generateVhd(`${basePath}/abandoned.vhd`)
 
   // one orphan, which is a full vhd, no parent
   const orphan = await generateVhd(`${basePath}/orphan.vhd`)
@@ -162,12 +162,12 @@ test('it remove backup meta data referencing a missing vhd in delta backup', asy
     },
   })
 
-  let loggued = ''
+  let logged = ''
   const logInfo = message => {
-    loggued += message + '\n'
+    logged += message + '\n'
   }
   await adapter.cleanVm(rootPath, { remove: true, logInfo, logWarn: logInfo, lock: false })
-  let matched = loggued.match(/deleting unused VHD/g) || []
+  let matched = logged.match(/deleting unused VHD/g) || []
   assert.equal(matched.length, 1) // only one vhd should have been deleted
 
   // a missing vhd cause clean to remove all vhds
@@ -179,14 +179,14 @@ test('it remove backup meta data referencing a missing vhd in delta backup', asy
         `deleted.vhd`, // in metadata but not in vhds
         `orphan.vhd`,
         `child.vhd`,
-        // abandonned.vhd is not here anymore
+        // abandoned.vhd is not here anymore
       ],
     }),
     { flags: 'w' }
   )
-  loggued = ''
+  logged = ''
   await adapter.cleanVm(rootPath, { remove: true, logInfo, logWarn: () => {}, lock: false })
-  matched = loggued.match(/deleting unused VHD/g) || []
+  matched = logged.match(/deleting unused VHD/g) || []
   assert.equal(matched.length, 2) // all vhds (orphan and  child  ) should have been deleted
 })
 
@@ -221,16 +221,16 @@ test('it merges delta of non destroyed chain', async () => {
     },
   })
 
-  let loggued = []
+  let logged = []
   const logInfo = message => {
-    loggued.push(message)
+    logged.push(message)
   }
   await adapter.cleanVm(rootPath, { remove: true, logInfo, logWarn: logInfo, lock: false })
-  assert.equal(loggued[0], `unexpected number of entries in backup cache`)
+  assert.equal(logged[0], `unexpected number of entries in backup cache`)
 
-  loggued = []
+  logged = []
   await adapter.cleanVm(rootPath, { remove: true, merge: true, logInfo, logWarn: () => {}, lock: false })
-  const [merging] = loggued
+  const [merging] = logged
   assert.equal(merging, `merging VHD chain`)
 
   const metadata = JSON.parse(await handler.readFile(`${rootPath}/metadata.json`))
@@ -287,9 +287,8 @@ test('it finish unterminated merge ', async () => {
 })
 
 // each of the vhd can be a file, a directory, an alias to a file or an alias to a directory
-// the message an resulting files should be identical to the output with vhd files which is tested independantly
-
-describe('tests multiple combination ', () => {
+// the message and resulting files should be identical to the output with vhd files which is tested independently
+describe('tests multiple combination ', { concurrency: 1 }, () => {
   for (const useAlias of [true, false]) {
     for (const vhdMode of ['file', 'directory']) {
       test(`alias : ${useAlias}, mode: ${vhdMode}`, async () => {
@@ -309,10 +308,10 @@ describe('tests multiple combination ', () => {
           await VhdAbstract.createAlias(handler, 'broken.alias.vhd', brokenVhdDataPath)
         }
 
-        // a vhd non referenced in metada
+        // a vhd non referenced in metadata
         await generateVhd(`${basePath}/nonreference.vhd`, { useAlias, mode: vhdMode })
-        // an abandonded delta vhd without its parent
-        await generateVhd(`${basePath}/abandonned.vhd`, {
+        // an abandoned delta vhd without its parent
+        await generateVhd(`${basePath}/abandoned.vhd`, {
           useAlias,
           mode: vhdMode,
           header: {
@@ -405,7 +404,7 @@ describe('tests multiple combination ', () => {
         // size should be the size of children + grand children + clean after the merge
         assert.deepEqual(metadata.size, vhdMode === 'file' ? 6502400 : 6501888)
 
-        // broken vhd, non referenced, abandonned should be deleted ( alias and data)
+        // broken vhd, non referenced, abandoned should be deleted ( alias and data)
         // ancestor and child should be merged
         // grand child and clean vhd should not have changed
         const survivors = await handler.list(basePath)
@@ -431,7 +430,6 @@ describe('tests multiple combination ', () => {
     }
   }
 })
-
 test('it cleans orphan merge states ', async () => {
   await handler.writeFile(`${basePath}/.orphan.vhd.merge.json`, '')
 
@@ -456,7 +454,7 @@ test('check Aliases should work alone', async () => {
     logWarn: () => {},
   })
 
-  // only ok have suvived
+  // only ok have survived
   const alias = (await handler.list('vhds')).filter(f => f.endsWith('.vhd'))
   assert.equal(alias.length, 1)
 

@xen-orchestra/backups/_cleanVm.mjs

@@ -4,7 +4,7 @@ import { asyncMap } from '@xen-orchestra/async-map'
 import { Constants, openVhd, VhdAbstract, VhdFile } from 'vhd-lib'
 import { isVhdAlias, resolveVhdAlias } from 'vhd-lib/aliases.js'
 import { basename, dirname, resolve } from 'node:path'
-import { isMetadataFile, isVhdFile, isXvaFile, isXvaSumFile } from './_backupType.mjs'
+import { isMetadataFile, isVhdFile, isVhdSumFile, isXvaFile, isXvaSumFile } from './_backupType.mjs'
 import { limitConcurrency } from 'limit-concurrency-decorator'
 import { mergeVhdChain } from 'vhd-lib/merge.js'
 
@@ -68,10 +68,12 @@ async function _mergeVhdChain(handler, chain, { logInfo, remove, mergeBlockConcu
 const noop = Function.prototype
 
 const INTERRUPTED_VHDS_REG = /^\.(.+)\.merge.json$/
+
 const listVhds = async (handler, vmDir, logWarn) => {
   const vhds = new Set()
   const aliases = {}
   const interruptedVhds = new Map()
+  const checksums = new Set()
 
   await asyncMap(
     await handler.list(`${vmDir}/vdis`, {
@@ -85,11 +87,15 @@ const listVhds = async (handler, vmDir, logWarn) => {
         }),
         async vdiDir => {
           const list = await handler.list(vdiDir, {
-            filter: file => isVhdFile(file) || INTERRUPTED_VHDS_REG.test(file),
+            filter: file => isVhdFile(file) || INTERRUPTED_VHDS_REG.test(file) || isVhdSumFile(file),
           })
           aliases[vdiDir] = list.filter(vhd => isVhdAlias(vhd)).map(file => `${vdiDir}/${file}`)
 
           await asyncMap(list, async file => {
+            if (isVhdSumFile(file)) {
+              checksums.add(`${vdiDir}/${file}`)
+              return
+            }
             const res = INTERRUPTED_VHDS_REG.exec(file)
             if (res === null) {
               vhds.add(`${vdiDir}/${file}`)
@@ -111,7 +117,7 @@ const listVhds = async (handler, vmDir, logWarn) => {
       )
   )
 
-  return { vhds, interruptedVhds, aliases }
+  return { vhds, interruptedVhds, aliases, checksums }
 }
 
 export async function checkAliases(
@@ -129,10 +135,29 @@ export async function checkAliases(
         logWarn('missing target of alias', { alias })
         if (remove) {
           logInfo('removing alias and non VHD target', { alias, target })
-          await handler.unlink(target)
           await handler.unlink(alias)
         }
+        continue
       }
+      if (err.code === 'EISDIR') {
+        logWarn('alias is a vhd directory', { alias })
+        if (remove) {
+          logInfo('removing vhd directory named as alias', { alias, target })
+          await VhdAbstract.unlink(handler, alias)
+        }
+        continue
+      }
+      logWarn('unhandled error while checking alias', { alias, err })
+      continue
+    }
+
+    if (target === '') {
+      logWarn('empty target for alias ', { alias })
+      if (remove) {
+        logInfo('removing alias and non VHD target', { alias, target })
+        await handler.unlink(alias)
+      }
+      continue
     }
 
     if (!isVhdFile(target)) {
@@ -209,7 +234,16 @@ export async function cleanVm(
   const vhdParents = { __proto__: null }
   const vhdChildren = { __proto__: null }
 
-  const { vhds, interruptedVhds, aliases } = await listVhds(handler, vmDir, logWarn)
+  const { vhds, interruptedVhds, aliases, checksums } = await listVhds(handler, vmDir, logWarn)
+
+  // from 5.110 to 5.113 we computed checksum for vhd file
+  // but never used nor removed them
+  await asyncMap(checksums, async path => {
+    if (remove) {
+      logInfo('deleting checksum file ', { path })
+      return handler.unlink(path)
+    }
+  })
 
   // remove broken VHDs
   await asyncMap(vhds, async path => {
@@ -493,7 +527,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
     })
   }
@@ -575,8 +609,8 @@ export async function cleanVm(
       if (mergedSize) {
         // all disks are now key disk
         metadata.isVhdDifferencing = {}
-        for (const id of Object.values(metadata.vdis ?? {})) {
-          metadata.isVhdDifferencing[`${id}.vhd`] = false
+        for (const id of Object.keys(metadata.vdis ?? {})) {
+          metadata.isVhdDifferencing[id] = false
         }
       }
       mustRegenerateCache = true

@xen-orchestra/backups/_getOldEntries.mjs

@@ -1,5 +1,58 @@
+// @ts-check
+
 import moment from 'moment-timezone'
 import assert from 'node:assert'
+/**
+ * @typedef {import('moment-timezone').Moment} Moment
+ */
+/**
+ * @typedef {Object} LTRSettings
+ * @property {number} [firstHourOfTheDay] - First hour of the day (for daily retention)
+ * @property {number} [firstDayOfWeek] - First day of the week (for weekly retention)
+ * @property {number} [firstDayOfMonth] - First day of the month (for monthly retention)
+ * @property {number} [firstDayOfYear] - First day of the year (for yearly retention)
+ */
+
+/**
+ * @typedef {Object} LTRConfig
+ * @property {number} retention - Number of time buckets to retain
+ * @property {LTRSettings} [settings] - Optional settings for the retention period
+ */
+
+/**
+ * @typedef {Object} LongTermRetention
+ * @property {LTRConfig} [daily] - Daily retention configuration
+ * @property {LTRConfig} [weekly] - Weekly retention configuration
+ * @property {LTRConfig} [monthly] - Monthly retention configuration
+ * @property {LTRConfig} [yearly] - Yearly retention configuration
+ */
+
+/**
+ * @typedef {Object} Entry
+ * @property {number | undefined} timestamp - Unix timestamp of the entry
+ * @property {string} id
+ * @property {*} [key] - Any other properties
+ */
+
+/**
+ * @typedef {Object} DateBucket
+ * @property {number} remaining - Number of remaining buckets to fill
+ * @property {string|null} lastMatchingBucket - Last bucket key that was matched
+ * @property {(date: Moment) => string} formatter - Function to format date into bucket key
+ * @property {Object.<string, Entry>} entries - Map of bucket keys to entries
+ */
+
+/**
+ * @typedef {Object} LTRDefinition
+ * @property {(options: {firstHourOfTheDay?: number, firstDayOfWeek?: number, firstDayOfMonth?: number, firstDayOfYear?: number, dateCreator: (date: Moment) => Moment}) => (date: Moment) => string} makeDateFormatter
+ * @property {string} [ancestor] - Name of the parent retention period
+ */
+
+/**
+ * Creates a function that converts dates to moment objects in a specific timezone
+ * @param {string|undefined} timezone - IANA timezone string (e.g., 'America/New_York')
+ * @returns {(date: Moment | number) => Moment} Function that creates timezoned moment objects
+ */
 
 function instantiateTimezonedDateCreator(timezone) {
   return date => {
@@ -9,9 +62,12 @@ function instantiateTimezonedDateCreator(timezone) {
   }
 }
 
+/**
+ * @type {Object.<string, LTRDefinition>}
+ */
 const LTR_DEFINITIONS = {
   daily: {
-    makeDateFormatter: ({ firstHourOfTheDay = 0, dateCreator } = {}) => {
+    makeDateFormatter: ({ firstHourOfTheDay = 0, dateCreator }) => {
       return date => {
         const copy = dateCreator(date)
         copy.hour(copy.hour() - firstHourOfTheDay)
@@ -20,20 +76,20 @@ const LTR_DEFINITIONS = {
     },
   },
   weekly: {
-    makeDateFormatter: ({ firstDayOfWeek = 0 /* relative to timezone week start */, dateCreator } = {}) => {
+    makeDateFormatter: ({ firstDayOfWeek = 0 /* relative to timezone week start */, dateCreator }) => {
       return date => {
         const copy = dateCreator(date)
 
-        copy.date(date.date() - firstDayOfWeek)
+        copy.date(copy.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')
+        // since the computation of the first week of a year is timezone dependent
+        return copy.format('gggg-ww')
       }
     },
     ancestor: 'daily',
   },
   monthly: {
-    makeDateFormatter: ({ firstDayOfMonth = 0, dateCreator } = {}) => {
+    makeDateFormatter: ({ firstDayOfMonth = 0, dateCreator }) => {
       return date => {
         const copy = dateCreator(date)
         copy.date(copy.date() - firstDayOfMonth)
@@ -43,7 +99,7 @@ const LTR_DEFINITIONS = {
     ancestor: 'weekly',
   },
   yearly: {
-    makeDateFormatter: ({ firstDayOfYear = 0, dateCreator } = {}) => {
+    makeDateFormatter: ({ firstDayOfYear = 0, dateCreator }) => {
       return date => {
         const copy = dateCreator(date)
         copy.date(copy.date() - firstDayOfYear)
@@ -53,27 +109,23 @@ const LTR_DEFINITIONS = {
     ancestor: 'monthly',
   },
 }
-
-// returns all entries but the last retention-th
 /**
- * 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
- * @returns Array<Backup>
+ * Groups entries into date buckets based on long-term retention configuration
+ * @template {Entry} T
+ * @param {Array<T>} entries - Array of entries sorted in descending order by timestamp
+ * @param {LongTermRetention} longTermRetention - Configuration for retention periods
+ * @param {string | undefined} timezone - IANA timezone string
+ * @returns {Object.<string, DateBucket>} Map of retention period names to their date buckets
  */
-export function getOldEntries(minRetentionCount, entries, { longTermRetention = {}, timezone } = {}) {
-  assert.strictEqual(
-    typeof minRetentionCount,
-    'number',
-    `minRetentionCount must be a number, got ${JSON.stringify(minRetentionCount)}`
-  )
-  assert.strictEqual(
-    minRetentionCount >= 0,
-    true,
-    `minRetentionCount must be a positive number, got ${JSON.stringify(minRetentionCount)}`
-  )
+
+export function getLtrEntries(entries, longTermRetention, timezone) {
+  /**
+   * @type  {Object.<string, DateBucket>}
+   */
   const dateBuckets = {}
+  if (!longTermRetention || Object.keys(longTermRetention).length === 0) {
+    return {}
+  }
   const dateCreator = instantiateTimezonedDateCreator(timezone)
   // only check buckets that have a retention set
   for (const [duration, { retention, settings }] of Object.entries(longTermRetention)) {
@@ -81,7 +133,7 @@ export function getOldEntries(minRetentionCount, entries, { longTermRetention =
     assert.notStrictEqual(
       timezone,
       undefined,
-      `timezone must defined for ltr, got ${JSON.stringify({ minRetentionCount, longTermRetention, timezone })}`
+      `timezone must defined for ltr, got ${JSON.stringify({ longTermRetention, timezone })}`
     )
     assert.strictEqual(
       typeof retention,
@@ -97,40 +149,106 @@ export function getOldEntries(minRetentionCount, entries, { longTermRetention =
       remaining: retention,
       lastMatchingBucket: null,
       formatter: LTR_DEFINITIONS[duration].makeDateFormatter({ ...settings, dateCreator }),
+      entries: {}, // bucket => entry id
     }
   }
   const nb = entries.length
-  const oldEntries = []
-
+  let previousTimestamp = -1
   for (let i = nb - 1; i >= 0; i--) {
     const entry = entries[i]
+    // force it so the compiler is sure we have a timestamp
+    if (entry.timestamp === undefined) {
+      assert.notStrictEqual(
+        entry.timestamp,
+        undefined,
+        `Can't compute long term retention if entries don't have a timestamp`
+      )
+      continue
+    }
+    // we go through the entries from the last (most recent) to the first (oldest)
+    assert.ok(
+      previousTimestamp === -1 || entry.timestamp < previousTimestamp,
+      `entries must be sorted in desc order ${new Date(entry.timestamp)} , previous :  > ${new Date(previousTimestamp)} `
+    )
+    previousTimestamp = entry.timestamp
     const entryDate = dateCreator(entry.timestamp)
-    let shouldBeKept = false
     for (const [duration, { remaining, lastMatchingBucket, formatter }] of Object.entries(dateBuckets)) {
-      if (remaining === 0) {
-        continue
-      }
       const bucket = formatter(entryDate)
       if (lastMatchingBucket !== bucket) {
-        if (lastMatchingBucket !== null) {
-          assert.strictEqual(
-            lastMatchingBucket > bucket,
-            true,
-            `entries must be sorted in asc order ${lastMatchingBucket} ${bucket}`
-          )
+        if (remaining === 0) {
+          continue
         }
-        shouldBeKept = true
-        dateBuckets[duration].remaining -= 1
         dateBuckets[duration].lastMatchingBucket = bucket
+        dateBuckets[duration].remaining -= 1
       }
-    }
-    if (i >= nb - minRetentionCount) {
-      shouldBeKept = true
-    }
-    if (!shouldBeKept) {
-      oldEntries.push(entry)
+      dateBuckets[duration].entries[bucket] = entry
     }
   }
-  // we expect the entries to be in the right order
-  return oldEntries.reverse()
+
+  return dateBuckets
+}
+
+/**
+ * return the status of an entry
+ * @param {Array<Entry>} entries
+ * @param {Entry} entry
+ * @param {LongTermRetention} longTermRetention - Configuration for retention periods
+ * @param {string | undefined} timezone - IANA timezone string
+ * @returns {Array<{duration: string, dateBucket:string}>}
+ */
+export function getEntryStatus(entries, entry, longTermRetention, timezone) {
+  const dateBuckets = getLtrEntries(entries, longTermRetention, timezone)
+  const entryBuckets = []
+  for (const [duration, { entries }] of Object.entries(dateBuckets)) {
+    for (const [dateBucket, bucketEntry] of Object.entries(entries)) {
+      if (entry.id === bucketEntry.id) {
+        entryBuckets.push({ duration, dateBucket })
+      }
+    }
+  }
+  return entryBuckets
+}
+
+/**
+ * return the entries too old to be kept
+ *  if multiple entries are in the same time bucket: keep only the oldest one
+ *  if an entry is valid in any of the bucket OR the minRetentionCount: keep it
+ *  if a bucket is completely empty: it does not count as one, thus it may extend the retention
+ * if an entry is within the most recents minRetentionCount entries : keep it
+ *
+ * @param {number} minRetentionCount - Minimum number of most recent entries to always keep
+ * @param {Array<Entry>} entries - Array of entries sorted in descending order by timestamp
+ * @param {Object} options - Additional options
+ * @param {LongTermRetention} [options.longTermRetention={}] - Configuration for retention periods
+ * @param {string | undefined} [options.timezone] - IANA timezone string
+ * @returns {Array<Entry>} Array of entries that can be removed
+ */
+export function getOldEntries(minRetentionCount, entries, { longTermRetention = {}, timezone } = {}) {
+  assert.strictEqual(
+    typeof minRetentionCount,
+    'number',
+    `minRetentionCount must be a number, got ${JSON.stringify(minRetentionCount)}`
+  )
+  assert.ok(
+    minRetentionCount >= 0,
+    `minRetentionCount must be a positive number, got ${JSON.stringify(minRetentionCount)}`
+  )
+  const dateBuckets = getLtrEntries(entries, longTermRetention, timezone)
+
+  const kept = new Set(entries.filter((_, index) => index >= entries.length - minRetentionCount))
+  /**
+   * @type {Set<Entry>}
+   */
+  for (const { entries } of Object.values(dateBuckets)) {
+    for (const entry of Object.values(entries)) {
+      kept.add(entry)
+    }
+  }
+
+  // ensure order is the same as the source
+  const oldEntries = entries.filter((entry, index) => {
+    return !kept.has(entry)
+  })
+
+  return oldEntries
 }

@xen-orchestra/backups/_getOldEntries.test.mjs

@@ -10,24 +10,28 @@ describe('_getOldEntries() should succeed', () => {
         1,
         [
           { timestamp: 1, id: 1 },
-          { timestamp: 3, id: 2 },
-          { timestamp: 2, id: 3 },
+          { timestamp: 2, id: 2 },
+          { timestamp: 3, id: 3 },
         ],
       ],
       expectedIds: [1, 2],
       testLabel: 'should  handle number based retention ',
     },
-
+    {
+      args: [3, [{ id: 1 }, 4, new Date(), 'whatever']],
+      expectedIds: [1],
+      testLabel: 'should  handle number based retention without timestamp  ',
+    },
     {
       args: [
         0,
         [
-          { timestamp: +new Date('2024-09-01 00:01:00'), id: 1 }, // too old
-          { timestamp: +new Date('2024-09-01 00:00:00'), id: 2 }, // too old
-          { timestamp: +new Date('2024-09-02 00:09:00'), id: 3 }, // too old in same day
+          { timestamp: +new Date('2024-09-01 00:00:00'), id: 1 }, // too old
+          { timestamp: +new Date('2024-09-01 00:01:00'), id: 2 }, // too old
+          { timestamp: +new Date('2024-09-02 00:09:00'), id: 3 }, // oldest in same day
           { timestamp: +new Date('2024-09-02 00:10:00'), id: 4 },
           { timestamp: +new Date('2024-09-03 00:09:00'), id: 5 },
-          { timestamp: +new Date('2024-09-04 00:09:00'), id: 6 }, // too old in same day
+          { timestamp: +new Date('2024-09-04 00:09:00'), id: 6 }, // oldest in same day
           { timestamp: +new Date('2024-09-04 00:10:00'), id: 7 },
         ],
         {
@@ -37,22 +41,22 @@ describe('_getOldEntries() should succeed', () => {
           timezone: 'Europe/Paris',
         },
       ],
-      expectedIds: [1, 2, 3, 6],
+      expectedIds: [1, 2, 4, 7],
       testLabel: 'should  handle day based retention  ',
     },
     {
       args: [
         0,
         [
-          { timestamp: +new Date('2024-09-01 00:01:00'), id: 1 }, // week n-3 too old
-          { timestamp: +new Date('2024-09-02 00:00:00'), id: 2 }, // week n-3 too old
-          { timestamp: +new Date('2024-09-03 00:09:00'), id: 3 }, // week n-2
+          { timestamp: +new Date('2024-08-30 00:01:00'), id: 1 }, // week n-3 too old
+          { timestamp: +new Date('2024-08-31 00:00:00'), id: 2 }, // week n-3 too old
+          { timestamp: +new Date('2024-09-03 00:09:00'), id: 3 }, // week n-2, oldest
           { timestamp: +new Date('2024-09-04 00:09:00'), id: 4 }, // week n-2
           { timestamp: +new Date('2024-09-05 00:09:00'), id: 5 }, // week n-2
           { timestamp: +new Date('2024-09-06 00:09:00'), id: 6 }, // week n-2
-          { timestamp: +new Date('2024-09-07 00:09:00'), id: 7 }, // week n-2, most recent kept
-          { timestamp: +new Date('2024-09-09 00:09:00'), id: 8 }, // week n-1, too old
-          { timestamp: +new Date('2024-09-15 00:09:00'), id: 9 }, // week n-1  kept
+          { timestamp: +new Date('2024-09-07 00:09:00'), id: 7 }, // week n-2
+          { timestamp: +new Date('2024-09-15 00:09:00'), id: 8 }, // week n-1, oldest
+          { timestamp: +new Date('2024-09-21 00:09:00'), id: 9 }, // week n-1  most recent
           { timestamp: +new Date('2024-09-22 00:09:00'), id: 10 }, // week n  kept
         ],
         {
@@ -62,7 +66,7 @@ describe('_getOldEntries() should succeed', () => {
           timezone: 'Europe/Paris',
         },
       ],
-      expectedIds: [1, 2, 3, 4, 5, 6, 8],
+      expectedIds: [1, 2, 4, 5, 6, 7, 9],
       testLabel: 'should  handle week based retention  ',
     },
     {
@@ -85,26 +89,26 @@ describe('_getOldEntries() should succeed', () => {
           timezone: 'Europe/Paris',
         },
       ],
-      expectedIds: [1, 3, 4, 6, 7],
+      expectedIds: [1, 4, 5, 7, 8],
       testLabel: 'should  handle month based retention',
     },
     {
       args: [
-        0,
+        2,
         [
-          { timestamp: +new Date('2023-05-18 00:09:00'), id: 1 }, // too old
-          { timestamp: +new Date('2024-06-15 00:09:00'), id: 2 }, // too old in same year
-          { timestamp: +new Date('2024-07-04 00:09:00'), id: 3 }, // too old
-          { timestamp: +new Date('2024-08-12 00:09:00'), id: 4 }, // too old
-          { timestamp: +new Date('2024-09-05 00:09:00'), id: 5 }, // too old
-          { timestamp: +new Date('2024-10-02 00:09:00'), id: 6 }, // new month,
-          { timestamp: +new Date('2024-11-01 00:09:00'), id: 7 }, // new month , week reached retention
-          { timestamp: +new Date('2024-12-17 00:09:00'), id: 8 }, // new week
-          { timestamp: +new Date('2024-12-24 00:09:00'), id: 9 }, // new week/month / year  daily reach retention
-          { timestamp: +new Date('2025-01-01 00:09:00'), id: 10 }, // same day/week/month/year
-          { timestamp: +new Date('2025-01-01 00:10:00'), id: 11 }, //  new  day / week / month
-          { timestamp: +new Date('2025-12-31 00:09:00'), id: 12 }, // same day/week/month/year
-          { timestamp: +new Date('2025-12-31 00:09:00'), id: 13 }, // new month /year
+          { timestamp: +new Date('2023-05-18 00:09:00'), id: 1 }, //
+          { timestamp: +new Date('2024-06-15 00:09:00'), id: 2 }, //  year n -1
+          { timestamp: +new Date('2024-07-04 00:09:00'), id: 3 }, //
+          { timestamp: +new Date('2024-08-12 00:09:00'), id: 4 }, //
+          { timestamp: +new Date('2024-09-05 00:09:00'), id: 5 }, //
+          { timestamp: +new Date('2024-10-02 00:09:00'), id: 6 }, //  month n-4
+          { timestamp: +new Date('2024-11-01 00:09:00'), id: 7 }, //  month n-3
+          { timestamp: +new Date('2024-12-17 00:09:00'), id: 8 }, //  week n-3
+          { timestamp: +new Date('2024-12-24 00:09:00'), id: 9 }, //  week n-2, month n-2,
+          { timestamp: +new Date('2025-01-01 00:09:00'), id: 10 }, //  week n-1, year n
+          { timestamp: +new Date('2025-01-02 00:10:00'), id: 11 }, //  day n-1, month n-1,
+          { timestamp: +new Date('2025-12-31 00:09:00'), id: 12 }, //  day n , week n , month n
+          { timestamp: +new Date('2025-12-31 10:09:00'), id: 13 }, // min retention
         ],
         {
           longTermRetention: {
@@ -116,18 +120,18 @@ describe('_getOldEntries() should succeed', () => {
           timezone: 'Europe/Paris', // use a time zone here because week definition is timezone bound
         },
       ],
-      expectedIds: [1, 2, 3, 4, 5, 10, 12],
+      expectedIds: [1, 3, 4, 5],
       testLabel: 'complete test  ',
     },
     {
       args: [
         0,
         [
-          { timestamp: +new Date('2024-09-01 00:01:00'), id: 1 }, // thrid day too old
-          { timestamp: +new Date('2024-09-01 00:10:00'), id: 2 }, // thrid day
-          { timestamp: +new Date('2024-09-01 00:20:00'), id: 3 }, // second day, too old
-          { timestamp: +new Date('2024-09-02 00:22:00'), id: 4 }, // second day too old
-          { timestamp: +new Date('2024-09-03 00:20:00'), id: 5 }, // second day in NZ
+          { timestamp: +new Date('2024-08-31 09:01:00'), id: 1 }, // 4th day too old
+          { timestamp: +new Date('2024-09-01 00:10:00'), id: 2 }, // third day
+          { timestamp: +new Date('2024-09-01 14:20:00'), id: 3 }, // second day, oldest
+          { timestamp: +new Date('2024-09-02 00:22:00'), id: 4 }, // second day
+          { timestamp: +new Date('2024-09-03 14:00:00'), id: 5 }, // same day oldest
           { timestamp: +new Date('2024-09-04 00:09:00'), id: 6 }, // same day in NZ
           { timestamp: +new Date('2024-09-04 00:10:00'), id: 7 }, // most recent
         ],
@@ -135,10 +139,10 @@ describe('_getOldEntries() should succeed', () => {
           longTermRetention: {
             daily: { retention: 3 },
           },
-          timezone: 'Pacific/Auckland', // GMT +6
+          timezone: 'Pacific/Auckland', // GMT +13
         },
       ],
-      expectedIds: [1, 2, 3, 6],
+      expectedIds: [1, 4, 6, 7],
       testLabel: 'should  handle timezone ',
     },
   ]
@@ -149,13 +153,20 @@ describe('_getOldEntries() should succeed', () => {
       assert.strictEqual(
         oldEntries.length,
         expectedIds.length,
-        `different length , ${JSON.stringify({ oldEntries, expectedIds })}`
+        `different length , ${JSON.stringify({ expectedIds, oldEntries: oldEntries.map(({ id }) => id) })}`
       )
       for (let i = 0; i < expectedIds.length; i++) {
+        if (i > 0) {
+          assert.strictEqual(
+            expectedIds[i - 1] < expectedIds[i],
+            true,
+            `expect ids in ascending order ${expectedIds[i - 1]} ${expectedIds[i]}`
+          )
+        }
         assert.strictEqual(
           oldEntries[i].id,
           expectedIds[i],
-          `different id , ${JSON.stringify({ i, expectedIds, oldEntries })}`
+          `different id , ${JSON.stringify({ i, expectedIds, oldEntries: oldEntries.map(({ id }) => id) })}`
         )
       }
     })
@@ -272,6 +283,19 @@ describe('_getOldEntries() should fail when called incorrectly', () => {
       ],
       testLabel: 'broken date ',
     },
+    {
+      args: [
+        1,
+        [{ obj: 1 }, 'toto', Date.now()],
+        {
+          longTermRetention: {
+            daily: { retention: 5 },
+          },
+          timezone: 'Europe/Paris',
+        },
+      ],
+      testLabel: 'should fail if LTR without timestamp',
+    },
   ]
 
   for (const { args, testLabel } of tests) {

@xen-orchestra/backups/_incrementalVm.mjs

@@ -10,6 +10,10 @@ import { Task } from './Task.mjs'
 import pick from 'lodash/pick.js'
 import { BASE_DELTA_VDI, COPY_OF, VM_UUID } from './_otherConfig.mjs'
 
+import { VHD_MAX_SIZE, XapiDiskSource } from '@xen-orchestra/xapi'
+import { toVhdStream } from 'vhd-lib/disk-consumer/index.mjs'
+import { toQcow2Stream } from '@xen-orchestra/qcow2'
+
 const ensureArray = value => (value === undefined ? [] : Array.isArray(value) ? value : [value])
 
 export async function exportIncrementalVm(
@@ -19,7 +23,7 @@ export async function exportIncrementalVm(
 ) {
   // refs of VM's VDIs → base's VDIs.
 
-  const streams = {}
+  const disks = {}
   const vdis = {}
   const vbds = {}
   await cancelableMap(cancelToken, vm.$VBDs, async (cancelToken, vbd) => {
@@ -52,32 +56,14 @@ export async function exportIncrementalVm(
       $snapshot_of$uuid: vdi.$snapshot_of?.uuid,
       $SR$uuid: vdi.$SR.uuid,
     }
-    try {
-      streams[`${vdiRef}.vhd`] = await vdi.$exportContent({
-        baseRef: baseVdi?.$ref,
-        cancelToken,
-        format: 'vhd',
-        nbdConcurrency,
-        preferNbd,
-      })
-    } catch (err) {
-      if (err.code === 'VDI_CANT_DO_DELTA') {
-        // fall back to a base
-        Task.info(`Can't do delta, will try to get a full stream`, { vdi })
-        streams[`${vdiRef}.vhd`] = await vdi.$exportContent({
-          cancelToken,
-          format: 'vhd',
-          nbdConcurrency,
-          preferNbd,
-        })
-        // only warn if the fall back succeed
-        Task.warning(`Can't do delta with this vdi, transfer will be a full`, {
-          vdi,
-        })
-      } else {
-        throw err
-      }
-    }
+    disks[vdiRef] = new XapiDiskSource({
+      vdiRef,
+      xapi: vm.$xapi,
+      baseRef: baseVdi?.$ref,
+      nbdConcurrency,
+      preferNbd,
+    })
+    await disks[vdiRef].init()
   })
 
   const suspendVdi = vm.$suspend_VDI
@@ -87,10 +73,13 @@ export async function exportIncrementalVm(
       ...suspendVdi,
       $SR$uuid: suspendVdi.$SR.uuid,
     }
-    streams[`${vdiRef}.vhd`] = await suspendVdi.$exportContent({
-      cancelToken,
-      format: 'vhd',
+    disks[vdiRef] = new XapiDiskSource({
+      vdiRef: suspendVdi.$ref,
+      xapi: vm.$xapi,
+      nbdConcurrency,
+      preferNbd,
     })
+    await disks[vdiRef].init()
   }
 
   const vifs = {}
@@ -104,11 +93,13 @@ export async function exportIncrementalVm(
     }
   })
 
+  // Get a fresh list of VM's VTPM to avoid `vm.VTPMs: [undefined]`
+  const vmVtpms = await vm.$xapi.getField('VM', vm.$ref, 'VTPMs')
   const vtpms = await Promise.all(
-    vm.$VTPMs.map(async vtpm => {
+    vmVtpms.map(async vtpmRef => {
       let content
       try {
-        content = await vm.$xapi.call('VTPM.get_contents', vtpm.$ref)
+        content = await vm.$xapi.call('VTPM.get_contents', vtpmRef)
       } catch (err) {
         console.error(err)
       }
@@ -116,24 +107,17 @@ export async function exportIncrementalVm(
     })
   )
 
-  return Object.defineProperty(
-    {
-      version: '1.1.0',
-      vbds,
-      vdis,
-      vifs,
-      vm: {
-        ...vm,
-      },
-      vtpms,
+  return {
+    version: '1.1.0',
+    vbds,
+    vdis,
+    vifs,
+    vm: {
+      ...vm,
     },
-    'streams',
-    {
-      configurable: true,
-      value: streams,
-      writable: true,
-    }
-  )
+    vtpms,
+    disks,
+  }
 }
 
 export const importIncrementalVm = defer(async function importIncrementalVm(
@@ -199,8 +183,8 @@ export const importIncrementalVm = defer(async function importIncrementalVm(
     const vdi = vdiRecords[vdiRef]
     let newVdi
 
-    if (vdi.baseVdi !== undefined) {
-      newVdi = await xapi.getRecord('VDI', await vdi.baseVdi.$clone())
+    if (vdi.baseVdi?.$ref !== undefined) {
+      newVdi = await xapi.getRecord('VDI', await xapi.VDI_clone(vdi.baseVdi.$ref))
       $defer.onFailure(() => newVdi.$destroy())
 
       await newVdi.update_other_config(COPY_OF, vdi.uuid)
@@ -244,21 +228,28 @@ export const importIncrementalVm = defer(async function importIncrementalVm(
     }
   })
 
-  const { streams } = incrementalVm
-
+  const { disks } = incrementalVm
   await Promise.all([
     // Import VDI contents.
     cancelableMap(cancelToken, Object.entries(newVdis), async (cancelToken, [id, vdi]) => {
-      for (let stream of ensureArray(streams[`${id}.vhd`])) {
-        if (stream === null) {
-          // we restore a backup and reuse completly a local snapshot
+      for (const disk of ensureArray(disks[id])) {
+        if (disk === null) {
+          // we restore a backup and reuse completely a local snapshot
           continue
         }
-        if (typeof stream === 'function') {
-          stream = await stream()
-        }
         await xapi.setField('VDI', vdi.$ref, 'name_label', `[Importing] ${vdiRecords[id].name_label}`)
-        await vdi.$importContent(stream, { cancelToken, format: 'vhd' })
+
+        let stream, format
+        if (vdi.virtual_size > VHD_MAX_SIZE) {
+          stream = await toQcow2Stream(disk)
+          format = 'qcow2'
+        } else {
+          stream = await toVhdStream(disk)
+          format = 'vhd'
+        }
+
+        await vdi.$importContent(stream, { cancelToken, format })
+
         await xapi.setField('VDI', vdi.$ref, 'name_label', vdiRecords[id].name_label)
       }
     }),
@@ -300,10 +291,16 @@ export const importIncrementalVm = defer(async function importIncrementalVm(
       await xapi.VTPM_create({ VM: vmRef, contents })
     })
   )
-
+  const vm = await xapi.getRecord('VM', vmRef)
   await Promise.all([
-    incrementalVm.vm.ha_always_run && xapi.setField('VM', vmRef, 'ha_always_run', true),
-    xapi.setField('VM', vmRef, 'name_label', incrementalVm.vm.name_label),
+    vmRecord.ha_always_run && xapi.setField('VM', vmRef, 'ha_always_run', true),
+    xapi.setField('VM', vmRef, 'name_label', vmRecord.name_label),
+    // correctly unlock the VM and reapply the target blocked operations
+    vm.update_blocked_operations({
+      start: null,
+      start_on: null,
+      ...vmRecord.blocked_operations,
+    }),
   ])
 
   return vmRef

@xen-orchestra/backups/_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
 

@xen-orchestra/backups/_listPartitions.mjs

@@ -20,13 +20,31 @@ const IGNORED_PARTITION_TYPES = {
   0xd5: true,
 
   0x82: true, // swap
+  // GPT Linux swap GUID
+  '0657fd6d-a4ab-43c4-84e5-0933c84b4f4f': true,
 }
 
-export const LVM_PARTITION_TYPE = 0x8e
+// MBR LVM type
+export const LVM_PARTITION_TYPE_MBR = 0x8e
+// GPT LVM type
+export const LVM_PARTITION_TYPE_GPT = 'e6d6d379-f507-44c2-a23c-238f2a3df928'
 
 const parsePartxLine = createParser({
   keyTransform: key => (key === 'UUID' ? 'id' : key.toLowerCase()),
-  valueTransform: (value, key) => (key === 'start' || key === 'size' || key === 'type' ? +value : value),
+  valueTransform: (value, key) => {
+    if (key === 'start' || key === 'size') {
+      return +value
+    }
+    // For GPT partitions, type is a UUID string
+    if (key === 'type' && !value.startsWith('0x')) {
+      return value.toLowerCase()
+    }
+    // For MBR partitions, type is a hex number as string (e.g., "0x8e")
+    if (key === 'type' && value.startsWith('0x')) {
+      return parseInt(value, 16)
+    }
+    return value
+  },
 })
 
 // returns an empty array in case of a non-partitioned disk

@xen-orchestra/backups/_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}
@@ -70,7 +70,8 @@ export async function getVmDeltaChainLength(xapi, vmRef) {
 
 /**
  *
- * Reset the other_config field of a VM and its VDIs
+ * Reset the other_config field related to backups of a VM and its VDIs
+ *
  *
  * @param {Xapi} xapi
  * @param {String} vmRef
@@ -90,39 +91,6 @@ export function resetVmOtherConfig(xapi, vmRef) {
   })
 }
 
-/**
- *
- * used to ensure compatibiliy with the previous snapshots that were having the config stored only into VM
- *
- * @param {Xapi} xapi
- * @param {String} vmRef
- * @returns {Promise}
- */
-export async function populateVdisOtherConfig(xapi, vmRef) {
-  const otherConfig = await xapi.getField('VM', vmRef, 'other_config')
-  const {
-    [DATETIME]: datetime,
-    [DELTA_CHAIN_LENGTH]: chainLength,
-    [EXPORTED_SUCCESSFULLY]: successfully,
-    [JOB_ID]: jobId,
-    [REPLICATED_TO_SR_UUID]: replicatedTo,
-    [SCHEDULE_ID]: scheduleId,
-    [VM_UUID]: vmUuid,
-  } = otherConfig
-
-  return applyToVmAndVdis(xapi, vmRef, (type, ref) =>
-    xapi.setFieldEntries(type, ref, 'other_config', {
-      [DATETIME]: datetime,
-      [DELTA_CHAIN_LENGTH]: chainLength,
-      [EXPORTED_SUCCESSFULLY]: successfully,
-      [JOB_ID]: jobId,
-      [REPLICATED_TO_SR_UUID]: replicatedTo,
-      [SCHEDULE_ID]: scheduleId,
-      [VM_UUID]: vmUuid,
-    })
-  )
-}
-
 /**
  *
  * set the other_config key related to a backup of a VM and its associated VDIs
@@ -152,7 +120,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

@xen-orchestra/backups/_runners/VmsRemote.mjs

@@ -4,11 +4,12 @@ import { limitConcurrency } from 'limit-concurrency-decorator'
 
 import { extractIdsFromSimplePattern } from '../extractIdsFromSimplePattern.mjs'
 import { Task } from '../Task.mjs'
-import createStreamThrottle from './_createStreamThrottle.mjs'
 import { DEFAULT_SETTINGS, Abstract } from './_Abstract.mjs'
 import { getAdaptersByRemote } from './_getAdaptersByRemote.mjs'
 import { FullRemote } from './_vmRunners/FullRemote.mjs'
 import { IncrementalRemote } from './_vmRunners/IncrementalRemote.mjs'
+import { Throttle } from '@vates/generator-toolbox'
+import createStreamThrottle from './_createStreamThrottle.mjs'
 
 const noop = Function.prototype
 
@@ -41,6 +42,7 @@ export const VmsRemote = class RemoteVmsBackupRunner extends Abstract {
     const schedule = this._schedule
     const settings = this._settings
 
+    const throttleGenerator = new Throttle(settings.maxExportRate)
     const throttleStream = createStreamThrottle(settings.maxExportRate)
 
     const config = this._config
@@ -89,7 +91,8 @@ export const VmsRemote = class RemoteVmsBackupRunner extends Abstract {
             schedule,
             settings: vmSettings,
             sourceRemoteAdapter,
-            throttleStream,
+            throttleGenerator, // for incrementals
+            throttleStream, // for full
             vmUuid,
           }
           let vmBackup

@xen-orchestra/backups/_runners/VmsXapi.mjs

@@ -4,12 +4,13 @@ import { limitConcurrency } from 'limit-concurrency-decorator'
 
 import { extractIdsFromSimplePattern } from '../extractIdsFromSimplePattern.mjs'
 import { Task } from '../Task.mjs'
-import createStreamThrottle from './_createStreamThrottle.mjs'
 import { DEFAULT_SETTINGS, Abstract } from './_Abstract.mjs'
 import { runTask } from './_runTask.mjs'
 import { getAdaptersByRemote } from './_getAdaptersByRemote.mjs'
 import { IncrementalXapi } from './_vmRunners/IncrementalXapi.mjs'
 import { FullXapi } from './_vmRunners/FullXapi.mjs'
+import { Throttle } from '@vates/generator-toolbox'
+import createStreamThrottle from './_createStreamThrottle.mjs'
 
 const noop = Function.prototype
 
@@ -55,6 +56,7 @@ export const VmsXapi = class VmsXapiBackupRunner extends Abstract {
     const schedule = this._schedule
     const settings = this._settings
 
+    const throttleGenerator = new Throttle(settings.maxExportRate)
     const throttleStream = createStreamThrottle(settings.maxExportRate)
 
     const config = this._config
@@ -147,6 +149,7 @@ export const VmsXapi = class VmsXapiBackupRunner extends Abstract {
                       schedule,
                       settings: vmSettings,
                       srs,
+                      throttleGenerator,
                       throttleStream,
                       vm,
                     }

@xen-orchestra/backups/_runners/_vmRunners/FullRemote.mjs

@@ -2,10 +2,11 @@ import { AbstractRemote } from './_AbstractRemote.mjs'
 import { FullRemoteWriter } from '../_writers/FullRemoteWriter.mjs'
 import { forkStreamUnpipe } from '../_forkStreamUnpipe.mjs'
 import { watchStreamSize } from '../../_watchStreamSize.mjs'
+import { AggregatedFullRemoteWriter } from '../_writers/AggregatedFullRemoteWriter.mjs'
 
 export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote {
-  _getRemoteWriter() {
-    return FullRemoteWriter
+  _getRemoteWriters() {
+    return [FullRemoteWriter, AggregatedFullRemoteWriter]
   }
 
   _filterTransferList(transferList) {
@@ -16,7 +17,7 @@ export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote
     const transferList = await this._computeTransferList(({ mode }) => mode === 'full')
 
     for (const metadata of transferList) {
-      const stream = await this._sourceRemoteAdapter.readFullVmBackup(metadata)
+      const stream = this._throttleStream(await this._sourceRemoteAdapter.readFullVmBackup(metadata))
       const sizeContainer = watchStreamSize(stream)
 
       // @todo shouldn't transfer backup if it will be deleted by retention policy (higher retention on source than destination)
@@ -24,8 +25,9 @@ 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,
             vm: metadata.vm,
             vmSnapshot: metadata.vmSnapshot,
@@ -36,5 +38,6 @@ export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote
       // for healthcheck
       this._tags = metadata.vm.tags
     }
+    this._hasTransferredData = transferList.length > 0
   }
 }

@xen-orchestra/backups/_runners/_vmRunners/FullXapi.mjs

@@ -5,23 +5,45 @@ import { FullRemoteWriter } from '../_writers/FullRemoteWriter.mjs'
 import { FullXapiWriter } from '../_writers/FullXapiWriter.mjs'
 import { watchStreamSize } from '../../_watchStreamSize.mjs'
 import { AbstractXapi } from './_AbstractXapi.mjs'
+import { AggregatedFullRemoteWriter } from '../_writers/AggregatedFullRemoteWriter.mjs'
+import { AggregatedFullXapiWriter } from '../_writers/AggregatedFullXapiWriter.mjs'
 
 const { debug } = createLogger('xo:backups:FullXapiVmBackup')
 
 export const FullXapi = class FullXapiVmBackupRunner extends AbstractXapi {
   _getWriters() {
-    return [FullRemoteWriter, FullXapiWriter]
+    return [FullRemoteWriter, FullXapiWriter, AggregatedFullRemoteWriter, AggregatedFullXapiWriter]
   }
 
-  _mustDoSnapshot() {
+  async _mustDoSnapshot() {
     const vm = this._vm
-
     const settings = this._settings
-    return (
-      settings.unconditionalSnapshot ||
-      (!settings.offlineBackup && vm.power_state === 'Running') ||
-      settings.snapshotRetention !== 0
-    )
+
+    // General setting forcing snapshot at all times
+    if (settings.unconditionalSnapshot) {
+      return true
+    }
+
+    // If offline backup option is not checked
+    // and vm is running, we make a snapshot
+    if (!settings.offlineBackup && vm.power_state === 'Running') {
+      return true
+    }
+
+    // General setting used for snapshot retention
+    // see schedule in backupJob edition
+    if (settings.snapshotRetention !== 0) {
+      return true
+    }
+
+    const vdis = await this._xapi.getRecords('VDI', await vm.$getDisks())
+    const hasNOBAKtag = vdis.some(idx => idx.name_label.includes('[NOBAK]'))
+
+    // if there is a disk with NOBAK tag
+    // we need to make a snapshot
+    if (hasNOBAKtag) {
+      return true
+    }
   }
   _selectBaseVm() {}
 
@@ -43,10 +65,17 @@ 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 rarely 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
+
+      // xva files are tar archive with data cut in 1MB blocks
+      // each block is signed with a hash (in xxhash format)
+      // each of these blocks + hash add one tar header entry in the file
+      const XVA_BLOCK_SIZE = 1024 * 1024
+      const nbBlocks = Math.ceil(vdi.virtual_size / XVA_BLOCK_SIZE)
+      const headersSize = nbBlocks * (512 /* file header */ + 512 /* xxhash header */ + 512) /* xhxhash size */
+      maxStreamLength += XVA_BLOCK_SIZE * nbBlocks + headersSize
     }
 
     const sizeContainer = watchStreamSize(stream)

@xen-orchestra/backups/_runners/_vmRunners/IncrementalRemote.mjs

@@ -3,8 +3,6 @@ import { createLogger } from '@xen-orchestra/log'
 import { asyncEach } from '@vates/async-each'
 import assert from 'node:assert'
 import * as UUID from 'uuid'
-import isVhdDifferencingDisk from 'vhd-lib/isVhdDifferencingDisk.js'
-import mapValues from 'lodash/mapValues.js'
 
 import { AbstractRemote } from './_AbstractRemote.mjs'
 import { forkDeltaExport } from './_forkDeltaExport.mjs'
@@ -12,14 +10,16 @@ import { IncrementalRemoteWriter } from '../_writers/IncrementalRemoteWriter.mjs
 import { Disposable } from 'promise-toolbox'
 import { openVhd } from 'vhd-lib'
 import { getVmBackupDir } from '../../_getVmBackupDir.mjs'
+import { SynchronizedDisk, ThrottledDisk } from '@xen-orchestra/disk-transform'
+import { AggregatedIncrementalRemoteWriter } from '../_writers/AggregatedIncrementalRemoteWriter.mjs'
 
 const { warn } = createLogger('xo:backups:Incrementalremote')
 class IncrementalRemoteVmBackupRunner extends AbstractRemote {
-  _getRemoteWriter() {
-    return IncrementalRemoteWriter
+  _getRemoteWriters() {
+    return [IncrementalRemoteWriter, AggregatedIncrementalRemoteWriter]
   }
 
-  // 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))) {
@@ -37,7 +37,7 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
       return
     }
     await asyncEach(Object.entries(metadata.vdis), async ([id, vdi]) => {
-      const isDifferencing = metadata.isVhdDifferencing[`${id}.vhd`]
+      const isDifferencing = metadata.isVhdDifferencing[id]
       if (isDifferencing) {
         const vmDir = getVmBackupDir(metadata.vm.uuid)
         const path = `${vmDir}/${metadata.vhds[id]}`
@@ -71,9 +71,13 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
       // recompute if disks are differencing or not
       const isVhdDifferencing = {}
 
-      await asyncEach(Object.entries(incrementalExport.streams), async ([key, stream]) => {
-        isVhdDifferencing[key] = await isVhdDifferencingDisk(stream)
-      })
+      for (const key in incrementalExport.disks) {
+        let disk = incrementalExport.disks[key]
+        isVhdDifferencing[key] = disk.isDifferencing()
+        disk = new ThrottledDisk(disk, this._throttleGenerator)
+        incrementalExport.disks[key] = new SynchronizedDisk(disk)
+      }
+
       const hasDifferencingDisk = Object.values(isVhdDifferencing).includes(true)
       if (metadata.isBase === hasDifferencingDisk) {
         warn(`Metadata isBase and real disk value are different`, {
@@ -87,11 +91,10 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
       await this._selectBaseVm(metadata)
       await this._callWriters(writer => writer.prepare({ isBase: metadata.isBase }), 'writer.prepare()')
 
-      incrementalExport.streams = mapValues(incrementalExport.streams, this._throttleStream)
       await this._callWriters(
         writer =>
           writer.transfer({
-            deltaExport: forkDeltaExport(incrementalExport),
+            deltaExport: forkDeltaExport(incrementalExport, writer.constructor.name),
             isVhdDifferencing,
             timestamp: metadata.timestamp,
             vm: metadata.vm,
@@ -114,6 +117,7 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
       // for healthcheck
       this._tags = metadata.vm.tags
     }
+    this._hasTransferredData = transferList.length > 0
   }
 }
 

@xen-orchestra/backups/_runners/_vmRunners/IncrementalXapi.mjs

@@ -1,18 +1,12 @@
-import { asyncEach } from '@vates/async-each'
 import { createLogger } from '@xen-orchestra/log'
-import { pipeline } from 'node:stream'
-import isVhdDifferencingDisk from 'vhd-lib/isVhdDifferencingDisk.js'
 import keyBy from 'lodash/keyBy.js'
-import mapValues from 'lodash/mapValues.js'
-import vhdStreamValidator from 'vhd-lib/vhdStreamValidator.js'
 
 import { AbstractXapi } from './_AbstractXapi.mjs'
-import { exportIncrementalVm } from '../../_incrementalVm.mjs'
 import { forkDeltaExport } from './_forkDeltaExport.mjs'
+import { exportIncrementalVm } from '../../_incrementalVm.mjs'
 import { IncrementalRemoteWriter } from '../_writers/IncrementalRemoteWriter.mjs'
 import { IncrementalXapiWriter } from '../_writers/IncrementalXapiWriter.mjs'
 import { Task } from '../../Task.mjs'
-import { watchStreamSize } from '../../_watchStreamSize.mjs'
 import {
   DATETIME,
   DELTA_CHAIN_LENGTH,
@@ -20,16 +14,23 @@ import {
   setVmDeltaChainLength,
   markExportSuccessfull,
 } from '../../_otherConfig.mjs'
+import { ThrottledDisk, SynchronizedDisk } from '@xen-orchestra/disk-transform'
+import { AggregatedIncrementalRemoteWriter } from '../_writers/AggregatedIncrementalRemoteWriter.mjs'
+import { AggregatedIncrementalXapiWriter } from '../_writers/AggregatedIncrementalXapiWriter.mjs'
 
 const { debug } = createLogger('xo:backups:IncrementalXapiVmBackup')
-const noop = Function.prototype
 
 export const IncrementalXapi = class IncrementalXapiVmBackupRunner extends AbstractXapi {
   _getWriters() {
-    return [IncrementalRemoteWriter, IncrementalXapiWriter]
+    return [
+      IncrementalRemoteWriter,
+      IncrementalXapiWriter,
+      AggregatedIncrementalRemoteWriter,
+      AggregatedIncrementalXapiWriter,
+    ]
   }
 
-  _mustDoSnapshot() {
+  async _mustDoSnapshot() {
     return true
   }
 
@@ -45,42 +46,37 @@ export const IncrementalXapi = class IncrementalXapiVmBackupRunner extends Abstr
       nbdConcurrency: this._settings.nbdConcurrency,
       preferNbd: this._settings.preferNbd,
     })
-    // since NBD is network based, if one disk use nbd , all the disk use them
-    // except the suspended VDI
-    if (Object.values(deltaExport.streams).some(({ _nbd }) => _nbd)) {
+
+    const isVhdDifferencing = {}
+    let useNbd = false
+    for (const key in deltaExport.disks) {
+      let disk = deltaExport.disks[key]
+      isVhdDifferencing[key] = disk.isDifferencing()
+      if (!isFull && !isVhdDifferencing[key] && key !== exportedVm.$suspend_VDI?.$ref) {
+        Task.warning('Backup fell back to a full')
+      }
+      useNbd = useNbd || disk.useNbd()
+      disk = new ThrottledDisk(disk, this._throttleGenerator)
+      deltaExport.disks[key] = new SynchronizedDisk(disk)
+    }
+    if (useNbd) {
       Task.info('Transfer data using NBD')
     }
 
-    const isVhdDifferencing = {}
-    // since isVhdDifferencingDisk is reading and unshifting data in stream
-    // it should be done BEFORE any other stream transform
-    await asyncEach(Object.entries(deltaExport.streams), async ([key, stream]) => {
-      isVhdDifferencing[key] = await isVhdDifferencingDisk(stream)
-    })
-    const sizeContainers = mapValues(deltaExport.streams, stream => watchStreamSize(stream))
-
-    if (this._settings.validateVhdStreams) {
-      deltaExport.streams = mapValues(deltaExport.streams, stream => pipeline(stream, vhdStreamValidator, noop))
-    }
-    deltaExport.streams = mapValues(deltaExport.streams, this._throttleStream)
+    // @todo : reimplement throttle
 
     const timestamp = Date.now()
-
     await this._callWriters(
       writer =>
         writer.transfer({
-          deltaExport: forkDeltaExport(deltaExport),
+          deltaExport: forkDeltaExport(deltaExport, writer.constructor.name),
           isVhdDifferencing,
-          sizeContainers,
           timestamp,
           vm,
           vmSnapshot: exportedVm,
         }),
       'writer.transfer()'
     )
-
-    // we want to control the uuid of the vhd in the chain
-    // and ensure they are correctly chained
     await this._callWriters(
       writer =>
         writer.updateUuidAndChain({
@@ -102,15 +98,6 @@ export const IncrementalXapi = class IncrementalXapiVmBackupRunner extends Abstr
       await markExportSuccessfull(this._xapi, exportedVm.$ref)
     }
 
-    const size = Object.values(sizeContainers).reduce((sum, { size }) => sum + size, 0)
-    const end = Date.now()
-    const duration = end - timestamp
-    debug('transfer complete', {
-      duration,
-      speed: duration !== 0 ? (size * 1e3) / 1024 / 1024 / duration : 0,
-      size,
-    })
-
     await this._callWriters(writer => writer.cleanup(), 'writer.cleanup()')
   }
 

@xen-orchestra/backups/_runners/_vmRunners/_AbstractRemote.mjs

@@ -13,6 +13,8 @@ import { Task } from '../../Task.mjs'
 
 export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstract {
   _filterPredicate
+  _hasTransferredData
+
   constructor({
     config,
     job,
@@ -21,6 +23,7 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
     schedule,
     settings,
     sourceRemoteAdapter,
+    throttleGenerator,
     throttleStream,
     vmUuid,
   }) {
@@ -34,6 +37,7 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
 
     this._healthCheckSr = healthCheckSr
     this._sourceRemoteAdapter = sourceRemoteAdapter
+    this._throttleGenerator = throttleGenerator
     this._throttleStream = throttleStream
     this._vmUuid = vmUuid
 
@@ -41,26 +45,41 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
     const writers = new Set()
     this._writers = writers
 
-    const RemoteWriter = this._getRemoteWriter()
-    extractIdsFromSimplePattern(job.remotes).forEach(remoteId => {
-      const adapter = remoteAdapters[remoteId]
-      const targetSettings = {
-        ...settings,
-        ...allSettings[remoteId],
-      }
+    const [BackupWriter, AggregratedBackupWriter] = this._getRemoteWriters()
+    if (settings.distributeBackups) {
       writers.add(
-        new RemoteWriter({
-          adapter,
+        new AggregratedBackupWriter({
+          adapters: remoteAdapters,
+          BackupWriter,
           config,
           healthCheckSr,
           job,
           scheduleId: schedule.id,
           vmUuid,
-          remoteId,
-          settings: targetSettings,
+          settings,
         })
       )
-    })
+    } else {
+      extractIdsFromSimplePattern(job.remotes).forEach(remoteId => {
+        const adapter = remoteAdapters[remoteId]
+        const targetSettings = {
+          ...settings,
+          ...allSettings[remoteId],
+        }
+        writers.add(
+          new BackupWriter({
+            adapter,
+            config,
+            healthCheckSr,
+            job,
+            scheduleId: schedule.id,
+            vmUuid,
+            remoteId,
+            settings: targetSettings,
+          })
+        )
+      })
+    }
     const { filter } = job
     if (filter === undefined) {
       this._filterPredicate = () => true
@@ -70,28 +89,28 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
   }
 
   async #computeTransferListPerJob(sourceBackups, remotesBackups) {
-    const localMetada = new Map()
+    const localMetadata = new Map()
     sourceBackups.forEach(metadata => {
       const timestamp = metadata.timestamp
-      localMetada.set(timestamp, metadata)
+      localMetadata.set(timestamp, metadata)
     })
     const nbRemotes = remotesBackups.length
-    const remoteMetadatas = {}
+    const remoteMetadata = {}
     remotesBackups.forEach(async remoteBackups => {
       remoteBackups.forEach(metadata => {
         const timestamp = metadata.timestamp
-        remoteMetadatas[timestamp] = (remoteMetadatas[timestamp] ?? 0) + 1
+        remoteMetadata[timestamp] = (remoteMetadata[timestamp] ?? 0) + 1
       })
     })
 
     let transferList = []
-    const timestamps = [...localMetada.keys()]
+    const timestamps = [...localMetadata.keys()]
     timestamps.sort()
     for (const timestamp of timestamps) {
-      if (remoteMetadatas[timestamp] !== nbRemotes) {
+      if (remoteMetadata[timestamp] !== nbRemotes) {
         // this backup is not present in all the remote
-        // should be retransfered if not found later
-        transferList.push(localMetada.get(timestamp))
+        // should be retransferred if not found later
+        transferList.push(localMetadata.get(timestamp))
       } else {
         // backup is present in local and remote : the chain has already been transferred
         transferList = []
@@ -99,17 +118,10 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
     }
     if (transferList.length > 0) {
       const filteredTransferList = this._filterTransferList(transferList)
-      if (filteredTransferList.length > 0) {
-        return filteredTransferList
-      } else {
-        Task.info('This VM is excluded by the job filter')
-        return []
-      }
+      return { transferList: filteredTransferList, filtered: true }
     } else {
-      Task.info('No new data to upload for this VM')
+      return { transferList, filtered: false }
     }
-
-    return []
   }
 
   /**
@@ -123,12 +135,21 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
       Object.values(this.remoteAdapters).map(remoteAdapter => remoteAdapter.listVmBackups(this._vmUuid, vmPredicate))
     )
     const sourceBackupByJobId = groupBy(sourceBackups, 'jobId')
-    const transferByJobs = await Promise.all(
+    const transferObjectsList = await Promise.all(
       Object.values(sourceBackupByJobId).map(vmBackupsByJob =>
         this.#computeTransferListPerJob(vmBackupsByJob, remotesBackups)
       )
     )
-    return transferByJobs.flat(1)
+    const transferList = transferObjectsList.map(transferObject => transferObject.transferList).flat(1)
+    if (transferList.length === 0 && Object.values(sourceBackupByJobId).length > 0) {
+      if (transferObjectsList.some(transferObject => transferObject.filtered)) {
+        // Happens if any job transfer list wasn't empty before filter and is empty after filter.
+        Task.info('This VM is excluded by the job filter')
+      } else {
+        Task.info('No new data to upload for this VM')
+      }
+    }
+    return transferList
   }
 
   async run($defer) {
@@ -141,7 +162,16 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
         })
       }, 'writer.beforeBackup()')
       await this._run()
-      await this._healthCheck()
+
+      if (this._hasTransferredData === undefined) {
+        throw new Error('Missing tag to check there are some transferred data')
+      }
+
+      if (this._hasTransferredData) {
+        await this._healthCheck()
+      } else {
+        Task.info(`No healthCheck needed because no data was transferred.`)
+      }
     })
   }
 }

@xen-orchestra/backups/_runners/_vmRunners/_AbstractXapi.mjs

@@ -1,21 +1,20 @@
 import assert from 'node:assert'
 import groupBy from 'lodash/groupBy.js'
+import { createLogger } from '@xen-orchestra/log'
 import ignoreErrors from 'promise-toolbox/ignoreErrors'
 import { asyncMap } from '@xen-orchestra/async-map'
+import { asyncEach } from '@vates/async-each'
 import { decorateMethodsWith } from '@vates/decorate-with'
 import { defer } from 'golike-defer'
 
 import { getOldEntries } from '../../_getOldEntries.mjs'
 import { Task } from '../../Task.mjs'
 import { Abstract } from './_Abstract.mjs'
-import {
-  DATETIME,
-  JOB_ID,
-  SCHEDULE_ID,
-  populateVdisOtherConfig,
-  resetVmOtherConfig,
-  setVmOtherConfig,
-} from '../../_otherConfig.mjs'
+import { DATETIME, JOB_ID, SCHEDULE_ID, VM_UUID, resetVmOtherConfig, setVmOtherConfig } from '../../_otherConfig.mjs'
+
+const { warn, info } = createLogger('xo:backups:AbstractXapi')
+
+const TEMP_SNAPSHOT_NAME = 'xo-backup-temp-snapshot-name'
 
 export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
   constructor({
@@ -28,6 +27,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
     schedule,
     settings,
     srs,
+    throttleGenerator,
     throttleStream,
     vm,
   }) {
@@ -62,6 +62,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
     this._healthCheckSr = healthCheckSr
     this._jobId = job.id
     this._jobSnapshotVdis = undefined
+    this._throttleGenerator = throttleGenerator
     this._throttleStream = throttleStream
     this._xapi = vm.$xapi
 
@@ -81,48 +82,84 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
       const writers = new Set()
       this._writers = writers
 
-      const [BackupWriter, ReplicationWriter] = this._getWriters()
+      const [BackupWriter, ReplicationWriter, AggregratedBackupWriter, AggregratedReplicationWriter] =
+        this._getWriters()
 
       const allSettings = job.settings
-      Object.entries(remoteAdapters).forEach(([remoteId, adapter]) => {
-        const targetSettings = {
-          ...settings,
-          ...allSettings[remoteId],
-        }
-        if (targetSettings.exportRetention !== 0) {
+
+      if (settings.exportRetention > 0) {
+        if (settings.distributeBackups) {
           writers.add(
-            new BackupWriter({
-              adapter,
+            new AggregratedBackupWriter({
+              adapters: remoteAdapters,
+              BackupWriter,
               config,
               healthCheckSr,
               job,
               scheduleId: schedule.id,
               vmUuid: vm.uuid,
-              remoteId,
-              settings: targetSettings,
+              settings,
             })
           )
+        } else {
+          Object.entries(remoteAdapters).forEach(([remoteId, adapter]) => {
+            const targetSettings = {
+              ...settings,
+              ...allSettings[remoteId],
+            }
+            if (targetSettings.exportRetention !== 0) {
+              writers.add(
+                new BackupWriter({
+                  adapter,
+                  config,
+                  healthCheckSr,
+                  job,
+                  scheduleId: schedule.id,
+                  vmUuid: vm.uuid,
+                  remoteId,
+                  settings: targetSettings,
+                })
+              )
+            }
+          })
         }
-      })
-      srs.forEach(sr => {
-        const targetSettings = {
-          ...settings,
-          ...allSettings[sr.uuid],
-        }
-        if (targetSettings.copyRetention !== 0) {
+      }
+      if (settings.copyRetention) {
+        if (settings.distributeReplications) {
           writers.add(
-            new ReplicationWriter({
+            new AggregratedReplicationWriter({
               config,
               healthCheckSr,
               job,
+              ReplicationWriter,
               scheduleId: schedule.id,
               vmUuid: vm.uuid,
-              sr,
-              settings: targetSettings,
+              srs,
+              settings,
             })
           )
+        } else {
+          srs.forEach(sr => {
+            const targetSettings = {
+              ...settings,
+              ...allSettings[sr.uuid],
+            }
+            if (targetSettings.copyRetention !== 0) {
+              writers.add(
+                new ReplicationWriter({
+                  config,
+                  healthCheckSr,
+                  job,
+                  scheduleId: schedule.id,
+                  vmUuid: vm.uuid,
+                  sr,
+                  settings: targetSettings,
+                })
+              )
+            }
+          })
         }
-      })
+      }
     }
   }
 
@@ -141,14 +178,14 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
 
     const settings = this._settings
 
-    if (this._mustDoSnapshot()) {
+    if (await this._mustDoSnapshot()) {
       await Task.run({ name: 'snapshot' }, async () => {
         if (!settings.bypassVdiChainsCheck) {
           await vm.$assertHealthyVdiChains()
         }
-        if (settings.preferNbd) {
+        if (settings.cbtDestroySnapshotData) {
           try {
-            // enable CBT on all disks if possible
+            // enable CBT on all disks if we want to be able to purge snapshot data
             const diskRefs = await xapi.VM_getDisks(vm.$ref)
             await Promise.all(diskRefs.map(diskRef => xapi.callAsync('VDI.enable_cbt', diskRef)))
           } catch (error) {
@@ -158,7 +195,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
 
         const snapshotRef = await vm[settings.checkpointSnapshot ? '$checkpoint' : '$snapshot']({
           ignoredVdisTag: '[NOBAK]',
-          name_label: this._getSnapshotNameLabel(vm),
+          name_label: TEMP_SNAPSHOT_NAME,
           unplugVusbs: true,
         })
         this.timestamp = Date.now()
@@ -168,6 +205,9 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
           scheduleId: this.scheduleId,
           vmUuid: vm.uuid,
         })
+        const snapshot = await xapi.getRecord('VM', snapshotRef)
+        await snapshot.set_name_label(this._getSnapshotNameLabel(vm))
+        // reload data to ensure it is up to date with the new name label
         this._exportedVm = await xapi.getRecord('VM', snapshotRef)
         return this._exportedVm.uuid
       })
@@ -177,43 +217,113 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
     }
   }
 
+  // handle snapshot by VDI since snapshot of cbtDestroySnapshotData jobs
+  // aren't attached to any VM
+
+  // look at all the vdi snapshots ( snapshot_of not empty )
+  // with the same vm_uuid and job_uuid
+  //   for cbt_metadata list them unconditionnaly to remove older one
+  //   for other: only list them if they are attached to a VM snapshot
+  //  and if this vm snapshot is also part of the backup
+  //   ensure they are attached to only one vm snapshot
+  //   ensure any VM-snapshot harvested by this has all its disk harvested (no mix of vdi snapshot from this job and not)
+
   async _fetchJobSnapshots() {
     const jobId = this._jobId
-    const vmRef = this._vm.$ref
     const xapi = this._xapi
 
-    // to ensure compatibility with snapshots older than CBT implementation
-    // update vdi data to ensure the vdi are correctly fetched in _jobSnapshotVdis
-    // remove by then end of 2024
-    const vmSnapshotsRef = await xapi.getField('VM', vmRef, 'snapshots')
-    const vmSnapshotsOtherConfig = await asyncMap(vmSnapshotsRef, ref => xapi.getField('VM', ref, 'other_config'))
+    const vdiCandidates = {}
 
-    const vmSnapshots = []
-    vmSnapshotsOtherConfig.forEach((other_config, i) => {
-      if (other_config[JOB_ID] === jobId) {
-        vmSnapshots.push({ other_config, $ref: vmSnapshotsRef[i] })
-      }
-    })
-    await Promise.all(vmSnapshots.map(snapshot => populateVdisOtherConfig(xapi, snapshot.$ref)))
-    // end of compatibiliy handling
+    Object.values(xapi.objects.indexes.type.VDI)
+      .filter(_ => !!_) // filter nullish
+      .filter(({ other_config, $snapshot_of }) => {
+        return $snapshot_of !== undefined && other_config[JOB_ID] === jobId && other_config[VM_UUID] === this._vm.uuid
+      })
+      .forEach(vdi => {
+        vdiCandidates[vdi.uuid] = vdi
+      })
 
-    // handle snapshot by VDI
-    this._jobSnapshotVdis = []
-    const srcVdis = await xapi.getRecords('VDI', await this._vm.$getDisks())
-    for (const srcVdi of srcVdis) {
-      const snapshots = await xapi.getRecords('VDI', srcVdi.snapshots)
-      for (const snapshot of snapshots) {
-        // only keep the snapshot related to this backup job
-        // and only if the job is still using  purge snapshot data or if the disk
-        // is not a cbt metadata disk ( expect a type: user for normal disks)
-        if (
-          snapshot.other_config[JOB_ID] === jobId &&
-          (this._settings.cbtDestroySnapshotData || snapshot.type !== 'cbt_metadata')
-        ) {
-          this._jobSnapshotVdis.push(snapshot)
-        }
+    // check that user snapshots are clean
+
+    for (const vdi of Object.values(vdiCandidates)) {
+      // cbt metadata are always considered linked to a backup job
+      // if they have the right other_config
+      if (vdi.type === 'cbt_metadata') {
+        continue
       }
+      const vbds = vdi.$VBDs
+        .filter(({ $VM }) => !!$VM) // filter empty VMs
+        .filter(({ $VM }) => $VM.is_control_domain === false) // do not handle control domain
+      if (vbds.length === 0) {
+        // orphan vdi snapshot
+        info(
+          `disk snapshot ${vdi.name_label} is orphan or attached only to control domain,
+          it will be removed at the end of a successful backup run`,
+          { vdi, attachedto: vdi.$VBDs.map(vbd => vbd?.$VM) }
+        )
+        continue
+      }
+      const userVms = vbds.map(({ $VM }) => $VM)
+      if (vbds.length > 1) {
+        warn(
+          `vdi ${vdi.name_label} (${vdi.uuid}) is linked to multipe vms :  ${userVms.map(({ name_label, uuid }) => `${name_label} ${uuid}`).join(', ')}. 
+              This disk snapshot will be excluded from the backup cleaning`,
+          { vdi, userVms }
+        )
+        delete vdiCandidates[vdi.uuid]
+        continue
+      }
+
+      const vm = vbds[0].$VM
+
+      // xapi has some issue regarding vdi snapshot attached to non snapshot VM
+      // it can also be some user action forcibely linking a vdi snapshot to a vm
+      // => we exclude these from the backup processing
+      if (vm.$snapshot_of === undefined) {
+        warn(
+          `vdi ${vdi.name_label} (${vdi.uuid}) is a snapshot linked to a non snapshot vm ${vm.name_label} ${vm.uuid}. 
+          This disk snapshot will be excluded from the backup cleaning`,
+          { vdi, vm }
+        )
+        delete vdiCandidates[vdi.uuid]
+        continue
+      }
+
+      // vdi is attached only to a snapshot that is not a backup snapshot
+      // we don't check scheduleId since we are looking for all the snapshot of this job
+      // => excludes from the list to be cleared
+      if (
+        vm.other_config[DATETIME] !== vdi.other_config[DATETIME] ||
+        vm.other_config[JOB_ID] !== vdi.other_config[JOB_ID] ||
+        vm.other_config[VM_UUID] !== vdi.other_config[VM_UUID]
+      ) {
+        warn(
+          `vdi ${vdi.name_label} (${vdi.uuid}) is a snapshot linked to a snapshot vm ${vm.name_label} ${vm.uuid} out of this backup job scope. 
+          This disk snapshot will be excluded from the backup cleaning`,
+          { vdi, vm }
+        )
+        delete vdiCandidates[vdi.uuid]
+        continue
+      }
+
+      // check if all the disks of these VM snapshot have been harvested
+      // if not => remove it from the list to ensure we won't half destroy VM later
+      vm.$VBDs
+        .filter(({ $VDI }) => !!$VDI) // filter missing keys
+        .filter(({ $VDI }) => $VDI && vdiCandidates[$VDI.uuid] === undefined)
+        .forEach(({ $VDI: outOfSnapshotsVdi, ...other }) => {
+          warn(
+            `vdi ${vdi.name_label} ${vdi.uuid} is recognized as a snapshot of the backup job,
+           linked to vm ${vm.name_label} ${vm.uuid} but vdi ${outOfSnapshotsVdi.name_label} ${outOfSnapshotsVdi.uuid} 
+           is not linked to the job. This disk snapshot will be excluded from the backup cleaning`,
+            { vdi, vm, vbds, outOfSnapshotsVdi }
+          )
+          // this will be called multiple time but it is not really an issue
+          delete vdiCandidates[vdi.uuid]
+        })
     }
+
+    this._jobSnapshotVdis = Object.values(vdiCandidates)
   }
 
   async _removeUnusedSnapshots() {
@@ -253,28 +363,47 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
           return
         }
         const vdis = snapshotPerDatetime[datetime]
-        let vmRef
+        let vm
         // if there is an attached VM => destroy the VM (Non CBT backups)
         for (const vdi of vdis) {
           const vbds = vdi.$VBDs.filter(({ $VM }) => $VM.is_control_domain === false)
           if (vbds.length > 0) {
             // only one VM linked to this vdi
             // this will throw error for VDI still attached to control domain
+            // since we won't be able to remove an attached VDI
             assert.strictEqual(vbds.length, 1, 'VDI must be free or attached to exactly one VM')
-            const vm = vbds[0].$VM
-            assert.strictEqual(vm.is_a_snapshot, true, `VM must be a snapshot`) // don't delete a VM (especially a control domain)
-
-            const vmRefVdi = vm.$ref
-            // same vm than other vdi of the same batch
-            assert.ok(
-              vmRef === undefined || vmRef === vmRefVdi,
-              '_removeUnusedSnapshots don t handle vdi related to multiple VMs '
-            )
-            vmRef = vmRefVdi
+            const vdiVm = vbds[0].$VM
+            if (vdiVm.$snapshot_of === undefined) {
+              // don't delete a VM (especially a control domain)
+              warn(
+                `VM ${vdiVm.uuid} (${vdiVm.name_label}) linked to VDI ${vdi.uuid} (${vdi.name_label}) should be a snapshot`
+              )
+              throw new Error(`VM must be a snapshot`)
+            }
+            if (vm !== undefined && vm.$ref !== vdiVm.$ref) {
+              // this VDI is attached to another VM than the other vdi of
+              // this batch
+              // in doubt, do not delete anything
+              warn("_removeUnusedSnapshots don't handle vdi related to multiple VMs ", {
+                vm1: {
+                  label: vm.name_label,
+                  id: vm.$id,
+                },
+                vm2: {
+                  label: vdiVm.name_label,
+                  id: vdiVm.$id,
+                },
+                vdis: vdis.map(({ name_label, $id }) => ({ name_label, $id })),
+              })
+              throw new Error(
+                `_removeUnusedSnapshots don't handle vdi related to multiple VMs ${vm.name_label} and ${vdiVm.name_label}`
+              )
+            }
+            vm = vdiVm
           }
         }
-        if (vmRef !== undefined) {
-          return xapi.VM_destroy(vmRef)
+        if (vm?.$ref !== undefined) {
+          return xapi.VM_destroy(vm.$ref)
         } else {
           return asyncMap(
             vdis.map(async ({ $ref }) => {
@@ -284,6 +413,11 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
         }
       })
     })
+
+    // list and remove the snapshot were the jobs failed between
+    // makesnapshot and update_other_config
+    const snapshots = this._vm.$snapshots.filter(_ => !!_).filter(({ name_label }) => name_label === TEMP_SNAPSHOT_NAME)
+    await asyncEach(snapshots, snapshot => snapshot.$destroy())
   }
 
   async _removeSnapshotData() {
@@ -291,14 +425,15 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
     // 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 (
+      this._exportedVm !== undefined &&
       // don't modify the VM
-      this._exportedVm?.is_a_snapshot &&
+      this._exportedVm.$snapshot_of !== undefined &&
       // 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
+      // only delete snapshot data if the config allows it
       this._settings.cbtDestroySnapshotData
     ) {
       Task.info('will delete snapshot data')
@@ -324,7 +459,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
     throw new Error('Not implemented')
   }
 
-  _mustDoSnapshot() {
+  async _mustDoSnapshot() {
     throw new Error('Not implemented')
   }
 

@xen-orchestra/backups/_runners/_vmRunners/_forkDeltaExport.mjs

@@ -1,11 +1,16 @@
+import { SynchronizedDisk } from '@xen-orchestra/disk-transform'
 import cloneDeep from 'lodash/cloneDeep.js'
-import mapValues from 'lodash/mapValues.js'
 
-import { forkStreamUnpipe } from '../_forkStreamUnpipe.mjs'
-
-export function forkDeltaExport(deltaExport) {
-  const { streams, ...rest } = deltaExport
-  const newMetadata = cloneDeep(rest)
-  newMetadata.streams = mapValues(streams, forkStreamUnpipe)
-  return newMetadata
+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
 }

@xen-orchestra/backups/_runners/_writers/AggregatedFullRemoteWriter.mjs

@@ -0,0 +1,38 @@
+import { AbstractAggregatedRemoteWriter } from './_AbstractAggregatedRemoteWriter.mjs'
+
+export class AggregatedFullRemoteWriter extends AbstractAggregatedRemoteWriter {
+  async deleteOldBackupsOnAdapter(adapter, backups) {
+    await adapter.deleteFullVmBackups(backups)
+  }
+
+  // take the lock on every adapters with this VM
+  // cleanup if deleteFirst is selected
+  async beforeBackup() {
+    await this.setupWriters()
+    await Promise.all(this.writers.map(writer => writer.beforeBackup()))
+
+    await this.setOldBackups()
+    if (this.props.settings.deleteFirst) {
+      await this.deleteOldBackups()
+    }
+  }
+
+  async run(props) {
+    const mainAdapter = await this.computeAdapterCandidate()
+    this.mainWriter = this.getWriterByAdapter(mainAdapter)
+    return this.mainWriter.run(props)
+  }
+
+  // cleanup if deleteFirst is NOT selected
+  // release  the lock on every adapters with this VM
+  async afterBackup() {
+    if (!this.props.settings.deleteFirst) {
+      await this.deleteOldBackups()
+    }
+    await Promise.all(this.writers.map(writer => writer.afterBackup()))
+  }
+
+  healthCheck() {
+    return this.mainWriter.healthCheck()
+  }
+}

@xen-orchestra/backups/_runners/_writers/AggregatedFullXapiWriter.mjs

@@ -0,0 +1,31 @@
+import { AbstractAggregatedXapiWriter } from './_AbstractAggregatedXapiWriter.mjs'
+
+export class AggregatedFullXapiWriter extends AbstractAggregatedXapiWriter {
+  // delete replica if deleteFirst is selected
+  async beforeBackup() {
+    await this.setupWriters()
+    await Promise.all(this.writers.map(writer => writer.beforeBackup()))
+    this.setOldReplicaList()
+    if (this.props.settings.deleteFirst) {
+      await this.deleteOldReplicas()
+    }
+  }
+
+  async run(props) {
+    const mainSr = await this.computeSRCandidate()
+    this.mainWriter = this.getWriterBySr(mainSr)
+    await this.mainWriter.run(props)
+  }
+
+  // delete replica if not using deleteFirst
+  async afterBackup() {
+    if (!this.props.settings.deleteFirst) {
+      await this.deleteOldReplicas()
+    }
+    await Promise.all(this.writers.map(writer => writer.afterBackup()))
+  }
+
+  healthCheck() {
+    return this.mainWriter.healthCheck()
+  }
+}

@xen-orchestra/backups/_runners/_writers/AggregatedIncrementalRemoteWriter.mjs

@@ -0,0 +1,78 @@
+import { AbstractAggregatedRemoteWriter } from './_AbstractAggregatedRemoteWriter.mjs'
+export class AggregatedIncrementalRemoteWriter extends AbstractAggregatedRemoteWriter {
+  async deleteOldBackupsOnAdapter(adapter, backups) {
+    await adapter.deleteDeltaVmBackups(backups)
+  }
+
+  /**
+   *
+   * @param {Map<string,string>} baseUuidToSrcVdi
+   */
+  async checkBaseVdis(baseUuidToSrcVdi) {
+    let selectedCopy = new Map()
+    for (const writer of this.writers) {
+      const copy = new Map(baseUuidToSrcVdi)
+      await writer.checkBaseVdis(copy)
+      if (copy.size > 0) {
+        // there can be multiple candidates
+        // we use the last one in this case
+        this.mainWriter = writer
+        selectedCopy = copy
+      }
+    }
+    // update the parameter with our best candidate
+    // that can be an empty map
+    baseUuidToSrcVdi.forEach(key => {
+      if (!selectedCopy.has(key)) {
+        baseUuidToSrcVdi.delete(key)
+      }
+    })
+  }
+
+  // take the lock on every adapters with this VM
+  // cleanup if deleteFirst is selected
+  async beforeBackup() {
+    await this.setupWriters()
+    await Promise.all(this.writers.map(writer => writer.beforeBackup()))
+
+    await this.setOldBackups()
+    if (this.props.settings.deleteFirst) {
+      await this.deleteOldBackups()
+    }
+  }
+
+  async prepare({ isFull }) {
+    if (this.mainWriter === undefined) {
+      // use the remote with the most empty space for starting a new chain
+      const mainAdapter = await this.computeAdapterCandidate()
+      this.mainWriter = this.getWriterByAdapter(mainAdapter)
+    }
+    await Promise.all(this.writers.map(writer => writer.prepare({ isFull })))
+  }
+  // write only on the main writer
+  transfer({ isVhdDifferencing, timestamp, deltaExport, vm, vmSnapshot }) {
+    return this.mainWriter.transfer({ isVhdDifferencing, timestamp, deltaExport, vm, vmSnapshot })
+  }
+
+  // chain only on the main writer
+  updateUuidAndChain({ isVhdDifferencing, vdis }) {
+    return this.mainWriter.updateUuidAndChain({ isVhdDifferencing, vdis })
+  }
+
+  // remove the backups and remove the entries
+  async cleanup() {
+    if (!this.props.settings.deleteFirst) {
+      await this.deleteOldBackups()
+    }
+    await Promise.all(this.writers.map(writer => writer.cleanup()))
+  }
+  // cleanVM on all, since we may want to delete a chani
+  // that is not on the main writer
+  async afterBackup() {
+    await Promise.all(this.writers.map(writer => writer.afterBackup()))
+  }
+
+  healthCheck() {
+    return this.mainWriter.healthCheck()
+  }
+}

@xen-orchestra/backups/_runners/_writers/AggregatedIncrementalXapiWriter.mjs

@@ -0,0 +1,85 @@
+import { AbstractAggregatedXapiWriter } from './_AbstractAggregatedXapiWriter.mjs'
+import { createLogger } from '@xen-orchestra/log'
+
+const { debug } = createLogger('xo:backups:AggregatedIncrementalXapiWriter')
+export class AggregatedIncrementalXapiWriter extends AbstractAggregatedXapiWriter {
+  /**
+   *
+   * @param {Map<string,string>} baseUuidToSrcVdi
+   */
+  async checkBaseVdis(baseUuidToSrcVdi) {
+    debug('checkBaseVdis', { baseUuidToSrcVdi })
+    let selectedCopy = new Map()
+    for (const writer of this.writers) {
+      const copy = new Map(baseUuidToSrcVdi)
+      await writer.checkBaseVdis(copy)
+      if (copy.size > 0) {
+        debug('checkBaseVdis found a mainwriter candidate ', writer._sr.name_label)
+        // there can be multiple candidates
+        // we use the last one in this case
+        this.mainWriter = writer
+        selectedCopy = copy
+      } else {
+        debug(writer._sr.name_label, 'is not a delta candidate')
+      }
+    }
+    // update the parameter with our best candidate
+    // that can be an empty map
+    baseUuidToSrcVdi.forEach(key => {
+      if (!selectedCopy.has(key)) {
+        baseUuidToSrcVdi.delete(key)
+      }
+    })
+    debug('checkBaseVdis', { baseUuidToSrcVdi })
+  }
+
+  // take the lock on every adapters with this VM
+  // cleanup if deleteFirst is selected
+  async beforeBackup() {
+    await this.setupWriters()
+    await Promise.all(this.writers.map(writer => writer.beforeBackup()))
+    this.setOldReplicaList()
+    if (this.props.settings.deleteFirst) {
+      await this.deleteOldReplicas()
+    }
+  }
+
+  async prepare(args) {
+    if (this.mainWriter === undefined) {
+      debug('no mainwriter found, fallback to a new SR')
+      // use the SR with the most empty space for starting a new chain
+      const mainSr = await this.computeSRCandidate()
+      this.mainWriter = this.getWriterBySr(mainSr)
+    }
+    await Promise.all(this.writers.map(writer => writer.prepare(args)))
+  }
+
+  // write only on the main writer
+  transfer(args) {
+    return this.mainWriter.transfer(args)
+  }
+
+  // chain only on the main writer
+  updateUuidAndChain(args) {
+    return this.mainWriter.updateUuidAndChain(args)
+  }
+
+  // remove the backups and remove the entries
+  async cleanup() {
+    debug('cleanup')
+    if (!this.props.settings.deleteFirst) {
+      await this.deleteOldReplicas()
+    }
+    await Promise.all(this.writers.map(writer => writer.cleanup()))
+  }
+
+  // cleanVM on all, since we may want to delete a chani
+  // that is not on the main writer
+  async afterBackup() {
+    await Promise.all(this.writers.map(writer => writer.afterBackup()))
+  }
+
+  healthCheck() {
+    return this.mainWriter.healthCheck()
+  }
+}

@xen-orchestra/backups/_runners/_writers/FullRemoteWriter.mjs

@@ -33,7 +33,7 @@ export class FullRemoteWriter extends MixinRemoteWriter(AbstractFullWriter) {
     let metadata = await this._isAlreadyTransferred(timestamp)
     if (metadata !== undefined) {
       // @todo : should skip backup while being vigilant to not stuck the forked stream
-      Task.info('This backup has already been transfered')
+      Task.info('This backup has already been transferred')
     }
 
     const oldBackups = getOldEntries(
@@ -59,8 +59,8 @@ export class FullRemoteWriter extends MixinRemoteWriter(AbstractFullWriter) {
       xva: './' + dataBasename,
     }
 
-    const { deleteFirst } = settings
-    if (deleteFirst) {
+    const { skipDeleteOldEntries, deleteFirst } = settings
+    if (!skipDeleteOldEntries && deleteFirst) {
       await deleteOldBackups()
     }
 
@@ -73,9 +73,10 @@ export class FullRemoteWriter extends MixinRemoteWriter(AbstractFullWriter) {
       return { size: sizeContainer.size }
     })
     metadata.size = sizeContainer.size
+    metadata.tags = await this.getLongTermRetentionTags(metadata)
     this._metadataFileName = await adapter.writeVmBackupMetadata(vm.uuid, metadata)
 
-    if (!deleteFirst) {
+    if (!skipDeleteOldEntries && !deleteFirst) {
       await deleteOldBackups()
     }
 

@xen-orchestra/backups/_runners/_writers/FullXapiWriter.mjs

@@ -46,8 +46,8 @@ export class FullXapiWriter extends MixinXapiWriter(AbstractFullWriter) {
     const oldVms = getOldEntries(settings.copyRetention - 1, listReplicatedVms(xapi, scheduleId, srUuid, vm.uuid))
 
     const deleteOldBackups = () => asyncMapSettled(oldVms, vm => xapi.VM_destroy(vm.$ref))
-    const { deleteFirst, _warmMigration } = settings
-    if (deleteFirst) {
+    const { deleteFirst, skipDeleteOldEntries, _warmMigration } = settings
+    if (!skipDeleteOldEntries && deleteFirst) {
       await deleteOldBackups()
     }
 
@@ -85,7 +85,7 @@ export class FullXapiWriter extends MixinXapiWriter(AbstractFullWriter) {
       }),
     ])
 
-    if (!deleteFirst) {
+    if (!skipDeleteOldEntries && !deleteFirst) {
       await deleteOldBackups()
     }
   }

@xen-orchestra/backups/_runners/_writers/IncrementalRemoteWriter.mjs

@@ -114,13 +114,13 @@ export class IncrementalRemoteWriter extends MixinRemoteWriter(AbstractIncrement
       oldEntries.length = maxMergedDeltasPerRun
     }
 
-    if (settings.deleteFirst) {
+    if (settings.deleteFirst && !settings.skipDeleteOldEntries) {
       await this._deleteOldEntries()
     }
   }
 
   async cleanup() {
-    if (!this._settings.deleteFirst) {
+    if (!this._settings.deleteFirst && !this._settings.skipDeleteOldEntries) {
       await this._deleteOldEntries()
     }
   }
@@ -136,7 +136,7 @@ export class IncrementalRemoteWriter extends MixinRemoteWriter(AbstractIncrement
     const { handler } = this._adapter
     const vhds = this.#vhds
     await asyncEach(Object.entries(vdis), async ([id, vdi]) => {
-      const isDifferencing = isVhdDifferencing[`${id}.vhd`]
+      const isDifferencing = isVhdDifferencing[id]
       const path = `${this._vmBackupDir}/${vhds[id]}`
       if (isDifferencing) {
         assert.notStrictEqual(
@@ -202,9 +202,8 @@ export class IncrementalRemoteWriter extends MixinRemoteWriter(AbstractIncrement
 
     let metadataContent = await this._isAlreadyTransferred(timestamp)
     if (metadataContent !== undefined) {
-      // skip backup while being vigilant to not stuck the forked stream
-      Task.info('This backup has already been transfered')
-      Object.values(deltaExport.streams).forEach(stream => stream.destroy())
+      // skip backup while being vigilant to not stuck the forked disk
+      await Promise.all(Object.values(deltaExport.disks).map(async disk => disk.close()))
       return { size: 0 }
     }
 
@@ -223,36 +222,34 @@ export class IncrementalRemoteWriter extends MixinRemoteWriter(AbstractIncrement
       vmSnapshot,
       vtpms: deltaExport.vtpms,
     }
-
-    const { size } = await Task.run({ name: 'transfer' }, async () => {
-      let transferSize = 0
+    let size = 0
+    await Task.run({ name: 'transfer' }, async () => {
       await asyncEach(
-        Object.keys(deltaExport.vdis),
-        async id => {
-          const path = `${this._vmBackupDir}/${vhds[id]}`
-          // don't write it as transferSize += await async function
-          // since i += await asyncFun lead to race condition
-          // as explained : https://eslint.org/docs/latest/rules/require-atomic-updates
-          const transferSizeOneDisk = await adapter.writeVhd(path, deltaExport.streams[`${id}.vhd`], {
+        Object.entries(deltaExport.disks),
+        async ([diskRef, disk]) => {
+          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,
           })
-          transferSize += transferSizeOneDisk
+          size = size + disk.getNbGeneratedBlock() * disk.getBlockSize()
         },
         {
           concurrency: settings.diskPerVmConcurrency,
         }
       )
 
-      return { size: transferSize }
+      return { size }
     })
-    metadataContent.size = size
+    metadataContent.tags = await this.getLongTermRetentionTags(metadataContent)
+    metadataContent.size = size // @todo return exactly the size written by this writer
     this._metadataFileName = await adapter.writeVmBackupMetadata(vm.uuid, metadataContent)
 
     // TODO: run cleanup?
+    return { size }
   }
 }
 decorateClass(IncrementalRemoteWriter, {