Feat(fs): add more error log during remote test

@xen-orchestra/fs/package.json

@@ -41,6 +41,7 @@
     "promise-toolbox": "^0.21.0",
     "proper-lockfile": "^4.1.2",
     "readable-stream": "^3.0.6",
+    "serialize-error": "^8.0.0",
     "through2": "^4.0.2",
     "xo-remote-parser": "^0.8.0"
   },

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

@@ -1,16 +1,20 @@
 import asyncMapSettled from '@xen-orchestra/async-map/legacy'
 import getStream from 'get-stream'
 import { coalesceCalls } from '@vates/coalesce-calls'
+import { createLogger } from '@xen-orchestra/log'
 import { fromCallback, fromEvent, ignoreErrors, timeout } from 'promise-toolbox'
 import { limitConcurrency } from 'limit-concurrency-decorator'
 import { parse } from 'xo-remote-parser'
 import { pipeline } from 'stream'
 import { randomBytes } from 'crypto'
+import { serializeError } from 'serialize-error'
 import { synchronized } from 'decorator-synchronized'
 
 import { basename, dirname, normalize as normalizePath } from './_path'
 import { createChecksumStream, validChecksumOfReadStream } from './checksum'
 
+const { warn } = createLogger('@xen-orchestra:fs')
+
 const checksumFile = file => file + '.checksum'
 const computeRate = (hrtime, size) => {
   const seconds = hrtime[0] + hrtime[1] / 1e9
@@ -357,11 +361,13 @@ export default class RemoteHandlerAbstract {
         readRate: computeRate(readDuration, SIZE),
       }
     } catch (error) {
+      warn(`error while testing the remote at step ${step}`, { error })
       return {
         success: false,
         step,
         file: testFileName,
-        error: error.message || String(error),
+        // ensure even non serializeable errors are displayed
+        error: error.message || JSON.stringify(serializeError(error)),
       }
     } finally {
       ignoreErrors.call(this._unlink(testFileName))

CHANGELOG.unreleased.md

@@ -13,6 +13,8 @@
 
 > Users must be able to say: “I had this issue, happy to know it's fixed”
 
+- [Remote] show more details when remote testing fails (PR [#6216](https://github.com/vatesfr/xen-orchestra/pull/6216))
+
 ### Packages to release
 
 > Packages will be released in the order they are here, therefore, they should
@@ -35,6 +37,8 @@
 
 <!--packages-start-->
 
+- @xen-orchestra/fs
+- @xen-orchestra/mixins patch
 - vhd-lib patch
 - vhd-cli patch
 - @xen-orchestra/backups patch

yarn.lock

@@ -16377,6 +16377,13 @@ send@0.18.0:
     range-parser "~1.2.1"
     statuses "2.0.1"
 
+serialize-error@^8.0.0:
+  version "8.1.0"
+  resolved "https://registry.yarnpkg.com/serialize-error/-/serialize-error-8.1.0.tgz#3a069970c712f78634942ddd50fbbc0eaebe2f67"
+  integrity sha512-3NnuWfM6vBYoy5gZFvHiYsVbafvI9vZv/+jlIigFn4oP4zjNPK3LhcY0xSCgeb1a5L8jO71Mit9LlNoi2UfDDQ==
+  dependencies:
+    type-fest "^0.20.2"
+
 serialize-javascript@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-3.1.0.tgz#8bf3a9170712664ef2561b44b691eafe399214ea"