centrifuge 5.2.0-beta.1 → 5.2.1

package/README.md

@@ -522,7 +522,7 @@ You can call `unsubscribe` method to unsubscribe from a channel:
 sub.unsubscribe();
 ```
 
-**Important thing to know** is that unsubscribing from subscription does not remove event handlers you already set to that Subscription object. This allows to simply subscribe to channel again later calling `.subscribe()` method of subscription (see below). But there are cases when your code structured in a way that you need to remove event handlers after unsubscribe **to prevent them be executed twice** in the future. To do this remove event listeners explicitly after calling `unsubscribe()`:
+**Important thing to mention** is that unsubscribing from subscription does not remove event handlers you already set to that Subscription object. This allows to simply subscribe to channel again later calling `.subscribe()` method of subscription (see below). But there are cases when your code structured in a way that you need to remove event handlers after unsubscribe **to prevent them be executed twice** in the future. To do this remove event listeners explicitly after calling `unsubscribe()`:
 
 ```javascript
 sub.unsubscribe();

package/build/centrifuge.d.ts

@@ -127,7 +127,7 @@ export declare class Centrifuge extends Centrifuge_base {
     private _getRefreshRetryDelay;
     private _refreshResponse;
     private _removeSubscription;
-    protected _unsubscribe(sub: Subscription): void;
+    protected _unsubscribe(sub: Subscription): Promise<void>;
     private _getSub;
     private _isServerSub;
     private _sendSubscribeCommands;

package/build/index.js

@@ -1,5 +1,37 @@
 'use strict';
 
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
 }
@@ -614,6 +646,7 @@ class Subscription extends EventEmitter$1 {
         this._delta = '';
         this._delta_negotiated = false;
         this._prevValue = null;
+        this._unsubPromise = Promise.resolve();
         this._setOptions(options);
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         if (this._centrifuge._debugEnabled) {
@@ -664,7 +697,7 @@ class Subscription extends EventEmitter$1 {
     }
     /** unsubscribe from a channel, keeping position state.*/
     unsubscribe() {
-        this._setUnsubscribed(exports.unsubscribedCodes.unsubscribeCalled, 'unsubscribe called', true);
+        this._unsubPromise = this._setUnsubscribed(exports.unsubscribedCodes.unsubscribeCalled, 'unsubscribe called', true);
     }
     /** publish data to a channel.*/
     publish(data) {
@@ -783,16 +816,25 @@ class Subscription extends EventEmitter$1 {
         }
     }
     _setSubscribing(code, reason) {
-        if (this._isSubscribing()) {
-            return;
-        }
-        if (this._isSubscribed()) {
-            this._clearSubscribedState();
-        }
-        if (this._setState(exports.SubscriptionState.Subscribing)) {
-            this.emit('subscribing', { channel: this.channel, code: code, reason: reason });
-        }
-        this._subscribe();
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._isSubscribing()) {
+                return;
+            }
+            if (this._isSubscribed()) {
+                this._clearSubscribedState();
+            }
+            if (this._setState(exports.SubscriptionState.Subscribing)) {
+                this.emit('subscribing', { channel: this.channel, code: code, reason: reason });
+            }
+            // @ts-ignore – for performance reasons only await _unsubPromise for emulution case where it's required.
+            if (this._centrifuge._transport && this._centrifuge._transport.emulation()) {
+                yield this._unsubPromise;
+            }
+            if (!this._isSubscribing()) {
+                return;
+            }
+            this._subscribe();
+        });
     }
     _subscribe() {
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
@@ -947,19 +989,20 @@ class Subscription extends EventEmitter$1 {
     }
     _setUnsubscribed(code, reason, sendUnsubscribe) {
         if (this._isUnsubscribed()) {
-            return;
+            return Promise.resolve();
         }
+        let promise = Promise.resolve();
         if (this._isSubscribed()) {
             if (sendUnsubscribe) {
                 // @ts-ignore – we are hiding some methods from public API autocompletion.
-                this._centrifuge._unsubscribe(this);
+                promise = this._centrifuge._unsubscribe(this);
             }
             this._clearSubscribedState();
         }
-        if (this._isSubscribing()) {
+        else if (this._isSubscribing()) {
             if (this._inflight && sendUnsubscribe) {
                 // @ts-ignore – we are hiding some methods from public API autocompletion.
-                this._centrifuge._unsubscribe(this);
+                promise = this._centrifuge._unsubscribe(this);
             }
             this._clearSubscribingState();
         }
@@ -967,6 +1010,7 @@ class Subscription extends EventEmitter$1 {
             this.emit('unsubscribed', { channel: this.channel, code: code, reason: reason });
         }
         this._rejectPromises({ code: exports.errorCodes.subscriptionUnsubscribed, message: this.state });
+        return promise;
     }
     _handlePublication(pub) {
         if (this._delta && this._delta_negotiated) {
@@ -1605,38 +1649,6 @@ class SseTransport {
     }
 }
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
-
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
 /** @internal */
 class WebtransportTransport {
     constructor(endpoint, options) {
@@ -3202,25 +3214,30 @@ class Centrifuge extends EventEmitter$1 {
     }
     _unsubscribe(sub) {
         if (!this._transportIsOpen) {
-            return;
+            return Promise.resolve();
         }
         const req = {
             channel: sub.channel
         };
         const cmd = { unsubscribe: req };
         const self = this;
-        this._call(cmd, false).then(resolveCtx => {
-            // @ts-ignore - improve later.
-            if (resolveCtx.next) {
+        const unsubscribePromise = new Promise((resolve, _) => {
+            this._call(cmd, false).then(resolveCtx => {
+                resolve();
                 // @ts-ignore - improve later.
-                resolveCtx.next();
-            }
-        }, rejectCtx => {
-            if (rejectCtx.next) {
-                rejectCtx.next();
-            }
-            self._disconnect(exports.connectingCodes.unsubscribeError, 'unsubscribe error', true);
+                if (resolveCtx.next) {
+                    // @ts-ignore - improve later.
+                    resolveCtx.next();
+                }
+            }, rejectCtx => {
+                resolve();
+                if (rejectCtx.next) {
+                    rejectCtx.next();
+                }
+                self._disconnect(exports.connectingCodes.unsubscribeError, 'unsubscribe error', true);
+            });
         });
+        return unsubscribePromise;
     }
     _getSub(channel) {
         const sub = this._subs[channel];

package/build/index.mjs

@@ -1,3 +1,35 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
 }
@@ -612,6 +644,7 @@ class Subscription extends EventEmitter$1 {
         this._delta = '';
         this._delta_negotiated = false;
         this._prevValue = null;
+        this._unsubPromise = Promise.resolve();
         this._setOptions(options);
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         if (this._centrifuge._debugEnabled) {
@@ -662,7 +695,7 @@ class Subscription extends EventEmitter$1 {
     }
     /** unsubscribe from a channel, keeping position state.*/
     unsubscribe() {
-        this._setUnsubscribed(unsubscribedCodes.unsubscribeCalled, 'unsubscribe called', true);
+        this._unsubPromise = this._setUnsubscribed(unsubscribedCodes.unsubscribeCalled, 'unsubscribe called', true);
     }
     /** publish data to a channel.*/
     publish(data) {
@@ -781,16 +814,25 @@ class Subscription extends EventEmitter$1 {
         }
     }
     _setSubscribing(code, reason) {
-        if (this._isSubscribing()) {
-            return;
-        }
-        if (this._isSubscribed()) {
-            this._clearSubscribedState();
-        }
-        if (this._setState(SubscriptionState.Subscribing)) {
-            this.emit('subscribing', { channel: this.channel, code: code, reason: reason });
-        }
-        this._subscribe();
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._isSubscribing()) {
+                return;
+            }
+            if (this._isSubscribed()) {
+                this._clearSubscribedState();
+            }
+            if (this._setState(SubscriptionState.Subscribing)) {
+                this.emit('subscribing', { channel: this.channel, code: code, reason: reason });
+            }
+            // @ts-ignore – for performance reasons only await _unsubPromise for emulution case where it's required.
+            if (this._centrifuge._transport && this._centrifuge._transport.emulation()) {
+                yield this._unsubPromise;
+            }
+            if (!this._isSubscribing()) {
+                return;
+            }
+            this._subscribe();
+        });
     }
     _subscribe() {
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
@@ -945,19 +987,20 @@ class Subscription extends EventEmitter$1 {
     }
     _setUnsubscribed(code, reason, sendUnsubscribe) {
         if (this._isUnsubscribed()) {
-            return;
+            return Promise.resolve();
         }
+        let promise = Promise.resolve();
         if (this._isSubscribed()) {
             if (sendUnsubscribe) {
                 // @ts-ignore – we are hiding some methods from public API autocompletion.
-                this._centrifuge._unsubscribe(this);
+                promise = this._centrifuge._unsubscribe(this);
             }
             this._clearSubscribedState();
         }
-        if (this._isSubscribing()) {
+        else if (this._isSubscribing()) {
             if (this._inflight && sendUnsubscribe) {
                 // @ts-ignore – we are hiding some methods from public API autocompletion.
-                this._centrifuge._unsubscribe(this);
+                promise = this._centrifuge._unsubscribe(this);
             }
             this._clearSubscribingState();
         }
@@ -965,6 +1008,7 @@ class Subscription extends EventEmitter$1 {
             this.emit('unsubscribed', { channel: this.channel, code: code, reason: reason });
         }
         this._rejectPromises({ code: errorCodes.subscriptionUnsubscribed, message: this.state });
+        return promise;
     }
     _handlePublication(pub) {
         if (this._delta && this._delta_negotiated) {
@@ -1603,38 +1647,6 @@ class SseTransport {
     }
 }
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
-
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
 /** @internal */
 class WebtransportTransport {
     constructor(endpoint, options) {
@@ -3200,25 +3212,30 @@ class Centrifuge extends EventEmitter$1 {
     }
     _unsubscribe(sub) {
         if (!this._transportIsOpen) {
-            return;
+            return Promise.resolve();
         }
         const req = {
             channel: sub.channel
         };
         const cmd = { unsubscribe: req };
         const self = this;
-        this._call(cmd, false).then(resolveCtx => {
-            // @ts-ignore - improve later.
-            if (resolveCtx.next) {
+        const unsubscribePromise = new Promise((resolve, _) => {
+            this._call(cmd, false).then(resolveCtx => {
+                resolve();
                 // @ts-ignore - improve later.
-                resolveCtx.next();
-            }
-        }, rejectCtx => {
-            if (rejectCtx.next) {
-                rejectCtx.next();
-            }
-            self._disconnect(connectingCodes.unsubscribeError, 'unsubscribe error', true);
+                if (resolveCtx.next) {
+                    // @ts-ignore - improve later.
+                    resolveCtx.next();
+                }
+            }, rejectCtx => {
+                resolve();
+                if (rejectCtx.next) {
+                    rejectCtx.next();
+                }
+                self._disconnect(connectingCodes.unsubscribeError, 'unsubscribe error', true);
+            });
         });
+        return unsubscribePromise;
     }
     _getSub(channel) {
         const sub = this._subs[channel];

package/build/protobuf/centrifuge.d.ts

@@ -127,7 +127,7 @@ export declare class Centrifuge extends Centrifuge_base {
     private _getRefreshRetryDelay;
     private _refreshResponse;
     private _removeSubscription;
-    protected _unsubscribe(sub: Subscription): void;
+    protected _unsubscribe(sub: Subscription): Promise<void>;
     private _getSub;
     private _isServerSub;
     private _sendSubscribeCommands;