node-opcua-address-space 2.58.0 → 2.62.0

package/src/ua_variable_type_impl.ts

@@ -6,20 +6,6 @@
 import * as chalk from "chalk";
 
 import { assert } from "node-opcua-assert";
-import { UInt32 } from "node-opcua-basic-types";
-import { ReferenceTypeIds } from "node-opcua-constants";
-import { coerceQualifiedName, NodeClass, QualifiedName } from "node-opcua-data-model";
-import { BrowseDirection } from "node-opcua-data-model";
-import { AttributeIds } from "node-opcua-data-model";
-import { DataValue, DataValueLike } from "node-opcua-data-value";
-import { checkDebugFlag, make_debugLog, make_warningLog } from "node-opcua-debug";
-import { coerceNodeId, makeNodeId, NodeId, NodeIdLike, sameNodeId } from "node-opcua-nodeid";
-import { StatusCodes } from "node-opcua-status-code";
-import { isNullOrUndefined } from "node-opcua-utils";
-import { DataType } from "node-opcua-variant";
-import { Variant } from "node-opcua-variant";
-import { VariantArrayType } from "node-opcua-variant";
-
 import {
     IAddressSpace,
     AddVariableOptions,
@@ -35,6 +21,15 @@ import {
     UAVariableType,
     CloneFilter
 } from "node-opcua-address-space-base";
+import { ObjectTypeIds, ReferenceTypeIds, VariableTypeIds } 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";
+import { coerceNodeId, makeNodeId, NodeId, NodeIdLike, sameNodeId } from "node-opcua-nodeid";
+import { StatusCodes } from "node-opcua-status-code";
+import { UInt32 } from "node-opcua-basic-types";
+import { isNullOrUndefined } from "node-opcua-utils";
+import { DataType, Variant, VariantArrayType, verifyRankAndDimensions } from "node-opcua-variant";
 
 import { SessionContext } from "../source/session_context";
 import { makeOptionalsMap, OptionalMap } from "../source/helpers/make_optionals_map";
@@ -45,11 +40,16 @@ 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 { verifyRankAndDimensions } from "./ua_variable_impl";
+import { resolveReferenceNode } from "./reference_impl";
 
 const debugLog = make_debugLog(__filename);
 const doDebug = checkDebugFlag(__filename);
 const warningLog = make_warningLog(__filename);
+const errorLog = make_errorLog(__filename);
+
+// eslint-disable-next-line prefer-const
+let doTrace = false;
+const traceLog = errorLog;
 
 interface InstantiateS {
     propertyOf?: any;
@@ -131,7 +131,6 @@ export class UAVariableTypeImpl extends BaseNodeImpl implements UAVariableType {
 
         if (options.value) {
             this.value = new Variant(options.value);
-            // xx console.log("setting ",this.value.toString());
         }
     }
 
@@ -246,6 +245,7 @@ export class UAVariableTypeImpl extends BaseNodeImpl implements UAVariableType {
             componentOf: options.componentOf,
             dataType,
             description: options.description || this.description,
+            displayName: options.displayName || this.displayName,
             eventSourceOf: options.eventSourceOf,
             minimumSamplingInterval: options.minimumSamplingInterval,
             modellingRule: options.modellingRule,
@@ -309,7 +309,7 @@ class MandatoryChildOrRequestedOptionalFilter implements CloneFilter {
             const n = addressSpace.findNode(r.nodeId)!;
             // istanbul ignore next
             if (!n) {
-                console.log(" cannot find node ", r.nodeId.toString());
+                warningLog(" cannot find node ", r.nodeId.toString());
                 return false;
             }
             return n.browseName!.name!.toString() === node.browseName!.name!.toString();
@@ -327,7 +327,24 @@ class MandatoryChildOrRequestedOptionalFilter implements CloneFilter {
         switch (modellingRule) {
             case null:
             case undefined:
-                return false; // skip
+                debugLog(
+                    "node ",
+                    node.browseName.toString(),
+                    node.nodeId.toString(),
+                    " has no modellingRule ",
+                    node.parentNodeId?.toString()
+                );
+                /**
+                 * in some badly generated NodeSet2.xml file, the modellingRule is not specified
+                 *
+                 * but in some other NodeSet2.xml, this means that the data are only attached to the Type node and shall not be
+                 * instantiate in the corresponding instance (example is the state variable of a finite state machine that are only
+                 * defined in the Type node)
+                 *
+                 * we should not consider it as an error, and treat it as not present
+                 */
+                return false;
+
             case "Mandatory":
                 return true; // keep;
             case "Optional":
@@ -370,11 +387,11 @@ function _get_parent_as_VariableOrObjectType(originalObject: BaseNode): UAVariab
 
     // istanbul ignore next
     if (parents.length > 1) {
-        console.warn(" object ", originalObject.browseName.toString(), " has more than one parent !");
-        console.warn(originalObject.toString());
-        console.warn(" parents : ");
+        warningLog(" object ", originalObject.browseName.toString(), " has more than one parent !");
+        warningLog(originalObject.toString());
+        warningLog(" parents : ");
         for (const parent of parents) {
-            console.log("     ", parent.toString(), addressSpace.findNode(parent.nodeId)!.browseName.toString());
+            warningLog("     ", parent.toString(), addressSpace.findNode(parent.nodeId)!.browseName.toString());
         }
         return null;
     }
@@ -395,8 +412,12 @@ interface CloneInfo {
     original: UAVariableType | UAObjectType;
 }
 class CloneHelper {
+    public level = 0;
     private readonly mapOrgToClone: Map<string, CloneInfo> = new Map();
 
+    public pad(): string {
+        return " ".padEnd(this.level * 2, " ");
+    }
     public registerClonedObject<TT extends UAVariableType | UAObjectType, T extends UAObject | UAVariable | UAMethod>(
         objInType: TT,
         clonedObj: T
@@ -439,7 +460,6 @@ class CloneHelper {
         // find subTypeOf
     }
 }
-
 // install properties and components on a instantiated Object
 //
 // based on their ModelingRule
@@ -452,39 +472,66 @@ class CloneHelper {
 function _initialize_properties_and_components<B extends UAObject | UAVariable | UAMethod, T extends UAObjectType | UAVariableType>(
     instance: B,
     topMostType: T,
-    typeNode: T,
+    typeDefinitionNode: T,
     copyAlsoModellingRules: boolean,
     optionalsMap: OptionalMap,
     extraInfo: CloneHelper
 ) {
     if (doDebug) {
-        console.log("instance browseName =", instance.browseName.toString());
-        console.log("typeNode         =", typeNode.browseName.toString());
-        console.log("optionalsMap     =", Object.keys(optionalsMap).join(" "));
+        debugLog("instance browseName =", instance.browseName.toString());
+        debugLog("typeNode         =", typeDefinitionNode.browseName.toString());
+        debugLog("optionalsMap     =", Object.keys(optionalsMap).join(" "));
 
-        const c = typeNode.findReferencesEx("Aggregates");
-        console.log("type possibilities      =", c.map((x) => x.node!.browseName.toString()).join(" "));
+        const c = typeDefinitionNode.findReferencesEx("Aggregates");
+        debugLog("typeDefinition aggregates      =", c.map((x) => x.node!.browseName.toString()).join(" "));
     }
     optionalsMap = optionalsMap || {};
 
-    if (sameNodeId(topMostType.nodeId, typeNode.nodeId)) {
+    if (sameNodeId(topMostType.nodeId, typeDefinitionNode.nodeId)) {
         return; // nothing to do
     }
 
-    const baseTypeNodeId = typeNode.subtypeOf;
-    const baseType = typeNode.subtypeOfObj;
+    const filter = new MandatoryChildOrRequestedOptionalFilter(instance, optionalsMap);
 
-    // istanbul ignore next
-    if (!baseType) {
-        throw new Error(chalk.red("Cannot find object with nodeId ") + baseTypeNodeId);
-    }
+    doTrace &&
+        traceLog(
+            chalk.cyan(extraInfo.pad(), "cloning relevant member of typeDefinition class"),
+            typeDefinitionNode.browseName.toString()
+        );
 
-    const filter = new MandatoryChildOrRequestedOptionalFilter(instance, optionalsMap);
+    const browseNameMap = new Set<string>();
+
+    _clone_children_references(typeDefinitionNode, instance, copyAlsoModellingRules, filter, extraInfo, browseNameMap);
+
+    // now apply recursion on baseTypeDefinition  to get properties and components from base class
 
-    _clone_children_references(typeNode, instance, copyAlsoModellingRules, filter, extraInfo);
+    const baseTypeDefinitionNodeId = typeDefinitionNode.subtypeOf;
+    const baseTypeDefinition = typeDefinitionNode.subtypeOfObj!;
+
+    doTrace &&
+        traceLog(
+            chalk.cyan(
+                extraInfo.pad(),
+                "now apply recursion on baseTypeDefinition  to get properties and components from base class"
+            ),
+            baseTypeDefinition.browseName.toString()
+        );
+
+    // istanbul ignore next
+    if (!baseTypeDefinition) {
+        throw new Error(chalk.red("Cannot find object with nodeId ") + baseTypeDefinitionNodeId);
+    }
+    extraInfo.level++;
+    _initialize_properties_and_components(
+        instance,
+        topMostType,
+        baseTypeDefinition,
+        copyAlsoModellingRules,
+        optionalsMap,
+        extraInfo
+    );
+    extraInfo.level--;
 
-    // get properties and components from base class
-    _initialize_properties_and_components(instance, topMostType, baseType, copyAlsoModellingRules, optionalsMap, extraInfo);
 }
 
 /**
@@ -595,8 +642,6 @@ function findNonHierarchicalReferences(originalObject: BaseNode): UAReference[]
 
         if (child) {
             const baseRef = findNonHierarchicalReferences(child);
-            // xx console.log("  ... ",originalObject.browseName.toString(),
-            // parent.browseName.toString(), references.length, baseRef.length);
             references = ([] as UAReference[]).concat(references, baseRef);
         }
     }
@@ -691,15 +736,6 @@ function reconstructFunctionalGroupType(extraInfo: any) {
     for (const { original, cloned } of extraInfo.mapOrgToClone.values()) {
         const organizedByArray = original.findReferencesEx("Organizes", BrowseDirection.Inverse);
 
-        // function dumpRef(r) {
-        //    var referenceTd = addressSpace.findNode(r.referenceTypeId);
-        //    var obj = addressSpace.findNode(r.nodeId);
-        //    return "<-- " + referenceTd.browseName.toString() + " -- " + obj.browseName.toString();
-        // }
-        //
-        // console.log("xxxxx ========================================================",
-        //    originalObject.browseName.toString(),
-        //    organizedByArray.map(dumpRef).join("\n"));
         for (const ref of organizedByArray) {
             const info = extraInfo.mapOrgToClone.get(ref.nodeId.toString());
             if (!info) continue;
@@ -718,7 +754,6 @@ function reconstructFunctionalGroupType(extraInfo: any) {
                 nodeId: cloned.nodeId,
                 referenceType: ref.referenceType
             });
-            // xx console.log("xxx ============> adding reference ",ref.browse )
         }
     }
 }

package/src/ua_view_impl.ts

@@ -34,7 +34,7 @@ export class UAViewImpl extends BaseNodeImpl implements UAView {
 
         switch (attributeId) {
             case AttributeIds.EventNotifier:
-                options.value = { dataType: DataType.UInt32, value: this.eventNotifier };
+                options.value = { dataType: DataType.Byte, value: this.eventNotifier };
                 options.statusCode = StatusCodes.Good;
                 break;
 

package/test_helpers/mock_session.ts

@@ -28,7 +28,7 @@ export class MockContinuationPointManager implements IContinuationPointManager {
 
 export const mockSession = {
     getSessionId() {
-        return NodeId.nullNodeId;
+        return new NodeId();
     },
     continuationPointManager: new MockContinuationPointManager()
 };

package/test_helpers/test_fixtures/fixture_simple_statemachine_nodeset2.xml

@@ -13,6 +13,7 @@
         <Alias Alias="HasTypeDefinition">i=40</Alias>
         <Alias Alias="HasProperty">i=46</Alias>
         <Alias Alias="HasNotifier">i=48</Alias>
+        <Alias Alias="HasEncoding">i=38</Alias>
         <Alias Alias="LocalizedText">i=21</Alias>
     </Aliases>
     <UADataType NodeId="i=6" BrowseName="Int32">
@@ -231,6 +232,23 @@
         </References>
         <InverseName>MayBeEffectedBy</InverseName>
     </UAReferenceType>
+    <UAReferenceType NodeId="i=38" BrowseName="HasEncoding">
+        <DisplayName>HasEncoding</DisplayName>
+        <Description>The type for references from data type nodes to to data type encoding nodes.</Description>
+        <References>
+            <Reference ReferenceType="HasSubtype" IsForward="false">i=32</Reference>
+        </References>
+        <InverseName>EncodingOf</InverseName>
+    </UAReferenceType>
+    <UAReferenceType NodeId="i=17603" BrowseName="HasInterface">
+        <DisplayName>HasInterface</DisplayName>
+        <Documentation>https://reference.opcfoundation.org/v104/Core/docs/Amendment7/11.20</Documentation>
+        <References>
+          <Reference ReferenceType="HasSubtype" IsForward="false">i=32</Reference>
+        </References>
+        <InverseName>InterfaceOf</InverseName>
+     </UAReferenceType>
+
     <UAObjectType NodeId="i=58" BrowseName="BaseObjectType">
         <DisplayName>BaseObjectType</DisplayName>
         <Description>The base type for all object nodes.</Description>

package/test_helpers/test_fixtures/fixuture_nodeset_objects_with_some_methods.xml

@@ -357,6 +357,14 @@
             <Reference ReferenceType="HasSubtype" IsForward="false">i=58</Reference>
         </References>
     </UAObjectType>
-
+    
+    <UAReferenceType NodeId="i=38" BrowseName="HasEncoding">
+        <DisplayName>HasEncoding</DisplayName>
+        <Documentation>https://reference.opcfoundation.org/v104/Core/docs/Part5/11.13</Documentation>
+        <References>
+          <Reference ReferenceType="HasSubtype" IsForward="false">i=32</Reference>
+        </References>
+        <InverseName>EncodingOf</InverseName>
+      </UAReferenceType>
 
 </UANodeSet>

package/test_helpers/test_fixtures/mini.Node.Set2.xml

@@ -442,7 +442,14 @@
         </References>
         <InverseName>HistoricalConfigurationOf</InverseName>
     </UAReferenceType>
-
+    <UAReferenceType NodeId="i=17603" BrowseName="HasInterface">
+        <DisplayName>HasInterface</DisplayName>
+        <Documentation>https://reference.opcfoundation.org/v104/Core/docs/Amendment7/11.20</Documentation>
+        <References>
+          <Reference ReferenceType="HasSubtype" IsForward="false">i=32</Reference>
+        </References>
+        <InverseName>InterfaceOf</InverseName>
+     </UAReferenceType>
 
 
     <UAObjectType NodeId="i=75" BrowseName="DataTypeSystemType">
@@ -4505,4 +4512,18 @@
             <Reference ReferenceType="HasProperty" IsForward="false">i=11646</Reference>
         </References>
     </UAVariable>
+    <UADataType NodeId="i=256" BrowseName="IdType">
+        <DisplayName>IdType</DisplayName>
+        <Documentation>https://reference.opcfoundation.org/v104/Core/docs/Part3/8.2.3</Documentation>
+        <References>
+          <Reference ReferenceType="HasProperty">i=7591</Reference>
+          <Reference ReferenceType="HasSubtype" IsForward="false">i=29</Reference>
+        </References>
+        <Definition Name="IdType">
+          <Field Name="Numeric" Value="0" />
+          <Field Name="String" Value="1" />
+          <Field Name="Guid" Value="2" />
+          <Field Name="Opaque" Value="3" />
+        </Definition>
+      </UADataType>
 </UANodeSet>