node-opcua-client 2.163.1 → 2.164.2

package/source/private/client_base_impl.ts

@@ -42,7 +42,7 @@ import {
 } from "node-opcua-service-endpoints";
 import { ChannelSecurityToken, coerceMessageSecurityMode, MessageSecurityMode } from "node-opcua-service-secure-channel";
 import { ErrorCallback, StatusCode, StatusCodes } from "node-opcua-status-code";
-import { matchUri } from "node-opcua-utils";
+import { matchUri, checkFileExistsAndIsNotEmpty } from "node-opcua-utils";
 
 import { getDefaultCertificateManager, makeSubject, OPCUACertificateManager } from "node-opcua-certificate-manager";
 import { VerificationStatus } from "node-opcua-pki";
@@ -124,7 +124,7 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
             // rebind backoff handler
             masterClient.listeners("backoff").forEach((handler: any) => client.on("backoff", handler));
 
-            // istanbul ignore next
+            // c8 ignore next
             if (doDebug) {
                 client.on("backoff", (retryCount: number, delay: number) => {
                     debugLog(
@@ -160,7 +160,7 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
                     err.message = "error in getEndpoints \n" + err.message;
                     return innerCallback(err);
                 }
-                // istanbul ignore next
+                // c8 ignore next
                 if (!endpoints) {
                     return innerCallback(new Error("Internal Error"));
                 }
@@ -206,7 +206,7 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
             );
         }
 
-        // istanbul ignore next
+        // c8 ignore next
         if (doDebug) {
             debugLog(chalk.bgWhite.red("xxxxxxxxxxxxxxxxxxxxx => selected EndPoint = "), selectedEndpoint.toString());
         }
@@ -228,7 +228,7 @@ async function _verify_serverCertificate(
     serverCertificate: Certificate) {
     const status = await certificateManager.checkCertificate(serverCertificate);
     if (status !== StatusCodes.Good) {
-        // istanbul ignore next
+        // c8 ignore next
         if (doDebug) {
             // do it again for debug purposes
             const status1 = await certificateManager.verifyCertificate(serverCertificate);
@@ -413,7 +413,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         this._internalState = internalState;
     }
     public emit(eventName: string | symbol, ...others: any[]): boolean {
-        // istanbul ignore next
+        // c8 ignore next
         if (doDebug) {
             debugLog(chalk.cyan(`  Client ${this._instanceNumber} ${this.clientName} emitting `), chalk.magentaBright(eventName));
         }
@@ -442,6 +442,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         this._applicationUri = options.applicationUri || this._getBuiltApplicationUri();
 
         this.clientCertificateManager = options.clientCertificateManager;
+        this.clientCertificateManager.referenceCounter++;
 
         this._secureChannel = null;
 
@@ -497,7 +498,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         // _cancel_reconnection is invoked during disconnection
         // when we detect that a reconnection is in progress...
 
-        // istanbul ignore next
+        // c8 ignore next
         if (!this.isReconnecting) {
             warningLog("internal error: _cancel_reconnection should only be used when reconnecting is in progress");
         }
@@ -506,7 +507,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
         this._reconnectionIsCanceled = true;
 
-        // istanbul ignore next
+        // c8 ignore next
         if (!this._secureChannel) {
             debugLog("_cancel_reconnection:  Nothing to do for !", this.clientName, " because secure channel doesn't exist");
             return callback(); // nothing to do
@@ -587,7 +588,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
             this._internal_create_secure_channel(infiniteConnectionRetry, (err?: Error | null) => {
                 if (err) {
-                    // istanbul ignore next
+                    // c8 ignore next
                     if (this._secureChannel) {
                         const err = new Error("_internal_create_secure_channel failed, expecting this._secureChannel not to exist");
                         return _when_internal_error(err, callback);
@@ -773,21 +774,22 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 validity: 365 * 10 // 10 years
             });
         }
-        // istanbul ignore next
+        // c8 ignore next
         if (!fs.existsSync(certificateFile)) {
             throw new Error(" cannot locate certificate file " + certificateFile);
         }
     }
 
     public async createDefaultCertificate(): Promise<void> {
-        // istanbul ignore next
+        // c8 ignore next
         if ((this as any)._inCreateDefaultCertificate) {
             errorLog("Internal error : re-entrancy in createDefaultCertificate!");
         }
         (this as any)._inCreateDefaultCertificate = true;
-        if (!fs.existsSync(this.certificateFile)) {
+
+        if (!checkFileExistsAndIsNotEmpty(this.certificateFile)) {
             await withLock({ fileToLock: this.certificateFile + ".mutex" }, async () => {
-                if (fs.existsSync(this.certificateFile)) {
+                if (checkFileExistsAndIsNotEmpty(this.certificateFile)) {
                     // the file may have been created in between
                     return;
                 }
@@ -829,15 +831,17 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         }
         await this.clientCertificateManager.initialize();
         await this.createDefaultCertificate();
-        // istanbul ignore next
+        // c8 ignore next
         if (!fs.existsSync(this.privateKeyFile)) {
             throw new Error(" cannot locate private key file " + this.privateKeyFile);
         }
         if (this.isUnusable()) return;
 
-        await this.clientCertificateManager.withLock2(async () => {
-            await performCertificateSanityCheck(this, "client", this.clientCertificateManager, this._getBuiltApplicationUri());
-        });
+        // Note: do NOT wrap this in withLock2 — performCertificateSanityCheck
+        // calls trustCertificate and verifyCertificate which each acquire
+        // withLock2 internally, so an outer withLock2 would cause a deadlock
+        // on the same file-based mutex.
+        await performCertificateSanityCheck(this, "client", this.clientCertificateManager, this._getBuiltApplicationUri());
     }
 
     protected _internalState: InternalClientState = "uninitialized";
@@ -877,7 +881,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         }
         assert(typeof endpointUrl === "string" && endpointUrl.length > 0);
 
-        // istanbul ignore next
+        // c8 ignore next
         if (this._internalState !== "disconnected") {
             callback(new Error(`client#connect failed, as invalid internal state = ${this._internalState}`));
             return;
@@ -1075,7 +1079,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 return callback(err);
             }
             this._serverEndpoints = [];
-            // istanbul ignore next
+            // c8 ignore next
             if (!response || !(response instanceof GetEndpointsResponse)) {
                 return callback(new Error("Internal Error"));
             }
@@ -1117,7 +1121,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             if (err) {
                 return callback(err);
             }
-            /* istanbul ignore next */
+            /* c8 ignore next */
             if (!response || !(response instanceof FindServersResponse)) {
                 return callback(new Error("Internal Error"));
             }
@@ -1142,7 +1146,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             if (err) {
                 return callback(err);
             }
-            /* istanbul ignore next */
+            /* c8 ignore next */
             if (!response || !(response instanceof FindServersOnNetworkResponse)) {
                 return new Error("Internal Error");
             }
@@ -1170,7 +1174,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         assert(typeof callback === "function");
         assert(typeof deleteSubscriptions === "boolean");
 
-        // istanbul ignore next
+        // c8 ignore next
         if (!this._secureChannel) {
             return callback(null); // new Error("no channel"));
         }
@@ -1276,7 +1280,9 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
         if (this.clientCertificateManager) {
             const tmp = this.clientCertificateManager;
             // (this as any).clientCertificateManager = null;
-            tmp.dispose();
+            tmp.dispose().catch((err: Error) => {
+                debugLog("Error disposing clientCertificateManager", err.message);
+            });
         }
 
         if (this._sessions.length) {
@@ -1411,7 +1417,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 return callback(err);
             }
 
-            // istanbul ignore next
+            // c8 ignore next
             if (!result) {
                 const err1 = new Error("internal error");
                 return callback(err1);
@@ -1471,7 +1477,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
             this._byteRead += this._secureChannel.bytesRead;
             this._transactionsPerformed += this._secureChannel.transactionsPerformed;
             this._timedOutRequestCount += this._secureChannel.timedOutRequestCount;
-            // istanbul ignore next
+            // c8 ignore next
             if (doDebug) {
                 const h = `Client ${this._instanceNumber} ${this.clientName}`;
                 debugLog(chalk.cyan(`${h} byteWritten          = `), this._byteWritten);
@@ -1483,7 +1489,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     }
     private _destroy_secure_channel() {
         if (this._secureChannel) {
-            // istanbul ignore next
+            // c8 ignore next
             if (doDebug) {
                 debugLog(
                     " DESTROYING SECURE CHANNEL (isTransactionInProgress ?",
@@ -1525,7 +1531,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 });
             },
             (err) => {
-                // istanbul ignore next
+                // c8 ignore next
                 if (this._sessions.length > 0) {
                     debugLog(
                         this._sessions
@@ -1694,7 +1700,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
                 if (this.isUnusable()) return;
                 this._finalReconnectionStep((err2?: Error | null) => {
                     if (err2) {
-                        // istanbul ignore next
+                        // c8 ignore next
                         if (doDebug) {
                             debugLog("connection_reestablished has failed");
                             debugLog("err= ", err2.message);
@@ -1768,7 +1774,7 @@ class TmpClient extends ClientBaseImpl {
     connect(endpoint: string, callback?: ErrorCallback): any {
         debugLog("connecting to TmpClient");
 
-        // istanbul ignore next
+        // c8 ignore next
         if (this._internalState !== "disconnected") {
             callback!(new Error("TmpClient#connect: invalid internal state = " + this._internalState));
             return;

package/source/private/client_monitored_item_impl.ts

@@ -265,7 +265,7 @@ export class ClientMonitoredItemImpl extends EventEmitter implements ClientMonit
 
             const filter = this.monitoringParameters.filter;
 
-            // istanbul ignore next
+            // c8 ignore next
             if (!filter) {
                 return { error: "Internal Error" };
             }
@@ -310,7 +310,6 @@ export class ClientMonitoredItemImpl extends EventEmitter implements ClientMonit
     public _applyResult(monitoredItemResult: MonitoredItemCreateResult): void {
         this.statusCode = monitoredItemResult.statusCode;
 
-        /* istanbul ignore else */
         if (monitoredItemResult.statusCode.isGood()) {
             this.result = monitoredItemResult;
             this.monitoredItemId = monitoredItemResult.monitoredItemId;

package/source/private/client_publish_engine.ts

@@ -281,7 +281,7 @@ export class ClientSidePublishEngine {
                     // There is no need to send more publish request for the time being until reconnection is completed
                     active = false;
                 }
-                // istanbul ignore next
+                // c8 ignore next
                 if (err.message.match(/BadNoSubscription/) && this.activeSubscriptionCount >= 1) {
                     // there is something wrong happening here.
                     // the server tells us that there is no subscription for this session
@@ -325,8 +325,23 @@ export class ClientSidePublishEngine {
                         warningLog(" => nbMaxPublishRequestsAcceptedByServer =", this.nbMaxPublishRequestsAcceptedByServer);
                     }
                 }
+                if (err.message.match(/BadSecureChannelIdInvalid/)) {
+                    // This can happen transiently during session transfer to a new
+                    // SecureChannel (e.g. after server certificate change). The
+                    // PublishRequest arrived on the new channel before ActivateSession
+                    // completed the session transfer. We should pause and let the
+                    // reconnection flow replenish publish requests once the session
+                    // transfer completes.
+                    debugLog(
+                        chalk.bgWhite.yellow(
+                            " WARNING: BadSecureChannelIdInvalid on PublishRequest"
+                            + " - session transfer may be in progress"
+                        )
+                    );
+                    active = false;
+                }
             } else {
-                // istanbul ignore next
+                // c8 ignore next
                 if (doDebug) {
                     debugLog(chalk.cyan("ClientSidePublishEngine.prototype.internalSendPublishRequest callback "));
                 }
@@ -380,7 +395,7 @@ export class ClientSidePublishEngine {
                 // delegate notificationData to the subscription callback
                 subscription.onNotificationMessage(notificationMessage);
             } catch (err) {
-                // istanbul ignore next
+                // c8 ignore next
                 if (doDebug) {
                     debugLog(err);
                     debugLog("Exception in onNotificationMessage");