node-opcua-client 2.99.0 → 2.101.0

package/source/private/client_base_impl.ts

@@ -69,13 +69,11 @@ import { performCertificateSanityCheck } from "../verify";
 import { ClientSessionImpl } from "./client_session_impl";
 import { IClientBase } from "./i_private_client";
 
-// tslint:disable-next-line:no-var-requires
-const once = require("once");
-
 const debugLog = make_debugLog(__filename);
 const doDebug = checkDebugFlag(__filename);
 const errorLog = make_errorLog(__filename);
 const warningLog = make_warningLog(__filename);
+const traceInternalState = false;
 
 const defaultConnectionStrategy: ConnectionStrategyOptions = {
     initialDelay: 1000,
@@ -268,6 +266,7 @@ type InternalClientState =
     | "disconnected"
     | "connecting"
     | "connected"
+    | "panic"
     | "reconnecting"
     | "reconnecting_newchannel_connected"
     | "disconnecting";
@@ -389,9 +388,9 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
     protected _setInternalState(internalState: InternalClientState): void {
         const previousState = this._internalState;
-        if (doDebug) {
-            debugLog(
-                chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} from    `),
+        if (doDebug || traceInternalState) {
+            (traceInternalState ? warningLog : debugLog)(
+                chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} : _internalState from    `),
                 chalk.yellow(previousState),
                 "to",
                 chalk.yellow(internalState)
@@ -476,12 +475,17 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
     private _cancel_reconnection(callback: ErrorCallback) {
         // _cancel_reconnection is invoked during disconnection
-        // when we detect that a reconnection is in progress..
+        // when we detect that a reconnection is in progress...
+
+        // istanbul ignore next
         if (!this.isReconnecting) {
-            warningLog("internal error : _cancel_reconnection should be used when reconnecting is in progress");
+            warningLog("internal error: _cancel_reconnection should only be used when reconnecting is in progress");
         }
+
         debugLog("canceling reconnection");
+
         this._reconnectionIsCanceled = true;
+
         // istanbul ignore next
         if (!this._secureChannel) {
             debugLog("_cancel_reconnection:  Nothing to do !");
@@ -502,7 +506,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
         if (!this.knowsServerEndpoint) {
             debugLog("Cannot reconnect , server endpoint is unknown");
-            return callback(new Error("Cannot reconnect, server endpoint is unknown"));
+            return callback(new Error("Cannot reconnect, server endpoint is unknown - this.knowsServerEndpoint = false"));
         }
         assert(this.knowsServerEndpoint);
 
@@ -521,7 +525,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         };
 
         const _when_reconnectionIsCanceled = (callback: ErrorCallback) => {
-            warningLog("attempt to recreate a new secure channel : suspended becasue reconnection is canceled !");
+            warningLog("attempt to recreate a new secure channel : suspended because reconnection is canceled !");
             this.emit("reconnection_canceled");
             return callback(new Error("Reconnection has been canceled - " + this.clientName));
         };
@@ -573,7 +577,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
                     if (
                         err!.message.match("BadCertificateInvalid") ||
-                        err!.message.match(/_socket has been disconnected by third party/)
+                        err!.message.match(/socket has been disconnected by third party/)
                     ) {
                         warningLog(
                             "the server certificate has changed,  we need to retrieve server certificate again: ",
@@ -695,7 +699,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             ],
             (err) => {
                 if (err) {
-                    debugLog("Inner create secure channel has failed", err.message);
+                    errorLog("Inner create secure channel has failed", err.message);
                     if (this._secureChannel) {
                         this._secureChannel!.abortConnection(() => {
                             this._destroy_secure_channel();
@@ -839,7 +843,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
         // istanbul ignore next
         if (this._internalState !== "disconnected") {
-            callback(new Error("invalid internal state = " + this._internalState));
+            callback(new Error(`client#connect failed, as invalid internal state = ${this._internalState}`));
             return;
         }
 
@@ -941,6 +945,16 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         return this._secureChannel ? this._secureChannel.getClientNonce() : null;
     }
 
+    public requestReconnection() {
+        if (this._secureChannel) {
+            this._secureChannel.abortConnection(() => {
+                errorLog("new connection requested");
+                /*
+                 */
+            });
+        }
+    }
+
     public performMessageTransaction(request: Request, callback: ResponseCallback<Response>): void {
         if (!this._secureChannel) {
             // this may happen if the Server has closed the connection abruptly for some unknown reason
@@ -960,7 +974,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                     "performMessageTransaction: Invalid client state " +
                         this._internalState +
                         " while performing a transaction " +
-                        request.constructor.name
+                        request.schema.name
                 )
             );
         }
@@ -1035,10 +1049,10 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         });
 
         this.performMessageTransaction(request, (err: Error | null, response?: Response) => {
-            this._serverEndpoints = [];
             if (err) {
                 return callback(err);
             }
+            this._serverEndpoints = [];
             // istanbul ignore next
             if (!response || !(response instanceof GetEndpointsResponse)) {
                 return callback(new Error("Internal Error"));
@@ -1065,13 +1079,6 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     public findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;
     public findServers(callback: ResponseCallback<ApplicationDescription[]>): void;
     public findServers(...args: any[]): any {
-        if (!this._secureChannel) {
-            setImmediate(() => {
-                callback(new Error("Invalid Secure Channel"));
-            });
-            return;
-        }
-
         if (args.length === 1) {
             return this.findServers({}, args[0]);
         }
@@ -1107,14 +1114,6 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         }
         const options = args[0] as FindServersOnNetworkRequestOptions;
         const callback = args[1] as ResponseCallback<ServerOnNetwork[]>;
-
-        if (!this._secureChannel) {
-            setImmediate(() => {
-                callback(new Error("Invalid Secure Channel"));
-            });
-            return;
-        }
-
         const request = new FindServersOnNetworkRequest(options);
 
         this.performMessageTransaction(request, (err: Error | null, response?: Response) => {
@@ -1325,6 +1324,10 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         str += "  applicationName............... " + this.applicationName + "\n";
         str += "  applicationUri................ " + this._getBuiltApplicationUri() + "\n";
         str += "  clientName.................... " + this.clientName + "\n";
+        str += "  reconnectOnFailure............ " + this.reconnectOnFailure + "\n";
+        str += "  isReconnecting................ " + this.isReconnecting + "\n";
+        str += "  (internal state).............. " + this._internalState + "\n";
+        str += "  sessions count................ " + this.getSessions().length + "\n";
 
         if (this._secureChannel) {
             str += "secureChannel:\n" + this._secureChannel.toString();
@@ -1432,19 +1435,11 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             this._transactionsPerformed += this._secureChannel.transactionsPerformed;
             this._timedOutRequestCount += this._secureChannel.timedOutRequestCount;
             if (doDebug) {
-                debugLog(
-                    chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} byteWritten          = `),
-                    this._byteWritten
-                );
-                debugLog(chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} byteRead             = `), this._byteRead);
-                debugLog(
-                    chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} transactions         = `),
-                    this._transactionsPerformed
-                );
-                debugLog(
-                    chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} timedOutRequestCount = `),
-                    this._timedOutRequestCount
-                );
+                const h = `Client ${this._instanceNumber} ${this.clientName}`;
+                debugLog(chalk.cyan(`${h} byteWritten          = `), this._byteWritten);
+                debugLog(chalk.cyan(`${h} byteRead             = `), this._byteRead);
+                debugLog(chalk.cyan(`${h} transactions         = `), this._transactionsPerformed);
+                debugLog(chalk.cyan(`${h} timedOutRequestCount = `), this._timedOutRequestCount);
             }
         }
     }
@@ -1563,6 +1558,9 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         });
 
         secureChannel.on("close", (err?: Error | null) => {
+            if (err) {
+                this._setInternalState("panic");
+            }
             debugLog(chalk.yellow.bold(" ClientBaseImpl emitting close"), err?.message);
             this._destroy_secure_channel();
             if (!err || !this.reconnectOnFailure) {
@@ -1687,7 +1685,7 @@ class TmpClient extends ClientBaseImpl {
 
         // istanbul ignore next
         if (this._internalState !== "disconnected") {
-            callback!(new Error("TmpClient#connect: invalid internal state " + this._internalState));
+            callback!(new Error("TmpClient#connect: invalid internal state = " + this._internalState));
             return;
         }
 

package/source/private/client_session_impl.ts

@@ -2,6 +2,7 @@
  * @module node-opcua-client-private
  */
 import { EventEmitter } from "events";
+import { callbackify } from "util";
 import * as chalk from "chalk";
 import { assert } from "node-opcua-assert";
 import { AggregateFunction } from "node-opcua-constants";
@@ -293,7 +294,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         this.timeout = 0;
     }
 
-
     getTransportSettings(): IBasicTransportSettings {
         return this._client!.getTransportSettings();
     }
@@ -1556,19 +1556,27 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         return this._client !== null && this._client._secureChannel !== null && this._client._secureChannel.isOpened();
     }
 
+    private requestReconnection() {
+        if (this._client) {
+            this._client.requestReconnection();
+            assert(this._client.isReconnecting === true, "expecting client to be reconnecting now");
+        }
+    }
+
     public performMessageTransaction(request: Request, callback: (err: Error | null, response?: Response) => void): void {
         if (!this._client) {
             // session may have been closed by user ... but is still in used !!
             return callback(new Error("Session has been closed and should not be used to perform a transaction anymore"));
         }
 
-        if (!this.isChannelValid()) {
-            // the secure channel is broken, may be the server has crashed or the network cable has been disconnected
-            // for a long time
-            // we may need to queue this transaction, as a secure token may be being reprocessed
-            debugLog(chalk.bgWhite.red("!!! Performing transaction on invalid channel !!! ", request.constructor.name));
-            return callback(new Error("Invalid Channel after performing transaction on " + request.constructor.name));
-        }
+        // if (!this.isChannelValid()) {
+        //     // the secure channel is broken, may be the server has crashed or the network cable has been disconnected
+        //     // for a long time
+        //     // we may need to queue this transaction, as a secure token may be being reprocessed
+        //     errorLog(chalk.bgWhite.red("!!! Performing transaction on invalid channel !!! ", request.schema.name));
+        //     // this.requestReconnection();
+        //     return callback(new Error("!!! Performing transaction on invalid channel with " + request.schema.name + ": starting reconnection process"));
+        // }
 
         this._reconnecting.pendingTransactions = this._reconnecting.pendingTransactions || [];
         this._reconnecting.pendingTransactionsCount = this._reconnecting.pendingTransactionsCount || 0;
@@ -2014,7 +2022,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         });
         this._keepAliveManager.start();
     }
-    
+
     public stopKeepAliveManager(): void {
         if (this._keepAliveManager) {
             this._keepAliveManager.stop();
@@ -2300,19 +2308,18 @@ async function promoteOpaqueStructure2(session: IBasicSession, callMethodResult:
 function countOpaqueStructures(callMethodResults: CallMethodResult[]): number {
     const x = (a: Variant[] | null): PseudoDataValue[] => {
         if (a === null) return [] as PseudoDataValue[];
-        return a.map((value) => { return { value: value } });
-    }
-    const opaqueStructureCount = callMethodResults.reduce(
-        (prev, callMethodResult) => {
-            return prev + extractDataValueToPromote(x(callMethodResult.outputArguments)).length;
-        }, 0);
+        return a.map((value) => {
+            return { value: value };
+        });
+    };
+    const opaqueStructureCount = callMethodResults.reduce((prev, callMethodResult) => {
+        return prev + extractDataValueToPromote(x(callMethodResult.outputArguments)).length;
+    }, 0);
     return opaqueStructureCount;
 }
 async function promoteOpaqueStructure3(session: IBasicSession, callMethodResults: CallMethodResult[]): Promise<void> {
-
     const opaqueStructureCount = countOpaqueStructures(callMethodResults);
-    if (0 === opaqueStructureCount)
-        return;
+    if (0 === opaqueStructureCount) return;
 
     // construct dataTypeManager if not already present
     await getExtraDataTypeManager(session);
@@ -2324,11 +2331,11 @@ async function promoteOpaqueStructure3(session: IBasicSession, callMethodResults
 // tslint:disable:no-var-requires
 // tslint:disable:max-line-length
 const thenify = require("thenify");
-const callbackify = require("callbackify");
 const opts = { multiArgs: false };
 
 const promoteOpaqueStructureWithCallback = callbackify(promoteOpaqueStructure);
 const promoteOpaqueStructure3WithCallback = callbackify(promoteOpaqueStructure3) as promoteOpaqueStructure3WithCallbackFunc;
+// ClientSessionImpl.prototype.constructExtensionObject = callbackify(ClientSessionImpl.prototype.constructExtensionObject) as any;
 
 ClientSessionImpl.prototype.browse = thenify.withCallback(ClientSessionImpl.prototype.browse, opts);
 ClientSessionImpl.prototype.browseNext = thenify.withCallback(ClientSessionImpl.prototype.browseNext, opts);
@@ -2367,5 +2374,4 @@ ClientSessionImpl.prototype.registerNodes = thenify.withCallback(ClientSessionIm
 ClientSessionImpl.prototype.unregisterNodes = thenify.withCallback(ClientSessionImpl.prototype.unregisterNodes, opts);
 ClientSessionImpl.prototype.readNamespaceArray = thenify.withCallback(ClientSessionImpl.prototype.readNamespaceArray, opts);
 ClientSessionImpl.prototype.getBuiltInDataType = thenify.withCallback(ClientSessionImpl.prototype.getBuiltInDataType, opts);
-ClientSessionImpl.prototype.constructExtensionObject = callbackify(ClientSessionImpl.prototype.constructExtensionObject);
 ClientSessionImpl.prototype.changeUser = thenify.withCallback(ClientSessionImpl.prototype.changeUser, opts);

package/source/private/i_private_client.ts

@@ -26,4 +26,6 @@ export interface IClientBase {
     _sessions: ClientSessionImpl[];
 
     getTransportSettings(): IBasicTransportSettings;
+
+    requestReconnection(): void;
 }

package/source/private/opcua_client_impl.ts

@@ -755,10 +755,10 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
         }
         // istanbul ignore next
         if (!this.__resolveEndPoint() || !this.endpoint) {
-            return callback!(            
+            return callback!(
                 new Error(
-                    " End point must exist " + this._secureChannel!.endpointUrl + 
-                    "  securityMode = " + MessageSecurityMode[this.securityMode] + 
+                    " End point must exist " + this._secureChannel!.endpointUrl +
+                    "  securityMode = " + MessageSecurityMode[this.securityMode] +
                     "  securityPolicy = " + this.securityPolicy));
         }
 
@@ -805,10 +805,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
      * @private
      */
     public _on_connection_reestablished(callback: (err?: Error) => void): void {
-        assert(typeof callback === "function");
-
-        // call base class implementation first
-        ClientBaseImpl.prototype._on_connection_reestablished.call(this, (/*err?: Error*/) => {
+        super._on_connection_reestablished((/*err?: Error*/) => {
             repair_client_sessions(this, callback);
         });
     }
@@ -849,7 +846,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
         this.clientNonce = crypto.randomBytes(32);
 
         // recycle session name if already exists
-        const sessionName =  session.name 
+        const sessionName = session.name
 
         const request = new CreateSessionRequest({
             clientCertificate: this.getCertificate(),
@@ -1163,15 +1160,15 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
                     this._serverEndpoints.map(
                         (endpoint) =>
                             endpoint.endpointUrl + " "
-                             + MessageSecurityMode[endpoint.securityMode] + " " 
-                             + endpoint.securityPolicyUri + " " 
-                             + endpoint.userIdentityTokens?.map((u)=> UserTokenType[u.tokenType]).join(",")
+                            + MessageSecurityMode[endpoint.securityMode] + " "
+                            + endpoint.securityPolicyUri + " "
+                            + endpoint.userIdentityTokens?.map((u) => UserTokenType[u.tokenType]).join(",")
                     ).join('\n')
                 );
             }
             return callback(new Error(
-                " End point must exist " + this._secureChannel!.endpointUrl + 
-                "  securityMode = " + MessageSecurityMode[this.securityMode] + 
+                " End point must exist " + this._secureChannel!.endpointUrl +
+                "  securityMode = " + MessageSecurityMode[this.securityMode] +
                 "  securityPolicy = " + this.securityPolicy));
         }
         this.serverUri = this.endpoint.server.applicationUri || "invalid application uri";

package/source/reconnection.ts

@@ -139,7 +139,7 @@ function create_session_and_repeat_if_failed(
     callback: CallbackT<ClientSessionImpl>
 ) {
     if (session.hasBeenClosed()) {
-        doDebug && debugLog("Cannot complete subscription republish due to session terminatio");
+        doDebug && debugLog("Cannot complete subscription republish due to session termination");
         return callback(new Error("Cannot complete subscription republish due to session termination"));
     }
     doDebug && debugLog(chalk.bgWhite.red("    => creating a new session ...."));
@@ -147,7 +147,7 @@ function create_session_and_repeat_if_failed(
     // so we can reuse subscriptions data
     client.__createSession_step2(session, (err: Error | null, session1?: ClientSessionImpl) => {
         if (err && session.hasBeenClosed()) {
-            doDebug && debugLog("Cannot complete subscription republish due to session terminatio");
+            doDebug && debugLog("Cannot complete subscription republish due to session termination");
             return callback(new Error("Cannot complete subscription republish due to session termination"));
         }
         if (!err && session1) {
@@ -433,9 +433,14 @@ export function repair_client_session(client: IClientBase, session: ClientSessio
                 session.sessionId.toString(),
                 " => Let's retry"
             );
-            setTimeout(() => {
-                _repair_client_session(client, session, callback);
-            }, 2000);
+            if (!session.hasBeenClosed()) {
+                setTimeout(() => {
+                    _repair_client_session(client, session, callback);
+                }, 2000);
+            } else {
+                // session does not need to be repaired anymore
+                callback();
+            }
             return;
         }
         doDebug && debugLog(chalk.yellow("session has been restored"), session.sessionId.toString());
@@ -452,9 +457,8 @@ export function repair_client_session(client: IClientBase, session: ClientSessio
 }
 
 export function repair_client_sessions(client: IClientBase, callback: (err?: Error) => void): void {
-    const self = client;
     // repair session
-    const sessions = self.getSessions();
+    const sessions = client.getSessions();
     doDebug && debugLog(chalk.red.bgWhite(" Starting sessions reactivation", sessions.length));
     async.map(
         sessions,