node-opcua-server 2.72.2 → 2.74.0

package/source/server_publish_engine.ts

@@ -11,7 +11,7 @@ import { checkDebugFlag, make_debugLog } from "node-opcua-debug";
 import { ObjectRegistry } from "node-opcua-object-registry";
 import { StatusCode, StatusCodes } from "node-opcua-status-code";
 
-import { PublishRequest, PublishResponse, SubscriptionAcknowledgement } from "node-opcua-types";
+import { PublishRequest, PublishResponse, ServiceFault, SubscriptionAcknowledgement } from "node-opcua-types";
 import { Subscription } from "./server_subscription";
 import { SubscriptionState } from "./server_subscription";
 import { IServerSidePublishEngine, INotifMsg, IClosedOrTransferredSubscription } from "./i_server_side_publish_engine";
@@ -36,7 +36,7 @@ interface PublishData {
     request: PublishRequest;
     serverTimeWhenReceived: number;
     results: StatusCode[];
-    callback: (request: PublishRequest, response: PublishResponse) => void;
+    callback: (request: PublishRequest, response: PublishResponse | ServiceFault) => void;
 }
 
 function _assertValidPublishData(publishData: PublishData) {
@@ -116,7 +116,7 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
         subscription: Subscription,
         destPublishEngine: ServerSidePublishEngine,
         sendInitialValues: boolean
-    ): Promise<void> {
+    ): Promise<Subscription> {
         const srcPublishEngine = subscription.publishEngine as any as ServerSidePublishEngine;
 
         assert(!destPublishEngine.getSubscriptionById(subscription.id));
@@ -135,7 +135,9 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
         //  to the old Session.
         subscription.notifyTransfer();
 
-        destPublishEngine.add_subscription(srcPublishEngine.detach_subscription(subscription));
+        const tmp = srcPublishEngine.detach_subscription(subscription);
+        destPublishEngine.add_subscription(tmp);
+
         subscription.resetLifeTimeCounter();
         if (sendInitialValues) {
             /*  A Boolean parameter with the following values:
@@ -158,6 +160,8 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
 
         assert(destPublishEngine.getSubscriptionById(subscription.id));
         assert(!srcPublishEngine.getSubscriptionById(subscription.id));
+
+        return subscription;
     }
 
     public maxPublishRequestInQueue = 0;
@@ -321,16 +325,17 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
     }
 
     public on_close_subscription(subscription: IClosedOrTransferredSubscription): void {
-        debugLog("ServerSidePublishEngine#on_close_subscription", subscription.id);
+        doDebug && debugLog("ServerSidePublishEngine#on_close_subscription", subscription.id);
         if (subscription.hasPendingNotifications) {
-            debugLog(
-                "ServerSidePublishEngine#on_close_subscription storing subscription",
-                subscription.id,
-                " to _closed_subscriptions because it has pending notification"
-            );
+            doDebug &&
+                debugLog(
+                    "ServerSidePublishEngine#on_close_subscription storing subscription",
+                    subscription.id,
+                    " to _closed_subscriptions because it has pending notification"
+                );
             this._closed_subscriptions.push(subscription);
         } else {
-            debugLog("ServerSidePublishEngine#on_close_subscription disposing subscription", subscription.id);
+            doDebug && debugLog("ServerSidePublishEngine#on_close_subscription disposing subscription", subscription.id);
             // subscription is no longer needed
             subscription.dispose();
         }
@@ -357,7 +362,7 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
     public findLateSubscriptions(): Subscription[] {
         const subscriptions = Object.values(this._subscriptions);
         return subscriptions.filter((subscription: Subscription) => {
-            return subscription.state === SubscriptionState.LATE && subscription.publishingEnabled;
+            return (subscription.state === SubscriptionState.LATE || !subscription.messageSent) && subscription.publishingEnabled;
         });
     }
 
@@ -398,7 +403,7 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
      */
     public _on_PublishRequest(
         request: PublishRequest,
-        callback?: (request1: PublishRequest, response: PublishResponse) => void
+        callback?: (request1: PublishRequest, response: PublishResponse| ServiceFault) => void
     ): void {
         callback = callback || dummy_function;
         assert(typeof callback === "function");
@@ -479,6 +484,10 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
                                 s.timeToKeepAlive +
                                 " m?=" +
                                 s.hasUncollectedMonitoredItemNotifications +
+                                " " +
+                                SubscriptionState[s.state] +
+                                " " +
+                                s.messageSent +
                                 "]"
                         )
                         .join(" \n")
@@ -493,6 +502,7 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
         const starving_subscription = /* this.findSubscriptionWaitingForFirstPublish() || */ findLateSubscriptionSortedByPriority();
         return starving_subscription;
     }
+
     private _feed_late_subscription() {
         setImmediate(() => {
             if (!this.pendingPublishRequestCount) {
@@ -500,7 +510,8 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
             }
             const starving_subscription = this._find_starving_subscription();
             if (starving_subscription) {
-                debugLog(chalk.bgWhite.red("feeding most late subscription subscriptionId  = "), starving_subscription.id);
+                doDebug &&
+                    debugLog(chalk.bgWhite.red("feeding most late subscription subscriptionId  = "), starving_subscription.id);
                 starving_subscription.process_subscription();
             }
         });
@@ -529,10 +540,10 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
 
     private _send_error_for_request(publishData: PublishData, statusCode: StatusCode): void {
         _assertValidPublishData(publishData);
-        const publishResponse = new PublishResponse({
+        const response = new ServiceFault({
             responseHeader: { serviceResult: statusCode }
         });
-        this._send_response_for_request(publishData, publishResponse);
+        this._send_response_for_request(publishData, response);
     }
 
     private _cancelPendingPublishRequest(statusCode: StatusCode): void {
@@ -621,7 +632,7 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
         assert(this.pendingPublishRequestCount > 0);
         assert(response.subscriptionId !== 0xffffff);
         const publishData = this._publish_request_queue.shift()!;
-        this._send_response_for_request(publishData, response);
+        this._send_valid_response_for_request(publishData, response);
     }
 
     public _on_tick(): void {
@@ -646,15 +657,17 @@ export class ServerSidePublishEngine extends EventEmitter implements IServerSide
             this._send_error_for_request(publishData, StatusCodes.BadTimeout);
         }
     }
-
-    public _send_response_for_request(publishData: PublishData, response: PublishResponse): void {
+    public _send_response_for_request(publishData: PublishData, response: PublishResponse | ServiceFault): void {
+        response.responseHeader.requestHandle = publishData.request.requestHeader.requestHandle;
+        publishData.callback(publishData.request, response);
+    }
+    public _send_valid_response_for_request(publishData: PublishData, response: PublishResponse): void {
         if (doDebug) {
             debugLog("_send_response_for_request ", response.toString());
         }
         _assertValidPublishData(publishData);
         // xx assert(response.responseHeader.requestHandle !== 0,"expecting a valid requestHandle");
         response.results = publishData.results;
-        response.responseHeader.requestHandle = publishData.request.requestHeader.requestHandle;
-        publishData.callback(publishData.request, response);
+        this._send_response_for_request(publishData, response);
     }
 }

package/source/server_publish_engine_for_orphan_subscriptions.ts

@@ -5,6 +5,7 @@
 import * as chalk from "chalk";
 
 import { checkDebugFlag, make_debugLog } from "node-opcua-debug";
+import { NodeId } from "node-opcua-nodeid";
 
 import { ServerSidePublishEngine, ServerSidePublishEngineOptions } from "./server_publish_engine";
 import { Subscription } from "./server_subscription";
@@ -28,6 +29,10 @@ export class ServerSidePublishEngineForOrphanSubscription extends ServerSidePubl
 
     public add_subscription(subscription: Subscription): Subscription {
         debugLog(chalk.bgCyan.yellow.bold(" adding live subscription with id="), subscription.id, " to orphan");
+
+        // detach subscription from old seession
+        subscription.$session = undefined;
+        
         super.add_subscription(subscription);
         // also add an event handler to detected when the subscription has ended
         // so we can automatically remove it from the orphan table
@@ -38,7 +43,7 @@ export class ServerSidePublishEngineForOrphanSubscription extends ServerSidePubl
             // xx publish_engine.detach_subscription(subscription);
             // Xx subscription.dispose();
         };
-        subscription.on("expired", (subscription as any)._expired_func);
+        subscription.once("expired", (subscription as any)._expired_func);
         return subscription;
     }
 

package/source/server_session.ts

@@ -72,6 +72,7 @@ interface SessionSecurityDiagnosticsDataTypeEx extends SessionSecurityDiagnostic
     $session: any;
 }
 
+export type SessionStatus = "new" | "active" | "screwed" | "disposed" | "closed";
 /**
  *
  * A Server session object.
@@ -99,13 +100,12 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
     public static registry = new ObjectRegistry();
     public static maxPublishRequestInQueue = 100;
 
-    public __status = "";
+    public __status: SessionStatus = "new";
     public parent: ServerEngine;
     public authenticationToken: NodeId;
     public nodeId: NodeId;
     public sessionName = "";
 
-    
     public publishEngine: ServerSidePublishEngine;
     public sessionObject: any;
     public readonly creationDate: Date;
@@ -227,18 +227,21 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
      * the first transaction is the creation of the session
      */
     public get clientLastContactTime(): number {
-        const lastSeen =  this._watchDogData ? this._watchDogData.lastSeen : minOPCUADate.getTime();
+        const lastSeen = this._watchDogData ? this._watchDogData.lastSeen : minOPCUADate.getTime();
         return WatchDog.lastSeenToDuration(lastSeen);
     }
 
-    public get status(): string {
+    public get status(): SessionStatus {
         return this.__status;
     }
 
-    public set status(value: string) {
+    public set status(value: SessionStatus) {
         if (value === "active") {
             this._createSessionObjectInAddressSpace();
         }
+        if (this.__status !== value) {
+            this.emit("statusChanged", value);
+        }
         this.__status = value;
     }
 
@@ -304,7 +307,7 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
             const propName = lowerFirstLetter(counterName + "Count");
             // istanbul ignore next
             if (!Object.prototype.hasOwnProperty.call(this._sessionDiagnostics, propName)) {
-               errorLog("incrementRequestTotalCounter: cannot find", propName);
+                errorLog("incrementRequestTotalCounter: cannot find", propName);
                 // xx return;
             } else {
                 (this._sessionDiagnostics as any)[propName].totalCount += 1;
@@ -444,7 +447,7 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
         assert(this.currentSubscriptionCount === 0);
 
         this.status = "closed";
-        
+
         this._detach_channel();
 
         /**
@@ -559,10 +562,10 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
 
     public _detach_channel(): void {
         const channel = this.channel;
-        
+
         // istanbul ignore next
         if (!channel) {
-            return; 
+            return;
             // already detached !
             // throw new Error("expecting a valid channel");
         }
@@ -682,13 +685,13 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
 
                 Object.defineProperty(this._sessionDiagnostics, "sessionId", {
                     get(this: SessionDiagnosticsDataTypeEx) {
-                        return this.$session?.nodeId;
+                        return this.$session ? this.$session.nodeId : NodeId.nullNodeId;
                     }
                 });
 
                 Object.defineProperty(this._sessionDiagnostics, "sessionName", {
                     get(this: SessionDiagnosticsDataTypeEx) {
-                        return this.$session?.sessionName.toString();
+                        return this.$session ? this.$session.sessionName.toString() : "";
                     }
                 });
 
@@ -910,8 +913,7 @@ export class ServerSession extends EventEmitter implements ISubscriber, ISession
         assert(this.nodeId instanceof NodeId);
 
         subscription.$session = this;
-
-        subscription.sessionId = this.nodeId;
+        assert(subscription.sessionId === this.nodeId);
 
         this._cumulatedSubscriptionCount += 1;