node-opcua-address-space 2.102.0 → 2.103.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.102.0",
+    "version": "2.103.0",
     "description": "pure nodejs OPCUA SDK - module address-space",
     "main": "./dist/src/index_current.js",
     "types": "./dist/source/index.d.ts",
@@ -22,14 +22,14 @@
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
         "lodash": "4.17.21",
-        "node-opcua-address-space-base": "2.102.0",
+        "node-opcua-address-space-base": "2.103.0",
         "node-opcua-assert": "2.98.1",
         "node-opcua-basic-types": "2.99.0",
         "node-opcua-binary-stream": "2.98.1",
-        "node-opcua-client-dynamic-extension-object": "2.102.0",
+        "node-opcua-client-dynamic-extension-object": "2.103.0",
         "node-opcua-constants": "2.98.1",
         "node-opcua-crypto": "^2.1.2",
-        "node-opcua-data-access": "2.102.0",
+        "node-opcua-data-access": "2.103.0",
         "node-opcua-data-model": "2.102.0",
         "node-opcua-data-value": "2.102.0",
         "node-opcua-date-time": "2.99.0",
@@ -38,20 +38,20 @@
         "node-opcua-extension-object": "2.99.0",
         "node-opcua-factory": "2.99.0",
         "node-opcua-nodeid": "2.99.0",
-        "node-opcua-nodeset-ua": "2.102.0",
+        "node-opcua-nodeset-ua": "2.103.0",
         "node-opcua-numeric-range": "2.102.0",
         "node-opcua-object-registry": "2.99.0",
-        "node-opcua-pseudo-session": "2.102.0",
-        "node-opcua-service-browse": "2.102.0",
-        "node-opcua-service-call": "2.102.0",
-        "node-opcua-service-history": "2.102.0",
-        "node-opcua-service-translate-browse-path": "2.102.0",
-        "node-opcua-service-write": "2.102.0",
+        "node-opcua-pseudo-session": "2.103.0",
+        "node-opcua-service-browse": "2.103.0",
+        "node-opcua-service-call": "2.103.0",
+        "node-opcua-service-history": "2.103.0",
+        "node-opcua-service-translate-browse-path": "2.103.0",
+        "node-opcua-service-write": "2.103.0",
         "node-opcua-status-code": "2.98.1",
-        "node-opcua-types": "2.102.0",
+        "node-opcua-types": "2.103.0",
         "node-opcua-utils": "2.98.1",
         "node-opcua-variant": "2.102.0",
-        "node-opcua-xml2json": "2.99.0",
+        "node-opcua-xml2json": "2.103.0",
         "semver": "^7.3.8",
         "set-prototype-of": "^1.0.0",
         "thenify": "^3.3.1",
@@ -61,10 +61,10 @@
         "mocha": "^10.2.0",
         "node-opcua-benchmarker": "2.98.1",
         "node-opcua-leak-detector": "2.99.0",
-        "node-opcua-nodesets": "2.99.0",
+        "node-opcua-nodesets": "2.103.0",
         "node-opcua-packet-analyzer": "2.102.0",
-        "node-opcua-service-filter": "2.102.0",
-        "node-opcua-test-fixtures": "2.102.0",
+        "node-opcua-service-filter": "2.103.0",
+        "node-opcua-test-fixtures": "2.103.0",
         "should": "^13.2.3",
         "sinon": "^15.0.3",
         "source-map-support": "^0.5.21"
@@ -84,7 +84,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "07dcdd8e8c7f2b55544c6e23023093e35674829c",
+    "gitHead": "e206cac2daf39bd07e5ac6cbd744f966bb54759e",
     "files": [
         "dist",
         "distHelpers",

package/source/namespace_data_access.ts

@@ -1,4 +1,9 @@
-import { AddVariableOptionsWithoutValue, AddYArrayItemOptions, BindVariableOptions, UADataType } from "node-opcua-address-space-base";
+import {
+    AddVariableOptionsWithoutValue,
+    AddYArrayItemOptions,
+    BindVariableOptions,
+    UADataType
+} from "node-opcua-address-space-base";
 import { NodeIdLike } from "node-opcua-nodeid";
 import { UAAnalogItem, UADataItem } from "node-opcua-nodeset-ua";
 import { EUInformation, EUInformationOptions } from "node-opcua-types";
@@ -40,11 +45,31 @@ export interface AddAnalogDataItemOptions extends AddDataItemOptions {
     engineeringUnits?: EUInformationOptions | EUInformation;
     minimumSamplingInterval?: number;
     dataType?: string | NodeIdLike | UADataType;
+
+    /**
+     * the acceptValueOutOfRange property indicates whether the write operation will accept or reject a value which
+     * is out of range of the instrumentRange.
+     * 
+     * **if true**: during a writeOperation by a client if the dataValue that is outside of the instrumentRange
+     * it will be recorded database and the statusCode will be set to BadOutOfRange, and
+     * the write operation will return Good. If the variable supports historizing, the value will be recorded in the history database.
+     * as well.
+     *
+     * **if false**: during a writeOperation by a client, if the dataValue that is outside of the instrumentRange
+     * it will be denied and the write operation will return BadOutOfRange.
+     *
+     * @default undefined (false)
+     *
+     */
+    acceptValueOutOfRange?: boolean;
 }
 
+export interface UAAnalogItemEx<T, DT extends DataType> extends UAAnalogItem<T, DT> {
+    acceptValueOutOfRange?: boolean;
+}
 export interface INamespaceDataAccess {
     addDataItem<T, DT extends DataType>(options: AddDataItemOptions): UADataItem<T, DT>;
-    addAnalogDataItem<T, DT extends DataType>(options: AddAnalogDataItemOptions): UAAnalogItem<T, DT>;
+    addAnalogDataItem<T, DT extends DataType>(options: AddAnalogDataItemOptions): UAAnalogItemEx<T, DT>;
 
     addYArrayItem<DT extends DataType.Double | DataType.Float>(options: AddYArrayItemOptions): UAYArrayItemEx<DT>;
 

package/source/pseudo_session.ts

@@ -352,11 +352,19 @@ export class PseudoSession implements IBasicSession {
                 if (!obj) {
                     return StatusCodes.BadNodeIdUnknown;
                 }
-                return promisify(obj.writeAttribute).call(obj, context, nodeToWrite);
-            });
-            Promise.all(statusCodesPromises).then((statusCodes) => {
-                callback!(null, isArray ? statusCodes : statusCodes[0]);
+                try {
+                    return promisify(obj.writeAttribute).call(obj, context, nodeToWrite);
+                } catch (err) {
+                    return StatusCodes.BadInternalError;
+                }
             });
+            Promise.all(statusCodesPromises)
+                .then((statusCodes) => {
+                    callback!(null, isArray ? statusCodes : statusCodes[0]);
+                })
+                .catch((err) => {
+                    callback!(err);
+                });
         });
     }
 }

package/source/session_context.ts

@@ -305,6 +305,7 @@ export class SessionContext implements ISessionContext {
                 return true;
             }
         }
+        if (!this.session ) { return false; }
         const securityMode = this.session?.channel?.securityMode;
         if (accessRestrictions & AccessRestrictionsFlag.SigningRequired) {
             if (securityMode !== MessageSecurityMode.Sign && securityMode !== MessageSecurityMode.SignAndEncrypt) {

package/src/data_access/adjust_datavalue_status_code.ts

@@ -0,0 +1,36 @@
+/**
+ * @module node-opcua-address-space.DataAccess
+ */
+import { StatusCodes } from "node-opcua-status-code";
+import { StatusCode } from "node-opcua-status-code";
+import { Range } from "node-opcua-types";
+import { UAVariable } from "node-opcua-address-space-base";
+import { NodeClass } from "node-opcua-data-model";
+import { DataValue } from "node-opcua-data-value";
+import { Variant } from "node-opcua-variant";
+import { UAVariableImpl } from "../ua_variable_impl";
+
+function validate_value_range(range: Range, variant: Variant) {
+    if (variant.value < range.low || variant.value > range.high) {
+        return false;
+    }
+    return true;
+}
+
+export function adjustDataValueStatusCode(
+    variable: UAVariableImpl,
+    dataValue: DataValue,
+    acceptValueOutOfRange: boolean
+): StatusCode {
+    const instrumentRange = variable.getChildByName("InstrumentRange") as UAVariable | null;
+    if (instrumentRange && instrumentRange.nodeClass === NodeClass.Variable) {
+        if (!validate_value_range(instrumentRange.readValue().value.value as Range, dataValue.value)) {
+            if (!acceptValueOutOfRange) {
+                return StatusCodes.BadOutOfRange;
+            } else {
+                dataValue.statusCode = StatusCodes.BadOutOfRange;
+            }
+        }
+    }
+    return StatusCodes.Good;
+}

package/src/index_current.ts

@@ -43,7 +43,7 @@ export { adjustNamespaceArray } from "./nodeset_tools/adjust_namespace_array";
 export { makeAttributeEventName } from "./base_node_impl";
 export { resolveReferenceNode, resolveReferenceType } from "./reference_impl";
 
-export * from "./data_access/check_variant_compatibility_ua_analog_item";
+export * from "./data_access/adjust_datavalue_status_code";
 export * from "./data_access/add_dataItem_stuff";
 export * from "./data_access/ua_multistate_discrete_impl";
 export * from "./data_access/ua_multistate_value_discrete_impl";

package/src/namespace_impl.ts

@@ -76,7 +76,7 @@ import {
     UATwoStateDiscreteEx,
     UAYArrayItemEx
 } from "../source";
-import { AddAnalogDataItemOptions, AddDataItemOptions } from "../source/namespace_data_access";
+import { AddAnalogDataItemOptions, AddDataItemOptions, UAAnalogItemEx } from "../source/namespace_data_access";
 import { UATwoStateVariableEx } from "../source/ua_two_state_variable_ex";
 import { UAMultiStateValueDiscreteEx } from "../source/interfaces/data_access/ua_multistate_value_discrete_ex";
 import { UAAlarmConditionEx } from "../source/interfaces/alarms_and_conditions/ua_alarm_condition_ex";
@@ -125,7 +125,6 @@ import { UAViewImpl } from "./ua_view_impl";
 import { UAStateMachineImpl, UATransitionImpl } from "./state_machine/finite_state_machine";
 import { _addMultiStateValueDiscrete } from "./data_access/ua_multistate_value_discrete_impl";
 
-
 function _makeHashKey(nodeId: NodeId): string | number {
     switch (nodeId.identifierType) {
         case NodeIdType.STRING:
@@ -931,6 +930,7 @@ export class NamespaceImpl implements NamespacePrivate {
 
             instrumentRange.on("value_changed", handler);
         }
+        (variable as any).acceptValueOutOfRange = options.acceptValueOutOfRange;
 
         if (Object.prototype.hasOwnProperty.call(options, "engineeringUnits")) {
             const engineeringUnits = new EUInformation(options.engineeringUnits);
@@ -1445,7 +1445,7 @@ export class NamespaceImpl implements NamespacePrivate {
         const _component = component as UAStateMachineImpl;
 
         assert(_component.nodeClass === NodeClass.Object || _component.nodeClass === NodeClass.ObjectType);
-      
+
         const initialStateType = addressSpace.findObjectType("InitialStateType")!;
         const stateType = addressSpace.findObjectType("StateType")!;
 
@@ -1662,24 +1662,24 @@ export class NamespaceImpl implements NamespacePrivate {
 
         // istanbul ignore next
         if (this._nodeid_index.has(hashKey)) {
-
             const exstingNode = this.findNode(node.nodeId)!;
             throw new Error(
                 "node " +
-                node.browseName.toString() +
-                " nodeId = " +
-                node.nodeId.displayText() +
-                " already registered " +
-                node.nodeId.toString() +
-                "\n" +
-                " in namespace " +
-                this.namespaceUri +
-                " index = " +
-                this.index +
-                "\n" +
-                "existing node = " +
-                exstingNode.toString() +
-                "this parent : " + node.parentNodeId?.toString()
+                    node.browseName.toString() +
+                    " nodeId = " +
+                    node.nodeId.displayText() +
+                    " already registered " +
+                    node.nodeId.toString() +
+                    "\n" +
+                    " in namespace " +
+                    this.namespaceUri +
+                    " index = " +
+                    this.index +
+                    "\n" +
+                    "existing node = " +
+                    exstingNode.toString() +
+                    "this parent : " +
+                    node.parentNodeId?.toString()
             );
         }
 
@@ -1742,15 +1742,15 @@ export class NamespaceImpl implements NamespacePrivate {
                     errorLog(
                         chalk.red.bold(
                             "Error: namespace index used at the front of the browseName " +
-                            indexVerif +
-                            " do not match the index of the current namespace (" +
-                            this.index +
-                            ")"
+                                indexVerif +
+                                " do not match the index of the current namespace (" +
+                                this.index +
+                                ")"
                         )
                     );
                     errorLog(
                         " Please fix your code so that the created node is inserted in the correct namespace," +
-                        " please refer to the NodeOPCUA documentation"
+                            " please refer to the NodeOPCUA documentation"
                     );
                 }
             }
@@ -1990,13 +1990,16 @@ export class NamespaceImpl implements NamespacePrivate {
 
         // -----------------------------------------------------
         const hasGetter = (options: AddVariableOptions2) => {
-            return typeof options.value?.get === "function" || typeof options.value?.timestamped_get === "function"
-        }
+            return typeof options.value?.get === "function" || typeof options.value?.timestamped_get === "function";
+        };
 
         // istanbul ignore next
         if (options.minimumSamplingInterval === undefined && hasGetter(options)) {
             // a getter has been specified and no options.minimumSamplingInterval has been specified
-            warningLog("[NODE-OPCUA-W30", "namespace#addVariable a getter has been specified and minimumSamplingInterval is missing.\nMinimumSamplingInterval has been adjusted to 1000 ms");
+            warningLog(
+                "[NODE-OPCUA-W30",
+                "namespace#addVariable a getter has been specified and minimumSamplingInterval is missing.\nMinimumSamplingInterval has been adjusted to 1000 ms"
+            );
             options.minimumSamplingInterval = 1000;
         }
 
@@ -2004,7 +2007,10 @@ export class NamespaceImpl implements NamespacePrivate {
 
         // istanbul ignore next
         if (options.minimumSamplingInterval === 0 && hasGetter(options)) {
-            warningLog("[NODE-OPCUA-W31", "namespace#addVariable a getter has been specified and minimumSamplingInterval is 0.\nThis may conduct to an unpredicable behavior.\nPlease specify a non zero minimum sampling interval")
+            warningLog(
+                "[NODE-OPCUA-W31",
+                "namespace#addVariable a getter has been specified and minimumSamplingInterval is 0.\nThis may conduct to an unpredicable behavior.\nPlease specify a non zero minimum sampling interval"
+            );
         }
 
         let references = options.references || ([] as AddReferenceOpts[]);
@@ -2209,15 +2215,15 @@ export function isNonEmptyQualifiedName(browseName?: null | string | QualifiedNa
     return browseName.name!.length > 0;
 }
 
-function _create_node_version_if_needed(node: BaseNode, options: {nodeVersion: boolean}) {
+function _create_node_version_if_needed(node: BaseNode, options: { nodeVersion: boolean }) {
     assert(options);
     if (options.nodeVersion) {
         assert(node.nodeClass === NodeClass.Variable || node.nodeClass === NodeClass.Object);
         // istanbul ignore next
-        if (node.getChildByName("NodeVersion"))  {
+        if (node.getChildByName("NodeVersion")) {
             return; // already exists
         }
-        const namespace  = node.addressSpace.getOwnNamespace();
+        const namespace = node.addressSpace.getOwnNamespace();
         const nodeVersion = namespace.addVariable({
             browseName: "NodeVersion",
             dataType: "String",

package/src/ua_variable_impl.ts

@@ -96,6 +96,7 @@ import {
     _installExtensionObjectBindingOnProperties,
     _touchValue
 } from "./ua_variable_impl_ext_obj";
+import { adjustDataValueStatusCode } from "./data_access/adjust_datavalue_status_code";
 
 const debugLog = make_debugLog(__filename);
 const warningLog = make_warningLog(__filename);
@@ -849,7 +850,7 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
                 // ----------------------------------
                 if (this.$extensionObject || this.$$extensionObjectArray) {
                     // we have an extension object already bound to this node
-                    // the client is asking us to replace the object entierly by a new one
+                    // the client is asking us to replace the object entirely by a new one
                     // const ext = dataValue.value.value;
                     this._internal_set_dataValue(dataValue);
                     return;
@@ -867,6 +868,11 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
         }
     }
 
+    private adjustDataValueStatusCode(dataValue: DataValue): StatusCode {
+        const statusCode = adjustDataValueStatusCode(this, dataValue, (this as any).acceptValueOutOfRange || false);
+        return statusCode;
+    }
+
     public writeValue(
         context: ISessionContext,
         dataValue: DataValue,
@@ -939,6 +945,12 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
             return callback!(null, statusCode);
         }
 
+        // adjust dataValue.statusCode based on InstrumentRange and EngineeringUnits
+        const statusCode2 = this.adjustDataValueStatusCode(dataValue);
+        if (statusCode2.isNotGood()) {
+            return callback!(null, statusCode2);
+        }
+
         const write_func = this._timestamped_set_func || default_func;
 
         if (!write_func) {
@@ -1281,7 +1293,7 @@ export class UAVariableImpl extends BaseNodeImpl implements UAVariable {
 
         const readImmediate = (innerCallback: (err: Error | null, dataValue: DataValue) => void) => {
             assert(this.$dataValue instanceof DataValue);
-            const dataValue = this.readValue();
+            const dataValue = this.readValue(context);
             innerCallback(null, dataValue);
         };
 
@@ -2046,10 +2058,14 @@ function _default_writable_timestamped_set_func(
 function turn_sync_to_async<T, D, R>(f: (this: T, data: D) => R, numberOfArgs: number) {
     if (f.length <= numberOfArgs) {
         return function (this: T, data: D, callback: (err: Error | null, r?: R) => void) {
-            const r = f.call(this, data);
-            setImmediate(() => {
-                return callback(null, r);
-            });
+            try {
+                const r = f.call(this, data);
+                setImmediate(() => {
+                    return callback(null, r);
+                });
+            } catch (err) {
+                return callback(err as Error);
+            }
         };
     } else {
         assert(f.length === numberOfArgs + 1);
@@ -2209,6 +2225,10 @@ function _Variable_bind_with_simple_set(this: UAVariableImpl, options: any) {
                 errorLog(chalk.yellow("StatusCode.Good is assumed"));
                 return callback(err, StatusCodes.Good, timestamped_value);
             }
+            if (statusCode && statusCode.isNotGood()) {
+                // record the value but still record the statusCode !
+                timestamped_value.statusCode = statusCode;
+            }
             callback(err, statusCode, timestamped_value);
         });
     };

package/src/data_access/check_variant_compatibility_ua_analog_item.ts

@@ -1,38 +0,0 @@
-/**
- * @module node-opcua-address-space.DataAccess
- */
-import { assert } from "node-opcua-assert";
-import { UAAnalogItem } from "node-opcua-nodeset-ua";
-import { StatusCodes } from "node-opcua-status-code";
-import { StatusCode } from "node-opcua-status-code";
-import { Range } from "node-opcua-types";
-import { DataType, Variant } from "node-opcua-variant";
-import { UAVariableImpl } from "../ua_variable_impl";
-
-function validate_value_range(range: Range, variant: Variant) {
-    if (variant.value < range.low || variant.value > range.high) {
-        return false;
-    }
-    return true;
-}
-
-function checkVariantCompatibilityUAAnalogItem(this: UAVariableImpl, value: Variant): StatusCode {
-    assert(value instanceof Variant);
-    // test dataType
-    if (!this._validate_DataType(value.dataType)) {
-        return StatusCodes.BadTypeMismatch;
-    }
-    const analogItem = this as unknown as UAAnalogItem<any, any>;
-    // AnalogDataItem
-    if (analogItem.instrumentRange) {
-        if (!validate_value_range(analogItem.instrumentRange.readValue().value.value as Range, value)) {
-            return StatusCodes.BadOutOfRange;
-        }
-    }
-    return StatusCodes.Good;
-}
-
-/**
- * extend default checkVariantCompatibility on base class with this one
- */
-UAVariableImpl.prototype.checkVariantCompatibility = checkVariantCompatibilityUAAnalogItem;