node-opcua-server 2.72.2 → 2.74.0

package/source/server_subscription.ts

@@ -91,9 +91,11 @@ function _adjust_lifeTimeCount(lifeTimeCount: number, maxKeepAliveCount: number,
     //        "The lifetime count shall be a minimum of three times the keep keep-alive count."
     lifeTimeCount = Math.max(lifeTimeCount, maxKeepAliveCount * 3);
 
-    const minTicks = Math.ceil((5 * 1000) / publishingInterval); // we want 5 seconds min
+    const minTicks = Math.ceil(Subscription.minimumLifetimeDuration / publishingInterval);
+    const maxTicks = Math.floor(Subscription.maximumLifetimeDuration / publishingInterval);
 
     lifeTimeCount = Math.max(minTicks, lifeTimeCount);
+    lifeTimeCount = Math.min(maxTicks, lifeTimeCount);
     return lifeTimeCount;
 }
 
@@ -186,7 +188,7 @@ function createSubscriptionDiagnostics(subscription: Subscription): Subscription
 
     const subscriptionDiagnostics = new SubscriptionDiagnosticsDataType({});
 
-    const subscription_subscriptionDiagnostics = subscriptionDiagnostics as any;
+    const subscription_subscriptionDiagnostics = subscriptionDiagnostics as SubscriptionDiagnosticsDataTypePriv as any;
     subscription_subscriptionDiagnostics.$subscription = subscription;
     // "sessionId"
     subscription_subscriptionDiagnostics.__defineGetter__(
@@ -300,13 +302,29 @@ function createSubscriptionDiagnostics(subscription: Subscription): Subscription
    "transferredToAltClientCount",
    "transferredToSameClientCount",
    "latePublishRequestCount",
-   "currentKeepAliveCount",
-   "currentLifetimeCount",
    "unacknowledgedMessageCount",
    "discardedMessageCount",
    "monitoringQueueOverflowCount",
    "eventQueueOverFlowCount"
    */
+    subscription_subscriptionDiagnostics.__defineGetter__(
+        "currentKeepAliveCount",
+        function (this: SubscriptionDiagnosticsDataTypePriv): number {
+            if (!this.$subscription) {
+                return 0;
+            }
+            return this.$subscription.currentKeepAliveCount;
+        }
+    );
+    subscription_subscriptionDiagnostics.__defineGetter__(
+        "currentLifetimeCount",
+        function (this: SubscriptionDiagnosticsDataTypePriv): number {
+            if (!this.$subscription) {
+                return 0;
+            }
+            return this.$subscription.currentLifetimeCount;
+        }
+    );
     // add object in Variable SubscriptionDiagnosticArray (i=2290) ( Array of SubscriptionDiagnostics)
     // add properties in Variable to reflect
     return subscriptionDiagnostics as SubscriptionDiagnosticsDataTypePriv;
@@ -453,15 +471,17 @@ export interface ServerCapabilitiesPartial {
 export class Subscription extends EventEmitter {
     public static minimumPublishingInterval = 50; // fastest possible
     public static defaultPublishingInterval = 1000; // one second
-    public static maximumPublishingInterval: number = 1000 * 60 * 60 * 24 * 15; // 15 days
+    public static maximumPublishingInterval: number = 1000 * 60; // one minute
     public static maxNotificationPerPublishHighLimit = 1000;
+    public static minimumLifetimeDuration = 5 * 1000; //  // we want 2 seconds minimum lifetime for any subscription
+    public static maximumLifetimeDuration = 60 * 60 * 1000; // 1 hour
 
     /**
      * maximum number of monitored item in a subscription to be used
      * when serverCapacity.maxMonitoredItems and serverCapacity.maxMonitoredItemsPerSubscription are not set.
      */
     public static defaultMaxMonitoredItemCount = 20000;
-    
+
     /**
      * @deprecated use serverCapacity.maxMonitoredItems and serverCapacity.maxMonitoredItemsPerSubscription instead
      */
@@ -471,7 +491,6 @@ export class Subscription extends EventEmitter {
 
     public static registry = new ObjectRegistry();
 
-    public sessionId: NodeId;
     public publishEngine?: IServerSidePublishEngine;
     public id: number;
     public priority: number;
@@ -518,10 +537,31 @@ export class Subscription extends EventEmitter {
      */
     public monitoredItemIdCounter: number;
 
-    public state: SubscriptionState;
+    private _state: SubscriptionState = -1 as SubscriptionState;
+    public set state(value: SubscriptionState) {
+        if (this._state !== value) {
+            this._state = value;
+            this.emit("stateChanged", value);
+        }
+    }
+    public get state(): SubscriptionState {
+        return this._state;
+    }
+
     public messageSent: boolean;
     public $session?: ServerSession;
 
+    public get sessionId(): NodeId {
+        return this.$session ? this.$session.nodeId : NodeId.nullNodeId;
+    }
+
+    public get currentLifetimeCount(): number {
+        return this._life_time_counter;
+    }
+    public get currentKeepAliveCount(): number {
+        return this._keep_alive_counter;
+    }
+
     private _life_time_counter: number;
     private _keep_alive_counter = 0;
     private _pending_notifications: Queue<InternalNotification>;
@@ -541,7 +581,6 @@ export class Subscription extends EventEmitter {
 
         Subscription.registry.register(this);
 
-        this.sessionId = options.sessionId || NodeId.nullNodeId;
         assert(this.sessionId instanceof NodeId, "expecting a sessionId NodeId");
 
         this.publishEngine = options.publishEngine!;
@@ -590,12 +629,13 @@ export class Subscription extends EventEmitter {
         this.messageSent = false;
 
         this.timerId = null;
-        this._start_timer();
+        this._start_timer({ firstTime: true });
 
         debugLog(chalk.green(`creating subscription ${this.id}`));
 
         this.serverCapabilities = options.serverCapabilities;
-        this.serverCapabilities.maxMonitoredItems = this.serverCapabilities.maxMonitoredItems || Subscription.defaultMaxMonitoredItemCount;
+        this.serverCapabilities.maxMonitoredItems =
+            this.serverCapabilities.maxMonitoredItems || Subscription.defaultMaxMonitoredItemCount;
         this.serverCapabilities.maxMonitoredItemsPerSubscription =
             this.serverCapabilities.maxMonitoredItemsPerSubscription || Subscription.defaultMaxMonitoredItemCount;
         this.globalCounter = options.globalCounter;
@@ -646,7 +686,7 @@ export class Subscription extends EventEmitter {
             // todo
         }
         this._stop_timer();
-        this._start_timer();
+        this._start_timer({ firstTime: false });
     }
 
     /**
@@ -674,7 +714,7 @@ export class Subscription extends EventEmitter {
      * @private
      */
     public get keepAliveCounterHasExpired(): boolean {
-        return this._keep_alive_counter >= this.maxKeepAliveCount;
+        return this._keep_alive_counter >= this.maxKeepAliveCount || this.state === SubscriptionState.LATE;
     }
 
     /**
@@ -691,6 +731,10 @@ export class Subscription extends EventEmitter {
      */
     public increaseLifeTimeCounter(): void {
         this._life_time_counter += 1;
+        if (this._life_time_counter >= this.lifeTimeCount) {
+            this.emit("lifeTimeExpired");
+        }
+        this.emit("lifeTimeCounterChanged", this._life_time_counter);
     }
 
     /**
@@ -823,8 +867,6 @@ export class Subscription extends EventEmitter {
         this._pending_notifications.clear();
         this._sent_notification_messages = [];
 
-        this.sessionId = new NodeId();
-
         this.$session = undefined;
         this.removeAllListeners();
 
@@ -1401,7 +1443,9 @@ export class Subscription extends EventEmitter {
                     "     -> subscription.state === LATE , " +
                         "because keepAlive Response cannot be send due to lack of PublishRequest"
                 );
-                this.state = SubscriptionState.LATE;
+                if (this.messageSent || this.keepAliveCounterHasExpired) {
+                    this.state = SubscriptionState.LATE;
+                }
             }
         }
     }
@@ -1414,7 +1458,7 @@ export class Subscription extends EventEmitter {
         }
     }
 
-    private _start_timer() {
+    private _start_timer({ firstTime }: { firstTime: boolean }) {
         debugLog(
             chalk.bgWhite.blue("Subscription#_start_timer  subscriptionId="),
             this.id,
@@ -1433,7 +1477,12 @@ export class Subscription extends EventEmitter {
 
         // make sure that a keep-alive Message will be send at the end of the first publishing cycle
         // if there are no Notifications ready.
-        this._keep_alive_counter = this.maxKeepAliveCount;
+        this._keep_alive_counter = 0; // this.maxKeepAliveCount;
+
+        if (firstTime) {
+            assert(this.messageSent === false);
+            assert(this.state === SubscriptionState.CREATING);
+        }
 
         assert(this.publishingInterval >= Subscription.minimumPublishingInterval);
         this.timerId = setInterval(this._tick.bind(this), this.publishingInterval);
@@ -1452,14 +1501,6 @@ export class Subscription extends EventEmitter {
         if (doDebug) {
             debugLog(`Subscription#_tick id ${this.id} aborted=${this.aborted} state=${SubscriptionState[this.state]}`);
         }
-
-        if (this.aborted) {
-            // xx  console.log(" Log aborted")
-            // xx  // underlying channel has been aborted ...
-            // xx self.publishEngine.cancelPendingPublishRequestBeforeChannelChange();
-            // xx // let's still increase lifetime counter to detect timeout
-        }
-
         if (this.state === SubscriptionState.CLOSED) {
             warningLog(`Warning: Subscription#_tick id ${this.id}  called while subscription is CLOSED`);
             return;
@@ -1480,17 +1521,19 @@ export class Subscription extends EventEmitter {
             );
         }
 
+        // give a chance to the publish engine to cancel timed out publish requests
         this.publishEngine!._on_tick();
 
         this.publishIntervalCount += 1;
 
-        this.increaseLifeTimeCounter();
+        if (this.state === SubscriptionState.LATE) {
+            this.increaseLifeTimeCounter();
+        }
 
         if (this.lifeTimeHasExpired) {
             /* istanbul ignore next */
-            if (doDebug) {
-                debugLog(chalk.red.bold(`Subscription ${this.id} has expired !!!!! => Terminating`));
-            }
+            doDebug && debugLog(chalk.red.bold(`Subscription ${this.id} has expired !!!!! => Terminating`));
+
             /**
              * notify the subscription owner that the subscription has expired by exceeding its life time.
              * @event expired
@@ -1499,7 +1542,7 @@ export class Subscription extends EventEmitter {
             this.emit("expired");
 
             // notify new terminated status only when subscription has timeout.
-            debugLog("adding StatusChangeNotification notification message for BadTimeout subscription = ", this.id);
+            doDebug && debugLog("adding StatusChangeNotification notification message for BadTimeout subscription = ", this.id);
             this._addNotificationMessage(new StatusChangeNotification({ status: StatusCodes.BadTimeout }));
 
             // kill timer and delete monitored items and transfer pending notification messages
@@ -1511,23 +1554,21 @@ export class Subscription extends EventEmitter {
         const publishEngine = this.publishEngine!;
 
         // istanbul ignore next
-        if (doDebug) {
-            debugLog("Subscription#_tick  self._pending_notifications= ", this._pending_notifications.size);
-        }
+        doDebug && debugLog("Subscription#_tick  self._pending_notifications= ", this._pending_notifications.size);
 
         if (
             publishEngine.pendingPublishRequestCount === 0 &&
             (this.hasPendingNotifications || this.hasUncollectedMonitoredItemNotifications)
         ) {
             // istanbul ignore next
-            if (doDebug) {
+            doDebug &&
                 debugLog(
                     "subscription set to LATE  hasPendingNotifications = ",
                     this.hasPendingNotifications,
                     " hasUncollectedMonitoredItemNotifications =",
                     this.hasUncollectedMonitoredItemNotifications
                 );
-            }
+
             this.state = SubscriptionState.LATE;
             return;
         }
@@ -1542,7 +1583,11 @@ export class Subscription extends EventEmitter {
                 this._process_keepAlive();
             }
         } else {
-            this._process_keepAlive();
+            if (this.state !== SubscriptionState.LATE) {
+                this._process_keepAlive();
+            } else {
+                this.resetKeepAliveCounter();
+            }
         }
     }
 
@@ -1555,11 +1600,10 @@ export class Subscription extends EventEmitter {
         if (this.publishEngine!.send_keep_alive_response(this.id, future_sequence_number)) {
             this.messageSent = true;
             // istanbul ignore next
-            if (doDebug) {
+            doDebug &&
                 debugLog(
                     `    -> Subscription#_sendKeepAliveResponse subscriptionId ${this.id} future_sequence_number ${future_sequence_number}`
                 );
-            }
             /**
              * notify the subscription owner that a keepalive message has to be sent.
              * @event keepalive
@@ -1582,7 +1626,7 @@ export class Subscription extends EventEmitter {
         this._keep_alive_counter = 0;
 
         // istanbul ignore next
-        if (doDebug) {
+        doDebug &&
             debugLog(
                 "     -> subscriptionId",
                 this.id,
@@ -1590,7 +1634,6 @@ export class Subscription extends EventEmitter {
                 this._keep_alive_counter,
                 this.maxKeepAliveCount
             );
-        }
     }
 
     /**
@@ -1600,7 +1643,7 @@ export class Subscription extends EventEmitter {
         this._keep_alive_counter += 1;
 
         // istanbul ignore next
-        if (doDebug) {
+        doDebug &&
             debugLog(
                 "     -> subscriptionId",
                 this.id,
@@ -1608,7 +1651,6 @@ export class Subscription extends EventEmitter {
                 this._keep_alive_counter,
                 this.maxKeepAliveCount
             );
-        }
     }
 
     /**
@@ -1616,9 +1658,8 @@ export class Subscription extends EventEmitter {
      */
     private _addNotificationMessage(notificationData: QueueItem | StatusChangeNotification, monitoredItemId?: number) {
         // istanbul ignore next
-        if (doDebug) {
-            debugLog(chalk.yellow("Subscription#_addNotificationMessage"), notificationData.toString());
-        }
+        doDebug && debugLog(chalk.yellow("Subscription#_addNotificationMessage"), notificationData.toString());
+
         this._pending_notifications.push({
             monitoredItemId,
             notification: notificationData,
@@ -1633,9 +1674,7 @@ export class Subscription extends EventEmitter {
      */
     private _removePendingNotificationsFor(monitoredItemId: number) {
         const nbRemovedNotification = this._pending_notifications.filterOut((e) => e.monitoredItemId === monitoredItemId);
-        if (doDebug) {
-            debugLog(`Removed ${nbRemovedNotification} notifications`);
-        }
+        doDebug && debugLog(`Removed ${nbRemovedNotification} notifications`);
     }
     /**
      * Extract the next Notification that is ready to be sent to the client.
@@ -1717,7 +1756,7 @@ export class Subscription extends EventEmitter {
         // Subscription is transferred to another Session, the queued NotificationMessages for this
         // Subscription are moved from the old to the new Session.
         if (maxNotificationMessagesInQueue <= this._sent_notification_messages.length) {
-            debugLog("discardOldSentNotifications = ", this._sent_notification_messages.length);
+            doDebug && debugLog("discardOldSentNotifications = ", this._sent_notification_messages.length);
             this._sent_notification_messages.splice(this._sent_notification_messages.length - maxNotificationMessagesInQueue);
         }
     }
@@ -1812,26 +1851,4 @@ export class Subscription extends EventEmitter {
     }
 }
 
-/**
- * extract up to maxNotificationsPerPublish notifications
- * @param the full array of monitored items
- * @param maxNotificationsPerPublish  the maximum number of notification to extract
- * @return an extract of array of monitored item matching at most maxNotificationsPerPublish
- * @private
- */
-function extract_notifications_chunk<T>(monitoredItems: Queue<T>, maxNotificationsPerPublish: number): T[] {
-    let n = maxNotificationsPerPublish === 0 ? monitoredItems.size : Math.min(monitoredItems.size, maxNotificationsPerPublish);
-
-    const chunk_monitoredItems: T[] = [];
-    while (n) {
-        chunk_monitoredItems.push(monitoredItems.shift()!);
-        n--;
-    }
-    return chunk_monitoredItems;
-}
-
-function filter_instanceof(Class: any, e: any): boolean {
-    return e instanceof Class;
-}
-
 assert(Subscription.maximumPublishingInterval < 2147483647, "maximumPublishingInterval cannot exceed (2**31-1) ms ");

package/source/sessions_compatible_for_transfer.ts

@@ -2,7 +2,11 @@ import { assert } from "node-opcua-assert";
 import { UserIdentityToken, AnonymousIdentityToken, UserNameIdentityToken, X509IdentityToken } from "node-opcua-types";
 import { ServerSession } from "./server_session";
 
-export function sessionsCompatibleForTransfer(sessionSrc: ServerSession, sessionDest: ServerSession): boolean {
+export function sessionsCompatibleForTransfer(sessionSrc: ServerSession | undefined, sessionDest: ServerSession): boolean {
+
+    if (!sessionSrc) {
+        return true;
+    }
     assert(sessionDest);
     assert(sessionSrc);
     if (!sessionSrc.userIdentityToken && !sessionDest.userIdentityToken) {