@xen-orchestra/backups 0.72.0 → 0.73.0

package/disks/RemoteVhdDiskChain.mjs

@@ -1,304 +0,0 @@
-// @ts-check
-
-/**
- * @typedef {import('./RemoteVhdDisk.mjs').VhdFooter} VhdFooter
- * @typedef {import('./RemoteVhdDisk.mjs').RemoteVhdDisk} RemoteVhdDisk
- * @typedef {import('@xen-orchestra/disk-transform').DiskBlock} DiskBlock
- * @typedef {import('@xen-orchestra/disk-transform').FileAccessor} FileAccessor
- */
-
-import { RemoteDisk } from './RemoteDisk.mjs'
-
-export class RemoteVhdDiskChain extends RemoteDisk {
-  /**
-   * @type {RemoteVhdDisk[]}
-   */
-  #disks
-
-  /**
-   * @type {number}
-   */
-  #blockSize = 2 * 1024 * 1024
-
-  /**
-   * @type {number}
-   */
-  #headerSize = 1024
-
-  /**
-   * @type {number}
-   */
-  #footerSize = 512
-
-  /**
-   * @type {number}
-   */
-  #bitmapSize = 512
-
-  /**
-   * @param {Object} params
-   * @param {FileAccessor} params.handler
-   * @param {RemoteVhdDisk[]} params.disks
-   */
-  constructor({ disks }) {
-    super()
-    this.#disks = disks
-  }
-
-  /**
-   * Initializes the VHD chain
-   * @param {Object} options
-   * @param {boolean} options.force
-   * @returns {Promise<void>}
-   */
-  async init(options) {
-    try {
-      await Promise.all(this.#disks.map(disk => disk.init(options)))
-      let parentUuid = ''
-      for (const [index, disk] of this.#disks.entries()) {
-        if (index !== 0) {
-          if (!disk.isDifferencing()) {
-            throw Object.assign(new Error("Can't init vhd directory with non differencing child disks"), {
-              code: 'NOT_SUPPORTED',
-            })
-          }
-          if (disk.getParentUuid() !== parentUuid) {
-            throw Object.assign(new Error("Can't init vhd directory with incorrect parentage"), {
-              code: 'NOT_SUPPORTED',
-            })
-          }
-        }
-
-        parentUuid = disk.getUuid()
-      }
-    } catch (error) {
-      await this.close()
-      throw error
-    }
-  }
-
-  /**
-   * Closes the VHD.
-   * @returns {Promise<void>}
-   */
-  async close() {
-    await Promise.all(this.#disks.map(disk => disk.close()))
-  }
-
-  /**
-   * @returns {number}
-   */
-  getVirtualSize() {
-    return this.#disks[this.#disks.length - 1].getVirtualSize()
-  }
-
-  /**
-   * @returns {number} size
-   */
-  getSizeOnDisk() {
-    const batEntrySize = 4
-    const sectorSize = 512
-    const batSize = Math.ceil((this.getMaxBlockCount() * batEntrySize) / sectorSize) * sectorSize
-
-    return (
-      this.#footerSize +
-      this.#headerSize +
-      batSize +
-      this.getBlockIndexes().length * (this.#blockSize + this.#bitmapSize) +
-      this.#footerSize
-    )
-  }
-
-  /**
-   * @returns {number}
-   */
-  getBlockSize() {
-    return this.#disks[this.#disks.length - 1].getBlockSize()
-  }
-
-  /**
-   * @returns {string}
-   */
-  getPath() {
-    return this.#disks[this.#disks.length - 1].getPath()
-  }
-
-  /**
-   * Disk chains return an array of disk paths.
-   *
-   * @returns {string[]}
-   */
-  getPaths() {
-    return this.#disks.map(disk => disk.getPath())
-  }
-
-  /**
-   * @returns {string}
-   */
-  getUuid() {
-    return this.#disks[this.#disks.length - 1].getUuid()
-  }
-
-  /**
-   * @returns {Promise<boolean>} canMergeConcurently
-   */
-  async canMergeConcurently() {
-    return this.isDirectory()
-  }
-
-  /**
-   * @returns {number} getMaxBlockCount
-   */
-  getMaxBlockCount() {
-    return this.#disks[this.#disks.length - 1].getMaxBlockCount()
-  }
-
-  /**
-   * Checks if the VHD contains a specific block.
-   * @param {number} index
-   * @returns {boolean}
-   */
-  hasBlock(index) {
-    for (const disk of this.#disks) {
-      if (disk.hasBlock(index)) {
-        return true
-      }
-    }
-
-    return false
-  }
-
-  /**
-   * Gets the indexes of all blocks in the VHD.
-   * @returns {Array<number>}
-   */
-  getBlockIndexes() {
-    const indexes = new Set()
-    for (const disk of this.#disks) {
-      for (const index of disk.getBlockIndexes()) {
-        indexes.add(index)
-      }
-    }
-    return [...indexes]
-  }
-
-  /**
-   * Returns the parent non inizialized instance
-   * @returns {RemoteDisk}
-   */
-  instantiateParent() {
-    return this.#disks[0].instantiateParent()
-  }
-
-  /**
-   * Writes a full block into this VHD.
-   * @param {DiskBlock} diskBlock
-   * @return {Promise<number>} blockSize
-   */
-  async writeBlock(diskBlock) {
-    throw new Error(`Can't write blocks into a disk chain`)
-  }
-
-  /**
-   * Reads a specific block from the VHD.
-   * @param {number} index
-   * @returns {Promise<DiskBlock>} diskBlock
-   */
-  async readBlock(index) {
-    const reversedDisks = this.#disks.slice().reverse()
-    for (const disk of reversedDisks) {
-      if (disk.hasBlock(index)) {
-        return disk.readBlock(index)
-      }
-    }
-    throw new Error(`Block ${index} not found in chain `)
-  }
-
-  /**
-   * Reads a specific block from the child disk to copy/move it to this disk.
-   * @param {RemoteDisk} childDisk
-   * @param {number} index
-   * @param {boolean} isResumingMerge
-   * @returns {Promise<number>} blockSize
-   */
-  async mergeBlock(childDisk, index, isResumingMerge) {
-    throw new Error(`Can't merge block into a disk chain`)
-  }
-
-  /**
-   * Gets a specific block path from the VHD directory disk.
-   * @param {number} index
-   * @returns {string} blockPath
-   */
-  getBlockPath(index) {
-    for (const disk of [...this.#disks].reverse()) {
-      if (disk.hasBlock(index)) {
-        return disk.getBlockPath(index)
-      }
-    }
-
-    throw new Error(`Block ${index} not found in chain`)
-  }
-
-  /**
-   * @returns {VhdFooter}
-   */
-  getMetadata() {
-    return this.#disks[this.#disks.length - 1].getMetadata()
-  }
-
-  /**
-   * @param {RemoteVhdDisk} childDisk
-   * @returns {Promise<void>}
-   */
-  async flushMetadata(childDisk) {
-    throw new Error(`Can't flush metadata on a disk chain`)
-  }
-
-  /**
-   * @param {RemoteVhdDisk} childDisk
-   * @returns {Promise<void>}
-   */
-  mergeMetadata(childDisk) {
-    throw new Error(`Can't merge metadata on a disk chain`)
-  }
-
-  /**
-   * Checks if the VHD is a differencing disk.
-   * @returns {boolean}
-   */
-  isDifferencing() {
-    return this.#disks[0].isDifferencing()
-  }
-
-  /**
-   * Abstract
-   * Rename alias/disk
-   * @param {string} newPath
-   */
-  async rename(newPath) {
-    throw new Error(`Can't rename a disk chain`)
-  }
-
-  /**
-   * Deletes all the disks
-   */
-  async unlink() {
-    for (const disk of this.#disks) {
-      await disk.unlink()
-    }
-  }
-
-  /**
-   * Check if all the disks in the chain are VHD directories.
-   * @returns {Promise<boolean>}
-   */
-  async isDirectory() {
-    for (const disk of this.#disks) {
-      if (!(await disk.isDirectory())) {
-        return false
-      }
-    }
-    return true
-  }
-}

package/disks/index.mjs

@@ -1,49 +0,0 @@
-import { RemoteVhdDisk } from './RemoteVhdDisk.mjs'
-
-export { RemoteDisk } from './RemoteDisk.mjs'
-export { openDiskChain } from './openDiskChain.mjs'
-
-/**
- * @typedef {import('../../disk-transform/src/FileAccessor.mjs').FileAccessor} FileAccessor
- * @typedef {import('./RemoteDisk.mjs').RemoteDisk} RemoteDisk
- */
-
-/**
- * @param {Object} params
- * @param {FileAccessor} params.handler
- * @param {string} params.path
- * @returns {Promise<RemoteDisk>}
- */
-export async function openDisk({ handler, path }) {
-  const disk = new RemoteVhdDisk({ handler, path })
-  await disk.init()
-  return disk
-}
-/**
- *
- * @param {Object} params
- * @param {FileAccessor} params.handler
- * @param {string} params.path
- * @returns {Promise<Disposable<RemoteDisk>>}
- */
-export async function openDisposableDisk({ handler, path }) {
-  const disk = new RemoteVhdDisk({ handler, path })
-  await disk.init()
-  return {
-    value: disk,
-    dispose: () => disk.close(),
-  }
-}
-
-const DISK_EXTENSIONS = ['.vhd']
-
-/**
- * Returns true if the path points to a supported disk format.
- *
- * @param {FileAccessor} _handler - Remote file handler (reserved for future use)
- * @param {string} path - Path to check
- * @returns {boolean}
- */
-export function isDisk(_handler, path) {
-  return DISK_EXTENSIONS.some(ext => path.endsWith(ext))
-}

package/disks/openDiskChain.mjs

@@ -1,40 +0,0 @@
-// @ts-check
-/**
- *
- * @typedef {import('../../disk-transform/src/FileAccessor.mjs').FileAccessor} FileAccessor
- * @typedef {import('./RemoteDisk.mjs').RemoteDisk} RemoteDisk
- */
-import { DiskChain } from '@xen-orchestra/disk-transform'
-import { RemoteVhdDisk } from './RemoteVhdDisk.mjs'
-
-import { defer } from 'golike-defer'
-/**
- * @param {any} $defer
- * @param {Object} params
- * @param {FileAccessor} params.handler
- * @param {string} params.path
- * @param {string | undefined} params.until
- */
-async function _openDiskChain($defer, { handler, path, until }) {
-  let disk
-  /**
-   * @type {Array<RemoteDisk>}
-   */
-  const disks = []
-  $defer.onFailure(() => Promise.all(disks.map(disk => disk.close())))
-  disk = new RemoteVhdDisk({ handler, path })
-
-  await disk.init()
-  disks.push(disk)
-  while (disk.isDifferencing()) {
-    disk = await disk.openParent()
-    if (disk.getPath() === until) {
-      break
-    }
-    disks.unshift(disk)
-  }
-  // the root disk
-  return new DiskChain({ disks })
-}
-
-export const openDiskChain = defer(_openDiskChain)