node-opcua-client 2.123.0 → 2.125.0

package/source/private/client_publish_engine.ts

@@ -1,13 +1,11 @@
 /**
  * @module node-opcua-client-private
  */
-import { types } from "util";
-import async from "async";
 import chalk from "chalk";
+import { minDate } from "node-opcua-date-time";
 import { assert } from "node-opcua-assert";
 import { checkDebugFlag, make_debugLog, make_warningLog } from "node-opcua-debug";
-import { PublishRequest, PublishResponse, RepublishRequest, RepublishResponse } from "node-opcua-service-subscription";
-import { StatusCodes } from "node-opcua-status-code";
+import { PublishRequest, PublishResponse } from "node-opcua-service-subscription";
 
 import { ClientSession, SubscriptionId } from "../client_session";
 import { ClientSubscription } from "../client_subscription";
@@ -41,7 +39,14 @@ export class ClientSidePublishEngine {
     public isSuspended: boolean;
     public session: ClientSession | null;
     private subscriptionAcknowledgements: any[];
-    private readonly subscriptionMap: { [key: number]: ClientSubscriptionImpl };
+
+    /**
+     * @internal
+     * @private
+     */
+    readonly subscriptionMap: { [key: number]: ClientSubscriptionImpl };
+
+    public lastRequestSentTime: Date = minDate;
 
     constructor(session: ClientSession) {
         this.session = session;
@@ -200,31 +205,6 @@ export class ClientSidePublishEngine {
         return Object.prototype.hasOwnProperty.call(this.subscriptionMap, subscriptionId);
     }
 
-    public republish(callback: () => void): void {
-        // After re-establishing the connection the Client shall call Republish in a loop, starting with
-        // the next expected sequence number and incrementing the sequence number until the Server returns
-        // the status BadMessageNotAvailable.
-        // After receiving this status, the Client shall start sending Publish requests with the normal Publish
-        // handling.
-        // This sequence ensures that the lost NotificationMessages queued in the Server are not overwritten
-        // by newPublish responses
-        /**
-         * call Republish continuously until all Notification messages of
-         * un-acknowledged notifications are reprocessed.
-         * @private
-         */
-        const repairSubscription = (
-            subscription: ClientSubscription,
-            subscriptionId: SubscriptionId | string,
-            innerCallback: () => void
-        ) => {
-            subscriptionId = parseInt(subscriptionId as string, 10);
-            this.__repairSubscription(subscription, subscriptionId, innerCallback);
-        };
-
-        async.forEachOf(this.subscriptionMap, repairSubscription, callback);
-    }
-
     public internalSendPublishRequest(): void {
         assert(this.session, "ClientSidePublishEngine terminated ?");
 
@@ -265,7 +245,7 @@ export class ClientSidePublishEngine {
         // in our case:
 
         assert(this.nbPendingPublishRequests > 0);
-        const calculatedTimeout = Math.min(0x7FFFFFFF, this.nbPendingPublishRequests * this.timeoutHint);
+        const calculatedTimeout = Math.min(0x7fffffff, this.nbPendingPublishRequests * this.timeoutHint);
 
         const publishRequest = new PublishRequest({
             requestHeader: { timeoutHint: calculatedTimeout }, // see note
@@ -278,6 +258,8 @@ export class ClientSidePublishEngine {
         session.publish(publishRequest, (err: Error | null, response?: PublishResponse) => {
             this.nbPendingPublishRequests -= 1;
 
+            this.lastRequestSentTime = new Date();
+
             if (err) {
                 debugLog(
                     chalk.cyan("ClientSidePublishEngine.prototype.internalSendPublishRequest callback : "),
@@ -403,102 +385,4 @@ export class ClientSidePublishEngine {
             debugLog(" or because there is no session for the subscription (session terminated ?).");
         }
     }
-
-    private _republish(subscription: any, subscriptionId: SubscriptionId, callback: (err?: Error) => void) {
-        assert(subscription.subscriptionId === +subscriptionId);
-
-        let isDone = false;
-        const session = this.session as ClientSessionImpl;
-
-        const sendRepublishFunc = (callback2: (err?: Error) => void) => {
-            assert(isFinite(subscription.lastSequenceNumber) && subscription.lastSequenceNumber + 1 >= 0);
-
-            const request = new RepublishRequest({
-                retransmitSequenceNumber: subscription.lastSequenceNumber + 1,
-                subscriptionId: subscription.subscriptionId
-            });
-
-            // istanbul ignore next
-            if (doDebug) {
-                // istanbul ignore next
-                debugLog(
-                    chalk.bgCyan.yellow.bold(" republish Request for subscription"),
-                    request.subscriptionId,
-                    " retransmitSequenceNumber=",
-                    request.retransmitSequenceNumber
-                );
-            }
-
-            if (!session || session!._closeEventHasBeenEmitted) {
-                debugLog("ClientPublishEngine#_republish aborted ");
-                // has  client been disconnected in the mean time ?
-                isDone = true;
-                return callback2();
-            }
-            session.republish(request, (err: Error | null, response?: RepublishResponse) => {
-                const statusCode = err ? StatusCodes.Bad : response!.responseHeader.serviceResult;
-                if (!err && (statusCode.equals(StatusCodes.Good) || statusCode.equals(StatusCodes.BadMessageNotAvailable))) {
-                    // reprocess notification message  and keep going
-                    if (statusCode.equals(StatusCodes.Good)) {
-                        subscription.onNotificationMessage(response!.notificationMessage);
-                    }
-                } else {
-                    if (!err) {
-                        err = new Error(response!.responseHeader.serviceResult.toString());
-                    }
-                    debugLog(" _send_republish ends with ", err.message);
-                    isDone = true;
-                }
-                callback2(err ? err : undefined);
-            });
-        };
-
-        setImmediate(() => {
-            assert(typeof callback === "function");
-            async.whilst(
-                (cb: (err: null, truth: boolean) => void) => cb(null, !isDone),
-                sendRepublishFunc,
-                ((err?: Error | null): void => {
-                    debugLog("nbPendingPublishRequest = ", this.nbPendingPublishRequests);
-                    debugLog(" _republish ends with ", err ? err.message : "null");
-                    callback(err!);
-                }) as any // Wait for @type/async bug to be fixed !
-            );
-        });
-    }
-
-    private __repairSubscription(
-        subscription: ClientSubscription,
-        subscriptionId: SubscriptionId,
-        callback: (err?: Error) => void
-    ) {
-        debugLog("__repairSubscription  for SubscriptionId ", subscriptionId);
-
-        this._republish(subscription, subscriptionId, (err?: Error) => {
-            assert(!err || types.isNativeError(err));
-
-            debugLog("__repairSubscription--------------------- err =", err ? err.message : null);
-
-            if (err && err.message.match(/BadSessionInvalid/)) {
-                // _republish failed because session is not valid anymore on server side.
-                return callback(err);
-            }
-            if (err && err.message.match(/SubscriptionIdInvalid/)) {
-                // _republish failed because subscriptionId is not valid anymore on server side.
-                //
-                // This could happen when the subscription has timed out and has been deleted by server
-                // Subscription may time out if the duration of the connection break exceed the max life time
-                // of the subscription.
-                //
-                // In this case, Client must recreate a subscription and recreate monitored item without altering
-                // the event handlers
-                //
-                debugLog(chalk.bgWhite.red("_republish failed " + " subscriptionId is not valid anymore on server side."));
-
-                const subscriptionI = subscription as ClientSubscriptionImpl;
-                return subscriptionI.recreateSubscriptionAndMonitoredItem(callback);
-            }
-            callback();
-        });
-    }
 }

package/source/private/client_session_impl.ts

@@ -29,7 +29,8 @@ import {
     NodeAttributes,
     ResponseCallback,
     BrowseDescriptionLike,
-    IBasicSessionAsync2
+    IBasicSessionAsync2,
+    readNamespaceArray
 } from "node-opcua-pseudo-session";
 import { AnyConstructorFunc } from "node-opcua-schemas";
 import { ClientSecureChannelLayer, requestHandleNotSetValue, SignatureData } from "node-opcua-secure-channel";
@@ -124,11 +125,11 @@ import {
     HistoryReadValueIdOptions2,
     ExtraReadHistoryValueParameters
 } from "../client_session";
+import { UserIdentityInfo } from "../user_identity_info";
 import { ClientSessionKeepAliveManager } from "../client_session_keepalive_manager";
 import { ClientSubscription } from "../client_subscription";
 import { Request, Response } from "../common";
-import { repair_client_session } from "../reconnection";
-import { UserIdentityInfo } from "../user_identity_info";
+import { repair_client_session } from "./reconnection/reconnection";
 
 import { ClientSidePublishEngine } from "./client_publish_engine";
 import { ClientSubscriptionImpl } from "./client_subscription_impl";
@@ -221,7 +222,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
     public _closeEventHasBeenEmitted: boolean;
     private _publishEngine: ClientSidePublishEngine | null;
     private _keepAliveManager?: ClientSessionKeepAliveManager;
-    private _namespaceArray?: any;
+    private $$namespaceArray?: string[];
     private recursive_repair_detector = 0;
 
     constructor(client: IClientBase) {
@@ -270,6 +271,9 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         return this._client ? this._client.isReconnecting || this._reconnecting?.reconnecting : false;
     }
 
+    protected resolveNodeId(nodeId: NodeIdLike): NodeIdLike {
+        return resolveNodeId(nodeId);
+    }
     public getPublishEngine(): ClientSidePublishEngine {
         if (!this._publishEngine) {
             this._publishEngine = new ClientSidePublishEngine(this);
@@ -406,8 +410,8 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                     if (r.references && r.references.length > this.requestedMaxReferencesPerNode) {
                         warningLog(
                             chalk.yellow("warning") +
-                                " BrowseResponse : the server didn't take into" +
-                                " account our requestedMaxReferencesPerNode "
+                            " BrowseResponse : the server didn't take into" +
+                            " account our requestedMaxReferencesPerNode "
                         );
                         warningLog("        this.requestedMaxReferencesPerNode= " + this.requestedMaxReferencesPerNode);
                         warningLog("        got " + r.references.length + "for " + nodesToBrowse[i].nodeId.toString());
@@ -416,7 +420,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 }
             }
             for (const r of results) {
-                r.references = r.references || /* istanbul ignore next */ [];
+                r.references = r.references || /* istanbul ignore next */[];
             }
             assert(results[0] instanceof BrowseResult);
             return callback(null, isArray ? results : results[0]);
@@ -652,7 +656,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                     continuationPoint: undefined,
                     dataEncoding: undefined, // {namespaceIndex: 0, name: undefined},
                     indexRange: undefined,
-                    nodeId: resolveNodeId(node as NodeIdLike)
+                    nodeId: this.resolveNodeId(node as NodeIdLike)
                 });
             } else {
                 nodesToRead.push(node as HistoryReadValueIdOptions);
@@ -715,7 +719,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 return callback(new Error(response.responseHeader.serviceResult.toString()));
             }
 
-            response.results = response.results || /* istanbul ignore next */ [];
+            response.results = response.results || /* istanbul ignore next */[];
             callback(null, response);
         });
     }
@@ -847,7 +851,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 return callback(new Error(response.responseHeader.serviceResult.toString()));
             }
 
-            response.results = response.results || /* istanbul ignore next */ [];
+            response.results = response.results || /* istanbul ignore next */[];
 
             assert(nodesToRead.length === response.results.length);
 
@@ -990,7 +994,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
             if (response.responseHeader.serviceResult.isNot(StatusCodes.Good)) {
                 return callback(new Error(response.responseHeader.serviceResult.toString()));
             }
-            response.results = response.results || /* istanbul ignore next */ [];
+            response.results = response.results || /* istanbul ignore next */[];
             assert(nodesToWrite.length === response.results.length);
             callback(null, isArray ? response.results : response.results[0]);
         });
@@ -1012,7 +1016,25 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
      * @param value   {Variant} - the value to write
      * @return {Promise<StatusCode>} - the status code of the write
      *
-     * @deprecated
+     * @deprecated use session.write instead
+     *
+     * @example
+     *     // please use session.write instead of session.writeSingleNode
+     *     // as follow
+     *     const statusCode = await session.write({
+     *          nodeId,
+     *          attributeId: AttributeIds.Value,
+     *          value: {
+     *             statusCode: Good,
+     *             sourceTimestamp: new Date(), // optional, some server may not accept this
+     *             value: {
+     *               dataType: opcua.DataType.Double,
+     *               value: 100.0
+     *             }
+     *          }
+     *     });
+     *
+     *
      */
     public writeSingleNode(nodeId: NodeIdLike, value: VariantLike, callback: ResponseCallback<StatusCode>): void;
 
@@ -1028,7 +1050,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         const nodeToWrite = new WriteValue({
             attributeId: AttributeIds.Value,
             indexRange: undefined,
-            nodeId: resolveNodeId(nodeId),
+            nodeId: this.resolveNodeId(nodeId),
             value: new DataValue({ value })
         });
 
@@ -1144,6 +1166,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
      * @param args
      */
     public read(...args: any[]): any {
+
         if (args.length === 2) {
             return this.read(args[0], 0, args[1]);
         }
@@ -1175,7 +1198,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 warningLog(
                     chalk.yellow(
                         "please make sure to refactor your code and check that " +
-                            "the second argument of your callback function is named"
+                        "the second argument of your callback function is named"
                     ),
                     chalk.cyan("dataValue" + (isArray ? "s" : ""))
                 );
@@ -1186,7 +1209,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
 
         // coerce nodeIds
         for (const node of nodesToRead) {
-            node.nodeId = resolveNodeId(node.nodeId);
+            node.nodeId = this.resolveNodeId(node.nodeId);
         }
 
         const request = new ReadRequest({
@@ -1208,7 +1231,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
 
             // perform ExtensionObject resolution
             promoteOpaqueStructureWithCallback(this, response.results!, () => {
-                response.results = response.results || /* istanbul ignore next */ [];
+                response.results = response.results || /* istanbul ignore next */[];
                 return callback(null, isArray ? response.results : response.results[0]);
             });
         });
@@ -1409,7 +1432,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 if (!response) {
                     return callback(new Error("Internal Error"));
                 }
-                response.results = response.results || /* istanbul ignore next */ [];
+                response.results = response.results || /* istanbul ignore next */[];
                 callback(err, isArray ? response.results : response.results[0]);
             }
         );
@@ -1454,7 +1477,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
             if (!response || !(response instanceof TranslateBrowsePathsToNodeIdsResponse)) {
                 return callback(new Error("Internal Error"));
             }
-            response.results = response.results || /* istanbul ignore next */ [];
+            response.results = response.results || /* istanbul ignore next */[];
 
             callback(null, isArray ? response.results : response.results[0]);
         });
@@ -1474,28 +1497,12 @@ 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
-        //     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;
 
@@ -1613,9 +1620,9 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
             if (response.responseHeader.serviceResult.isNot(StatusCodes.Good)) {
                 err = new Error(
                     " ServiceResult is " +
-                        response.responseHeader.serviceResult.toString() +
-                        " request was " +
-                        request.constructor.name
+                    response.responseHeader.serviceResult.toString() +
+                    " request was " +
+                    request.constructor.name
                 );
 
                 if (response && response.responseHeader.serviceDiagnostics) {
@@ -1855,7 +1862,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         assert(Array.isArray(nodesToRegister));
 
         const request = new RegisterNodesRequest({
-            nodesToRegister: nodesToRegister.map(resolveNodeId)
+            nodesToRegister: nodesToRegister.map((n) => this.resolveNodeId(n))
         });
 
         this.performMessageTransaction(request, (err: Error | null, response?: Response) => {
@@ -1868,7 +1875,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
                 return callback(new Error("Internal Error"));
             }
 
-            response.registeredNodeIds = response.registeredNodeIds || /* istanbul ignore next */ [];
+            response.registeredNodeIds = response.registeredNodeIds || /* istanbul ignore next */[];
 
             callback(null, response.registeredNodeIds);
         });
@@ -1884,7 +1891,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         assert(Array.isArray(nodesToUnregister));
 
         const request = new UnregisterNodesRequest({
-            nodesToUnregister: nodesToUnregister.map(resolveNodeId)
+            nodesToUnregister: nodesToUnregister.map((n) => this.resolveNodeId(n))
         });
 
         this.performMessageTransaction(request, (err: Error | null, response?: Response) => {
@@ -2014,47 +2021,20 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
             .catch(callback);
     }
 
-    public resumePublishEngine(): void {
-        assert(this._publishEngine);
-        if (this._publishEngine && this._publishEngine.subscriptionCount > 0) {
-            this._publishEngine.replenish_publish_request_queue();
-        }
-    }
-
     public async readNamespaceArray(): Promise<string[]>;
     public readNamespaceArray(callback: (err: Error | null, namespaceArray?: string[]) => void): void;
     public readNamespaceArray(...args: any[]): any {
         const callback = args[0];
-
-        this.read(
-            {
-                attributeId: AttributeIds.Value,
-                nodeId: resolveNodeId("Server_NamespaceArray")
-            },
-            (err: Error | null, dataValue?: DataValue) => {
-                /* istanbul ignore next */
-                if (err) {
-                    return callback(err);
-                }
-                /* istanbul ignore next */
-                if (!dataValue) {
-                    return callback(new Error("Internal Error"));
-                }
-
-                /* istanbul ignore next */
-                if (dataValue.statusCode.isNotGood()) {
-                    return callback(new Error("readNamespaceArray : " + dataValue.statusCode.toString()));
-                }
-                assert(dataValue.value.value instanceof Array);
-                this._namespaceArray = dataValue.value.value; // keep a cache
-                callback(null, this._namespaceArray);
-            }
-        );
+        readNamespaceArray(this)
+            .then((namespaceArray) => callback(null, namespaceArray))
+            .catch((err) => {
+                callback(err);
+            });
     }
 
     public getNamespaceIndex(namespaceUri: string): number {
-        assert(this._namespaceArray, "please make sure that readNamespaceArray has been called");
-        return this._namespaceArray.indexOf(namespaceUri);
+        assert(this.$$namespaceArray, "please make sure that readNamespaceArray has been called");
+        return this.$$namespaceArray!.indexOf(namespaceUri);
     }
 
     // tslint:disable:no-empty
@@ -2205,6 +2185,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         request: Request,
         callback: (err: Error | null, response?: Response) => void
     ) {
+        warningLog("attempt to recreate session to reperform a transation ", request.constructor.name);
         if (this.recursive_repair_detector >= 1) {
             // tslint:disable-next-line: no-console
             warningLog("recreate_session_and_reperform_transaction => Already in Progress");
@@ -2230,10 +2211,7 @@ type promoteOpaqueStructure3WithCallbackFunc = (
     callback: ErrorCallback
 ) => void;
 
-async function promoteOpaqueStructure2(
-    session: IBasicSessionAsync2,
-    callMethodResult: CallMethodResult
-): Promise<void> {
+async function promoteOpaqueStructure2(session: IBasicSessionAsync2, callMethodResult: CallMethodResult): Promise<void> {
     if (!callMethodResult || !callMethodResult.outputArguments || callMethodResult.outputArguments.length === 0) {
         return;
     }