node-opcua-address-space 2.181.0 → 2.182.0

package/impl/ua_variable_impl.ts

@@ -283,8 +283,19 @@ export class UAVariableImpl<T extends UAVariableEvents & ListenerSignature<T> =
 
         this.historizing = !!options.historizing; // coerced to boolean"
 
-        // a Variant built from null takes the constructor's short path; the options form costs twice as much
-        this.$dataValue = new DataValue({ statusCode: StatusCodes.UncertainInitialValue, value: new Variant(null) });
+        // a Variant built from null takes the constructor's short path; the options form costs twice as much.
+        // Stamped with the clock of the construction: a variable nobody gives a value to (a nodeset
+        // Variable of an abstract data type has no default to make up) is read as it is, and the
+        // requested timestamps are expected on that Uncertain result too (FEAT-34)
+        const now = getCurrentClock();
+        this.$dataValue = new DataValue({
+            statusCode: StatusCodes.UncertainInitialValue,
+            value: new Variant(null),
+            sourceTimestamp: now.timestamp,
+            sourcePicoseconds: now.picoseconds,
+            serverTimestamp: now.timestamp,
+            serverPicoseconds: now.picoseconds
+        });
 
         if (options.value) {
             this.bindVariable(options.value);
@@ -405,23 +416,27 @@ export class UAVariableImpl<T extends UAVariableEvents & ListenerSignature<T> =
             context = SessionContext.defaultContext;
         }
 
+        // A Bad result the variable makes up here carries the requested timestamps: a
+        // DataValue may carry them whatever its status, and the CTT expects them on every
+        // result of a Read with TimestampsToReturn Source or Both (Attribute Read 037 for
+        // the encoding, Base Info Core Structure 2 001 for the arguments of a method the
+        // nodeset reserves to a role nobody holds, FEAT-34). The clock of the denial is
+        // the honest source timestamp: the value behind it stays undisclosed.
         if (context.isAccessRestricted(this)) {
-            return new DataValue({ statusCode: StatusCodes.BadSecurityModeInsufficient });
+            return makeNowDataValue({ statusCode: StatusCodes.BadSecurityModeInsufficient });
         }
 
         if (!this.isReadable(context)) {
-            return new DataValue({ statusCode: StatusCodes.BadNotReadable });
+            return makeNowDataValue({ statusCode: StatusCodes.BadNotReadable });
         }
         if (!this.checkPermissionPrivate(context, PermissionType.Read)) {
-            return new DataValue({ statusCode: StatusCodes.BadUserAccessDenied });
+            return makeNowDataValue({ statusCode: StatusCodes.BadUserAccessDenied });
         }
         if (!this.isUserReadable(context)) {
-            return new DataValue({ statusCode: StatusCodes.BadNotReadable });
+            return makeNowDataValue({ statusCode: StatusCodes.BadNotReadable });
         }
         if (!isValidDataEncoding(dataEncoding)) {
-            // Table 51: no encoding can be applied to a non-Structure value. The CTT
-            // (Attribute Read 037) still expects the requested timestamps on this Bad
-            // result, and a DataValue may carry them whatever its status.
+            // Table 51: no encoding can be applied to a non-Structure value
             return makeNowDataValue({ statusCode: StatusCodes.BadDataEncodingInvalid });
         }
 
@@ -1307,8 +1322,10 @@ export class UAVariableImpl<T extends UAVariableEvents & ListenerSignature<T> =
 
         let func: (innerCallback: (err: Error | null, dataValue: DataValue) => void) => void;
 
+        // stamped like the same gates of readValue(): the requested timestamps are expected
+        // on a Bad result too (FEAT-34)
         const answerStatusOnly = (statusCode: StatusCode) => (innerCallback: (err: Error | null, dataValue: DataValue) => void) =>
-            innerCallback(null, new DataValue({ statusCode }));
+            innerCallback(null, makeNowDataValue({ statusCode }));
 
         if (context.isAccessRestricted(this)) {
             // same gate as readValue(): a variable bound with a simple get()

package/impl/ua_variable_impl_ext_obj.ts

@@ -484,6 +484,20 @@ function isVariableContainingExtensionObject(uaVariable: UAVariableImpl): boolea
     return true;
 }
 
+/**
+ * the dimensions to iterate an extension object array over. "ArrayDimensions=0" and an absent
+ * ArrayDimensions both mean "one dimension, length unknown", so the length has to come from the
+ * array itself -- but that is a fact about this iteration, not a correction to the node: the
+ * ArrayDimensions attribute is what the nodeset declared and stays that way.
+ */
+function effectiveArrayDimensions(declared: number[] | null | undefined, totalLength: number): number[] {
+    const dimensions = declared ?? [];
+    if (dimensions.length === 0 || dimensions.every((d) => d === 0)) {
+        return [totalLength];
+    }
+    return dimensions;
+}
+
 function _innerBindExtensionObjectScalar(
     uaVariable: UAVariableImpl,
     {
@@ -696,7 +710,11 @@ export function _bindExtensionObjectArrayOrMatrix(
     if (uaVariable.valueRank < 1) {
         throw new Error("Variable must be a MultiDimensional array");
     }
-    const arrayDimensions = uaVariable.arrayDimensions || [];
+    // a copy: the ArrayDimensions attribute of the node is not this function's to change, and the
+    // fallback below writes into this array. Taken by reference, that write rewrote what the
+    // nodeset declared -- a variable that said ArrayDimensions="0" came back saying "1", on the
+    // server as well as in any export
+    const arrayDimensions = [...(uaVariable.arrayDimensions || [])];
     // c8 ignore next
     if (!isVariableContainingExtensionObject(uaVariable)) {
         return [];
@@ -887,8 +905,8 @@ export function extractPartialData(path: string | string[], extensionObject: Ext
 
 export function propagateTouchValueDownwardArray(uaVariable: UAVariableImpl, now: PreciseClock, cache: Set<UAVariable>) {
     if (!uaVariable.$$extensionObjectArray) return;
-    const arrayDimensions = uaVariable.arrayDimensions || [];
     const totalLength = uaVariable.$$extensionObjectArray.length;
+    const arrayDimensions = effectiveArrayDimensions(uaVariable.arrayDimensions, totalLength);
 
     const indexIterator = new IndexIterator(arrayDimensions);
     for (let i = 0; i < totalLength; i++) {

package/impl/ua_variable_type_impl.ts

@@ -2,6 +2,7 @@
  * @module node-opcua-address-space
  */
 import type {
+    AddReferenceOpts,
     AddVariableOptions,
     BaseNode,
     BaseNodeEvents,
@@ -12,6 +13,7 @@ import type {
     UAMethod,
     UAObject,
     UAObjectType,
+    UAReferenceType,
     UAVariable,
     UAVariableType
 } from "node-opcua-address-space-base";
@@ -48,10 +50,47 @@ const errorLog = make_errorLog("ua_variable_type_impl");
 interface InstantiateS {
     propertyOf?: NodeIdLike | UAObject | UAObjectType | UAVariable | UAVariableType | UAMethod;
     componentOf?: NodeIdLike | BaseNode;
+    references?: AddReferenceOpts[];
     modellingRule?: ModellingRuleType;
     copyAlsoModellingRules?: boolean;
     copyAlsoAllOptionals?: boolean;
 }
+
+/**
+ * the parent given through `options.references` as an inverse aggregate
+ * reference (HasOrderedComponent, HasPhysicalComponent ...), if any.
+ * See InstantiateOptions.references.
+ */
+export function findAggregateParentInReferences(
+    addressSpace: AddressSpacePrivate,
+    references: AddReferenceOpts[] | undefined
+): BaseNode | null {
+    if (!references || references.length === 0) {
+        return null;
+    }
+    const aggregates = addressSpace.findReferenceType("Aggregates");
+    if (!aggregates) {
+        return null;
+    }
+    for (const ref of references) {
+        if (ref.isForward !== false) {
+            continue;
+        }
+        const referenceType =
+            typeof ref.referenceType === "object" && "nodeClass" in (ref.referenceType as object)
+                ? (ref.referenceType as UAReferenceType)
+                : addressSpace.findReferenceType(ref.referenceType as NodeIdLike);
+        if (!referenceType?.isSubtypeOf(aggregates)) {
+            continue;
+        }
+        const parent = addressSpace._coerceNode(ref.nodeId as BaseNode | NodeIdLike);
+        if (parent) {
+            return parent;
+        }
+    }
+    return null;
+}
+
 export function topMostParentIsObjectTypeOrVariableType(addressSpace: AddressSpacePrivate, options: InstantiateS): boolean {
     if (options.copyAlsoModellingRules) {
         return true;
@@ -60,7 +99,7 @@ export function topMostParentIsObjectTypeOrVariableType(addressSpace: AddressSpa
         return true;
     }
 
-    const parent = options.propertyOf || options.componentOf;
+    const parent = options.propertyOf || options.componentOf || findAggregateParentInReferences(addressSpace, options.references);
     if (!parent) {
         return false;
     }
@@ -127,7 +166,7 @@ export class UAVariableTypeImpl extends BaseNodeImpl<BaseNodeEvents> implements
     public arrayDimensions: UInt32[] | null;
     public readonly minimumSamplingInterval: number;
     // declare-only: an emitted field would hide, on a type without a default value, a child named Value
-    public declare readonly value: unknown;
+    declare public readonly value: unknown;
     public historizing: boolean;
 
     constructor(options: UAVariableTypeOptions) {
@@ -292,6 +331,9 @@ export class UAVariableTypeImpl extends BaseNodeImpl<BaseNodeEvents> implements
             nodeId: options.nodeId,
             notifierOf: options.notifierOf,
             organizedBy: options.organizedBy,
+            // see InstantiateOptions.references: created with the node so the
+            // NodeIdManager derives the symbolic name from that parent
+            references: options.references,
             typeDefinition: this.nodeId,
             value: options.value || defaultValue,
             valueRank
@@ -353,7 +395,11 @@ function hasChildWithBrowseName(parent: BaseNode, childBrowseName: QualifiedName
 }
 
 function getParent(addressSpace: IAddressSpace, options: InstantiateVariableOptions) {
-    const parent = options.componentOf || options.organizedBy;
+    const parent =
+        options.componentOf ||
+        options.organizedBy ||
+        findAggregateParentInReferences(addressSpace as AddressSpacePrivate, options.references) ||
+        undefined;
     if (parent instanceof NodeId) {
         return addressSpace.findNode(parent as NodeId);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.181.0",
+    "version": "2.182.0",
     "description": "pure nodejs OPCUA SDK - module address-space",
     "main": "./dist/api/index.js",
     "types": "./dist/api/index.d.ts",
@@ -10,6 +10,7 @@
     "scripts": {
         "build": "tsc -b",
         "test": "mocha",
+        "test:long": "mocha --spec \"test_long/**/*.ts\" --timeout 900000",
         "test:check": "tsc --noEmit -p test/tsconfig.json",
         "lint": "biome check --no-errors-on-unmatched .",
         "format": "biome check --write --no-errors-on-unmatched .",
@@ -21,36 +22,36 @@
         "@types/semver": "7.8.0",
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
-        "node-opcua-address-space-base": "2.181.0",
+        "node-opcua-address-space-base": "2.182.0",
         "node-opcua-assert": "2.179.0",
-        "node-opcua-basic-types": "2.181.0",
+        "node-opcua-basic-types": "2.182.0",
         "node-opcua-binary-stream": "2.181.0",
-        "node-opcua-client-dynamic-extension-object": "2.181.0",
+        "node-opcua-client-dynamic-extension-object": "2.182.0",
         "node-opcua-constants": "2.181.0",
         "node-opcua-crypto": "5.10.1",
-        "node-opcua-data-access": "2.181.0",
-        "node-opcua-data-model": "2.181.0",
-        "node-opcua-data-value": "2.181.0",
+        "node-opcua-data-access": "2.182.0",
+        "node-opcua-data-model": "2.182.0",
+        "node-opcua-data-value": "2.182.0",
         "node-opcua-date-time": "2.181.0",
         "node-opcua-debug": "2.181.0",
         "node-opcua-enum": "2.181.0",
-        "node-opcua-extension-object": "2.181.0",
-        "node-opcua-factory": "2.181.0",
-        "node-opcua-nodeid": "2.181.0",
-        "node-opcua-nodeset-ua": "2.181.0",
-        "node-opcua-numeric-range": "2.181.0",
+        "node-opcua-extension-object": "2.182.0",
+        "node-opcua-factory": "2.182.0",
+        "node-opcua-nodeid": "2.182.0",
+        "node-opcua-nodeset-ua": "2.182.0",
+        "node-opcua-numeric-range": "2.182.0",
         "node-opcua-object-registry": "2.181.0",
-        "node-opcua-pseudo-session": "2.181.0",
-        "node-opcua-service-browse": "2.181.0",
-        "node-opcua-service-call": "2.181.0",
-        "node-opcua-service-history": "2.181.0",
-        "node-opcua-service-translate-browse-path": "2.181.0",
-        "node-opcua-service-write": "2.181.0",
+        "node-opcua-pseudo-session": "2.182.0",
+        "node-opcua-service-browse": "2.182.0",
+        "node-opcua-service-call": "2.182.0",
+        "node-opcua-service-history": "2.182.0",
+        "node-opcua-service-translate-browse-path": "2.182.0",
+        "node-opcua-service-write": "2.182.0",
         "node-opcua-status-code": "2.181.0",
-        "node-opcua-types": "2.181.0",
+        "node-opcua-types": "2.182.0",
         "node-opcua-utils": "2.181.0",
-        "node-opcua-variant": "2.181.0",
-        "node-opcua-xml2json": "2.181.0",
+        "node-opcua-variant": "2.182.0",
+        "node-opcua-xml2json": "2.182.0",
         "semver": "^7.8.5",
         "thenify-ex": "4.4.0",
         "xml-writer": "^1.7.0"
@@ -59,10 +60,10 @@
         "humanize": "0.0.9",
         "node-opcua-benchmarker": "2.181.0",
         "node-opcua-leak-detector": "2.181.0",
-        "node-opcua-nodesets": "2.181.0",
-        "node-opcua-packet-analyzer": "2.181.0",
-        "node-opcua-schemas": "2.181.0",
-        "node-opcua-service-filter": "2.181.0",
+        "node-opcua-nodesets": "2.182.0",
+        "node-opcua-packet-analyzer": "2.182.0",
+        "node-opcua-schemas": "2.182.0",
+        "node-opcua-service-filter": "2.182.0",
         "node-opcua-test-fixtures": "2.181.0",
         "node-opcua-test-helpers": "2.181.0"
     },
@@ -81,7 +82,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "f8f472c59e681b2aa18ae1533c3d1e5f17614c5c",
+    "gitHead": "7172ac8333d34505a72221e8f56e8708c2c96bd7",
     "files": [
         "dist",
         "distHelpers",
@@ -97,6 +98,7 @@
         "bin"
     ],
     "bin": {
-        "opcua-nodeset-image": "bin/opcua-nodeset-image.js"
+        "opcua-nodeset-image": "bin/opcua-nodeset-image.js",
+        "opcua-nodeset-live": "bin/opcua-nodeset-live.js"
     }
 }

package/source_nodejs/generate_address_space.ts

@@ -1,7 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
 import { promisify } from "node:util";
-import zlib, { gunzip } from "node:zlib";
+import zlib, { gunzip, gzip as gzipCb } from "node:zlib";
 import type { IAddressSpace } from "node-opcua-address-space-base";
 import { checkDebugFlag, make_debugLog, make_errorLog } from "node-opcua-debug";
 import {
@@ -13,6 +13,7 @@ import {
     nodesetImageProblem,
     nodesetToImage as nodesetToImageRaw,
     readNodesetImageInfo,
+    setImageDeflater,
     setImageInflater,
     sha256Hex
 } from "../dist/api/index.js";
@@ -23,6 +24,11 @@ import { FileNodesetImageStore } from "./nodeset_image_file_store.js";
 const gunzipAsync = promisify(gunzip);
 setImageInflater(async (image) => (await gunzipAsync(image)).toString("utf8"));
 
+// and out through zlib at level 9: CompressionStream has no level to ask for, and an image is
+// written once and read many times, so the extra work at build time is free at load time
+const gzipAsync = promisify(gzipCb);
+setImageDeflater(async (text) => new Uint8Array(await gzipAsync(Buffer.from(text, "utf8"), { level: 9 })));
+
 const _doDebug = checkDebugFlag("generate_address_space");
 const debugLog = make_debugLog("generate_address_space");
 const errorLog = make_errorLog("generate_address_space");