node-opcua-client 2.167.0 → 2.168.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-client",
-    "version": "2.167.0",
+    "version": "2.168.0",
     "description": "pure nodejs OPCUA SDK - module client",
     "scripts": {
         "clean": "npx rimraf -g node_modules dist *.tsbuildinfo certificates",
@@ -15,56 +15,55 @@
     "types": "./dist/index.d.ts",
     "dependencies": {
         "@ster5/global-mutex": "^3.3.0",
-        "async": "^3.2.6",
         "chalk": "4.1.2",
-        "node-opcua-alarm-condition": "2.167.0",
+        "node-opcua-alarm-condition": "2.168.0",
         "node-opcua-assert": "2.164.0",
-        "node-opcua-basic-types": "2.167.0",
-        "node-opcua-buffer-utils": "2.167.0",
-        "node-opcua-certificate-manager": "2.167.0",
-        "node-opcua-client-dynamic-extension-object": "2.167.0",
-        "node-opcua-common": "2.167.0",
+        "node-opcua-basic-types": "2.168.0",
+        "node-opcua-buffer-utils": "2.168.0",
+        "node-opcua-certificate-manager": "2.168.0",
+        "node-opcua-client-dynamic-extension-object": "2.168.0",
+        "node-opcua-common": "2.168.0",
         "node-opcua-constants": "2.157.0",
         "node-opcua-crypto": "5.3.3",
-        "node-opcua-data-model": "2.167.0",
-        "node-opcua-data-value": "2.167.0",
-        "node-opcua-date-time": "2.167.0",
-        "node-opcua-debug": "2.165.0",
-        "node-opcua-extension-object": "2.167.0",
+        "node-opcua-data-model": "2.168.0",
+        "node-opcua-data-value": "2.168.0",
+        "node-opcua-date-time": "2.168.0",
+        "node-opcua-debug": "2.168.0",
+        "node-opcua-extension-object": "2.168.0",
         "node-opcua-hostname": "2.167.0",
-        "node-opcua-nodeid": "2.167.0",
-        "node-opcua-numeric-range": "2.167.0",
-        "node-opcua-object-registry": "2.165.0",
+        "node-opcua-nodeid": "2.168.0",
+        "node-opcua-numeric-range": "2.168.0",
+        "node-opcua-object-registry": "2.168.0",
         "node-opcua-pki": "6.12.0",
-        "node-opcua-pseudo-session": "2.167.0",
-        "node-opcua-schemas": "2.167.0",
-        "node-opcua-secure-channel": "2.167.0",
-        "node-opcua-service-browse": "2.167.0",
-        "node-opcua-service-call": "2.167.0",
-        "node-opcua-service-discovery": "2.167.0",
-        "node-opcua-service-endpoints": "2.167.0",
-        "node-opcua-service-filter": "2.167.0",
-        "node-opcua-service-history": "2.167.0",
-        "node-opcua-service-query": "2.167.0",
-        "node-opcua-service-read": "2.167.0",
-        "node-opcua-service-register-node": "2.167.0",
-        "node-opcua-service-secure-channel": "2.167.0",
-        "node-opcua-service-session": "2.167.0",
-        "node-opcua-service-subscription": "2.167.0",
-        "node-opcua-service-translate-browse-path": "2.167.0",
-        "node-opcua-service-write": "2.167.0",
-        "node-opcua-status-code": "2.167.0",
-        "node-opcua-types": "2.167.0",
-        "node-opcua-utils": "2.165.0",
-        "node-opcua-variant": "2.167.0",
+        "node-opcua-pseudo-session": "2.168.0",
+        "node-opcua-schemas": "2.168.0",
+        "node-opcua-secure-channel": "2.168.0",
+        "node-opcua-service-browse": "2.168.0",
+        "node-opcua-service-call": "2.168.0",
+        "node-opcua-service-discovery": "2.168.0",
+        "node-opcua-service-endpoints": "2.168.0",
+        "node-opcua-service-filter": "2.168.0",
+        "node-opcua-service-history": "2.168.0",
+        "node-opcua-service-query": "2.168.0",
+        "node-opcua-service-read": "2.168.0",
+        "node-opcua-service-register-node": "2.168.0",
+        "node-opcua-service-secure-channel": "2.168.0",
+        "node-opcua-service-session": "2.168.0",
+        "node-opcua-service-subscription": "2.168.0",
+        "node-opcua-service-translate-browse-path": "2.168.0",
+        "node-opcua-service-write": "2.168.0",
+        "node-opcua-status-code": "2.168.0",
+        "node-opcua-types": "2.168.0",
+        "node-opcua-utils": "2.168.0",
+        "node-opcua-variant": "2.168.0",
         "thenify-ex": "4.4.0"
     },
     "devDependencies": {
         "dequeue": "^1.0.5",
-        "node-opcua-address-space": "2.167.0",
-        "node-opcua-binary-stream": "2.167.0",
-        "node-opcua-factory": "2.167.0",
-        "node-opcua-leak-detector": "2.165.0",
+        "node-opcua-address-space": "2.168.0",
+        "node-opcua-binary-stream": "2.168.0",
+        "node-opcua-factory": "2.168.0",
+        "node-opcua-leak-detector": "2.168.0",
         "node-opcua-nodesets": "2.163.1"
     },
     "eslintConfig": {
@@ -87,7 +86,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "5decfa86ee53a36ecd3bb454e7bf6e3dd27c7a4e",
+    "gitHead": "653b6d6df801ca17298308089dee32e5b12102b6",
     "files": [
         "dist",
         "source"

package/source/private/client_base_impl.ts

@@ -6,52 +6,26 @@ import fs from "node:fs";
 import path from "node:path";
 
 import { withLock } from "@ster5/global-mutex";
-import async from "async";
+
 import chalk from "chalk";
 import { assert } from "node-opcua-assert";
-import {
-    getDefaultCertificateManager,
-    makeSubject,
-    type OPCUACertificateManager
-} from "node-opcua-certificate-manager";
-import {
-    type IOPCUASecureObjectOptions,
-    makeApplicationUrn,
-    OPCUASecureObject
-} from "node-opcua-common";
-import {
-    type Certificate,
-    makeSHA1Thumbprint,
-    split_der
-} from "node-opcua-crypto/web";
-import {
-    installPeriodicClockAdjustment,
-    periodicClockAdjustment,
-    uninstallPeriodicClockAdjustment
-} from "node-opcua-date-time";
-import {
-    checkDebugFlag,
-    make_debugLog,
-    make_errorLog,
-    make_warningLog
-} from "node-opcua-debug";
-import {
-    getHostname
-} from "node-opcua-hostname";
-import type {
-    IBasicTransportSettings,
-    ResponseCallback
-} from "node-opcua-pseudo-session";
+import { getDefaultCertificateManager, makeSubject, type OPCUACertificateManager } from "node-opcua-certificate-manager";
+import { type IOPCUASecureObjectOptions, makeApplicationUrn, OPCUASecureObject } from "node-opcua-common";
+import { type Certificate, makeSHA1Thumbprint, split_der } from "node-opcua-crypto/web";
+import { installPeriodicClockAdjustment, periodicClockAdjustment, uninstallPeriodicClockAdjustment } from "node-opcua-date-time";
+import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
+import { getHostname } from "node-opcua-hostname";
+import type { IBasicTransportSettings, ResponseCallback } from "node-opcua-pseudo-session";
 import {
     ClientSecureChannelLayer,
     type ConnectionStrategy,
     type ConnectionStrategyOptions,
     coerceConnectionStrategy,
     coerceSecurityPolicy,
+    type PerformTransactionCallback,
     type Request as Request1,
     type Response as Response1,
-    type SecurityPolicy,
-    type PerformTransactionCallback
+    type SecurityPolicy
 } from "node-opcua-secure-channel";
 import {
     FindServersOnNetworkRequest,
@@ -67,10 +41,7 @@ import {
     GetEndpointsRequest,
     GetEndpointsResponse
 } from "node-opcua-service-endpoints";
-import {
-    type ChannelSecurityToken,
-    coerceMessageSecurityMode, MessageSecurityMode
-} from "node-opcua-service-secure-channel";
+import { type ChannelSecurityToken, coerceMessageSecurityMode, MessageSecurityMode } from "node-opcua-service-secure-channel";
 import { CloseSessionRequest, type CloseSessionResponse } from "node-opcua-service-session";
 import { type ErrorCallback, StatusCodes } from "node-opcua-status-code";
 import { checkFileExistsAndIsNotEmpty, matchUri } from "node-opcua-utils";
@@ -151,8 +122,8 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
 
     let selectedEndpoint: EndpointDescription | undefined;
     const allEndpoints: EndpointDescription[] = [];
-    const tasks = [
-        (innerCallback: ErrorCallback) => {
+    const step1_connect = (): Promise<void> => {
+        return new Promise<void>((resolve, reject) => {
             // rebind backoff handler
             masterClient.listeners("backoff").forEach((handler) => {
                 client.on("backoff", handler as unknown as (retryCount: number, delay: number) => void);
@@ -174,7 +145,6 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
 
             client.connect(endpointUrl, (err?: Error) => {
                 if (err) {
-                    // let's improve the error message with meaningful info
                     err.message =
                         "Fail to connect to server at " +
                         endpointUrl +
@@ -183,20 +153,23 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
                         err.message +
                         ")";
                     warningLog(err.message);
+                    return reject(err);
                 }
-                return innerCallback(err);
+                resolve();
             });
-        },
+        });
+    };
 
-        (innerCallback: ErrorCallback) => {
+    const step2_getEndpoints = (): Promise<void> => {
+        return new Promise<void>((resolve, reject) => {
             client.getEndpoints((err: Error | null, endpoints?: EndpointDescription[]) => {
                 if (err) {
                     err.message = `error in getEndpoints \n${err.message}`;
-                    return innerCallback(err);
+                    return reject(err);
                 }
                 // c8 ignore next
                 if (!endpoints) {
-                    return innerCallback(new Error("Internal Error"));
+                    return reject(new Error("Internal Error"));
                 }
 
                 for (const endpoint of endpoints) {
@@ -211,47 +184,45 @@ function __findEndpoint(this: ClientBaseImpl, endpointUrl: string, params: FindE
                         selectedEndpoint = endpoint; // found it
                     }
                 }
-                innerCallback();
+                resolve();
             });
-        },
+        });
+    };
 
-        (innerCallback: ErrorCallback) => {
-            client.disconnect(innerCallback);
-        }
-    ];
+    const step3_disconnect = (): Promise<void> => {
+        return new Promise<void>((resolve) => {
+            client.disconnect(() => resolve());
+        });
+    };
+
+    step1_connect()
+        .then(() => step2_getEndpoints())
+        .then(() => step3_disconnect())
+        .then(() => {
+            if (!selectedEndpoint) {
+                return callback(
+                    new Error(
+                        "Cannot find an Endpoint matching " +
+                        " security mode: " +
+                        securityMode.toString() +
+                        " policy: " +
+                        securityPolicy.toString()
+                    )
+                );
+            }
+
+            // c8 ignore next
+            if (doDebug) {
+                debugLog(chalk.bgWhite.red("xxxxxxxxxxxxxxxxxxxxx => selected EndPoint = "), selectedEndpoint.toString());
+            }
 
-    async.series(tasks, (err) => {
-        if (err) {
+            callback(null, { endpoints: allEndpoints, selectedEndpoint });
+        })
+        .catch((err) => {
             client.disconnect(() => {
                 callback(err);
             });
-            return;
-        }
-
-        if (!selectedEndpoint) {
-            return callback(
-                new Error(
-                    "Cannot find an Endpoint matching " +
-                    " security mode: " +
-                    securityMode.toString() +
-                    " policy: " +
-                    securityPolicy.toString()
-                )
-            );
-        }
-
-        // c8 ignore next
-        if (doDebug) {
-            debugLog(chalk.bgWhite.red("xxxxxxxxxxxxxxxxxxxxx => selected EndPoint = "), selectedEndpoint.toString());
-        }
-
-        const result = {
-            endpoints: allEndpoints,
-            selectedEndpoint
-        };
-
-        callback(null, result);
-    });
+        });
 }
 
 /**
@@ -556,7 +527,6 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
             this._secureChannel = null;
             callback();
         });
-
     }
 
     public _recreate_secure_channel(callback: ErrorCallback): void {
@@ -741,60 +711,65 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
 
         this.emit("secure_channel_created", secureChannel);
 
-        async.series(
-            [
-                // ------------------------------------------------- STEP 2 : OpenSecureChannel
-                (innerCallback: ErrorCallback) => {
-                    debugLog("_internal_create_secure_channel before secureChannel.create");
+        const step2_openSecureChannel = (): Promise<void> => {
+            return new Promise<void>((resolve, reject) => {
+                debugLog("_internal_create_secure_channel before secureChannel.create");
+
+                secureChannel.create(this.endpointUrl, (err?: Error) => {
+                    debugLog("_internal_create_secure_channel after secureChannel.create");
+                    if (!this._secureChannel) {
+                        debugLog("_secureChannel has been closed during the transaction !");
+                        return reject(new Error("Secure Channel Closed"));
+                    }
+                    if (err) {
+                        return reject(err);
+                    }
+                    this._install_secure_channel_event_handlers(secureChannel);
+                    resolve();
+                });
+            });
+        };
+
+        const step3_getEndpoints = (): Promise<void> => {
+            return new Promise<void>((resolve, reject) => {
+                assert(this._secureChannel !== null);
+                if (!this.knowsServerEndpoint) {
+                    this._setInternalState("connecting");
 
-                    secureChannel.create(this.endpointUrl, (err?: Error) => {
-                        debugLog("_internal_create_secure_channel after secureChannel.create");
+                    this.getEndpoints((err: Error | null /*, endpoints?: EndpointDescription[]*/) => {
                         if (!this._secureChannel) {
-                            debugLog("_secureChannel has been closed during the transaction !");
-                            return innerCallback(new Error("Secure Channel Closed"));
+                            debugLog("_secureChannel has been closed during the transaction ! (while getEndpoints)");
+                            return reject(new Error("Secure Channel Closed"));
                         }
-                        if (!err) {
-                            this._install_secure_channel_event_handlers(secureChannel);
+                        if (err) {
+                            return reject(err);
                         }
-                        innerCallback(err);
+                        resolve();
                     });
-                },
-                // ------------------------------------------------- STEP 3 : GetEndpointsRequest
-                (innerCallback: ErrorCallback) => {
-                    assert(this._secureChannel !== null);
-                    if (!this.knowsServerEndpoint) {
-                        this._setInternalState("connecting");
-
-                        this.getEndpoints((err: Error | null /*, endpoints?: EndpointDescription[]*/) => {
-                            if (!this._secureChannel) {
-                                debugLog("_secureChannel has been closed during the transaction ! (while getEndpoints)");
-                                return innerCallback(new Error("Secure Channel Closed"));
-                            }
-                            innerCallback(err ? err : undefined);
-                        });
-                    } else {
-                        // end points are already known
-                        innerCallback();
-                    }
+                } else {
+                    // end points are already known
+                    resolve();
                 }
-            ],
-            (err) => {
-                if (err) {
-                    doDebug && debugLog(this.clientName, " : Inner create secure channel has failed", err.message);
-                    if (this._secureChannel) {
-                        this._secureChannel.abortConnection(() => {
-                            this._destroy_secure_channel();
-                            callback(err);
-                        });
-                    } else {
+            });
+        };
+
+        step2_openSecureChannel()
+            .then(() => step3_getEndpoints())
+            .then(() => {
+                assert(this._secureChannel !== null);
+                callback(null, secureChannel);
+            })
+            .catch((err) => {
+                doDebug && debugLog(this.clientName, " : Inner create secure channel has failed", err.message);
+                if (this._secureChannel) {
+                    this._secureChannel.abortConnection(() => {
+                        this._destroy_secure_channel();
                         callback(err);
-                    }
+                    });
                 } else {
-                    assert(this._secureChannel !== null);
-                    callback(null, secureChannel);
+                    callback(err);
                 }
-            }
-        );
+            });
     }
 
     static async createCertificate(
@@ -1021,10 +996,7 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
         });
     }
 
-    public performMessageTransaction(
-        request: Request,
-        callback: ResponseCallback<Response>
-    ): void {
+    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
             // or if the tcp connection has been broken.
@@ -1053,10 +1025,7 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
         assert(request);
         assert(request.requestHeader);
         assert(typeof callback === "function");
-        this._secureChannel.performMessageTransaction(
-            request,
-            callback as unknown as PerformTransactionCallback
-        );
+        this._secureChannel.performMessageTransaction(request, callback as unknown as PerformTransactionCallback);
     }
 
     /**
@@ -1104,10 +1073,7 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
     public getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void;
     public getEndpoints(...args: unknown[]): Promise<EndpointDescription[]> | undefined {
         if (args.length === 1) {
-            this.getEndpoints(
-                {} as GetEndpointsOptions,
-                args[0] as unknown as ResponseCallback<EndpointDescription[]>
-            );
+            this.getEndpoints({} as GetEndpointsOptions, args[0] as unknown as ResponseCallback<EndpointDescription[]>);
             return;
         }
         const options = args[0] as GetEndpointsOptions;
@@ -1156,27 +1122,16 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
     /**
 
      */
-    public findServers(
-        options?: FindServersRequestLike
-    ): Promise<ApplicationDescription[]>;
-    public findServers(
-        options: FindServersRequestLike,
-        callback: ResponseCallback<ApplicationDescription[]>
-    ): void;
-    public findServers(
-        callback: ResponseCallback<ApplicationDescription[]>
-    ): void;
-    public findServers(
-        ...args: unknown[]
-    ): Promise<ApplicationDescription[]> | void {
+    public findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>;
+    public findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;
+    public findServers(callback: ResponseCallback<ApplicationDescription[]>): void;
+    public findServers(...args: unknown[]): Promise<ApplicationDescription[]> | undefined {
         if (args.length === 1) {
             if (typeof args[0] === "function") {
-                this.findServers(
-                    {} as FindServersRequestLike, args[0] as ResponseCallback<ApplicationDescription[]>);
-                return void 0;
-            } else {
-                throw new Error("Invalid arguments");
+                this.findServers({} as FindServersRequestLike, args[0] as ResponseCallback<ApplicationDescription[]>);
+                return;
             }
+            throw new Error("Invalid arguments");
         }
         const options = args[0] as FindServersRequestLike;
         const callback = args[1] as ResponseCallback<ApplicationDescription[]>;
@@ -1201,18 +1156,16 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
 
             callback(null, response.servers);
         });
+        return undefined;
     }
 
     public findServersOnNetwork(options?: FindServersOnNetworkRequestLike): Promise<ServerOnNetwork[]>;
     public findServersOnNetwork(callback: ResponseCallback<ServerOnNetwork[]>): void;
     public findServersOnNetwork(options: FindServersOnNetworkRequestLike, callback: ResponseCallback<ServerOnNetwork[]>): void;
-    public findServersOnNetwork(...args: unknown[]): Promise<ServerOnNetwork[]> | unknown {
+    public findServersOnNetwork(...args: unknown[]): Promise<ServerOnNetwork[]> | undefined {
         if (args.length === 1) {
-            this.findServersOnNetwork(
-                {} as FindServersOnNetworkRequestOptions,
-                args[0] as ResponseCallback<ServerOnNetwork[]>
-            );
-            return;
+            this.findServersOnNetwork({} as FindServersOnNetworkRequestOptions, args[0] as ResponseCallback<ServerOnNetwork[]>);
+            return undefined;
         }
         const options = args[0] as FindServersOnNetworkRequestOptions;
         const callback = args[1] as ResponseCallback<ServerOnNetwork[]>;
@@ -1231,7 +1184,7 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
             response.servers = response.servers || [];
             callback(null, response.servers);
         });
-        return;
+        return undefined;
     }
 
     public _removeSession(session: ClientSessionImpl): void {
@@ -1589,30 +1542,27 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
 
     private _close_pending_sessions(callback: ErrorCallback) {
         const sessions = [...this._sessions];
-        async.map(
-            sessions,
-            (session: ClientSessionImpl, next: () => void) => {
-                assert(session._client === this);
-
-                // note: to prevent next to be call twice
-                let _next_already_call = false;
-                session.close((err?: Error) => {
-                    if (_next_already_call) {
-                        return;
-                    }
-                    _next_already_call = true;
 
-                    // We should not bother if we have an error here
-                    // Session may fail to close , if they haven't been activate and forcefully closed by server
-                    // in a attempt to preserve resources in the case of a DDOS attack for instance.
-                    if (err) {
-                        const msg = session.authenticationToken ? session.authenticationToken.toString() : "";
-                        debugLog(` failing to close session ${msg}`);
-                    }
-                    next();
+        const closeAll = async (): Promise<void> => {
+            for (const session of sessions) {
+                assert(session._client === this);
+                await new Promise<void>((resolve) => {
+                    let resolved = false;
+                    session.close((err?: Error) => {
+                        if (resolved) return;
+                        resolved = true;
+                        if (err) {
+                            const msg = session.authenticationToken ? session.authenticationToken.toString() : "";
+                            debugLog(` failing to close session ${msg}`);
+                        }
+                        resolve();
+                    });
                 });
-            },
-            (err) => {
+            }
+        };
+
+        closeAll()
+            .then(() => {
                 // c8 ignore next
                 if (this._sessions.length > 0) {
                     debugLog(
@@ -1622,9 +1572,9 @@ export class ClientBaseImpl<Events extends OPCUAClientBaseEvents = OPCUAClientBa
                     );
                 }
                 assert(this._sessions.length === 0, " failed to disconnect exiting sessions ");
-                callback(err || undefined);
-            }
-        );
+                callback();
+            })
+            .catch((err) => callback(err));
     }
 
     private _install_secure_channel_event_handlers(secureChannel: ClientSecureChannelLayer) {
@@ -1863,8 +1813,7 @@ class TmpClient extends ClientBaseImpl {
 
         // c8 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;
         }