node-opcua-server 2.156.0 → 2.158.0

package/source/i_register_server_manager.ts

@@ -2,16 +2,77 @@
  * @module node-opcua-server
  */
 import { EventEmitter } from "events";
-import { ErrorCallback } from "node-opcua-status-code";
 
-export interface IRegisterServerManager extends EventEmitter {
-    discoveryServerEndpointUrl: string;
+/**
+ * Finite State Machine for RegisterServerManager.
+ *
+ * This state machine defines the lifecycle of the server's registration with an LDS.
+ * It's designed to handle all transitions, including successful operations,
+ * failures, and interruptions (e.g., a stop call during a start operation).
+ *
+ * **States:**
+ * - **INACTIVE**: The manager is not running.
+ * - **INITIALIZING**: The initial connection phase to retrieve endpoints from the LDS.
+ * - **INITIALIZED**: The initial connection was successful, and endpoints were retrieved.
+ * - **REGISTERING**: The manager is actively sending a RegisterServer request.
+ * - **REGISTERED**: The server has successfully registered.
+ * - **WAITING**: The server is registered and waiting for the next renewal period.
+ * - **UNREGISTERING**: The manager is sending an unregister request.
+ * - **UNREGISTERED**: The server has been successfully unregistered.
+ *
+ * **Transitions:**
+ * - `INACTIVE` -> `INITIALIZING`: Triggered by `start()`.
+ * - `INITIALIZING` -> `INITIALIZED`: On successful initial connection.
+ * - `INITIALIZING` -> `INACTIVE`: On connection failure.
+ * - `INITIALIZED` -> `REGISTERING`: Immediately after initialization.
+ * - `REGISTERING` -> `REGISTERED`: On successful registration.
+ * - `REGISTERING` -> `INACTIVE`: On registration failure.
+ * - `REGISTERED` -> `WAITING`: Immediately after registration.
+ * - `WAITING` -> `REGISTERING`: On renewal timer expiration.
+ * - `WAITING` -> `UNREGISTERING`: Triggered by `stop()`.
+ * - `UNREGISTERING` -> `UNREGISTERED`: On successful unregistration.
+ * - `UNREGISTERING` -> `INACTIVE`: On unregistration failure.
+ * - `UNREGISTERED` -> `INACTIVE`: Immediately after unregistration.
+ * - Any state can transition to `INACTIVE` on a fatal interruption.
+ *
+ */
+export enum RegisterServerManagerStatus {
+    INACTIVE = 1,
+    INITIALIZING = 2,
+    INITIALIZED = 3,
+    REGISTERING = 4,
+    REGISTERED = 5,
+    WAITING = 6,
+    UNREGISTERING = 7,
+    UNREGISTERED = 8,
+    NOT_APPLICABLE = -1,
+    
+    DISPOSING = 9
+}
 
-    start(callback: ErrorCallback): void;
 
-    stop(callback: ErrorCallback): void;
 
+export interface IRegisterServerManager extends EventEmitter {
+    /** The URL of the discovery server the manager is configured to connect to. */
+    discoveryServerEndpointUrl: string;
+    /**
+     * Initiates the server registration process with the discovery server.
+     * This method is idempotent and will throw an error if called when the manager is not in the INACTIVE state.
+     */
+    start(): Promise<void>;
+    /**
+     * Gracefully unregisters the server from the discovery server and halts the renewal process.
+     * This method can be safely called at any point; it will ensure a clean shutdown.
+     */
+    stop(): Promise<void>;
+    /**
+     * Disposes of all resources, rendering the manager unusable.
+     */
     dispose(): void;
+    /**
+     * Returns the current state of the registration manager.
+     */
+    getState(): RegisterServerManagerStatus;
 
     // tslint:disable:unified-signatures
     on(eventName: "serverRegistrationPending", eventHandler: () => void): this;

package/source/index.ts

@@ -1,3 +1,25 @@
+/*!
+ * The MIT License (MIT)
+ * Copyright (c) 2022-2025  Sterfive SAS - 833264583 RCS ORLEANS - France  (https://www.sterfive.com)
+ * Copyright (c) 2014-2022 Etienne Rossignon
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ * 
+ *   The above copyright notice and this permission notice shall be included in all
+ *   copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
 /**
  * @module node-opcua-server
  */

package/source/monitored_item.ts

@@ -376,7 +376,7 @@ const badDataUnavailable = new DataValue({ statusCode: StatusCodes.BadDataUnavai
  *
  */
 export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
-    public get node(): UAVariable | UAObject | UAMethod |null {
+    public get node(): UAVariable | UAObject | UAMethod | null {
         return this._node;
     }
 
@@ -393,7 +393,12 @@ export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
     public monitoredItemId: number;
     public overflow: boolean;
     public oldDataValue: DataValue;
-    public monitoringMode: MonitoringMode;
+
+
+    #monitoringMode: MonitoringMode = MonitoringMode.Invalid;
+
+    public get monitoringMode() { return this.#monitoringMode; }
+
     public timestampsToReturn: TimestampsToReturn;
     public itemToMonitor: any;
     public filter: MonitoringFilter | null;
@@ -437,7 +442,7 @@ export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
         this.oldDataValue = badDataUnavailable;
 
         // user has to call setMonitoringMode
-        this.monitoringMode = MonitoringMode.Invalid;
+        this.#monitoringMode = MonitoringMode.Invalid;
 
         this.timestampsToReturn = coerceTimestampsToReturn(options.timestampsToReturn);
 
@@ -464,26 +469,26 @@ export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
         (this._node as BaseNode).on("dispose", this._on_node_disposed_listener);
     }
 
-    public setMonitoringMode(monitoringMode: MonitoringMode): void {
-        assert(monitoringMode !== MonitoringMode.Invalid);
+    public setMonitoringMode(monitoringMode: MonitoringMode): StatusCode {
 
         if (monitoringMode === this.monitoringMode) {
             // nothing to do
-            return;
+            return StatusCodes.BadNothingToDo;
+        }
+        if (monitoringMode === MonitoringMode.Invalid) {
+            return StatusCodes.BadInvalidArgument;
         }
-
         const old_monitoringMode = this.monitoringMode;
 
-        this.monitoringMode = monitoringMode;
 
-        if (this.monitoringMode === MonitoringMode.Disabled) {
+        if (monitoringMode === MonitoringMode.Disabled) {
+            this.#monitoringMode = monitoringMode;
             this._stop_sampling();
-
             // OPCUA 1.03 part 4 : $5.12.4
             // setting the mode to DISABLED causes all queued Notifications to be deleted
             this._empty_queue();
-        } else {
-            assert(this.monitoringMode === MonitoringMode.Sampling || this.monitoringMode === MonitoringMode.Reporting);
+        } else if (monitoringMode === MonitoringMode.Sampling || monitoringMode === MonitoringMode.Reporting) {
+            this.#monitoringMode = monitoringMode;
 
             // OPCUA 1.03 part 4 : $5.12.1.3
             // When a MonitoredItem is enabled (i.e. when the MonitoringMode is changed from DISABLED to
@@ -494,10 +499,14 @@ export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
                 old_monitoringMode === MonitoringMode.Invalid || old_monitoringMode === MonitoringMode.Disabled;
             const installEventHandler = old_monitoringMode === MonitoringMode.Invalid;
             this._start_sampling(recordInitialValue);
+        } else {
+            return StatusCodes.BadInternalError;
         }
+
+        return StatusCodes.Good;
     }
 
-    /**
+    /*
      * Terminate the  MonitoredItem.
      * This will stop the internal sampling timer.
      */
@@ -1132,7 +1141,7 @@ export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
                 if (this.node.nodeClass == NodeClass.Variable) {
                     this.node.on("value_changed", this._value_changed_callback);
                     this.node.on("semantic_changed", this._semantic_changed_callback);
-                } 
+                }
             }
 
             // initiate first read
@@ -1292,11 +1301,11 @@ export class MonitoredItem extends EventEmitter implements MonitoredItemBase {
         ) {
             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())
             );
         }
 

package/source/opcua_server.ts

@@ -1315,7 +1315,9 @@ export class OPCUAServer extends OPCUABaseServer {
                 } else {
                     // we start the registration process asynchronously
                     // as we want to make server immediately available
-                    this.registerServerManager!.start(() => {
+                    this.registerServerManager!.start().then(() => {
+                        /* empty */
+                    }).catch((err) => {
                         /* empty */
                     });
 
@@ -1379,20 +1381,28 @@ export class OPCUAServer extends OPCUABaseServer {
         this.engine.setShutdownTime(shutdownTime);
 
         debugLog("OPCUAServer is now un-registering itself from  the discovery server " + this.buildInfo);
-        this.registerServerManager!.stop((err?: Error | null) => {
-            debugLog("OPCUAServer unregistered from discovery server", err);
-            setTimeout(async () => {
-                await this.engine.shutdown();
+        this.registerServerManager!.stop()
+            .then(() => {
+                debugLog("OPCUAServer unregistered from discovery server successfully");
 
-                debugLog("OPCUAServer#shutdown: started");
-                OPCUABaseServer.prototype.shutdown.call(this, (err1?: Error) => {
-                    debugLog("OPCUAServer#shutdown: completed");
+            })
+            .catch((err) => {
+                debugLog("OPCUAServer unregistered from discovery server with err: ", err.message);
+            }).finally(() => {
 
-                    this.dispose();
-                    callback(err1);
-                });
-            }, timeout);
-        });
+                setTimeout(async () => {
+                    await this.engine.shutdown();
+
+                    debugLog("OPCUAServer#shutdown: started");
+                    OPCUABaseServer.prototype.shutdown.call(this, (err1?: Error) => {
+                        debugLog("OPCUAServer#shutdown: completed");
+
+                        this.dispose();
+                        callback(err1);
+                    });
+                }, timeout);
+
+            });
     }
 
     public dispose(): void {
@@ -3323,8 +3333,8 @@ export class OPCUAServer extends OPCUABaseServer {
                     if (!monitoredItem) {
                         return StatusCodes.BadMonitoredItemIdInvalid;
                     }
-                    monitoredItem.setMonitoringMode(monitoringMode);
-                    return StatusCodes.Good;
+                    const statusCode = monitoredItem.setMonitoringMode(monitoringMode);
+                    return statusCode;
                 });
 
                 const response = new SetMonitoringModeResponse({
@@ -3621,11 +3631,11 @@ export class OPCUAServer extends OPCUABaseServer {
 
 const userIdentityTokenPasswordRemoved = (userIdentityToken?: UserIdentityToken): UserIdentityToken => {
     if (!userIdentityToken) return new AnonymousIdentityToken();
-    const a: UserIdentityToken  = userIdentityToken.clone();
+    const a: UserIdentityToken = userIdentityToken.clone();
     // For Username/Password tokens the password shall not be included.
     if (a instanceof UserNameIdentityToken) {
         // remove password
-        a.password = Buffer.from("*************","ascii");
+        a.password = Buffer.from("*************", "ascii");
     }
     // if (a instanceof X509IdentityToken) {
     //     a.certificateData = Buffer.alloc(0);
@@ -3745,7 +3755,7 @@ export interface RaiseEventAuditActivateSessionEventData extends RaiseEventAudit
 }
 
 // tslint:disable:no-empty-interface
-export interface RaiseEventTransitionEventData extends RaiseEventData {}
+export interface RaiseEventTransitionEventData extends RaiseEventData { }
 
 export interface RaiseEventAuditUrlMismatchEventTypeData extends RaiseEventData {
     endpointUrl: PseudoVariantString;
@@ -3775,7 +3785,7 @@ export interface RaiseAuditCertificateDataMismatchEventData extends RaiseAuditCe
      */
     invalidUri: PseudoVariantString;
 }
-export interface RaiseAuditCertificateUntrustedEventData extends RaiseAuditCertificateEventData {}
+export interface RaiseAuditCertificateUntrustedEventData extends RaiseAuditCertificateEventData { }
 /**
  * This EventType inherits all Properties of the AuditCertificateEventType.
  *
@@ -3787,7 +3797,7 @@ export interface RaiseAuditCertificateUntrustedEventData extends RaiseAuditCerti
  * There are no additional Properties defined for this EventType.
  *
  */
-export interface RaiseAuditCertificateExpiredEventData extends RaiseAuditCertificateEventData {}
+export interface RaiseAuditCertificateExpiredEventData extends RaiseAuditCertificateEventData { }
 /**
  * This EventType inherits all Properties of the AuditCertificateEventType.
  *
@@ -3797,7 +3807,7 @@ export interface RaiseAuditCertificateExpiredEventData extends RaiseAuditCertifi
  *
  * There are no additional Properties defined for this EventType.
  */
-export interface RaiseAuditCertificateInvalidEventData extends RaiseAuditCertificateEventData {}
+export interface RaiseAuditCertificateInvalidEventData extends RaiseAuditCertificateEventData { }
 /**
  * This EventType inherits all Properties of the AuditCertificateEventType.
  *
@@ -3807,7 +3817,7 @@ export interface RaiseAuditCertificateInvalidEventData extends RaiseAuditCertifi
  * If a trust chain is involved then the certificate that failed in the trust chain should be described.
  * There are no additional Properties defined for this EventType.
  */
-export interface RaiseAuditCertificateUntrustedEventData extends RaiseAuditCertificateEventData {}
+export interface RaiseAuditCertificateUntrustedEventData extends RaiseAuditCertificateEventData { }
 /**
  * This EventType inherits all Properties of the AuditCertificateEventType.
  *
@@ -3830,7 +3840,7 @@ export interface RaiseAuditCertificateRevokedEventData extends RaiseAuditCertifi
  *
  * There are no additional Properties defined for this EventType
  */
-export interface RaiseAuditCertificateMismatchEventData extends RaiseAuditCertificateEventData {}
+export interface RaiseAuditCertificateMismatchEventData extends RaiseAuditCertificateEventData { }
 export interface OPCUAServer {
     /**
      * @internal