message_bus 0.9.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f439c4637f8f2b6271244a4ed2e3ab2637ff6c79
-  data.tar.gz: a35a858e95c8b3b218ba29e0773296420bf9f69b
+  metadata.gz: 540d941673f27bbce348815bdc0e76b5dda46f54
+  data.tar.gz: 7497c9ff05c2c0752f40dd4e11fe892fecaef57e
 SHA512:
-  metadata.gz: 9ad5513fdaaadb637035aab15cc4d8edf76e5c8bee0774cdf90a90e3f5eb725abb987de5a4072213ba447b77f600113755330772d7169c75104e9bba816a8f6e
-  data.tar.gz: 72e05629c7e15d6d19cd3bf78238a3def6cb96007668ca4031e930f0b6fbb66f19524c55028ce9fdbc16aa9a3bb8e47ded98434e70ba60445731e5e599fe82b1
+  metadata.gz: 3d139e29977062c4072488a6b3d49dbf3795aa7d0a2ffedb51d80f6b7f5a0b73d432a7d2d467a1a0e70fc57accd1d8214cb5245e8864c7eadb846d298257c1f7
+  data.tar.gz: 29913ebc677903bc51f89e94b01ae1c357b349ba154615131dfd682ee26007bcf59f7cf2bca22fae54ec766822913b4c5391118397fb8f5dec8e4bdf433f32e0

data/CHANGELOG

@@ -1,3 +1,8 @@
+22-09-2014
+- Version 1.0.0
+- Feature: add backgroundCallbackInterval - interval to send polls when page is in the background
+- Feature: issue a long poll as soon as page moves into the foreground
+
 11-08-2014
 - Version 0.9.5
 - Fix: release db connection a lot earlier for long polling (rails defer closes)

data/assets/message-bus.js

@@ -29,55 +29,6 @@ window.MessageBus = (function() {
   failCount = 0;
   baseUrl = "/";
 
-  /* TODO: The plan is to force a long poll as soon as page becomes visible
-  // MIT based off https://github.com/mathiasbynens/jquery-visibility/blob/master/jquery-visibility.js
-  initVisibilityTracking =  function(window, document, $, undefined) {
-    var prefix;
-    var property;
-    // In Opera, `'onfocusin' in document == true`, hence the extra `hasFocus` check to detect IE-like behavior
-    var eventName = 'onfocusin' in document && 'hasFocus' in document ? 'focusin focusout' : 'focus blur';
-    var prefixes = ['webkit', 'o', 'ms', 'moz', ''];
-    var $event = $.event;
-
-    while ((prefix = prefixes.pop()) !== undefined) {
-      property = (prefix ? prefix + 'H': 'h') + 'idden';
-      var supportsVisibility = typeof document[property] === 'boolean';
-      if (supportsVisibility) {
-        eventName = prefix + 'visibilitychange';
-        break;
-      }
-    }
-
-    $(/blur$/.test(eventName) ? window : document).on(eventName, function(event) {
-      var type = event.type;
-      var originalEvent = event.originalEvent;
-
-      // Avoid errors from triggered native events for which `originalEvent` is
-      // not available.
-      if (!originalEvent) {
-              return;
-      }
-
-      var toElement = originalEvent.toElement;
-
-      // If it's a `{focusin,focusout}` event (IE), `fromElement` and `toElement`
-      // should both be `null` or `undefined`; else, the page visibility hasn't
-      // changed, but the user just clicked somewhere in the doc. In IE9, we need
-      // to check the `relatedTarget` property instead.
-      if (
-              !/^focus./.test(type) || (
-                      toElement === undefined &&
-                      originalEvent.fromElement === undefined &&
-                      originalEvent.relatedTarget === undefined
-              )
-      ) {
-          visibilityChanged(property && document[property] || /^(?:blur|focusout)$/.test(type) ? 'hide' : 'show');
-      }
-    });
-
-  };
-  */
-
   var hiddenProperty;
 
   $.each(["","webkit","ms","moz","ms"], function(index, prefix){
@@ -108,8 +59,9 @@ window.MessageBus = (function() {
     var aborted = false;
     lastAjax = new Date();
     totalAjaxCalls += 1;
-
-    return $.ajax(me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""), {
+    
+    return $.ajax({
+      url: me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""),
       data: data,
       cache: false,
       dataType: 'json',
@@ -160,9 +112,7 @@ window.MessageBus = (function() {
             if (failCount > 2) {
               interval = interval * failCount;
             } else if (!shouldLongPoll()) {
-              // slowing down stuff a lot when hidden
-              // we will need to fine tune this
-              interval = interval * 4;
+              interval = me.backgroundCallbackInterval;
             }
             if (interval > me.maxPollInterval) {
               interval = me.maxPollInterval;
@@ -180,7 +130,7 @@ window.MessageBus = (function() {
           }
         }
 
-        pollTimeout = setTimeout(poll, interval);
+        pollTimeout = setTimeout(function(){pollTimeout=null; poll();}, interval);
         me.longPoll = null;
       }
     });
@@ -189,6 +139,7 @@ window.MessageBus = (function() {
   me = {
     enableLongPolling: true,
     callbackInterval: 15000,
+    backgroundCallbackInterval: 60000,
     maxPollInterval: 3 * 60 * 1000,
     callbacks: callbacks,
     clientId: clientId,
@@ -210,7 +161,7 @@ window.MessageBus = (function() {
 
     // Start polling
     start: function(opts) {
-      var poll;
+      var poll, delayPollTimeout;
 
       if (started) return;
       started = true;
@@ -226,7 +177,9 @@ window.MessageBus = (function() {
         }
 
         if (callbacks.length === 0) {
-          setTimeout(poll, 500);
+          if(!delayPollTimeout) {
+            delayPollTimeout = setTimeout(function(){ delayPollTimeout = null; poll();}, 500);
+          }
           return;
         }
 
@@ -234,8 +187,22 @@ window.MessageBus = (function() {
         $.each(callbacks, function(_,callback) {
           data[callback.channel] = callback.last_id;
         });
+
         me.longPoll = longPoller(poll,data);
       };
+
+
+      // monitor visibility, issue a new long poll when the page shows
+      if(document.addEventListener && 'hidden' in document){
+        me.visibilityEvent = document.addEventListener('visibilitychange', function(){
+          if(!document.hidden && !me.longPoll && pollTimeout){
+            clearTimeout(pollTimeout);
+            pollTimeout = null;
+            poll();
+          }
+        });
+      }
+
       poll();
     },
 

data/lib/message_bus.rb

@@ -101,7 +101,7 @@ module MessageBus::Implementation
   end
 
   def long_polling_interval
-    @long_polling_interval || 30 * 1000
+    @long_polling_interval || 25 * 1000
   end
 
   def off

data/lib/message_bus/version.rb

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "0.9.6"
+  VERSION = "1.0.0"
 end

data/vendor/assets/javascripts/message-bus.js

@@ -29,55 +29,6 @@ window.MessageBus = (function() {
   failCount = 0;
   baseUrl = "/";
 
-  /* TODO: The plan is to force a long poll as soon as page becomes visible
-  // MIT based off https://github.com/mathiasbynens/jquery-visibility/blob/master/jquery-visibility.js
-  initVisibilityTracking =  function(window, document, $, undefined) {
-    var prefix;
-    var property;
-    // In Opera, `'onfocusin' in document == true`, hence the extra `hasFocus` check to detect IE-like behavior
-    var eventName = 'onfocusin' in document && 'hasFocus' in document ? 'focusin focusout' : 'focus blur';
-    var prefixes = ['webkit', 'o', 'ms', 'moz', ''];
-    var $event = $.event;
-
-    while ((prefix = prefixes.pop()) !== undefined) {
-      property = (prefix ? prefix + 'H': 'h') + 'idden';
-      var supportsVisibility = typeof document[property] === 'boolean';
-      if (supportsVisibility) {
-        eventName = prefix + 'visibilitychange';
-        break;
-      }
-    }
-
-    $(/blur$/.test(eventName) ? window : document).on(eventName, function(event) {
-      var type = event.type;
-      var originalEvent = event.originalEvent;
-
-      // Avoid errors from triggered native events for which `originalEvent` is
-      // not available.
-      if (!originalEvent) {
-              return;
-      }
-
-      var toElement = originalEvent.toElement;
-
-      // If it's a `{focusin,focusout}` event (IE), `fromElement` and `toElement`
-      // should both be `null` or `undefined`; else, the page visibility hasn't
-      // changed, but the user just clicked somewhere in the doc. In IE9, we need
-      // to check the `relatedTarget` property instead.
-      if (
-              !/^focus./.test(type) || (
-                      toElement === undefined &&
-                      originalEvent.fromElement === undefined &&
-                      originalEvent.relatedTarget === undefined
-              )
-      ) {
-          visibilityChanged(property && document[property] || /^(?:blur|focusout)$/.test(type) ? 'hide' : 'show');
-      }
-    });
-
-  };
-  */
-
   var hiddenProperty;
 
   $.each(["","webkit","ms","moz","ms"], function(index, prefix){
@@ -108,8 +59,9 @@ window.MessageBus = (function() {
     var aborted = false;
     lastAjax = new Date();
     totalAjaxCalls += 1;
-
-    return $.ajax(me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""), {
+    
+    return $.ajax({
+      url: me.baseUrl + "message-bus/" + me.clientId + "/poll?" + (!shouldLongPoll() || !me.enableLongPolling ? "dlp=t" : ""),
       data: data,
       cache: false,
       dataType: 'json',
@@ -160,9 +112,7 @@ window.MessageBus = (function() {
             if (failCount > 2) {
               interval = interval * failCount;
             } else if (!shouldLongPoll()) {
-              // slowing down stuff a lot when hidden
-              // we will need to fine tune this
-              interval = interval * 4;
+              interval = me.backgroundCallbackInterval;
             }
             if (interval > me.maxPollInterval) {
               interval = me.maxPollInterval;
@@ -180,7 +130,7 @@ window.MessageBus = (function() {
           }
         }
 
-        pollTimeout = setTimeout(poll, interval);
+        pollTimeout = setTimeout(function(){pollTimeout=null; poll();}, interval);
         me.longPoll = null;
       }
     });
@@ -189,6 +139,7 @@ window.MessageBus = (function() {
   me = {
     enableLongPolling: true,
     callbackInterval: 15000,
+    backgroundCallbackInterval: 60000,
     maxPollInterval: 3 * 60 * 1000,
     callbacks: callbacks,
     clientId: clientId,
@@ -210,7 +161,7 @@ window.MessageBus = (function() {
 
     // Start polling
     start: function(opts) {
-      var poll;
+      var poll, delayPollTimeout;
 
       if (started) return;
       started = true;
@@ -226,7 +177,9 @@ window.MessageBus = (function() {
         }
 
         if (callbacks.length === 0) {
-          setTimeout(poll, 500);
+          if(!delayPollTimeout) {
+            delayPollTimeout = setTimeout(function(){ delayPollTimeout = null; poll();}, 500);
+          }
           return;
         }
 
@@ -234,8 +187,22 @@ window.MessageBus = (function() {
         $.each(callbacks, function(_,callback) {
           data[callback.channel] = callback.last_id;
         });
+
         me.longPoll = longPoller(poll,data);
       };
+
+
+      // monitor visibility, issue a new long poll when the page shows
+      if(document.addEventListener && 'hidden' in document){
+        me.visibilityEvent = document.addEventListener('visibilitychange', function(){
+          if(!document.hidden && !me.longPoll && pollTimeout){
+            clearTimeout(pollTimeout);
+            pollTimeout = null;
+            poll();
+          }
+        });
+      }
+
       poll();
     },
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack