spine-high-templar - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

dist/spine-high-templar.es.js

@@ -28,2 +28,52 @@ import mitt from 'mitt';
 
+var Subscription = function () {
+    function Subscription() {
+        var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+        classCallCheck(this, Subscription);
+        this.room = null;
+        this.socket = null;
+        this.requestId = null;
+        this.onPublish = null;
+        this.wrappedHandler = null;
+        this.messageCached = true;
+
+        this.room = props.room;
+        this.onPublish = props.onPublish;
+        this.socket = props.socket;
+        this.requestId = uuid();
+        this._start();
+    }
+
+    createClass(Subscription, [{
+        key: '_start',
+        value: function _start() {
+            if (this.onPublish) {
+                this._startListening();
+            }
+        }
+    }, {
+        key: '_startListening',
+        value: function _startListening() {
+            var _this = this;
+
+            var wrappedHandler = function wrappedHandler(msg) {
+                if (msg.requestId !== _this.requestId || msg.type !== 'publish') {
+                    return false;
+                }
+                _this.onPublish(msg);
+            };
+            this.wrappedHandler = wrappedHandler;
+            this.socket.on('message', wrappedHandler);
+        }
+    }, {
+        key: 'stopListening',
+        value: function stopListening() {
+            if (this.wrappedHandler) {
+                this.socket.off('message', this.wrappedHandler);
+            }
+        }
+    }]);
+    return Subscription;
+}();
+
 var Socket = function () {
@@ -35,4 +85,4 @@ function Socket() {
         this.pingIntervalHandle = null;
-        this.publishHandlers = {};
-        this.pendingSendMessages = [];
+        this.subscriptions = [];
+        this.pendingSendActions = [];
         this.pingInterval = 30000;
@@ -67,2 +117,3 @@ this.reconnectInterval = 2000;
                 _this._sendPendingMessages();
+                _this._reconnectSubscriptions();
                 _this._initiatePingInterval();
@@ -112,10 +163,18 @@ };
             };
-            // console.log('[sent]', msg);
-            // Wait for a while if the socket is not yet done connecting...
+            // If the socket is not connected, push them onto a stack
+            // which will pop when the socket connects.
             if (this.instance.readyState !== 1) {
-                this.pendingSendMessages.push(msg);
-                return;
+                var resolveSend = null;
+                var pSend = new Promise(function (resolve, reject) {
+                    resolveSend = resolve;
+                });
+                this.pendingSendActions.push({
+                    message: msg,
+                    resolve: resolveSend
+                });
+                return pSend;
             }
 
             this._sendDirectly(msg);
+            return Promise.resolve();
         }
@@ -128,49 +187,13 @@ }, {
 
-            var requestId = uuid();
-
-            if (onPublish) {
-                this._addPublishHandler(requestId, onPublish);
-            }
-
-            this.send({
-                type: 'subscribe',
-                requestId: requestId,
-                room: room
+            var sub = new Subscription({ room: room, onPublish: onPublish, socket: this });
+            this.subscriptions.push(sub);
+            this.notifySocketOfSubscription(sub).then(function () {
+                sub.messageCached = false;
             });
 
-            return requestId;
+            return sub;
         }
     }, {
-        key: 'unsubscribe',
-        value: function unsubscribe(requestId) {
-            this._removePublishHandler(requestId);
-            this.send({
-                type: 'unsubscribe',
-                requestId: requestId
-            });
-        }
-    }, {
-        key: '_addPublishHandler',
-        value: function _addPublishHandler(requestId, handler) {
-            var wrappedHandler = function wrappedHandler(msg) {
-                if (msg.requestId !== requestId || msg.type !== 'publish') {
-                    return false;
-                }
-                handler(msg);
-            };
-            this.on('message', wrappedHandler);
-            this.publishHandlers[requestId] = wrappedHandler;
-        }
-    }, {
-        key: '_removePublishHandler',
-        value: function _removePublishHandler(requestId) {
-            var handler = this.publishHandlers[requestId];
-            if (!handler) return;
-
-            delete this.publishHandlers[requestId];
-            this.off('message', handler);
-        }
-    }, {
-        key: '_sendPendingMessages',
-        value: function _sendPendingMessages() {
+        key: '_reconnectSubscriptions',
+        value: function _reconnectSubscriptions() {
             var _iteratorNormalCompletion = true;
@@ -181,6 +204,9 @@ var _didIteratorError = false;
             try {
-                for (var _iterator = this.pendingSendMessages[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-                    var msg = _step.value;
+                for (var _iterator = this.subscriptions[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+                    var sub = _step.value;
 
-                    this._sendDirectly(msg);
+                    if (sub.messageCached) {
+                        return;
+                    }
+                    this.notifySocketOfSubscription(sub);
                 }
@@ -203,2 +229,54 @@ } catch (err) {
     }, {
+        key: 'notifySocketOfSubscription',
+        value: function notifySocketOfSubscription(sub) {
+            return this.send({
+                type: 'subscribe',
+                requestId: sub.requestId,
+                room: sub.room
+            });
+        }
+    }, {
+        key: 'unsubscribe',
+        value: function unsubscribe(subscription) {
+            subscription.stopListening();
+
+            var subIndex = this.subscriptions.indexOf(subscription);
+            this.subscriptions.splice(subIndex, 1);
+            return this.send({
+                type: 'unsubscribe',
+                requestId: subscription.requestId
+            });
+        }
+    }, {
+        key: '_sendPendingMessages',
+        value: function _sendPendingMessages() {
+            var _iteratorNormalCompletion2 = true;
+            var _didIteratorError2 = false;
+            var _iteratorError2 = undefined;
+
+            try {
+                for (var _iterator2 = this.pendingSendActions[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
+                    var action = _step2.value;
+
+                    this._sendDirectly(action.message);
+                    action.resolve();
+                }
+            } catch (err) {
+                _didIteratorError2 = true;
+                _iteratorError2 = err;
+            } finally {
+                try {
+                    if (!_iteratorNormalCompletion2 && _iterator2.return) {
+                        _iterator2.return();
+                    }
+                } finally {
+                    if (_didIteratorError2) {
+                        throw _iteratorError2;
+                    }
+                }
+            }
+
+            this.pendingSendActions = [];
+        }
+    }, {
         key: '_sendDirectly',
@@ -225,2 +303,9 @@ value: function _sendDirectly(msg) {
         }
+    }, {
+        key: 'pendingSendMessages',
+        get: function get$$1() {
+            return this.pendingSendActions.map(function (a) {
+                return a.message;
+            });
+        }
     }]);
@@ -230,2 +315,2 @@ return Socket;
 
-export { Socket };
+export { Socket, Subscription };

dist/spine-high-templar.umd.js

@@ -34,2 +34,52 @@ (function (global, factory) {
 
+var Subscription = function () {
+    function Subscription() {
+        var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+        classCallCheck(this, Subscription);
+        this.room = null;
+        this.socket = null;
+        this.requestId = null;
+        this.onPublish = null;
+        this.wrappedHandler = null;
+        this.messageCached = true;
+
+        this.room = props.room;
+        this.onPublish = props.onPublish;
+        this.socket = props.socket;
+        this.requestId = uuid();
+        this._start();
+    }
+
+    createClass(Subscription, [{
+        key: '_start',
+        value: function _start() {
+            if (this.onPublish) {
+                this._startListening();
+            }
+        }
+    }, {
+        key: '_startListening',
+        value: function _startListening() {
+            var _this = this;
+
+            var wrappedHandler = function wrappedHandler(msg) {
+                if (msg.requestId !== _this.requestId || msg.type !== 'publish') {
+                    return false;
+                }
+                _this.onPublish(msg);
+            };
+            this.wrappedHandler = wrappedHandler;
+            this.socket.on('message', wrappedHandler);
+        }
+    }, {
+        key: 'stopListening',
+        value: function stopListening() {
+            if (this.wrappedHandler) {
+                this.socket.off('message', this.wrappedHandler);
+            }
+        }
+    }]);
+    return Subscription;
+}();
+
 var Socket = function () {
@@ -41,4 +91,4 @@ function Socket() {
         this.pingIntervalHandle = null;
-        this.publishHandlers = {};
-        this.pendingSendMessages = [];
+        this.subscriptions = [];
+        this.pendingSendActions = [];
         this.pingInterval = 30000;
@@ -73,2 +123,3 @@ this.reconnectInterval = 2000;
                 _this._sendPendingMessages();
+                _this._reconnectSubscriptions();
                 _this._initiatePingInterval();
@@ -118,10 +169,18 @@ };
             };
-            // console.log('[sent]', msg);
-            // Wait for a while if the socket is not yet done connecting...
+            // If the socket is not connected, push them onto a stack
+            // which will pop when the socket connects.
             if (this.instance.readyState !== 1) {
-                this.pendingSendMessages.push(msg);
-                return;
+                var resolveSend = null;
+                var pSend = new Promise(function (resolve, reject) {
+                    resolveSend = resolve;
+                });
+                this.pendingSendActions.push({
+                    message: msg,
+                    resolve: resolveSend
+                });
+                return pSend;
             }
 
             this._sendDirectly(msg);
+            return Promise.resolve();
         }
@@ -134,49 +193,13 @@ }, {
 
-            var requestId = uuid();
-
-            if (onPublish) {
-                this._addPublishHandler(requestId, onPublish);
-            }
-
-            this.send({
-                type: 'subscribe',
-                requestId: requestId,
-                room: room
+            var sub = new Subscription({ room: room, onPublish: onPublish, socket: this });
+            this.subscriptions.push(sub);
+            this.notifySocketOfSubscription(sub).then(function () {
+                sub.messageCached = false;
             });
 
-            return requestId;
+            return sub;
         }
     }, {
-        key: 'unsubscribe',
-        value: function unsubscribe(requestId) {
-            this._removePublishHandler(requestId);
-            this.send({
-                type: 'unsubscribe',
-                requestId: requestId
-            });
-        }
-    }, {
-        key: '_addPublishHandler',
-        value: function _addPublishHandler(requestId, handler) {
-            var wrappedHandler = function wrappedHandler(msg) {
-                if (msg.requestId !== requestId || msg.type !== 'publish') {
-                    return false;
-                }
-                handler(msg);
-            };
-            this.on('message', wrappedHandler);
-            this.publishHandlers[requestId] = wrappedHandler;
-        }
-    }, {
-        key: '_removePublishHandler',
-        value: function _removePublishHandler(requestId) {
-            var handler = this.publishHandlers[requestId];
-            if (!handler) return;
-
-            delete this.publishHandlers[requestId];
-            this.off('message', handler);
-        }
-    }, {
-        key: '_sendPendingMessages',
-        value: function _sendPendingMessages() {
+        key: '_reconnectSubscriptions',
+        value: function _reconnectSubscriptions() {
             var _iteratorNormalCompletion = true;
@@ -187,6 +210,9 @@ var _didIteratorError = false;
             try {
-                for (var _iterator = this.pendingSendMessages[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-                    var msg = _step.value;
+                for (var _iterator = this.subscriptions[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+                    var sub = _step.value;
 
-                    this._sendDirectly(msg);
+                    if (sub.messageCached) {
+                        return;
+                    }
+                    this.notifySocketOfSubscription(sub);
                 }
@@ -209,2 +235,54 @@ } catch (err) {
     }, {
+        key: 'notifySocketOfSubscription',
+        value: function notifySocketOfSubscription(sub) {
+            return this.send({
+                type: 'subscribe',
+                requestId: sub.requestId,
+                room: sub.room
+            });
+        }
+    }, {
+        key: 'unsubscribe',
+        value: function unsubscribe(subscription) {
+            subscription.stopListening();
+
+            var subIndex = this.subscriptions.indexOf(subscription);
+            this.subscriptions.splice(subIndex, 1);
+            return this.send({
+                type: 'unsubscribe',
+                requestId: subscription.requestId
+            });
+        }
+    }, {
+        key: '_sendPendingMessages',
+        value: function _sendPendingMessages() {
+            var _iteratorNormalCompletion2 = true;
+            var _didIteratorError2 = false;
+            var _iteratorError2 = undefined;
+
+            try {
+                for (var _iterator2 = this.pendingSendActions[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
+                    var action = _step2.value;
+
+                    this._sendDirectly(action.message);
+                    action.resolve();
+                }
+            } catch (err) {
+                _didIteratorError2 = true;
+                _iteratorError2 = err;
+            } finally {
+                try {
+                    if (!_iteratorNormalCompletion2 && _iterator2.return) {
+                        _iterator2.return();
+                    }
+                } finally {
+                    if (_didIteratorError2) {
+                        throw _iteratorError2;
+                    }
+                }
+            }
+
+            this.pendingSendActions = [];
+        }
+    }, {
         key: '_sendDirectly',
@@ -231,2 +309,9 @@ value: function _sendDirectly(msg) {
         }
+    }, {
+        key: 'pendingSendMessages',
+        get: function get$$1() {
+            return this.pendingSendActions.map(function (a) {
+                return a.message;
+            });
+        }
     }]);
@@ -237,2 +322,3 @@ return Socket;
 exports.Socket = Socket;
+exports.Subscription = Subscription;
 
@@ -239,0 +325,0 @@ Object.defineProperty(exports, '__esModule', { value: true });

package.json

 {
   "name": "spine-high-templar",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
@@ -5,0 +5,0 @@ "author": "Jasper Stam <[e-mail]>",

README.md

@@ -5,3 +5,4 @@ # spine-high-templar
 [![codecov](https://codecov.io/gh/CodeYellowBV/spine-high-templar/branch/master/graph/badge.svg)](https://codecov.io/gh/CodeYellowBV/spine-high-templar)
+[![npm version](https://img.shields.io/npm/v/spine-high-templar.svg?style=flat)](https://www.npmjs.com/package/spine-high-templar)
 
 A frontend package which adds websocket and pubSub logic from [high-templar](https://github.com/CodeYellowBV/high-templar) to [mobx-spine](https://github.com/CodeYellowBV/mobx-spine).

No alert changes

Improved metrics

Total package byte prevSize

23778

increased by33.58%

Lines of code

564

increased by39.95%

Number of lines in readme file

8

increased by14.29%

No dependency changes