message_bus 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6aa05eed76182bd5fe219675994c62e4bbab64a4
-  data.tar.gz: cbc5bb1dee813ae31140818862684fb000640e0d
+SHA256:
+  metadata.gz: d2bee95bc6938bb37f780cf48bccd6481f2bca144c6672acac69e6d3e1ef176b
+  data.tar.gz: 387450399296441956030b46054a48b2f996c02e51eeb32e5bc181fa03d8b6d8
 SHA512:
-  metadata.gz: 74a3cf289846f5d2f69562655ca2da052e62f9c069be0e4ecc6621031511da9595f35992130266e622ea707fa808b2e80ba2a7af3919067de9fec4c165c4e026
-  data.tar.gz: 67f93e82846a5ca0ead95bd1cc3aa04de4ef284ba9142d2b6127c8631bdcfb422be74a665129f150fe0c70615d52ea1341737e0b0f2ce87db6c7daae2f587161
+  metadata.gz: 2a87dd71aba2740acd7dd326b9f9d2d8cf3b51c33f2c498bbb128346ed52fc2483f52b9135d5320c8ce3d025d2cb7357260d78b8d5963600256cb62704bfb173
+  data.tar.gz: db86f4a8d2b3949ced575612eac992d9d878abe836ee818340ef2045486a0debc816600db95ffb19a497acf3371e673473fe7bcf5d54f48cbd7b1505db8bc791

data/CHANGELOG

@@ -1,3 +1,11 @@
+09-01-2018
+
+- Version 2.1.2
+
+- FEATURE: minHiddenPollInterval set to 1500ms out of the box, ensures we never do hidden tab
+   polls at a high rate if tons of tabs are open
+- FEATURE: added random 500ms to delayed polls to increase tab entropy
+
 18-12-2017
 
 - Version 2.1.1

data/README.md

@@ -239,6 +239,9 @@ alwaysLongPoll|false|For debugging you may want to disable the "is browser in ba
 baseUrl|/|If message bus is mounted in a subdirectory of different domain, you may configure it to perform requests there
 ajax|$.ajax or XMLHttpRequest|MessageBus will first attempt to use jQuery and then fallback to a plain XMLHttpRequest version that's contained in the `message-bus-ajax.js` file. `message-bus-ajax.js` must be loaded after `message-bus.js` for it to be used.
 headers|{}|Extra headers to be include with request.  Properties and values of object must be valid values for HTTP Headers, i.e. no spaces and control characters.
+minHiddenPollInterval|1500|Time to wait between poll requests performed by background or hidden tabs and windows, shared state via localStorage
+enableChunkedEncoding|true|Allow streaming of message bus data over the HTTP channel
+
 **API**:
 
 `MessageBus.diagnostics()` : Returns a log that may be used for diagnostics on the status of message bus

data/assets/message-bus.js

@@ -48,6 +48,32 @@
     }
   };
 
+  var hasLocalStorage = (function() {
+    try {
+      localStorage.setItem("mbTestLocalStorage", Date.now());
+      localStorage.removeItem("mbTestLocalStorage");
+      return true;
+    } catch(e) {
+      return false;
+    }
+  })();
+
+  var updateLastAjax = function() {
+    if (hasLocalStorage) {
+      localStorage.setItem("__mbLastAjax", Date.now());
+    }
+  }
+
+  var hiddenTabShouldWait = function() {
+    if (hasLocalStorage && isHidden()) {
+      var lastAjaxCall = parseInt(localStorage.getItem("__mbLastAjax"), 10);
+      var deltaAjax = Date.now() - lastAjaxCall;
+
+      return deltaAjax >= 0 && deltaAjax < me.minHiddenPollInterval;
+    }
+    return false;
+  }
+
   var hasonprogress = (new XMLHttpRequest()).onprogress === null;
   var allowChunked = function(){
     return me.enableChunkedEncoding && hasonprogress;
@@ -182,6 +208,9 @@
     if (!me.ajax){
       throw new Error("Either jQuery or the ajax adapter must be loaded");
     }
+
+    updateLastAjax();
+
     var req = me.ajax({
       url: me.baseUrl + "message-bus/" + me.clientId + "/poll" + (!longPoll ? "?dlp=t" : ""),
       data: data,
@@ -260,7 +289,10 @@
           }
         }
 
-        pollTimeout = setTimeout(function(){pollTimeout=null; poll();}, interval);
+        pollTimeout = setTimeout(function(){
+          pollTimeout = null;
+          poll();
+        }, interval);
         me.longPoll = null;
       }
     });
@@ -269,6 +301,8 @@
   };
 
   me = {
+    /* shared between all tabs */
+    minHiddenPollInterval: 1500,
     enableChunkedEncoding: true,
     enableLongPolling: true,
     callbackInterval: 15000,
@@ -322,9 +356,11 @@
           return;
         }
 
-        if (callbacks.length === 0) {
+        if (callbacks.length === 0 || hiddenTabShouldWait()) {
           if(!delayPollTimeout) {
-            delayPollTimeout = setTimeout(function(){ delayPollTimeout = null; poll();}, 500);
+            delayPollTimeout = setTimeout(function() {
+              delayPollTimeout = null; poll();
+            }, parseInt(500 + Math.random() * 500));
           }
           return;
         }

data/lib/message_bus/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MessageBus
-  VERSION = "2.1.1"
+  VERSION = "2.1.2"
 end

data/spec/assets/message-bus.spec.js

@@ -40,11 +40,11 @@ describe("Messagebus", function() {
       expect(spec.MockedXMLHttpRequest.prototype.send).toHaveBeenCalled()
       expect(onMessageSpy).not.toHaveBeenCalled()
       MessageBus.resume()
-    }, 510) // greater than delayPollTimeout of 500
+    }, 1010) // greater than delayPollTimeout of 500 + 500 random
     setTimeout(function(){
       expect(onMessageSpy).toHaveBeenCalled()
       done()
-    }, 550) // greater than first timeout above
+    }, 1050) // greater than first timeout above
   });
 
   it('can unsubscribe from callbacks', function(done){

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: ''