centrifuge 5.0.2 → 5.1.1

package/README.md

@@ -27,6 +27,7 @@ The features implemented by this SDK can be found in [SDK feature matrix](https:
 * [Protobuf support](#protobuf-support)
 * [Using with NodeJS](#using-with-nodejs)
 * [Custom WebSocket constructor](#custom-websocket-constructor)
+* [Run tests locally](#run-tests-locally)
 
 ## Install
 
@@ -815,3 +816,17 @@ var centrifuge = new Centrifuge('ws://localhost:8000/connection/websocket', {
 ```
 
 See a basic example with React Native where this technique is used [in this comment](https://github.com/centrifugal/centrifuge-js/issues/224#issuecomment-1538820023).
+
+## Run tests locally
+
+If you want to run `centrifuge-js` tests locally, start test Centrifugo server:
+
+```
+docker compose up
+```
+
+Then:
+
+```
+yarn test
+```

package/build/centrifuge.d.ts

@@ -7,6 +7,7 @@ declare const Centrifuge_base: new () => TypedEventEmitter<ClientEvents>;
 /** Centrifuge is a Centrifuge/Centrifugo bidirectional client. */
 export declare class Centrifuge extends Centrifuge_base {
     state: State;
+    private _transportIsOpen;
     private _endpoint;
     private _emulation;
     private _transports;

package/build/index.js

@@ -783,12 +783,15 @@ class Subscription extends EventEmitter$1 {
         if (this._setState(exports.SubscriptionState.Subscribing)) {
             this.emit('subscribing', { channel: this.channel, code: code, reason: reason });
         }
-        this._subscribe(false, false);
+        this._subscribe();
     }
-    _subscribe(optimistic, skipSending) {
+    _subscribe() {
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         this._centrifuge._debug('subscribing on', this.channel);
-        if (this._centrifuge.state !== exports.State.Connected && !optimistic) {
+        // need to check transport readiness here, because there's no point for calling getData or getToken
+        // if transport is not ready yet
+        // @ts-ignore – we are hiding some symbols from public API autocompletion.
+        if (!this._centrifuge._transportIsOpen) {
             // @ts-ignore – we are hiding some symbols from public API autocompletion.
             this._centrifuge._debug('delay subscribe on', this.channel, 'till connected');
             // subscribe will be called later automatically.
@@ -805,17 +808,14 @@ class Subscription extends EventEmitter$1 {
                         return;
                     }
                     self._data = data;
-                    self._sendSubscribe(self._token, false);
+                    self._sendSubscribe(self._token);
                 });
                 return null;
             }
             else {
-                return self._sendSubscribe(self._token, skipSending);
+                return self._sendSubscribe(self._token);
             }
         }
-        if (optimistic) {
-            return null;
-        }
         this._getSubscriptionToken().then(function (token) {
             if (!self._isSubscribing()) {
                 return;
@@ -831,11 +831,11 @@ class Subscription extends EventEmitter$1 {
                         return;
                     }
                     self._data = data;
-                    self._sendSubscribe(token, false);
+                    self._sendSubscribe(token);
                 });
             }
             else {
-                self._sendSubscribe(token, false);
+                self._sendSubscribe(token);
             }
         }).catch(function (e) {
             if (!self._isSubscribing()) {
@@ -857,7 +857,13 @@ class Subscription extends EventEmitter$1 {
         });
         return null;
     }
-    _sendSubscribe(token, skipSending) {
+    _sendSubscribe(token) {
+        // we also need to check for transport state before sending subscription
+        // because it may change for subscription with side effects (getData, getToken options)
+        // @ts-ignore – we are hiding some symbols from public API autocompletion.
+        if (!this._centrifuge._transportIsOpen) {
+            return null;
+        }
         const channel = this.channel;
         const req = {
             channel: channel
@@ -891,7 +897,7 @@ class Subscription extends EventEmitter$1 {
         const cmd = { subscribe: req };
         this._inflight = true;
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
-        this._centrifuge._call(cmd, skipSending).then(resolveCtx => {
+        this._centrifuge._call(cmd).then(resolveCtx => {
             this._inflight = false;
             // @ts-ignore - improve later.
             const result = resolveCtx.reply.subscribe;
@@ -997,7 +1003,7 @@ class Subscription extends EventEmitter$1 {
         const delay = this._getResubscribeDelay();
         this._resubscribeTimeout = setTimeout(function () {
             if (self._isSubscribing()) {
-                self._subscribe(false, false);
+                self._subscribe();
             }
         }, delay);
     }
@@ -1820,6 +1826,7 @@ class Centrifuge extends EventEmitter$1 {
         this._refreshTimeout = null;
         this._serverPingTimeout = null;
         this.state = exports.State.Disconnected;
+        this._transportIsOpen = false;
         this._endpoint = endpoint;
         this._emulation = false;
         this._transports = [];
@@ -2425,25 +2432,10 @@ class Centrifuge extends EventEmitter$1 {
         const transportId = this._nextTransportId();
         self._debug("id of transport", transportId);
         let wasOpen = false;
-        let optimistic = true;
-        if (this._transport.name() === 'sse') {
-            // Avoid using optimistic subscriptions with SSE/EventSource as we are sending
-            // initial data in URL params. URL is recommended to be 2048 chars max – so adding
-            // subscription data may be risky.
-            optimistic = false;
-        }
         const initialCommands = [];
         if (this._transport.emulation()) {
             const connectCommand = self._sendConnect(true);
             initialCommands.push(connectCommand);
-            if (optimistic) {
-                const subscribeCommands = self._sendSubscribeCommands(true, true);
-                for (const i in subscribeCommands) {
-                    if (subscribeCommands.hasOwnProperty(i)) {
-                        initialCommands.push(subscribeCommands[i]);
-                    }
-                }
-            }
         }
         this._setNetworkEvents();
         const initialData = this._codec.encodeCommands(initialCommands);
@@ -2465,16 +2457,17 @@ class Centrifuge extends EventEmitter$1 {
                 }
                 wasOpen = true;
                 self._debug(transport.subName(), 'transport open');
-                self._transportWasOpen = true;
                 if (transport.emulation()) {
                     return;
                 }
+                self._transportIsOpen = true;
+                self._transportWasOpen = true;
                 self.startBatching();
                 self._sendConnect(false);
-                if (optimistic) {
-                    self._sendSubscribeCommands(true, false);
-                }
+                self._sendSubscribeCommands();
                 self.stopBatching();
+                //@ts-ignore must be used only for debug and test purposes. Exposed only for non-emulation transport.
+                self.emit('__centrifuge_debug:connect_frame_sent', {});
             },
             onError: function (e) {
                 if (self._transportId != transportId) {
@@ -2494,6 +2487,7 @@ class Centrifuge extends EventEmitter$1 {
                 }
                 self._debug(transport.subName(), 'transport closed');
                 self._transportClosed = true;
+                self._transportIsOpen = false;
                 let reason = 'connection closed';
                 let needReconnect = true;
                 let code = 0;
@@ -2552,6 +2546,8 @@ class Centrifuge extends EventEmitter$1 {
                 self._dataReceived(data);
             }
         }, initialData);
+        //@ts-ignore must be used only for debug and test purposes.
+        self.emit('__centrifuge_debug:transport_initialized', {});
     }
     _sendConnect(skipSending) {
         const connectCommand = this._constructConnectCommand();
@@ -2665,7 +2661,6 @@ class Centrifuge extends EventEmitter$1 {
                 'error': err
             });
             this._debug('closing transport due to connect error');
-            this._reconnecting = false;
             this._disconnect(err.code, err.message, true);
         }
         else {
@@ -2685,6 +2680,7 @@ class Centrifuge extends EventEmitter$1 {
             delay = 0;
         }
         this._debug('reconnect after ' + delay + ' milliseconds');
+        this._clearReconnectTimeout();
         this._reconnectTimeout = setTimeout(() => {
             this._startReconnecting();
         }, delay);
@@ -2857,7 +2853,11 @@ class Centrifuge extends EventEmitter$1 {
         if (this._isDisconnected()) {
             return;
         }
+        // we mark transport is closed right away, because _clearConnectedState will move subscriptions to subscribing state
+        // if transport will still be open at this time, subscribe frames will be sent to closing transport
+        this._transportIsOpen = false;
         const previousState = this.state;
+        this._reconnecting = false;
         const ctx = {
             code: code,
             reason: reason
@@ -2890,6 +2890,8 @@ class Centrifuge extends EventEmitter$1 {
             const transport = this._transport;
             this._transport = null;
             transport.close(); // Close only after setting this._transport to null to avoid recursion when calling transport close().
+            // Need to mark as closed here, because connect call may be sync called after disconnect,
+            // transport onClose callback will not be called yet
             this._transportClosed = true;
             this._nextTransportId();
         }
@@ -2999,7 +3001,7 @@ class Centrifuge extends EventEmitter$1 {
         delete this._subs[sub.channel];
     }
     _unsubscribe(sub) {
-        if (!this._isConnected()) {
+        if (!this._transportIsOpen) {
             return;
         }
         const req = {
@@ -3030,7 +3032,7 @@ class Centrifuge extends EventEmitter$1 {
     _isServerSub(channel) {
         return this._serverSubs[channel] !== undefined;
     }
-    _sendSubscribeCommands(optimistic, skipSending) {
+    _sendSubscribeCommands() {
         const commands = [];
         for (const channel in this._subs) {
             if (!this._subs.hasOwnProperty(channel)) {
@@ -3043,7 +3045,7 @@ class Centrifuge extends EventEmitter$1 {
             }
             if (sub.state === exports.SubscriptionState.Subscribing) {
                 // @ts-ignore – we are hiding some symbols from public API autocompletion.
-                const cmd = sub._subscribe(optimistic, skipSending);
+                const cmd = sub._subscribe();
                 if (cmd) {
                     commands.push(cmd);
                 }
@@ -3052,6 +3054,7 @@ class Centrifuge extends EventEmitter$1 {
         return commands;
     }
     _connectResponse(result) {
+        this._transportIsOpen = true;
         this._transportWasOpen = true;
         this._reconnectAttempts = 0;
         this._refreshRequired = false;
@@ -3069,7 +3072,7 @@ class Centrifuge extends EventEmitter$1 {
         this._session = result.session;
         this._node = result.node;
         this.startBatching();
-        this._sendSubscribeCommands(false, false);
+        this._sendSubscribeCommands();
         this.stopBatching();
         const ctx = {
             client: result.client,

package/build/index.mjs

@@ -781,12 +781,15 @@ class Subscription extends EventEmitter$1 {
         if (this._setState(SubscriptionState.Subscribing)) {
             this.emit('subscribing', { channel: this.channel, code: code, reason: reason });
         }
-        this._subscribe(false, false);
+        this._subscribe();
     }
-    _subscribe(optimistic, skipSending) {
+    _subscribe() {
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         this._centrifuge._debug('subscribing on', this.channel);
-        if (this._centrifuge.state !== State.Connected && !optimistic) {
+        // need to check transport readiness here, because there's no point for calling getData or getToken
+        // if transport is not ready yet
+        // @ts-ignore – we are hiding some symbols from public API autocompletion.
+        if (!this._centrifuge._transportIsOpen) {
             // @ts-ignore – we are hiding some symbols from public API autocompletion.
             this._centrifuge._debug('delay subscribe on', this.channel, 'till connected');
             // subscribe will be called later automatically.
@@ -803,17 +806,14 @@ class Subscription extends EventEmitter$1 {
                         return;
                     }
                     self._data = data;
-                    self._sendSubscribe(self._token, false);
+                    self._sendSubscribe(self._token);
                 });
                 return null;
             }
             else {
-                return self._sendSubscribe(self._token, skipSending);
+                return self._sendSubscribe(self._token);
             }
         }
-        if (optimistic) {
-            return null;
-        }
         this._getSubscriptionToken().then(function (token) {
             if (!self._isSubscribing()) {
                 return;
@@ -829,11 +829,11 @@ class Subscription extends EventEmitter$1 {
                         return;
                     }
                     self._data = data;
-                    self._sendSubscribe(token, false);
+                    self._sendSubscribe(token);
                 });
             }
             else {
-                self._sendSubscribe(token, false);
+                self._sendSubscribe(token);
             }
         }).catch(function (e) {
             if (!self._isSubscribing()) {
@@ -855,7 +855,13 @@ class Subscription extends EventEmitter$1 {
         });
         return null;
     }
-    _sendSubscribe(token, skipSending) {
+    _sendSubscribe(token) {
+        // we also need to check for transport state before sending subscription
+        // because it may change for subscription with side effects (getData, getToken options)
+        // @ts-ignore – we are hiding some symbols from public API autocompletion.
+        if (!this._centrifuge._transportIsOpen) {
+            return null;
+        }
         const channel = this.channel;
         const req = {
             channel: channel
@@ -889,7 +895,7 @@ class Subscription extends EventEmitter$1 {
         const cmd = { subscribe: req };
         this._inflight = true;
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
-        this._centrifuge._call(cmd, skipSending).then(resolveCtx => {
+        this._centrifuge._call(cmd).then(resolveCtx => {
             this._inflight = false;
             // @ts-ignore - improve later.
             const result = resolveCtx.reply.subscribe;
@@ -995,7 +1001,7 @@ class Subscription extends EventEmitter$1 {
         const delay = this._getResubscribeDelay();
         this._resubscribeTimeout = setTimeout(function () {
             if (self._isSubscribing()) {
-                self._subscribe(false, false);
+                self._subscribe();
             }
         }, delay);
     }
@@ -1818,6 +1824,7 @@ class Centrifuge extends EventEmitter$1 {
         this._refreshTimeout = null;
         this._serverPingTimeout = null;
         this.state = State.Disconnected;
+        this._transportIsOpen = false;
         this._endpoint = endpoint;
         this._emulation = false;
         this._transports = [];
@@ -2423,25 +2430,10 @@ class Centrifuge extends EventEmitter$1 {
         const transportId = this._nextTransportId();
         self._debug("id of transport", transportId);
         let wasOpen = false;
-        let optimistic = true;
-        if (this._transport.name() === 'sse') {
-            // Avoid using optimistic subscriptions with SSE/EventSource as we are sending
-            // initial data in URL params. URL is recommended to be 2048 chars max – so adding
-            // subscription data may be risky.
-            optimistic = false;
-        }
         const initialCommands = [];
         if (this._transport.emulation()) {
             const connectCommand = self._sendConnect(true);
             initialCommands.push(connectCommand);
-            if (optimistic) {
-                const subscribeCommands = self._sendSubscribeCommands(true, true);
-                for (const i in subscribeCommands) {
-                    if (subscribeCommands.hasOwnProperty(i)) {
-                        initialCommands.push(subscribeCommands[i]);
-                    }
-                }
-            }
         }
         this._setNetworkEvents();
         const initialData = this._codec.encodeCommands(initialCommands);
@@ -2463,16 +2455,17 @@ class Centrifuge extends EventEmitter$1 {
                 }
                 wasOpen = true;
                 self._debug(transport.subName(), 'transport open');
-                self._transportWasOpen = true;
                 if (transport.emulation()) {
                     return;
                 }
+                self._transportIsOpen = true;
+                self._transportWasOpen = true;
                 self.startBatching();
                 self._sendConnect(false);
-                if (optimistic) {
-                    self._sendSubscribeCommands(true, false);
-                }
+                self._sendSubscribeCommands();
                 self.stopBatching();
+                //@ts-ignore must be used only for debug and test purposes. Exposed only for non-emulation transport.
+                self.emit('__centrifuge_debug:connect_frame_sent', {});
             },
             onError: function (e) {
                 if (self._transportId != transportId) {
@@ -2492,6 +2485,7 @@ class Centrifuge extends EventEmitter$1 {
                 }
                 self._debug(transport.subName(), 'transport closed');
                 self._transportClosed = true;
+                self._transportIsOpen = false;
                 let reason = 'connection closed';
                 let needReconnect = true;
                 let code = 0;
@@ -2550,6 +2544,8 @@ class Centrifuge extends EventEmitter$1 {
                 self._dataReceived(data);
             }
         }, initialData);
+        //@ts-ignore must be used only for debug and test purposes.
+        self.emit('__centrifuge_debug:transport_initialized', {});
     }
     _sendConnect(skipSending) {
         const connectCommand = this._constructConnectCommand();
@@ -2663,7 +2659,6 @@ class Centrifuge extends EventEmitter$1 {
                 'error': err
             });
             this._debug('closing transport due to connect error');
-            this._reconnecting = false;
             this._disconnect(err.code, err.message, true);
         }
         else {
@@ -2683,6 +2678,7 @@ class Centrifuge extends EventEmitter$1 {
             delay = 0;
         }
         this._debug('reconnect after ' + delay + ' milliseconds');
+        this._clearReconnectTimeout();
         this._reconnectTimeout = setTimeout(() => {
             this._startReconnecting();
         }, delay);
@@ -2855,7 +2851,11 @@ class Centrifuge extends EventEmitter$1 {
         if (this._isDisconnected()) {
             return;
         }
+        // we mark transport is closed right away, because _clearConnectedState will move subscriptions to subscribing state
+        // if transport will still be open at this time, subscribe frames will be sent to closing transport
+        this._transportIsOpen = false;
         const previousState = this.state;
+        this._reconnecting = false;
         const ctx = {
             code: code,
             reason: reason
@@ -2888,6 +2888,8 @@ class Centrifuge extends EventEmitter$1 {
             const transport = this._transport;
             this._transport = null;
             transport.close(); // Close only after setting this._transport to null to avoid recursion when calling transport close().
+            // Need to mark as closed here, because connect call may be sync called after disconnect,
+            // transport onClose callback will not be called yet
             this._transportClosed = true;
             this._nextTransportId();
         }
@@ -2997,7 +2999,7 @@ class Centrifuge extends EventEmitter$1 {
         delete this._subs[sub.channel];
     }
     _unsubscribe(sub) {
-        if (!this._isConnected()) {
+        if (!this._transportIsOpen) {
             return;
         }
         const req = {
@@ -3028,7 +3030,7 @@ class Centrifuge extends EventEmitter$1 {
     _isServerSub(channel) {
         return this._serverSubs[channel] !== undefined;
     }
-    _sendSubscribeCommands(optimistic, skipSending) {
+    _sendSubscribeCommands() {
         const commands = [];
         for (const channel in this._subs) {
             if (!this._subs.hasOwnProperty(channel)) {
@@ -3041,7 +3043,7 @@ class Centrifuge extends EventEmitter$1 {
             }
             if (sub.state === SubscriptionState.Subscribing) {
                 // @ts-ignore – we are hiding some symbols from public API autocompletion.
-                const cmd = sub._subscribe(optimistic, skipSending);
+                const cmd = sub._subscribe();
                 if (cmd) {
                     commands.push(cmd);
                 }
@@ -3050,6 +3052,7 @@ class Centrifuge extends EventEmitter$1 {
         return commands;
     }
     _connectResponse(result) {
+        this._transportIsOpen = true;
         this._transportWasOpen = true;
         this._reconnectAttempts = 0;
         this._refreshRequired = false;
@@ -3067,7 +3070,7 @@ class Centrifuge extends EventEmitter$1 {
         this._session = result.session;
         this._node = result.node;
         this.startBatching();
-        this._sendSubscribeCommands(false, false);
+        this._sendSubscribeCommands();
         this.stopBatching();
         const ctx = {
             client: result.client,

package/build/protobuf/centrifuge.d.ts

@@ -7,6 +7,7 @@ declare const Centrifuge_base: new () => TypedEventEmitter<ClientEvents>;
 /** Centrifuge is a Centrifuge/Centrifugo bidirectional client. */
 export declare class Centrifuge extends Centrifuge_base {
     state: State;
+    private _transportIsOpen;
     private _endpoint;
     private _emulation;
     private _transports;