mirror of
https://github.com/vatesfr/xen-orchestra.git
synced 2026-11-09 17:06:13 -06:00
3bf50c38ee
This branch is a reliability overhaul of the ESXi/vSphere source side of V2V, plus a scope reduction of the package. The SOAP plumbing is rewritten:
VimClient wraps @vates/node-vsphere-soap in a promise API with one emitter per call (no more cross-talk between concurrent calls, no listener leak) and a pTimeout;
vim25 faults are now parsed (_parseFault.mjs) so callers get a real fault type instead of task execution failed;
the library no longer throws from async callbacks (which killed xo-server) and its beforeExit logout hook is per-client instead of removeAllListeners.
Request specs are built in explicit schema order (soap/specs.mjs) with xsi:type, and property values are normalized (soap/normalize.mjs) so search() and the new #retrieveProperty share one shape.
search() now paginates, cancels the retrieval and destroys the container view.
Datastore HTTP downloads get session-cookie reuse, retry with jittered backoff, a headers-only timeout, and range-honouring validation.
Task waiting polls with backoff and per-operation timeouts (6 h for snapshot consolidation).
nbdkit servers are memoized by a key that includes the export options, the readiness wait races the process death instead of sleeping 2 s
the password file is 0600 and unlinked
the thumbprint is read over TLS in-process instead of two openssl spawns.
The old VHD-over-datastore readers (VhdEsxi*, Datastore*, openDeltaVmdkAsVhd) are deleted, hence the majo, rleaving the vddk/NBD path with a COWD grain-directory parser as data-map fallback.
~1.7k lines of unit tests are added.
82 lines
2.9 KiB
JavaScript
82 lines
2.9 KiB
JavaScript
/**
|
|
* Builders for the vim25 arguments we hand to the SOAP library.
|
|
*
|
|
* The schema declares every complex type as an `xs:sequence`, so the server rejects a spec whose
|
|
* children are out of order — and the library derives that order from JS key insertion order,
|
|
* which is exactly the kind of thing that breaks silently when an object is refactored or when a
|
|
* field is renamed. Declaring the order explicitly here makes it reviewable and testable.
|
|
*
|
|
* Each list is the full schema order; only the elements which are actually set get emitted.
|
|
*/
|
|
|
|
export const PROPERTY_SPEC = Object.freeze(['type', 'all', 'pathSet'])
|
|
|
|
export const TRAVERSAL_SPEC = Object.freeze(['name', 'type', 'path', 'skip', 'selectSet'])
|
|
|
|
export const OBJECT_SPEC = Object.freeze(['obj', 'skip', 'selectSet'])
|
|
|
|
export const PROPERTY_FILTER_SPEC = Object.freeze(['propSet', 'objectSet', 'reportMissingObjectsInResults'])
|
|
|
|
export const RETRIEVE_OPTIONS = Object.freeze(['maxObjects'])
|
|
|
|
/**
|
|
* A managed object reference.
|
|
*
|
|
* @param {string} type - type of the object, e.g. `VirtualMachine`
|
|
* @param {string} value - the reference itself, e.g. `vm-42`
|
|
* @returns {object}
|
|
*/
|
|
export function moRef(type, value) {
|
|
return { attributes: { type }, $value: value }
|
|
}
|
|
|
|
/**
|
|
* Builds an element, its children in schema order, skipping the values which are not set.
|
|
*
|
|
* @param {ReadonlyArray<string>} order - schema element order
|
|
* @param {string | undefined} xsiType - type to declare, mandatory wherever the schema declares an
|
|
* abstract type, e.g. the `selectSet` of an ObjectSpec
|
|
* @param {object} values
|
|
* @returns {object}
|
|
*/
|
|
export function orderedChildren(order, xsiType, values) {
|
|
const unknown = Object.keys(values).filter(name => values[name] !== undefined && !order.includes(name))
|
|
if (unknown.length > 0) {
|
|
// a typo in a field name would otherwise be silently dropped from the request
|
|
const error = new Error(`unknown element(s) for this type: ${unknown.join(', ')}`)
|
|
// this spec is built here, not by the host: such a failure is a bug of this package
|
|
error.code = 'BAD_VIM25_SPEC'
|
|
throw error
|
|
}
|
|
|
|
// the attributes are not an element, but the library expects them first
|
|
const node = xsiType === undefined ? {} : { attributes: { 'xsi:type': xsiType } }
|
|
for (const name of order) {
|
|
const value = values[name]
|
|
if (value !== undefined && value !== null) {
|
|
node[name] = value
|
|
}
|
|
}
|
|
return node
|
|
}
|
|
|
|
export function propertySpec(values) {
|
|
return orderedChildren(PROPERTY_SPEC, 'PropertySpec', values)
|
|
}
|
|
|
|
export function traversalSpec(values) {
|
|
return orderedChildren(TRAVERSAL_SPEC, 'TraversalSpec', values)
|
|
}
|
|
|
|
export function objectSpec(values) {
|
|
return orderedChildren(OBJECT_SPEC, 'ObjectSpec', values)
|
|
}
|
|
|
|
export function propertyFilterSpec(values) {
|
|
return orderedChildren(PROPERTY_FILTER_SPEC, 'PropertyFilterSpec', values)
|
|
}
|
|
|
|
export function retrieveOptions(values) {
|
|
return orderedChildren(RETRIEVE_OPTIONS, 'RetrieveOptions', values)
|
|
}
|