node-opcua-address-space 2.67.1 → 2.69.0

package/src/address_space.ts

@@ -121,7 +121,7 @@ function isNodeIdString(str: unknown): boolean {
     return str.substring(0, 2) === "i=" || str.substring(0, 3) === "ns=";
 }
 
-type ShutdownTask = (this: AddressSpace) => void;
+type ShutdownTask = ((this: AddressSpace) => void) | ((this: AddressSpace) => Promise<void>);
 
 /**
  * `AddressSpace` is a collection of UA nodes.
@@ -167,7 +167,7 @@ export class AddressSpace implements AddressSpacePrivate {
         this._private_namespaceIndex = 1;
         this._namespaceArray = [];
         // special namespace 0 is reserved for the UA namespace
-        this.registerNamespace("http://opcfoundation.org/UA/");     
+        this.registerNamespace("http://opcfoundation.org/UA/");
         AddressSpace.registry.register(this);
     }
     /**
@@ -1061,21 +1061,22 @@ export class AddressSpace implements AddressSpacePrivate {
      * register a function that will be called when the server will perform its shut down.
      * @method registerShutdownTask
      */
-    public registerShutdownTask(task: (this: AddressSpace) => void): void {
+    public registerShutdownTask(task: ShutdownTask): void {
         this._shutdownTask = this._shutdownTask || [];
         assert(typeof task === "function");
         this._shutdownTask.push(task);
     }
 
-    public shutdown(): void {
+    public async shutdown(): Promise<void> {
         if (!this._shutdownTask) {
             return;
         }
-        // perform registerShutdownTask
-        this._shutdownTask.forEach((task: any) => {
-            task.call(this);
-        });
+        const tasks = this._shutdownTask;
         this._shutdownTask = [];
+        // perform registerShutdownTask
+        for (const task of tasks) {
+            await task.call(this);
+        }
     }
 
     /**
@@ -1534,8 +1535,6 @@ export class AddressSpace implements AddressSpacePrivate {
         return nodeId;
     }
 
-
-
     private _findReferenceType(refType: NodeId | string, namespaceIndex?: number): UAReferenceType | null {
         if (refType instanceof NodeId) {
             return _find_by_node_id<UAReferenceType>(this, refType, namespaceIndex);

package/src/base_node_private.ts

@@ -13,7 +13,7 @@ import {
     NodeClass,
     ResultMask
 } from "node-opcua-data-model";
-import { make_warningLog } from "node-opcua-debug";
+import { checkDebugFlag, make_warningLog } from "node-opcua-debug";
 import { NodeId, resolveNodeId, sameNodeId } from "node-opcua-nodeid";
 import { ReferenceDescription } from "node-opcua-types";
 import {
@@ -42,7 +42,7 @@ import { BaseNodeImpl, getReferenceType } from "./base_node_impl";
 import { AddressSpacePrivate } from "./address_space_private";
 
 // eslint-disable-next-line prefer-const
-let dotrace = false;
+let doTrace = checkDebugFlag("INSTANTIATE");
 const traceLog = console.log.bind(console);
 
 const g_weakMap = new WeakMap();
@@ -484,7 +484,7 @@ function _clone_collection_new(
         }
 
         if (optionalFilter && node && !optionalFilter.shouldKeep(node)) {
-            dotrace && traceLog(extraInfo.pad(), "skipping ", node.browseName.toString());
+            doTrace && traceLog(extraInfo.pad(), "skipping optional ", node.browseName.toString(), "that doesn't appear in the filter");
             continue; // skip this node
         }
         const key = node.browseName.toString();
@@ -501,7 +501,7 @@ function _clone_collection_new(
             copyAlsoModellingRules
         };
 
-        dotrace &&
+        doTrace &&
             traceLog(
                 extraInfo.pad(),
                 "cloning => ",
@@ -554,7 +554,7 @@ function _extractInterfaces2(typeDefinitionNode: UAObjectType | UAVariableType,
 
     const baseInterfaces: UAInterface[] = [];
     for (const iface of interfaces) {
-        dotrace &&
+        doTrace &&
             traceLog(
                 extraInfo.pad(),
                 typeDefinitionNode.browseName.toString(),
@@ -570,7 +570,7 @@ function _extractInterfaces2(typeDefinitionNode: UAObjectType | UAVariableType,
     }
     interfaces.push(...baseInterfaces);
     if (typeDefinitionNode.subtypeOfObj) {
-        dotrace &&
+        doTrace &&
             traceLog(
                 extraInfo.pad(),
                 typeDefinitionNode.browseName.toString(),
@@ -583,7 +583,7 @@ function _extractInterfaces2(typeDefinitionNode: UAObjectType | UAVariableType,
     }
     const dedupedInterfaces = [...new Set(interfaces)];
 
-    dotrace &&
+    doTrace &&
         traceLog(
             extraInfo.pad(),
             chalk.yellow("Interface for ", typeDefinitionNode.browseName.toString()),
@@ -635,7 +635,7 @@ function _crap_extractInterfaces(typeDefinitionNode: UAObjectType | UAVariableTy
     const interfacesRef = typeDefinitionNode.findReferencesEx("HasInterface", BrowseDirection.Forward);
     const interfaces = interfacesRef.map((r) => r.node! as UAInterface);
     for (const iface of interfaces) {
-        dotrace && traceLog(extraInfo.pad(), "   interface ", iface.browseName.toString());
+        doTrace && traceLog(extraInfo.pad(), "   interface ", iface.browseName.toString());
     }
 
     return interfaces;
@@ -648,7 +648,7 @@ function _cloneInterface(
     extraInfo: CloneExtraInfo,
     browseNameMap: Set<string>
 ): void {
-    dotrace &&
+    doTrace &&
         traceLog(
             extraInfo?.pad(),
             chalk.green("-------------------- now cloning interfaces of ", node.browseName.toString(), node.nodeId.toString())
@@ -660,23 +660,30 @@ function _cloneInterface(
     if (!typeDefinitionNode) {
         return;
     }
-    dotrace && traceLog(extraInfo.pad(), "  --- {");
     const interfaces = _extractInterfaces2(typeDefinitionNode, extraInfo);
-    dotrace && traceLog(extraInfo.pad(), "  --- }");
-    dotrace && traceLog(extraInfo?.pad(), chalk.green("-------------------- interfaces are  ", interfaces.length));
+    if (interfaces.length === 0) {
+        if (doTrace) {
+            traceLog(
+                extraInfo.pad(),
+                chalk.yellow("No interface for ", node.browseName.toString(), node.nodeId.toString())
+            );
+        }
+        return;
+    }
+    doTrace && traceLog(extraInfo?.pad(), chalk.green("-------------------- interfaces are  ", interfaces.length));
 
     const localFilter = optionalFilter.filterFor(node);
 
     for (const iface of interfaces) {
         const aggregates = iface.findReferencesEx("Aggregates", BrowseDirection.Forward);
-        dotrace &&
+        doTrace &&
             traceLog(
                 extraInfo.pad(),
                 chalk.magentaBright("   interface ", iface.browseName.toString()),
                 "\n" + extraInfo?.pad(),
                 aggregates.map((r) => r.toString({ addressSpace })).join("\n" + extraInfo?.pad())
             );
-        _clone_collection_new(newParent, aggregates, false, localFilter, extraInfo, browseNameMap);
+        _clone_collection_new(node, aggregates, false, localFilter, extraInfo, browseNameMap);
     }
 }
 export function _clone_children_references(
@@ -775,36 +782,37 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
     const cloneObj = new Constructor(constructorOptions);
     (this.addressSpace as AddressSpacePrivate)._register(cloneObj);
 
-    options.copyAlsoModellingRules = options.copyAlsoModellingRules || false;
+    if (!options.ignoreChildren) {
+        // clone children and the rest ....
+        options.copyAlsoModellingRules = options.copyAlsoModellingRules || false;
 
-    const newFilter = optionalFilter.filterFor(cloneObj);
+        const newFilter = optionalFilter.filterFor(cloneObj);
 
-    const browseNameMap = new Set<string>();
-    _clone_children_references(this, cloneObj, options.copyAlsoModellingRules, newFilter!, extraInfo, browseNameMap);
+        const browseNameMap = new Set<string>();
+        _clone_children_references(this, cloneObj, options.copyAlsoModellingRules, newFilter!, extraInfo, browseNameMap);
 
-    //
-    let typeDefinitionNode: UAVariableType | UAObjectType | null = this.typeDefinitionObj;
-    while (typeDefinitionNode) {
-        dotrace &&
-            traceLog(
-                extraInfo?.pad(),
-                chalk.blueBright("---------------------- Exploring ", typeDefinitionNode.browseName.toString())
+        //
+        let typeDefinitionNode: UAVariableType | UAObjectType | null = this.typeDefinitionObj;
+        while (typeDefinitionNode) {
+            doTrace &&
+                traceLog(
+                    extraInfo?.pad(),
+                    chalk.blueBright("---------------------- Exploring ", typeDefinitionNode.browseName.toString())
+                );
+            _clone_children_references(
+                typeDefinitionNode,
+                cloneObj,
+                options.copyAlsoModellingRules,
+                newFilter,
+                extraInfo,
+                browseNameMap
             );
-        _clone_children_references(
-            typeDefinitionNode,
-            cloneObj,
-            options.copyAlsoModellingRules,
-            newFilter,
-            extraInfo,
-            browseNameMap
-        );
-        typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
-    }
-
-    _clone_non_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
+            typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
+        }
 
+        _clone_non_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
+    }
     cloneObj.propagate_back_references();
-
     cloneObj.install_extra_properties();
 
     return cloneObj;

package/src/historical_access/address_space_historical_data_node.ts

@@ -172,7 +172,7 @@ export class VariableHistorian implements IVariableHistorian {
         reverseDataValue: boolean,
         callback: CallbackT<DataValue[]>
     ): void {
-        assert(callback instanceof Function);
+        assert(typeof callback === 'function');
 
         let dataValues = filter_dequeue(this._timeline, historyReadRawModifiedDetails, maxNumberToExtract, isReversed);
 
@@ -322,7 +322,7 @@ function _historyReadRawAsync(
     reverseDataValue: boolean,
     callback: CallbackT<DataValue[]>
 ) {
-    assert(callback instanceof Function);
+    assert(typeof callback === 'function');
     this.varHistorian!.extractDataValues(historyReadRawModifiedDetails, maxNumberToExtract, isReversed, reverseDataValue, callback);
 }
 
@@ -546,7 +546,7 @@ function _historyRead(
     continuationData: ContinuationData,
     callback: CallbackT<HistoryReadResult>
 ) {
-    assert(callback instanceof Function);
+    assert(typeof callback === 'function');
     if (historyReadDetails instanceof ReadRawModifiedDetails) {
         // note: only ReadRawModifiedDetails supported at this time
         return this._historyReadRawModify(context, historyReadDetails, indexRange, dataEncoding, continuationData, callback);

package/src/nodeset_tools/nodeset_to_xml.ts

@@ -243,11 +243,14 @@ function _dumpVariantInnerExtensionObject(
         const lowerFieldName = utils.lowerFirstLetter(fieldName);
         const v = (value as unknown as Record<string, unknown>)[lowerFieldName];
         if (v !== null && v !== undefined) {
-
-            if (dataTypeNodeId.namespace === 0 && dataTypeNodeId.value ===0 && dataTypeNodeId.identifierType === NodeIdType.NUMERIC) {
+            if (
+                dataTypeNodeId.namespace === 0 &&
+                dataTypeNodeId.value === 0 &&
+                dataTypeNodeId.identifierType === NodeIdType.NUMERIC
+            ) {
                 // to do ?? shall we do a extension Object here ?
                 continue; // ns=0;i=0 is reserved
-            }          
+            }
             const { name, definition } = definitionMap.findDefinition(dataTypeNodeId);
             xw.startElement(fieldName);
 
@@ -324,7 +327,9 @@ function _dumpVariantInnerValue(
             xw.text(value[1].toString());
             break;
         case DataType.Boolean:
+        case DataType.SByte:
         case DataType.Byte:
+        case DataType.SByte:
         case DataType.Float:
         case DataType.Double:
         case DataType.Int16:
@@ -628,7 +633,10 @@ function dumpReferencedNodes(xw: XmlWriter, node: BaseNode, forward: boolean) {
                 const typeDefinitionObj = ReferenceImpl.resolveReferenceNode(addressSpace, r[0])! as BaseNode;
                 if (!typeDefinitionObj) {
                     warningLog(node.toString());
-                    warningLog("dumpReferencedNodes: Warning : " + node.browseName.toString() + " unknown typeDefinition, ", r[0].toString());
+                    warningLog(
+                        "dumpReferencedNodes: Warning : " + node.browseName.toString() + " unknown typeDefinition, ",
+                        r[0].toString()
+                    );
                 } else {
                     assert(typeDefinitionObj instanceof BaseNodeImpl);
                     if (typeDefinitionObj.nodeId.namespace === node.nodeId.namespace) {

package/src/ua_variable_impl.ts

@@ -89,7 +89,15 @@ import { BaseNodeImpl, InternalBaseNodeOptions } from "./base_node_impl";
 import { _clone, ToStringBuilder, UAVariable_toString, valueRankToString } from "./base_node_private";
 import { EnumerationInfo, IEnumItem, UADataTypeImpl } from "./ua_data_type_impl";
 import { apply_condition_refresh, ConditionRefreshCache } from "./apply_condition_refresh";
-import { extractPartialData, propagateTouchValueUpward, setExtensionObjectValue, _bindExtensionObject, _installExtensionObjectBindingOnProperties, _setExtensionObject, _touchValue } from "./ua_variable_impl_ext_obj";
+import {
+    extractPartialData,
+    propagateTouchValueUpward,
+    setExtensionObjectValue,
+    _bindExtensionObject,
+    _installExtensionObjectBindingOnProperties,
+    _setExtensionObject,
+    _touchValue
+} from "./ua_variable_impl_ext_obj";
 
 const debugLog = make_debugLog(__filename);
 const warningLog = make_warningLog(__filename);
@@ -774,7 +782,6 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
             } else {
                 this._internal_set_dataValue(dataValue);
             }
-
         } catch (err) {
             errorLog("UAVariable#setValueFromString Error : ", this.browseName.toString(), this.nodeId.toString());
             errorLog((err as Error).message);
@@ -1167,7 +1174,7 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         if (!context) {
             context = SessionContext.defaultContext;
         }
-        assert(callback instanceof Function);
+        assert(typeof callback === "function");
 
         this.__waiting_callbacks = this.__waiting_callbacks || [];
         this.__waiting_callbacks.push(callback);
@@ -1324,8 +1331,8 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
 
     /**
      * @private
-     * install UAVariable to exposed th  
-     * 
+     * install UAVariable to exposed th
+     *
      * precondition:
      */
     public installExtensionObjectVariables(): void {
@@ -1347,10 +1354,9 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         optionalExtensionObject?: ExtensionObject,
         options?: BindExtensionObjectOptions
     ): ExtensionObject | null {
-       return  _bindExtensionObject(this, optionalExtensionObject, options);
+        return _bindExtensionObject(this, optionalExtensionObject, options);
     }
 
-
     public updateExtensionObjectPartial(partialExtensionObject?: { [key: string]: any }): ExtensionObject {
         setExtensionObjectValue(this, partialExtensionObject);
         return this.$extensionObject;
@@ -1412,7 +1418,7 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         callback?: CallbackT<HistoryReadResult>
     ): any {
         assert(context instanceof SessionContext);
-        assert(callback instanceof Function);
+        assert(typeof callback === "function");
         if (typeof this._historyRead !== "function") {
             return callback!(null, new HistoryReadResult({ statusCode: StatusCodes.BadNotReadable }));
         }
@@ -1505,7 +1511,6 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         this.$dataValue.value = value;
     }
 
-
     public _internal_set_dataValue(dataValue: DataValue, indexRange?: NumericRange | null): void {
         assert(dataValue, "expecting a dataValue");
         assert(dataValue instanceof DataValue, "expecting dataValue to be a DataValue");
@@ -1686,7 +1691,6 @@ export interface UAVariableImpl {
     $$indexPropertyName: any;
 }
 
-
 function check_valid_array(dataType: DataType, array: any): boolean {
     if (Array.isArray(array)) {
         return true;

package/src/ua_variable_type_impl.ts

@@ -21,7 +21,7 @@ import {
     UAVariableType,
     CloneFilter
 } from "node-opcua-address-space-base";
-import { ObjectTypeIds, ReferenceTypeIds, VariableTypeIds } from "node-opcua-constants";
+import { ReferenceTypeIds } from "node-opcua-constants";
 import { coerceQualifiedName, NodeClass, QualifiedName, BrowseDirection, AttributeIds } from "node-opcua-data-model";
 import { DataValue, DataValueLike } from "node-opcua-data-value";
 import { checkDebugFlag, make_debugLog, make_warningLog, make_errorLog } from "node-opcua-debug";
@@ -40,7 +40,6 @@ import { _clone_children_references, ToStringBuilder, UAVariableType_toString }
 import * as tools from "./tool_isSupertypeOf";
 import { get_subtypeOfObj } from "./tool_isSupertypeOf";
 import { get_subtypeOf } from "./tool_isSupertypeOf";
-import { resolveReferenceNode } from "./reference_impl";
 
 const debugLog = make_debugLog(__filename);
 const doDebug = checkDebugFlag(__filename);
@@ -48,7 +47,7 @@ const warningLog = make_warningLog(__filename);
 const errorLog = make_errorLog(__filename);
 
 // eslint-disable-next-line prefer-const
-let doTrace = false;
+let doTrace = checkDebugFlag("INSTANTIATE");
 const traceLog = errorLog;
 
 interface InstantiateS {

package/test_helpers/test_fixtures/nodeset_with_utf8_special_characters.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<UANodeSet>
+    <NamespaceUris>
+        <Uri>uri://mynamespace</Uri>
+    </NamespaceUris>
+    <Models>
+        <Model ModelUri="uri://mynamespace" PublicationDate="2022-04-21T00:00:00Z" Version="1.00">
+            <RequiredModel ModelUri="http://opcfoundation.org/UA/" PublicationDate="2021-09-15T00:00:00Z" Version="1.04.10"/>
+        </Model>
+    </Models>
+    <Aliases>
+    </Aliases>
+    <UAObject BrowseName="Noël" NodeId="ns=1;i=1001"/>
+    <UAObject BrowseName="Strauß" NodeId="ns=1;i=1002"/>
+    <UAObject BrowseName="Bjørn Ødger Åse" NodeId="ns=1;i=1003"/>
+    <UAObject BrowseName="Günter Альберт" NodeId="ns=1;i=1004"/>
+    <UAObject BrowseName="Мир во всём ми́ре" NodeId="ns=1;i=1005"/>
+    <UAObject BrowseName="صلح در زمین" NodeId="ns=1;i=1006"/>
+    
+</UANodeSet>