node-opcua-server 2.53.0 → 2.56.1

package/source/base_server.ts

@@ -2,11 +2,11 @@
  * @module node-opcua-server
  */
 // tslint:disable:no-console
-import * as async from "async";
-import * as chalk from "chalk";
 import * as fs from "fs";
 import * as path from "path";
 import * as os from "os";
+import * as async from "async";
+import * as chalk from "chalk";
 import { withLock } from "@ster5/global-mutex";
 import { assert } from "node-opcua-assert";
 import {
@@ -31,10 +31,10 @@ import { ApplicationDescriptionOptions } from "node-opcua-types";
 import { EndpointDescription, GetEndpointsRequest } from "node-opcua-types";
 import { matchUri } from "node-opcua-utils";
 
+import { performCertificateSanityCheck } from "node-opcua-client";
 import { OPCUAServerEndPoint } from "./server_end_point";
 import { IChannelData } from "./i_channel_data";
 import { ISocketData } from "./i_socket_data";
-import { performCertificateSanityCheck } from "node-opcua-client";
 
 const doDebug = checkDebugFlag(__filename);
 const debugLog = make_debugLog(__filename);
@@ -175,9 +175,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
 
         const __applicationUri = serverInfo.applicationUri || "";
 
-        (this.serverInfo as any).__defineGetter__("applicationUri", function (this: any) {
-            return resolveFullyQualifiedDomainName(__applicationUri);
-        });
+        (this.serverInfo as any).__defineGetter__("applicationUri", () => resolveFullyQualifiedDomainName(__applicationUri));
 
         this._preInitTask.push(async () => {
             const fqdn = await extractFullyQualifiedDomainName();
@@ -188,7 +186,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
         });
     }
 
-    protected async createDefaultCertificate() {
+    protected async createDefaultCertificate(): Promise<void> {
         if (fs.existsSync(this.certificateFile)) {
             return;
         }
@@ -225,7 +223,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
      * @async
      * @param {callback} done
      */
-    public start(done: (err?: Error | null) => void) {
+    public start(done: (err?: Error | null) => void): void {
         assert(typeof done === "function");
         this.startAsync()
             .then(() => done(null))
@@ -243,22 +241,22 @@ export class OPCUABaseServer extends OPCUASecureObject {
     protected async startAsync(): Promise<void> {
         await this.performPreInitialization();
 
-        const self = this;
         assert(Array.isArray(this.endpoints));
         assert(this.endpoints.length > 0, "We need at least one end point");
 
         installPeriodicClockAdjustment();
-
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const server = this;
         const _on_new_channel = function (this: OPCUAServerEndPoint, channel: ServerSecureChannelLayer) {
-            self.emit("newChannel", channel, this);
+            server.emit("newChannel", channel, this);
         };
 
         const _on_close_channel = function (this: OPCUAServerEndPoint, channel: ServerSecureChannelLayer) {
-            self.emit("closeChannel", channel, this);
+            server.emit("closeChannel", channel, this);
         };
 
         const _on_connectionRefused = function (this: OPCUAServerEndPoint, socketData: ISocketData) {
-            self.emit("connectionRefused", socketData, this);
+            server.emit("connectionRefused", socketData, this);
         };
 
         const _on_openSecureChannelFailure = function (
@@ -266,7 +264,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
             socketData: ISocketData,
             channelData: IChannelData
         ) {
-            self.emit("openSecureChannelFailure", socketData, channelData, this);
+            server.emit("openSecureChannelFailure", socketData, channelData, this);
         };
 
         const promises: Promise<void>[] = [];
@@ -295,7 +293,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
      * shutdown all server endPoints
      * @async
      */
-    public shutdown(done: (err?: Error) => void) {
+    public shutdown(done: (err?: Error) => void): void {
         assert(typeof done === "function");
         uninstallPeriodicClockAdjustment();
         this.serverCertificateManager.dispose().then(() => {
@@ -346,7 +344,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
     /**
      * @private
      */
-    public on_request(message: Message, channel: ServerSecureChannelLayer) {
+    public on_request(message: Message, channel: ServerSecureChannelLayer): void {
         assert(message.request);
         assert(message.requestId !== 0);
         const request = message.request;
@@ -378,6 +376,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
             // handler must be named _on_ActionRequest()
             const handler = (this as any)["_on_" + request.schema.name];
             if (typeof handler === "function") {
+                // eslint-disable-next-line prefer-rest-params
                 handler.apply(this, arguments);
             } else {
                 errMessage = "[NODE-OPCUA-W07] Unsupported Service : " + request.schema.name;
@@ -497,15 +496,14 @@ export class OPCUABaseServer extends OPCUASecureObject {
     /**
      * @private
      */
-    protected _on_GetEndpointsRequest(message: Message, channel: ServerSecureChannelLayer) {
-        const server = this;
+    protected _on_GetEndpointsRequest(message: Message, channel: ServerSecureChannelLayer): void {
         const request = message.request as GetEndpointsRequest;
 
         assert(request.schema.name === "GetEndpointsRequest");
 
         const response = new GetEndpointsResponse({});
 
-        response.endpoints = server._get_endpoints(null);
+        response.endpoints = this._get_endpoints(null);
 
         response.endpoints = response.endpoints.filter((endpoint: EndpointDescription) => !(endpoint as any).restricted);
 
@@ -529,8 +527,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
     /**
      * @private
      */
-    protected _on_FindServersRequest(message: Message, channel: ServerSecureChannelLayer) {
-        const server = this;
+    protected _on_FindServersRequest(message: Message, channel: ServerSecureChannelLayer): void {
         // Release 1.02  13  OPC Unified Architecture, Part 4 :
         //   This  Service  can be used without security and it is therefore vulnerable to Denial Of Service (DOS)
         //   attacks. A  Server  should minimize the amount of processing required to send the response for this
@@ -545,7 +542,7 @@ export class OPCUABaseServer extends OPCUASecureObject {
                 throw new Error("Invalid request type");
             }
 
-            let servers = server.getServers(channel);
+            let servers = this.getServers(channel);
             // apply filters
             // TODO /
             if (request.serverUris && request.serverUris.length > 0) {

package/source/factory.ts

@@ -7,10 +7,13 @@ import { ExtensionObject } from "node-opcua-extension-object";
 import { constructObject } from "node-opcua-factory";
 import { ExpandedNodeId } from "node-opcua-nodeid";
 
+export interface EngineForFactory {
+    /** */
+}
 export class Factory {
-    public engine: any;
+    public engine: EngineForFactory;
 
-    constructor(engine: any) {
+    constructor(engine: EngineForFactory) {
         assert(engine !== null && typeof engine === "object");
         this.engine = engine;
     }

package/source/history_server_capabilities.ts

@@ -11,7 +11,7 @@ export interface HistoryServerCapabilitiesOptions {
     insertDataCapability?: boolean;
     replaceDataCapability?: boolean;
     updateDataCapability?: boolean;
-    deleteRawCapability ?: boolean;
+    deleteRawCapability?: boolean;
     deleteAtTimeCapability?: boolean;
     insertEventCapability?: boolean;
     replaceEventCapability?: boolean;
@@ -22,7 +22,6 @@ export interface HistoryServerCapabilitiesOptions {
 /**
  */
 export class HistoryServerCapabilities {
-
     public accessHistoryDataCapability: boolean;
     public accessHistoryEventsCapability: boolean;
     public maxReturnDataValues: number;
@@ -41,7 +40,7 @@ export class HistoryServerCapabilities {
     constructor(options?: HistoryServerCapabilitiesOptions) {
         options = options || {};
 
-        function coerceBool(value: boolean | undefined , defaultValue: boolean): boolean {
+        function coerceBool(value: boolean | undefined, defaultValue: boolean): boolean {
             if (undefined === value) {
                 return defaultValue;
             }
@@ -49,7 +48,7 @@ export class HistoryServerCapabilities {
             return value as boolean;
         }
 
-        function coerceUInt32(value: number| undefined, defaultValue: number): number {
+        function coerceUInt32(value: number | undefined, defaultValue: number): number {
             if (undefined === value) {
                 return defaultValue;
             }

package/source/i_channel_data.ts

@@ -1,15 +1,11 @@
-import { 
-    AsymmetricAlgorithmSecurityHeader,
-    MessageSecurityMode,
-    SecurityPolicy
-} from "node-opcua-secure-channel";
+import { AsymmetricAlgorithmSecurityHeader, MessageSecurityMode, SecurityPolicy } from "node-opcua-secure-channel";
 
 export interface IChannelData {
-    channelId: number| null;
+    channelId: number | null;
     clientCertificate: Buffer | null;
-    clientNonce: Buffer |null,
+    clientNonce: Buffer | null;
     clientSecurityHeader: any;
-    securityHeader: AsymmetricAlgorithmSecurityHeader |null;
+    securityHeader: AsymmetricAlgorithmSecurityHeader | null;
     securityMode: MessageSecurityMode;
     securityPolicy: SecurityPolicy;
     timeout: number;

package/source/i_register_server_manager.ts

@@ -4,9 +4,7 @@
 import { EventEmitter } from "events";
 import { ErrorCallback } from "node-opcua-status-code";
 
-
 export interface IRegisterServerManager extends EventEmitter {
-
     discoveryServerEndpointUrl: string;
 
     start(callback: ErrorCallback): void;
@@ -20,5 +18,4 @@ export interface IRegisterServerManager extends EventEmitter {
     on(eventName: "serverRegistered", eventHandler: () => void): this;
     on(eventName: "serverRegistrationRenewed", eventHandler: () => void): this;
     on(eventName: "serverUnregistered", eventHandler: () => void): this;
-
 }

package/source/i_server_side_publish_engine.ts

@@ -1,7 +1,6 @@
-import { Subscription, InternalNotification } from "./server_subscription";
 import { PublishResponseOptions, PublishResponse, StatusChangeNotification } from "node-opcua-types";
 import assert from "node-opcua-assert";
-import { Queue } from "./queue";
+import { Subscription } from "./server_subscription";
 
 export interface INotifMsg {
     subscriptionId: number;
@@ -38,7 +37,7 @@ export class TransferredSubscription implements IClosedOrTransferredSubscription
         return !!this._pending_notification;
     }
     dispose(): void {
-        this._pending_notification= undefined;
+        this._pending_notification = undefined;
         this.publishEngine = null;
     }
     _publish_pending_notifications(): void {
@@ -51,13 +50,13 @@ export class TransferredSubscription implements IClosedOrTransferredSubscription
         const response = new PublishResponse({
             moreNotifications,
             notificationMessage: {
-                notificationData: [notificationMessage ],
+                notificationData: [notificationMessage],
                 publishTime: new Date(),
-                sequenceNumber: 0xFFFFFFFF
+                sequenceNumber: 0xffffffff
             },
             subscriptionId
         });
-        
+
         // apply sequence number and store in sent_notifications queue
         assert(response.notificationMessage.sequenceNumber === 0xffffffff);
         response.notificationMessage.sequenceNumber = this._get_next_sequence_number();

package/source/i_socket_data.ts

@@ -8,4 +8,4 @@ export interface ISocketData {
     remotePort?: number;
     timestamp: Date;
     reason: string;
-}
+}

package/source/index.ts

@@ -1,14 +1,14 @@
-/**
- * @module node-opcua-server
- */
-export * from "./base_server";
-export * from "./server_end_point";
-export * from "./register_server_manager";
-export * from "./register_server_manager_mdns_only";
-export * from "./server_publish_engine";
-export * from "./server_subscription";
-export * from "./server_session";
-export * from "./server_capabilities";
-export * from "./server_engine";
-export * from "./opcua_server";
-export * from "./monitored_item";
+/**
+ * @module node-opcua-server
+ */
+export * from "./base_server";
+export * from "./server_end_point";
+export * from "./register_server_manager";
+export * from "./register_server_manager_mdns_only";
+export * from "./server_publish_engine";
+export * from "./server_subscription";
+export * from "./server_session";
+export * from "./server_capabilities";
+export * from "./server_engine";
+export * from "./opcua_server";
+export * from "./monitored_item";

package/source/monitored_item.ts

@@ -1,11 +1,9 @@
 /**
  * @module node-opcua-server
  */
-// tslint:disable:no-console
-import * as chalk from "chalk";
 import { EventEmitter } from "events";
+import * as chalk from "chalk";
 import { assert } from "node-opcua-assert";
-
 import {
     BaseNode,
     IEventData,
@@ -102,8 +100,8 @@ function _adjust_queue_size(queueSize: number): number {
 
 function _validate_parameters(monitoringParameters: any) {
     // xx assert(options instanceof MonitoringParameters);
-    assert(monitoringParameters.hasOwnProperty("clientHandle"));
-    assert(monitoringParameters.hasOwnProperty("samplingInterval"));
+    assert(Object.prototype.hasOwnProperty.call(monitoringParameters, "clientHandle"));
+    assert(Object.prototype.hasOwnProperty.call(monitoringParameters, "samplingInterval"));
     assert(isFinite(monitoringParameters.clientHandle));
     assert(isFinite(monitoringParameters.samplingInterval));
     assert(typeof monitoringParameters.discardOldest === "boolean");
@@ -135,7 +133,7 @@ function valueHasChanged(
         case DeadbandType.Absolute:
             // AbsoluteDeadband
             return isOutsideDeadbandAbsolute(oldDataValue.value, newDataValue.value, deadbandValue);
-        default:
+        default: {
             // Percent_2    PercentDeadband (This type is specified in Part 8).
             assert(deadbandType === DeadbandType.Percent);
 
@@ -172,6 +170,7 @@ function valueHasChanged(
                 console.log("EURange is not of type Variable");
             }
             return true;
+        }
     }
 }
 
@@ -258,7 +257,6 @@ function apply_dataChange_filter(this: MonitoredItem, newDataValue: DataValue, o
             );
         }
     }
-    return false;
 }
 
 function apply_filter(this: MonitoredItem, newDataValue: DataValue) {
@@ -274,11 +272,6 @@ function apply_filter(this: MonitoredItem, newDataValue: DataValue) {
         }
         return !sameVariant(newDataValue.value, this.oldDataValue.value);
     }
-    return true; // keep
-    // else {
-    //      return !sameDataValue(newDataValue, this.oldDataValue, TimestampsToReturn.Neither);
-    // }
-    // return true; // keep
 }
 
 function setSemanticChangeBit(notification: QueueItem | DataValue): void {
@@ -377,7 +370,7 @@ export class MonitoredItem extends EventEmitter {
     public static defaultSamplingInterval = 1500; // 1500 ms as a default sampling interval
     public static maximumSamplingInterval = 1000 * 60 * 60; // 1 hour !
 
-    public samplingInterval: number = -1;
+    public samplingInterval = -1;
     public monitoredItemId: number;
     public overflow: boolean;
     public oldDataValue?: DataValue;
@@ -385,8 +378,8 @@ export class MonitoredItem extends EventEmitter {
     public timestampsToReturn: TimestampsToReturn;
     public itemToMonitor: any;
     public filter: MonitoringFilter | null;
-    public discardOldest: boolean = true;
-    public queueSize: number = 0;
+    public discardOldest = true;
+    public queueSize = 0;
     public clientHandle: UInt32;
     public $subscription?: ISubscription;
     public _samplingId?: TimerKey | string;
@@ -397,7 +390,7 @@ export class MonitoredItem extends EventEmitter {
     private _node: BaseNode | null;
     private queue: QueueItem[];
     private _semantic_version: number;
-    private _is_sampling: boolean = false;
+    private _is_sampling = false;
     private _on_opcua_event_received_callback: any;
     private _attribute_changed_callback: any;
     private _value_changed_callback: any;
@@ -409,13 +402,13 @@ export class MonitoredItem extends EventEmitter {
     constructor(options: MonitoredItemOptions) {
         super();
 
-        assert(Object.prototype.hasOwnProperty.call(options,"monitoredItemId"));
+        assert(Object.prototype.hasOwnProperty.call(options, "monitoredItemId"));
         assert(!options.monitoringMode, "use setMonitoring mode explicitly to activate the monitored item");
 
         options.itemToMonitor = options.itemToMonitor || defaultItemToMonitor;
 
         this._samplingId = undefined;
-        this.clientHandle = 0; // invalid 
+        this.clientHandle = 0; // invalid
         this.filter = null;
         this._set_parameters(options);
 
@@ -445,7 +438,7 @@ export class MonitoredItem extends EventEmitter {
         MonitoredItem.registry.register(this);
     }
 
-    public setNode(node: BaseNode) {
+    public setNode(node: BaseNode): void {
         assert(!this.node || this.node === node, "node already set");
         this._node = node;
         this._semantic_version = (node as any).semantic_version;
@@ -453,7 +446,7 @@ export class MonitoredItem extends EventEmitter {
         this._node.on("dispose", this._on_node_disposed_listener);
     }
 
-    public setMonitoringMode(monitoringMode: MonitoringMode) {
+    public setMonitoringMode(monitoringMode: MonitoringMode): void {
         assert(monitoringMode !== MonitoringMode.Invalid);
 
         if (monitoringMode === this.monitoringMode) {
@@ -492,12 +485,11 @@ export class MonitoredItem extends EventEmitter {
      *
      * This will stop the internal sampling timer.
      */
-    public terminate() {
+    public terminate(): void {
         this._stop_sampling();
     }
 
-
-    public dispose() {
+    public dispose(): void {
         if (doDebug) {
             debugLog("DISPOSING MONITORED ITEM", this._node!.nodeId.toString());
         }
@@ -563,7 +555,7 @@ export class MonitoredItem extends EventEmitter {
      *    of the contain at the time recordValue was called.
      *
      */
-    public recordValue(dataValue: DataValue, skipChangeTest: boolean, indexRange?: NumericRange) {
+    public recordValue(dataValue: DataValue, skipChangeTest: boolean, indexRange?: NumericRange): void {
         assert(dataValue instanceof DataValue);
         assert(dataValue !== this.oldDataValue, "recordValue expects different dataValue to be provided");
 
@@ -615,7 +607,6 @@ export class MonitoredItem extends EventEmitter {
             setSemanticChangeBit(dataValue);
             this._semantic_version = (this.node as UAVariable).semantic_version;
             return this._enqueue_value(dataValue);
-            debugLog("_enqueue_value => because hasSemanticChanged 2");
         }
 
         const useIndexRange = this.itemToMonitor.indexRange && !this.itemToMonitor.indexRange.isEmpty();
@@ -726,14 +717,11 @@ export class MonitoredItem extends EventEmitter {
         setImmediate(() => {
             this._triggeredNotifications = this._triggeredNotifications || [];
             const notifications = this.extractMonitoredItemNotifications(true);
-            this._triggeredNotifications = ([] as QueueItem[]).concat(
-                this._triggeredNotifications!,
-                notifications
-            );
+            this._triggeredNotifications = ([] as QueueItem[]).concat(this._triggeredNotifications!, notifications);
         });
     }
 
-    public extractMonitoredItemNotifications(bForce: boolean = false): QueueItem[] {
+    public extractMonitoredItemNotifications(bForce = false): QueueItem[] {
         if (!bForce && this.monitoringMode === MonitoringMode.Sampling && this._triggeredNotifications) {
             const notifications1 = this._triggeredNotifications;
             this._triggeredNotifications = undefined;
@@ -1029,13 +1017,13 @@ export class MonitoredItem extends EventEmitter {
             // initiate first read
             if (recordInitialValue) {
                 /* await */ new Promise<void>((resolve: () => void) => {
-                (this.node as UAVariable).readValueAsync(context, (err: Error | null, dataValue?: DataValue) => {
-                    if (!err && dataValue) {
-                        this.recordValue(dataValue, true);
-                    }
-                    resolve();
+                    (this.node as UAVariable).readValueAsync(context, (err: Error | null, dataValue?: DataValue) => {
+                        if (!err && dataValue) {
+                            this.recordValue(dataValue, true);
+                        }
+                        resolve();
+                    });
                 });
-            });
             }
         } else {
             this._set_timer();
@@ -1051,9 +1039,9 @@ export class MonitoredItem extends EventEmitter {
         _validate_parameters(monitoredParameters);
         // only change clientHandle if it is valid (0<X<MAX)
         if (monitoredParameters.clientHandle !== 0 && monitoredParameters.clientHandle !== 4294967295) {
-           this.clientHandle = monitoredParameters.clientHandle;
+            this.clientHandle = monitoredParameters.clientHandle;
         }
- 
+
         // The Server may support data that is collected based on a sampling model or generated based on an
         // exception-based model. The fastest supported sampling interval may be equal to 0, which indicates
         // that the data item is exception-based rather than being sampled at some period. An exception-based
@@ -1074,7 +1062,7 @@ export class MonitoredItem extends EventEmitter {
     }
 
     private _setOverflowBit(notification: any) {
-        if (notification.hasOwnProperty("value")) {
+        if (Object.prototype.hasOwnProperty.call(notification, "value")) {
             assert(notification.value.statusCode.equals(StatusCodes.Good));
             notification.value.statusCode = StatusCode.makeStatusCode(
                 notification.value.statusCode,
@@ -1191,11 +1179,11 @@ export class MonitoredItem extends EventEmitter {
         ) {
             throw new Error(
                 "dataValue.value.value cannot be the same object twice! " +
-                this.node!.browseName.toString() +
-                " " +
-                dataValue.toString() +
-                "  " +
-                chalk.cyan(this.oldDataValue.toString())
+                    this.node!.browseName.toString() +
+                    " " +
+                    dataValue.toString() +
+                    "  " +
+                    chalk.cyan(this.oldDataValue.toString())
             );
         }