Merge pull request #609 from pusher/subcount

Add subscription_count event

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 7.2.0
+
+* [ADDED] Add support for subscription_count event
+
 ## 7.1.1-beta
 
 [FIXED] Exported Typescript types in index.d.ts

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pusher-js",
-  "version": "7.1.1-beta",
+  "version": "7.2.0",
   "description": "Pusher Channels JavaScript library for browsers, React Native, NodeJS and web workers",
   "main": "dist/node/pusher.js",
   "browser": "dist/web/pusher.js",

spec/javascripts/unit/core/channels/channel_spec.js

@@ -170,6 +170,31 @@ describe("Channel", function() {
       });
     });
 
+    describe('on pusher_internal:subscription_count', function() {
+      it('should emit pusher:subscription_count', function() {
+        const testEvent = {
+          event: 'pusher_internal:subscription_count',
+          data: { subscription_count: 101 }
+        };
+
+        var callback = jasmine.createSpy('callback');
+        channel.bind('pusher:subscription_count', callback);
+
+        channel.handleEvent(testEvent);
+
+        expect(callback).toHaveBeenCalledWith(testEvent.data);
+      });
+
+      it('should set #subscriptionCount', function() {
+        channel.handleEvent({
+          event: 'pusher_internal:subscription_count',
+          data: { subscription_count: 101 }
+        });
+
+        expect(channel.subscriptionCount).toEqual(101);
+      });
+    });
+
     describe("on other events", function() {
       it("should emit the event", function() {
         var callback = jasmine.createSpy("callback");

src/core/channels/channel.ts

@@ -26,6 +26,7 @@ export default class Channel extends EventsDispatcher {
   subscribed: boolean;
   subscriptionPending: boolean;
   subscriptionCancelled: boolean;
+  subscriptionCount: null;
 
   constructor(name: string, pusher: Pusher) {
     super(function(event, data) {
@@ -78,6 +79,8 @@ export default class Channel extends EventsDispatcher {
     var data = event.data;
     if (eventName === 'pusher_internal:subscription_succeeded') {
       this.handleSubscriptionSucceededEvent(event);
+    } else if (eventName === 'pusher_internal:subscription_count') {
+      this.handleSubscriptionCountEvent(event);
     } else if (eventName.indexOf('pusher_internal:') !== 0) {
       var metadata: Metadata = {};
       this.emit(eventName, data, metadata);
@@ -94,6 +97,14 @@ export default class Channel extends EventsDispatcher {
     }
   }
 
+  handleSubscriptionCountEvent(event: PusherEvent) {
+    if (event.data.subscription_count) {
+      this.subscriptionCount = event.data.subscription_count;
+    }
+
+    this.emit('pusher:subscription_count', event.data);
+  }
+
   /** Sends a subscription request. For internal use only. */
   subscribe() {
     if (this.subscribed) {

src/core/channels/presence_channel.ts

@@ -69,6 +69,9 @@ export default class PresenceChannel extends PrivateChannel {
       case 'pusher_internal:subscription_succeeded':
         this.handleSubscriptionSucceededEvent(event);
         break;
+      case 'pusher_internal:subscription_count':
+        this.handleSubscriptionCountEvent(event);
+        break;
       case 'pusher_internal:member_added':
         var addedMember = this.members.addMember(data);
         this.emit('pusher:member_added', addedMember);

types/src/core/channels/channel.d.ts

@@ -8,12 +8,14 @@ export default class Channel extends EventsDispatcher {
     subscribed: boolean;
     subscriptionPending: boolean;
     subscriptionCancelled: boolean;
+    subscriptionCount: null;
     constructor(name: string, pusher: Pusher);
     authorize(socketId: string, callback: ChannelAuthorizationCallback): void;
     trigger(event: string, data: any): boolean;
     disconnect(): void;
     handleEvent(event: PusherEvent): void;
     handleSubscriptionSucceededEvent(event: PusherEvent): void;
+    handleSubscriptionCountEvent(event: PusherEvent): void;
     subscribe(): void;
     unsubscribe(): void;
     cancelSubscription(): void;