node-opcua-client 2.101.0 → 2.103.0

package/source/client_base.ts

@@ -102,6 +102,10 @@ export interface OPCUAClientBaseOptions {
      * @default false
      */
     keepSessionAlive?: boolean;
+    /**
+     * the number of milliseconds that the client should wait until it sends a keep alive message to the server.
+     */
+    keepAliveInterval?: number;
 
     /**
      * certificate Manager
@@ -132,6 +136,7 @@ export interface OPCUAClientBaseOptions {
      * @advanced
      */
     transportSettings?: TransportSettings;
+    transportTimeout?: number;
 }
 
 export interface GetEndpointsOptions {
@@ -325,7 +330,6 @@ export interface OPCUAClientBase {
     readonly connectionStrategy: ConnectionStrategy;
     readonly keepPendingSessionsOnDisconnect: boolean;
     readonly endpointUrl: string;
-    readonly keepSessionAlive: boolean;
     readonly applicationName: string;
 }
 

package/source/client_session_keepalive_manager.ts

@@ -7,8 +7,10 @@ import { assert } from "node-opcua-assert";
 import { ServerState } from "node-opcua-common";
 import { VariableIds } from "node-opcua-constants";
 import { DataValue } from "node-opcua-data-value";
+import { AttributeIds } from "node-opcua-basic-types";
 import { checkDebugFlag, make_debugLog, make_warningLog } from "node-opcua-debug";
 import { coerceNodeId } from "node-opcua-nodeid";
+import { ClientSecureChannelLayer } from "node-opcua-secure-channel";
 import { StatusCodes } from "node-opcua-status-code";
 import { ClientSessionImpl } from "./private/client_session_impl";
 
@@ -28,9 +30,9 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
     private timerId?: NodeJS.Timer;
     private pingTimeout: number;
     private lastKnownState?: ServerState;
-    private checkInterval: number;
     private transactionInProgress = false;
     public count = 0;
+    public checkInterval: number;
 
     constructor(session: ClientSessionImpl) {
         super();
@@ -41,7 +43,7 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
         this.count = 0;
     }
 
-    public start(): void {
+    public start(keepAliveInterval?: number): void {
         assert(!this.timerId);
         /* istanbul ignore next*/
         if (this.session.timeout < 600) {
@@ -56,8 +58,12 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
             );
         }
 
-        this.pingTimeout = Math.min(this.session.timeout / 3, 20000);
-        this.checkInterval = Math.max(50, Math.min((this.session.timeout * 2) / 3, 20000));
+        const selectedCheckInterval =
+            keepAliveInterval ||
+            Math.min(Math.floor(Math.min((this.session.timeout * 2) / 3, 20000)), ClientSecureChannelLayer.defaultTransportTimeout);
+
+        this.checkInterval = selectedCheckInterval;
+        this.pingTimeout = Math.floor(Math.min(Math.max(50, selectedCheckInterval / 2), 20000));
 
         // make sure first one is almost immediate
         this.timerId = setTimeout(() => this.ping_server(), this.pingTimeout);
@@ -103,7 +109,7 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
         if (!this.timerId) {
             return 0; // keep-alive has been canceled ....
         }
-        const now = Date.now(); 
+        const now = Date.now();
 
         const timeSinceLastServerContact = now - session.lastResponseReceivedTime.getTime();
         if (timeSinceLastServerContact < this.pingTimeout) {
@@ -141,41 +147,50 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
         // Server_ServerStatus_State
 
         return new Promise((resolve) => {
-            session.readVariableValue(serverStatusStateNodeId, (err: Error | null, dataValue?: DataValue) => {
-                this.transactionInProgress = false;
-
-                if (err || !dataValue || !dataValue.value) {
-                    if (err) {
-                        warningLog(chalk.cyan(" warning : ClientSessionKeepAliveManager#ping_server "), chalk.yellow(err.message));
+            session.read(
+                {
+                    nodeId: serverStatusStateNodeId,
+                    attributeId: AttributeIds.Value
+                },
+                (err: Error | null, dataValue?: DataValue) => {
+                    this.transactionInProgress = false;
+
+                    if (err || !dataValue || !dataValue.value) {
+                        if (err) {
+                            warningLog(
+                                chalk.cyan(" warning : ClientSessionKeepAliveManager#ping_server "),
+                                chalk.yellow(err.message)
+                            );
+                        }
+                        /**
+                         * @event failure
+                         * raised when the server is not responding or is responding with en error to
+                         * the keep alive read Variable value transaction
+                         */
+                        this.emit("failure");
+                        resolve(0);
+                        return;
                     }
-                    /**
-                     * @event failure
-                     * raised when the server is not responding or is responding with en error to
-                     * the keep alive read Variable value transaction
-                     */
-                    this.emit("failure");
-                    resolve(0);
-                    return;
-                }
 
-                if (dataValue.statusCode.isGood()) {
-                    const newState = dataValue.value.value as ServerState;
-                    // istanbul ignore next
-                    if (newState !== this.lastKnownState && this.lastKnownState) {
-                        warningLog(
-                            "ClientSessionKeepAliveManager#Server state has changed = ",
-                            ServerState[newState],
-                            " was ",
-                            ServerState[this.lastKnownState]
-                        );
+                    if (dataValue.statusCode.isGood()) {
+                        const newState = dataValue.value.value as ServerState;
+                        // istanbul ignore next
+                        if (newState !== this.lastKnownState && this.lastKnownState) {
+                            warningLog(
+                                "ClientSessionKeepAliveManager#Server state has changed = ",
+                                ServerState[newState],
+                                " was ",
+                                ServerState[this.lastKnownState]
+                            );
+                        }
+                        this.lastKnownState = newState;
+                        this.count++; // increase successful counter
                     }
-                    this.lastKnownState = newState;
-                    this.count++; // increase successful counter
+                    debugLog("emit keepalive");
+                    this.emit("keepalive", this.lastKnownState, this.count);
+                    resolve(0);
                 }
-                debugLog("emit keepalive");
-                this.emit("keepalive", this.lastKnownState, this.count);
-                resolve(0);
-            });
+            );
         });
     }
 }

package/source/opcua_client.ts

@@ -16,7 +16,6 @@ import { ClientSubscription, ClientSubscriptionOptions } from "./client_subscrip
 import { OPCUAClientImpl } from "./private/opcua_client_impl";
 import { UserIdentityInfo } from "./user_identity_info";
 
-
 export interface OPCUAClientOptions extends OPCUAClientBaseOptions {
     /**
      * the requested session timeout in CreateSession (ms)
@@ -43,51 +42,6 @@ export interface OPCUAClientOptions extends OPCUAClientBaseOptions {
      * @default true
      */
     endpointMustExist?: boolean;
-
-    // --------------------------------------------------------------------
-    connectionStrategy?: ConnectionStrategyOptions;
-
-    /** the server certificate. */
-    serverCertificate?: Certificate;
-
-    /***
-     * default secure token lifetime in ms
-     */
-    defaultSecureTokenLifetime?: number;
-
-    /**
-     * the security mode
-     * @default MessageSecurityMode.None
-     */
-    securityMode?: MessageSecurityMode | string;
-
-    /**
-     * the security policy
-     * @default SecurityPolicy.None
-     */
-    securityPolicy?: SecurityPolicy | string;
-
-    /**
-     * @default false
-     */
-    keepSessionAlive?: boolean;
-
-    /**
-     * client certificate pem file.
-     * @default "certificates/client_self-signed_cert_2048.pem"
-     */
-    certificateFile?: string;
-
-    /**
-     * client private key pem file.
-     * @default "certificates/client_key_2048.pem"
-     */
-    privateKeyFile?: string;
-
-    /**
-     * a client name string that will be used to generate session names.
-     */
-    clientName?: string;
 }
 
 export interface OPCUAClient extends OPCUAClientBase {

package/source/private/client_base_impl.ts

@@ -365,6 +365,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
      * true if session shall periodically probe the server to keep the session alive and prevent timeout
      */
     public keepSessionAlive: boolean;
+    public readonly keepAliveInterval?: number;
 
     public _sessions: ClientSessionImpl[];
     protected _serverEndpoints: EndpointDescription[];
@@ -383,6 +384,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     private _tmpClient?: OPCUAClientBase;
     private _instanceNumber: number;
     private _transportSettings: TransportSettings;
+    private _transportTimeout?: number;
 
     public clientCertificateManager: OPCUACertificateManager;
 
@@ -451,6 +453,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         this.serverCertificate = options.serverCertificate;
 
         this.keepSessionAlive = typeof options.keepSessionAlive === "boolean" ? options.keepSessionAlive : false;
+        this.keepAliveInterval = options.keepAliveInterval;
 
         // statistics...
         this._byteRead = 0;
@@ -471,6 +474,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         this._setInternalState("disconnected");
 
         this._transportSettings = options.transportSettings || {};
+        this._transportTimeout = options.transportTimeout;
     }
 
     private _cancel_reconnection(callback: ErrorCallback) {
@@ -645,8 +649,8 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             securityPolicy: this.securityPolicy,
             serverCertificate: this.serverCertificate,
             tokenRenewalInterval: this.tokenRenewalInterval,
-            transportSettings: this._transportSettings
-            // transportTimeout:
+            transportSettings: this._transportSettings,
+            transportTimeout: this._transportTimeout
         });
         secureChannel.on("backoff", (count: number, delay: number) => {
             this.emit("backoff", count, delay);
@@ -1288,8 +1292,8 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 setImmediate(callback);
             });
         } else {
-            this.emit("close", null);
             this._setInternalState("disconnected");
+        //    this.emit("close", null);
             setImmediate(callback);
         }
     }
@@ -1569,12 +1573,14 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                  * @event close
                  * @param error
                  */
-                this.emit("close", err);
+                if (err) {
+                    this.emit("connection_lost", err?.message); // instead of "close"
+                }
+                this.emit("close", err); // instead of "close"
             } else {
                 /**
                  * @event connection_lost
                  */
-                // this.emit("close", err);
                 if (this.reconnectOnFailure && this._internalState !== "reconnecting") {
                     debugLog(" ClientBaseImpl emitting connection_lost");
                     this.emit("connection_lost", err?.message); // instead of "close"

package/source/private/client_publish_engine.ts

@@ -1,6 +1,7 @@
 /**
  * @module node-opcua-client-private
  */
+import { types } from "util";
 import * as async from "async";
 import * as chalk from "chalk";
 import { assert } from "node-opcua-assert";
@@ -471,7 +472,7 @@ export class ClientSidePublishEngine {
         debugLog("__repairSubscription  for SubscriptionId ", subscriptionId);
 
         this._republish(subscription, subscriptionId, (err?: Error) => {
-            assert(!err || err instanceof Error);
+            assert(!err || types.isNativeError(err));
 
             debugLog("__repairSubscription--------------------- err =", err ? err.message : null);
 

package/source/private/client_session_impl.ts

@@ -23,7 +23,7 @@ import { ExtensionObject } from "node-opcua-extension-object";
 import { coerceNodeId, NodeId, NodeIdLike, resolveNodeId } from "node-opcua-nodeid";
 import { getBuiltInDataType, getArgumentDefinitionHelper, IBasicSession, IBasicTransportSettings } from "node-opcua-pseudo-session";
 import { AnyConstructorFunc } from "node-opcua-schemas";
-import { requestHandleNotSetValue, SignatureData } from "node-opcua-secure-channel";
+import { ClientSecureChannelLayer, requestHandleNotSetValue, SignatureData } from "node-opcua-secure-channel";
 import { BrowseDescription, BrowseRequest, BrowseResponse, BrowseResult } from "node-opcua-service-browse";
 import { CallMethodRequest, CallMethodResult, CallRequest, CallResponse } from "node-opcua-service-call";
 import { EndpointDescription } from "node-opcua-service-endpoints";
@@ -309,7 +309,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
     get subscriptionCount(): number {
         return this._publishEngine ? this._publishEngine.subscriptionCount : 0;
     }
-
+    
     get isReconnecting(): boolean {
         return this._client ? this._client.isReconnecting || this._reconnecting?.reconnecting : false;
     }
@@ -546,13 +546,12 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
      * ```javascript
      *     const dataValues = await session.readVariableValue(["ns=1;s=Temperature","ns=1;s=Pressure"]);
      * ```
+     * 
+     * @deprecated
      */
     public readVariableValue(nodeId: NodeIdLike, callback: ResponseCallback<DataValue>): void;
-
     public readVariableValue(nodeIds: NodeIdLike[], callback: ResponseCallback<DataValue[]>): void;
-
     public async readVariableValue(nodeId: NodeIdLike): Promise<DataValue>;
-
     public async readVariableValue(nodeIds: NodeIdLike[]): Promise<DataValue[]>;
     /**
      * @internal
@@ -1999,7 +1998,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         });
     }
 
-    public startKeepAliveManager(): void {
+    public startKeepAliveManager(keepAliveInterval?: number): void {
         if (this._keepAliveManager) {
             //  "keepAliveManger already started"
             return;
@@ -2020,7 +2019,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
              */
             this.emit("keepalive", state, count);
         });
-        this._keepAliveManager.start();
+        this._keepAliveManager.start(keepAliveInterval);
     }
 
     public stopKeepAliveManager(): void {
@@ -2074,6 +2073,12 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 str += "\n reviseTokenLifetime...... " + this._client._secureChannel.securityToken.revisedLifetime;
             }
         }
+        str += "\n keepAlive ................ " + this._keepAliveManager ? true:  false;
+        if (this._keepAliveManager) {
+            str += "\n keepAlive checkInterval.. " + this._keepAliveManager.checkInterval;
+            str += "\n defaultTransportTimeout.. " + ClientSecureChannelLayer.defaultTransportTimeout;
+
+        } 
         return str;
     }
 

package/source/private/opcua_client_impl.ts

@@ -1049,7 +1049,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
                     session.serverNonce = response.serverNonce;
                     session.lastResponseReceivedTime = new Date();
                     if (this.keepSessionAlive) {
-                        session.startKeepAliveManager();
+                        session.startKeepAliveManager(this.keepAliveInterval);
                     }
                     session.userIdentityInfo = userIdentityInfo;
                     return callback(null, session);

package/source/reconnection.ts

@@ -11,6 +11,7 @@ import { TransferSubscriptionsRequest, TransferSubscriptionsResponse } from "nod
 import { CallbackT, StatusCode, StatusCodes } from "node-opcua-status-code";
 import { ErrorCallback } from "node-opcua-status-code";
 import { CloseSessionRequest } from "node-opcua-types";
+import { invalidateExtraDataTypeManager } from "node-opcua-client-dynamic-extension-object";
 
 import { SubscriptionId } from "./client_session";
 import { ClientSessionImpl, Reconnectable } from "./private/client_session_impl";
@@ -166,6 +167,11 @@ function repair_client_session_by_recreating_a_new_session(
     session: ClientSessionImpl,
     callback: (err?: Error) => void
 ) {
+
+    // As we don"t know if server has been rebooted or not,
+    // and may be upgraded in between, we have to invalidate the extra data type manager
+    invalidateExtraDataTypeManager(session);
+
     if (doDebug) {
         doDebug && debugLog(" repairing client session by_recreating a new session for old session ", session.sessionId.toString());
     }
@@ -210,13 +216,17 @@ function repair_client_session_by_recreating_a_new_session(
                     newSession,
                     newSession.userIdentityInfo!,
                     (err: Error | null, session1?: ClientSessionImpl) => {
-                        doDebug && debugLog(chalk.bgWhite.cyan("    =>  activating a new session .... Done err=", err ? err.message : "null"));
-                        if (err) {
-                            doDebug && debugLog(
-                                chalk.bgWhite.cyan(
-                                    "reactivation of the new session has failed: let be smart and close it before failing this repair attempt"
-                                )
+                        doDebug &&
+                            debugLog(
+                                chalk.bgWhite.cyan("    =>  activating a new session .... Done err=", err ? err.message : "null")
                             );
+                        if (err) {
+                            doDebug &&
+                                debugLog(
+                                    chalk.bgWhite.cyan(
+                                        "reactivation of the new session has failed: let be smart and close it before failing this repair attempt"
+                                    )
+                                );
                             // but just on the server side, not on the client side
                             const closeSessionRequest = new CloseSessionRequest({
                                 deleteSubscriptions: true
@@ -277,10 +287,11 @@ function repair_client_session_by_recreating_a_new_session(
 
                         // istanbul ignore next
                         if (doDebug) {
-                            doDebug && debugLog(
-                                chalk.cyan("    =>  transfer subscriptions  done"),
-                                results.map((x: any) => x.statusCode.toString()).join(" ")
-                            );
+                            doDebug &&
+                                debugLog(
+                                    chalk.cyan("    =>  transfer subscriptions  done"),
+                                    results.map((x: any) => x.statusCode.toString()).join(" ")
+                                );
                         }
 
                         const subscriptionsToRecreate = [];
@@ -291,22 +302,24 @@ function repair_client_session_by_recreating_a_new_session(
                             const statusCode = results[i].statusCode;
                             if (statusCode.equals(StatusCodes.BadSubscriptionIdInvalid)) {
                                 // repair subscription
-                                doDebug && debugLog(
-                                    chalk.red("         WARNING SUBSCRIPTION  "),
-                                    subscriptionsIds[i],
-                                    chalk.red(" SHOULD BE RECREATED")
-                                );
+                                doDebug &&
+                                    debugLog(
+                                        chalk.red("         WARNING SUBSCRIPTION  "),
+                                        subscriptionsIds[i],
+                                        chalk.red(" SHOULD BE RECREATED")
+                                    );
 
                                 subscriptionsToRecreate.push(subscriptionsIds[i]);
                             } else {
                                 const availableSequenceNumbers = results[i].availableSequenceNumbers;
 
-                                doDebug && debugLog(
-                                    chalk.green("         SUBSCRIPTION "),
-                                    subscriptionsIds[i],
-                                    chalk.green(" CAN BE REPAIRED AND AVAILABLE "),
-                                    availableSequenceNumbers
-                                );
+                                doDebug &&
+                                    debugLog(
+                                        chalk.green("         SUBSCRIPTION "),
+                                        subscriptionsIds[i],
+                                        chalk.green(" CAN BE REPAIRED AND AVAILABLE "),
+                                        availableSequenceNumbers
+                                    );
                                 // should be Good.
                             }
                         }
@@ -329,10 +342,11 @@ function repair_client_session_by_recreating_a_new_session(
                                         doDebug && debugLog("_recreateSubscription failed !" + err1.message);
                                     }
 
-                                    doDebug && debugLog(
-                                        chalk.cyan("          => RECREATING SUBSCRIPTION  AND MONITORED ITEM DONE "),
-                                        subscriptionId
-                                    );
+                                    doDebug &&
+                                        debugLog(
+                                            chalk.cyan("          => RECREATING SUBSCRIPTION  AND MONITORED ITEM DONE "),
+                                            subscriptionId
+                                        );
 
                                     next();
                                 });
@@ -379,7 +393,8 @@ function repair_client_session_by_recreating_a_new_session(
 
 function _repair_client_session(client: IClientBase, session: ClientSessionImpl, callback: (err?: Error) => void): void {
     const callback2 = (err2?: Error) => {
-        doDebug && debugLog("Session repair completed with err: ", err2 ? err2.message : "<no error>", session.sessionId.toString());
+        doDebug &&
+            debugLog("Session repair completed with err: ", err2 ? err2.message : "<no error>", session.sessionId.toString());
         session.emit("session_repaired");
         callback(err2);
     };