node-opcua-client 2.72.2 → 2.74.0

package/source/private/client_session_impl.ts

@@ -10,8 +10,7 @@ import {
     ExtraDataTypeManager,
     getExtensionObjectConstructor,
     getExtraDataTypeManager,
-    promoteOpaqueStructure,
-    resolveDynamicExtensionObject
+    promoteOpaqueStructure
 } from "node-opcua-client-dynamic-extension-object";
 import { Certificate, Nonce } from "node-opcua-crypto";
 import { attributeNameById, BrowseDirection, LocalizedTextLike } from "node-opcua-data-model";
@@ -21,7 +20,7 @@ import { ExtensionObject } from "node-opcua-extension-object";
 import { coerceNodeId, NodeId, NodeIdLike, resolveNodeId } from "node-opcua-nodeid";
 import { getBuiltInDataType, getArgumentDefinitionHelper, IBasicSession } from "node-opcua-pseudo-session";
 import { AnyConstructorFunc } from "node-opcua-schemas";
-import { ClientSecureChannelLayer, requestHandleNotSetValue, SignatureData } from "node-opcua-secure-channel";
+import { 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";
@@ -83,7 +82,13 @@ import {
 import { WriteRequest, WriteResponse, WriteValue } from "node-opcua-service-write";
 import { StatusCode, StatusCodes, Callback, CallbackT } from "node-opcua-status-code";
 import { ErrorCallback } from "node-opcua-status-code";
-import { BrowseNextRequest, BrowseNextResponse, HistoryReadValueIdOptions, WriteValueOptions } from "node-opcua-types";
+import {
+    BrowseNextRequest,
+    BrowseNextResponse,
+    HistoryReadValueIdOptions,
+    ServiceFault,
+    WriteValueOptions
+} from "node-opcua-types";
 import { buffer_ellipsis, getFunctionParameterNames, isNullOrUndefined, lowerFirstLetter } from "node-opcua-utils";
 import { DataType, Variant, VariantLike } from "node-opcua-variant";
 
@@ -115,7 +120,6 @@ import { repair_client_session } from "../reconnection";
 
 import { ClientSidePublishEngine } from "./client_publish_engine";
 import { ClientSubscriptionImpl } from "./client_subscription_impl";
-import { OPCUAClientImpl } from "./opcua_client_impl";
 import { IClientBase } from "./i_private_client";
 
 export type ResponseCallback<T> = (err: Error | null, response?: T) => void;
@@ -1542,6 +1546,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
             if (err && err.message.match(/BadSessionIdInvalid/) && request.constructor.name !== "ActivateSessionRequest") {
                 debugLog("Transaction on Invalid Session ", request.constructor.name);
                 request.requestHeader.requestHandle = requestHandleNotSetValue;
+                warningLog("client is now attempting to recreate a session");
                 this.recreate_session_and_reperform_transaction(request, callback);
                 return;
             }
@@ -1597,6 +1602,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 }
                 return callback(err);
             }
+
             /* istanbul ignore next */
             if (!response) {
                 return callback(new Error("internal Error"));

package/source/private/client_subscription_impl.ts

@@ -471,8 +471,12 @@ export class ClientSubscriptionImpl extends EventEmitter implements ClientSubscr
         });
         session.setTriggering(setTriggeringRequest, (err: Error | null, response?: SetTriggeringResponse) => {
             if (err) {
-                // use soft error, no exceptions
-                return callback(null, response);
+                if (response) {
+                    // use soft error, no exceptions
+                    return callback(null, response);
+                } else {
+                    return callback(err);
+                }
             }
             // istanbul ignore next
             if (!response) {

package/source/private/opcua_client_impl.ts

@@ -278,7 +278,7 @@ function createUserNameIdentityToken(
 
     // istanbul ignore next
     if (!cryptoFactory) {
-        throw new Error(" Unsupported security Policy "+  securityPolicy.toString());
+        throw new Error(" Unsupported security Policy " + securityPolicy.toString());
     }
 
     identityToken = new UserNameIdentityToken({
@@ -411,7 +411,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
 
                 this._addSession(session as ClientSessionImpl);
 
-                this._activateSession(session as ClientSessionImpl, (err1: Error | null, session2?: ClientSessionImpl) => {                  
+                this._activateSession(session as ClientSessionImpl, (err1: Error | null, session2?: ClientSessionImpl) => {
                     callback(err1, session2);
                 });
             }
@@ -861,13 +861,17 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
         this.performMessageTransaction(request, (err: Error | null, response?: Response) => {
             /* istanbul ignore next */
             if (err) {
-                // we could have an invalid state here or a connection error
-                errorLog("error: ", err.message, " retrying in ... 5 secondes");
-                setTimeout(() => {
-                    errorLog(" .... now retrying");
-                    this.__createSession_step3(session, callback);
-                }, 5 * 1000);
-                return;
+                console.log("__createSession_step3 has failed", err.message);
+                return callback(err);
+
+                //  //xxxxxx               qdqsdqsdqsdqsd
+                //                 // we could have an invalid state here or a connection error
+                //                 errorLog("error: ", err.message, " retrying in ... 5 secondes");
+                //                 setTimeout(() => {
+                //                     errorLog(" .... now retrying");
+                //                     this.__createSession_step3(session, callback);
+                //                 }, 5 * 1000);
+                //                 return;
             }
 
             /* istanbul ignore next */
@@ -1039,7 +1043,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
                     session.lastResponseReceivedTime = new Date();
                     if (this.keepSessionAlive) {
                         session.startKeepAliveManager();
-                    }            
+                    }
                     return callback(null, session);
                 } else {
                     // restore client

package/source/reconnection.ts

@@ -10,12 +10,12 @@ import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "n
 import { TransferSubscriptionsRequest, TransferSubscriptionsResponse } from "node-opcua-service-subscription";
 import { CallbackT, StatusCodes } from "node-opcua-status-code";
 import { ErrorCallback } from "node-opcua-status-code";
+import { CloseSessionRequest } from "node-opcua-types";
 
 import { SubscriptionId } from "./client_session";
 import { ClientSessionImpl, Reconnectable } from "./private/client_session_impl";
 import { ClientSubscriptionImpl } from "./private/client_subscription_impl";
 import { IClientBase } from "./private/i_private_client";
-import { OPCUAClientImpl } from "./private/opcua_client_impl";
 
 const debugLog = make_debugLog(__filename);
 const doDebug = checkDebugFlag(__filename);
@@ -133,7 +133,7 @@ function _ask_for_subscription_republish(session: ClientSessionImpl, callback: (
     });
 }
 
-function create_session_and_repeat_if_failed(
+function create_session_and_repeat_if_failed_Old(
     client: IClientBase,
     session: ClientSessionImpl,
     callback: CallbackT<ClientSessionImpl>
@@ -145,21 +145,53 @@ function create_session_and_repeat_if_failed(
     // create new session, based on old session,
     // so we can reuse subscriptions data
     client.__createSession_step2(session, (err: Error | null, session1?: ClientSessionImpl) => {
-        debugLog(chalk.bgWhite.cyan("    => creating a new session (based on old session data).... Done"));
+        if (err && session.hasBeenClosed()) {
+            return callback(new Error("Cannot complete subscription republish due to session termination"));
+        }
         if (!err && session1) {
             const newSession = session1;
             assert(session === session1, "session should have been recycled");
             callback(err, newSession);
             return;
         } else {
+            debugLog(chalk.bgWhite.cyan("    => creating a new session (based on old session data).... Done"));
             setTimeout(() => {
                 create_session_and_repeat_if_failed(client, session, callback);
             }, 1000);
             return;
         }
-        callback(err);
     });
 }
+
+function create_session_and_repeat_if_failed(
+    client: IClientBase,
+    session: ClientSessionImpl,
+    callback: CallbackT<ClientSessionImpl>
+) {
+    if (session.hasBeenClosed()) {
+        debugLog("Cannot complete subscription republish due to session terminatio");
+        return callback(new Error("Cannot complete subscription republish due to session termination"));
+    }
+    debugLog(chalk.bgWhite.red("    => creating a new session ...."));
+    // create new session, based on old session,
+    // so we can reuse subscriptions data
+    client.__createSession_step2(session, (err: Error | null, session1?: ClientSessionImpl) => {
+        if (err && session.hasBeenClosed()) {
+            debugLog("Cannot complete subscription republish due to session terminatio");
+            return callback(new Error("Cannot complete subscription republish due to session termination"));
+        }
+        if (!err && session1) {
+            const newSession = session1;
+            assert(session === session1, "session should have been recycled");
+            callback(err, newSession);
+            return;
+        } else {
+            debugLog("Cannot complete subscription republish err = ", err?.message);
+            callback(err);
+        }
+    });
+}
+
 function repair_client_session_by_recreating_a_new_session(
     client: IClientBase,
     session: ClientSessionImpl,
@@ -207,7 +239,25 @@ function repair_client_session_by_recreating_a_new_session(
 
                 client._activateSession(newSession, (err: Error | null, session1?: ClientSessionImpl) => {
                     debugLog(chalk.bgWhite.cyan("    =>  activating a new session .... Done err=", err ? err.message : "null"));
-                    innerCallback(err ? err : undefined);
+                    if (err) {
+                        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
+                        });
+                        session.performMessageTransaction(closeSessionRequest, (err2?: Error | null) => {
+                            if (err2) {
+                                warningLog("closing session", err2.message);
+                            }
+                            innerCallback(err);
+                        });
+                    } else {
+                        innerCallback(err ? err : undefined);
+                    }
                 });
             },
 
@@ -238,8 +288,8 @@ function repair_client_session_by_recreating_a_new_session(
                     subscriptionsToTransfer,
                     (err: Error | null, transferSubscriptionsResponse?: TransferSubscriptionsResponse) => {
                         if (err) {
-                            debugLog(chalk.bgCyan("Warning TransferSubscription has failed " + err.message));
-                            debugLog(chalk.bgCyan("May be the server is not supporting this feature"));
+                            warningLog(chalk.bgCyan("Warning TransferSubscription has failed " + err.message));
+                            warningLog(chalk.bgCyan("May be the server is not supporting this feature"));
                             // when transfer subscription has failed, we have no other choice but
                             // recreate the subscriptions on the server side
                             return innerCallback();
@@ -303,7 +353,7 @@ function repair_client_session_by_recreating_a_new_session(
 
                                 (subscription as ClientSubscriptionImpl).recreateSubscriptionAndMonitoredItem((err1?: Error) => {
                                     if (err1) {
-                                        debugLog("_recreateSubscription failed !");
+                                        debugLog("_recreateSubscription failed !" + err1.message);
                                     }
 
                                     debugLog(
@@ -356,7 +406,7 @@ 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) => {
-        debugLog("Session is repaired ", err2 ? err2.message : "<no error>", session.sessionId.toString());
+        debugLog("Session repair completed with err: ", err2 ? err2.message : "<no error>", session.sessionId.toString());
         session.emit("session_repaired");
         callback(err2);
     };
@@ -404,10 +454,13 @@ export function repair_client_session(client: IClientBase, session: ClientSessio
     _repair_client_session(client, session, (err) => {
         privateSession._reconnecting.reconnecting = false;
         if (err) {
-            errorLog(chalk.red("SESSION RESTORED HAS FAILED! retrying"), err.message, session.sessionId.toString());
-            return _repair_client_session(client, session, callback);
+            errorLog(chalk.red("session restoration has failed! err ="), err.message, session.sessionId.toString(), " => Let's retry");
+            setTimeout(() => {
+                _repair_client_session(client, session, callback);
+            }, 2000);
+            return;
         }
-        debugLog(chalk.yellow("SESSION RESTORED"), session.sessionId.toString());
+        debugLog(chalk.yellow("session has been restored"), session.sessionId.toString());
         session.emit("session_restored");
         const otherCallbacks = privateSession._reconnecting.pendingCallbacks;
         privateSession._reconnecting.pendingCallbacks = [];

package/source/tools/findservers.ts

@@ -28,7 +28,7 @@ export function findServers(
     discoveryServerEndpointUri: string,
     callback?: (err: Error | null, result?: FindServerResults) => void
 ): any {
-    const client = new ClientBaseImpl({});
+    const client = new ClientBaseImpl({ connectionStrategy: { maxRetry: 3 } });
 
     let servers: ApplicationDescription[] = [];
     let endpoints: EndpointDescription[] = [];
@@ -77,7 +77,7 @@ export function findServersOnNetwork(
     discoveryServerEndpointUri: string,
     callback?: (err: Error | null, servers?: ServerOnNetwork[]) => void
 ): any {
-    const client = new ClientBaseImpl({});
+    const client = new ClientBaseImpl({ connectionStrategy: { maxRetry: 3 } });
 
     client.connect(discoveryServerEndpointUri, (err?: Error) => {
         if (!err) {