centrifuge 5.3.4 → 5.4.0-beta.1

package/README.md

@@ -28,6 +28,7 @@ The features implemented by this SDK can be found in [SDK feature matrix](https:
 * [Using with NodeJS](#using-with-nodejs)
 * [Custom WebSocket constructor](#custom-websocket-constructor)
 * [Using with React Native on Android](#using-with-react-native-on-android)
+* [Errors in callbacks](#errors-in-callbacks)
 * [Run tests locally](#run-tests-locally)
 
 ## Install
@@ -605,7 +606,7 @@ getSubscription returns `Subscription` if it's registered in the internal regist
 
 `removeSubscription(sub: Subscription | null)`
 
-removeSubscription allows removing Subcription from the internal registry. Subscrption must be in unsubscribed state.
+removeSubscription allows removing Subcription from the internal registry.
 
 ### subscriptions
 
@@ -822,6 +823,10 @@ See a basic example with React Native where this technique is used [in this comm
 
 If you have issues with the connection on Android when using React Native – [check out this comment](https://github.com/centrifugal/centrifuge-js/issues/242#issuecomment-2569474401) – you may be using non-secure endpoint schemes and need to explicitly allow it.
 
+## Errors in callbacks
+
+There is currently no built-in error handling in the SDK for exceptions happening in application-level callbacks, which means you must catch any error that could be thrown in a listener. Not doing that may corrupt a state of SDK making it unusable.
+
 ## Run tests locally
 
 If you want to run `centrifuge-js` tests locally, start test Centrifugo server:

package/build/centrifuge.d.ts

@@ -57,8 +57,7 @@ export declare class Centrifuge extends Centrifuge_base {
     /** getSubscription returns Subscription if it's registered in the internal
      * registry or null. */
     getSubscription(channel: string): Subscription | null;
-    /** removeSubscription allows removing Subcription from the internal registry. Subscrption
-     * must be in unsubscribed state. */
+    /** removeSubscription allows removing Subcription from the internal registry. */
     removeSubscription(sub: Subscription | null): void;
     /** Get a map with all current client-side subscriptions. */
     subscriptions(): Record<string, Subscription>;
@@ -88,7 +87,6 @@ export declare class Centrifuge extends Centrifuge_base {
     history(channel: string, options?: HistoryOptions): Promise<HistoryResult>;
     /** presence for a channel. */
     presence(channel: string): Promise<PresenceResult>;
-    /** presence stats for a channel. */
     presenceStats(channel: string): Promise<PresenceStatsResult>;
     /** start command batching (collect into temporary buffer without sending to a server)
      * until stopBatching called.*/
@@ -97,6 +95,7 @@ export declare class Centrifuge extends Centrifuge_base {
      * network (all in one request/frame).*/
     stopBatching(): void;
     private _debug;
+    private _codecName;
     private _configure;
     private _setState;
     private _isDisconnected;

package/build/index.js

@@ -699,31 +699,31 @@ class Subscription extends EventEmitter$1 {
     }
     /** publish data to a channel.*/
     publish(data) {
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._centrifuge.publish(self.channel, data);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._methodCall();
+            return this._centrifuge.publish(this.channel, data);
         });
     }
     /** get online presence for a channel.*/
     presence() {
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._centrifuge.presence(self.channel);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._methodCall();
+            return this._centrifuge.presence(this.channel);
         });
     }
     /** presence stats for a channel (num clients and unique users).*/
     presenceStats() {
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._centrifuge.presenceStats(self.channel);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._methodCall();
+            return this._centrifuge.presenceStats(this.channel);
         });
     }
     /** history for a channel. By default it does not return publications (only current
      *  StreamPosition data) – provide an explicit limit > 0 to load publications.*/
     history(opts) {
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._centrifuge.history(self.channel, opts);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._methodCall();
+            return this._centrifuge.history(this.channel, opts);
         });
     }
     _methodCall() {
@@ -731,17 +731,21 @@ class Subscription extends EventEmitter$1 {
             return Promise.resolve();
         }
         if (this._isUnsubscribed()) {
-            return Promise.reject({ code: exports.errorCodes.subscriptionUnsubscribed, message: this.state });
+            return Promise.reject({
+                code: exports.errorCodes.subscriptionUnsubscribed,
+                message: this.state
+            });
         }
-        return new Promise((res, rej) => {
-            const timeout = setTimeout(function () {
-                rej({ code: exports.errorCodes.timeout, message: 'timeout' });
-                // @ts-ignore – we are hiding some symbols from public API autocompletion.
-            }, this._centrifuge._config.timeout);
+        return new Promise((resolve, reject) => {
+            // @ts-ignore – we are hiding some symbols from public API autocompletion.
+            const timeoutDuration = this._centrifuge._config.timeout;
+            const timeout = setTimeout(() => {
+                reject({ code: exports.errorCodes.timeout, message: 'timeout' });
+            }, timeoutDuration);
             this._promises[this._nextPromiseId()] = {
-                timeout: timeout,
-                resolve: res,
-                reject: rej
+                timeout,
+                resolve,
+                reject
             };
         });
     }
@@ -953,12 +957,9 @@ class Subscription extends EventEmitter$1 {
         // @ts-ignore – we are hiding some symbols from public API autocompletion.
         this._centrifuge._call(cmd).then(resolveCtx => {
             this._inflight = false;
-            // @ts-ignore - improve later.
             const result = resolveCtx.reply.subscribe;
             this._handleSubscribeResponse(result);
-            // @ts-ignore - improve later.
             if (resolveCtx.next) {
-                // @ts-ignore - improve later.
                 resolveCtx.next();
             }
         }, rejectCtx => {
@@ -1136,8 +1137,8 @@ class Subscription extends EventEmitter$1 {
             return;
         }
         if (options.since) {
-            this._offset = options.since.offset;
-            this._epoch = options.since.epoch;
+            this._offset = options.since.offset || 0;
+            this._epoch = options.since.epoch || '';
             this._recover = true;
         }
         if (options.data) {
@@ -1215,7 +1216,7 @@ class Subscription extends EventEmitter$1 {
                     message: 'provide a function to get channel subscription token'
                 }
             });
-            throw new UnauthorizedError('');
+            return Promise.reject(new UnauthorizedError(''));
         }
         return getToken(ctx);
     }
@@ -1240,12 +1241,9 @@ class Subscription extends EventEmitter$1 {
             };
             // @ts-ignore – we are hiding some symbols from public API autocompletion.
             self._centrifuge._call(msg).then(resolveCtx => {
-                // @ts-ignore - improve later.
                 const result = resolveCtx.reply.sub_refresh;
                 self._refreshResponse(result);
-                // @ts-ignore - improve later.
                 if (resolveCtx.next) {
-                    // @ts-ignore - improve later.
                     resolveCtx.next();
                 }
             }, rejectCtx => {
@@ -2139,8 +2137,7 @@ class Centrifuge extends EventEmitter$1 {
     getSubscription(channel) {
         return this._getSub(channel);
     }
-    /** removeSubscription allows removing Subcription from the internal registry. Subscrption
-     * must be in unsubscribed state. */
+    /** removeSubscription allows removing Subcription from the internal registry. */
     removeSubscription(sub) {
         if (!sub) {
             return;
@@ -2158,24 +2155,22 @@ class Centrifuge extends EventEmitter$1 {
      * state and rejects in case of client goes to Disconnected or Failed state.
      * Users can provide optional timeout in milliseconds. */
     ready(timeout) {
-        if (this.state === exports.State.Disconnected) {
-            return Promise.reject({ code: exports.errorCodes.clientDisconnected, message: 'client disconnected' });
-        }
-        if (this.state === exports.State.Connected) {
-            return Promise.resolve();
+        switch (this.state) {
+            case exports.State.Disconnected:
+                return Promise.reject({ code: exports.errorCodes.clientDisconnected, message: 'client disconnected' });
+            case exports.State.Connected:
+                return Promise.resolve();
+            default:
+                return new Promise((resolve, reject) => {
+                    const ctx = { resolve, reject };
+                    if (timeout) {
+                        ctx.timeout = setTimeout(() => {
+                            reject({ code: exports.errorCodes.timeout, message: 'timeout' });
+                        }, timeout);
+                    }
+                    this._promises[this._nextPromiseId()] = ctx;
+                });
         }
-        return new Promise((res, rej) => {
-            const ctx = {
-                resolve: res,
-                reject: rej
-            };
-            if (timeout) {
-                ctx.timeout = setTimeout(function () {
-                    rej({ code: exports.errorCodes.timeout, message: 'timeout' });
-                }, timeout);
-            }
-            this._promises[this._nextPromiseId()] = ctx;
-        });
     }
     /** connect to a server. */
     connect() {
@@ -2206,121 +2201,113 @@ class Centrifuge extends EventEmitter$1 {
     /** send asynchronous data to a server (without any response from a server
      * expected, see rpc method if you need response). */
     send(data) {
-        const cmd = {
-            send: {
-                data: data
-            }
-        };
-        const self = this;
-        return this._methodCall().then(function () {
-            const sent = self._transportSendCommands([cmd]); // can send message to server without id set
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmd = {
+                send: {
+                    data
+                }
+            };
+            yield this._methodCall();
+            const sent = this._transportSendCommands([cmd]); // can send message to server without id set
             if (!sent) {
-                return Promise.reject(self._createErrorObject(exports.errorCodes.transportWriteError, 'transport write error'));
+                throw this._createErrorObject(exports.errorCodes.transportWriteError, 'transport write error');
             }
-            return Promise.resolve();
         });
     }
     /** rpc to a server - i.e. a call which waits for a response with data. */
     rpc(method, data) {
-        const cmd = {
-            rpc: {
-                method: method,
-                data: data
-            }
-        };
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._callPromise(cmd, function (reply) {
-                return {
-                    'data': reply.rpc.data
-                };
-            });
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmd = {
+                rpc: {
+                    method,
+                    data
+                }
+            };
+            yield this._methodCall();
+            const result = yield this._callPromise(cmd, (reply) => reply.rpc);
+            return {
+                data: result.data
+            };
         });
     }
     /** publish data to a channel. */
     publish(channel, data) {
-        const cmd = {
-            publish: {
-                channel: channel,
-                data: data
-            }
-        };
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._callPromise(cmd, function () {
-                return {};
-            });
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmd = {
+                publish: {
+                    channel,
+                    data
+                }
+            };
+            yield this._methodCall();
+            yield this._callPromise(cmd, () => ({}));
+            return {};
         });
     }
     /** history for a channel. By default it does not return publications (only current
      *  StreamPosition data) – provide an explicit limit > 0 to load publications.*/
     history(channel, options) {
-        const cmd = {
-            history: this._getHistoryRequest(channel, options)
-        };
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._callPromise(cmd, function (reply) {
-                const result = reply.history;
-                const publications = [];
-                if (result.publications) {
-                    for (let i = 0; i < result.publications.length; i++) {
-                        publications.push(self._getPublicationContext(channel, result.publications[i]));
-                    }
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmd = {
+                history: this._getHistoryRequest(channel, options)
+            };
+            yield this._methodCall();
+            const result = yield this._callPromise(cmd, (reply) => reply.history);
+            const publications = [];
+            if (result.publications) {
+                for (let i = 0; i < result.publications.length; i++) {
+                    publications.push(this._getPublicationContext(channel, result.publications[i]));
                 }
-                return {
-                    'publications': publications,
-                    'epoch': result.epoch || '',
-                    'offset': result.offset || 0
-                };
-            });
+            }
+            return {
+                publications,
+                epoch: result.epoch || '',
+                offset: result.offset || 0
+            };
         });
     }
     /** presence for a channel. */
     presence(channel) {
-        const cmd = {
-            presence: {
-                channel: channel
-            }
-        };
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._callPromise(cmd, function (reply) {
-                const clients = reply.presence.presence;
-                for (const clientId in clients) {
-                    if (clients.hasOwnProperty(clientId)) {
-                        const connInfo = clients[clientId]['conn_info'];
-                        const chanInfo = clients[clientId]['chan_info'];
-                        if (connInfo) {
-                            clients[clientId].connInfo = connInfo;
-                        }
-                        if (chanInfo) {
-                            clients[clientId].chanInfo = chanInfo;
-                        }
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmd = {
+                presence: {
+                    channel
+                }
+            };
+            yield this._methodCall();
+            const result = yield this._callPromise(cmd, (reply) => reply.presence);
+            const clients = result.presence;
+            for (const clientId in clients) {
+                if (Object.prototype.hasOwnProperty.call(clients, clientId)) {
+                    const rawClient = clients[clientId];
+                    const connInfo = rawClient['conn_info'];
+                    const chanInfo = rawClient['chan_info'];
+                    if (connInfo) {
+                        rawClient.connInfo = connInfo;
+                    }
+                    if (chanInfo) {
+                        rawClient.chanInfo = chanInfo;
                     }
                 }
-                return {
-                    'clients': clients
-                };
-            });
+            }
+            return { clients };
         });
     }
-    /** presence stats for a channel. */
     presenceStats(channel) {
-        const cmd = {
-            'presence_stats': {
-                channel: channel
-            }
-        };
-        const self = this;
-        return this._methodCall().then(function () {
-            return self._callPromise(cmd, function (reply) {
-                const result = reply.presence_stats;
-                return {
-                    'numUsers': result.num_users,
-                    'numClients': result.num_clients
-                };
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmd = {
+                'presence_stats': {
+                    channel
+                }
+            };
+            yield this._methodCall();
+            const result = yield this._callPromise(cmd, (reply) => {
+                return reply.presence_stats;
             });
+            return {
+                numUsers: result.num_users,
+                numClients: result.num_clients
+            };
         });
     }
     /** start command batching (collect into temporary buffer without sending to a server)
@@ -2350,6 +2337,9 @@ class Centrifuge extends EventEmitter$1 {
         }
         log('debug', args);
     }
+    _codecName() {
+        return this._codec.name();
+    }
     /** @internal */
     _formatOverride() {
         return;
@@ -2693,7 +2683,7 @@ class Centrifuge extends EventEmitter$1 {
         connectTimeout = setTimeout(function () {
             transport.close();
         }, this._config.timeout);
-        this._transport.initialize(this._codec.name(), {
+        this._transport.initialize(this._codecName(), {
             onOpen: function () {
                 if (connectTimeout) {
                     clearTimeout(connectTimeout);
@@ -2802,12 +2792,9 @@ class Centrifuge extends EventEmitter$1 {
         const connectCommand = this._constructConnectCommand();
         const self = this;
         this._call(connectCommand, skipSending).then(resolveCtx => {
-            // @ts-ignore = improve later.
             const result = resolveCtx.reply.connect;
             self._connectResponse(result);
-            // @ts-ignore - improve later.
             if (resolveCtx.next) {
-                // @ts-ignore - improve later.
                 resolveCtx.next();
             }
         }, rejectCtx => {
@@ -3035,19 +3022,15 @@ class Centrifuge extends EventEmitter$1 {
     }
     _callPromise(cmd, resultCB) {
         return new Promise((resolve, reject) => {
-            this._call(cmd, false).then(resolveCtx => {
-                // @ts-ignore - improve later.
-                resolve(resultCB(resolveCtx.reply));
-                // @ts-ignore - improve later.
-                if (resolveCtx.next) {
-                    // @ts-ignore - improve later.
-                    resolveCtx.next();
-                }
-            }, rejectCtx => {
+            this._call(cmd, false).then((resolveCtx) => {
+                var _a;
+                const result = resultCB(resolveCtx.reply);
+                resolve(result);
+                (_a = resolveCtx.next) === null || _a === void 0 ? void 0 : _a.call(resolveCtx);
+            }, (rejectCtx) => {
+                var _a;
                 reject(rejectCtx.error);
-                if (rejectCtx.next) {
-                    rejectCtx.next();
-                }
+                (_a = rejectCtx.next) === null || _a === void 0 ? void 0 : _a.call(rejectCtx);
             });
         });
     }
@@ -3186,7 +3169,7 @@ class Centrifuge extends EventEmitter$1 {
                     message: 'token expired but no getToken function set in the configuration'
                 }
             });
-            throw new UnauthorizedError('');
+            return Promise.reject(new UnauthorizedError(''));
         }
         return this._config.getToken({});
     }
@@ -3210,12 +3193,9 @@ class Centrifuge extends EventEmitter$1 {
                 refresh: { token: self._token }
             };
             self._call(cmd, false).then(resolveCtx => {
-                // @ts-ignore - improve later.
                 const result = resolveCtx.reply.refresh;
                 self._refreshResponse(result);
-                // @ts-ignore - improve later.
                 if (resolveCtx.next) {
-                    // @ts-ignore - improve later.
                     resolveCtx.next();
                 }
             }, rejectCtx => {
@@ -3285,9 +3265,7 @@ class Centrifuge extends EventEmitter$1 {
         const unsubscribePromise = new Promise((resolve, _) => {
             this._call(cmd, false).then(resolveCtx => {
                 resolve();
-                // @ts-ignore - improve later.
                 if (resolveCtx.next) {
-                    // @ts-ignore - improve later.
                     resolveCtx.next();
                 }
             }, rejectCtx => {
@@ -3450,7 +3428,8 @@ class Centrifuge extends EventEmitter$1 {
             positioned: false,
             recoverable: false,
             wasRecovering: false,
-            recovered: false
+            recovered: false,
+            hasRecoveredPublications: false,
         };
         if (result.recovered) {
             ctx.recovered = true;
@@ -3478,6 +3457,9 @@ class Centrifuge extends EventEmitter$1 {
                 'epoch': epoch
             };
         }
+        if (Array.isArray(result.publications) && result.publications.length > 0) {
+            ctx.hasRecoveredPublications = true;
+        }
         if (result.data) {
             ctx.data = result.data;
         }
@@ -3505,7 +3487,7 @@ class Centrifuge extends EventEmitter$1 {
                 next();
                 return;
             }
-            const error = reply.error;
+            const error = { code: reply.error.code, message: reply.error.message || '', temporary: reply.error.temporary || false };
             errback({ error, next });
         }
     }
@@ -3588,11 +3570,13 @@ class Centrifuge extends EventEmitter$1 {
             client: clientInfo.client,
             user: clientInfo.user
         };
-        if (clientInfo.conn_info) {
-            info.connInfo = clientInfo.conn_info;
+        const connInfo = clientInfo['conn_info'];
+        if (connInfo) {
+            info.connInfo = connInfo;
         }
-        if (clientInfo.chan_info) {
-            info.chanInfo = clientInfo.chan_info;
+        const chanInfo = clientInfo['chan_info'];
+        if (chanInfo) {
+            info.chanInfo = chanInfo;
         }
         return info;
     }