fix(event-engine): fix missing presence events on subscription

Fix issue because of which presence events not delivered to the `Subscription` and `SubscriptionSet` objects (only global listeners).
pubnub · Nov 17, 2024 · 02e3db1 · 02e3db1
1 parent 2b523b2
commit 02e3db1
Show file tree

Hide file tree

Showing 14 changed files with 41 additions and 31 deletions.
diff --git a/dist/web/pubnub.js b/dist/web/pubnub.js
@@ -6403,6 +6403,7 @@
 	     * @param event - Received real-time event.
 	     */
 	    emitEvent(event) {
+	        var _a;
 	        if (event.type === PubNubEventType.Message) {
 	            this.listenerManager.announceMessage(event.data);
 	            this.announce('message', event.data, event.data.channel, event.data.subscription);
@@ -6413,7 +6414,7 @@
 	        }
 	        else if (event.type === PubNubEventType.Presence) {
 	            this.listenerManager.announcePresence(event.data);
-	            this.announce('presence', event.data, event.data.channel, event.data.subscription);
+	            this.announce('presence', event.data, (_a = event.data.subscription) !== null && _a !== void 0 ? _a : event.data.channel, event.data.subscription);
 	        }
 	        else if (event.type === PubNubEventType.AppContext) {
 	            const { data: objectEvent } = event;
@@ -9963,7 +9964,7 @@
 	     * types of events.
 	     */
 	    addListener(listener) {
-	        this.eventEmitter.addListener(listener, this.channelNames.filter((c) => !c.endsWith('-pnpres')), this.groupNames.filter((cg) => !cg.endsWith('-pnpres')));
+	        this.eventEmitter.addListener(listener, this.channelNames, this.groupNames);
 	    }
 	    /**
 	     * Remove events handler.
@@ -10065,7 +10066,7 @@
 	            this.subscriptionList.push(subscription);
 	        });
 	        this.listener = {};
-	        eventEmitter.addListener(this.listener, this.channelNames.filter((c) => !c.endsWith('-pnpres')), this.groupNames.filter((cg) => !cg.endsWith('-pnpres')));
+	        eventEmitter.addListener(this.listener, this.channelNames, this.groupNames);
 	    }
 	    /**
 	     * Add additional entity's subscription to the subscription set.
@@ -10187,7 +10188,7 @@
 	        this.pubnub = pubnub;
 	        this.eventEmitter = eventEmitter;
 	        this.listener = {};
-	        eventEmitter.addListener(this.listener, this.channelNames.filter((c) => !c.endsWith('-pnpres')), this.groupNames.filter((cg) => !cg.endsWith('-pnpres')));
+	        eventEmitter.addListener(this.listener, this.channelNames, this.groupNames);
 	    }
 	    /**
 	     * Merge entities' subscription objects into subscription set.
@@ -10283,9 +10284,12 @@
 	     */
 	    subscription(subscriptionOptions) {
 	        {
+	            const channelGroups = [this.name];
+	            if ((subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) && !this.name.endsWith('-pnpres'))
+	                channelGroups.push(`${this.name}-pnpres`);
 	            return new Subscription({
 	                channels: [],
-	                channelGroups: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
+	                channelGroups,
 	                subscriptionOptions: subscriptionOptions,
 	                eventEmitter: this.eventEmitter,
 	                pubnub: this.pubnub,
@@ -10370,8 +10374,11 @@
 	     */
 	    subscription(subscriptionOptions) {
 	        {
+	            const channels = [this.name];
+	            if ((subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) && !this.name.endsWith('-pnpres'))
+	                channels.push(`${this.name}-pnpres`);
 	            return new Subscription({
-	                channels: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
+	                channels,
 	                channelGroups: [],
 	                subscriptionOptions: subscriptionOptions,
 	                eventEmitter: this.eventEmitter,

diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/lib/core/components/eventEmitter.js b/lib/core/components/eventEmitter.js
@@ -45,6 +45,7 @@ class EventEmitter {
      * @param event - Received real-time event.
      */
     emitEvent(event) {
+        var _a;
         if (event.type === subscribe_1.PubNubEventType.Message) {
             this.listenerManager.announceMessage(event.data);
             this.announce('message', event.data, event.data.channel, event.data.subscription);
@@ -55,7 +56,7 @@ class EventEmitter {
         }
         else if (event.type === subscribe_1.PubNubEventType.Presence) {
             this.listenerManager.announcePresence(event.data);
-            this.announce('presence', event.data, event.data.channel, event.data.subscription);
+            this.announce('presence', event.data, (_a = event.data.subscription) !== null && _a !== void 0 ? _a : event.data.channel, event.data.subscription);
         }
         else if (event.type === subscribe_1.PubNubEventType.AppContext) {
             const { data: objectEvent } = event;

diff --git a/lib/entities/Channel.js b/lib/entities/Channel.js
@@ -34,8 +34,11 @@ class Channel {
      */
     subscription(subscriptionOptions) {
         if (process.env.SUBSCRIBE_EVENT_ENGINE_MODULE !== 'disabled') {
+            const channels = [this.name];
+            if ((subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) && !this.name.endsWith('-pnpres'))
+                channels.push(`${this.name}-pnpres`);
             return new Subscription_1.Subscription({
-                channels: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
+                channels,
                 channelGroups: [],
                 subscriptionOptions: subscriptionOptions,
                 eventEmitter: this.eventEmitter,

diff --git a/lib/entities/ChannelGroup.js b/lib/entities/ChannelGroup.js
@@ -35,9 +35,12 @@ class ChannelGroup {
      */
     subscription(subscriptionOptions) {
         if (process.env.SUBSCRIBE_EVENT_ENGINE_MODULE !== 'disabled') {
+            const channelGroups = [this.name];
+            if ((subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) && !this.name.endsWith('-pnpres'))
+                channelGroups.push(`${this.name}-pnpres`);
             return new Subscription_1.Subscription({
                 channels: [],
-                channelGroups: (subscriptionOptions === null || subscriptionOptions === void 0 ? void 0 : subscriptionOptions.receivePresenceEvents) ? [this.name, `${this.name}-pnpres`] : [this.name],
+                channelGroups,
                 subscriptionOptions: subscriptionOptions,
                 eventEmitter: this.eventEmitter,
                 pubnub: this.pubnub,

diff --git a/lib/entities/SubscribeCapable.js b/lib/entities/SubscribeCapable.js
@@ -82,7 +82,7 @@ class SubscribeCapable {
      * types of events.
      */
     addListener(listener) {
-        this.eventEmitter.addListener(listener, this.channelNames.filter((c) => !c.endsWith('-pnpres')), this.groupNames.filter((cg) => !cg.endsWith('-pnpres')));
+        this.eventEmitter.addListener(listener, this.channelNames, this.groupNames);
     }
     /**
      * Remove events handler.

diff --git a/lib/entities/Subscription.js b/lib/entities/Subscription.js
@@ -53,7 +53,7 @@ class Subscription extends SubscribeCapable_1.SubscribeCapable {
         this.pubnub = pubnub;
         this.eventEmitter = eventEmitter;
         this.listener = {};
-        eventEmitter.addListener(this.listener, this.channelNames.filter((c) => !c.endsWith('-pnpres')), this.groupNames.filter((cg) => !cg.endsWith('-pnpres')));
+        eventEmitter.addListener(this.listener, this.channelNames, this.groupNames);
     }
     /**
      * Merge entities' subscription objects into subscription set.

diff --git a/lib/entities/SubscriptionSet.js b/lib/entities/SubscriptionSet.js
@@ -74,7 +74,7 @@ class SubscriptionSet extends SubscribeCapable_1.SubscribeCapable {
             this.subscriptionList.push(subscription);
         });
         this.listener = {};
-        eventEmitter.addListener(this.listener, this.channelNames.filter((c) => !c.endsWith('-pnpres')), this.groupNames.filter((cg) => !cg.endsWith('-pnpres')));
+        eventEmitter.addListener(this.listener, this.channelNames, this.groupNames);
     }
     /**
      * Add additional entity's subscription to the subscription set.

diff --git a/src/core/components/eventEmitter.ts b/src/core/components/eventEmitter.ts
@@ -45,7 +45,7 @@ export default class EventEmitter {
       this.announce('signal', event.data, event.data.channel, event.data.subscription);
     } else if (event.type === PubNubEventType.Presence) {
       this.listenerManager.announcePresence(event.data);
-      this.announce('presence', event.data, event.data.channel, event.data.subscription);
+      this.announce('presence', event.data, event.data.subscription ?? event.data.channel, event.data.subscription);
     } else if (event.type === PubNubEventType.AppContext) {
       const { data: objectEvent } = event;
       const { message: object } = objectEvent;

diff --git a/src/entities/Channel.ts b/src/entities/Channel.ts
@@ -57,8 +57,12 @@ export class Channel {
    */
   subscription(subscriptionOptions?: SubscriptionOptions) {
     if (process.env.SUBSCRIBE_EVENT_ENGINE_MODULE !== 'disabled') {
+      const channels = [this.name];
+      if (subscriptionOptions?.receivePresenceEvents && !this.name.endsWith('-pnpres'))
+        channels.push(`${this.name}-pnpres`);
+
       return new Subscription({
-        channels: subscriptionOptions?.receivePresenceEvents ? [this.name, `${this.name}-pnpres`] : [this.name],
+        channels,
         channelGroups: [],
         subscriptionOptions: subscriptionOptions,
         eventEmitter: this.eventEmitter,

diff --git a/src/entities/ChannelGroup.ts b/src/entities/ChannelGroup.ts
@@ -59,9 +59,13 @@ export class ChannelGroup {
    */
   subscription(subscriptionOptions?: SubscriptionOptions) {
     if (process.env.SUBSCRIBE_EVENT_ENGINE_MODULE !== 'disabled') {
+      const channelGroups = [this.name];
+      if (subscriptionOptions?.receivePresenceEvents && !this.name.endsWith('-pnpres'))
+        channelGroups.push(`${this.name}-pnpres`);
+
       return new Subscription({
         channels: [],
-        channelGroups: subscriptionOptions?.receivePresenceEvents ? [this.name, `${this.name}-pnpres`] : [this.name],
+        channelGroups,
         subscriptionOptions: subscriptionOptions,
         eventEmitter: this.eventEmitter,
         pubnub: this.pubnub,

diff --git a/src/entities/SubscribeCapable.ts b/src/entities/SubscribeCapable.ts
@@ -141,11 +141,7 @@ export abstract class SubscribeCapable {
    * types of events.
    */
   addListener(listener: Listener) {
-    this.eventEmitter.addListener(
-      listener,
-      this.channelNames.filter((c) => !c.endsWith('-pnpres')),
-      this.groupNames.filter((cg) => !cg.endsWith('-pnpres')),
-    );
+    this.eventEmitter.addListener(listener, this.channelNames, this.groupNames);
   }
 
   /**

diff --git a/src/entities/Subscription.ts b/src/entities/Subscription.ts
@@ -99,11 +99,7 @@ export class Subscription extends SubscribeCapable {
     this.pubnub = pubnub;
     this.eventEmitter = eventEmitter;
     this.listener = {};
-    eventEmitter.addListener(
-      this.listener,
-      this.channelNames.filter((c) => !c.endsWith('-pnpres')),
-      this.groupNames.filter((cg) => !cg.endsWith('-pnpres')),
-    );
+    eventEmitter.addListener(this.listener, this.channelNames, this.groupNames);
   }
 
   /**

diff --git a/src/entities/SubscriptionSet.ts b/src/entities/SubscriptionSet.ts
@@ -123,11 +123,7 @@ export class SubscriptionSet extends SubscribeCapable {
       this.subscriptionList.push(subscription);
     });
     this.listener = {};
-    eventEmitter.addListener(
-      this.listener,
-      this.channelNames.filter((c) => !c.endsWith('-pnpres')),
-      this.groupNames.filter((cg) => !cg.endsWith('-pnpres')),
-    );
+    eventEmitter.addListener(this.listener, this.channelNames, this.groupNames);
   }
 
   /**