node-opcua-client 2.178.0 → 2.179.0

package/source/client_session_keepalive_manager.ts

@@ -2,8 +2,8 @@
  * @module node-opcua-client
  */
 
+import { EventEmitter } from "node:events";
 import chalk from "chalk";
-import { EventEmitter } from "events";
 import { assert } from "node-opcua-assert";
 import { AttributeIds } from "node-opcua-basic-types";
 import { ServerState } from "node-opcua-common";
@@ -11,20 +11,11 @@ import { VariableIds } from "node-opcua-constants";
 import type { DataValue } from "node-opcua-data-value";
 import { checkDebugFlag, make_debugLog, make_warningLog } from "node-opcua-debug";
 import { coerceNodeId } from "node-opcua-nodeid";
-import { ClientSecureChannelLayer } from "node-opcua-secure-channel";
-import type { StatusCode } from "node-opcua-status-code";
+import { ClientSecureChannelLayer, type ServiceFaultAnnotatedError } from "node-opcua-secure-channel";
 import { StatusCodes } from "node-opcua-status-code";
 import type { ClientSessionImpl } from "./private/client_session_impl";
 import type { IClientBase } from "./private/i_private_client";
 
-interface ServiceFaultAnnotatedError extends Error {
-    response?: {
-        responseHeader?: {
-            serviceResult?: StatusCode;
-        };
-    };
-}
-
 const serverStatusStateNodeId = coerceNodeId(VariableIds.Server_ServerStatus_State);
 
 const debugLog = make_debugLog(__filename);
@@ -86,26 +77,40 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
 
     public stop(): void {
         if (this.timerId) {
-            debugLog("ClientSessionKeepAliveManager#stop");
+            // c8 ignore next
+            doDebug && debugLog("ClientSessionKeepAliveManager#stop");
             clearTimeout(this.timerId);
             this.timerId = undefined;
         } else {
-            debugLog("warning ClientSessionKeepAliveManager#stop ignore (already stopped)");
+            // c8 ignore next
+            doDebug && debugLog("warning ClientSessionKeepAliveManager#stop ignore (already stopped)");
         }
     }
 
     private ping_server() {
-        this._ping_server().then((delta) => {
-            if (!this.session || this.session.hasBeenClosed()) {
-                return; // stop here
-            }
-            if (this.timerId) {
-                // When delta exceeds checkInterval it is an explicit backoff requested by _ping_server;
-                // otherwise delta is the time already consumed this cycle.
-                const timeout = delta > this.checkInterval ? delta : Math.max(1, this.checkInterval - delta);
-                this.timerId = setTimeout(() => this.ping_server(), timeout);
-            }
-        });
+        this._ping_server()
+            .catch((err) => {
+                // _ping_server must never reject: transactionInProgress would stay latched and the
+                // timer chain would stop, silently killing the keep-alive for the life of the
+                // session. Recover the cycle instead, and try again at the normal cadence.
+                warningLog(
+                    chalk.cyan("ClientSessionKeepAliveManager#ping_server unexpected error "),
+                    chalk.yellow(err instanceof Error ? err.message : String(err))
+                );
+                this.transactionInProgress = false;
+                return this.checkInterval;
+            })
+            .then((nextCheckDelay) => {
+                if (!this.session || this.session.hasBeenClosed()) {
+                    return; // stop here
+                }
+                if (this.timerId) {
+                    // _ping_server returns how long to wait before the next check: checkInterval
+                    // in steady state, the residual wait when it skipped the ping because we heard
+                    // from the server recently, or an explicit backoff after consecutive faults.
+                    this.timerId = setTimeout(() => this.ping_server(), Math.max(1, nextCheckDelay));
+                }
+            });
     }
     /**
      * @private
@@ -117,45 +122,52 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
     private async _ping_server(): Promise<number> {
         const session = this.session;
         if (!session || session.isReconnecting) {
-            debugLog("ClientSessionKeepAliveManager#ping_server => no session available");
-            return 0;
+            // c8 ignore next
+            doDebug && debugLog("ClientSessionKeepAliveManager#ping_server => no session available");
+            return this.checkInterval;
         }
 
         if (!this.timerId) {
-            return 0; // keep-alive has been canceled ....
+            return this.checkInterval; // keep-alive has been canceled ....
         }
         const now = Date.now();
 
         const timeSinceLastServerContact = now - session.lastResponseReceivedTime.getTime();
         if (timeSinceLastServerContact < this.pingTimeout) {
-            debugLog(
-                "ClientSessionKeepAliveManager#ping_server skipped because last communication with server was not that long ago ping timeout=",
-                Math.round(this.pingTimeout),
-                "timeSinceLastServerContact  = ",
-                timeSinceLastServerContact
-            );
-            // no need to send a ping yet
-            return timeSinceLastServerContact - this.pingTimeout;
+            // c8 ignore next
+            doDebug &&
+                debugLog(
+                    "ClientSessionKeepAliveManager#ping_server skipped because last communication with server was not that long ago ping timeout=",
+                    Math.round(this.pingTimeout),
+                    "timeSinceLastServerContact  = ",
+                    timeSinceLastServerContact
+                );
+            // no need to send a ping yet: come back when the quiet period is actually over
+            return this.pingTimeout - timeSinceLastServerContact;
         }
 
         if (session.isReconnecting) {
-            debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
-            return 0;
+            // c8 ignore next
+            doDebug && debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
+            return this.checkInterval;
         }
         if (session.hasBeenClosed()) {
-            debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
-            return 0;
+            // c8 ignore next
+            doDebug && debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
+            return this.checkInterval;
         }
-        debugLog(
-            "ClientSessionKeepAliveManager#ping_server timeSinceLastServerContact=",
-            timeSinceLastServerContact,
-            "timeout",
-            this.session.timeout
-        );
+        // c8 ignore next
+        doDebug &&
+            debugLog(
+                "ClientSessionKeepAliveManager#ping_server timeSinceLastServerContact=",
+                timeSinceLastServerContact,
+                "timeout",
+                this.session.timeout
+            );
 
         if (this.transactionInProgress) {
             // readVariable already taking place ! Ignore
-            return 0;
+            return this.checkInterval;
         }
         this.transactionInProgress = true;
         // Server_ServerStatus_State
@@ -180,7 +192,7 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
                                     "Keep alive has failed, considering a network outage is in place, forcing a reconnection"
                                 );
                                 terminateConnection(session._client);
-                                resolve(0);
+                                resolve(this.checkInterval);
                             } else {
                                 if (sc?.equals(StatusCodes.BadInvalidTimestamp)) {
                                     // BadInvalidTimestamp (OPC UA Part 4 7.38.2, Table 178:
@@ -204,9 +216,13 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
                                     // See: https://reference.opcfoundation.org/Core/Part4/v105/docs/7.38.2
                                     //      https://reference.opcfoundation.org/Core/Part4/v105/docs/7.32
                                     this.consecutiveFailures = 0;
-                                    debugLog("emit keepalive (BadInvalidTimestamp: session alive, clock skew on request timestamp)");
+                                    // c8 ignore next
+                                    doDebug &&
+                                        debugLog(
+                                            "emit keepalive (BadInvalidTimestamp: session alive, clock skew on request timestamp)"
+                                        );
                                     this.emit("keepalive", this.lastKnownState ?? ServerState.Unknown, this.count);
-                                    resolve(0);
+                                    resolve(this.checkInterval);
                                     return;
                                 }
                                 this.consecutiveFailures++;
@@ -218,11 +234,11 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
                             this.emit("failure");
                             warningLog("Keep alive has failed, considering a network outage is in place, forcing a reconnection");
                             terminateConnection(session._client);
-                            resolve(0);
+                            resolve(this.checkInterval);
                         }
                         return;
                     }
-                    if (!dataValue || !dataValue.value) {
+                    if (!dataValue?.value) {
                         /**
                          * @event failure
                          * raised when the server is not responding or is responding with en error to
@@ -231,7 +247,7 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
                         this.emit("failure");
                         warningLog("Keep alive has failed, considering a network outage is in place, forcing a reconnection");
                         terminateConnection(session._client);
-                        resolve(0);
+                        resolve(this.checkInterval);
                         return;
                     }
 
@@ -250,9 +266,10 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
                         this.count++; // increase successful counter
                     }
                     this.consecutiveFailures = 0;
-                    debugLog("emit keepalive");
+                    // c8 ignore next
+                    doDebug && debugLog("emit keepalive");
                     this.emit("keepalive", this.lastKnownState, this.count);
-                    resolve(0);
+                    resolve(this.checkInterval);
                 }
             );
         });
@@ -262,7 +279,7 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
 function terminateConnection(client: IClientBase | null) {
     if (!client) return;
 
-    const channel: ClientSecureChannelLayer = (client as any)._secureChannel;
+    const channel: ClientSecureChannelLayer | null = client._secureChannel;
     if (!channel) {
         return;
     }

package/source/client_subscription.ts

@@ -2,8 +2,7 @@
  * @module node-opcua-client
  */
 
-// tslint:disable:unified-signatures
-import type { EventEmitter } from "events";
+import type { EventEmitter } from "node:events";
 import type { Byte, Double, UInt32 } from "node-opcua-basic-types";
 
 import type { DiagnosticInfo } from "node-opcua-data-model";
@@ -238,8 +237,10 @@ export interface ClientSubscription extends EventEmitter {
 }
 
 export declare interface ClientSubscription {
+    // biome-ignore lint/suspicious/noExplicitAny: matches Node's EventEmitter catch-all signature; narrowing to unknown[] breaks assignability of specifically-typed listener handlers at call sites
     once(event: string | symbol, listener: (...args: any[]) => void): this;
 
+    // biome-ignore lint/suspicious/noExplicitAny: matches Node's EventEmitter catch-all signature; narrowing to unknown[] breaks assignability of specifically-typed listener handlers at call sites
     on(event: string | symbol, listener: (...args: any[]) => void): this;
     /**
      * notify the observers that the subscription has now started
@@ -298,8 +299,10 @@ export declare interface ClientSubscription {
     ): ClientMonitoredItem;
 }
 
+// biome-ignore lint/suspicious/noUnsafeDeclarationMerging: interface adds typed members/overloads for this class
+// biome-ignore lint/complexity/noStaticOnlyClass: class identity is required for the `implements IBasicSubscription` contract; static factory + static flag can't be expressed as a namespace
 export class ClientSubscription implements IBasicSubscription {
-    public static create(clientSession: ClientSession, options: ClientSubscriptionOptions): ClientSubscription {
+    public static create(_clientSession: ClientSession, _options: ClientSubscriptionOptions): ClientSubscription {
         /* c8 ignore next*/
         throw new Error("Not Implemented");
     }

package/source/common.ts

@@ -49,6 +49,8 @@ import type {
     SetMonitoringModeResponse,
     SetPublishingModeRequest,
     SetPublishingModeResponse,
+    SetTriggeringRequest,
+    SetTriggeringResponse,
     TransferSubscriptionsRequest,
     TransferSubscriptionsResponse
 } from "node-opcua-service-subscription";
@@ -80,6 +82,7 @@ export type Request =
     | RepublishRequest
     | DeleteMonitoredItemsRequest
     | SetPublishingModeRequest
+    | SetTriggeringRequest
     | FindServersOnNetworkRequest
     | FindServersRequest
     | HistoryReadRequest
@@ -110,6 +113,7 @@ export type Response =
     | RepublishResponse
     | DeleteMonitoredItemsResponse
     | SetPublishingModeResponse
+    | SetTriggeringResponse
     | FindServersOnNetworkResponse
     | FindServersResponse
     | HistoryReadResponse

package/source/index.ts

@@ -37,8 +37,8 @@ export * from "./client_session";
 export * from "./client_subscription";
 export * from "./client_utils";
 export * from "./opcua_client";
-export * from "./reverse/client_reverse_connect";
 export { ClientSidePublishEngine } from "./private/client_publish_engine";
+export * from "./reverse/client_reverse_connect";
 export * from "./tools/findservers";
 export * from "./tools/read_history_server_capabilities";
 export * from "./user_identity_info";

package/source/opcua_client.ts

@@ -233,6 +233,7 @@ export interface OPCUAClient<Events extends OPCUAClientBaseEvents = OPCUAClientB
  * });
  * ```
  */
+// biome-ignore lint/complexity/noStaticOnlyClass: interface merges instance-side typings; static factory + static accessors can't be expressed as a namespace (get/set)
 export class OPCUAClient {
     /**
      * Create a new OPC UA client instance.