Fix spelling for some of these items

* ; otherwise,
* a
* abandoned
* accessor
* across
* additional
* address
* algorithm
* and
* apply
* assign
* availability
* beginning
* broken
* case-insensitive
* chains
* chosen
* click
* compactness
* compatibility
* completely
* configuration
* connection
* corresponding
* criteria
* dependent
* dictionary
* differentiate
* discrepancy
* duplication
* each other
* efficiently
* empty
* encrypter
* enough
* environment
* equal
* exactly
* existing
* expansion
* explicitly
* fall back
* falsish
* file
* function
* github
* id
* immutability
* implicitly
* in
* increase
* initial
* instantiated
* its
* length
* listener
* little
* localhost
* locator
* logged
* longer
* mechanisms
* metadata is also immutable
* metadata
* method
* modify
* negotiation
* nonexistent
* occurred
* ofthe
* one
* opening
* optional
* output
* overlapping
* parameters
* params
* positioning
* prepositioning
* really
* reasonable
* reinstantiated
* repair
* respect
* result
* retransferred
* save
* scanning
* self-signed
* separately
* set up
* set
* similar
* slash
* snapshot
* something
* succeed
* succeeded
* successful
* survived
* swapping
* there
* transferred
* triggering
* ubuntu
* unreasonably
* unsupported
* unwanted
* usage
* want
* will
* without
* workaround
* written

Signed-off-by: Josh Soref <[email protected]>

Author: jsoref

@vates/diff/index.js

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

@vates/nbd-client/constants.mjs

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

@vates/nbd-client/index.mjs

@@ -43,9 +43,9 @@ export default class NbdClient {
   // AFAIK, there is no guaranty the server answers in the same order as the queries
   // so we handle a backlog of command waiting for response and handle concurrency manually
 
-  #waitingForResponse // there is already a listenner waiting for a response
+  #waitingForResponse // there is already a listener waiting for a response
   #nextCommandQueryId = BigInt(0)
-  #commandQueryBacklog // map of command waiting for an response queryId => { size/*in byte*/, resolve, reject}
+  #commandQueryBacklog // map of command waiting for a response queryId => { size/*in byte*/, resolve, reject}
   #connected = false
 
   #reconnectingPromise
@@ -196,7 +196,7 @@ export default class NbdClient {
     }
 
     // send export name we want to access.
-    // it's  implictly closing the negociation phase.
+    // it's implicitly closing the negotiation phase.
     await this.#write(OPTS_MAGIC)
     await this.#writeInt32(NBD_OPT_EXPORT_NAME)
     const exportNameBuffer = Buffer.from(this.#exportName)

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

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

@vates/xml/cli.js

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

@xen-orchestra/backups/ImportVmBackup.mjs

@@ -168,13 +168,13 @@ export class ImportVmBackup {
           vdis[vdiRef].baseVdi = snapshotCandidate
         } catch (error) {
           // can be a broken VHD chain, a vhd chain with a key backup, ....
-          // not an irrecuperable error, don't dispose parentVhd, and fallback to full restore
+          // not an irrecuperable error, don't dispose parentVhd, and fall back to full restore
           warn(`can't use differential restore`, { error })
           descendant?.close()
           negativeDisk?.close()
         }
       }
-      // didn't make a negative stream : fallback to classic stream
+      // didn't make a negative stream : fall back to classic stream
       if (disk === undefined) {
         debug('use legacy restore')
         disk = parent

@xen-orchestra/backups/RemoteAdapter.mjs

@@ -204,7 +204,7 @@ export class RemoteAdapter {
     })
   }
 
-  // check if we will be allowed to merge a a vhd created in this adapter
+  // check if we will be allowed to merge a vhd created in this adapter
   // with the vhd at path `path`
   async isMergeableParent(packedParentUid, path) {
     return await Disposable.use(VhdSynthetic.fromVhdChain(this.handler, path), vhd => {
@@ -774,7 +774,7 @@ export class RemoteAdapter {
     let json
     let isImmutable = false
     let remoteIsImmutable = false
-    // if the remote is immutable, check if this metadatas are also immutables
+    // if the remote is immutable, check if this metadata is also immutable
     try {
       // this file is not encrypted
       await this._handler._readFile(IMMUTABILTY_METADATA_FILENAME)
@@ -790,7 +790,7 @@ export class RemoteAdapter {
       json = await this.handler.readFile(path, { flag: 'r+' })
       // s3 handler don't respect flags
     } catch (err) {
-      // retry without triggerring immutbaility check ,only on immutable remote
+      // retry without triggering immutability check ,only on immutable remote
       if (err.code === 'EPERM' && remoteIsImmutable) {
         isImmutable = true
         json = await this._handler.readFile(path, { flag: 'r' })

@xen-orchestra/backups/RestoreMetadataBackup.mjs

@@ -24,7 +24,7 @@ export class RestoreMetadataBackup {
       const dataFileName = resolve('/', backupId, metadata.data ?? 'data.json').slice(1)
       const data = await handler.readFile(dataFileName)
 
-      // if data is JSON, sent it as a plain string, otherwise, consider the data as binary and encode it
+      // if data is JSON, sent it as a plain string; otherwise, consider the data as binary and encode it
       const isJson = dataFileName.endsWith('.json')
       return isJson ? data.toString() : { encoding: 'base64', data: data.toString('base64') }
     }

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

@@ -132,7 +132,7 @@ test('it remove vhd with missing or multiple ancestors', async () => {
   const deletedOrphanVhd = loggued.match(/deleting orphan VHD/g) || []
   assert.equal(deletedOrphanVhd.length, 1) // only one vhd should have been deleted
 
-  // we don't test the filew on disk, since they will all be marker as unused and deleted without a metadata.json file
+  // we don't test the file on disk, since they will all be marker as unused and deleted without a metadata.json file
 })
 
 test('it remove backup meta data referencing a missing vhd in delta backup', async () => {
@@ -287,7 +287,7 @@ test('it finish unterminated merge ', async () => {
 })
 
 // each of the vhd can be a file, a directory, an alias to a file or an alias to a directory
-// the message an resulting files should be identical to the output with vhd files which is tested independantly
+// the message and resulting files should be identical to the output with vhd files which is tested independently
 describe('tests multiple combination ', { concurrency: 1 }, () => {
   for (const useAlias of [true, false]) {
     for (const vhdMode of ['file', 'directory']) {
@@ -308,9 +308,9 @@ describe('tests multiple combination ', { concurrency: 1 }, () => {
           await VhdAbstract.createAlias(handler, 'broken.alias.vhd', brokenVhdDataPath)
         }
 
-        // a vhd non referenced in metada
+        // a vhd non referenced in metadata
         await generateVhd(`${basePath}/nonreference.vhd`, { useAlias, mode: vhdMode })
-        // an abandonded delta vhd without its parent
+        // an abandoned delta vhd without its parent
         await generateVhd(`${basePath}/abandonned.vhd`, {
           useAlias,
           mode: vhdMode,
@@ -404,7 +404,7 @@ describe('tests multiple combination ', { concurrency: 1 }, () => {
         // size should be the size of children + grand children + clean after the merge
         assert.deepEqual(metadata.size, vhdMode === 'file' ? 6502400 : 6501888)
 
-        // broken vhd, non referenced, abandonned should be deleted ( alias and data)
+        // broken vhd, non referenced, abandoned should be deleted ( alias and data)
         // ancestor and child should be merged
         // grand child and clean vhd should not have changed
         const survivors = await handler.list(basePath)
@@ -454,7 +454,7 @@ test('check Aliases should work alone', async () => {
     logWarn: () => {},
   })
 
-  // only ok have suvived
+  // only ok have survived
   const alias = (await handler.list('vhds')).filter(f => f.endsWith('.vhd'))
   assert.equal(alias.length, 1)
 

@xen-orchestra/backups/_cleanVm.mjs

@@ -512,7 +512,7 @@ export async function cleanVm(
         remove,
         mergeBlockConcurrency,
       })
-      const metadataPath = vhdsToJSons[chain[chain.length - 1]] // all the chain should have the same metada file
+      const metadataPath = vhdsToJSons[chain[chain.length - 1]] // all the chain should have the same metadata file
       metadataWithMergedVhd[metadataPath] = (metadataWithMergedVhd[metadataPath] ?? 0) + finalVhdSize
     })
   }

@xen-orchestra/backups/_getOldEntries.mjs

@@ -26,7 +26,7 @@ const LTR_DEFINITIONS = {
 
         copy.date(date.date() - firstDayOfWeek)
         // warning, the year in term of week may different from YYYY
-        // since the computation of the first week of a year is timezone dependant
+        // since the computation of the first week of a year is timezone dependent
         return copy.format('gggg-ww')
       }
     },
@@ -59,7 +59,7 @@ const LTR_DEFINITIONS = {
  * return the entries too old to be kept
  *  if multiple entries are i the same time bucket : keep only the most recent one
  *  if an entry is valid in any of the bucket OR the  minRetentionCount : keep it
- *  if a bucket is completly empty : it does not count as one, thus it may extend the retention
+ *  if a bucket is completely empty : it does not count as one, thus it may extend the retention
  * @returns Array<Backup>
  */
 export function getOldEntries(minRetentionCount, entries, { longTermRetention = {}, timezone } = {}) {

@xen-orchestra/backups/_incrementalVm.mjs

@@ -231,7 +231,7 @@ export const importIncrementalVm = defer(async function importIncrementalVm(
     cancelableMap(cancelToken, Object.entries(newVdis), async (cancelToken, [id, vdi]) => {
       for (const disk of ensureArray(disks[id])) {
         if (disk === null) {
-          // we restore a backup and reuse completly a local snapshot
+          // we restore a backup and reuse completely a local snapshot
           continue
         }
         await xapi.setField('VDI', vdi.$ref, 'name_label', `[Importing] ${vdiRecords[id].name_label}`)

@xen-orchestra/backups/_isValidXva.mjs

@@ -44,7 +44,7 @@ const isValidTar = async (handler, size, fd) => {
   return buf.every(_ => _ === 0)
 }
 
-// TODO: find an heuristic for compressed files
+// TODO: find a heuristic for compressed files
 export async function isValidXva(path) {
   const handler = this._handler
 

@xen-orchestra/backups/_otherConfig.mjs

@@ -43,7 +43,7 @@ async function getDeltaChainLength(xapi, type, ref) {
 }
 
 /**
- * set the delta chain lenght ( number of delta since last base backup) to a VM and its associated VDIs
+ * set the delta chain length ( number of delta since last base backup) to a VM and its associated VDIs
  *
  * @param {Xapi} xapi
  * @param {String} vmRef
@@ -58,7 +58,7 @@ export async function setVmDeltaChainLength(xapi, vmRef, length) {
 
 /**
  * Compute the delta chain length of a VM and its associated VDIs
- * if there is a discrependcy, use, the highest value
+ * if there is a discrepancy, use, the highest value
  * @param {Xapi} xapi
  * @param {String} vmRef
  * @returns {Promise}
@@ -92,7 +92,7 @@ export function resetVmOtherConfig(xapi, vmRef) {
 
 /**
  *
- * used to ensure compatibiliy with the previous snapshots that were having the config stored only into VM
+ * used to ensure compatibility with the previous snapshots that were having the config stored only into VM
  *
  * @param {Xapi} xapi
  * @param {String} vmRef
@@ -152,7 +152,7 @@ export async function setVmOtherConfig(xapi, vmRef, { timestamp, jobId, schedule
 }
 /**
  *
- * mark the export of he VM and its VDIs as successfull
+ * mark the export of he VM and its VDIs as successful
  *
  * @param {Xapi} xapi
  * @param {String} vmRef

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

@@ -24,7 +24,7 @@ export const FullRemote = class FullRemoteVmBackupRunner extends AbstractRemote
         writer =>
           writer.run({
             stream: forkStreamUnpipe(stream),
-            // stream will be forked and transformed, it's not safe to attach additionnal properties to it
+            // stream will be forked and transformed, it's not safe to attach additional properties to it
             streamLength: stream.length,
             maxStreamLength: stream.maxStreamLength, // on encrypted source
             timestamp: metadata.timestamp,

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

@@ -45,8 +45,8 @@ export const FullXapi = class FullXapiVmBackupRunner extends AbstractXapi {
     for (const vdiRef of vdis) {
       const vdi = await this._xapi.getRecord('VDI', vdiRef)
 
-      // the size a of fully allocated vdi will be virtual_size  exaclty, it's a gross over evaluation
-      // of the real stream size in general, since a disk is never completly full
+      // the size a of fully allocated vdi will be virtual_size exactly, it's a gross over evaluation
+      // of the real stream size in general, since a disk is never completely full
       // vdi.physical_size seems to underevaluate a lot the real disk usage of a VDI, as of 2023-10-30
       maxStreamLength += vdi.virtual_size
     }

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

@@ -16,7 +16,7 @@ class IncrementalRemoteVmBackupRunner extends AbstractRemote {
     return IncrementalRemoteWriter
   }
 
-  // we'll transfer the full list if at least one backup should be transfered
+  // we'll transfer the full list if at least one backup should be transferred
   // to ensure we don't cut the delta chain
   _filterTransferList(transferList) {
     if (transferList.some(vmBackupMetadata => this._filterPredicate(vmBackupMetadata))) {

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

@@ -90,7 +90,7 @@ export const AbstractRemote = class AbstractRemoteVmBackupRunner extends Abstrac
     for (const timestamp of timestamps) {
       if (remoteMetadatas[timestamp] !== nbRemotes) {
         // this backup is not present in all the remote
-        // should be retransfered if not found later
+        // should be retransferred if not found later
         transferList.push(localMetada.get(timestamp))
       } else {
         // backup is present in local and remote : the chain has already been transferred

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

@@ -195,7 +195,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
       }
     })
     await Promise.all(vmSnapshots.map(snapshot => populateVdisOtherConfig(xapi, snapshot.$ref)))
-    // end of compatibiliy handling
+    // end of compatibility handling
 
     // handle snapshot by VDI
     this._jobSnapshotVdis = []
@@ -298,7 +298,7 @@ export const AbstractXapi = class AbstractXapiVmBackupRunner extends Abstract {
       // preferNbd is not a guarantee that the backup used NBD, depending on the network configuration,
       // in that case next runs will be full, but there is not an easy way to prevent that
       this._settings.preferNbd &&
-      // only delete snapshost data if the config allows it
+      // only delete snapshot data if the config allows it
       this._settings.cbtDestroySnapshotData
     ) {
       Task.info('will delete snapshot data')

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

@@ -230,7 +230,7 @@ export class IncrementalRemoteWriter extends MixinRemoteWriter(AbstractIncrement
           const path = `${this._vmBackupDir}/${vhds[diskRef]}`
           await adapter.writeVhd(path, disk, {
             // no checksum for VHDs, because they will be invalidated by
-            // merges and chainings
+            // merges and chains
             checksum: false,
             validator: tmpPath => checkVhd(handler, tmpPath),
             writeBlockConcurrency: this._config.writeBlockConcurrency,

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

@@ -21,7 +21,7 @@ export class IncrementalXapiWriter extends MixinXapiWriter(AbstractIncrementalWr
     }
 
     // @todo use an index if possible
-    // @todo : this seems similare to decorateVmMetadata
+    // @todo : this seems similar to decorateVmMetadata
     const replicatedVdis = sr.$VDIs
       .filter(vdi => {
         // REPLICATED_TO_SR_UUID is not used here since we are already filtering from sr.$VDIs

@xen-orchestra/disk-transform/src/FileAccessor.mts

@@ -6,8 +6,8 @@ export type FileDescriptor = number
  * a base interface is defined to be able to add other accessor ,
  * for example in browser or from a vmware datastore
  *
- * NOTE : file acessor on datastore should try to use a stream
- * and read/skip from this when possible, since openingn a new stream is costly
+ * NOTE : file accessor on datastore should try to use a stream
+ * and read/skip from this when possible, since opening a new stream is costly
  * and we are generally reading the vhd sequentially
  */
 export interface FileAccessor {

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

@@ -210,16 +210,16 @@ export default class RemoteHandlerAbstract {
       validator,
     })
     if (checksum) {
-      // using _outpuFile means the checksum will NOT be encrypted
+      // using _outputFile means the checksum will NOT be encrypted
       // it is by design to allow checking of encrypted files without the key
       await this._outputFile(checksumFile(path), await checksumStream.checksum, { dirMode, flags: 'wx' })
     }
   }
 
   // Free the resources possibly dedicated to put the remote at work, when it
-  // is no more needed
+  // is no longer needed
   //
-  // FIXME: Some handlers are implemented based on system-wide mecanisms (such
+  // FIXME: Some handlers are implemented based on system-wide mechanisms (such
   // as mount), forgetting them might breaking other processes using the same
   // remote.
   @synchronized()
@@ -331,7 +331,7 @@ export default class RemoteHandlerAbstract {
     await this._rmtree(normalizePath(dir))
   }
 
-  // Asks the handler to sync the state of the effective remote with its'
+  // Asks the handler to sync the state of the effective remote with its
   // metadata
   //
   // This method MUST ALWAYS be called before using the handler.
@@ -386,15 +386,15 @@ export default class RemoteHandlerAbstract {
       const data = await this.__readFile(ENCRYPTION_METADATA_FILENAME)
       JSON.parse(data)
     } catch (error) {
-      // can be enoent, bad algorithm, or broeken json ( bad key or algorithm)
+      // can be enoent, bad algorithm, or broken json ( bad key or algorithm)
       if (encryptionAlgorithm !== 'none') {
         if (await this.#canWriteMetadata()) {
           // any other error , but on empty remote => update with remote settings
 
           info('will update metadata of this remote')
           return this.#createMetadata()
         } else {
-          // to add a new encrypted fs remote, the remote directory must be empty, otherwise metadata.json is not created
+          // to add a new encrypted fs remote, the remote directory must be empty; otherwise, metadata.json is not created
           if (error.code === 'ENOENT' && error.path.includes('metadata.json')) {
             throw new Error('Remote directory must be empty.')
           }
@@ -644,7 +644,7 @@ export default class RemoteHandlerAbstract {
           if (error.code === 'EISDIR' || error.code === 'EPERM') {
             return this._rmtree(`${dir}/${file}`).catch(rmTreeError => {
               if (rmTreeError.code === 'ENOTDIR') {
-                // this was realy a EPERM error, maybe with immutable backups
+                // this was really a EPERM error, maybe with immutable backups
                 throw error
               }
               throw rmTreeError

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

@@ -16,7 +16,7 @@ class TestHandler extends AbstractHandler {
   constructor(impl) {
     super({ url: 'test://' }, { timeout: TIMEOUT })
     Object.defineProperty(this, 'isEncrypted', {
-      get: () => false, // encryption is tested separatly
+      get: () => false, // encryption is tested separately
     })
     Object.keys(impl).forEach(method => {
       this[`_${method}`] = impl[method]

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

@@ -48,9 +48,9 @@ export const createChecksumStream = (algorithm = 'md5') => {
   return stream
 }
 
-// Check if the checksum of a readable stream is equals to an expected checksum.
+// Check if the checksum of a readable stream is equal to an expected checksum.
 // The given stream is wrapped in a stream which emits an error event
-// if the computed checksum is not equals to the expected checksum.
+// if the computed checksum is not equal to the expected checksum.
 export const validChecksumOfReadStream = (stream, expectedChecksum) => {
   const algorithmId = expectedChecksum.slice(1, expectedChecksum.indexOf('$', 1))