node-opcua-address-space 2.180.0 → 2.181.1

package/src/ua_variable_impl_ext_obj.ts

@@ -1,903 +0,0 @@
-import type { BindExtensionObjectOptions, UADataType, UAVariable, UAVariableType } from "node-opcua-address-space-base";
-import assert from "node-opcua-assert";
-import { coerceQualifiedName, NodeClass } from "node-opcua-data-model";
-import type { DataValue } from "node-opcua-data-value";
-import { coerceClock, getCurrentClock, type PreciseClock } from "node-opcua-date-time";
-import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
-import { ExtensionObject } from "node-opcua-extension-object";
-import { NodeId, NodeIdType } from "node-opcua-nodeid";
-import type { NumericRange } from "node-opcua-numeric-range";
-import { StatusCodes } from "node-opcua-status-code";
-import type { StructureField } from "node-opcua-types";
-import { lowerFirstLetter } from "node-opcua-utils";
-import { DataType, VariantArrayType, type VariantLike } from "node-opcua-variant";
-import { IndexIterator } from "./idx_iterator";
-import type { UADataTypeImpl } from "./ua_data_type_impl";
-import { UAVariableImpl } from "./ua_variable_impl";
-
-const doDebug = checkDebugFlag(__filename);
-const debugLog = make_debugLog(__filename);
-const warningLog = make_warningLog(__filename);
-const errorLog = make_errorLog(__filename);
-
-function _w(str: string, n: number): string {
-    return str.padEnd(n).substring(n);
-}
-
-function isProxy(ext: unknown): boolean {
-    return !!(ext as Record<string, unknown> | null)?.$isProxy;
-}
-function getProxyVariable(ext: Record<string, unknown>): UAVariable | null {
-    assert(isProxy(ext));
-    return ext.$variable as UAVariable | null;
-}
-
-function getProxyVariableForProp(ext: Record<string, unknown>, prop: string) {
-    const uaVariable = getProxyVariable(ext);
-    if (!uaVariable) return undefined;
-    return (uaVariable as unknown as Record<string, unknown>)[prop] as UAVariableImpl | undefined;
-}
-
-export function getProxyTarget(ext: Record<string, unknown>): unknown {
-    assert(isProxy(ext));
-    const target = ext.$proxyTarget;
-    if (target && isProxy(target as Record<string, unknown>)) {
-        return getProxyTarget(target as Record<string, unknown>);
-    }
-    return target;
-}
-
-function unProxy(ext: ExtensionObject): ExtensionObject {
-    const extAsRecord = ext as unknown as Record<string, unknown>;
-    return isProxy(extAsRecord) ? (getProxyTarget(extAsRecord) as ExtensionObject) : ext;
-}
-
-function getExtensionObjectArray(uaVariable: UAVariableImpl): ExtensionObject[] {
-    const arr = uaVariable.$$extensionObjectArray;
-    if (!arr) {
-        throw new Error(
-            `Internal Error: $$extensionObjectArray is not bound on UAVariable ${uaVariable.nodeId.toString()} (${uaVariable.browseName.toString()})`
-        );
-    }
-    return arr;
-}
-
-function _extensionObjectFieldGetter(getVariable: () => UAVariable | null, target: ExtensionObject, key: string /*, receiver*/) {
-    if (key === "$isProxy") {
-        return true;
-    }
-    if (key === "$proxyTarget") {
-        return target;
-    }
-    if (key === "$variable") {
-        return getVariable();
-    }
-
-    const targetAsRecord = target as unknown as Record<string, unknown>;
-    if (targetAsRecord[key] === undefined) {
-        return undefined;
-    }
-    return targetAsRecord[key];
-}
-function _extensionObjectFieldSetter(
-    getVariable: () => UAVariable | null,
-    target: ExtensionObject,
-    key: string,
-    value: unknown /*, receiver*/
-): boolean {
-    const targetAsRecord = target as unknown as Record<string, unknown>;
-    targetAsRecord[key] = value;
-    if (isProxy(targetAsRecord)) {
-        return true;
-    }
-    const uaVariable = getVariable();
-    if (!uaVariable) return true;
-    const child = (uaVariable as unknown as Record<string, UAVariable | null>)[key];
-    if (child?.touchValue) {
-        child.touchValue();
-    }
-    return true; // true means the set operation has succeeded
-}
-
-function makeHandler(getVariable: () => UAVariable | null) {
-    const handler = {
-        get: _extensionObjectFieldGetter.bind(null, getVariable),
-        set: _extensionObjectFieldSetter.bind(null, getVariable)
-    };
-    return handler;
-}
-
-/**
- * inconditionnaly change the time stamp of the variable
- * if the variable is being listened to, and if the minimumSamplingInterval is exactly zero,
- * then the change will be reported to the observer
- *
- */
-export function _touchValue(property: UAVariableImpl, now: PreciseClock): void {
-    property.$dataValue.sourceTimestamp = now.timestamp;
-    property.$dataValue.sourcePicoseconds = now.picoseconds;
-    property.$dataValue.serverTimestamp = now.timestamp;
-    property.$dataValue.serverPicoseconds = now.picoseconds;
-    // don't change statusCode ! property.$dataValue.statusCode = StatusCodes.Good;
-    if (property.listenerCount("value_changed") > 0) {
-        property.emit("value_changed", property.$dataValue.clone());
-    }
-}
-
-export function propagateTouchValueUpward(self: UAVariableImpl, now: PreciseClock, cache?: Set<UAVariable>): void {
-    _touchValue(self, now);
-    if (self.parent && self.parent.nodeClass === NodeClass.Variable) {
-        const parentVar = self.parent as UAVariableImpl;
-        if (!parentVar.isExtensionObject()) return;
-
-        if (cache) {
-            if (cache.has(parentVar)) return;
-            cache.add(parentVar);
-        }
-        propagateTouchValueUpward(parentVar, now, cache);
-    }
-}
-
-export function propagateTouchValueDownward(self: UAVariableImpl, now: PreciseClock, cache?: Set<UAVariable>): void {
-    if (!self.isExtensionObject()) return;
-    // also propagate changes to embeded variables
-    const dataTypeNode = self.getDataTypeNode();
-    const definition = dataTypeNode.getStructureDefinition();
-    for (const field of definition.fields || []) {
-        const property = self.getChildByName(field.name || "") as UAVariableImpl;
-
-        if (property) {
-            if (cache) {
-                if (cache.has(property)) {
-                    continue;
-                }
-                cache.add(property);
-            }
-
-            _touchValue(property, now);
-            // to do cascade recursivelly ?
-        }
-    }
-}
-
-export function setExtensionObjectPartialValue(
-    node: UAVariableImpl,
-    partialObject: Record<string, unknown> | undefined,
-    sourceTimestamp?: PreciseClock
-) {
-    const variablesToUpdate: Set<UAVariableImpl> = new Set();
-
-    const extensionObject = node.$extensionObject;
-    if (!extensionObject) {
-        throw new Error(`setExtensionObjectValue node has no extension object ${node.browseName.toString()}`);
-    }
-    /**
-     * Returns true if the value is a structure-like object that should
-     * be recursed into during a partial update.
-     *
-     * For the existing extension object (extObject[prop]):
-     *  - Proxied sub-extension objects → recurse (they have $isProxy)
-     * For the incoming partial object (partialObject1[prop]):
-     *  - Plain objects {} → recurse (from constructExtensionObject or literals)
-     *
-     * Everything else (Date, Buffer, NodeId, QualifiedName, LocalizedText,
-     * DiagnosticInfo, arrays, etc.) is a terminal value and should be
-     * assigned directly — even if it has a `schema` property.
-     */
-    function _shouldRecurseIntoExisting(value: unknown): boolean {
-        if (value === null || value === undefined) return false;
-        if (typeof value !== "object") return false;
-        if (Array.isArray(value)) return false;
-        // proxied sub-structures: installed by bindExtensionObject for nested structs
-        if (isProxy(value as Record<string, unknown>)) return true;
-        // plain objects (unlikely on the existing side but safe fallback)
-        const proto = Object.getPrototypeOf(value);
-        if (proto === Object.prototype || proto === null) return true;
-        return false;
-    }
-
-    function _shouldRecurseIntoNew(value: unknown): boolean {
-        if (value === null || value === undefined) return false;
-        if (typeof value !== "object") return false;
-        if (Array.isArray(value)) return false;
-        // plain objects: partial update literals like { field1: v1 }
-        const proto = Object.getPrototypeOf(value);
-        if (proto === Object.prototype || proto === null) return true;
-        // extension objects from constructExtensionObject have a schema
-        // but so do QualifiedName/LocalizedText — we disambiguate by
-        // checking the *existing* side with isProxy, not here.
-        // Instead, only recurse if it's a schema'd type AND has
-        // Extension-Object-like characteristics (constructor with schema.name)
-        const valueRecord = value as Record<string, unknown>;
-        if (
-            valueRecord.schema !== undefined &&
-            (valueRecord.constructor as { name?: string })?.name !== "QualifiedName" &&
-            (valueRecord.constructor as { name?: string })?.name !== "LocalizedText" &&
-            (valueRecord.constructor as { name?: string })?.name !== "DiagnosticInfo"
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-    function _update_extension_object(extObject: Record<string, unknown>, partialObject1: Record<string, unknown>) {
-        const keys = Object.keys(partialObject1);
-        for (const prop of keys) {
-            if (_shouldRecurseIntoExisting(extObject[prop]) && _shouldRecurseIntoNew(partialObject1[prop])) {
-                _update_extension_object(
-                    extObject[prop] as Record<string, unknown>,
-                    partialObject1[prop] as Record<string, unknown>
-                );
-            } else {
-                if (isProxy(extObject)) {
-                    // collect element we have to update
-                    const target = getProxyTarget(extObject) as Record<string, unknown>;
-                    assert(!isProxy(target), "something wierd!");
-                    target[prop] = partialObject1[prop];
-                    const variable = getProxyVariableForProp(extObject, prop);
-                    variable && variablesToUpdate.add(variable as UAVariableImpl);
-                } else {
-                    extObject[prop] = partialObject1[prop];
-                }
-            }
-        }
-    }
-    _update_extension_object(extensionObject as unknown as Record<string, unknown>, partialObject as Record<string, unknown>);
-
-    const now = sourceTimestamp || getCurrentClock();
-    const cache: Set<UAVariable> = new Set();
-    for (const c of variablesToUpdate) {
-        if (cache.has(c)) continue;
-        propagateTouchValueUpward(c, now, cache);
-        propagateTouchValueDownward(c, now, cache);
-        cache.add(c);
-    }
-}
-
-function getOrCreateProperty(
-    variableNode: UAVariableImpl,
-    field: StructureField,
-    options: BindExtensionObjectOptions
-): UAVariableImpl | null {
-    const dt = variableNode.getDataTypeNode();
-    // the namespace for the structure browse name elements
-    const structureNamespace = dt.nodeId.namespace;
-
-    const components = variableNode.getComponents();
-    let property: UAVariableImpl;
-    const selectedComponents = components.filter(
-        (f) => f instanceof UAVariableImpl && f.browseName.name?.toString() === field.name
-    );
-
-    // c8 ignore next
-    if (field.dataType.value === DataType.Variant) {
-        // this means that any type of extensions being used here
-        // c8 ignore next
-        doDebug && debugLog("Warning : variant is not supported in ExtensionObject");
-    }
-
-    if (selectedComponents.length === 1) {
-        property = selectedComponents[0] as UAVariableImpl;
-        /* c8 ignore next */
-    } else {
-        if (!options?.createMissingProp) {
-            return null;
-        }
-        // c8 ignore next
-        doDebug &&
-            debugLog(
-                "adding missing array variable",
-                field.name,
-                variableNode.browseName.toString(),
-                variableNode.nodeId.toString()
-            );
-        // todo: Handle array appropriately...
-        assert(selectedComponents.length === 0);
-        // create a variable (Note we may use ns=1;s=parentName/0:PropertyName)
-        property = variableNode.namespace.addVariable({
-            browseName: { namespaceIndex: structureNamespace, name: field.name?.toString() },
-            componentOf: variableNode,
-            dataType: field.dataType,
-            minimumSamplingInterval: variableNode.minimumSamplingInterval,
-            accessLevel: variableNode.accessLevel,
-            accessRestrictions: variableNode.accessRestrictions,
-            rolePermissions: variableNode.rolePermissions
-        }) as UAVariableImpl;
-        assert(property.minimumSamplingInterval === variableNode.minimumSamplingInterval);
-    }
-    return property;
-}
-
-function installExt(uaVariable: UAVariableImpl, ext: ExtensionObject) {
-    ext = unProxy(ext);
-    uaVariable.$extensionObject = new Proxy(
-        ext,
-        makeHandler(() => uaVariable)
-    );
-
-    const addressSpace = uaVariable.addressSpace;
-    const definition = uaVariable.dataTypeObj.getStructureDefinition();
-    const structure = addressSpace.findDataType("Structure");
-    if (!structure) {
-        throw new Error("Cannot find 'Structure' DataType in standard address Space");
-    }
-    for (const field of definition.fields || []) {
-        if (field.dataType) {
-            const dataTypeNode = addressSpace.findDataType(field.dataType);
-            // c8 ignore next
-            if (dataTypeNode?.isSubtypeOf(structure)) {
-                // sub structure .. let make an handler too
-                const camelCaseName = lowerFirstLetter(field.name || "");
-
-                const subExtObj = uaVariable.$extensionObject[camelCaseName];
-                if (subExtObj) {
-                    uaVariable.$extensionObject[camelCaseName] = new Proxy(
-                        subExtObj,
-                        makeHandler(() => {
-                            return uaVariable.getComponentByName(field.name || "") as UAVariable | null;
-                        })
-                    );
-                } else {
-                    doDebug && warningLog("extension object is null");
-                }
-            }
-        }
-    }
-}
-
-export function _installExtensionObjectBindingOnProperties(
-    uaVariable: UAVariableImpl,
-    _options?: BindExtensionObjectOptions
-): void {
-    // may be extension object mechanism has alreday been install
-    // in this case we just need to rebind the properties...
-    if (uaVariable.$extensionObject) {
-        const extObj = uaVariable.$extensionObject;
-        uaVariable.bindExtensionObject(extObj, { createMissingProp: true, force: true });
-        return;
-    }
-    if (uaVariable.$$extensionObjectArray) {
-        const extObj = uaVariable.$$extensionObjectArray;
-        _bindExtensionObjectArrayOrMatrix(uaVariable, extObj, { createMissingProp: true, force: true });
-        return;
-    }
-
-    const dataValue = uaVariable.readValue();
-    const extObj = dataValue.value.value;
-    if (extObj instanceof ExtensionObject) {
-        uaVariable.bindExtensionObject(extObj, { createMissingProp: true, force: true });
-    } else if (Array.isArray(extObj)) {
-        if (dataValue.value.arrayType === VariantArrayType.Array || dataValue.value.arrayType === VariantArrayType.Matrix) {
-            _bindExtensionObjectArrayOrMatrix(uaVariable, extObj, { createMissingProp: true, force: true });
-        } else {
-            /* c8 ignore next */
-            throw new Error("Internal Error, unexpected case");
-        }
-    }
-}
-
-function _installFields2(
-    uaVariable: UAVariableImpl,
-    {
-        get,
-        set
-    }: {
-        get: (fieldName: string) => unknown;
-        set: (fieldName: string, value: unknown, sourceTime: PreciseClock) => void;
-    },
-    options?: BindExtensionObjectOptions
-) {
-    options = options || { createMissingProp: false };
-    const dt = uaVariable.getDataTypeNode();
-    const definition = dt.getStructureDefinition();
-
-    for (const field of definition.fields || []) {
-        if (NodeId.sameNodeId(NodeId.nullNodeId, field.dataType)) {
-            if (doDebug) {
-                debugLog("field.dataType is null ! ", field.name, NodeId.nullNodeId.toString());
-                debugLog(field.toString());
-                debugLog(" dataType replaced with BaseDataType ");
-                debugLog(definition.toString());
-            }
-            field.dataType = uaVariable.resolveNodeId("BaseDataType");
-        }
-
-        const propertyNode = getOrCreateProperty(uaVariable, field, options);
-        if (!propertyNode) {
-            continue;
-        }
-
-        propertyNode.$dataValue.statusCode = StatusCodes.Good;
-        propertyNode.$dataValue.sourceTimestamp = uaVariable.$dataValue.sourceTimestamp;
-        propertyNode.$dataValue.sourcePicoseconds = uaVariable.$dataValue.sourcePicoseconds;
-        propertyNode.$dataValue.serverTimestamp = uaVariable.$dataValue.serverTimestamp;
-        propertyNode.$dataValue.serverPicoseconds = uaVariable.$dataValue.serverPicoseconds;
-        propertyNode.$dataValue.value.dataType = propertyNode.dataTypeObj.basicDataType;
-        propertyNode.$dataValue.value.arrayType =
-            propertyNode.valueRank === -1
-                ? VariantArrayType.Scalar
-                : propertyNode.valueRank === 1
-                  ? VariantArrayType.Array
-                  : VariantArrayType.Matrix;
-        propertyNode.$dataValue.value.dimensions = propertyNode.valueRank > 1 ? propertyNode.arrayDimensions : null;
-
-        const fieldName = field.name || "";
-        installDataValueGetter(propertyNode, () => get(fieldName));
-        assert(propertyNode._inner_replace_dataValue);
-        propertyNode._inner_replace_dataValue = (dataValue: DataValue, _indexRange?: NumericRange | null) => {
-            /** */
-            const sourceTime = coerceClock(dataValue.sourceTimestamp, dataValue.sourcePicoseconds);
-            const value = dataValue.value.value;
-            set(field.name || "", value, sourceTime);
-            propertyNode.touchValue(sourceTime);
-        };
-
-        if (propertyNode.dataTypeObj.basicDataType === DataType.ExtensionObject) {
-            _installFields2(
-                propertyNode,
-                {
-                    get: (fieldName: string) => {
-                        const mainFieldName = field.name || "";
-                        return (get(mainFieldName) as Record<string, unknown>)[lowerFirstLetter(fieldName)];
-                    },
-                    set: (fieldName: string, value: unknown, _sourceTime: PreciseClock) => {
-                        const mainFieldName = field.name || "";
-                        (get(mainFieldName) as Record<string, unknown>)[lowerFirstLetter(fieldName)] = value;
-                    }
-                },
-                options
-            );
-        }
-    }
-}
-
-function installDataValueGetter(propertyNode: UAVariableImpl, get: () => unknown) {
-    Object.defineProperty(propertyNode.$dataValue.value, "value", { get });
-    const $ = propertyNode.$dataValue;
-    Object.defineProperty(propertyNode, "$dataValue", {
-        get() {
-            return $;
-        },
-        set: (_value) => {
-            throw new Error("$dataValue is now frozen and should not be modified this way !\n contact sterfive.com");
-        }
-    });
-}
-
-function isVariableContainingExtensionObject(uaVariable: UAVariableImpl): boolean {
-    const addressSpace = uaVariable.addressSpace;
-    const structure = addressSpace.findDataType("Structure");
-
-    if (!structure) {
-        // the addressSpace is limited and doesn't provide extension object
-        // bindExtensionObject cannot be performed and shall finish here.
-        return false;
-    }
-
-    assert(structure.browseName.toString() === "Structure", "expecting DataType Structure to be in IAddressSpace");
-
-    const dt = uaVariable.getDataTypeNode() as UADataTypeImpl;
-    if (!dt.isSubtypeOf(structure)) {
-        return false;
-    }
-    return true;
-}
-
-function _innerBindExtensionObjectScalar(
-    uaVariable: UAVariableImpl,
-    {
-        get,
-        set,
-        setField
-    }: {
-        get: () => ExtensionObject;
-        set: (value: ExtensionObject, sourceTimestamp: PreciseClock, cache: Set<UAVariableImpl>) => void;
-        setField: (fieldName: string, value: unknown, sourceTimestamp: PreciseClock, cache?: Set<UAVariableImpl>) => void;
-    },
-    options?: BindExtensionObjectOptions
-) {
-    uaVariable.$dataValue.statusCode = StatusCodes.Good;
-    uaVariable.$dataValue.value.dataType = DataType.ExtensionObject;
-    uaVariable.$dataValue.value.arrayType = VariantArrayType.Scalar;
-
-    uaVariable.setValueFromSource = function (this: UAVariableImpl, variant: VariantLike) {
-        setExtensionObjectPartialValue(this, variant.value);
-    };
-
-    installDataValueGetter(uaVariable, get);
-    uaVariable.$set_ExtensionObject = set;
-
-    _installFields2(
-        uaVariable,
-        {
-            get: (fieldName: string) => {
-                const extObj = get() as unknown as Record<string, unknown>;
-                return extObj[lowerFirstLetter(fieldName)];
-            },
-            set: (fieldName: string, value: unknown, sourceTime: PreciseClock) => {
-                setField(fieldName, value, sourceTime);
-            }
-        },
-        options
-    );
-}
-
-export function _bindExtensionObject(
-    uaVariable: UAVariableImpl,
-    optionalExtensionObject?: ExtensionObject,
-    options?: BindExtensionObjectOptions
-): ExtensionObject | null {
-    options = options || { createMissingProp: false };
-
-    // c8 ignore next
-    if (!isVariableContainingExtensionObject(uaVariable)) {
-        return null;
-    }
-
-    // c8 ignore next
-    if (optionalExtensionObject && uaVariable.valueRank === 0) {
-        warningLog(
-            uaVariable.browseName.toString() +
-                ": valueRank was zero but needed to be adjusted to -1 (Scalar) in bindExtensionObject"
-        );
-        uaVariable.valueRank = -1;
-    }
-    const addressSpace = uaVariable.addressSpace;
-    let extensionObject_: ExtensionObject | undefined;
-
-    // c8 ignore next
-    if (uaVariable.valueRank !== -1 && uaVariable.valueRank !== 1) {
-        throw new Error("Cannot bind an extension object here, valueRank must be scalar (-1) or one-dimensional (1)");
-    }
-
-    // c8 ignore next
-    doDebug && debugLog(" ------------------------------ binding ", uaVariable.browseName.toString(), uaVariable.nodeId.toString());
-
-    // ignore bindExtensionObject on sub extension object, bindExtensionObject has to be called from the top most object
-    if (
-        !options.force &&
-        uaVariable.parent &&
-        (uaVariable.parent.nodeClass === NodeClass.Variable || uaVariable.parent.nodeClass === NodeClass.VariableType)
-    ) {
-        const parentDataType = (uaVariable.parent as UAVariable | UAVariableType).dataType;
-        const dataTypeNode = addressSpace.findNode(parentDataType) as UADataType;
-        const structure = addressSpace.findDataType("Structure");
-        // c8 ignore next
-        if (structure && dataTypeNode?.isSubtypeOf(structure)) {
-            // warningLog(
-            //     "Ignoring bindExtensionObject on sub extension object",
-            //     "child=",
-            //     self.browseName.toString(),
-            //     "parent=",
-            //     self.parent.browseName.toString()
-            // );
-            return null;
-        }
-    }
-
-    // -------------------- make sure we do not bind a variable twice ....
-    if (uaVariable.$extensionObject && !optionalExtensionObject) {
-        // c8 ignore next
-        if (!uaVariable.checkExtensionObjectIsCorrect(uaVariable.$extensionObject)) {
-            warningLog(
-                "on node : ",
-                uaVariable.browseName.toString(),
-                uaVariable.nodeId.toString(),
-                "dataType=",
-                uaVariable.dataType.toString({ addressSpace: uaVariable.addressSpace })
-            );
-            warningLog(uaVariable.$extensionObject?.toString());
-            throw new Error(
-                "bindExtensionObject: $extensionObject is incorrect: we are expecting a " +
-                    uaVariable.dataType.toString({ addressSpace: uaVariable.addressSpace }) +
-                    " but we got a " +
-                    uaVariable.$extensionObject?.schema.name
-            );
-        }
-        // the variable may have been bound at load time with createMissingProp:false ( the loader only
-        // binds what the nodeset declares ): a caller explicitly asking for the missing child
-        // properties must still get them installed on the existing extension object.
-        if (!options.createMissingProp) {
-            return uaVariable.$extensionObject;
-        }
-    }
-
-    if (uaVariable.dataTypeObj.isAbstract) {
-        // c8 ignore next
-        if (!optionalExtensionObject) {
-            warningLog(
-                "Warning the DataType associated with this Variable is abstract ",
-                uaVariable.dataTypeObj.browseName.toString()
-            );
-            warningLog("You need to provide a extension object yourself ");
-            throw new Error("bindExtensionObject requires a extensionObject as associated dataType is only abstract");
-        }
-    }
-
-    const s = uaVariable.readValue();
-    if (s.value && s.value.dataType === DataType.ExtensionObject && s.value.value && optionalExtensionObject) {
-        // we want to replace the extension object
-        s.value.value = null;
-    }
-    innerBindExtensionObject();
-    assert(uaVariable.$extensionObject instanceof Object);
-    return uaVariable.$extensionObject;
-
-    function innerBindExtensionObject() {
-        if (s.value && (s.value.dataType === DataType.Null || (s.value.dataType === DataType.ExtensionObject && !s.value.value))) {
-            if (uaVariable.valueRank === -1 /** Scalar */) {
-                extensionObject_ = optionalExtensionObject || addressSpace.constructExtensionObject(uaVariable.dataType, {});
-
-                installExt(uaVariable, extensionObject_);
-
-                _innerBindExtensionObjectScalar(
-                    uaVariable,
-                    {
-                        get: () => uaVariable.$extensionObject as ExtensionObject,
-                        set: (value: ExtensionObject) => installExt(uaVariable, value),
-                        setField: (fieldName: string, value: unknown) => {
-                            const extObj = uaVariable.$extensionObject as unknown as Record<string, unknown>;
-                            (getProxyTarget(extObj) as Record<string, unknown>)[lowerFirstLetter(fieldName)] = value;
-                        }
-                    },
-                    options
-                );
-                return;
-            } else if (uaVariable.valueRank === 1 /** Array */) {
-                throw new Error("Should not get there ! Please fix me");
-            } else {
-                errorLog(uaVariable.toString());
-                errorLog("Unsupported case ! valueRank= ", uaVariable.valueRank);
-            }
-        } else {
-            // verify that variant has the correct type
-            assert(s.value.dataType === DataType.ExtensionObject);
-            installExt(uaVariable, s.value.value);
-            _innerBindExtensionObjectScalar(
-                uaVariable,
-                {
-                    get: () => uaVariable.$extensionObject as ExtensionObject,
-                    set: (value: ExtensionObject) => installExt(uaVariable, value),
-                    setField: (fieldName: string, value: unknown) => {
-                        const extObj = uaVariable.$extensionObject as unknown as Record<string, unknown>;
-                        (getProxyTarget(extObj) as Record<string, unknown>)[lowerFirstLetter(fieldName)] = value;
-                    }
-                },
-                options
-            );
-        }
-    }
-}
-
-const getIndexAsText = (index: number | number[]): string => {
-    if (typeof index === "number") return `${index}`;
-    return `${index.map((a) => a.toString()).join(",")}`;
-};
-const composeBrowseNameAndNodeId = (uaVariable: UAVariable, indexes: number[]) => {
-    const iAsText = getIndexAsText(indexes);
-    const browseName = coerceQualifiedName(iAsText);
-    let nodeId: NodeId | undefined;
-    if (uaVariable.nodeId.identifierType === NodeIdType.STRING) {
-        nodeId = new NodeId(NodeIdType.STRING, `${uaVariable.nodeId.value as string}[${iAsText}]`, uaVariable.nodeId.namespace);
-    }
-    return { browseName, nodeId };
-};
-
-export function _bindExtensionObjectArrayOrMatrix(
-    uaVariable: UAVariableImpl,
-    optionalExtensionObjectArray?: ExtensionObject[],
-    options?: BindExtensionObjectOptions
-): ExtensionObject[] {
-    options = options || { createMissingProp: false };
-    options.createMissingProp = options.createMissingProp || false;
-
-    // c8 ignore next
-    if (uaVariable.valueRank < 1) {
-        throw new Error("Variable must be a MultiDimensional array");
-    }
-    const arrayDimensions = uaVariable.arrayDimensions || [];
-    // c8 ignore next
-    if (!isVariableContainingExtensionObject(uaVariable)) {
-        return [];
-    }
-
-    if (!optionalExtensionObjectArray && uaVariable.$dataValue.value.value) {
-        assert(Array.isArray(uaVariable.$dataValue.value.value));
-        optionalExtensionObjectArray = uaVariable.$dataValue.value.value;
-    }
-
-    if (
-        (arrayDimensions.length === 0 || (arrayDimensions.length === 1 && arrayDimensions[0] === 0)) &&
-        optionalExtensionObjectArray
-    ) {
-        arrayDimensions[0] = optionalExtensionObjectArray.length;
-    }
-
-    const totalLength = arrayDimensions.reduce((p, c) => p * c, 1);
-
-    /** */
-    const addressSpace = uaVariable.addressSpace;
-    if (optionalExtensionObjectArray && optionalExtensionObjectArray.length !== 0) {
-        if (optionalExtensionObjectArray.length !== totalLength) {
-            throw new Error(
-                `optionalExtensionObjectArray must have the expected number of element matching ${arrayDimensions} but was ${optionalExtensionObjectArray.length}`
-            );
-        }
-    }
-    if (!optionalExtensionObjectArray || optionalExtensionObjectArray.length === 0) {
-        optionalExtensionObjectArray = [];
-        for (let i = 0; i < totalLength; i++) {
-            optionalExtensionObjectArray[i] = addressSpace.constructExtensionObject(uaVariable.dataType, {});
-        }
-    }
-    uaVariable.$$extensionObjectArray = optionalExtensionObjectArray;
-    uaVariable.$dataValue.value.arrayType = uaVariable.valueRank === 1 ? VariantArrayType.Array : VariantArrayType.Matrix;
-    uaVariable.$dataValue.value.dimensions = uaVariable.valueRank === 1 ? null : uaVariable.arrayDimensions || [];
-    uaVariable.$dataValue.value.dataType = DataType.ExtensionObject;
-    uaVariable.$dataValue.value.value = uaVariable.$$extensionObjectArray;
-
-    // make sure uaVariable.$dataValue cannot be inadvertantly changed from this point onward
-    const $dataValue = uaVariable.$dataValue;
-    Object.defineProperty(uaVariable, "$dataValue", {
-        get(): DataValue {
-            return $dataValue;
-        },
-        set() {
-            throw new Error("$dataValue is now sealed , you should not change internal $dataValue!");
-        },
-        //    writable: true,
-        enumerable: true,
-        configurable: true
-    });
-
-    uaVariable.bindVariable(
-        {
-            get: () => uaVariable.$dataValue.value
-        },
-        true
-    );
-
-    const namespace = uaVariable.namespace;
-    const indexIterator = new IndexIterator(arrayDimensions);
-    for (let i = 0; i < totalLength; i++) {
-        const index = indexIterator.next();
-
-        const { browseName, nodeId } = composeBrowseNameAndNodeId(uaVariable, index);
-
-        let uaElement = uaVariable.getComponentByName(browseName) as UAVariableImpl | null;
-        if (!uaElement) {
-            if (!options.createMissingProp) {
-                continue;
-            }
-
-            uaElement = namespace.addVariable({
-                browseName,
-                nodeId,
-                componentOf: uaVariable,
-                dataType: uaVariable.dataType,
-                valueRank: -1,
-                accessLevel: uaVariable.accessLevel
-            }) as UAVariableImpl;
-        }
-
-        uaElement.$dataValue.statusCode = StatusCodes.Good;
-        uaElement.$dataValue.sourceTimestamp = uaVariable.$dataValue.sourceTimestamp;
-        uaElement.$dataValue.sourcePicoseconds = uaVariable.$dataValue.sourcePicoseconds;
-        uaElement.$dataValue.serverTimestamp = uaVariable.$dataValue.serverTimestamp;
-        uaElement.$dataValue.serverPicoseconds = uaVariable.$dataValue.serverPicoseconds;
-        uaElement.$dataValue.value.dataType = DataType.ExtensionObject;
-        uaElement.$dataValue.value.arrayType = VariantArrayType.Scalar;
-
-        {
-            const capturedIndex = i;
-            const capturedUaElement = uaElement as UAVariableImpl;
-            _innerBindExtensionObjectScalar(
-                uaElement,
-                {
-                    get: () => getExtensionObjectArray(uaVariable)[capturedIndex],
-                    set: (newValue: ExtensionObject, sourceTimestamp: PreciseClock, cache: Set<UAVariableImpl>) => {
-                        const extArray = getExtensionObjectArray(uaVariable);
-                        assert(!isProxy(extArray[capturedIndex]));
-                        extArray[capturedIndex] = newValue;
-                        // c8 ignore next
-                        if (extArray !== uaVariable.$dataValue.value.value) {
-                            warningLog("uaVariable", uaVariable.nodeId.toString());
-                            warningLog("Houston! We have a problem ");
-                        }
-                        propagateTouchValueDownward(capturedUaElement, sourceTimestamp, cache);
-                        propagateTouchValueUpward(capturedUaElement, sourceTimestamp, cache);
-                    },
-                    setField: (
-                        fieldName: string,
-                        newValue: unknown,
-                        sourceTimestamp: PreciseClock,
-                        cache?: Set<UAVariableImpl>
-                    ) => {
-                        // c8 ignore next doDebug && debugLog("setField", fieldName, newValue, sourceTimestamp, cache);
-                        const extObj = getExtensionObjectArray(uaVariable)[capturedIndex];
-                        (unProxy(extObj) as unknown as Record<string, unknown>)[lowerFirstLetter(fieldName)] = newValue;
-                        propagateTouchValueUpward(capturedUaElement, sourceTimestamp, cache);
-                    }
-                },
-                { ...options, force: true }
-            );
-        }
-    }
-    return uaVariable.$$extensionObjectArray;
-}
-
-export function getElement(path: string | string[], data: Record<string, unknown>): unknown {
-    if (typeof path === "string") {
-        path = path.split(".");
-    }
-    let a: Record<string, unknown> = data;
-    for (const e of path) {
-        a = a[e] as Record<string, unknown>;
-    }
-    return a;
-}
-export function setElement(path: string | string[], data: Record<string, unknown>, value: unknown): void {
-    if (typeof path === "string") {
-        path = path.split(".");
-    }
-    const last = path.pop();
-    if (last === undefined) {
-        return;
-    }
-    let a: Record<string, unknown> = data;
-    for (const e of path) {
-        a = a[e] as Record<string, unknown>;
-    }
-    a[last] = value;
-}
-export function incrementElement(path: string | string[], data: Record<string, unknown>): void {
-    const value = getElement(path, data) as number;
-    setElement(path, data, value + 1);
-}
-export function extractPartialData(path: string | string[], extensionObject: ExtensionObject) {
-    let name: string;
-    if (typeof path === "string") {
-        path = path.split(".");
-    }
-    let i: number;
-    // read partial value
-    const partialData: Record<string, unknown> = {};
-    let p: Record<string, unknown> = partialData;
-    for (i = 0; i < path.length - 1; i++) {
-        name = path[i];
-        p[name] = {};
-        p = p[name] as Record<string, unknown>;
-    }
-    name = path[path.length - 1];
-    p[name] = 0;
-
-    let c1: Record<string, unknown> = partialData;
-    let c2: Record<string, unknown> = extensionObject as unknown as Record<string, unknown>;
-
-    for (i = 0; i < path.length - 1; i++) {
-        name = path[i];
-        c1 = partialData[name] as Record<string, unknown>;
-        c2 = (extensionObject as unknown as Record<string, unknown>)[name] as Record<string, unknown>;
-    }
-    name = path[path.length - 1];
-    c1[name] = c2[name];
-    return partialData;
-}
-
-export function propagateTouchValueDownwardArray(uaVariable: UAVariableImpl, now: PreciseClock, cache: Set<UAVariable>) {
-    if (!uaVariable.$$extensionObjectArray) return;
-    const arrayDimensions = uaVariable.arrayDimensions || [];
-    const totalLength = uaVariable.$$extensionObjectArray.length;
-
-    const indexIterator = new IndexIterator(arrayDimensions);
-    for (let i = 0; i < totalLength; i++) {
-        const index = indexIterator.next();
-
-        const { browseName } = composeBrowseNameAndNodeId(uaVariable, index);
-        const uaElement = uaVariable.getComponentByName(browseName) as UAVariableImpl | null;
-        if (uaElement?.nodeClass === NodeClass.Variable) {
-            uaElement.touchValue(now);
-            propagateTouchValueDownward(uaElement, now, cache);
-        }
-    }
-}