fix(xo-server-auth-ldap): get name from LDAP record not user input

Fixes vatesfr/xo-web#1655

.editorconfig

@@ -3,63 +3,12 @@
 # Julien Fontanet's configuration
 # https://gist.github.com/julien-f/8096213
 
-# Top-most EditorConfig file.
 root = true
 
-# Common config.
 [*]
 charset = utf-8
 end_of_line = lf
+indent_size = 2
+indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
-
-# CoffeeScript
-#
-# https://github.com/polarmobile/coffeescript-style-guide/blob/master/README.md
-[*.{,lit}coffee]
-indent_size = 2
-indent_style = space
-
-# Markdown
-[*.{md,mdwn,mdown,markdown}]
-indent_size = 4
-indent_style = space
-
-# Package.json
-#
-# This indentation style is the one used by npm.
-[package.json]
-indent_size = 2
-indent_style = space
-
-# Pug (Jade)
-[*.{jade,pug}]
-indent_size = 2
-indent_style = space
-
-# JavaScript
-#
-# Two spaces seems to be the standard most common style, at least in
-# Node.js (http://nodeguide.com/style.html#tabs-vs-spaces).
-[*.{js,jsx,ts,tsx}]
-indent_size = 2
-indent_style = space
-
-# Less
-[*.less]
-indent_size = 2
-indent_style = space
-
-# Sass
-#
-# Style used for http://libsass.com
-[*.s[ac]ss]
-indent_size = 2
-indent_style = space
-
-# YAML
-#
-# Only spaces are allowed.
-[*.yaml]
-indent_size = 2
-indent_style = space

.env.example

@@ -0,0 +1,2 @@
+# xo_fs_nfs=nfs://ip:/folder
+# xo_fs_smb=smb://login:pass@domain\\ip\folder

.eslintrc.js

@@ -1,5 +1,13 @@
 module.exports = {
-  extends: ['standard', 'standard-jsx'],
+  extends: [
+    'plugin:eslint-comments/recommended',
+
+    'standard',
+    'standard-jsx',
+    'prettier',
+    'prettier/standard',
+    'prettier/react',
+  ],
   globals: {
     __DEV__: true,
     $Dict: true,
@@ -10,6 +18,16 @@ module.exports = {
     $PropertyType: true,
     $Shape: true,
   },
+
+  overrides: [
+    {
+      files: ['cli.js', '*-cli.js', '**/*cli*/**/*.js'],
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ],
+
   parser: 'babel-eslint',
   parserOptions: {
     ecmaFeatures: {
@@ -17,12 +35,22 @@ module.exports = {
     },
   },
   rules: {
-    'comma-dangle': ['error', 'always-multiline'],
-    indent: 'off',
+    // disabled because XAPI objects are using camel case
+    camelcase: ['off'],
+
+    'react/jsx-handler-names': 'off',
+
+    // disabled because not always relevant, we might reconsider in the future
+    //
+    // enabled by https://github.com/standard/eslint-config-standard/commit/319b177750899d4525eb1210686f6aca96190b2f
+    //
+    // example: https://github.com/vatesfr/xen-orchestra/blob/31ed3767c67044ca445658eb6b560718972402f2/packages/xen-api/src/index.js#L156-L157
+    'lines-between-class-members': 'off',
+
+    'no-console': ['error', { allow: ['warn', 'error'] }],
     'no-var': 'error',
     'node/no-extraneous-import': 'error',
     'node/no-extraneous-require': 'error',
     'prefer-const': 'error',
-    'react/jsx-indent': 'off',
   },
 }

.gitignore

@@ -30,3 +30,4 @@ pnpm-debug.log
 pnpm-debug.log.*
 yarn-error.log
 yarn-error.log.*
+.env

.prettierrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+  jsxSingleQuote: true,
   semi: false,
   singleQuote: true,
   trailingComma: 'es5',

@xen-orchestra/async-map/README.md

@@ -35,7 +35,7 @@ Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/async
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may:

@xen-orchestra/async-map/package.json

@@ -7,6 +7,7 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/async-map",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/async-map",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -35,8 +36,8 @@
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
-    "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "cross-env": "^6.0.3",
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -45,6 +46,7 @@
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
     "prepare": "yarn run build",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/babel-config/index.js

@@ -14,7 +14,7 @@ const configs = {
   '@babel/plugin-proposal-pipeline-operator': {
     proposal: 'minimal',
   },
-  '@babel/preset-env' (pkg) {
+  '@babel/preset-env'(pkg) {
     return {
       debug: !__TEST__,
 
@@ -46,7 +46,13 @@ const getConfig = (key, ...args) => {
     : config
 }
 
-module.exports = function (pkg, plugins, presets) {
+// some plugins must be used in a specific order
+const pluginsOrder = [
+  '@babel/plugin-proposal-decorators',
+  '@babel/plugin-proposal-class-properties',
+]
+
+module.exports = function(pkg, plugins, presets) {
   plugins === undefined && (plugins = {})
   presets === undefined && (presets = {})
 
@@ -61,7 +67,13 @@ module.exports = function (pkg, plugins, presets) {
   return {
     comments: !__PROD__,
     ignore: __TEST__ ? undefined : [/\.spec\.js$/],
-    plugins: Object.keys(plugins).map(plugin => [plugin, plugins[plugin]]),
+    plugins: Object.keys(plugins)
+      .map(plugin => [plugin, plugins[plugin]])
+      .sort(([a], [b]) => {
+        const oA = pluginsOrder.indexOf(a)
+        const oB = pluginsOrder.indexOf(b)
+        return oA !== -1 && oB !== -1 ? oA - oB : a < b ? -1 : 1
+      }),
     presets: Object.keys(presets).map(preset => [preset, presets[preset]]),
   }
 }

@xen-orchestra/babel-config/package.json

@@ -5,7 +5,11 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/babel-config",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/babel-config",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "engines": {
+    "node": ">=6"
   }
 }

@xen-orchestra/backups-cli/_asyncMap.js

@@ -0,0 +1,7 @@
+const curryRight = require('lodash/curryRight')
+
+module.exports = curryRight((iterable, fn) =>
+  Promise.all(
+    Array.isArray(iterable) ? iterable.map(fn) : Array.from(iterable, fn)
+  )
+)

@xen-orchestra/backups-cli/_composeCommands.js

@@ -0,0 +1,32 @@
+const getopts = require('getopts')
+
+const { version } = require('./package.json')
+
+module.exports = commands =>
+  async function(args, prefix) {
+    const opts = getopts(args, {
+      alias: {
+        help: 'h',
+      },
+      boolean: ['help'],
+      stopEarly: true,
+    })
+
+    const commandName = opts.help || args.length === 0 ? 'help' : args[0]
+    const command = commands[commandName]
+    if (command === undefined) {
+      process.stdout.write(`Usage:
+
+${Object.keys(commands)
+  .filter(command => command !== 'help')
+  .map(command => `    ${prefix} ${command} ${commands[command].usage || ''}`)
+  .join('\n\n')}
+
+xo-backups v${version}
+`)
+      process.exitCode = commandName === 'help' ? 0 : 1
+      return
+    }
+
+    return command.main(args.slice(1), prefix + ' ' + commandName)
+  }

@xen-orchestra/backups-cli/_fs.js

@@ -0,0 +1,57 @@
+const { dirname } = require('path')
+
+const fs = require('promise-toolbox/promisifyAll')(require('fs'))
+module.exports = fs
+
+fs.mktree = async function mkdirp(path) {
+  try {
+    await fs.mkdir(path)
+  } catch (error) {
+    const { code } = error
+    if (code === 'EEXIST') {
+      await fs.readdir(path)
+      return
+    }
+    if (code === 'ENOENT') {
+      await mkdirp(dirname(path))
+      return mkdirp(path)
+    }
+    throw error
+  }
+}
+
+// - easier:
+//   - single param for direct use in `Array#map`
+//   - files are prefixed with directory path
+// - safer: returns empty array if path is missing or not a directory
+fs.readdir2 = path =>
+  fs.readdir(path).then(
+    entries => {
+      entries.forEach((entry, i) => {
+        entries[i] = `${path}/${entry}`
+      })
+
+      return entries
+    },
+    error => {
+      if (
+        error != null &&
+        (error.code === 'ENOENT' || error.code === 'ENOTDIR')
+      ) {
+        console.warn('WARN: readdir(%s)', path, error)
+        return []
+      }
+      throw error
+    }
+  )
+
+fs.symlink2 = async (target, path) => {
+  try {
+    await fs.symlink(target, path)
+  } catch (error) {
+    if (error.code === 'EEXIST' && (await fs.readlink(path)) === target) {
+      return
+    }
+    throw error
+  }
+}

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

@@ -0,0 +1,371 @@
+#!/usr/bin/env node
+
+// assigned when options are parsed by the main function
+let force
+
+// -----------------------------------------------------------------------------
+
+const assert = require('assert')
+const flatten = require('lodash/flatten')
+const getopts = require('getopts')
+const lockfile = require('proper-lockfile')
+const pipe = require('promise-toolbox/pipe')
+const { default: Vhd } = require('vhd-lib')
+const { dirname, resolve } = require('path')
+const { DISK_TYPE_DIFFERENCING } = require('vhd-lib/dist/_constants')
+
+const asyncMap = require('../_asyncMap')
+const fs = require('../_fs')
+
+const handler = require('@xen-orchestra/fs').getHandler({ url: 'file://' })
+
+// -----------------------------------------------------------------------------
+
+const isGzipFile = async fd => {
+  // https://tools.ietf.org/html/rfc1952.html#page-5
+  const magicNumber = Buffer.allocUnsafe(2)
+  assert.strictEqual(
+    await fs.read(fd, magicNumber, 0, magicNumber.length, 0),
+    magicNumber.length
+  )
+  return magicNumber[0] === 31 && magicNumber[1] === 139
+}
+
+// TODO: better check?
+//
+// our heuristic is not good enough, there has been some false positives
+// (detected as invalid by us but valid by `tar` and imported with success),
+// either THOUGH THEY MAY HAVE BEEN COMPRESSED FILES:
+// - these files were normal but the check is incorrect
+// - these files were invalid but without data loss
+// - these files were invalid but with silent data loss
+//
+// maybe reading the end of the file looking for a file named
+// /^Ref:\d+/\d+\.checksum$/ and then validating the tar structure from it
+//
+// https://github.com/npm/node-tar/issues/234#issuecomment-538190295
+const isValidTar = async (size, fd) => {
+  if (size <= 1024 || size % 512 !== 0) {
+    return false
+  }
+
+  const buf = Buffer.allocUnsafe(1024)
+  assert.strictEqual(
+    await fs.read(fd, buf, 0, buf.length, size - buf.length),
+    buf.length
+  )
+  return buf.every(_ => _ === 0)
+}
+
+// TODO: find an heuristic for compressed files
+const isValidXva = async path => {
+  try {
+    const fd = await fs.open(path, 'r')
+    try {
+      const { size } = await fs.fstat(fd)
+      if (size < 20) {
+        // neither a valid gzip not tar
+        return false
+      }
+
+      return (await isGzipFile(fd))
+        ? true // gzip files cannot be validated at this time
+        : await isValidTar(size, fd)
+    } finally {
+      fs.close(fd).catch(noop)
+    }
+  } catch (error) {
+    // never throw, log and report as valid to avoid side effects
+    console.error('isValidXva', path, error)
+    return true
+  }
+}
+
+const noop = Function.prototype
+
+// -----------------------------------------------------------------------------
+
+// chain is an array of VHDs from child to parent
+//
+// the whole chain will be merged into parent, parent will be renamed to child
+// and all the others will deleted
+async function mergeVhdChain(chain) {
+  assert(chain.length >= 2)
+
+  const child = chain[0]
+  const parent = chain[chain.length - 1]
+  const children = chain.slice(0, -1).reverse()
+
+  console.warn('Unused parents of VHD', child)
+  chain
+    .slice(1)
+    .reverse()
+    .forEach(parent => {
+      console.warn('  ', parent)
+    })
+  force && console.warn('  merging…')
+  console.warn('')
+  if (force) {
+    // `mergeVhd` does not work with a stream, either
+    // - make it accept a stream
+    // - or create synthetic VHD which is not a stream
+    return console.warn('TODO: implement merge')
+    // await mergeVhd(
+    //   handler,
+    //   parent,
+    //   handler,
+    //   children.length === 1
+    //     ? child
+    //     : await createSyntheticStream(handler, children)
+    // )
+  }
+
+  await Promise.all([
+    force && fs.rename(parent, child),
+    asyncMap(children.slice(0, -1), child => {
+      console.warn('Unused VHD', child)
+      force && console.warn('  deleting…')
+      console.warn('')
+      return force && handler.unlink(child)
+    }),
+  ])
+}
+
+const listVhds = pipe([
+  vmDir => vmDir + '/vdis',
+  fs.readdir2,
+  asyncMap(fs.readdir2),
+  flatten,
+  asyncMap(fs.readdir2),
+  flatten,
+  _ => _.filter(_ => _.endsWith('.vhd')),
+])
+
+async function handleVm(vmDir) {
+  const vhds = new Set()
+  const vhdParents = { __proto__: null }
+  const vhdChildren = { __proto__: null }
+
+  // remove broken VHDs
+  await asyncMap(await listVhds(vmDir), async path => {
+    try {
+      const vhd = new Vhd(handler, path)
+      await vhd.readHeaderAndFooter()
+      vhds.add(path)
+      if (vhd.footer.diskType === DISK_TYPE_DIFFERENCING) {
+        const parent = resolve(dirname(path), vhd.header.parentUnicodeName)
+        vhdParents[path] = parent
+        if (parent in vhdChildren) {
+          const error = new Error(
+            'this script does not support multiple VHD children'
+          )
+          error.parent = parent
+          error.child1 = vhdChildren[parent]
+          error.child2 = path
+          throw error // should we throw?
+        }
+        vhdChildren[parent] = path
+      }
+    } catch (error) {
+      console.warn('Error while checking VHD', path)
+      console.warn('  ', error)
+      if (error != null && error.code === 'ERR_ASSERTION') {
+        force && console.warn('  deleting…')
+        console.warn('')
+        force && (await handler.unlink(path))
+      }
+    }
+  })
+
+  // remove VHDs with missing ancestors
+  {
+    const deletions = []
+
+    // return true if the VHD has been deleted or is missing
+    const deleteIfOrphan = vhd => {
+      const parent = vhdParents[vhd]
+      if (parent === undefined) {
+        return
+      }
+
+      // no longer needs to be checked
+      delete vhdParents[vhd]
+
+      deleteIfOrphan(parent)
+
+      if (!vhds.has(parent)) {
+        vhds.delete(vhd)
+
+        console.warn('Error while checking VHD', vhd)
+        console.warn('  missing parent', parent)
+        force && console.warn('  deleting…')
+        console.warn('')
+        force && deletions.push(handler.unlink(vhd))
+      }
+    }
+
+    // > A property that is deleted before it has been visited will not be
+    // > visited later.
+    // >
+    // > -- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...in#Deleted_added_or_modified_properties
+    for (const child in vhdParents) {
+      deleteIfOrphan(child)
+    }
+
+    await Promise.all(deletions)
+  }
+
+  const [jsons, xvas] = await fs
+    .readdir2(vmDir)
+    .then(entries => [
+      entries.filter(_ => _.endsWith('.json')),
+      new Set(entries.filter(_ => _.endsWith('.xva'))),
+    ])
+
+  await asyncMap(xvas, async path => {
+    // check is not good enough to delete the file, the best we can do is report
+    // it
+    if (!(await isValidXva(path))) {
+      console.warn('Potential broken XVA', path)
+      console.warn('')
+    }
+  })
+
+  const unusedVhds = new Set(vhds)
+  const unusedXvas = new Set(xvas)
+
+  // compile the list of unused XVAs and VHDs, and remove backup metadata which
+  // reference a missing XVA/VHD
+  await asyncMap(jsons, async json => {
+    const metadata = JSON.parse(await fs.readFile(json))
+    const { mode } = metadata
+    if (mode === 'full') {
+      const linkedXva = resolve(vmDir, metadata.xva)
+
+      if (xvas.has(linkedXva)) {
+        unusedXvas.delete(linkedXva)
+      } else {
+        console.warn('Error while checking backup', json)
+        console.warn('  missing file', linkedXva)
+        force && console.warn('  deleting…')
+        console.warn('')
+        force && (await handler.unlink(json))
+      }
+    } else if (mode === 'delta') {
+      const linkedVhds = (() => {
+        const { vhds } = metadata
+        return Object.keys(vhds).map(key => resolve(vmDir, vhds[key]))
+      })()
+
+      // FIXME: find better approach by keeping as much of the backup as
+      // possible (existing disks) even if one disk is missing
+      if (linkedVhds.every(_ => vhds.has(_))) {
+        linkedVhds.forEach(_ => unusedVhds.delete(_))
+      } else {
+        console.warn('Error while checking backup', json)
+        const missingVhds = linkedVhds.filter(_ => !vhds.has(_))
+        console.warn(
+          '  %i/%i missing VHDs',
+          missingVhds.length,
+          linkedVhds.length
+        )
+        missingVhds.forEach(vhd => {
+          console.warn('  ', vhd)
+        })
+        force && console.warn('  deleting…')
+        console.warn('')
+        force && (await handler.unlink(json))
+      }
+    }
+  })
+
+  // TODO: parallelize by vm/job/vdi
+  const unusedVhdsDeletion = []
+  {
+    // VHD chains (as list from child to ancestor) to merge indexed by last
+    // ancestor
+    const vhdChainsToMerge = { __proto__: null }
+
+    const toCheck = new Set(unusedVhds)
+
+    const getUsedChildChainOrDelete = vhd => {
+      if (vhd in vhdChainsToMerge) {
+        const chain = vhdChainsToMerge[vhd]
+        delete vhdChainsToMerge[vhd]
+        return chain
+      }
+
+      if (!unusedVhds.has(vhd)) {
+        return [vhd]
+      }
+
+      // no longer needs to be checked
+      toCheck.delete(vhd)
+
+      const child = vhdChildren[vhd]
+      if (child !== undefined) {
+        const chain = getUsedChildChainOrDelete(child)
+        if (chain !== undefined) {
+          chain.push(vhd)
+          return chain
+        }
+      }
+
+      console.warn('Unused VHD', vhd)
+      force && console.warn('  deleting…')
+      console.warn('')
+      force && unusedVhdsDeletion.push(handler.unlink(vhd))
+    }
+
+    toCheck.forEach(vhd => {
+      vhdChainsToMerge[vhd] = getUsedChildChainOrDelete(vhd)
+    })
+
+    Object.keys(vhdChainsToMerge).forEach(key => {
+      const chain = vhdChainsToMerge[key]
+      if (chain !== undefined) {
+        unusedVhdsDeletion.push(mergeVhdChain(chain))
+      }
+    })
+  }
+
+  await Promise.all([
+    unusedVhdsDeletion,
+    asyncMap(unusedXvas, path => {
+      console.warn('Unused XVA', path)
+      force && console.warn('  deleting…')
+      console.warn('')
+      return force && handler.unlink(path)
+    }),
+  ])
+}
+
+// -----------------------------------------------------------------------------
+
+module.exports = async function main(args) {
+  const opts = getopts(args, {
+    alias: {
+      force: 'f',
+    },
+    boolean: ['force'],
+    default: {
+      force: false,
+    },
+  })
+
+  ;({ force } = opts)
+  await asyncMap(opts._, async vmDir => {
+    vmDir = resolve(vmDir)
+
+    // TODO: implement this in `xo-server`, not easy because not compatible with
+    // `@xen-orchestra/fs`.
+    const release = await lockfile.lock(vmDir)
+    try {
+      await handleVm(vmDir)
+    } catch (error) {
+      console.error('handleVm', vmDir, error)
+    } finally {
+      await release()
+    }
+  })
+}

@xen-orchestra/backups-cli/commands/create-symlink-index.js

@@ -0,0 +1,28 @@
+const filenamify = require('filenamify')
+const get = require('lodash/get')
+const { dirname, join, relative } = require('path')
+
+const asyncMap = require('../_asyncMap')
+const { mktree, readdir2, readFile, symlink2 } = require('../_fs')
+
+module.exports = async function createSymlinkIndex([backupDir, fieldPath]) {
+  const indexDir = join(backupDir, 'indexes', filenamify(fieldPath))
+  await mktree(indexDir)
+
+  await asyncMap(await readdir2(backupDir), async vmDir =>
+    asyncMap(
+      (await readdir2(vmDir)).filter(_ => _.endsWith('.json')),
+      async json => {
+        const metadata = JSON.parse(await readFile(json))
+        const value = get(metadata, fieldPath)
+        if (value !== undefined) {
+          const target = relative(indexDir, dirname(json))
+          const path = join(indexDir, filenamify(String(value)))
+          await symlink2(target, path).catch(error => {
+            console.warn('symlink(%s, %s)', target, path, error)
+          })
+        }
+      }
+    )
+  )
+}

@xen-orchestra/backups-cli/index.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+require('./_composeCommands')({
+  'clean-vms': {
+    get main() {
+      return require('./commands/clean-vms')
+    },
+    usage: '[--force] xo-vm-backups/*',
+  },
+  'create-symlink-index': {
+    get main() {
+      return require('./commands/create-symlink-index')
+    },
+    usage: 'xo-vm-backups <field path>',
+  },
+})(process.argv.slice(2), 'xo-backups').catch(error => {
+  console.error('main', error)
+  process.exitCode = 1
+})

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

@@ -0,0 +1,29 @@
+{
+  "bin": {
+    "xo-backups": "index.js"
+  },
+  "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
+  "dependencies": {
+    "@xen-orchestra/fs": "^0.10.2",
+    "filenamify": "^4.1.0",
+    "getopts": "^2.2.5",
+    "lodash": "^4.17.15",
+    "promise-toolbox": "^0.15.0",
+    "proper-lockfile": "^4.1.1",
+    "vhd-lib": "^0.7.2"
+  },
+  "engines": {
+    "node": ">=7.10.1"
+  },
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/backups-cli",
+  "name": "@xen-orchestra/backups-cli",
+  "repository": {
+    "directory": "@xen-orchestra/backups-cli",
+    "type": "git",
+    "url": "https://github.com/vatesfr/xen-orchestra.git"
+  },
+  "scripts": {
+    "postversion": "npm publish --access public"
+  },
+  "version": "0.0.0"
+}

@xen-orchestra/cr-seed-cli/index.js

@@ -5,7 +5,7 @@ const { NULL_REF, Xapi } = require('xen-api')
 
 const pkg = require('./package.json')
 
-Xapi.prototype.getVmDisks = async function (vm) {
+Xapi.prototype.getVmDisks = async function(vm) {
   const disks = { __proto__: null }
   await Promise.all([
     ...vm.VBDs.map(async vbdRef => {
@@ -19,7 +19,7 @@ Xapi.prototype.getVmDisks = async function (vm) {
   return disks
 }
 
-defer(async function main ($defer, args) {
+defer(async function main($defer, args) {
   if (args.length === 0 || args.includes('-h') || args.includes('--help')) {
     const cliName = Object.keys(pkg.bin)[0]
     return console.error(
@@ -82,35 +82,26 @@ ${cliName} v${pkg.version}
   )
 
   await Promise.all([
-    srcXapi.setFieldEntries(srcSnapshot, 'other_config', metadata),
-    srcXapi.setFieldEntries(srcSnapshot, 'other_config', {
-      'xo:backup:exported': 'true',
-    }),
-    tgtXapi.setField(
-      tgtVm,
-      'name_label',
-      `${srcVm.name_label} (${srcSnapshot.snapshot_time})`
-    ),
-    tgtXapi.setFieldEntries(tgtVm, 'other_config', metadata),
-    tgtXapi.setFieldEntries(tgtVm, 'other_config', {
+    srcSnapshot.update_other_config(metadata),
+    srcSnapshot.update_other_config('xo:backup:exported', 'true'),
+    tgtVm.set_name_label(`${srcVm.name_label} (${srcSnapshot.snapshot_time})`),
+    tgtVm.update_other_config(metadata),
+    tgtVm.update_other_config({
       'xo:backup:sr': tgtSr.uuid,
       'xo:copy_of': srcSnapshotUuid,
     }),
-    tgtXapi.setFieldEntries(tgtVm, 'blocked_operations', {
-      start:
-        'Start operation for this vm is blocked, clone it if you want to use it.',
-    }),
+    tgtVm.update_blocked_operations(
+      'start',
+      'Start operation for this vm is blocked, clone it if you want to use it.'
+    ),
     Promise.all(
       userDevices.map(userDevice => {
         const srcDisk = srcDisks[userDevice]
         const tgtDisk = tgtDisks[userDevice]
 
-        return tgtXapi.setFieldEntry(
-          tgtDisk,
-          'other_config',
-          'xo:copy_of',
-          srcDisk.uuid
-        )
+        return tgtDisk.update_other_config({
+          'xo:copy_of': srcDisk.uuid,
+        })
       })
     ),
   ])

@xen-orchestra/cr-seed-cli/package.json

@@ -4,6 +4,7 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/cr-seed-cli",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/cr-seed-cli",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -15,6 +16,9 @@
   },
   "dependencies": {
     "golike-defer": "^0.4.1",
-    "xen-api": "^0.21.0"
+    "xen-api": "^0.27.3"
+  },
+  "scripts": {
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/cron/README.md

@@ -16,7 +16,6 @@ Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/cron)
 <minute> <hour> <day of month> <month> <day of week>
 ```
 
-
 Each entry can be:
 
 - a single value
@@ -29,12 +28,12 @@ A wildcard (`*`) can be used as a shortcut for the whole range
 Step values can be used in conjunctions with ranges. For instance,
 `1-7/2` is the same as `1,3,5,7`.
 
-| Field            | Allowed values |
-|------------------|----------------|
-| minute           | 0-59           |
-| hour             | 0-23           |
-| day of the month | 1-31 or 3-letter names (`jan`, `feb`, …) |
-| month            | 0-11           |
+| Field            | Allowed values                                                     |
+| ---------------- | ------------------------------------------------------------------ |
+| minute           | 0-59                                                               |
+| hour             | 0-23                                                               |
+| day of the month | 1-31 or 3-letter names (`jan`, `feb`, …)                           |
+| month            | 0-11                                                               |
 | day of week      | 0-7 (0 and 7 both mean Sunday) or 3-letter names (`mon`, `tue`, …) |
 
 > Note: the month range is 0-11 to be compatible with
@@ -131,7 +130,7 @@ job.stop()
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may:

@xen-orchestra/cron/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xen-orchestra/cron",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "license": "ISC",
   "description": "Focused, well maintained, cron parser/scheduler",
   "keywords": [
@@ -17,6 +17,7 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/cron",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/cron",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -45,8 +46,8 @@
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
-    "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "cross-env": "^6.0.3",
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -54,6 +55,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run clean",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/cron/src/index.js

@@ -6,8 +6,22 @@ import parse from './parse'
 const MAX_DELAY = 2 ** 31 - 1
 
 class Job {
-  constructor (schedule, fn) {
+  constructor(schedule, fn) {
+    let scheduledDate
     const wrapper = () => {
+      const now = Date.now()
+      if (scheduledDate > now) {
+        // we're early, delay
+        //
+        // no need to check _isEnabled, we're just delaying the existing timeout
+        //
+        // see https://github.com/vatesfr/xen-orchestra/issues/4625
+        this._timeout = setTimeout(wrapper, scheduledDate - now)
+        return
+      }
+
+      this._isRunning = true
+
       let result
       try {
         result = fn()
@@ -22,29 +36,42 @@ class Job {
       }
     }
     const scheduleNext = () => {
-      const delay = schedule._nextDelay()
-      this._timeout =
-        delay < MAX_DELAY
-          ? setTimeout(wrapper, delay)
-          : setTimeout(scheduleNext, MAX_DELAY)
+      this._isRunning = false
+
+      if (this._isEnabled) {
+        const now = schedule._createDate()
+        scheduledDate = +next(schedule._schedule, now)
+        const delay = scheduledDate - now
+        this._timeout =
+          delay < MAX_DELAY
+            ? setTimeout(wrapper, delay)
+            : setTimeout(scheduleNext, MAX_DELAY)
+      }
     }
 
+    this._isEnabled = false
+    this._isRunning = false
     this._scheduleNext = scheduleNext
     this._timeout = undefined
   }
 
-  start () {
+  start() {
     this.stop()
-    this._scheduleNext()
+
+    this._isEnabled = true
+    if (!this._isRunning) {
+      this._scheduleNext()
+    }
   }
 
-  stop () {
+  stop() {
+    this._isEnabled = false
     clearTimeout(this._timeout)
   }
 }
 
 class Schedule {
-  constructor (pattern, zone = 'utc') {
+  constructor(pattern, zone = 'utc') {
     this._schedule = parse(pattern)
     this._createDate =
       zone.toLowerCase() === 'utc'
@@ -54,11 +81,11 @@ class Schedule {
         : () => moment.tz(zone)
   }
 
-  createJob (fn) {
+  createJob(fn) {
     return new Job(this, fn)
   }
 
-  next (n) {
+  next(n) {
     const dates = new Array(n)
     const schedule = this._schedule
     let date = this._createDate()
@@ -68,12 +95,7 @@ class Schedule {
     return dates
   }
 
-  _nextDelay () {
-    const now = this._createDate()
-    return next(this._schedule, now) - now
-  }
-
-  startJob (fn) {
+  startJob(fn) {
     const job = this.createJob(fn)
     job.start()
     return job.stop.bind(job)

@xen-orchestra/cron/src/index.spec.js

@@ -0,0 +1,78 @@
+/* eslint-env jest */
+
+import { createSchedule } from './'
+
+const wrap = value => () => value
+
+describe('issues', () => {
+  let originalDateNow
+  beforeAll(() => {
+    originalDateNow = Date.now
+  })
+  afterAll(() => {
+    Date.now = originalDateNow
+    originalDateNow = undefined
+  })
+
+  test('stop during async execution', async () => {
+    let nCalls = 0
+    let resolve, promise
+
+    const schedule = createSchedule('* * * * *')
+    const job = schedule.createJob(() => {
+      ++nCalls
+
+      // eslint-disable-next-line promise/param-names
+      promise = new Promise(r => {
+        resolve = r
+      })
+      return promise
+    })
+
+    job.start()
+    Date.now = wrap(+schedule.next(1)[0])
+    jest.runAllTimers()
+
+    expect(nCalls).toBe(1)
+
+    job.stop()
+
+    resolve()
+    await promise
+
+    jest.runAllTimers()
+    expect(nCalls).toBe(1)
+  })
+
+  test('stop then start during async job execution', async () => {
+    let nCalls = 0
+    let resolve, promise
+
+    const schedule = createSchedule('* * * * *')
+    const job = schedule.createJob(() => {
+      ++nCalls
+
+      // eslint-disable-next-line promise/param-names
+      promise = new Promise(r => {
+        resolve = r
+      })
+      return promise
+    })
+
+    job.start()
+    Date.now = wrap(+schedule.next(1)[0])
+    jest.runAllTimers()
+
+    expect(nCalls).toBe(1)
+
+    job.stop()
+    job.start()
+
+    resolve()
+    await promise
+
+    Date.now = wrap(+schedule.next(1)[0])
+    jest.runAllTimers()
+    expect(nCalls).toBe(2)
+  })
+})

@xen-orchestra/defined/README.md

@@ -1,13 +1,13 @@
-# ${pkg.name} [![Build Status](https://travis-ci.org/${pkg.shortGitHubPath}.png?branch=master)](https://travis-ci.org/${pkg.shortGitHubPath})
+# @xen-orchestra/defined [![Build Status](https://travis-ci.org/${pkg.shortGitHubPath}.png?branch=master)](https://travis-ci.org/${pkg.shortGitHubPath})
 
 > ${pkg.description}
 
 ## Install
 
-Installation of the [npm package](https://npmjs.org/package/${pkg.name}):
+Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/defined):
 
 ```
-> npm install --save ${pkg.name}
+> npm install --save @xen-orchestra/defined
 ```
 
 ## Usage
@@ -35,15 +35,15 @@ Installation of the [npm package](https://npmjs.org/package/${pkg.name}):
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may:
 
-- report any [issue](${pkg.bugs})
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
   you've encountered;
 - fork and create a pull request.
 
 ## License
 
-${pkg.license} © [${pkg.author.name}](${pkg.author.url})
+ISC © [Vates SAS](https://vates.fr)

@xen-orchestra/defined/package.json

@@ -7,6 +7,7 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/defined",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/defined",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -33,8 +34,8 @@
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
-    "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "cross-env": "^6.0.3",
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -42,6 +43,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/defined/src/index.js

@@ -13,7 +13,7 @@
 //   process.env.http_proxy
 // ])
 // ```
-export default function defined () {
+export default function defined() {
   let args = arguments
   let n = args.length
   if (n === 1) {

@xen-orchestra/emit-async/README.md

@@ -19,7 +19,7 @@ import emitAsync from '@xen-orchestra/emit-async'
 const ee = new EE()
 ee.emitAsync = emitAsync
 
-ee.on('start', async function () {
+ee.on('start', async function() {
   // whatever
 })
 
@@ -29,11 +29,14 @@ await ee.emitAsync('start')
 
 // by default, it will rejects as soon as one listener reject, you can customise
 // error handling though:
-await ee.emitAsync({
-  onError (error) {
-    console.warn(error)
-  }
-}, 'start')
+await ee.emitAsync(
+  {
+    onError(error) {
+      console.warn(error)
+    },
+  },
+  'start'
+)
 ```
 
 ## Development
@@ -57,15 +60,15 @@ await ee.emitAsync({
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may:
 
-- report any [issue](${pkg.bugs})
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
   you've encountered;
 - fork and create a pull request.
 
 ## License
 
-${pkg.license} © [${pkg.author.name}](${pkg.author.url})
+ISC © [Vates SAS](https://vates.fr)

@xen-orchestra/emit-async/package.json

@@ -7,6 +7,7 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/emit-async",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/emit-async",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -32,8 +33,8 @@
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
-    "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "cross-env": "^6.0.3",
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -41,6 +42,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/emit-async/src/index.js

@@ -1,4 +1,4 @@
-export default function emitAsync (event) {
+export default function emitAsync(event) {
   let opts
   let i = 1
 

@xen-orchestra/fs/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@xen-orchestra/fs",
-  "version": "0.4.1",
+  "version": "0.10.2",
   "license": "AGPL-3.0",
   "description": "The File System for Xen Orchestra backups.",
   "keywords": [],
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/fs",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/fs",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -17,29 +18,38 @@
     "dist/"
   ],
   "engines": {
-    "node": ">=6"
+    "node": ">=8.10"
   },
   "dependencies": {
-    "@marsaud/smb2": "^0.9.0",
-    "execa": "^1.0.0",
-    "fs-extra": "^7.0.0",
-    "get-stream": "^4.0.0",
+    "@marsaud/smb2": "^0.15.0",
+    "@sindresorhus/df": "^3.1.1",
+    "@xen-orchestra/async-map": "^0.0.0",
+    "decorator-synchronized": "^0.5.0",
+    "execa": "^3.2.0",
+    "fs-extra": "^8.0.1",
+    "get-stream": "^5.1.0",
+    "limit-concurrency-decorator": "^0.4.0",
     "lodash": "^4.17.4",
-    "promise-toolbox": "^0.11.0",
+    "promise-toolbox": "^0.15.0",
+    "readable-stream": "^3.0.6",
     "through2": "^3.0.0",
-    "tmp": "^0.0.33",
+    "tmp": "^0.1.0",
     "xo-remote-parser": "^0.5.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
     "@babel/core": "^7.0.0",
+    "@babel/plugin-proposal-decorators": "^7.1.6",
     "@babel/plugin-proposal-function-bind": "^7.0.0",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.4.4",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-flow": "^7.0.0",
+    "async-iterator-to-stream": "^1.1.0",
     "babel-plugin-lodash": "^3.3.2",
-    "cross-env": "^5.1.3",
+    "cross-env": "^6.0.3",
+    "dotenv": "^8.0.0",
     "index-modules": "^0.3.0",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -47,6 +57,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run clean",
-    "prepare": "yarn run build"
+    "prepare": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/fs/src/_mount.js

@@ -0,0 +1,108 @@
+import execa from 'execa'
+import fs from 'fs-extra'
+import { ignoreErrors } from 'promise-toolbox'
+import { join } from 'path'
+import { tmpdir } from 'os'
+
+import LocalHandler from './local'
+
+const sudoExeca = (command, args, opts) =>
+  execa('sudo', [command, ...args], opts)
+
+export default class MountHandler extends LocalHandler {
+  constructor(
+    remote,
+    {
+      mountsDir = join(tmpdir(), 'xo-fs-mounts'),
+      useSudo = false,
+      ...opts
+    } = {},
+    params
+  ) {
+    super(remote, opts)
+
+    this._execa = useSudo ? sudoExeca : execa
+    this._keeper = undefined
+    this._params = {
+      ...params,
+      options: [params.options, remote.options]
+        .filter(_ => _ !== undefined)
+        .join(','),
+    }
+    this._realPath = join(
+      mountsDir,
+      remote.id ||
+        Math.random()
+          .toString(36)
+          .slice(2)
+    )
+  }
+
+  async _forget() {
+    const keeper = this._keeper
+    if (keeper === undefined) {
+      return
+    }
+    this._keeper = undefined
+    await fs.close(keeper)
+
+    await ignoreErrors.call(
+      this._execa('umount', [this._getRealPath()], {
+        env: {
+          LANG: 'C',
+        },
+      })
+    )
+  }
+
+  _getRealPath() {
+    return this._realPath
+  }
+
+  async _sync() {
+    // in case of multiple `sync`s, ensure we properly close previous keeper
+    {
+      const keeper = this._keeper
+      if (keeper !== undefined) {
+        this._keeper = undefined
+        ignoreErrors.call(fs.close(keeper))
+      }
+    }
+
+    const realPath = this._getRealPath()
+
+    await fs.ensureDir(realPath)
+
+    try {
+      const { type, device, options, env } = this._params
+      await this._execa(
+        'mount',
+        ['-t', type, device, realPath, '-o', options],
+        {
+          env: {
+            LANG: 'C',
+            ...env,
+          },
+        }
+      )
+    } catch (error) {
+      try {
+        // the failure may mean it's already mounted, use `findmnt` to check
+        // that's the case
+        await this._execa('findmnt', [realPath], {
+          stdio: 'ignore',
+        })
+      } catch (_) {
+        throw error
+      }
+    }
+
+    // keep an open file on the mount to prevent it from being unmounted if used
+    // by another handler/process
+    const keeperPath = `${realPath}/.keeper_${Math.random()
+      .toString(36)
+      .slice(2)}`
+    this._keeper = await fs.open(keeperPath, 'w')
+    ignoreErrors.call(fs.unlink(keeperPath))
+  }
+}

@xen-orchestra/fs/src/_normalizePath.js

@@ -0,0 +1,9 @@
+import path from 'path'
+
+const { resolve } = path.posix
+
+// normalize the path:
+// - does not contains `.` or `..`  (cannot escape root dir)
+// - always starts with `/`
+const normalizePath = path => resolve('/', path)
+export { normalizePath as default }

@xen-orchestra/fs/src/abstract.js

@@ -2,29 +2,80 @@
 
 // $FlowFixMe
 import getStream from 'get-stream'
-import { randomBytes } from 'crypto'
-import { fromCallback, fromEvent, ignoreErrors, timeout } from 'promise-toolbox'
-import { type Readable, type Writable } from 'stream'
-import { parse } from 'xo-remote-parser'
 
+import asyncMap from '@xen-orchestra/async-map'
+import limit from 'limit-concurrency-decorator'
+import path from 'path'
+import synchronized from 'decorator-synchronized'
+import { fromCallback, fromEvent, ignoreErrors, timeout } from 'promise-toolbox'
+import { parse } from 'xo-remote-parser'
+import { randomBytes } from 'crypto'
+import { type Readable, type Writable } from 'stream'
+
+import normalizePath from './_normalizePath'
 import { createChecksumStream, validChecksumOfReadStream } from './checksum'
 
+const { dirname } = path.posix
+
 type Data = Buffer | Readable | string
 type FileDescriptor = {| fd: mixed, path: string |}
 type LaxReadable = Readable & Object
 type LaxWritable = Writable & Object
+type RemoteInfo = { used?: number, size?: number }
 
 type File = FileDescriptor | string
 
 const checksumFile = file => file + '.checksum'
+const computeRate = (hrtime: number[], size: number) => {
+  const seconds = hrtime[0] + hrtime[1] / 1e9
+  return size / seconds
+}
 
 const DEFAULT_TIMEOUT = 6e5 // 10 min
+const DEFAULT_MAX_PARALLEL_OPERATIONS = 10
+
+const ignoreEnoent = error => {
+  if (error == null || error.code !== 'ENOENT') {
+    throw error
+  }
+}
+
+class PrefixWrapper {
+  constructor(handler, prefix) {
+    this._prefix = prefix
+    this._handler = handler
+  }
+
+  get type() {
+    return this._handler.type
+  }
+
+  // necessary to remove the prefix from the path with `prependDir` option
+  async list(dir, opts) {
+    const entries = await this._handler.list(this._resolve(dir), opts)
+    if (opts != null && opts.prependDir) {
+      const n = this._prefix.length
+      entries.forEach((entry, i, entries) => {
+        entries[i] = entry.slice(n)
+      })
+    }
+    return entries
+  }
+
+  rename(oldPath, newPath) {
+    return this._handler.rename(this._resolve(oldPath), this._resolve(newPath))
+  }
+
+  _resolve(path) {
+    return this._prefix + normalizePath(path)
+  }
+}
 
 export default class RemoteHandlerAbstract {
   _remote: Object
   _timeout: number
 
-  constructor (remote: any, options: Object = {}) {
+  constructor(remote: any, options: Object = {}) {
     if (remote.url === 'test://') {
       this._remote = remote
     } else {
@@ -34,238 +85,49 @@ export default class RemoteHandlerAbstract {
       }
     }
     ;({ timeout: this._timeout = DEFAULT_TIMEOUT } = options)
-  }
 
-  get type (): string {
-    throw new Error('Not implemented')
-  }
-
-  /**
-   * Asks the handler to sync the state of the effective remote with its' metadata
-   */
-  async sync (): Promise<mixed> {
-    return this._sync()
-  }
-
-  async _sync (): Promise<mixed> {
-    throw new Error('Not implemented')
-  }
-
-  /**
-   * Free the resources possibly dedicated to put the remote at work, when it is no more needed
-   */
-  async forget (): Promise<void> {
-    await this._forget()
-  }
-
-  async _forget (): Promise<void> {
-    throw new Error('Not implemented')
-  }
-
-  async test (): Promise<Object> {
-    const testFileName = `${Date.now()}.test`
-    const data = await fromCallback(cb => randomBytes(1024 * 1024, cb))
-    let step = 'write'
-    try {
-      await this.outputFile(testFileName, data)
-      step = 'read'
-      const read = await this.readFile(testFileName)
-      if (data.compare(read) !== 0) {
-        throw new Error('output and input did not match')
-      }
-      return {
-        success: true,
-      }
-    } catch (error) {
-      return {
-        success: false,
-        step,
-        file: testFileName,
-        error: error.message || String(error),
-      }
-    } finally {
-      ignoreErrors.call(this.unlink(testFileName))
-    }
-  }
-
-  async outputFile (file: string, data: Data, options?: Object): Promise<void> {
-    return this._outputFile(file, data, {
-      flags: 'wx',
-      ...options,
-    })
-  }
-
-  async _outputFile (file: string, data: Data, options?: Object): Promise<void> {
-    const stream = await this.createOutputStream(file, options)
-    const promise = fromEvent(stream, 'finish')
-    stream.end(data)
-    await promise
-  }
-
-  async read (
-    file: File,
-    buffer: Buffer,
-    position?: number
-  ): Promise<{| bytesRead: number, buffer: Buffer |}> {
-    return this._read(file, buffer, position)
-  }
-
-  _read (
-    file: File,
-    buffer: Buffer,
-    position?: number
-  ): Promise<{| bytesRead: number, buffer: Buffer |}> {
-    throw new Error('Not implemented')
-  }
-
-  async readFile (file: string, options?: Object): Promise<Buffer> {
-    return this._readFile(file, options)
-  }
-
-  _readFile (file: string, options?: Object): Promise<Buffer> {
-    return this.createReadStream(file, options).then(getStream.buffer)
-  }
-
-  async rename (
-    oldPath: string,
-    newPath: string,
-    { checksum = false }: Object = {}
-  ) {
-    let p = timeout.call(this._rename(oldPath, newPath), this._timeout)
-    if (checksum) {
-      p = Promise.all([
-        p,
-        this._rename(checksumFile(oldPath), checksumFile(newPath)),
-      ])
-    }
-    return p
-  }
-
-  async _rename (oldPath: string, newPath: string) {
-    throw new Error('Not implemented')
-  }
-
-  async list (
-    dir: string = '.',
-    {
-      filter,
-      prependDir = false,
-    }: { filter?: (name: string) => boolean, prependDir?: boolean } = {}
-  ): Promise<string[]> {
-    let entries = await timeout.call(this._list(dir), this._timeout)
-    if (filter !== undefined) {
-      entries = entries.filter(filter)
-    }
-
-    if (prependDir) {
-      entries.forEach((entry, i) => {
-        entries[i] = dir + '/' + entry
-      })
-    }
-
-    return entries
-  }
-
-  async _list (dir: string): Promise<string[]> {
-    throw new Error('Not implemented')
-  }
-
-  createReadStream (
-    file: string,
-    { checksum = false, ignoreMissingChecksum = false, ...options }: Object = {}
-  ): Promise<LaxReadable> {
-    const path = typeof file === 'string' ? file : file.path
-    const streamP = timeout
-      .call(this._createReadStream(file, options), this._timeout)
-      .then(stream => {
-        // detect early errors
-        let promise = fromEvent(stream, 'readable')
-
-        // try to add the length prop if missing and not a range stream
-        if (
-          stream.length === undefined &&
-          options.end === undefined &&
-          options.start === undefined
-        ) {
-          promise = Promise.all([
-            promise,
-            ignoreErrors.call(
-              this.getSize(file).then(size => {
-                stream.length = size
-              })
-            ),
-          ])
-        }
-
-        return promise.then(() => stream)
-      })
-
-    if (!checksum) {
-      return streamP
-    }
-
-    // avoid a unhandled rejection warning
-    ignoreErrors.call(streamP)
-
-    return this.readFile(checksumFile(path)).then(
-      checksum =>
-        streamP.then(stream => {
-          const { length } = stream
-          stream = (validChecksumOfReadStream(
-            stream,
-            String(checksum).trim()
-          ): LaxReadable)
-          stream.length = length
-
-          return stream
-        }),
-      error => {
-        if (ignoreMissingChecksum && error && error.code === 'ENOENT') {
-          return streamP
-        }
-        throw error
-      }
+    const sharedLimit = limit(
+      options.maxParallelOperations ?? DEFAULT_MAX_PARALLEL_OPERATIONS
     )
+    this.closeFile = sharedLimit(this.closeFile)
+    this.getInfo = sharedLimit(this.getInfo)
+    this.getSize = sharedLimit(this.getSize)
+    this.list = sharedLimit(this.list)
+    this.mkdir = sharedLimit(this.mkdir)
+    this.openFile = sharedLimit(this.openFile)
+    this.outputFile = sharedLimit(this.outputFile)
+    this.read = sharedLimit(this.read)
+    this.readFile = sharedLimit(this.readFile)
+    this.rename = sharedLimit(this.rename)
+    this.rmdir = sharedLimit(this.rmdir)
+    this.truncate = sharedLimit(this.truncate)
+    this.unlink = sharedLimit(this.unlink)
+    this.write = sharedLimit(this.write)
+    this.writeFile = sharedLimit(this.writeFile)
   }
 
-  async _createReadStream (
-    file: string,
-    options?: Object
-  ): Promise<LaxReadable> {
+  // Public members
+
+  get type(): string {
     throw new Error('Not implemented')
   }
 
-  async openFile (path: string, flags?: string): Promise<FileDescriptor> {
-    return {
-      fd: await timeout.call(this._openFile(path, flags), this._timeout),
-      path,
-    }
+  addPrefix(prefix: string) {
+    prefix = normalizePath(prefix)
+    return prefix === '/' ? this : new PrefixWrapper(this, prefix)
   }
 
-  async _openFile (path: string, flags?: string): Promise<mixed> {
-    throw new Error('Not implemented')
-  }
-
-  async closeFile (fd: FileDescriptor): Promise<void> {
+  async closeFile(fd: FileDescriptor): Promise<void> {
     await timeout.call(this._closeFile(fd.fd), this._timeout)
   }
 
-  async _closeFile (fd: mixed): Promise<void> {
-    throw new Error('Not implemented')
-  }
-
-  async refreshChecksum (path: string): Promise<void> {
-    const stream = (await this.createReadStream(path)).pipe(
-      createChecksumStream()
-    )
-    stream.resume() // start reading the whole file
-    await this.outputFile(checksumFile(path), await stream.checksum)
-  }
-
-  async createOutputStream (
+  async createOutputStream(
     file: File,
     { checksum = false, ...options }: Object = {}
   ): Promise<LaxWritable> {
+    if (typeof file === 'string') {
+      file = normalizePath(file)
+    }
     const path = typeof file === 'string' ? file : file.path
     const streamP = timeout.call(
       this._createOutputStream(file, {
@@ -290,36 +152,498 @@ export default class RemoteHandlerAbstract {
 
     // $FlowFixMe
     checksumStream.checksumWritten = checksumStream.checksum
-      .then(value => this.outputFile(checksumFile(path), value))
+      .then(value =>
+        this._outputFile(checksumFile(path), value, { flags: 'wx' })
+      )
       .catch(forwardError)
 
     return checksumStream
   }
 
-  async _createOutputStream (
-    file: mixed,
-    options?: Object
-  ): Promise<LaxWritable> {
-    throw new Error('Not implemented')
+  createReadStream(
+    file: File,
+    { checksum = false, ignoreMissingChecksum = false, ...options }: Object = {}
+  ): Promise<LaxReadable> {
+    if (typeof file === 'string') {
+      file = normalizePath(file)
+    }
+    const path = typeof file === 'string' ? file : file.path
+    const streamP = timeout
+      .call(this._createReadStream(file, options), this._timeout)
+      .then(stream => {
+        // detect early errors
+        let promise = fromEvent(stream, 'readable')
+
+        // try to add the length prop if missing and not a range stream
+        if (
+          stream.length === undefined &&
+          options.end === undefined &&
+          options.start === undefined
+        ) {
+          promise = Promise.all([
+            promise,
+            ignoreErrors.call(
+              this._getSize(file).then(size => {
+                stream.length = size
+              })
+            ),
+          ])
+        }
+
+        return promise.then(() => stream)
+      })
+
+    if (!checksum) {
+      return streamP
+    }
+
+    // avoid a unhandled rejection warning
+    ignoreErrors.call(streamP)
+
+    return this._readFile(checksumFile(path), { flags: 'r' }).then(
+      checksum =>
+        streamP.then(stream => {
+          const { length } = stream
+          stream = (validChecksumOfReadStream(
+            stream,
+            String(checksum).trim()
+          ): LaxReadable)
+          stream.length = length
+
+          return stream
+        }),
+      error => {
+        if (ignoreMissingChecksum && error && error.code === 'ENOENT') {
+          return streamP
+        }
+        throw error
+      }
+    )
   }
 
-  async unlink (file: string, { checksum = true }: Object = {}): Promise<void> {
+  createWriteStream(
+    file: File,
+    options: { end?: number, flags?: string, start?: number } = {}
+  ): Promise<LaxWritable> {
+    return timeout.call(
+      this._createWriteStream(
+        typeof file === 'string' ? normalizePath(file) : file,
+        {
+          flags: 'wx',
+          ...options,
+        }
+      )
+    )
+  }
+
+  // Free the resources possibly dedicated to put the remote at work, when it
+  // is no more needed
+  //
+  // FIXME: Some handlers are implemented based on system-wide mecanisms (such
+  // as mount), forgetting them might breaking other processes using the same
+  // remote.
+  @synchronized()
+  async forget(): Promise<void> {
+    await this._forget()
+  }
+
+  async getInfo(): Promise<RemoteInfo> {
+    return timeout.call(this._getInfo(), this._timeout)
+  }
+
+  async getSize(file: File): Promise<number> {
+    return timeout.call(
+      this._getSize(typeof file === 'string' ? normalizePath(file) : file),
+      this._timeout
+    )
+  }
+
+  async list(
+    dir: string,
+    {
+      filter,
+      prependDir = false,
+    }: { filter?: (name: string) => boolean, prependDir?: boolean } = {}
+  ): Promise<string[]> {
+    const virtualDir = normalizePath(dir)
+    dir = normalizePath(dir)
+
+    let entries = await timeout.call(this._list(dir), this._timeout)
+    if (filter !== undefined) {
+      entries = entries.filter(filter)
+    }
+
+    if (prependDir) {
+      entries.forEach((entry, i) => {
+        entries[i] = virtualDir + '/' + entry
+      })
+    }
+
+    return entries
+  }
+
+  async mkdir(dir: string): Promise<void> {
+    dir = normalizePath(dir)
+    try {
+      await this._mkdir(dir)
+    } catch (error) {
+      if (error == null || error.code !== 'EEXIST') {
+        throw error
+      }
+
+      // this operation will throw if it's not already a directory
+      await this._list(dir)
+    }
+  }
+
+  async mktree(dir: string): Promise<void> {
+    await this._mktree(normalizePath(dir))
+  }
+
+  async openFile(path: string, flags: string): Promise<FileDescriptor> {
+    path = normalizePath(path)
+
+    return {
+      fd: await timeout.call(this._openFile(path, flags), this._timeout),
+      path,
+    }
+  }
+
+  async outputFile(
+    file: string,
+    data: Data,
+    { flags = 'wx' }: { flags?: string } = {}
+  ): Promise<void> {
+    await this._outputFile(normalizePath(file), data, { flags })
+  }
+
+  async read(
+    file: File,
+    buffer: Buffer,
+    position?: number
+  ): Promise<{| bytesRead: number, buffer: Buffer |}> {
+    return this._read(
+      typeof file === 'string' ? normalizePath(file) : file,
+      buffer,
+      position
+    )
+  }
+
+  async readFile(
+    file: string,
+    { flags = 'r' }: { flags?: string } = {}
+  ): Promise<Buffer> {
+    return this._readFile(normalizePath(file), { flags })
+  }
+
+  async refreshChecksum(path: string): Promise<void> {
+    path = normalizePath(path)
+
+    const stream = (await this._createReadStream(path, { flags: 'r' })).pipe(
+      createChecksumStream()
+    )
+    stream.resume() // start reading the whole file
+    await this._outputFile(checksumFile(path), await stream.checksum, {
+      flags: 'wx',
+    })
+  }
+
+  async rename(
+    oldPath: string,
+    newPath: string,
+    { checksum = false }: Object = {}
+  ) {
+    oldPath = normalizePath(oldPath)
+    newPath = normalizePath(newPath)
+
+    let p = timeout.call(this._rename(oldPath, newPath), this._timeout)
+    if (checksum) {
+      p = Promise.all([
+        p,
+        this._rename(checksumFile(oldPath), checksumFile(newPath)),
+      ])
+    }
+    return p
+  }
+
+  async rmdir(dir: string): Promise<void> {
+    await timeout.call(
+      this._rmdir(normalizePath(dir)).catch(ignoreEnoent),
+      this._timeout
+    )
+  }
+
+  async rmtree(dir: string): Promise<void> {
+    await this._rmtree(normalizePath(dir))
+  }
+
+  // Asks the handler to sync the state of the effective remote with its'
+  // metadata
+  //
+  // This method MUST ALWAYS be called before using the handler.
+  @synchronized()
+  async sync(): Promise<void> {
+    await this._sync()
+  }
+
+  async test(): Promise<Object> {
+    const SIZE = 1024 * 1024 * 10
+    const testFileName = normalizePath(`${Date.now()}.test`)
+    const data = await fromCallback(randomBytes, SIZE)
+    let step = 'write'
+    try {
+      const writeStart = process.hrtime()
+      await this._outputFile(testFileName, data, { flags: 'wx' })
+      const writeDuration = process.hrtime(writeStart)
+
+      step = 'read'
+      const readStart = process.hrtime()
+      const read = await this._readFile(testFileName, { flags: 'r' })
+      const readDuration = process.hrtime(readStart)
+
+      if (!data.equals(read)) {
+        throw new Error('output and input did not match')
+      }
+      return {
+        success: true,
+        writeRate: computeRate(writeDuration, SIZE),
+        readRate: computeRate(readDuration, SIZE),
+      }
+    } catch (error) {
+      return {
+        success: false,
+        step,
+        file: testFileName,
+        error: error.message || String(error),
+      }
+    } finally {
+      ignoreErrors.call(this._unlink(testFileName))
+    }
+  }
+
+  async truncate(file: string, len: number): Promise<void> {
+    await this._truncate(file, len)
+  }
+
+  async unlink(file: string, { checksum = true }: Object = {}): Promise<void> {
+    file = normalizePath(file)
+
     if (checksum) {
       ignoreErrors.call(this._unlink(checksumFile(file)))
     }
 
-    await timeout.call(this._unlink(file), this._timeout)
+    await this._unlink(file).catch(ignoreEnoent)
   }
 
-  async _unlink (file: mixed): Promise<void> {
+  async write(
+    file: File,
+    buffer: Buffer,
+    position: number
+  ): Promise<{| bytesWritten: number, buffer: Buffer |}> {
+    await this._write(
+      typeof file === 'string' ? normalizePath(file) : file,
+      buffer,
+      position
+    )
+  }
+
+  async writeFile(
+    file: string,
+    data: Data,
+    { flags = 'wx' }: { flags?: string } = {}
+  ): Promise<void> {
+    await this._writeFile(normalizePath(file), data, { flags })
+  }
+
+  // Methods that can be implemented by inheriting classes
+
+  async _closeFile(fd: mixed): Promise<void> {
     throw new Error('Not implemented')
   }
 
-  async getSize (file: mixed): Promise<number> {
-    return timeout.call(this._getSize(file), this._timeout)
+  async _createOutputStream(file: File, options: Object): Promise<LaxWritable> {
+    try {
+      return await this._createWriteStream(file, options)
+    } catch (error) {
+      if (typeof file !== 'string' || error.code !== 'ENOENT') {
+        throw error
+      }
+    }
+
+    await this._mktree(dirname(file))
+    return this._createOutputStream(file, options)
   }
 
-  async _getSize (file: mixed): Promise<number> {
+  async _createReadStream(file: File, options?: Object): Promise<LaxReadable> {
+    throw new Error('Not implemented')
+  }
+
+  async _createWriteStream(file: File, options: Object): Promise<LaxWritable> {
+    throw new Error('Not implemented')
+  }
+
+  // called to finalize the remote
+  async _forget(): Promise<void> {}
+
+  async _getInfo(): Promise<Object> {
+    return {}
+  }
+
+  async _getSize(file: File): Promise<number> {
+    throw new Error('Not implemented')
+  }
+
+  async _list(dir: string): Promise<string[]> {
+    throw new Error('Not implemented')
+  }
+
+  async _mkdir(dir: string): Promise<void> {
+    throw new Error('Not implemented')
+  }
+
+  async _mktree(dir: string): Promise<void> {
+    try {
+      return await this.mkdir(dir)
+    } catch (error) {
+      if (error.code !== 'ENOENT') {
+        throw error
+      }
+    }
+
+    await this._mktree(dirname(dir))
+    return this._mktree(dir)
+  }
+
+  async _openFile(path: string, flags: string): Promise<mixed> {
+    throw new Error('Not implemented')
+  }
+
+  async _outputFile(
+    file: string,
+    data: Data,
+    options: { flags?: string }
+  ): Promise<void> {
+    try {
+      return await this._writeFile(file, data, options)
+    } catch (error) {
+      if (error.code !== 'ENOENT') {
+        throw error
+      }
+    }
+
+    await this._mktree(dirname(file))
+    return this._outputFile(file, data, options)
+  }
+
+  _read(
+    file: File,
+    buffer: Buffer,
+    position?: number
+  ): Promise<{| bytesRead: number, buffer: Buffer |}> {
+    throw new Error('Not implemented')
+  }
+
+  _readFile(file: string, options?: Object): Promise<Buffer> {
+    return this._createReadStream(file, options).then(getStream.buffer)
+  }
+
+  async _rename(oldPath: string, newPath: string) {
+    throw new Error('Not implemented')
+  }
+
+  async _rmdir(dir: string) {
+    throw new Error('Not implemented')
+  }
+
+  async _rmtree(dir: string) {
+    try {
+      return await this._rmdir(dir)
+    } catch (error) {
+      if (error.code !== 'ENOTEMPTY') {
+        throw error
+      }
+    }
+
+    const files = await this._list(dir)
+    await asyncMap(files, file =>
+      this._unlink(`${dir}/${file}`).catch(error => {
+        if (error.code === 'EISDIR') {
+          return this._rmtree(`${dir}/${file}`)
+        }
+        throw error
+      })
+    )
+    return this._rmtree(dir)
+  }
+
+  // called to initialize the remote
+  async _sync(): Promise<void> {}
+
+  async _unlink(file: string): Promise<void> {
+    throw new Error('Not implemented')
+  }
+
+  async _write(file: File, buffer: Buffer, position: number): Promise<void> {
+    const isPath = typeof file === 'string'
+    if (isPath) {
+      file = await this.openFile(file, 'r+')
+    }
+    try {
+      return await this._writeFd(file, buffer, position)
+    } finally {
+      if (isPath) {
+        await this.closeFile(file)
+      }
+    }
+  }
+
+  async _writeFd(
+    fd: FileDescriptor,
+    buffer: Buffer,
+    position: number
+  ): Promise<void> {
+    throw new Error('Not implemented')
+  }
+
+  async _writeFile(
+    file: string,
+    data: Data,
+    options: { flags?: string }
+  ): Promise<void> {
     throw new Error('Not implemented')
   }
 }
+
+function createPrefixWrapperMethods() {
+  const pPw = PrefixWrapper.prototype
+  const pRha = RemoteHandlerAbstract.prototype
+
+  const {
+    defineProperty,
+    getOwnPropertyDescriptor,
+    prototype: { hasOwnProperty },
+  } = Object
+
+  Object.getOwnPropertyNames(pRha).forEach(name => {
+    let descriptor, value
+    if (
+      hasOwnProperty.call(pPw, name) ||
+      name[0] === '_' ||
+      typeof (value = (descriptor = getOwnPropertyDescriptor(pRha, name))
+        .value) !== 'function'
+    ) {
+      return
+    }
+
+    descriptor.value = function() {
+      let path
+      if (arguments.length !== 0 && typeof (path = arguments[0]) === 'string') {
+        arguments[0] = this._resolve(path)
+      }
+      return value.apply(this._handler, arguments)
+    }
+
+    defineProperty(pPw, name, descriptor)
+  })
+}
+createPrefixWrapperMethods()

@xen-orchestra/fs/src/abstract.spec.js

@@ -7,7 +7,7 @@ import AbstractHandler from './abstract'
 const TIMEOUT = 10e3
 
 class TestHandler extends AbstractHandler {
-  constructor (impl) {
+  constructor(impl) {
     super({ url: 'test://' }, { timeout: TIMEOUT })
 
     Object.keys(impl).forEach(method => {
@@ -16,53 +16,7 @@ class TestHandler extends AbstractHandler {
   }
 }
 
-describe('rename()', () => {
-  it(`throws in case of timeout`, async () => {
-    const testHandler = new TestHandler({
-      rename: () => new Promise(() => {}),
-    })
-
-    const promise = testHandler.rename('oldPath', 'newPath')
-    jest.advanceTimersByTime(TIMEOUT)
-    await expect(promise).rejects.toThrowError(TimeoutError)
-  })
-})
-
-describe('list()', () => {
-  it(`throws in case of timeout`, async () => {
-    const testHandler = new TestHandler({
-      list: () => new Promise(() => {}),
-    })
-
-    const promise = testHandler.list()
-    jest.advanceTimersByTime(TIMEOUT)
-    await expect(promise).rejects.toThrowError(TimeoutError)
-  })
-})
-
-describe('createReadStream()', () => {
-  it(`throws in case of timeout`, async () => {
-    const testHandler = new TestHandler({
-      createReadStream: () => new Promise(() => {}),
-    })
-
-    const promise = testHandler.createReadStream('file')
-    jest.advanceTimersByTime(TIMEOUT)
-    await expect(promise).rejects.toThrowError(TimeoutError)
-  })
-})
-
-describe('openFile()', () => {
-  it(`throws in case of timeout`, async () => {
-    const testHandler = new TestHandler({
-      openFile: () => new Promise(() => {}),
-    })
-
-    const promise = testHandler.openFile('path')
-    jest.advanceTimersByTime(TIMEOUT)
-    await expect(promise).rejects.toThrowError(TimeoutError)
-  })
-})
+jest.useFakeTimers()
 
 describe('closeFile()', () => {
   it(`throws in case of timeout`, async () => {
@@ -88,13 +42,25 @@ describe('createOutputStream()', () => {
   })
 })
 
-describe('unlink()', () => {
+describe('createReadStream()', () => {
   it(`throws in case of timeout`, async () => {
     const testHandler = new TestHandler({
-      unlink: () => new Promise(() => {}),
+      createReadStream: () => new Promise(() => {}),
     })
 
-    const promise = testHandler.unlink('')
+    const promise = testHandler.createReadStream('file')
+    jest.advanceTimersByTime(TIMEOUT)
+    await expect(promise).rejects.toThrowError(TimeoutError)
+  })
+})
+
+describe('getInfo()', () => {
+  it('throws in case of timeout', async () => {
+    const testHandler = new TestHandler({
+      getInfo: () => new Promise(() => {}),
+    })
+
+    const promise = testHandler.getInfo()
     jest.advanceTimersByTime(TIMEOUT)
     await expect(promise).rejects.toThrowError(TimeoutError)
   })
@@ -111,3 +77,51 @@ describe('getSize()', () => {
     await expect(promise).rejects.toThrowError(TimeoutError)
   })
 })
+
+describe('list()', () => {
+  it(`throws in case of timeout`, async () => {
+    const testHandler = new TestHandler({
+      list: () => new Promise(() => {}),
+    })
+
+    const promise = testHandler.list('.')
+    jest.advanceTimersByTime(TIMEOUT)
+    await expect(promise).rejects.toThrowError(TimeoutError)
+  })
+})
+
+describe('openFile()', () => {
+  it(`throws in case of timeout`, async () => {
+    const testHandler = new TestHandler({
+      openFile: () => new Promise(() => {}),
+    })
+
+    const promise = testHandler.openFile('path')
+    jest.advanceTimersByTime(TIMEOUT)
+    await expect(promise).rejects.toThrowError(TimeoutError)
+  })
+})
+
+describe('rename()', () => {
+  it(`throws in case of timeout`, async () => {
+    const testHandler = new TestHandler({
+      rename: () => new Promise(() => {}),
+    })
+
+    const promise = testHandler.rename('oldPath', 'newPath')
+    jest.advanceTimersByTime(TIMEOUT)
+    await expect(promise).rejects.toThrowError(TimeoutError)
+  })
+})
+
+describe('rmdir()', () => {
+  it(`throws in case of timeout`, async () => {
+    const testHandler = new TestHandler({
+      rmdir: () => new Promise(() => {}),
+    })
+
+    const promise = testHandler.rmdir('dir')
+    jest.advanceTimersByTime(TIMEOUT)
+    await expect(promise).rejects.toThrowError(TimeoutError)
+  })
+})

@xen-orchestra/fs/src/fs.integ.spec.js

@@ -1,26 +0,0 @@
-/* eslint-env jest */
-
-import rimraf from 'rimraf'
-import tmp from 'tmp'
-import { pFromCallback } from 'promise-toolbox'
-
-import { getHandler } from '.'
-
-const initialDir = process.cwd()
-
-beforeEach(async () => {
-  const dir = await pFromCallback(cb => tmp.dir(cb))
-  process.chdir(dir)
-})
-
-afterEach(async () => {
-  const tmpDir = process.cwd()
-  process.chdir(initialDir)
-  await pFromCallback(cb => rimraf(tmpDir, cb))
-})
-
-test("fs test doesn't crash", async () => {
-  const handler = getHandler({ url: 'file://' + process.cwd() })
-  const result = await handler.test()
-  expect(result.success).toBeTruthy()
-})

@xen-orchestra/fs/src/fs.spec.js

@@ -0,0 +1,379 @@
+/* eslint-env jest */
+
+import 'dotenv/config'
+import asyncIteratorToStream from 'async-iterator-to-stream'
+import getStream from 'get-stream'
+import { forOwn, random } from 'lodash'
+import { fromCallback } from 'promise-toolbox'
+import { pipeline } from 'readable-stream'
+import { tmpdir } from 'os'
+
+import { getHandler } from '.'
+
+// https://gist.github.com/julien-f/3228c3f34fdac01ade09
+const unsecureRandomBytes = n => {
+  const bytes = Buffer.alloc(n)
+
+  const odd = n & 1
+  for (let i = 0, m = n - odd; i < m; i += 2) {
+    bytes.writeUInt16BE((Math.random() * 65536) | 0, i)
+  }
+
+  if (odd) {
+    bytes.writeUInt8((Math.random() * 256) | 0, n - 1)
+  }
+
+  return bytes
+}
+
+const TEST_DATA_LEN = 1024
+const TEST_DATA = unsecureRandomBytes(TEST_DATA_LEN)
+const createTestDataStream = asyncIteratorToStream(function*() {
+  yield TEST_DATA
+})
+
+const rejectionOf = p =>
+  p.then(
+    value => {
+      throw value
+    },
+    reason => reason
+  )
+
+const handlers = [`file://${tmpdir()}`]
+if (process.env.xo_fs_nfs) handlers.push(process.env.xo_fs_nfs)
+if (process.env.xo_fs_smb) handlers.push(process.env.xo_fs_smb)
+
+handlers.forEach(url => {
+  describe(url, () => {
+    let handler
+
+    const testWithFileDescriptor = (path, flags, fn) => {
+      it('with path', () => fn({ file: path, flags }))
+      it('with file descriptor', async () => {
+        const file = await handler.openFile(path, flags)
+        try {
+          await fn({ file })
+        } finally {
+          await handler.closeFile(file)
+        }
+      })
+    }
+
+    beforeAll(async () => {
+      handler = getHandler({ url }).addPrefix(`xo-fs-tests-${Date.now()}`)
+      await handler.sync()
+    })
+    afterAll(async () => {
+      await handler.forget()
+      handler = undefined
+    })
+
+    beforeEach(async () => {
+      // ensure test dir exists
+      await handler.mkdir('.')
+    })
+    afterEach(async () => {
+      await handler.rmtree('.')
+    })
+
+    describe('#type', () => {
+      it('returns the type of the remote', () => {
+        expect(typeof handler.type).toBe('string')
+      })
+    })
+
+    describe('#createOutputStream()', () => {
+      it('creates parent dir if missing', async () => {
+        const stream = await handler.createOutputStream('dir/file')
+        await fromCallback(pipeline, createTestDataStream(), stream)
+        await expect(await handler.readFile('dir/file')).toEqual(TEST_DATA)
+      })
+    })
+
+    describe('#createReadStream()', () => {
+      beforeEach(() => handler.outputFile('file', TEST_DATA))
+
+      testWithFileDescriptor('file', 'r', async ({ file, flags }) => {
+        await expect(
+          await getStream.buffer(
+            await handler.createReadStream(file, { flags })
+          )
+        ).toEqual(TEST_DATA)
+      })
+    })
+
+    describe('#createWriteStream()', () => {
+      testWithFileDescriptor('file', 'wx', async ({ file, flags }) => {
+        const stream = await handler.createWriteStream(file, { flags })
+        await fromCallback(pipeline, createTestDataStream(), stream)
+        await expect(await handler.readFile('file')).toEqual(TEST_DATA)
+      })
+
+      it('fails if parent dir is missing', async () => {
+        const error = await rejectionOf(handler.createWriteStream('dir/file'))
+        expect(error.code).toBe('ENOENT')
+      })
+    })
+
+    describe('#getInfo()', () => {
+      let info
+      beforeAll(async () => {
+        info = await handler.getInfo()
+      })
+
+      it('should return an object with info', async () => {
+        expect(typeof info).toBe('object')
+      })
+
+      it('should return correct type of attribute', async () => {
+        if (info.size !== undefined) {
+          expect(typeof info.size).toBe('number')
+        }
+        if (info.used !== undefined) {
+          expect(typeof info.used).toBe('number')
+        }
+      })
+    })
+
+    describe('#getSize()', () => {
+      beforeEach(() => handler.outputFile('file', TEST_DATA))
+
+      testWithFileDescriptor('file', 'r', async () => {
+        expect(await handler.getSize('file')).toEqual(TEST_DATA_LEN)
+      })
+    })
+
+    describe('#list()', () => {
+      it(`should list the content of folder`, async () => {
+        await handler.outputFile('file', TEST_DATA)
+        await expect(await handler.list('.')).toEqual(['file'])
+      })
+
+      it('can prepend the directory to entries', async () => {
+        await handler.outputFile('dir/file', '')
+        expect(await handler.list('dir', { prependDir: true })).toEqual([
+          '/dir/file',
+        ])
+      })
+
+      it('can prepend the directory to entries', async () => {
+        await handler.outputFile('dir/file', '')
+        expect(await handler.list('dir', { prependDir: true })).toEqual([
+          '/dir/file',
+        ])
+      })
+    })
+
+    describe('#mkdir()', () => {
+      it('creates a directory', async () => {
+        await handler.mkdir('dir')
+        await expect(await handler.list('.')).toEqual(['dir'])
+      })
+
+      it('does not throw on existing directory', async () => {
+        await handler.mkdir('dir')
+        await handler.mkdir('dir')
+      })
+
+      it('throws ENOTDIR on existing file', async () => {
+        await handler.outputFile('file', '')
+        const error = await rejectionOf(handler.mkdir('file'))
+        expect(error.code).toBe('ENOTDIR')
+      })
+    })
+
+    describe('#mktree()', () => {
+      it('creates a tree of directories', async () => {
+        await handler.mktree('dir/dir')
+        await expect(await handler.list('.')).toEqual(['dir'])
+        await expect(await handler.list('dir')).toEqual(['dir'])
+      })
+
+      it('does not throw on existing directory', async () => {
+        await handler.mktree('dir/dir')
+        await handler.mktree('dir/dir')
+      })
+
+      it('throws ENOTDIR on existing file', async () => {
+        await handler.outputFile('dir/file', '')
+        const error = await rejectionOf(handler.mktree('dir/file'))
+        expect(error.code).toBe('ENOTDIR')
+      })
+
+      it('throws ENOTDIR on existing file in path', async () => {
+        await handler.outputFile('file', '')
+        const error = await rejectionOf(handler.mktree('file/dir'))
+        expect(error.code).toBe('ENOTDIR')
+      })
+    })
+
+    describe('#outputFile()', () => {
+      it('writes data to a file', async () => {
+        await handler.outputFile('file', TEST_DATA)
+        expect(await handler.readFile('file')).toEqual(TEST_DATA)
+      })
+
+      it('throws on existing files', async () => {
+        await handler.outputFile('file', '')
+        const error = await rejectionOf(handler.outputFile('file', ''))
+        expect(error.code).toBe('EEXIST')
+      })
+    })
+
+    describe('#read()', () => {
+      beforeEach(() => handler.outputFile('file', TEST_DATA))
+
+      const start = random(TEST_DATA_LEN)
+      const size = random(TEST_DATA_LEN)
+
+      testWithFileDescriptor('file', 'r', async ({ file }) => {
+        const buffer = Buffer.alloc(size)
+        const result = await handler.read(file, buffer, start)
+        expect(result.buffer).toBe(buffer)
+        expect(result).toEqual({
+          buffer,
+          bytesRead: Math.min(size, TEST_DATA_LEN - start),
+        })
+      })
+    })
+
+    describe('#readFile', () => {
+      it('returns a buffer containing the contents of the file', async () => {
+        await handler.outputFile('file', TEST_DATA)
+        expect(await handler.readFile('file')).toEqual(TEST_DATA)
+      })
+
+      it('throws on missing file', async () => {
+        const error = await rejectionOf(handler.readFile('file'))
+        expect(error.code).toBe('ENOENT')
+      })
+    })
+
+    describe('#rename()', () => {
+      it(`should rename the file`, async () => {
+        await handler.outputFile('file', TEST_DATA)
+        await handler.rename('file', `file2`)
+
+        expect(await handler.list('.')).toEqual(['file2'])
+        expect(await handler.readFile(`file2`)).toEqual(TEST_DATA)
+      })
+    })
+
+    describe('#rmdir()', () => {
+      it('should remove an empty directory', async () => {
+        await handler.mkdir('dir')
+        await handler.rmdir('dir')
+        expect(await handler.list('.')).toEqual([])
+      })
+
+      it(`should throw on non-empty directory`, async () => {
+        await handler.outputFile('dir/file', '')
+
+        const error = await rejectionOf(handler.rmdir('.'))
+        await expect(error.code).toEqual('ENOTEMPTY')
+      })
+
+      it('does not throw on missing directory', async () => {
+        await handler.rmdir('dir')
+      })
+    })
+
+    describe('#rmtree', () => {
+      it(`should remove a directory resursively`, async () => {
+        await handler.outputFile('dir/file', '')
+        await handler.rmtree('dir')
+
+        expect(await handler.list('.')).toEqual([])
+      })
+    })
+
+    describe('#test()', () => {
+      it('tests the remote appears to be working', async () => {
+        const answer = await handler.test()
+
+        expect(answer.success).toBe(true)
+        expect(typeof answer.writeRate).toBe('number')
+        expect(typeof answer.readRate).toBe('number')
+      })
+    })
+
+    describe('#unlink()', () => {
+      it(`should remove the file`, async () => {
+        await handler.outputFile('file', TEST_DATA)
+        await handler.unlink('file')
+
+        await expect(await handler.list('.')).toEqual([])
+      })
+
+      it('does not throw on missing file', async () => {
+        await handler.unlink('file')
+      })
+    })
+
+    describe('#write()', () => {
+      beforeEach(() => handler.outputFile('file', TEST_DATA))
+
+      const PATCH_DATA_LEN = Math.ceil(TEST_DATA_LEN / 2)
+      const PATCH_DATA = unsecureRandomBytes(PATCH_DATA_LEN)
+
+      forOwn(
+        {
+          'dont increase file size': (() => {
+            const offset = random(0, TEST_DATA_LEN - PATCH_DATA_LEN)
+
+            const expected = Buffer.from(TEST_DATA)
+            PATCH_DATA.copy(expected, offset)
+
+            return { offset, expected }
+          })(),
+          'increase file size': (() => {
+            const offset = random(
+              TEST_DATA_LEN - PATCH_DATA_LEN + 1,
+              TEST_DATA_LEN
+            )
+
+            const expected = Buffer.alloc(offset + PATCH_DATA_LEN)
+            TEST_DATA.copy(expected)
+            PATCH_DATA.copy(expected, offset)
+
+            return { offset, expected }
+          })(),
+        },
+        ({ offset, expected }, title) => {
+          describe(title, () => {
+            testWithFileDescriptor('file', 'r+', async ({ file }) => {
+              await handler.write(file, PATCH_DATA, offset)
+              await expect(await handler.readFile('file')).toEqual(expected)
+            })
+          })
+        }
+      )
+    })
+
+    describe('#truncate()', () => {
+      forOwn(
+        {
+          'shrinks file': (() => {
+            const length = random(0, TEST_DATA_LEN)
+            const expected = TEST_DATA.slice(0, length)
+            return { length, expected }
+          })(),
+          'grows file': (() => {
+            const length = random(TEST_DATA_LEN, TEST_DATA_LEN * 2)
+            const expected = Buffer.alloc(length)
+            TEST_DATA.copy(expected)
+            return { length, expected }
+          })(),
+        },
+        ({ length, expected }, title) => {
+          it(title, async () => {
+            await handler.outputFile('file', TEST_DATA)
+            await handler.truncate('file', length)
+            await expect(await handler.readFile('file')).toEqual(expected)
+          })
+        }
+      )
+    })
+  })
+})

@xen-orchestra/fs/src/index.js

@@ -1,19 +1,27 @@
 // @flow
+import execa from 'execa'
 
 import type RemoteHandler from './abstract'
 import RemoteHandlerLocal from './local'
 import RemoteHandlerNfs from './nfs'
 import RemoteHandlerSmb from './smb'
+import RemoteHandlerSmbMount from './smb-mount'
 
 export type { default as RemoteHandler } from './abstract'
 export type Remote = { url: string }
 
 const HANDLERS = {
   file: RemoteHandlerLocal,
-  smb: RemoteHandlerSmb,
   nfs: RemoteHandlerNfs,
 }
 
+try {
+  execa.sync('mount.cifs', ['-V'])
+  HANDLERS.smb = RemoteHandlerSmbMount
+} catch (_) {
+  HANDLERS.smb = RemoteHandlerSmb
+}
+
 export const getHandler = (remote: Remote, ...rest: any): RemoteHandler => {
   // FIXME: should be done in xo-remote-parser.
   const type = remote.url.split('://')[0]

@xen-orchestra/fs/src/local.js

@@ -1,50 +1,87 @@
+import df from '@sindresorhus/df'
 import fs from 'fs-extra'
-import { dirname, resolve } from 'path'
-import { noop, startsWith } from 'lodash'
+import { fromEvent } from 'promise-toolbox'
 
 import RemoteHandlerAbstract from './abstract'
 
 export default class LocalHandler extends RemoteHandlerAbstract {
-  get type () {
+  get type() {
     return 'file'
   }
 
-  _getRealPath () {
+  _getRealPath() {
     return this._remote.path
   }
 
-  _getFilePath (file) {
-    const realPath = this._getRealPath()
-    const parts = [realPath]
-    if (file) {
-      parts.push(file)
+  _getFilePath(file) {
+    return this._getRealPath() + file
+  }
+
+  async _closeFile(fd) {
+    return fs.close(fd)
+  }
+
+  async _createReadStream(file, options) {
+    if (typeof file === 'string') {
+      const stream = fs.createReadStream(this._getFilePath(file), options)
+      await fromEvent(stream, 'open')
+      return stream
     }
-    const path = resolve.apply(null, parts)
-    if (!startsWith(path, realPath)) {
-      throw new Error('Remote path is unavailable')
+    return fs.createReadStream('', {
+      autoClose: false,
+      ...options,
+      fd: file.fd,
+    })
+  }
+
+  async _createWriteStream(file, options) {
+    if (typeof file === 'string') {
+      const stream = fs.createWriteStream(this._getFilePath(file), options)
+      await fromEvent(stream, 'open')
+      return stream
     }
-    return path
+    return fs.createWriteStream('', {
+      autoClose: false,
+      ...options,
+      fd: file.fd,
+    })
   }
 
-  async _sync () {
-    const path = this._getRealPath()
-    await fs.ensureDir(path)
-    await fs.access(path, fs.R_OK | fs.W_OK)
+  async _getInfo() {
+    // df.file() resolves with an object with the following properties:
+    // filesystem, type, size, used, available, capacity and mountpoint.
+    // size, used, available and capacity may be `NaN` so we remove any `NaN`
+    // value from the object.
+    const info = await df.file(this._getFilePath('/'))
+    Object.keys(info).forEach(key => {
+      if (Number.isNaN(info[key])) {
+        delete info[key]
+      }
+    })
 
-    return this._remote
+    return info
   }
 
-  async _forget () {
-    return noop()
+  async _getSize(file) {
+    const stats = await fs.stat(
+      this._getFilePath(typeof file === 'string' ? file : file.path)
+    )
+    return stats.size
   }
 
-  async _outputFile (file, data, options) {
-    const path = this._getFilePath(file)
-    await fs.ensureDir(dirname(path))
-    await fs.writeFile(path, data, options)
+  async _list(dir) {
+    return fs.readdir(this._getFilePath(dir))
   }
 
-  async _read (file, buffer, position) {
+  _mkdir(dir) {
+    return fs.mkdir(this._getFilePath(dir))
+  }
+
+  async _openFile(path, flags) {
+    return fs.open(this._getFilePath(path), flags)
+  }
+
+  async _read(file, buffer, position) {
     const needsClose = typeof file === 'string'
     file = needsClose ? await fs.open(this._getFilePath(file), 'r') : file.fd
     try {
@@ -62,62 +99,37 @@ export default class LocalHandler extends RemoteHandlerAbstract {
     }
   }
 
-  async _readFile (file, options) {
+  async _readFile(file, options) {
     return fs.readFile(this._getFilePath(file), options)
   }
 
-  async _rename (oldPath, newPath) {
+  async _rename(oldPath, newPath) {
     return fs.rename(this._getFilePath(oldPath), this._getFilePath(newPath))
   }
 
-  async _list (dir = '.') {
-    return fs.readdir(this._getFilePath(dir))
+  async _rmdir(dir) {
+    return fs.rmdir(this._getFilePath(dir))
   }
 
-  async _createReadStream (file, options) {
-    return typeof file === 'string'
-      ? fs.createReadStream(this._getFilePath(file), options)
-      : fs.createReadStream('', {
-          autoClose: false,
-          ...options,
-          fd: file.fd,
-        })
+  async _sync() {
+    const path = this._getRealPath('/')
+    await fs.ensureDir(path)
+    await fs.access(path, fs.R_OK | fs.W_OK)
   }
 
-  async _createOutputStream (file, options) {
-    if (typeof file === 'string') {
-      const path = this._getFilePath(file)
-      await fs.ensureDir(dirname(path))
-      return fs.createWriteStream(path, options)
-    }
-    return fs.createWriteStream('', {
-      autoClose: false,
-      ...options,
-      fd: file.fd,
-    })
+  _truncate(file, len) {
+    return fs.truncate(this._getFilePath(file), len)
   }
 
-  async _unlink (file) {
-    return fs.unlink(this._getFilePath(file)).catch(error => {
-      // do not throw if the file did not exist
-      if (error == null || error.code !== 'ENOENT') {
-        throw error
-      }
-    })
+  async _unlink(file) {
+    return fs.unlink(this._getFilePath(file))
   }
 
-  async _getSize (file) {
-    const stats = await fs.stat(
-      this._getFilePath(typeof file === 'string' ? file : file.path)
-    )
-    return stats.size
+  _writeFd(file, buffer, position) {
+    return fs.write(file.fd, buffer, 0, buffer.length, position)
   }
 
-  async _openFile (path, flags) {
-    return fs.open(this._getFilePath(path), flags)
-  }
-
-  async _closeFile (fd) {
-    return fs.close(fd)
+  _writeFile(file, data, { flags }) {
+    return fs.writeFile(this._getFilePath(file), data, { flag: flags })
   }
 }

@xen-orchestra/fs/src/nfs.js

@@ -1,86 +1,20 @@
-import execa from 'execa'
-import fs from 'fs-extra'
-import { join } from 'path'
-import { tmpdir } from 'os'
+import { parse } from 'xo-remote-parser'
 
-import LocalHandler from './local'
+import MountHandler from './_mount'
 
 const DEFAULT_NFS_OPTIONS = 'vers=3'
 
-export default class NfsHandler extends LocalHandler {
-  constructor (
-    remote,
-    { mountsDir = join(tmpdir(), 'xo-fs-mounts'), ...opts } = {}
-  ) {
-    super(remote, opts)
-
-    this._realPath = join(mountsDir, remote.id)
+export default class NfsHandler extends MountHandler {
+  constructor(remote, opts) {
+    const { host, port, path } = parse(remote.url)
+    super(remote, opts, {
+      type: 'nfs',
+      device: `${host}${port !== undefined ? ':' + port : ''}:${path}`,
+      options: DEFAULT_NFS_OPTIONS,
+    })
   }
 
-  get type () {
+  get type() {
     return 'nfs'
   }
-
-  _getRealPath () {
-    return this._realPath
-  }
-
-  async _mount () {
-    await fs.ensureDir(this._getRealPath())
-    const { host, path, port, options } = this._remote
-    return execa(
-      'mount',
-      [
-        '-t',
-        'nfs',
-        '-o',
-        DEFAULT_NFS_OPTIONS + (options !== undefined ? `,${options}` : ''),
-        `${host}${port !== undefined ? ':' + port : ''}:${path}`,
-        this._getRealPath(),
-      ],
-      {
-        env: {
-          LANG: 'C',
-        },
-      }
-    ).catch(error => {
-      if (
-        error == null ||
-        typeof error.stderr !== 'string' ||
-        !error.stderr.includes('already mounted')
-      ) {
-        throw error
-      }
-    })
-  }
-
-  async _sync () {
-    await this._mount()
-
-    return this._remote
-  }
-
-  async _forget () {
-    try {
-      await this._umount(this._remote)
-    } catch (_) {
-      // We have to go on...
-    }
-  }
-
-  async _umount () {
-    await execa('umount', ['--force', this._getRealPath()], {
-      env: {
-        LANG: 'C',
-      },
-    }).catch(error => {
-      if (
-        error == null ||
-        typeof error.stderr !== 'string' ||
-        !error.stderr.includes('not mounted')
-      ) {
-        throw error
-      }
-    })
-  }
 }

@xen-orchestra/fs/src/smb-mount.js

@@ -0,0 +1,25 @@
+import { parse } from 'xo-remote-parser'
+
+import MountHandler from './_mount'
+import normalizePath from './_normalizePath'
+
+export default class SmbMountHandler extends MountHandler {
+  constructor(remote, opts) {
+    const { domain = 'WORKGROUP', host, password, path, username } = parse(
+      remote.url
+    )
+    super(remote, opts, {
+      type: 'cifs',
+      device: '//' + host + normalizePath(path),
+      options: `domain=${domain}`,
+      env: {
+        USER: username,
+        PASSWD: password,
+      },
+    })
+  }
+
+  get type() {
+    return 'smb'
+  }
+}

@xen-orchestra/fs/src/smb.js

@@ -1,245 +1,177 @@
 import Smb2 from '@marsaud/smb2'
-import { pFinally } from 'promise-toolbox'
 
 import RemoteHandlerAbstract from './abstract'
 
-const noop = () => {}
-
 // Normalize the error code for file not found.
-class ErrorWrapper extends Error {
-  constructor (error, newCode) {
-    super(error.message)
-    this.cause = error
-    this.code = newCode
-  }
-}
+const wrapError = (error, code) => ({
+  __proto__: error,
+  cause: error,
+  code,
+})
 const normalizeError = (error, shouldBeDirectory) => {
   const { code } = error
 
-  return code === 'STATUS_OBJECT_NAME_NOT_FOUND' ||
-    code === 'STATUS_OBJECT_PATH_NOT_FOUND'
-    ? new ErrorWrapper(error, 'ENOENT')
+  throw code === 'STATUS_DIRECTORY_NOT_EMPTY'
+    ? wrapError(error, 'ENOTEMPTY')
+    : code === 'STATUS_FILE_IS_A_DIRECTORY'
+    ? wrapError(error, 'EISDIR')
+    : code === 'STATUS_NOT_A_DIRECTORY'
+    ? wrapError(error, 'ENOTDIR')
+    : code === 'STATUS_OBJECT_NAME_NOT_FOUND' ||
+      code === 'STATUS_OBJECT_PATH_NOT_FOUND'
+    ? wrapError(error, 'ENOENT')
+    : code === 'STATUS_OBJECT_NAME_COLLISION'
+    ? wrapError(error, 'EEXIST')
     : code === 'STATUS_NOT_SUPPORTED' || code === 'STATUS_INVALID_PARAMETER'
-    ? new ErrorWrapper(error, shouldBeDirectory ? 'ENOTDIR' : 'EISDIR')
+    ? wrapError(error, shouldBeDirectory ? 'ENOTDIR' : 'EISDIR')
     : error
 }
+const normalizeDirError = error => normalizeError(error, true)
 
 export default class SmbHandler extends RemoteHandlerAbstract {
-  constructor (remote, opts) {
+  constructor(remote, opts) {
     super(remote, opts)
-    this._forget = noop
+
+    // defined in _sync()
+    this._client = undefined
+
+    const prefix = this._remote.path
+    this._prefix = prefix !== '' ? prefix + '\\' : prefix
   }
 
-  get type () {
+  get type() {
     return 'smb'
   }
 
-  _getClient () {
+  _getFilePath(file) {
+    return (
+      this._prefix +
+      (typeof file === 'string' ? file : file.path)
+        .slice(1)
+        .replace(/\//g, '\\')
+    )
+  }
+
+  _dirname(file) {
+    const parts = file.split('\\')
+    parts.pop()
+    return parts.join('\\')
+  }
+
+  _closeFile(file) {
+    return this._client.close(file).catch(normalizeError)
+  }
+
+  _createReadStream(file, options) {
+    if (typeof file === 'string') {
+      file = this._getFilePath(file)
+    } else {
+      options = { autoClose: false, ...options, fd: file.fd }
+      file = ''
+    }
+    return this._client.createReadStream(file, options).catch(normalizeError)
+  }
+
+  _createWriteStream(file, options) {
+    if (typeof file === 'string') {
+      file = this._getFilePath(file)
+    } else {
+      options = { autoClose: false, ...options, fd: file.fd }
+      file = ''
+    }
+    return this._client.createWriteStream(file, options).catch(normalizeError)
+  }
+
+  _forget() {
+    const client = this._client
+    this._client = undefined
+    return client.disconnect()
+  }
+
+  _getSize(file) {
+    return this._client.getSize(this._getFilePath(file)).catch(normalizeError)
+  }
+
+  _list(dir) {
+    return this._client.readdir(this._getFilePath(dir)).catch(normalizeDirError)
+  }
+
+  _mkdir(dir) {
+    return this._client.mkdir(this._getFilePath(dir)).catch(normalizeDirError)
+  }
+
+  // TODO: add flags
+  _openFile(path, flags) {
+    return this._client
+      .open(this._getFilePath(path), flags)
+      .catch(normalizeError)
+  }
+
+  async _read(file, buffer, position) {
+    const client = this._client
+    const needsClose = typeof file === 'string'
+    file = needsClose ? await client.open(this._getFilePath(file)) : file.fd
+    try {
+      return await client.read(file, buffer, 0, buffer.length, position)
+    } catch (error) {
+      normalizeError(error)
+    } finally {
+      if (needsClose) {
+        await client.close(file)
+      }
+    }
+  }
+
+  _readFile(file, options) {
+    return this._client
+      .readFile(this._getFilePath(file), options)
+      .catch(normalizeError)
+  }
+
+  _rename(oldPath, newPath) {
+    return this._client
+      .rename(this._getFilePath(oldPath), this._getFilePath(newPath), {
+        replace: true,
+      })
+      .catch(normalizeError)
+  }
+
+  _rmdir(dir) {
+    return this._client.rmdir(this._getFilePath(dir)).catch(normalizeDirError)
+  }
+
+  _sync() {
     const remote = this._remote
 
-    return new Smb2({
+    this._client = new Smb2({
       share: `\\\\${remote.host}`,
       domain: remote.domain,
       username: remote.username,
       password: remote.password,
       autoCloseTimeout: 0,
     })
-  }
 
-  _getFilePath (file) {
-    if (file === '.') {
-      file = undefined
-    }
-
-    let path = this._remote.path !== '' ? this._remote.path : ''
-
-    // Ensure remote path is a directory.
-    if (path !== '' && path[path.length - 1] !== '\\') {
-      path += '\\'
-    }
-
-    if (file) {
-      path += file.replace(/\//g, '\\')
-    }
-
-    return path
-  }
-
-  _dirname (file) {
-    const parts = file.split('\\')
-    parts.pop()
-    return parts.join('\\')
-  }
-
-  async _sync () {
     // Check access (smb2 does not expose connect in public so far...)
-    await this.list()
-
-    return this._remote
+    return this.list('.')
   }
 
-  async _outputFile (file, data, options = {}) {
-    const client = this._getClient()
-    const path = this._getFilePath(file)
-    const dir = this._dirname(path)
-
-    if (dir) {
-      await client.ensureDir(dir)
-    }
-
-    return client.writeFile(path, data, options)::pFinally(() => {
-      client.disconnect()
-    })
+  _truncate(file, len) {
+    return this._client
+      .truncate(this._getFilePath(file), len)
+      .catch(normalizeError)
   }
 
-  async _read (file, buffer, position) {
-    const needsClose = typeof file === 'string'
-
-    let client
-    if (needsClose) {
-      client = this._getClient()
-      file = await client.open(this._getFilePath(file))
-    } else {
-      ;({ client, file } = file.fd)
-    }
-
-    try {
-      return await client.read(file, buffer, 0, buffer.length, position)
-    } finally {
-      if (needsClose) {
-        await client.close(file)
-        client.disconnect()
-      }
-    }
+  _unlink(file) {
+    return this._client.unlink(this._getFilePath(file)).catch(normalizeError)
   }
 
-  async _readFile (file, options = {}) {
-    const client = this._getClient()
-    let content
-
-    try {
-      content = await client
-        .readFile(this._getFilePath(file), options)
-        ::pFinally(() => {
-          client.disconnect()
-        })
-    } catch (error) {
-      throw normalizeError(error)
-    }
-
-    return content
+  _writeFd(file, buffer, position) {
+    return this._client.write(file.fd, buffer, 0, buffer.length, position)
   }
 
-  async _rename (oldPath, newPath) {
-    const client = this._getClient()
-
-    try {
-      await client
-        .rename(this._getFilePath(oldPath), this._getFilePath(newPath), {
-          replace: true,
-        })
-        ::pFinally(() => {
-          client.disconnect()
-        })
-    } catch (error) {
-      throw normalizeError(error)
-    }
-  }
-
-  async _list (dir = '.') {
-    const client = this._getClient()
-    let list
-
-    try {
-      list = await client.readdir(this._getFilePath(dir))::pFinally(() => {
-        client.disconnect()
-      })
-    } catch (error) {
-      throw normalizeError(error, true)
-    }
-
-    return list
-  }
-
-  async _createReadStream (file, options = {}) {
-    if (typeof file !== 'string') {
-      file = file.path
-    }
-    const client = this._getClient()
-    let stream
-
-    try {
-      // FIXME ensure that options are properly handled by @marsaud/smb2
-      stream = await client.createReadStream(this._getFilePath(file), options)
-      stream.on('end', () => client.disconnect())
-    } catch (error) {
-      throw normalizeError(error)
-    }
-
-    return stream
-  }
-
-  async _createOutputStream (file, options = {}) {
-    if (typeof file !== 'string') {
-      file = file.path
-    }
-    const client = this._getClient()
-    const path = this._getFilePath(file)
-    const dir = this._dirname(path)
-    let stream
-    try {
-      if (dir) {
-        await client.ensureDir(dir)
-      }
-      stream = await client.createWriteStream(path, options) // FIXME ensure that options are properly handled by @marsaud/smb2
-    } catch (err) {
-      client.disconnect()
-      throw err
-    }
-    stream.on('finish', () => client.disconnect())
-    return stream
-  }
-
-  async _unlink (file) {
-    const client = this._getClient()
-
-    try {
-      await client.unlink(this._getFilePath(file))::pFinally(() => {
-        client.disconnect()
-      })
-    } catch (error) {
-      throw normalizeError(error)
-    }
-  }
-
-  async _getSize (file) {
-    const client = await this._getClient()
-    let size
-
-    try {
-      size = await client
-        .getSize(this._getFilePath(typeof file === 'string' ? file : file.path))
-        ::pFinally(() => {
-          client.disconnect()
-        })
-    } catch (error) {
-      throw normalizeError(error)
-    }
-
-    return size
-  }
-
-  // TODO: add flags
-  async _openFile (path) {
-    const client = this._getClient()
-    return {
-      client,
-      file: await client.open(this._getFilePath(path)),
-    }
-  }
-
-  async _closeFile ({ client, file }) {
-    await client.close(file)
-    client.disconnect()
+  _writeFile(file, data, options) {
+    return this._client
+      .writeFile(this._getFilePath(file), data, options)
+      .catch(normalizeError)
   }
 }

@xen-orchestra/log/README.md

@@ -15,7 +15,7 @@ Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/log):
 Everywhere something should be logged:
 
 ```js
-import createLogger from '@xen-orchestra/log'
+import { createLogger } from '@xen-orchestra/log'
 
 const log = createLogger('my-module')
 
@@ -24,11 +24,25 @@ log.info('this information is relevant to the user')
 log.warn('something went wrong but did not prevent current action')
 log.error('something went wrong')
 log.fatal('service/app is going down')
+
+// you can add contextual info
+log.debug('new API request', {
+  method: 'foo',
+  params: [ 'bar', 'baz' ]
+  user: 'qux'
+})
+
+// by convention, errors go into the `error` field
+log.error('could not join server', {
+  error,
+  server: 'example.org',
+})
 ```
 
 Then, at application level, configure the logs are handled:
 
 ```js
+import { createLogger } from '@xen-orchestra/log'
 import { configure, catchGlobalErrors } from '@xen-orchestra/log/configure'
 import transportConsole from '@xen-orchestra/log/transports/console'
 import transportEmail from '@xen-orchestra/log/transports/email'
@@ -37,13 +51,10 @@ const transport = transportEmail({
   service: 'gmail',
   auth: {
     user: 'jane.smith@gmail.com',
-    pass: 'H&NbECcpXF|pyXe#%ZEb'
+    pass: 'H&NbECcpXF|pyXe#%ZEb',
   },
   from: 'jane.smith@gmail.com',
-  to: [
-    'jane.smith@gmail.com',
-    'sam.doe@yahoo.com'
-  ]
+  to: ['jane.smith@gmail.com', 'sam.doe@yahoo.com'],
 })
 
 configure([
@@ -53,19 +64,19 @@ configure([
     // matched against the namespace of the logs
     filter: process.env.DEBUG,
 
-    transport: transportConsole()
+    transport: transportConsole(),
   },
   {
     // only levels >= warn
     level: 'warn',
 
-    transport
-  }
+    transport,
+  },
 ])
 
 // send all global errors (uncaught exceptions, warnings, unhandled rejections)
-// to this transport
-catchGlobalErrors(transport)
+// to this logger
+catchGlobalErrors(createLogger('app'))
 ```
 
 ### Transports
@@ -75,7 +86,7 @@ catchGlobalErrors(transport)
 ```js
 import transportConsole from '@xen-orchestra/log/transports/console'
 
-configure(transports.console())
+configure(transportConsole())
 ```
 
 #### Email
@@ -91,18 +102,17 @@ Configuration:
 ```js
 import transportEmail from '@xen-orchestra/log/transports/email'
 
-configure(transportEmail({
-  service: 'gmail',
-  auth: {
-    user: 'jane.smith@gmail.com',
-    pass: 'H&NbECcpXF|pyXe#%ZEb'
-  },
-  from: 'jane.smith@gmail.com',
-  to: [
-    'jane.smith@gmail.com',
-    'sam.doe@yahoo.com'
-  ]
-}))
+configure(
+  transportEmail({
+    service: 'gmail',
+    auth: {
+      user: 'jane.smith@gmail.com',
+      pass: 'H&NbECcpXF|pyXe#%ZEb',
+    },
+    from: 'jane.smith@gmail.com',
+    to: ['jane.smith@gmail.com', 'sam.doe@yahoo.com'],
+  })
+)
 ```
 
 #### Syslog
@@ -146,7 +156,7 @@ configure(transportSyslog('tcp://syslog.company.lan'))
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may:

@xen-orchestra/log/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@xen-orchestra/log",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "license": "ISC",
   "description": "",
   "keywords": [],
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/log",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/log",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -26,20 +27,20 @@
     ">2%"
   ],
   "engines": {
-    "node": ">=4"
+    "node": ">=6"
   },
   "dependencies": {
     "lodash": "^4.17.4",
-    "promise-toolbox": "^0.11.0"
+    "promise-toolbox": "^0.15.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-lodash": "^3.3.2",
-    "cross-env": "^5.1.3",
+    "cross-env": "^6.0.3",
     "index-modules": "^0.3.0",
-    "rimraf": "^2.6.2"
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -47,6 +48,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepare": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/log/src/configure.js

@@ -12,14 +12,15 @@ const createTransport = config => {
   if (Array.isArray(config)) {
     const transports = config.map(createTransport)
     const { length } = transports
-    return function () {
+    return function() {
       for (let i = 0; i < length; ++i) {
         transports[i].apply(this, arguments)
       }
     }
   }
 
-  let { filter, transport } = config
+  let { filter } = config
+  let transport = createTransport(config.transport)
   const level = resolve(config.level)
 
   if (filter !== undefined) {
@@ -29,14 +30,14 @@ const createTransport = config => {
     }
 
     const orig = transport
-    transport = function (log) {
+    transport = function(log) {
       if ((level !== undefined && log.level >= level) || filter(log)) {
         return orig.apply(this, arguments)
       }
     }
   } else if (level !== undefined) {
     const orig = transport
-    transport = function (log) {
+    transport = function(log) {
       if (log.level >= level) {
         return orig.apply(this, arguments)
       }
@@ -51,11 +52,12 @@ const symbol =
     ? Symbol.for('@xen-orchestra/log')
     : '@@@xen-orchestra/log'
 
+const { env } = process
 global[symbol] = createTransport({
   // display warnings or above, and all that are enabled via DEBUG or
   // NODE_DEBUG env
-  filter: process.env.DEBUG || process.env.NODE_DEBUG,
-  level: LEVELS.INFO,
+  filter: [env.DEBUG, env.NODE_DEBUG].filter(Boolean).join(','),
+  level: resolve(env.LOG_LEVEL, LEVELS.INFO),
 
   transport: createConsoleTransport(),
 })
@@ -85,7 +87,7 @@ export const catchGlobalErrors = logger => {
   const EventEmitter = require('events')
   const { prototype } = EventEmitter
   const { emit } = prototype
-  function patchedEmit (event, error) {
+  function patchedEmit(event, error) {
     if (event === 'error' && this.listenerCount(event) === 0) {
       logger.error('unhandled error event', { error })
       return false

@xen-orchestra/log/src/index.js

@@ -1,5 +1,5 @@
 import createTransport from './transports/console'
-import LEVELS from './levels'
+import LEVELS, { resolve } from './levels'
 
 const symbol =
   typeof Symbol !== 'undefined'
@@ -9,12 +9,13 @@ if (!(symbol in global)) {
   // the default behavior, without requiring `configure` is to avoid
   // logging anything unless it's a real error
   const transport = createTransport()
-  global[symbol] = log => log.level > LEVELS.WARN && transport(log)
+  const level = resolve(process.env.LOG_LEVEL, LEVELS.WARN)
+  global[symbol] = log => log.level >= level && transport(log)
 }
 
 // -------------------------------------------------------------------
 
-function Log (data, level, namespace, message, time) {
+function Log(data, level, namespace, message, time) {
   this.data = data
   this.level = level
   this.namespace = namespace
@@ -22,7 +23,7 @@ function Log (data, level, namespace, message, time) {
   this.time = time
 }
 
-function Logger (namespace) {
+function Logger(namespace) {
   this._namespace = namespace
 
   // bind all logging methods
@@ -37,11 +38,11 @@ const { prototype } = Logger
 for (const name in LEVELS) {
   const level = LEVELS[name]
 
-  prototype[name.toLowerCase()] = function (message, data) {
+  prototype[name.toLowerCase()] = function(message, data) {
     if (typeof message !== 'string') {
       if (message instanceof Error) {
         data = { error: message }
-        ;({ message = 'an error has occured' } = message)
+        ;({ message = 'an error has occurred' } = message)
       } else {
         return this.warn('incorrect value passed to logger', {
           level,
@@ -53,13 +54,13 @@ for (const name in LEVELS) {
   }
 }
 
-prototype.wrap = function (message, fn) {
+prototype.wrap = function(message, fn) {
   const logger = this
   const warnAndRethrow = error => {
     logger.warn(message, { error })
     throw error
   }
-  return function () {
+  return function() {
     try {
       const result = fn.apply(this, arguments)
       const then = result != null && result.then
@@ -72,5 +73,5 @@ prototype.wrap = function (message, fn) {
   }
 }
 
-const createLogger = namespace => new Logger(namespace)
+export const createLogger = namespace => new Logger(namespace)
 export { createLogger as default }

@xen-orchestra/log/src/levels.js

@@ -13,11 +13,22 @@ for (const name in LEVELS) {
   NAMES[LEVELS[name]] = name
 }
 
-export const resolve = level => {
-  if (typeof level === 'string') {
-    level = LEVELS[level.toUpperCase()]
+// resolves to the number representation of a level
+//
+// returns `defaultLevel` if invalid
+export const resolve = (level, defaultLevel) => {
+  const type = typeof level
+  if (type === 'number') {
+    if (level in NAMES) {
+      return level
+    }
+  } else if (type === 'string') {
+    const nLevel = LEVELS[level.toUpperCase()]
+    if (nLevel !== undefined) {
+      return nLevel
+    }
   }
-  return level
+  return defaultLevel
 }
 
 Object.freeze(LEVELS)

@xen-orchestra/log/src/transports/console.js

@@ -1,24 +1,23 @@
 import LEVELS, { NAMES } from '../levels'
 
-// Bind console methods (necessary for browsers)
-const debugConsole = console.log.bind(console)
-const infoConsole = console.info.bind(console)
-const warnConsole = console.warn.bind(console)
-const errorConsole = console.error.bind(console)
-
 const { ERROR, INFO, WARN } = LEVELS
 
 const consoleTransport = ({ data, level, namespace, message, time }) => {
   const fn =
+    /* eslint-disable no-console */
     level < INFO
-      ? debugConsole
+      ? console.log
       : level < WARN
-      ? infoConsole
+      ? console.info
       : level < ERROR
-      ? warnConsole
-      : errorConsole
+      ? console.warn
+      : console.error
+  /* eslint-enable no-console */
 
-  fn('%s - %s - [%s] %s', time.toISOString(), namespace, NAMES[level], message)
-  data != null && fn(data)
+  const args = [time.toISOString(), namespace, NAMES[level], message]
+  if (data != null) {
+    args.push(data)
+  }
+  fn.apply(console, args)
 }
 export default () => consoleTransport

@xen-orchestra/log/src/transports/syslog.js

@@ -1,7 +1,6 @@
 import fromCallback from 'promise-toolbox/fromCallback'
-import splitHost from 'split-host' // eslint-disable-line node/no-extraneous-import node/no-missing-import
-import startsWith from 'lodash/startsWith'
-import { createClient, Facility, Severity, Transport } from 'syslog-client' // eslint-disable-line node/no-extraneous-import node/no-missing-import
+import splitHost from 'split-host'
+import { createClient, Facility, Severity, Transport } from 'syslog-client'
 
 import LEVELS from '../levels'
 
@@ -19,10 +18,10 @@ const facility = Facility.User
 export default target => {
   const opts = {}
   if (target !== undefined) {
-    if (startsWith(target, 'tcp://')) {
+    if (target.startsWith('tcp://')) {
       target = target.slice(6)
       opts.transport = Transport.Tcp
-    } else if (startsWith(target, 'udp://')) {
+    } else if (target.startsWith('udp://')) {
       target = target.slice(6)
       opts.transport = Transport.Udp
     }

@xen-orchestra/log/src/utils.js

@@ -55,7 +55,8 @@ export const required = name => {
 // -------------------------------------------------------------------
 
 export const serializeError = error => ({
-  ...error,
+  ...error, // Copy enumerable properties.
+  code: error.code,
   message: error.message,
   name: error.name,
   stack: error.stack,

@xen-orchestra/mixin/README.md

@@ -1,13 +1,13 @@
-# ${pkg.name} [![Build Status](https://travis-ci.org/${pkg.shortGitHubPath}.png?branch=master)](https://travis-ci.org/${pkg.shortGitHubPath})
+# @xen-orchestra/mixin [![Build Status](https://travis-ci.org/${pkg.shortGitHubPath}.png?branch=master)](https://travis-ci.org/${pkg.shortGitHubPath})
 
 > ${pkg.description}
 
 ## Install
 
-Installation of the [npm package](https://npmjs.org/package/${pkg.name}):
+Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/mixin):
 
 ```
-> npm install --save ${pkg.name}
+> npm install --save @xen-orchestra/mixin
 ```
 
 ## Usage
@@ -35,15 +35,15 @@ Installation of the [npm package](https://npmjs.org/package/${pkg.name}):
 
 ## Contributions
 
-Contributions are *very* welcomed, either on the documentation or on
+Contributions are _very_ welcomed, either on the documentation or on
 the code.
 
 You may:
 
-- report any [issue](${pkg.bugs})
+- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
   you've encountered;
 - fork and create a pull request.
 
 ## License
 
-${pkg.license} © [${pkg.author.name}](${pkg.author.url})
+ISC © [Vates SAS](https://vates.fr)

@xen-orchestra/mixin/package.json

@@ -7,6 +7,7 @@
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/mixin",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/mixin",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
@@ -35,8 +36,8 @@
     "@babel/preset-env": "^7.0.0",
     "babel-plugin-dev": "^1.0.0",
     "babel-plugin-lodash": "^3.3.2",
-    "cross-env": "^5.1.3",
-    "rimraf": "^2.6.2"
+    "cross-env": "^6.0.3",
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -44,6 +45,7 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish"
   }
 }

@xen-orchestra/mixin/src/index.js

@@ -61,7 +61,7 @@ const mixin = Mixins => Class => {
 
   const n = Mixins.length
 
-  function DecoratedClass (...args) {
+  function DecoratedClass(...args) {
     const instance = new Class(...args)
 
     for (let i = 0; i < n; ++i) {

@xen-orchestra/template/README.md

@@ -0,0 +1,65 @@
+# @xen-orchestra/template [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
+
+## Install
+
+Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/template):
+
+```
+> npm install --save @xen-orchestra/template
+```
+
+## Usage
+
+Create a string replacer based on a pattern and a list of rules.
+
+```js
+const myReplacer = compileTemplate('{name}_COPY_{name}_{id}_%%', {
+  '{name}': vm => vm.name_label,
+  '{id}': vm => vm.id,
+  '%': (_, i) => i,
+})
+
+const newString = myReplacer(
+  {
+    name_label: 'foo',
+    id: 42,
+  },
+  32
+)
+
+newString === 'foo_COPY_{name}_42_32%' // true
+```
+
+## Development
+
+```
+# Install dependencies
+> yarn
+
+# Run the tests
+> yarn test
+
+# Continuously compile
+> yarn dev
+
+# Continuously run the tests
+> yarn dev-test
+
+# Build for production (automatically called by npm install)
+> yarn build
+```
+
+## 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
+
+ISC © [Vates SAS](https://vates.fr)

@xen-orchestra/template/package.json

@@ -1,45 +1,35 @@
 {
-  "name": "xo-server-cloud",
-  "version": "0.2.4",
+  "name": "@xen-orchestra/template",
+  "version": "0.1.0",
   "license": "ISC",
-  "description": "",
-  "keywords": [
-    "cloud",
-    "orchestra",
-    "plugin",
-    "xen",
-    "xen-orchestra",
-    "xo-server"
-  ],
-  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server-cloud",
+  "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/template",
   "bugs": "https://github.com/vatesfr/xen-orchestra/issues",
   "repository": {
+    "directory": "@xen-orchestra/template",
     "type": "git",
     "url": "https://github.com/vatesfr/xen-orchestra.git"
   },
   "author": {
-    "name": "Pierre Donias",
-    "email": "pierre.donias@gmail.com"
+    "name": "Julien Fontanet",
+    "email": "julien.fontanet@vates.fr"
   },
   "preferGlobal": false,
   "main": "dist/",
-  "bin": {},
   "files": [
     "dist/"
   ],
+  "browserslist": [
+    ">2%"
+  ],
   "engines": {
     "node": ">=6"
   },
-  "dependencies": {
-    "http-request-plus": "^0.6.0",
-    "jsonrpc-websocket-client": "^0.4.1"
-  },
   "devDependencies": {
     "@babel/cli": "^7.0.0",
     "@babel/core": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
-    "cross-env": "^5.1.3",
-    "rimraf": "^2.5.4"
+    "cross-env": "^6.0.3",
+    "rimraf": "^3.0.0"
   },
   "scripts": {
     "build": "cross-env NODE_ENV=production babel --source-maps --out-dir=dist/ src/",
@@ -47,6 +37,10 @@
     "dev": "cross-env NODE_ENV=development babel --watch --source-maps --out-dir=dist/ src/",
     "prebuild": "yarn run clean",
     "predev": "yarn run prebuild",
-    "prepublishOnly": "yarn run build"
+    "prepublishOnly": "yarn run build",
+    "postversion": "npm publish --access public"
+  },
+  "dependencies": {
+    "lodash": "^4.17.15"
   }
 }

@xen-orchestra/template/src/index.js

@@ -0,0 +1,19 @@
+import escapeRegExp from 'lodash/escapeRegExp'
+
+const compareLengthDesc = (a, b) => b.length - a.length
+
+export function compileTemplate(pattern, rules) {
+  const matches = Object.keys(rules)
+    .sort(compareLengthDesc)
+    .map(escapeRegExp)
+    .join('|')
+  const regExp = new RegExp(`\\\\(?:\\\\|${matches})|${matches}`, 'g')
+  return (...params) =>
+    pattern.replace(regExp, match => {
+      if (match[0] === '\\') {
+        return match.slice(1)
+      }
+      const rule = rules[match]
+      return typeof rule === 'function' ? rule(...params) : rule
+    })
+}

@xen-orchestra/template/src/index.spec.js

@@ -0,0 +1,14 @@
+/* eslint-env jest */
+import { compileTemplate } from '.'
+
+it("correctly replaces the template's variables", () => {
+  const replacer = compileTemplate(
+    '{property}_\\{property}_\\\\{property}_{constant}_%_FOO',
+    {
+      '{property}': obj => obj.name,
+      '{constant}': 1235,
+      '%': (_, i) => i,
+    }
+  )
+  expect(replacer({ name: 'bar' }, 5)).toBe('bar_{property}_\\bar_1235_5_FOO')
+})

CHANGELOG.md

@@ -1,6 +1,652 @@
 # ChangeLog
 
-## *next*
+## **next**
+
+### Enhancements
+
+### Bug fixes
+
+### Released packages
+
+
+## **5.42.0** (2019-12-20)
+
+![Channel: latest](https://badgen.net/badge/channel/latest/yellow)
+
+### Highlights
+
+- [SDN Controller] Allow private network creation on bond and VLAN (PR [#4682](https://github.com/vatesfr/xen-orchestra/pull/4682))
+- [Hub/recipes] [Ability to create a kubernetes cluster](https://xen-orchestra.com/blog/devblog-5-kubernetes-clutser-on-xo/) (PR [#4695](https://github.com/vatesfr/xen-orchestra/pull/4695))
+
+### Enhancements
+
+- [XOA] Display XOA build number [#4693](https://github.com/vatesfr/xen-orchestra/issues/4693) (PR [#4694](https://github.com/vatesfr/xen-orchestra/pull/4694))
+
+### Released packages
+
+- xo-server v5.54.0
+- xo-web v5.54.0
+
+## **5.41.0** (2019-11-29)
+
+![Channel: stable](https://badgen.net/badge/channel/stable/green)
+
+### Highlights
+
+- [Backup NG] Make report recipients configurable in the backup settings [#4581](https://github.com/vatesfr/xen-orchestra/issues/4581) (PR [#4646](https://github.com/vatesfr/xen-orchestra/pull/4646))
+- [Host] Advanced Live Telemetry (PR [#4680](https://github.com/vatesfr/xen-orchestra/pull/4680))
+- [Plugin] [Web hooks](https://xen-orchestra.com/docs/web-hooks.html) [#1946](https://github.com/vatesfr/xen-orchestra/issues/1946) (PR [#3155](https://github.com/vatesfr/xen-orchestra/pull/3155))
+
+### Enhancements
+
+- [SAML] Setting to disable requested authentication context (helps with _Active Directory_) (PR [#4675](https://github.com/vatesfr/xen-orchestra/pull/4675))
+- The default sign-in page can be configured via `authentication.defaultSignInPage` (PR [#4678](https://github.com/vatesfr/xen-orchestra/pull/4678))
+- [SR] Allow import of VHD and VMDK disks [#4137](https://github.com/vatesfr/xen-orchestra/issues/4137) (PR [#4138](https://github.com/vatesfr/xen-orchestra/pull/4138) )
+
+### Bug fixes
+
+- [Metadata backup] Add 10 minutes timeout to avoid stuck jobs [#4657](https://github.com/vatesfr/xen-orchestra/issues/4657) (PR [#4666](https://github.com/vatesfr/xen-orchestra/pull/4666))
+- [Metadata backups] Fix out-of-date listing for 1 minute due to cache (PR [#4672](https://github.com/vatesfr/xen-orchestra/pull/4672))
+- [Delta backup] Limit the number of merged deltas per run to avoid interrupted jobs (PR [#4674](https://github.com/vatesfr/xen-orchestra/pull/4674))
+
+### Released packages
+
+- vhd-lib v0.7.2
+- xo-vmdk-to-vhd v0.1.8
+- xo-server-auth-ldap v0.6.6
+- xo-server-auth-saml v0.7.0
+- xo-server-backup-reports v0.16.4
+- xo-server-web-hooks v0.1.0
+- @xen-orchestra/fs v0.10.2
+- xo-server v5.53.0
+- xo-web v5.53.3
+
+## **5.40.2** (2019-11-22)
+
+### Enhancements
+
+- [Logs] Ability to report a bug with attached log (PR [#4201](https://github.com/vatesfr/xen-orchestra/pull/4201))
+- [Backup] Reduce _VDI chain protection error_ occurrence by being more tolerant (configurable via `xo-server`'s `xapiOptions.maxUncoalescedVdis` setting) [#4124](https://github.com/vatesfr/xen-orchestra/issues/4124) (PR [#4651](https://github.com/vatesfr/xen-orchestra/pull/4651))
+- [Tables] Always put the tables' search in the URL [#4542](https://github.com/vatesfr/xen-orchestra/issues/4542) (PR [#4637](https://github.com/vatesfr/xen-orchestra/pull/4637))
+
+### Bug fixes
+
+- [SDN controller] Prevent private network creation on bond slave PIF (Fixes https://github.com/xcp-ng/xcp/issues/300) (PR [4633](https://github.com/vatesfr/xen-orchestra/pull/4633))
+- [Metadata backup] Fix failed backup reported as successful [#4596](https://github.com/vatesfr/xen-orchestra/issues/4596) (PR [#4598](https://github.com/vatesfr/xen-orchestra/pull/4598))
+- [Backup NG] Fix "task cancelled" error when the backup job timeout exceeds 596 hours [#4662](https://github.com/vatesfr/xen-orchestra/issues/4662) (PR [#4663](https://github.com/vatesfr/xen-orchestra/pull/4663))
+- Fix `promise rejected with non-error` warnings in logs (PR [#4659](https://github.com/vatesfr/xen-orchestra/pull/4659))
+
+### Released packages
+
+- xen-api v0.27.3
+- xo-server-backup-reports v0.16.3
+- vhd-lib v0.7.1
+- xo-server v5.52.1
+- xo-web v5.52.0
+
+## **5.40.1** (2019-10-29)
+
+### Bug fixes
+
+- [XOSAN] Fix "Install Cloud plugin" warning (PR [#4631](https://github.com/vatesfr/xen-orchestra/pull/4631))
+
+### Released packages
+
+- xo-web v5.51.1
+
+## **5.40.0** (2019-10-29)
+
+### Breaking changes
+
+- `xo-server` requires Node 8.
+
+### Highlights
+
+- [Backup NG] Offline backup feature [#3449](https://github.com/vatesfr/xen-orchestra/issues/3449) (PR [#4470](https://github.com/vatesfr/xen-orchestra/pull/4470))
+- [Menu] Remove legacy backup entry [#4467](https://github.com/vatesfr/xen-orchestra/issues/4467) (PR [#4476](https://github.com/vatesfr/xen-orchestra/pull/4476))
+- [Hub] Ability to update existing template (PR [#4613](https://github.com/vatesfr/xen-orchestra/pull/4613))
+- [Support] Ability to open and close support tunnel from the user interface [#4513](https://github.com/vatesfr/xen-orchestra/issues/4513) (PR [#4616](https://github.com/vatesfr/xen-orchestra/pull/4616))
+
+### Enhancements
+
+- [Hub] Ability to select SR in hub VM installation (PR [#4571](https://github.com/vatesfr/xen-orchestra/pull/4571))
+- [Hub] Display more info about downloadable templates (PR [#4593](https://github.com/vatesfr/xen-orchestra/pull/4593))
+- [xo-server-transport-icinga2] Add support of [icinga2](https://icinga.com/docs/icinga2/latest/doc/12-icinga2-api/) for reporting services status [#4563](https://github.com/vatesfr/xen-orchestra/issues/4563) (PR [#4573](https://github.com/vatesfr/xen-orchestra/pull/4573))
+
+### Bug fixes
+
+- [SR] Fix `[object HTMLInputElement]` name after re-attaching a SR [#4546](https://github.com/vatesfr/xen-orchestra/issues/4546) (PR [#4550](https://github.com/vatesfr/xen-orchestra/pull/4550))
+- [Schedules] Prevent double runs [#4625](https://github.com/vatesfr/xen-orchestra/issues/4625) (PR [#4626](https://github.com/vatesfr/xen-orchestra/pull/4626))
+- [Schedules] Properly enable/disable on config import (PR [#4624](https://github.com/vatesfr/xen-orchestra/pull/4624))
+
+### Released packages
+
+- @xen-orchestra/cron v1.0.6
+- xo-server-transport-icinga2 v0.1.0
+- xo-server-sdn-controller v0.3.1
+- xo-server v5.51.1
+- xo-web v5.51.0
+
+### Dropped packages
+
+- xo-server-cloud : this package was useless for OpenSource installations because it required a complete XOA environment
+
+
+## **5.39.1** (2019-10-11)
+
+### Enhancements
+
+- [Support] Ability to check the XOA on the user interface [#4513](https://github.com/vatesfr/xen-orchestra/issues/4513) (PR [#4574](https://github.com/vatesfr/xen-orchestra/pull/4574))
+
+### Bug fixes
+
+- [VM/new-vm] Fix template selection on creating new VM for resource sets [#4565](https://github.com/vatesfr/xen-orchestra/issues/4565) (PR [#4568](https://github.com/vatesfr/xen-orchestra/pull/4568))
+- [VM] Clearer invalid cores per socket error [#4120](https://github.com/vatesfr/xen-orchestra/issues/4120) (PR [#4187](https://github.com/vatesfr/xen-orchestra/pull/4187))
+
+### Released packages
+
+- xo-web v5.50.3
+
+
+## **5.39.0** (2019-09-30)
+
+### Highlights
+
+- [VM/console] Add a button to connect to the VM via the local SSH client (PR [#4415](https://github.com/vatesfr/xen-orchestra/pull/4415))
+- [SDN Controller] Add possibility to encrypt private networks (PR [#4441](https://github.com/vatesfr/xen-orchestra/pull/4441))
+- [Backups] Improve performance by caching VM backups listing (PR [#4509](https://github.com/vatesfr/xen-orchestra/pull/4509))
+- [HUB] VM template store [#1918](https://github.com/vatesfr/xen-orchestra/issues/1918) (PR [#4442](https://github.com/vatesfr/xen-orchestra/pull/4442))
+
+### Enhancements
+
+- [SR/new] Clarify address formats [#4450](https://github.com/vatesfr/xen-orchestra/issues/4450) (PR [#4460](https://github.com/vatesfr/xen-orchestra/pull/4460))
+- [Backup NG/New] Show warning if zstd compression is not supported on a VM [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PRs [#4411](https://github.com/vatesfr/xen-orchestra/pull/4411))
+- [VM/disks] Don't hide disks that are attached to the same VM twice [#4400](https://github.com/vatesfr/xen-orchestra/issues/4400) (PR [#4414](https://github.com/vatesfr/xen-orchestra/pull/4414))
+- [SDN Controller] Ability to configure MTU for private networks (PR [#4491](https://github.com/vatesfr/xen-orchestra/pull/4491))
+- [VM Export] Filenames are now prefixed with datetime [#4503](https://github.com/vatesfr/xen-orchestra/issues/4503)
+- [Settings/Logs] Differenciate XS/XCP-ng errors from XO errors [#4101](https://github.com/vatesfr/xen-orchestra/issues/4101) (PR [#4385](https://github.com/vatesfr/xen-orchestra/pull/4385))
+- [Backups] Improve performance by caching logs consolidation (PR [#4541](https://github.com/vatesfr/xen-orchestra/pull/4541))
+- [New VM] Cloud Init available for all plans (PR [#4543](https://github.com/vatesfr/xen-orchestra/pull/4543))
+- [Servers] IPv6 addresses can be used [#4520](https://github.com/vatesfr/xen-orchestra/issues/4520) (PR [#4521](https://github.com/vatesfr/xen-orchestra/pull/4521)) \
+  Note: They must enclosed in brackets to differentiate with the port, e.g.: `[2001:db8::7334]` or `[ 2001:db8::7334]:4343`
+
+### Bug fixes
+
+- [PBD] Obfuscate cifs password from device config [#4384](https://github.com/vatesfr/xen-orchestra/issues/4384) (PR [#4401](https://github.com/vatesfr/xen-orchestra/pull/4401))
+- [XOSAN] Fix "invalid parameters" error on creating a SR (PR [#4478](https://github.com/vatesfr/xen-orchestra/pull/4478))
+- [Patching] Avoid overloading XCP-ng by reducing the frequency of yum update checks [#4358](https://github.com/vatesfr/xen-orchestra/issues/4358) (PR [#4477](https://github.com/vatesfr/xen-orchestra/pull/4477))
+- [Network] Fix inability to create a bonded network (PR [#4489](https://github.com/vatesfr/xen-orchestra/pull/4489))
+- [Backup restore & Replication] Don't copy `sm_config` to new VDIs which might leads to useless coalesces [#4482](https://github.com/vatesfr/xen-orchestra/issues/4482) (PR [#4484](https://github.com/vatesfr/xen-orchestra/pull/4484))
+- [Home] Fix intermediary "no results" display showed on filtering items [#4420](https://github.com/vatesfr/xen-orchestra/issues/4420) (PR [#4456](https://github.com/vatesfr/xen-orchestra/pull/4456)
+- [Backup NG/New schedule] Properly show user errors in the form [#3831](https://github.com/vatesfr/xen-orchestra/issues/3831) (PR [#4131](https://github.com/vatesfr/xen-orchestra/pull/4131))
+- [VM/Advanced] Fix `"vm.set_domain_type" is not a function` error on switching virtualization mode (PV/HVM) [#4348](https://github.com/vatesfr/xen-orchestra/issues/4348) (PR [#4504](https://github.com/vatesfr/xen-orchestra/pull/4504))
+- [Backup NG/logs] Show warning when zstd compression is selected but not supported [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PR [#4375](https://github.com/vatesfr/xen-orchestra/pull/4375)
+- [Patches] Fix patches installation for CH 8.0 (PR [#4511](https://github.com/vatesfr/xen-orchestra/pull/4511))
+- [Network] Fix inability to set a network name [#4514](https://github.com/vatesfr/xen-orchestra/issues/4514) (PR [4510](https://github.com/vatesfr/xen-orchestra/pull/4510))
+- [Backup NG] Fix race conditions that could lead to disabled jobs still running (PR [4510](https://github.com/vatesfr/xen-orchestra/pull/4510))
+- [XOA] Remove "Updates" and "Licenses" tabs for non admin users (PR [#4526](https://github.com/vatesfr/xen-orchestra/pull/4526))
+- [New VM] Ability to escape [cloud config template](https://xen-orchestra.com/blog/xen-orchestra-5-21/#cloudconfigtemplates) variables [#4486](https://github.com/vatesfr/xen-orchestra/issues/4486) (PR [#4501](https://github.com/vatesfr/xen-orchestra/pull/4501))
+- [Backup NG] Properly log and report if job is already running [#4497](https://github.com/vatesfr/xen-orchestra/issues/4497) (PR [4534](https://github.com/vatesfr/xen-orchestra/pull/4534))
+- [Host] Fix an issue where host was wrongly reporting time inconsistency (PR [#4540](https://github.com/vatesfr/xen-orchestra/pull/4540))
+
+
+### Released packages
+
+- xen-api v0.27.2
+- xo-server-cloud v0.3.0
+- @xen-orchestra/cron v1.0.4
+- xo-server-sdn-controller v0.3.0
+- @xen-orchestra/template v0.1.0
+- xo-server v5.50.1
+- xo-web v5.50.2
+
+
+## **5.38.0** (2019-08-29)
+
+### Enhancements
+
+- [VM/Attach disk] Display confirmation modal when VDI is already attached [#3381](https://github.com/vatesfr/xen-orchestra/issues/3381) (PR [#4366](https://github.com/vatesfr/xen-orchestra/pull/4366))
+- [Zstd]
+  - [VM/copy, VM/export] Only show zstd option when it's supported [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PRs [#4326](https://github.com/vatesfr/xen-orchestra/pull/4326) [#4368](https://github.com/vatesfr/xen-orchestra/pull/4368))
+  - [VM/Bulk copy] Show warning if zstd compression is not supported on a VM [#3892](https://github.com/vatesfr/xen-orchestra/issues/3892) (PR [#4346](https://github.com/vatesfr/xen-orchestra/pull/4346))
+- [VM import & Continuous Replication] Enable `guessVhdSizeOnImport` by default, this fix some `VDI_IO_ERROR` with XenServer 7.1 and XCP-ng 8.0 (PR [#4436](https://github.com/vatesfr/xen-orchestra/pull/4436))
+- [SDN Controller] Add possibility to create multiple GRE networks and VxLAN networks within a same pool (PR [#4435](https://github.com/vatesfr/xen-orchestra/pull/4435))
+- [SDN Controller] Add possibility to create cross-pool private networks (PR [#4405](https://github.com/vatesfr/xen-orchestra/pull/4405))
+
+### Bug fixes
+
+- [SR/General] Display VDI VM name in SR usage graph (PR [#4370](https://github.com/vatesfr/xen-orchestra/pull/4370))
+- [VM/Attach disk] Fix checking VDI mode (PR [#4373](https://github.com/vatesfr/xen-orchestra/pull/4373))
+- [VM revert] Snapshot before: add admin ACLs on created snapshot [#4331](https://github.com/vatesfr/xen-orchestra/issues/4331) (PR [#4391](https://github.com/vatesfr/xen-orchestra/pull/4391))
+- [Network] Fixed "invalid parameters" error when creating bonded network [#4425](https://github.com/vatesfr/xen-orchestra/issues/4425) (PR [#4429](https://github.com/vatesfr/xen-orchestra/pull/4429))
+
+### Released packages
+
+- xo-server-sdn-controller v0.2.0
+- xo-server-usage-report v0.7.3
+- xo-server v5.48.0
+- xo-web v5.48.1
+
+## **5.37.1** (2019-08-06)
+
+### Enhancements
+
+- [SDN Controller] Let the user choose on which PIF to create a private network (PR [#4379](https://github.com/vatesfr/xen-orchestra/pull/4379))
+
+### Bug fixes
+
+- [SDN Controller] Better detect host shutting down to adapt network topology (PR [#4314](https://github.com/vatesfr/xen-orchestra/pull/4314))
+- [SDN Controller] Add new hosts to pool's private networks (PR [#4382](https://github.com/vatesfr/xen-orchestra/pull/4382))
+
+### Released packages
+
+- xo-server-sdn-controller v0.1.2
+
+## **5.37.0** (2019-07-25)
+
+### Highlights
+
+- [Pool] Ability to add multiple hosts on the pool [#2402](https://github.com/vatesfr/xen-orchestra/issues/2402) (PR [#3716](https://github.com/vatesfr/xen-orchestra/pull/3716))
+- [SR/General] Improve SR usage graph [#3608](https://github.com/vatesfr/xen-orchestra/issues/3608) (PR [#3830](https://github.com/vatesfr/xen-orchestra/pull/3830))
+- [VM] Permission to revert to any snapshot for VM operators [#3928](https://github.com/vatesfr/xen-orchestra/issues/3928) (PR [#4247](https://github.com/vatesfr/xen-orchestra/pull/4247))
+- [Backup NG] Ability to bypass unhealthy VDI chains check [#4324](https://github.com/vatesfr/xen-orchestra/issues/4324) (PR [#4340](https://github.com/vatesfr/xen-orchestra/pull/4340))
+- [VM/console] Multiline copy/pasting [#4261](https://github.com/vatesfr/xen-orchestra/issues/4261) (PR [#4341](https://github.com/vatesfr/xen-orchestra/pull/4341))
+
+### Enhancements
+
+- [Stats] Ability to display last day stats [#4160](https://github.com/vatesfr/xen-orchestra/issues/4160) (PR [#4168](https://github.com/vatesfr/xen-orchestra/pull/4168))
+- [Settings/servers] Display servers connection issues [#4300](https://github.com/vatesfr/xen-orchestra/issues/4300) (PR [#4310](https://github.com/vatesfr/xen-orchestra/pull/4310))
+- [VM] Show current operations and progress [#3811](https://github.com/vatesfr/xen-orchestra/issues/3811) (PR [#3982](https://github.com/vatesfr/xen-orchestra/pull/3982))
+- [Backup NG/New] Generate default schedule if no schedule is specified [#4036](https://github.com/vatesfr/xen-orchestra/issues/4036) (PR [#4183](https://github.com/vatesfr/xen-orchestra/pull/4183))
+- [Host/Advanced] Ability to edit iSCSI IQN [#4048](https://github.com/vatesfr/xen-orchestra/issues/4048) (PR [#4208](https://github.com/vatesfr/xen-orchestra/pull/4208))
+- [VM,host] Improved state icons/pills (colors and tooltips) (PR [#4363](https://github.com/vatesfr/xen-orchestra/pull/4363))
+
+### Bug fixes
+
+- [Settings/Servers] Fix read-only setting toggling
+- [SDN Controller] Do not choose physical PIF without IP configuration for tunnels. (PR [#4319](https://github.com/vatesfr/xen-orchestra/pull/4319))
+- [Xen servers] Fix `no connection found for object` error if pool master is reinstalled [#4299](https://github.com/vatesfr/xen-orchestra/issues/4299) (PR [#4302](https://github.com/vatesfr/xen-orchestra/pull/4302))
+- [Backup-ng/restore] Display correct size for full VM backup [#4316](https://github.com/vatesfr/xen-orchestra/issues/4316) (PR [#4332](https://github.com/vatesfr/xen-orchestra/pull/4332))
+- [VM/tab-advanced] Fix CPU limits edition (PR [#4337](https://github.com/vatesfr/xen-orchestra/pull/4337))
+- [Remotes] Fix `EIO` errors due to massive parallel fs operations [#4323](https://github.com/vatesfr/xen-orchestra/issues/4323) (PR [#4330](https://github.com/vatesfr/xen-orchestra/pull/4330))
+- [VM/Advanced] Fix virtualization mode switch (PV/HVM) (PR [#4349](https://github.com/vatesfr/xen-orchestra/pull/4349))
+- [Task] fix hidden notification by search field [#3874](https://github.com/vatesfr/xen-orchestra/issues/3874) (PR [#4305](https://github.com/vatesfr/xen-orchestra/pull/4305)
+- [VM] Fail to change affinity (PR [#4361](https://github.com/vatesfr/xen-orchestra/pull/4361)
+- [VM] Number of CPUs not correctly changed on running VMs (PR [#4360](https://github.com/vatesfr/xen-orchestra/pull/4360)
+
+### Released packages
+
+- @xen-orchestra/fs v0.10.1
+- xo-server-sdn-controller v0.1.1
+- xen-api v0.27.1
+- xo-server v5.46.0
+- xo-web v5.46.0
+
+## **5.36.0** (2019-06-27)
+
+### Highlights
+
+- [SR/new] Create ZFS storage [#4260](https://github.com/vatesfr/xen-orchestra/issues/4260) (PR [#4266](https://github.com/vatesfr/xen-orchestra/pull/4266))
+- [Host/advanced] Fix host CPU hyperthreading detection [#4262](https://github.com/vatesfr/xen-orchestra/issues/4262) (PR [#4285](https://github.com/vatesfr/xen-orchestra/pull/4285))
+- [VM/Advanced] Ability to use UEFI instead of BIOS [#4264](https://github.com/vatesfr/xen-orchestra/issues/4264) (PR [#4268](https://github.com/vatesfr/xen-orchestra/pull/4268))
+- [Backup-ng/restore] Display size for full VM backup [#4009](https://github.com/vatesfr/xen-orchestra/issues/4009) (PR [#4245](https://github.com/vatesfr/xen-orchestra/pull/4245))
+- [Sr/new] Ability to select NFS version when creating NFS storage [#3951](https://github.com/vatesfr/xen-orchestra/issues/3951) (PR [#4277](https://github.com/vatesfr/xen-orchestra/pull/4277))
+- [Host/storages, SR/hosts] Display PBD details [#4264](https://github.com/vatesfr/xen-orchestra/issues/4161) (PR [#4268](https://github.com/vatesfr/xen-orchestra/pull/4284))
+- [auth-saml] Improve compatibility with Microsoft Azure Active Directory (PR [#4294](https://github.com/vatesfr/xen-orchestra/pull/4294))
+
+### Enhancements
+
+- [Host] Display warning when "Citrix Hypervisor" license has restrictions [#4251](https://github.com/vatesfr/xen-orchestra/issues/4164) (PR [#4235](https://github.com/vatesfr/xen-orchestra/pull/4279))
+- [VM/Backup] Create backup bulk action [#2573](https://github.com/vatesfr/xen-orchestra/issues/2573) (PR [#4257](https://github.com/vatesfr/xen-orchestra/pull/4257))
+- [Host] Display warning when host's time differs too much from XOA's time [#4113](https://github.com/vatesfr/xen-orchestra/issues/4113) (PR [#4173](https://github.com/vatesfr/xen-orchestra/pull/4173))
+- [VM/network] Display and set bandwidth rate-limit of a VIF [#4215](https://github.com/vatesfr/xen-orchestra/issues/4215) (PR [#4293](https://github.com/vatesfr/xen-orchestra/pull/4293))
+- [SDN Controller] New plugin which enables creating pool-wide private networks [xcp-ng/xcp#175](https://github.com/xcp-ng/xcp/issues/175) (PR [#4269](https://github.com/vatesfr/xen-orchestra/pull/4269))
+
+### Bug fixes
+
+- [XOA] Don't require editing the _email_ field in case of re-registration (PR [#4259](https://github.com/vatesfr/xen-orchestra/pull/4259))
+- [Metadata backup] Missing XAPIs should trigger a failure job [#4281](https://github.com/vatesfr/xen-orchestra/issues/4281) (PR [#4283](https://github.com/vatesfr/xen-orchestra/pull/4283))
+- [iSCSI] Fix fibre channel paths display [#4291](https://github.com/vatesfr/xen-orchestra/issues/4291) (PR [#4303](https://github.com/vatesfr/xen-orchestra/pull/4303))
+- [New VM] Fix tooltips not displayed on disabled elements in some browsers (e.g. Google Chrome) [#4304](https://github.com/vatesfr/xen-orchestra/issues/4304) (PR [#4309](https://github.com/vatesfr/xen-orchestra/pull/4309))
+
+### Released packages
+
+- xo-server-auth-ldap v0.6.5
+- xen-api v0.26.0
+- xo-server-sdn-controller v0.1
+- xo-server-auth-saml v0.6.0
+- xo-server-backup-reports v0.16.2
+- xo-server v5.44.0
+- xo-web v5.44.0
+
+## **5.35.0** (2019-05-29)
+
+### Enhancements
+
+- [VM/general] Display 'Started... ago' instead of 'Halted... ago' for paused state [#3750](https://github.com/vatesfr/xen-orchestra/issues/3750) (PR [#4170](https://github.com/vatesfr/xen-orchestra/pull/4170))
+- [Metadata backup] Ability to define when the backup report will be sent (PR [#4149](https://github.com/vatesfr/xen-orchestra/pull/4149))
+- [XOA/Update] Ability to select release channel [#4200](https://github.com/vatesfr/xen-orchestra/issues/4200) (PR [#4202](https://github.com/vatesfr/xen-orchestra/pull/4202))
+- [User] Forget connection tokens on password change or on demand [#4214](https://github.com/vatesfr/xen-orchestra/issues/4214) (PR [#4224](https://github.com/vatesfr/xen-orchestra/pull/4224))
+- [Settings/Logs] LICENCE_RESTRICTION errors: suggest XCP-ng as an Open Source alternative [#3876](https://github.com/vatesfr/xen-orchestra/issues/3876) (PR [#4238](https://github.com/vatesfr/xen-orchestra/pull/4238))
+- [VM/Migrate] Display VDI size on migrate modal [#2534](https://github.com/vatesfr/xen-orchestra/issues/2534) (PR [#4250](https://github.com/vatesfr/xen-orchestra/pull/4250))
+- [Host] Display hyperthreading status on advanced tab [#4262](https://github.com/vatesfr/xen-orchestra/issues/4262) (PR [#4263](https://github.com/vatesfr/xen-orchestra/pull/4263))
+
+### Bug fixes
+
+- [Pool/Patches] Fix "an error has occurred" in "Applied patches" [#4192](https://github.com/vatesfr/xen-orchestra/issues/4192) (PR [#4193](https://github.com/vatesfr/xen-orchestra/pull/4193))
+- [Backup NG] Fix report sent even though "Never" is selected [#4092](https://github.com/vatesfr/xen-orchestra/issues/4092) (PR [#4178](https://github.com/vatesfr/xen-orchestra/pull/4178))
+- [Remotes] Fix issues after a config import (PR [#4197](https://github.com/vatesfr/xen-orchestra/pull/4197))
+- [Charts] Fixed the chart lines sometimes changing order/color (PR [#4221](https://github.com/vatesfr/xen-orchestra/pull/4221))
+- Prevent non-admin users to access admin pages with URL (PR [#4220](https://github.com/vatesfr/xen-orchestra/pull/4220))
+- [Upgrade] Fix alert before upgrade while running backup jobs [#4164](https://github.com/vatesfr/xen-orchestra/issues/4164) (PR [#4235](https://github.com/vatesfr/xen-orchestra/pull/4235))
+- [Import] Fix import OVA files (PR [#4232](https://github.com/vatesfr/xen-orchestra/pull/4232))
+- [VM/network] Fix duplicate IPv4 (PR [#4239](https://github.com/vatesfr/xen-orchestra/pull/4239))
+- [Remotes] Fix disconnected remotes which may appear to work
+- [Host] Fix incorrect hypervisor name [#4246](https://github.com/vatesfr/xen-orchestra/issues/4246) (PR [#4248](https://github.com/vatesfr/xen-orchestra/pull/4248))
+
+### Released packages
+
+- xo-server-backup-reports v0.16.1
+- @xen-orchestra/fs v0.9.0
+- vhd-lib v0.7.0
+- xo-server v5.42.1
+- xo-web v5.42.1
+
+## **5.34.0** (2019-04-30)
+
+### Highlights
+
+- [Self/New VM] Add network config box to custom cloud-init [#3872](https://github.com/vatesfr/xen-orchestra/issues/3872) (PR [#4150](https://github.com/vatesfr/xen-orchestra/pull/4150))
+- [Metadata backup] Detailed logs [#4005](https://github.com/vatesfr/xen-orchestra/issues/4005) (PR [#4014](https://github.com/vatesfr/xen-orchestra/pull/4014))
+- [Backup reports] Support metadata backups (PR [#4084](https://github.com/vatesfr/xen-orchestra/pull/4084))
+- [VM migration] Auto select default SR and collapse optional actions [#3326](https://github.com/vatesfr/xen-orchestra/issues/3326) (PR [#4121](https://github.com/vatesfr/xen-orchestra/pull/4121))
+- Unlock basic stats on all editions [#4166](https://github.com/vatesfr/xen-orchestra/issues/4166) (PR [#4172](https://github.com/vatesfr/xen-orchestra/pull/4172))
+
+### Enhancements
+
+- [Settings/remotes] Expose mount options field for SMB [#4063](https://github.com/vatesfr/xen-orchestra/issues/4063) (PR [#4067](https://github.com/vatesfr/xen-orchestra/pull/4067))
+- [Backup/Schedule] Add warning regarding DST when you add a schedule [#4042](https://github.com/vatesfr/xen-orchestra/issues/4042) (PR [#4056](https://github.com/vatesfr/xen-orchestra/pull/4056))
+- [Import] Avoid blocking the UI when dropping a big OVA file on the UI (PR [#4018](https://github.com/vatesfr/xen-orchestra/pull/4018))
+- [Backup NG/Overview] Make backup list title clearer [#4111](https://github.com/vatesfr/xen-orchestra/issues/4111) (PR [#4129](https://github.com/vatesfr/xen-orchestra/pull/4129))
+- [Dashboard] Hide "Report" section for non-admins [#4123](https://github.com/vatesfr/xen-orchestra/issues/4123) (PR [#4126](https://github.com/vatesfr/xen-orchestra/pull/4126))
+- [Self/New VM] Display confirmation modal when user will use a large amount of resources [#4044](https://github.com/vatesfr/xen-orchestra/issues/4044) (PR [#4127](https://github.com/vatesfr/xen-orchestra/pull/4127))
+- [VDI migration, New disk] Warning when SR host is different from the other disks [#3911](https://github.com/vatesfr/xen-orchestra/issues/3911) (PR [#4035](https://github.com/vatesfr/xen-orchestra/pull/4035))
+- [Attach disk] Display warning message when VDI SR is on different host from the other disks [#3911](https://github.com/vatesfr/xen-orchestra/issues/3911) (PR [#4117](https://github.com/vatesfr/xen-orchestra/pull/4117))
+- [Editable] Notify user when editable undo fails [#3799](https://github.com/vatesfr/xen-orchestra/issues/3799) (PR [#4150](https://github.com/vatesfr/xen-orchestra/pull/4157))
+- [XO] Add banner for sources users to clarify support conditions [#4165](https://github.com/vatesfr/xen-orchestra/issues/4165) (PR [#4167](https://github.com/vatesfr/xen-orchestra/pull/4167))
+
+### Bug fixes
+
+- [Continuous Replication] Fix VHD size guess for empty files [#4105](https://github.com/vatesfr/xen-orchestra/issues/4105)  (PR [#4107](https://github.com/vatesfr/xen-orchestra/pull/4107))
+- [Backup NG] Only display full backup interval in case of a delta backup (PR [#4125](https://github.com/vatesfr/xen-orchestra/pull/4107))
+- [Dashboard/Health] fix 'an error has occurred' on the storage state table [#4128](https://github.com/vatesfr/xen-orchestra/issues/4128)  (PR [#4132](https://github.com/vatesfr/xen-orchestra/pull/4132))
+- [Menu] XOA: Fixed empty slot when menu is collapsed [#4012](https://github.com/vatesfr/xen-orchestra/issues/4012) (PR [#4068](https://github.com/vatesfr/xen-orchestra/pull/4068)
+- [Self/New VM] Fix missing templates when refreshing page [#3265](https://github.com/vatesfr/xen-orchestra/issues/3265) (PR [#3565](https://github.com/vatesfr/xen-orchestra/pull/3565))
+- [Home] No more false positives when select Tag on Home page [#4087](https://github.com/vatesfr/xen-orchestra/issues/4087) (PR [#4112](https://github.com/vatesfr/xen-orchestra/pull/4112))
+
+### Released packages
+
+- xo-server-backup-reports v0.16.0
+- complex-matcher v0.6.0
+- xo-vmdk-to-vhd v0.1.7
+- vhd-lib v0.6.1
+- xo-server v5.40.0
+- xo-web v5.40.1
+
+## **5.33.1** (2019-04-04)
+
+### Bug fix
+
+- Fix major memory leak [2563be4](https://github.com/vatesfr/xen-orchestra/commit/2563be472bfd84c6ed867efd21c4aeeb824d387f)
+
+### Released packages
+
+- xen-api v0.25.1
+- xo-server v5.38.2
+
+## **5.33.0** (2019-03-29)
+
+### Enhancements
+
+- [SR/Disk] Disable actions on unmanaged VDIs [#3988](https://github.com/vatesfr/xen-orchestra/issues/3988) (PR [#4000](https://github.com/vatesfr/xen-orchestra/pull/4000))
+- [Pool] Specify automatic networks on a Pool [#3916](https://github.com/vatesfr/xen-orchestra/issues/3916) (PR [#3958](https://github.com/vatesfr/xen-orchestra/pull/3958))
+- [VM/advanced] Manage start delay for VM [#3909](https://github.com/vatesfr/xen-orchestra/issues/3909) (PR [#4002](https://github.com/vatesfr/xen-orchestra/pull/4002))
+- [New/Vm] SR section: Display warning message when the selected SRs aren't in the same host [#3911](https://github.com/vatesfr/xen-orchestra/issues/3911) (PR [#3967](https://github.com/vatesfr/xen-orchestra/pull/3967))
+- Enable compression for HTTP requests (and initial objects fetch)
+- [VDI migration] Display same-pool SRs first in the selector [#3945](https://github.com/vatesfr/xen-orchestra/issues/3945) (PR [#3996](https://github.com/vatesfr/xen-orchestra/pull/3996))
+- [Home] Save the current page in url [#3993](https://github.com/vatesfr/xen-orchestra/issues/3993) (PR [#3999](https://github.com/vatesfr/xen-orchestra/pull/3999))
+- [VDI] Ensure suspend VDI is destroyed when destroying a VM  [#4027](https://github.com/vatesfr/xen-orchestra/issues/4027) (PR [#4038](https://github.com/vatesfr/xen-orchestra/pull/4038))
+- [VM/disk]: Warning when 2 VDIs are on 2 different hosts' local SRs [#3911](https://github.com/vatesfr/xen-orchestra/issues/3911) (PR [#3969](https://github.com/vatesfr/xen-orchestra/pull/3969))
+- [Remotes] Benchmarks (read and write rate speed) added when remote is tested [#3991](https://github.com/vatesfr/xen-orchestra/issues/3991) (PR [#4015](https://github.com/vatesfr/xen-orchestra/pull/4015))
+- [Cloud Config] Support both NoCloud and Config Drive 2 datasources for maximum compatibility (PR [#4053](https://github.com/vatesfr/xen-orchestra/pull/4053))
+- [Advanced] Configurable cookie validity (PR [#4059](https://github.com/vatesfr/xen-orchestra/pull/4059))
+- [Plugins] Display number of installed plugins [#4008](https://github.com/vatesfr/xen-orchestra/issues/4008) (PR [#4050](https://github.com/vatesfr/xen-orchestra/pull/4050))
+- [Continuous Replication] Opt-in mode to guess VHD size, should help with XenServer 7.1 CU2 and various `VDI_IO_ERROR` errors (PR [#3726](https://github.com/vatesfr/xen-orchestra/pull/3726))
+- [VM/Snapshots] Always delete broken quiesced snapshots [#4074](https://github.com/vatesfr/xen-orchestra/issues/4074) (PR [#4075](https://github.com/vatesfr/xen-orchestra/pull/4075))
+- [Settings/Servers] Display link to pool [#4041](https://github.com/vatesfr/xen-orchestra/issues/4041) (PR [#4045](https://github.com/vatesfr/xen-orchestra/pull/4045))
+- [Import] Change wording of drop zone (PR [#4020](https://github.com/vatesfr/xen-orchestra/pull/4020))
+- [Backup NG] Ability to set the interval of the full backups [#1783](https://github.com/vatesfr/xen-orchestra/issues/1783) (PR [#4083](https://github.com/vatesfr/xen-orchestra/pull/4083))
+- [Hosts] Display a warning icon if you have XenServer license restrictions [#4091](https://github.com/vatesfr/xen-orchestra/issues/4091) (PR [#4094](https://github.com/vatesfr/xen-orchestra/pull/4094))
+- [Restore] Ability to restore a metadata backup [#4004](https://github.com/vatesfr/xen-orchestra/issues/4004) (PR [#4023](https://github.com/vatesfr/xen-orchestra/pull/4023))
+- Improve connection to XCP-ng/XenServer hosts:
+  - never disconnect by itself even in case of errors
+  - never stop watching events
+
+### Bug fixes
+
+- [New network] PIF was wrongly required which prevented from creating a private network (PR [#4010](https://github.com/vatesfr/xen-orchestra/pull/4010))
+- [Google authentication] Migrate to new endpoint
+- [Backup NG] Better handling of huge logs [#4025](https://github.com/vatesfr/xen-orchestra/issues/4025) (PR [#4026](https://github.com/vatesfr/xen-orchestra/pull/4026))
+- [Home/VM] Bulk migration: fixed VM VDIs not migrated to the selected SR [#3986](https://github.com/vatesfr/xen-orchestra/issues/3986) (PR [#3987](https://github.com/vatesfr/xen-orchestra/pull/3987))
+- [Stats] Fix cache usage with simultaneous requests [#4017](https://github.com/vatesfr/xen-orchestra/issues/4017) (PR [#4028](https://github.com/vatesfr/xen-orchestra/pull/4028))
+- [Backup NG] Fix compression displayed for the wrong backup mode (PR [#4021](https://github.com/vatesfr/xen-orchestra/pull/4021))
+- [Home] Always sort the items by their names as a secondary sort criteria [#3983](https://github.com/vatesfr/xen-orchestra/issues/3983) (PR [#4047](https://github.com/vatesfr/xen-orchestra/pull/4047))
+- [Remotes] Fixes `spawn mount EMFILE` error during backup
+- Properly redirect to sign in page instead of being stuck in a refresh loop
+- [Backup-ng] No more false positives when list matching VMs on Home page [#4078](https://github.com/vatesfr/xen-orchestra/issues/4078) (PR [#4085](https://github.com/vatesfr/xen-orchestra/pull/4085))
+- [Plugins] Properly remove optional settings when unchecking _Fill information_ (PR [#4076](https://github.com/vatesfr/xen-orchestra/pull/4076))
+- [Patches] (PR [#4077](https://github.com/vatesfr/xen-orchestra/pull/4077))
+  - Add a host to a pool: fixes the auto-patching of the host on XenServer < 7.2 [#3783](https://github.com/vatesfr/xen-orchestra/issues/3783)
+  - Add a host to a pool: homogenizes both the host and **pool**'s patches [#2188](https://github.com/vatesfr/xen-orchestra/issues/2188)
+  - Safely install a subset of patches on a pool [#3777](https://github.com/vatesfr/xen-orchestra/issues/3777)
+  - XCP-ng: no longer requires to run `yum install xcp-ng-updater` when it's already installed [#3934](https://github.com/vatesfr/xen-orchestra/issues/3934)
+
+### Released packages
+
+- xen-api v0.25.0
+- vhd-lib v0.6.0
+- @xen-orchestra/fs v0.8.0
+- xo-server-usage-report v0.7.2
+- xo-server v5.38.1
+- xo-web v5.38.0
+
+## **5.32.2** (2019-02-28)
+
+### Bug fixes
+
+- Fix XAPI events monitoring on old version (XenServer 7.2)
+
+## **5.32.1** (2019-02-28)
+
+### Bug fixes
+
+- Fix a very short timeout in the monitoring of XAPI events which may lead to unresponsive XenServer hosts
+
+## **5.32.0** (2019-02-28)
+
+### Enhancements
+
+- [VM migration] Display same-pool hosts first in the selector [#3262](https://github.com/vatesfr/xen-orchestra/issues/3262) (PR [#3890](https://github.com/vatesfr/xen-orchestra/pull/3890))
+- [Home/VM] Sort VM by start time [#3955](https://github.com/vatesfr/xen-orchestra/issues/3955) (PR [#3970](https://github.com/vatesfr/xen-orchestra/pull/3970))
+- [Editable fields] Unfocusing (clicking outside) submits the change instead of canceling (PR [#3980](https://github.com/vatesfr/xen-orchestra/pull/3980))
+- [Network] Dedicated page for network creation [#3895](https://github.com/vatesfr/xen-orchestra/issues/3895) (PR [#3906](https://github.com/vatesfr/xen-orchestra/pull/3906))
+- [Logs] Add button to download the log [#3957](https://github.com/vatesfr/xen-orchestra/issues/3957) (PR [#3985](https://github.com/vatesfr/xen-orchestra/pull/3985))
+- [Continuous Replication] Share full copy between schedules [#3973](https://github.com/vatesfr/xen-orchestra/issues/3973) (PR [#3995](https://github.com/vatesfr/xen-orchestra/pull/3995))
+- [Backup] Ability to backup XO configuration and pool metadata [#808](https://github.com/vatesfr/xen-orchestra/issues/808) [#3501](https://github.com/vatesfr/xen-orchestra/issues/3501) (PR [#3912](https://github.com/vatesfr/xen-orchestra/pull/3912))
+
+### Bug fixes
+
+- [Host] Fix multipathing status for XenServer < 7.5 [#3956](https://github.com/vatesfr/xen-orchestra/issues/3956) (PR [#3961](https://github.com/vatesfr/xen-orchestra/pull/3961))
+- [Home/VM] Show creation date of the VM on if it available [#3953](https://github.com/vatesfr/xen-orchestra/issues/3953) (PR [#3959](https://github.com/vatesfr/xen-orchestra/pull/3959))
+- [Notifications] Fix invalid notifications when not registered (PR [#3966](https://github.com/vatesfr/xen-orchestra/pull/3966))
+- [Import] Fix import of some OVA files [#3962](https://github.com/vatesfr/xen-orchestra/issues/3962) (PR [#3974](https://github.com/vatesfr/xen-orchestra/pull/3974))
+- [Servers] Fix *already connected error* after a server has been removed during connection [#3976](https://github.com/vatesfr/xen-orchestra/issues/3976) (PR [#3977](https://github.com/vatesfr/xen-orchestra/pull/3977))
+- [Backup] Fix random _mount_ issues with NFS/SMB remotes [#3973](https://github.com/vatesfr/xen-orchestra/issues/3973) (PR [#4003](https://github.com/vatesfr/xen-orchestra/pull/4003))
+
+### Released packages
+
+- @xen-orchestra/fs v0.7.0
+- xen-api v0.24.3
+- xoa-updater v0.15.2
+- xo-server v5.36.0
+- xo-web v5.36.0
+
+## **5.31.2** (2019-02-08)
+
+### Enhancements
+
+- [Home] Set description on bulk snapshot [#3925](https://github.com/vatesfr/xen-orchestra/issues/3925) (PR [#3933](https://github.com/vatesfr/xen-orchestra/pull/3933))
+- Work-around the XenServer issue when `VBD#VDI` is an empty string instead of an opaque reference (PR [#3950](https://github.com/vatesfr/xen-orchestra/pull/3950))
+- [VDI migration] Retry when XenServer fails with `TOO_MANY_STORAGE_MIGRATES` (PR [#3940](https://github.com/vatesfr/xen-orchestra/pull/3940))
+- [VM]
+  - [General] The creation date of the VM is now visible [#3932](https://github.com/vatesfr/xen-orchestra/issues/3932) (PR [#3947](https://github.com/vatesfr/xen-orchestra/pull/3947))
+  - [Disks] Display device name [#3902](https://github.com/vatesfr/xen-orchestra/issues/3902) (PR [#3946](https://github.com/vatesfr/xen-orchestra/pull/3946))
+- [VM Snapshotting]
+  - Detect and destroy broken quiesced snapshot left by XenServer [#3936](https://github.com/vatesfr/xen-orchestra/issues/3936) (PR [#3937](https://github.com/vatesfr/xen-orchestra/pull/3937))
+  - Retry twice after a 1 minute delay if quiesce failed [#3938](https://github.com/vatesfr/xen-orchestra/issues/3938) (PR [#3952](https://github.com/vatesfr/xen-orchestra/pull/3952))
+
+### Bug fixes
+
+- [Import] Fix import of big OVA files
+- [Host] Show the host's memory usage instead of the sum of the VMs' memory usage (PR [#3924](https://github.com/vatesfr/xen-orchestra/pull/3924))
+- [SAML] Make `AssertionConsumerServiceURL` matches the callback URL
+- [Backup NG] Correctly delete broken VHD chains [#3875](https://github.com/vatesfr/xen-orchestra/issues/3875) (PR [#3939](https://github.com/vatesfr/xen-orchestra/pull/3939))
+- [Remotes] Don't ignore `mount` options [#3935](https://github.com/vatesfr/xen-orchestra/issues/3935) (PR [#3931](https://github.com/vatesfr/xen-orchestra/pull/3931))
+
+### Released packages
+
+- xen-api v0.24.2
+- @xen-orchestra/fs v0.6.1
+- xo-server-auth-saml v0.5.3
+- xo-server v5.35.0
+- xo-web v5.35.0
+
+## **5.31.0** (2019-01-31)
+
+### Enhancements
+
+- [Backup NG] Restore logs moved to restore tab [#3772](https://github.com/vatesfr/xen-orchestra/issues/3772) (PR [#3802](https://github.com/vatesfr/xen-orchestra/pull/3802))
+- [Remotes] New SMB implementation that provides better stability and performance [#2257](https://github.com/vatesfr/xen-orchestra/issues/2257) (PR [#3708](https://github.com/vatesfr/xen-orchestra/pull/3708))
+- [VM/advanced] ACL management from VM view [#3040](https://github.com/vatesfr/xen-orchestra/issues/3040) (PR [#3774](https://github.com/vatesfr/xen-orchestra/pull/3774))
+- [VM / snapshots] Ability to save the VM memory [#3795](https://github.com/vatesfr/xen-orchestra/issues/3795) (PR [#3812](https://github.com/vatesfr/xen-orchestra/pull/3812))
+- [Backup NG / Health] Show number of lone snapshots in tab label [#3500](https://github.com/vatesfr/xen-orchestra/issues/3500) (PR [#3824](https://github.com/vatesfr/xen-orchestra/pull/3824))
+- [Login] Add autofocus on username input on login page [#3835](https://github.com/vatesfr/xen-orchestra/issues/3835) (PR [#3836](https://github.com/vatesfr/xen-orchestra/pull/3836))
+- [Home/VM] Bulk snapshot: specify snapshots' names [#3778](https://github.com/vatesfr/xen-orchestra/issues/3778) (PR [#3787](https://github.com/vatesfr/xen-orchestra/pull/3787))
+- [Remotes] Show free space and disk usage on remote [#3055](https://github.com/vatesfr/xen-orchestra/issues/3055) (PR [#3767](https://github.com/vatesfr/xen-orchestra/pull/3767))
+- [New SR] Add tooltip for reattach action button [#3845](https://github.com/vatesfr/xen-orchestra/issues/3845) (PR [#3852](https://github.com/vatesfr/xen-orchestra/pull/3852))
+- [VM migration] Display hosts' free memory [#3264](https://github.com/vatesfr/xen-orchestra/issues/3264) (PR [#3832](https://github.com/vatesfr/xen-orchestra/pull/3832))
+- [Plugins] New field to filter displayed plugins (PR [#3832](https://github.com/vatesfr/xen-orchestra/pull/3871))
+- Ability to copy ID of "unknown item"s [#3833](https://github.com/vatesfr/xen-orchestra/issues/3833) (PR [#3856](https://github.com/vatesfr/xen-orchestra/pull/3856))
+- [Cloud-Init] switch config drive type to `nocloud` to prepare for the passing of network config (PR [#3877](https://github.com/vatesfr/xen-orchestra/pull/3877))
+- [UI] Show pool name next to templates' names [#3894](https://github.com/vatesfr/xen-orchestra/issues/3894) (PR [#3896](https://github.com/vatesfr/xen-orchestra/pull/3896))
+- [Backup NG] Support zstd compression for full backups [#3773](https://github.com/vatesfr/xen-orchestra/issues/3773) (PR [#3883](https://github.com/vatesfr/xen-orchestra/pull/3883))
+- [VM] Ability to copy a VM with zstd compression [#3773](https://github.com/vatesfr/xen-orchestra/issues/3773) (PR [#3889](https://github.com/vatesfr/xen-orchestra/pull/3889))
+- [VM & Host] "Pool > Host" breadcrumb at the top of the page (PR [#3898](https://github.com/vatesfr/xen-orchestra/pull/3898))
+- [Hosts] Ability to enable/disable host multipathing [#3659](https://github.com/vatesfr/xen-orchestra/issues/3659) (PR [#3865](https://github.com/vatesfr/xen-orchestra/pull/3865))
+- [Login] Add OTP authentication [#2044](https://github.com/vatesfr/xen-orchestra/issues/2044) (PR [#3879](https://github.com/vatesfr/xen-orchestra/pull/3879))
+- [Notifications] New notification page to provide important information about XOA (PR [#3904](https://github.com/vatesfr/xen-orchestra/pull/3904))
+- [VM] Ability to export a VM with zstd compression [#3773](https://github.com/vatesfr/xen-orchestra/issues/3773) (PR [#3891](https://github.com/vatesfr/xen-orchestra/pull/3891))
+- [Host/network] Display PIF speed [#3887](https://github.com/vatesfr/xen-orchestra/issues/3887) (PR [#3901](https://github.com/vatesfr/xen-orchestra/pull/3901))
+- [SR] Display iscsi paths and mark the SR with a yellow dot if one path is not available. [#3659](https://github.com/vatesfr/xen-orchestra/issues/3659) (PR [#3829](https://github.com/vatesfr/xen-orchestra/pull/3829))
+- [UI] Unifies the Signin buttons (PR [#3913](https://github.com/vatesfr/xen-orchestra/pull/3913))
+- [Settings/remotes] NFS: display default option on placeholder [#3631](https://github.com/vatesfr/xen-orchestra/issues/3631) (PR [#3921](https://github.com/vatesfr/xen-orchestra/pull/3921))
+- [VM/advanced] Ability to pin vCPU to physical cores [#3241](https://github.com/vatesfr/xen-orchestra/issues/3241) (PR [#3254](https://github.com/vatesfr/xen-orchestra/pull/3254))
+
+### Bug fixes
+
+- [Self] Display sorted Resource Sets [#3818](https://github.com/vatesfr/xen-orchestra/issues/3818) (PR [#3823](https://github.com/vatesfr/xen-orchestra/pull/3823))
+- [Servers] Correctly report connecting status (PR [#3838](https://github.com/vatesfr/xen-orchestra/pull/3838))
+- [Servers] Fix cannot reconnect to a server after connection has been lost [#3839](https://github.com/vatesfr/xen-orchestra/issues/3839) (PR [#3841](https://github.com/vatesfr/xen-orchestra/pull/3841))
+- [New VM] Fix `NO_HOSTS_AVAILABLE()` error when creating  a VM on a local SR from template on another local SR [#3084](https://github.com/vatesfr/xen-orchestra/issues/3084) (PR [#3827](https://github.com/vatesfr/xen-orchestra/pull/3827))
+- [Backup NG] Fix typo in the form [#3854](https://github.com/vatesfr/xen-orchestra/issues/3854) (PR [#3855](https://github.com/vatesfr/xen-orchestra/pull/3855))
+- [New SR] No warning when creating a NFS SR on a path that is already used as NFS SR [#3844](https://github.com/vatesfr/xen-orchestra/issues/3844) (PR [#3851](https://github.com/vatesfr/xen-orchestra/pull/3851))
+- [New SR] No redirection if the SR creation failed or canceled [#3843](https://github.com/vatesfr/xen-orchestra/issues/3843) (PR [#3853](https://github.com/vatesfr/xen-orchestra/pull/3853))
+- [Home] Fix two tabs opened by middle click in Firefox [#3450](https://github.com/vatesfr/xen-orchestra/issues/3450) (PR [#3825](https://github.com/vatesfr/xen-orchestra/pull/3825))
+- [XOA] Enable downgrade for ending trial (PR [#3867](https://github.com/vatesfr/xen-orchestra/pull/3867))
+- [OVA import] allow import of big files [#3468](https://github.com/vatesfr/xen-orchestra/issues/3468) (PR [#3504](https://github.com/vatesfr/xen-orchestra/pull/3504))
+- [Backup NG] Smart settings not saved when editing a backup job [#3885](https://github.com/vatesfr/xen-orchestra/issues/3885) (PR [#3886](https://github.com/vatesfr/xen-orchestra/pull/3886))
+- [VM/snapshot] New snapshot with memory: fix "invalid parameters" error (PR [#3903](https://github.com/vatesfr/xen-orchestra/pull/3903))
+- [VM creation] Broken CloudInit config drive when VM created on local SR
+- [Legacy Backup] Fix error when restoring a backup
+- [Home] Fix `user.getAll` error when user is not admin [#3573](https://github.com/vatesfr/xen-orchestra/issues/3573) (PR [#3918](https://github.com/vatesfr/xen-orchestra/pull/3918))
+- [Backup NG] Fix restore issue when a disk has grown [#3910](https://github.com/vatesfr/xen-orchestra/issues/3910)  (PR [#3920](https://github.com/vatesfr/xen-orchestra/pull/3920))
+- [Backup NG] Delete _importing_ VMs due to interrupted CR/DR (PR [#3923](https://github.com/vatesfr/xen-orchestra/pull/3923))
+
+### Released packages
+
+- vhd-cli v0.2.0
+- @xen-orchestra/fs v0.6.0
+- vhd-lib v0.5.1
+- xoa-updater v0.15.0
+- xen-api v0.24.1
+- xo-vmdk-to-vhd v0.1.6
+- xo-server v5.34.0
+- xo-web v5.34.0
+
+## **5.30.0** (2018-12-20)
+
+### Enhancements
+
+- [Users] Display user groups [#3719](https://github.com/vatesfr/xen-orchestra/issues/3719) (PR [#3740](https://github.com/vatesfr/xen-orchestra/pull/3740))
+- [VDI] Display VDI's SR [3021](https://github.com/vatesfr/xen-orchestra/issues/3021) (PR [#3285](https://github.com/vatesfr/xen-orchestra/pull/3285))
+- [Health, VM/disks] Display SR's container [#3021](https://github.com/vatesfr/xen-orchestra/issues/3021) (PRs [#3747](https://github.com/vatesfr/xen-orchestra/pull/3747), [#3751](https://github.com/vatesfr/xen-orchestra/pull/3751))
+- [Servers] Auto-connect to ejected host [#2238](https://github.com/vatesfr/xen-orchestra/issues/2238) (PR [#3738](https://github.com/vatesfr/xen-orchestra/pull/3738))
+- [Backup NG] Add "XOSAN" in excluded tags by default [#2128](https://github.com/vatesfr/xen-orchestra/issues/3563) (PR [#3559](https://github.com/vatesfr/xen-orchestra/pull/3563))
+- [VM] add tooltip for VM status icon [#3749](https://github.com/vatesfr/xen-orchestra/issues/3749) (PR [#3765](https://github.com/vatesfr/xen-orchestra/pull/3765))
+- [New XOSAN] Improve view and possibility to sort SRs by name/size/free space [#2416](https://github.com/vatesfr/xen-orchestra/issues/2416) (PR [#3691](https://github.com/vatesfr/xen-orchestra/pull/3691))
+- [Backup NG] Disable HA on replicated VM (CR, DR) [#2359](https://github.com/vatesfr/xen-orchestra/issues/2359) (PR [#3755](https://github.com/vatesfr/xen-orchestra/pull/3755))
+- [Backup NG] Display the last run status for each schedule with the possibility to show the associated log [#3769](https://github.com/vatesfr/xen-orchestra/issues/3769) (PR [#3779](https://github.com/vatesfr/xen-orchestra/pull/3779))
+- [Backup NG] Add a link to the documentation [#3789](https://github.com/vatesfr/xen-orchestra/issues/3789) (PR [#3790](https://github.com/vatesfr/xen-orchestra/pull/3790))
+- [Backup NG] Ability to copy schedule/job id to the clipboard [#3753](https://github.com/vatesfr/xen-orchestra/issues/3753) (PR [#3791](https://github.com/vatesfr/xen-orchestra/pull/3791))
+- [Backup NG / logs] Merge the job log status with the display details button [#3797](https://github.com/vatesfr/xen-orchestra/issues/3797) (PR [#3800](https://github.com/vatesfr/xen-orchestra/pull/3800))
+- [XOA] Notification banner when XOA is not registered [#3803](https://github.com/vatesfr/xen-orchestra/issues/3803) (PR [#3808](https://github.com/vatesfr/xen-orchestra/pull/3808))
+
+### Bug fixes
+
+- [Home/SRs] Fixed SR status for non admin users [#2204](https://github.com/vatesfr/xen-orchestra/issues/2204) (PR [#3742](https://github.com/vatesfr/xen-orchestra/pull/3742))
+- [Servers] Fix occasional "server's pool already connected" errors when pool is not connected (PR [#3782](https://github.com/vatesfr/xen-orchestra/pull/3782))
+- [Self] Fix missing objects when the self service view is the first one to be loaded when opening XO [#2689](https://github.com/vatesfr/xen-orchestra/issues/2689) (PR [#3096](https://github.com/vatesfr/xen-orchestra/pull/3096))
+
+### Released packages
+
+- @xen-orchestra/fs v0.5.0
+- xen-api v0.23.0
+- xo-acl-resolver v0.4.1
+- xo-server v5.32.0
+- xo-web v5.32.0
+
+## **5.29.0** (2018-11-29)
+
+### Enhancements
+
+- [Perf alert] Ability to trigger an alarm if a host/VM/SR usage value is below the threshold [#3612](https://github.com/vatesfr/xen-orchestra/issues/3612) (PR [#3675](https://github.com/vatesfr/xen-orchestra/pull/3675))
+- [Home/VMs] Display pool's name [#2226](https://github.com/vatesfr/xen-orchestra/issues/2226) (PR [#3709](https://github.com/vatesfr/xen-orchestra/pull/3709))
+- [Servers] Prevent new connection if pool is already connected [#2238](https://github.com/vatesfr/xen-orchestra/issues/2238) (PR [#3724](https://github.com/vatesfr/xen-orchestra/pull/3724))
+- [VM] Pause (like Suspend but doesn't copy RAM on disk) [#3727](https://github.com/vatesfr/xen-orchestra/issues/3727) (PR [#3731](https://github.com/vatesfr/xen-orchestra/pull/3731))
+
+### Bug fixes
+
+- [Servers] Fix deleting server on joining a pool [#2238](https://github.com/vatesfr/xen-orchestra/issues/2238) (PR [#3728](https://github.com/vatesfr/xen-orchestra/pull/3728))
+
+### Released packages
+
+- xen-api v0.22.0
+- xo-server-perf-alert v0.2.0
+- xo-server-usage-report v0.7.1
+- xo-server v5.31.0
+- xo-web v5.31.0
+
+## **5.28.2** (2018-11-16)
 
 ### Enhancements
 
@@ -33,7 +679,7 @@
 - xen-api v0.21.0
 - xo-common v0.2.0
 - xo-acl-resolver v0.4.0
-- xo-server v5.30.0
+- xo-server v5.30.1
 - xo-web v5.30.0
 
 ## **5.28.1** (2018-11-05)

CHANGELOG.unreleased.md

@@ -0,0 +1,22 @@
+> This file contains all changes that have not been released yet.
+>
+> Keep in mind the changelog is addressed to **users** and should be
+> understandable by them.
+
+### Enhancements
+
+> Users must be able to say: “Nice enhancement, I'm eager to test it”
+
+### Bug fixes
+
+> Users must be able to say: “I had this issue, happy to know it's fixed”
+
+### Released packages
+
+> Packages will be released in the order they are here, therefore, they should
+> be listed by inverse order of dependency.
+>
+> Rule of thumb: add packages on top.
+
+- xo-server v5.55.0
+- xo-web v5.55.0

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

ISSUE_TEMPLATE.md

@@ -14,9 +14,9 @@ the issues :)
 
 - **XO origin**: the sources / XO Appliance
 - **Versions**:
-   - Node: **FILL HERE**
-   - xo-web: **FILL HERE**
-   - xo-server: **FILL HERE**
+  - Node: **FILL HERE**
+  - xo-web: **FILL HERE**
+  - xo-server: **FILL HERE**
 
 ### Expected behavior
 

PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1,28 @@
 ### Check list
 
-> Check items when done or if not relevant
+> Check if done, if not relevant leave unchecked.
 
-- [ ] PR reference the relevant issue (e.g. `Fixes #007`)
+- [ ] PR reference the relevant issue (e.g. `Fixes #007` or `See xoa-support#42`)
 - [ ] if UI changes, a screenshot has been added to the PR
-- [ ] CHANGELOG:
-   - enhancement/bug fix entry added
-   - list of packages to release updated (`${name} v${new version}`)
 - [ ] documentation updated
+- `CHANGELOG.unreleased.md`:
+  - [ ] enhancement/bug fix entry added
+  - [ ] list of packages to release updated (`${name} v${new version}`)
+- **I have tested added/updated features** (and impacted code)
+  - [ ] unit tests (e.g. [`cron/parse.spec.js`](https://github.com/vatesfr/xen-orchestra/blob/b24400b21de1ebafa1099c56bac1de5c988d9202/%40xen-orchestra/cron/src/parse.spec.js))
+  - [ ] if `xo-server` API changes, the corresponding test has been added to/updated on [`xo-server-test`](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server-test)
+  - [ ] at least manual testing
 
 ### Process
 
 1. create a PR as soon as possible
 1. mark it as `WiP:` (Work in Progress) if not ready to be merged
-1. when you want a review, add a reviewer
+1. when you want a review, add a reviewer (and only one)
 1. if necessary, update your PR, and re- add a reviewer
+
+From [_the Four Agreements_](https://en.wikipedia.org/wiki/Don_Miguel_Ruiz#The_Four_Agreements):
+
+1. Be impeccable with your word.
+1. Don't take anything personally.
+1. Don't make assumptions.
+1. Always do your best.

README.md

@@ -1,4 +1,4 @@
-# Xen Orchestra [![Chat with us](https://storage.crisp.im/plugins/images/936925df-f37b-4ba8-bab0-70cd2edcb0be/badge.svg)](https://go.crisp.im/chat/embed/?website_id=-JzqzzwddSV7bKGtEyAQ) [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
+# Xen Orchestra [![Build Status](https://travis-ci.org/vatesfr/xen-orchestra.png?branch=master)](https://travis-ci.org/vatesfr/xen-orchestra)
 
 ![](http://i.imgur.com/tRffA5y.png)
 

docs/README.md

@@ -1,4 +1,3 @@
-
 # Xen Orchestra
 
 ## Introduction
@@ -13,19 +12,19 @@ It aims to be easy to use on any device supporting modern web technologies (HTML
 
 ## XOA quick deploy
 
-SSH to your XenServer, and execute the following:
+Log in to your account and use the deploy form available on [this page](https://xen-orchestra.com/#!/xoa)
 
-```
-bash -c "$(curl -s http://xoa.io/deploy)"
-```
+> **Note:** no data will be sent to our servers, it's running only between your browser and your host!
+
+[![](./assets/deploy_form.png)](https://xen-orchestra.com/#!/xoa)
 
 ### XOA credentials
 
-* Web UI: `admin@admin.net` / `admin`
-* Console/SSH: `xoa` / `xoa` (first login)
+- Web UI: `admin@admin.net` / `admin`
+- Console/SSH: `xoa` / `xoa` (first login)
 
 ## Must read
 
-* [XOA installation](xoa.md)
-* [Main features](features.md)
-* [Pro Support](support.md)
+- [XOA installation](xoa.md)
+- [Main features](features.md)
+- [Pro Support](support.md)

docs/SUMMARY.md

@@ -1,77 +1,81 @@
 # Summary
 
-* [Introduction](README.md)
-* [Architecture](architecture.md)
-   * [xo-server](xo-server.md)
-   * [xo-web](xo-web.md)
-   * [xo-cli](xo-cli.md)
-   * [others](others.md)
-* [Installation](installation.md)
-   * [XOA](xoa.md)
-       * [Updater](updater.md)
-       * [Trial activation](trial_activation.md)
-       * [Plugins](plugins.md)
-       * [Logs](logs.md)
-       * [Compatibility](supported-version.md)
-       * [Troubleshooting](troubleshooting.md)
-   * [From the sources](from_the_sources.md)
-* [Configuration](configuration.md)
-* [Features](features.md)
-   * [Administration](administration.md)
-       * [Home view](user_interface.md)
-       * [Search and filters](search.md)
-       * [VM management](vm_management.md)
-       * [VM creation](vm_creation.md)
-       * [VM import and export](vm_import_export.md)
-       * [XenServer Patching](patching.md)
-   * [Docker support](docker_support.md)
-   * [Backup and DR](backups.md)
-       * [Full backups](full_backups.md)
-       * [Rolling snapshots](rolling_snapshots.md)
-       * [Continuous Delta backups](delta_backups.md)
-       * [Continuous Replication](continuous_replication.md)
-       * [Disaster recovery](disaster_recovery.md)
-       * [Smart Backup](smart_backup.md)
-       * [File level Restore](file_level_restore.md)
-       * [Backup Concurrency](concurrency.md)
-       * [Configure backup reports](backup_reports.md)
-       * [Backup troubleshooting](backup_troubleshooting.md)
-   * [User authentication](authentication.md)
-       * [Built-in](built-in.md)
-       * [LDAP](ldap.md)
-       * [SAML](saml.md)
-       * [GitHub](github.md)
-       * [Google](google.md)
-   * [Resources delegation](resources_delegation.md)
-       * [ACLs](acls.md)
-   * [CloudInit](cloudinit.md)
-   * [Self Service](self_service.md)
-   * [Visualizations](visualizations.md)
-   * [Health](health.md)
-   * [Job manager](scheduler.md)
-   * [Alerts](alerts.md)
-   * [Load balancing](load_balancing.md)
-   * [Auto scalability](auto_scalability.md)
-   * [Forecaster](forecaster.md)
-* [Recipes](recipes.md)
-   * [Reverse proxy](reverse_proxy.md)
-* [How to contribute?](contributing.md)
-* [Support](support.md)
-* [Roadmap](roadmap.md)
-* [Purchase](purchase.md)
-   * [Direct purchase](directpurchase.md)
-   * [Through purchase department](through_purchase_department.md)
-   * [Reseller](reseller.md)
-   * [Editions](editions.md)
-   * [Trial](trial.md)
-   * [Invoices](invoices.md)
-   * [Upgrade](upgrade.md)
-* [XOSAN](xosan.md)
-  * [Requirements](xosan_requirements.md)
-  * [Types](xosan_types.md)
-    * [Replicated](xosan_replicated.md)
-    * [Disperse](xosan_disperse.md)
-  * [Creation](xosan_create.md)
-  * [Trial](xosan_trial.md)
-* [General Troubleshooting](general-troubleshooting.md)
-* [Glossary](glossary.md)
+- [Introduction](README.md)
+- [Architecture](architecture.md)
+  - [xo-server](xo-server.md)
+  - [xo-web](xo-web.md)
+  - [xo-cli](xo-cli.md)
+  - [others](others.md)
+- [Installation](installation.md)
+  - [XOA](xoa.md)
+    - [Updater](updater.md)
+    - [Trial activation](trial_activation.md)
+    - [Plugins](plugins.md)
+    - [Logs](logs.md)
+    - [Compatibility](supported-version.md)
+    - [Troubleshooting](troubleshooting.md)
+  - [From the sources](from_the_sources.md)
+- [Configuration](configuration.md)
+- [Features](features.md)
+  - [Administration](administration.md)
+    - [Home view](user_interface.md)
+    - [Search and filters](search.md)
+    - [VM management](vm_management.md)
+    - [VM creation](vm_creation.md)
+    - [VM import and export](vm_import_export.md)
+    - [XenServer Patching](patching.md)
+  - [Docker support](docker_support.md)
+  - [Backup and DR](backups.md)
+    - [Full backups](full_backups.md)
+    - [Rolling snapshots](rolling_snapshots.md)
+    - [Continuous Delta backups](delta_backups.md)
+    - [Continuous Replication](continuous_replication.md)
+    - [Disaster recovery](disaster_recovery.md)
+    - [Smart Backup](smart_backup.md)
+    - [File level Restore](file_level_restore.md)
+    - [Metadata Backup](metadata_backup.md)
+    - [Backup Concurrency](concurrency.md)
+    - [Configure backup reports](backup_reports.md)
+    - [Backup troubleshooting](backup_troubleshooting.md)
+  - [User authentication](authentication.md)
+    - [Built-in](built-in.md)
+    - [LDAP](ldap.md)
+    - [SAML](saml.md)
+    - [GitHub](github.md)
+    - [Google](google.md)
+  - [Resources delegation](resources_delegation.md)
+    - [ACLs](acls.md)
+  - [CloudInit](cloudinit.md)
+  - [Self Service](self_service.md)
+  - [Visualizations](visualizations.md)
+  - [Health](health.md)
+  - [Job manager](scheduler.md)
+  - [Alerts](alerts.md)
+  - [Web hooks](web-hooks.md)
+  - [Load balancing](load_balancing.md)
+  - [Emergency Shutdown](emergency_shutdown.md)
+  - [Auto scalability](auto_scalability.md)
+  - [Forecaster](forecaster.md)
+  - [SDN Controller](sdn_controller.md)
+- [Recipes](recipes.md)
+  - [Reverse proxy](reverse_proxy.md)
+- [How to contribute?](contributing.md)
+- [Support](support.md)
+- [Roadmap](roadmap.md)
+- [Purchase](purchase.md)
+  - [Direct purchase](directpurchase.md)
+  - [Through purchase department](through_purchase_department.md)
+  - [Reseller](reseller.md)
+  - [Editions](editions.md)
+  - [Trial](trial.md)
+  - [Invoices](invoices.md)
+  - [Upgrade](upgrade.md)
+- [XOSAN](xosan.md)
+  - [Requirements](xosan_requirements.md)
+  - [Types](xosan_types.md)
+    - [Replicated](xosan_replicated.md)
+    - [Disperse](xosan_disperse.md)
+  - [Creation](xosan_create.md)
+  - [Trial](xosan_trial.md)
+- [General Troubleshooting](general-troubleshooting.md)
+- [Glossary](glossary.md)

docs/acls.md

@@ -23,32 +23,32 @@ You can edit/remove existing ACLs here.
 
 There are 3 different roles for your users:
 
-* Admin
-* Operator
-* Viewer
+- Admin
+- Operator
+- Viewer
 
 ### Admin
 
 An object admin can do everything on it, even destroy it. E.g with its admin VM:
 
-* remove it
-* migrate it (to a host with admin permission on it)
-* modify the VM resources, name and description
-* clone it
-* copy it
-* convert it into a template
-* snapshot it (even revert from a snapshot)
-* export it
-* attach/add visible disks
-* same for network cards
+- remove it
+- migrate it (to a host with admin permission on it)
+- modify the VM resources, name and description
+- clone it
+- copy it
+- convert it into a template
+- snapshot it (even revert from a snapshot)
+- export it
+- attach/add visible disks
+- same for network cards
 
 ### Operator
 
 An operator can make everyday operations on assigned objects. E.g on a VM:
 
-* eject a CD
-* insert a CD (if he can view the ISO storage repository)
-* start, restart, shutdown, suspend/resume it
+- eject a CD
+- insert a CD (if he can view the ISO storage repository)
+- start, restart, shutdown, suspend/resume it
 
 All other operations are forbidden.
 
@@ -60,7 +60,7 @@ A viewer can only see the VM state and its metrics. That's all!
 
 Objects have a hierarchy: a Pool contains all its hosts, containing itself all its VMs.
 
-If you give a *view* permission to a user (or a group) on a pool, he will automatically see all the objects inside this pool (SRs, hosts, VMs).
+If you give a _view_ permission to a user (or a group) on a pool, he will automatically see all the objects inside this pool (SRs, hosts, VMs).
 
 ## Examples
 
@@ -68,5 +68,5 @@ If you give a *view* permission to a user (or a group) on a pool, he will automa
 
 If the OS install needs an ISO, you need to give this user 2 permissions:
 
-* *Operate* on the VM (e.g to start it)
-* *View* on the ISO Storage containing the needed ISO.
+- _Operate_ on the VM (e.g to start it)
+- _View_ on the ISO Storage containing the needed ISO.

docs/administration.md

@@ -2,11 +2,11 @@
 
 This section contains everyday XenServer administration tasks.
 
-* [Home view](user_interface.md)
-* [Search and filters](search.md)
-* [VM management](vm_management.md)
-* [VM creation](vm_creation.md)
-* [VM import and export](vm_import_export.md)
-* [XenServer Patching](patching.md)
+- [Home view](user_interface.md)
+- [Search and filters](search.md)
+- [VM management](vm_management.md)
+- [VM creation](vm_creation.md)
+- [VM import and export](vm_import_export.md)
+- [XenServer Patching](patching.md)
 
 ![](./assets/xo5homevms.png)

docs/alerts.md

@@ -8,12 +8,12 @@ The administrator will configure alerts based on performance thresholds.
 
 The configurable metrics are:
 
-* CPU usage (VM, host)
-* RAM usage (VM, host)
-* network bandwidth (VM, host)
-* load average (host)
-* disk IO (VM)
-* total IO (SR, only for XenServer Dundee and higher)
+- CPU usage (VM, host)
+- RAM usage (VM, host)
+- network bandwidth (VM, host)
+- load average (host)
+- disk IO (VM)
+- total IO (SR, only for XenServer Dundee and higher)
 
 If any configured values exceed the threshold during a selected period of time, an alert will be sent.
 
@@ -31,5 +31,5 @@ You can choose to be notified only if it fails or even after each backup job.
 
 Current supported alerts system:
 
-* Email
-* XMPP
+- Email
+- XMPP

docs/architecture.md

@@ -1,4 +1,3 @@
-
 # Architecture
 
 Xen Orchestra (XO) is software built with a server and clients, such as the web client `xo-web`, but also a CLI capable client, called `xo-cli`.
@@ -7,7 +6,7 @@ Xen Orchestra (XO) is software built with a server and clients, such as the web
 
 ## XOA
 
-*Xen Orchestra Virtual Appliance* (XOA) is a virtual machine with Xen Orchestra already installed, thus working out-of-the-box.
+_Xen Orchestra Virtual Appliance_ (XOA) is a virtual machine with Xen Orchestra already installed, thus working out-of-the-box.
 
 This is the easiest way to try Xen Orchestra quickly.
 
@@ -20,9 +19,9 @@ Your XOA is connected to all your hosts, or the pool master only if you are usin
 ![](./assets/xo-arch.jpg)
 
 Xen Orchestra itself is built as a modular solution. Each part has its role:
+
 - The core is "[xo-server](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-server/)" - a daemon dealing directly with XenServer or XAPI capable hosts. This is where users are stored, and it's the center point for talking to your whole Xen infrastructure.
-- The web interface is "[xo-web](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-web)" - it runs directly from your browser. The connection with ```xo-server``` is done via *WebSockets*.
+- The web interface is "[xo-web](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-web)" - it runs directly from your browser. The connection with `xo-server` is done via _WebSockets_.
 - "[xo-cli](https://github.com/vatesfr/xen-orchestra/tree/master/packages/xo-cli)" is a module allowing you to send commands directly from the command line.
 
-
 We have other modules as well (like the LDAP plugin for example). It allows us to use this modular architecture to add further parts as we need them. It's completely flexible, allowing us to adapt Xen Orchestra to every existing workflow.

docs/authentication.md

@@ -1,16 +1,14 @@
 # User authentication
 
-
 Xen Orchestra supports various types of user authentication, internal or even external thanks to the usage of the [Passport library](http://passportjs.org/).
 
 There are 2 types of XO users:
 
-* admins, with all rights on all connected resources
-* users, with no rights by default
+- admins, with all rights on all connected resources
+- users, with no rights by default
 
 All users will land on the "flat" view, which displays no hierarchy, only all their visible objects (or no object if they are not configured).
 
-
 ACLs will thus apply only to "users".
 
 > Any account created by an external authentication process (LDAP, SSO...) will be a **user** without any permission.

docs/backup_reports.md

@@ -6,15 +6,15 @@ At the end of a backup job, you can configure Xen Orchestra to send backup repor
 
 ### Step-by-step
 
-1. On the "settings/plugins" view you have to activate and configure the "Backup-reports" plugin. 
-![](./assets/backup-reports-plugin.png)
+1. On the "settings/plugins" view you have to activate and configure the "Backup-reports" plugin.
+   ![](./assets/backup-reports-plugin.png)
 
 2. Still in the plugins view, you also have to configure the "transport-email" plugin.
-![](./assets/transport-email-plugin.png)
+   ![](./assets/transport-email-plugin.png)
 
-3. Once it's done, you can now create your backup job. In the "report" selection you can choose the situation in wish you want to receive an email (always, never or failure). 
-![](./assets/backup-report-config.png)
-> Note: You can also modify existing backup jobs and change the behaviour of the report system.
+3. Once it's done, you can now create your backup job. In the "report" selection you can choose the situation in wish you want to receive an email (always, never or failure).
+   ![](./assets/backup-report-config.png)
+   > Note: You can also modify existing backup jobs and change the behaviour of the report system.
 
 ## XMPP nofications
 
@@ -67,9 +67,9 @@ Like all other xo-server plugins, it can be configured directly via the web inte
 
 You need to be an admin:
 
-* Go into the MatterMost menu, then Integration
-* Click on "Add Incoming webhook"
-* "Add Incoming Webhook"
+- Go into the MatterMost menu, then Integration
+- Click on "Add Incoming webhook"
+- "Add Incoming Webhook"
 
 ### Testing the plugin
 

docs/backup_troubleshooting.md

@@ -12,33 +12,37 @@ Another good way to check if there is activity is the XOA VM stats view (on the
 
 ### VDI chain protection
 
-This means your previous VM disks and snapshots should be "merged" (*coalesced* in the XenServer world) before we can take a new snapshot. This mechanism is handled by XenServer itself, not Xen Orchestra. But we can check your existing VDI chain and avoid creating more snapshots than your storage can merge. Otherwise, this will lead to catastrophic consequences. Xen Orchestra is the **only** XenServer/XCP backup product dealing with this.
+Backup jobs regularly delete snapshots. When a snapshot is deleted, either manually or via a backup job, it triggers the need for Xenserver to coalesce the VDI chain - to merge the remaining VDIs and base copies in the chain. This means generally we cannot take too many new snapshots on said VM until Xenserver has finished running a coalesce job on the VDI chain.
+
+This mechanism and scheduling is handled by XenServer itself, not Xen Orchestra. But we can check your existing VDI chain and avoid creating more snapshots than your storage can merge. If we don't, this will lead to catastrophic consequences. Xen Orchestra is the **only** XenServer/XCP backup product that takes this into account and offers protection.
 
 Without this detection, you could have 2 potential issues:
 
-* `The Snapshot Chain is too Long`
-* `SR_BACKEND_FAILURE_44 (insufficient space)`
+- `The Snapshot Chain is too Long`
+- `SR_BACKEND_FAILURE_44 (insufficient space)`
 
 The first issue is a chain that contains more than 30 elements (fixed XenServer limit), and the other one means it's full because the "coalesce" process couldn't keep up the pace and the storage filled up.
 
-In the end, this message is a **protection mechanism against damaging your SR**. The backup job will fail, but XenServer itself should eventually automatically coalesce the snapshot chain, and the the next time the backup job should complete.
+In the end, this message is a **protection mechanism preventing damage to your SR**. The backup job will fail, but XenServer itself should eventually automatically coalesce the snapshot chain, and the the next time the backup job should complete.
 
-Just remember this: **coalesce will happen every time a snapshot is removed**.
+Just remember this: **a coalesce should happen every time a snapshot is removed**.
 
 > You can read more on this on our dedicated blog post regarding [XenServer coalesce detection](https://xen-orchestra.com/blog/xenserver-coalesce-detection-in-xen-orchestra/).
 
 ### Troubleshooting a constant VDI Chain Protection message (XenServer failure to coalesce)
 
- As previously mentioned, this message can be normal and it just means XenServer needs to perform a coalesce to merge old snapshots. However if you repeatedly get this message and it seems XenServer is not coalescing, You can take a few steps to determine why.  
+As previously mentioned, this message can be normal and it just means XenServer needs to perform a coalesce to merge old snapshots. However if you repeatedly get this message and it seems XenServer is not coalescing, You can take a few steps to determine why.
 
-First check SMlog on the XenServer host for messages relating to VDI corruption or coalesce job failure. For example, by running `cat /var/log/SMlog | grep -i exception` or `cat /var/log/SMlog | grep -i error` on the XenServer host with the affected storage.  
+First check SMlog on the XenServer host for messages relating to VDI corruption or coalesce job failure. For example, by running `cat /var/log/SMlog | grep -i exception` or `cat /var/log/SMlog | grep -i error` on the XenServer host with the affected storage.
 
-Coalesce jobs can also fail to run if the SR does not have enough free space. Check the problematic SR and make sure it has enough free space, generally 30% or more free is recommended depending on VM size.  
+Coalesce jobs can also fail to run if the SR does not have enough free space. Check the problematic SR and make sure it has enough free space, generally 30% or more free is recommended depending on VM size. You can check if this is the issue by searching `SMlog` with `grep -i coales /var/log/SMlog` (you may have to look at previous logs such as `SMlog.1`).
 
-You can check if a coalesce job is currently active by running `ps axf | grep vhd` on the XenServer host and looking for a VHD process in the results (one of the resulting processes will be the grep command you just ran, ignore that one).  
+You can check if a coalesce job is currently active by running `ps axf | grep vhd` on the XenServer host and looking for a VHD process in the results (one of the resulting processes will be the grep command you just ran, ignore that one).
 
 If you don't see any running coalesce jobs, and can't find any other reason that XenServer has not started one, you can attempt to make it start a coalesce job by rescanning the SR. This is harmless to try, but will not always result in a coalesce. Visit the problematic SR in the XOA UI, then click the "Rescan All Disks" button towards the top right: it looks like a refresh circle icon. This should begin the coalesce process - if you click the Advanced tab in the SR view, the "disks needing to be coalesced" list should become smaller and smaller.
 
+As a last resort, migrating the VM (more specifically, its disks) to a new storage repository will also force a coalesce and solve this issue. That means migrating a VM to another host (with its own storage) and back will force the VDI chain for that VM to be coalesced, and get rid of the `VDI Chain Protection` message.
+
 ### Parse Error
 
 This is most likely due to running a backup job that uses Delta functionality (eg: delta backups, or continuous replication) on a version of XenServer older than 6.5. To use delta functionality you must run [XenServer 6.5 or later](https://xen-orchestra.com/docs/supported-version.html).
@@ -51,10 +55,10 @@ The Storage Repository (where your VM disks are currently stored) is full. Note
 
 Workarounds:
 
-* use a thin provisioned SR (local ext, NFS, XOSAN)
-* wait for Citrix to release thin provisioning on LVM
-* wait for Citrix to allow another mechanism besides snapshot to be able to export disks
-* use less than 50% of SR space or don't backup all VMs
+- use a thin provisioned SR (local ext, NFS, XOSAN)
+- wait for Citrix to release thin provisioning on LVM
+- wait for Citrix to allow another mechanism besides snapshot to be able to export disks
+- use less than 50% of SR space or don't backup all VMs
 
 ### Could not find the base VM
 
@@ -68,12 +72,12 @@ To solve it, you have to change a parameter in your VM. `xe vm-param-set has-ven
 
 ### ENOSPC: no space left on device
 
-This message appears when you do not have enough free space on the target remote when running a backup to it.  
+This message appears when you do not have enough free space on the target remote when running a backup to it.
 
 To check your free space, enter your XOA and run `xoa check` to check free system space and `df -h` to check free space on your chosen remote storage.
 
 ### Error: no VMs match this pattern
 
-This is happening when you have a *smart backup job* that doesn't match any VMs. For example: you created a job to backup all running VMs. If no VMs are running on backup schedule, you'll have this message. This could also happen if you lost connection with your pool master (the VMs aren't visible anymore from Xen Orchestra).
+This is happening when you have a _smart backup job_ that doesn't match any VMs. For example: you created a job to backup all running VMs. If no VMs are running on backup schedule, you'll have this message. This could also happen if you lost connection with your pool master (the VMs aren't visible anymore from Xen Orchestra).
 
 Edit your job and try to see matching VMs or check if your pool is connected to XOA.

docs/backups.md

@@ -1,15 +1,18 @@
 # Backups
 
+> Watch our [introduction video](https://www.youtube.com/watch?v=FfUqIwT8KzI) (45m) to Backup in Xen Orchestra!
+
 This section is dedicated to all existing methods of rolling back or backing up your VMs in Xen Orchestra.
 
 There are several ways to protect your VMs:
 
-* [Full Backups](full_backups.md) [*Starter Edition*]
-* [Rolling Snapshots](rolling_snapshots.md) [*Starter Edition*]
-* [Delta Backups](delta_backups.md) (best of both previous ones) [*Enterprise Edition*]
-* [Disaster Recovery](disaster_recovery.md) [*Enterprise Edition*]
-* [Continuous Replication](continuous_replication.md) [*Premium Edition*]
-* [File Level Restore](file_level_restore.md) [*Premium Edition*]
+- [Full Backups](full_backups.md) [*Starter Edition*]
+- [Rolling Snapshots](rolling_snapshots.md) [*Starter Edition*]
+- [Delta Backups](delta_backups.md) (best of both previous ones) [*Enterprise Edition*]
+- [Disaster Recovery](disaster_recovery.md) [*Enterprise Edition*]
+- [Metadata Backups](metadata_backup.md) [*Enterprise Edition*]
+- [Continuous Replication](continuous_replication.md) [*Premium Edition*]
+- [File Level Restore](file_level_restore.md) [*Premium Edition*]
 
 > Don't forget to take a look at the [backup troubleshooting](backup_troubleshooting.md) section. You can also take a look at the [backup reports](backup_reports.md) section for configuring notifications.
 
@@ -39,7 +42,7 @@ Each backups' job execution is identified by a `runId`. You can find this `runId
 
 All backup types rely on snapshots. But what about data consistency? By default, Xen Orchestra will try to take a **quiesced snapshot** every time a snapshot is done (and fall back to normal snapshots if it's not possible).
 
-Snapshots of Windows VMs can be quiesced (especially MS SQL or Exchange services) after you have installed Xen Tools in your VMs. However, [there is an extra step to install the VSS provider on windows](quiesce). A quiesced snapshot means the operating system will be notified and the cache will be flushed to disks. This way, your backups will always be consistent.
+Snapshots of Windows VMs can be quiesced (especially MS SQL or Exchange services) after you have installed Xen Tools in your VMs. However, [there is an extra step to install the VSS provider on windows](https://xen-orchestra.com/blog/xenserver-quiesce-snapshots/). A quiesced snapshot means the operating system will be notified and the cache will be flushed to disks. This way, your backups will always be consistent.
 
 To see if you have quiesced snapshots for a VM, just go into its snapshot tab, then the "info" icon means it is a quiesced snapshot:
 
@@ -51,16 +54,15 @@ The tooltip confirms this:
 
 ## Remotes
 
-> Remotes are places where your *backup* and *delta backup* files will be stored.
+> Remotes are places where your _backup_ and _delta backup_ files will be stored.
 
-To add a *remote*, go to the **Settings/Remotes** menu.
+To add a _remote_, go to the **Settings/Remotes** menu.
 
 Supported remote types:
 
-* Local (any folder in XOA filesystem)
-* NFS
-* SMB (CIFS)
-
+- Local (any folder in XOA filesystem)
+- NFS
+- SMB (CIFS)
 
 > **WARNING**: the initial "/" or "\\" is automatically added.
 
@@ -70,15 +72,15 @@ On your NFS server, authorize XOA's IP address and permissions for subfolders. T
 
 ### SMB
 
-We support SMB storage on *Windows Server 2012 R2*.
+We support SMB storage on _Windows Server 2012 R2_.
 
 > WARNING: For continuous delta backup, SMB is **NOT** recommended (or only for small VMs, eg < 50GB)
 
 Also, read the UI twice when you add an SMB store. If you have:
 
-* `192.168.1.99` as SMB host
-* `Backups` as folder
-* no subfolder
+- `192.168.1.99` as SMB host
+- `Backups` as folder
+- no subfolder
 
 You'll have to fill it like this:
 
@@ -109,13 +111,13 @@ All your scheduled backups are acccessible in the "Restore" view in the backup s
 
 ## About backup compression
 
-By default, *Backups* are compressed (using GZIP, done on XenServer side). There is no absolute rule but in general uncompressed backups are faster (but sometimes much larger).
+By default, _Backups_ are compressed (using GZIP, done on XenServer side). There is no absolute rule but in general uncompressed backups are faster (but sometimes much larger).
 
 XenServer uses Gzip compression, which is:
 
-* slow (single threaded)
-* space efficient
-* consumes less bandwidth (helpful if your NFS share is far away)
+- slow (single threaded)
+- space efficient
+- consumes less bandwidth (helpful if your NFS share is far away)
 
 If you have compression on your NFS share (or destination filesystem like ZFS), you can disable compression in Xen Orchestra.
 
@@ -141,3 +143,12 @@ To make the mount point persistent in XOA, edit the `/etc/fstab` file, and add:
 ```
 
 This way, without modifying your previous scheduled snapshot, they will be written to this new local mountpoint!
+
+## High availability (HA) disabled on replicated VMs
+
+Replicated VMs HA are taken into account by XS/XCP-ng. To avoid the resultant troubles, HA will be disabled from the replicated VMs and a tag indicating this change will be added.
+
+![](./assets/disabled-dr-ha-tag.png)
+![](./assets/disabled-cr-ha-tag.png)
+
+> The tag won't be automatically removed by XO on the replicated VMs, even if HA is re-enabled.

docs/backups_and_disaster_recovery.md

@@ -22,16 +22,15 @@ All your scheduled backup are acccessible in the "Restore" view in backup sectio
 
 ![](https://xen-orchestra.com/blog/content/images/2015/11/restore.png)
 
-
 ### Backup compression
 
 By default, Backup are compressed (using GZIP, done in XenServer side). There is no absolute rule about using compression or not, but there is some rules.
 
 Gzip compression is:
 
-* slow
-* space efficient
-* consume less bandwidth (if your NFS share is far)
+- slow
+- space efficient
+- consume less bandwidth (if your NFS share is far)
 
 If you have compression on your NFS share (or destination file-system like ZFS), you can disable compression in Xen Orchestra.
 
@@ -45,4 +44,4 @@ This feature is close to Backups, but it creates a snapshot when planned to do s
 
 **Warning**: snapshots are not backups. They help to rollback to a previous state, but all snapshots are on the same Storage than their original disk. If you lose the original VDI (or the SR), you'll **lose all your snapshots**.
 
-[Read more about it](https://xen-orchestra.com/blog/xen-orchestra-4-2/#schedulerollingsnapshots).
+[Read more about it](https://xen-orchestra.com/blog/xen-orchestra-4-2/#schedulerollingsnapshots).