message_bus 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096c5bb55b64076beef0b89313a6424fb0ded08cb2988f0b79cc44dfc58cc4dd'
-  data.tar.gz: aceed48ea3dbc555fa4f9896f8cdb474fa543f20469659bc8bf05bcbdd8e20e2
+  metadata.gz: 79e90ec066435ef35d00e9184481acdb2a03dbecb41b629dd18584c8a824ae4b
+  data.tar.gz: 8d571923665a26165255e06a4a217ad660b39caad101ae3d3755473d740fd3c1
 SHA512:
-  metadata.gz: d906c4e50068024c76ea0019f9d376869fba3ea67d52cfae4a49d251f270b442723a3924b78eccdaddcc68963f0c040e91a37d92c9b396f2bf5340b213338328
-  data.tar.gz: c7ffa6dfd797b20c44e3e305f5de06c04a10a39fc708152c5479b50ca54baf3ebc2b3ff19a08f33949f31390370fded3ea934f39f8c10a0ac22f7a18ac8a341f
+  metadata.gz: 4ad3699e51995f038ba76197eed72f9d494f29a3b5ab09be389277cc0b62fe2848eb1d96f090563f75393480768490798c012a16f279f19bbded8b7ea78667d7
+  data.tar.gz: 2e8772dc961eefaa746d3569ff57ceecea034c406a4749177c9ba1139ac6575891d8448c00cd7c4f314acd72794cf886ecd5066beb5925a5f7a3b0520270979c

data/CHANGELOG

@@ -1,3 +1,11 @@
+Unreleased
+
+- Version 2.2.1
+
+  - FEATURE: Support rate limiting by server, 429 status codes are respected and we hold off as needed
+
+  - FIX: In the redis backend make the `is_readonly?` method compatible with the redis gem both pre and post v4.0 when the `client` attribute was removed
+
 30-04-2019
 
 - Version 2.2.1

data/assets/message-bus.js

@@ -1,20 +1,36 @@
 /*jshint bitwise: false*/
 (function(global, document, undefined) {
-  'use strict';
+  "use strict";
   var previousMessageBus = global.MessageBus;
 
   // http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript
-  var callbacks, clientId, failCount, shouldLongPoll, queue, responseCallbacks, uniqueId, baseUrl;
-  var me, started, stopped, longPoller, pollTimeout, paused, later, jQuery, interval, chunkedBackoff;
+  var callbacks,
+    clientId,
+    failCount,
+    shouldLongPoll,
+    queue,
+    responseCallbacks,
+    uniqueId,
+    baseUrl;
+  var me,
+    started,
+    stopped,
+    longPoller,
+    pollTimeout,
+    paused,
+    later,
+    jQuery,
+    interval,
+    chunkedBackoff;
   var delayPollTimeout;
 
   var ajaxInProgress = false;
 
   uniqueId = function() {
-    return 'xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
+    return "xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx".replace(/[xy]/g, function(c) {
       var r, v;
-      r = Math.random() * 16 | 0;
-      v = c === 'x' ? r : (r & 0x3 | 0x8);
+      r = (Math.random() * 16) | 0;
+      v = c === "x" ? r : (r & 0x3) | 0x8;
       return v.toString(16);
     });
   };
@@ -32,19 +48,19 @@
   jQuery = global.jQuery;
   var hiddenProperty;
 
-  (function(){
-    var prefixes = ["","webkit","ms","moz"];
-    for(var i=0; i<prefixes.length; i++) {
+  (function() {
+    var prefixes = ["", "webkit", "ms", "moz"];
+    for (var i = 0; i < prefixes.length; i++) {
       var prefix = prefixes[i];
       var check = prefix + (prefix === "" ? "hidden" : "Hidden");
-      if(document[check] !== undefined ){
+      if (document[check] !== undefined) {
         hiddenProperty = check;
       }
     }
   })();
 
   var isHidden = function() {
-    if (hiddenProperty !== undefined){
+    if (hiddenProperty !== undefined) {
       return document[hiddenProperty];
     } else {
       return !document.hasFocus;
@@ -56,7 +72,7 @@
       localStorage.setItem("mbTestLocalStorage", Date.now());
       localStorage.removeItem("mbTestLocalStorage");
       return true;
-    } catch(e) {
+    } catch (e) {
       return false;
     }
   })();
@@ -65,7 +81,7 @@
     if (hasLocalStorage) {
       localStorage.setItem("__mbLastAjax", Date.now());
     }
-  }
+  };
 
   var hiddenTabShouldWait = function() {
     if (hasLocalStorage && isHidden()) {
@@ -75,10 +91,10 @@
       return deltaAjax >= 0 && deltaAjax < me.minHiddenPollInterval;
     }
     return false;
-  }
+  };
 
-  var hasonprogress = (new XMLHttpRequest()).onprogress === null;
-  var allowChunked = function(){
+  var hasonprogress = new XMLHttpRequest().onprogress === null;
+  var allowChunked = function() {
     return me.enableChunkedEncoding && hasonprogress;
   };
 
@@ -94,19 +110,23 @@
     var gotData = false;
     if (!messages) return false; // server unexpectedly closed connection
 
-    for (var i=0; i<messages.length; i++) {
+    for (var i = 0; i < messages.length; i++) {
       var message = messages[i];
       gotData = true;
-      for (var j=0; j<callbacks.length; j++) {
+      for (var j = 0; j < callbacks.length; j++) {
         var callback = callbacks[j];
         if (callback.channel === message.channel) {
           callback.last_id = message.message_id;
           try {
             callback.func(message.data, message.global_id, message.message_id);
-          }
-          catch(e){
-            if(console.log) {
-              console.log("MESSAGE BUS FAIL: callback " + callback.channel +  " caused exception " + e.message);
+          } catch (e) {
+            if (console.log) {
+              console.log(
+                "MESSAGE BUS FAIL: callback " +
+                  callback.channel +
+                  " caused exception " +
+                  e.stack
+              );
             }
           }
         }
@@ -125,7 +145,7 @@
     failCount = 0;
     if (paused) {
       if (messages) {
-        for (var i=0; i<messages.length; i++) {
+        for (var i = 0; i < messages.length; i++) {
           later.push(messages[i]);
         }
       }
@@ -136,7 +156,6 @@
   };
 
   longPoller = function(poll, data) {
-
     if (ajaxInProgress) {
       // never allow concurrent ajax reqs
       return;
@@ -144,6 +163,9 @@
 
     var gotData = false;
     var aborted = false;
+    var rateLimited = false;
+    var rateLimitedSeconds;
+
     lastAjax = new Date();
     totalAjaxCalls += 1;
     data.__seq = totalAjaxCalls;
@@ -156,20 +178,19 @@
     }
 
     var headers = {
-      'X-SILENCE-LOGGER': 'true'
+      "X-SILENCE-LOGGER": "true"
     };
-    for (var name in me.headers){
+    for (var name in me.headers) {
       headers[name] = me.headers[name];
     }
 
-    if (!chunked){
-      headers["Dont-Chunk"] = 'true';
+    if (!chunked) {
+      headers["Dont-Chunk"] = "true";
     }
 
     var dataType = chunked ? "text" : "json";
 
     var handle_progress = function(payload, position) {
-
       var separator = "\r\n|\r\n";
       var endChunk = payload.indexOf(separator, position);
 
@@ -182,7 +203,7 @@
 
       try {
         reqSuccess(JSON.parse(chunk));
-      } catch(e) {
+      } catch (e) {
         if (console.log) {
           console.log("FAILED TO PARSE CHUNKED REPLY");
           console.log(data);
@@ -190,9 +211,9 @@
       }
 
       return handle_progress(payload, endChunk + separator.length);
-    }
+    };
 
-    var disableChunked = function(){
+    var disableChunked = function() {
       if (me.longPoll) {
         me.longPoll.abort();
         chunkedBackoff = 30;
@@ -203,18 +224,21 @@
       var position = 0;
       // if it takes longer than 3000 ms to get first chunk, we have some proxy
       // this is messing with us, so just backoff from using chunked for now
-      var chunkedTimeout = setTimeout(disableChunked,3000);
-      xhr.onprogress = function () {
+      var chunkedTimeout = setTimeout(disableChunked, 3000);
+      xhr.onprogress = function() {
         clearTimeout(chunkedTimeout);
-        if(xhr.getResponseHeader('Content-Type') === 'application/json; charset=utf-8') {
+        if (
+          xhr.getResponseHeader("Content-Type") ===
+          "application/json; charset=utf-8"
+        ) {
           // not chunked we are sending json back
           chunked = false;
           return;
         }
         position = handle_progress(xhr.responseText, position);
-      }
+      };
     };
-    if (!me.ajax){
+    if (!me.ajax) {
       throw new Error("Either jQuery or the ajax adapter must be loaded");
     }
 
@@ -222,12 +246,17 @@
 
     ajaxInProgress = true;
     var req = me.ajax({
-      url: me.baseUrl + "message-bus/" + me.clientId + "/poll" + (!longPoll ? "?dlp=t" : ""),
+      url:
+        me.baseUrl +
+        "message-bus/" +
+        me.clientId +
+        "/poll" +
+        (!longPoll ? "?dlp=t" : ""),
       data: data,
       cache: false,
       async: true,
       dataType: dataType,
-      type: 'POST',
+      type: "POST",
       headers: headers,
       messageBus: {
         chunked: chunked,
@@ -235,15 +264,18 @@
           var position = 0;
           // if it takes longer than 3000 ms to get first chunk, we have some proxy
           // this is messing with us, so just backoff from using chunked for now
-          var chunkedTimeout = setTimeout(disableChunked,3000);
-          return xhr.onprogress = function () {
+          var chunkedTimeout = setTimeout(disableChunked, 3000);
+          return (xhr.onprogress = function() {
             clearTimeout(chunkedTimeout);
-            if(xhr.getResponseHeader('Content-Type') === 'application/json; charset=utf-8') {
+            if (
+              xhr.getResponseHeader("Content-Type") ===
+              "application/json; charset=utf-8"
+            ) {
               chunked = false; // not chunked, we are sending json back
             } else {
               position = handle_progress(xhr.responseText, position);
             }
-          }
+          });
         }
       },
       xhr: function() {
@@ -255,16 +287,27 @@
         return xhr;
       },
       success: function(messages) {
-         if (!chunked) {
-           // we may have requested text so jQuery will not parse
-           if (typeof(messages) === "string") {
-             messages = JSON.parse(messages);
-           }
-           gotData = reqSuccess(messages);
-         }
-       },
+        if (!chunked) {
+          // we may have requested text so jQuery will not parse
+          if (typeof messages === "string") {
+            messages = JSON.parse(messages);
+          }
+          gotData = reqSuccess(messages);
+        }
+      },
       error: function(xhr, textStatus, err) {
-        if(textStatus === "abort") {
+        if (xhr.status === 429) {
+          var tryAfter =
+            parseInt(
+              xhr.getResponseHeader && xhr.getResponseHeader("Retry-After")
+            ) || 0;
+          tryAfter = tryAfter || 0;
+          if (tryAfter < 15) {
+            tryAfter = 15;
+          }
+          rateLimitedSeconds = tryAfter;
+          rateLimited = true;
+        } else if (textStatus === "abort") {
           aborted = true;
         } else {
           failCount += 1;
@@ -272,12 +315,13 @@
         }
       },
       complete: function() {
-
         ajaxInProgress = false;
 
         var interval;
         try {
-          if (gotData || aborted) {
+          if (rateLimited) {
+            interval = Math.max(me.minPollInterval, rateLimitedSeconds * 1000);
+          } else if (gotData || aborted) {
             interval = me.minPollInterval;
           } else {
             interval = me.callbackInterval;
@@ -290,14 +334,14 @@
               interval = me.maxPollInterval;
             }
 
-            interval -= (new Date() - lastAjax);
+            interval -= new Date() - lastAjax;
 
             if (interval < 100) {
               interval = 100;
             }
           }
-        } catch(e) {
-          if(console.log && e.message) {
+        } catch (e) {
+          if (console.log && e.message) {
             console.log("MESSAGE BUS FAIL: " + e.message);
           }
         }
@@ -308,7 +352,7 @@
         }
 
         if (started) {
-          pollTimeout = setTimeout(function(){
+          pollTimeout = setTimeout(function() {
             pollTimeout = null;
             poll();
           }, interval);
@@ -335,17 +379,26 @@
     alwaysLongPoll: false,
     baseUrl: baseUrl,
     headers: {},
-    ajax: (jQuery && jQuery.ajax),
-    noConflict: function(){
+    ajax: jQuery && jQuery.ajax,
+    noConflict: function() {
       global.MessageBus = global.MessageBus.previousMessageBus;
       return this;
     },
-    diagnostics: function(){
+    diagnostics: function() {
       console.log("Stopped: " + stopped + " Started: " + started);
       console.log("Current callbacks");
       console.log(callbacks);
-      console.log("Total ajax calls: " + totalAjaxCalls + " Recent failure count: " + failCount + " Total failures: " + totalAjaxFailures);
-      console.log("Last ajax call: " + (new Date() - lastAjax) / 1000  + " seconds ago") ;
+      console.log(
+        "Total ajax calls: " +
+          totalAjaxCalls +
+          " Recent failure count: " +
+          failCount +
+          " Total failures: " +
+          totalAjaxFailures
+      );
+      console.log(
+        "Last ajax call: " + (new Date() - lastAjax) / 1000 + " seconds ago"
+      );
     },
 
     pause: function() {
@@ -381,12 +434,12 @@
       poll = function() {
         var data;
 
-        if(stopped) {
+        if (stopped) {
           return;
         }
 
         if (callbacks.length === 0 || hiddenTabShouldWait()) {
-          if(!delayPollTimeout) {
+          if (!delayPollTimeout) {
             delayPollTimeout = setTimeout(function() {
               delayPollTimeout = null;
               poll();
@@ -396,7 +449,7 @@
         }
 
         data = {};
-        for (var i=0;i<callbacks.length;i++) {
+        for (var i = 0; i < callbacks.length; i++) {
           data[callbacks[i].channel] = callbacks[i].last_id;
         }
 
@@ -407,30 +460,31 @@
         }
       };
 
-
       // monitor visibility, issue a new long poll when the page shows
-      if(document.addEventListener && 'hidden' in document){
-        me.visibilityEvent = global.document.addEventListener('visibilitychange', function(){
-          if(!document.hidden && !me.longPoll && pollTimeout){
-
-            clearTimeout(pollTimeout);
-            clearTimeout(delayPollTimeout);
+      if (document.addEventListener && "hidden" in document) {
+        me.visibilityEvent = global.document.addEventListener(
+          "visibilitychange",
+          function() {
+            if (!document.hidden && !me.longPoll && pollTimeout) {
+              clearTimeout(pollTimeout);
+              clearTimeout(delayPollTimeout);
 
-            delayPollTimeout = null;
-            pollTimeout = null;
-            poll();
+              delayPollTimeout = null;
+              pollTimeout = null;
+              poll();
+            }
           }
-        });
+        );
       }
 
       poll();
     },
 
-    "status": function() {
+    status: function() {
       if (paused) {
-         return "paused";
+        return "paused";
       } else if (started) {
-         return "started";
+        return "started";
       } else if (stopped) {
         return "stopped";
       } else {
@@ -445,16 +499,15 @@
     // -2 will recieve last message + all new messages
     // -3 will recieve last 2 messages + all new messages
     subscribe: function(channel, func, lastId) {
-
-      if(!started && !stopped){
+      if (!started && !stopped) {
         me.start();
       }
 
-      if (typeof(lastId) !== "number") {
+      if (typeof lastId !== "number") {
         lastId = -1;
       }
 
-      if (typeof(channel) !== "string") {
+      if (typeof channel !== "string") {
         throw "Channel name must be a string!";
       }
 
@@ -483,8 +536,7 @@
 
       var removed = false;
 
-      for (var i=callbacks.length-1; i>=0; i--) {
-
+      for (var i = callbacks.length - 1; i >= 0; i--) {
         var callback = callbacks[i];
         var keep;
 
@@ -494,12 +546,12 @@
           keep = callback.channel !== channel;
         }
 
-        if(!keep && func && callback.func !== func){
+        if (!keep && func && callback.func !== func) {
           keep = true;
         }
 
         if (!keep) {
-          callbacks.splice(i,1);
+          callbacks.splice(i, 1);
           removed = true;
         }
       }

data/lib/message_bus/backends/redis.rb

@@ -433,10 +433,11 @@ LUA
         key = "__mb_is_readonly"
 
         begin
+          # disconnect to force a reconnect when attempting to set the key
           # in case we are not connected to the correct server
           # which can happen when sharing ips
-          pub_redis.client.reconnect
-          pub_redis.client.call([:set, key, '1'])
+          pub_redis.disconnect!
+          pub_redis.set(key, '1')
           false
         rescue ::Redis::CommandError => e
           return true if e.message =~ /^READONLY/

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "2.2.1"
+  VERSION = "2.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack