message_bus 2.2.3 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46de79e771fac3fb31c3edc55b0866842b6dc108df65c5bcbd7d1062568a6279
-  data.tar.gz: 201cb983ab710b1fe487f69105a13f0291873bf94c8a5e16f1749993a22ddc74
+  metadata.gz: 659722c1ea3a6a805dbe81099ee2848a11ab7ebffaf8612d119f5062fd740337
+  data.tar.gz: 4b187421f5fb4bdff177d117b059c05314305729885f5ec520127ad827db5369
 SHA512:
-  metadata.gz: 633808d11a69d4f6e7c8e53f4805c6bff2d5cd5e57b4c38a166af355e8c6cd2e423c6b27cb0f861597cda6b65dedb0c2bf46edfe5b7fada98b79e8f1bed7d38a
-  data.tar.gz: d38cb6e67c791a9e1e3dcaef8764517e47a363fa4045aed35eedff84cdbdf2a7da85bf0e55a2f00c4c877612bf46ce3dbaea430786afb6dd903ae090b4144638
+  metadata.gz: c345409c8c9c1624b079d28ca166b962f9d64bd79159fc085055df8cb760545372732fd5cf509061b55eb0a427e8ffd7018238a7b49c44f27f4e942d575f0504
+  data.tar.gz: d92fb533dea19da315c210f7ac96a1029cf2d1709fee3dd919032f221b557cff9ebb3d2556285e5e0c6018ebc4b227ed178fd8658711c5a9ffacf19aeb47edff

data/.rubocop.yml

@@ -1 +1,9 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+inherit_gem:
+  rubocop-discourse: .rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'examples/**/*'
+
+RSpec:
+  Enabled: false

data/.travis.yml

@@ -1,9 +1,9 @@
 before_install: gem install bundler
 language: ruby
 rvm:
-  - 2.3
   - 2.4
   - 2.5
+  - 2.6
 gemfile:
   - Gemfile
 addons:

data/CHANGELOG

@@ -1,3 +1,42 @@
+09-06-2020
+
+- Version 3.3.1
+
+  - FIX: Disconnect Redis conn when rescuing errors in global subscribe.
+  - FIX: `MessageBus::Backends::Redis#global_subscribe` not closing Redis connections.
+
+15-05-2020
+
+- Version 3.3.0
+
+   - FEATURE: `MessageBus.base_route=` to alter the route that message bus will listen on.
+
+07-05-2020
+
+- Version 3.2.0
+
+   - FIX: compatability with Rails 6.0.3, note: apps without ActionDispatch::Flash may stop working after this upgrade
+   to correct this disable middleware injection with `config.skip_message_bus_middleware = true` and configure middleware by hand with `app.middleware.use(MessageBus::Rack::Middleware)`
+
+28-04-2020
+
+- Version 3.1.0
+
+  - FEATURE: `MessageBus#register_client_message_filter` to register a custom filter so that messages can be inspected and filtered away from clients.
+
+27-04-2020
+
+- Version 3.0.0
+
+  - Drop support for Ruby 2.3
+  - FIX: Don't publish message to intersection of `user_ids` and `group_ids` - instead use the union, this is a behavior change, hence a new major release.
+
+26-03-2020
+
+- Version 2.2.4
+
+  - FEATURE: shouldLongPollCallback optional setting which allows overriding decision about long polling
+
 18-10-2019
 
 - Version 2.2.3

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in message_bus.gemspec
@@ -6,6 +7,7 @@ gemspec
 group :test do
   gem 'minitest'
   gem 'minitest-hooks'
+  gem 'minitest-global_expectations'
   gem 'rake'
   gem 'http_parser.rb'
   gem 'thin'
@@ -18,8 +20,11 @@ group :test, :development do
   gem 'byebug'
 end
 
+group :development do
+  gem 'yard'
+  gem 'rubocop-discourse', require: false
+  gem 'rubocop-rspec', require: false
+end
+
 gem 'rack'
 gem 'concurrent-ruby' # for distributed-cache
-
-gem 'rubocop'
-gem 'yard'

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 

data/README.md

@@ -8,6 +8,8 @@ Since long-polling is implemented using Rack Hijack and Thin::Async, all common
 
 MessageBus is implemented as Rack middleware and can be used by any Rails / Sinatra or pure Rack application.
 
+Read the generated docs: <https://www.rubydoc.info/gems/message_bus>
+
 ## Try it out!
 
 Live chat demo per [examples/chat](https://github.com/SamSaffron/message_bus/tree/master/examples/chat) is at:
@@ -72,32 +74,40 @@ id = MessageBus.last_id("/channel")
 MessageBus.backlog "/channel", id
 ```
 
-```ruby
-# messages can be targetted at particular users or groups
-MessageBus.publish "/channel", "hello", user_ids: [1,2,3], group_ids: [4,5,6]
+### Targetted messages
+
+Messages can be targetted to particular clients by supplying the `client_ids` option when publishing a message.
 
-# messages can be targetted at particular clients (using MessageBus.clientId)
-MessageBus.publish "/channel", "hello", client_ids: ["XXX","YYY"]
+```ruby
+MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"] # (using MessageBus.clientId)
+```
 
-# message bus determines the user ids and groups based on env
+By configuring the `user_id_lookup` and `group_ids_lookup` options with a Proc or Lambda which will be called with a [Rack specification environment](https://github.com/rack/rack/blob/master/SPEC.rdoc#the-environment-), messages can be targetted to particular clients users or groups by supplying either the `user_ids` or `group_ids` options when publishing a message.
 
+```ruby
 MessageBus.configure(user_id_lookup: proc do |env|
   # this lookup occurs on JS-client poolings, so that server can retrieve backlog
   # for the client considering/matching/filtering user_ids set on published messages
   # if user_id is not set on publish time, any user_id returned here will receive the message
-
   # return the user id here
 end)
 
+# Target user_ids when publishing a message
+MessageBus.publish "/channel", "hello", user_ids: [1, 2, 3]
+
 MessageBus.configure(group_ids_lookup: proc do |env|
   # return the group ids the user belongs to
   # can be nil or []
 end)
 
-# example of message bus to set user_ids from an initializer in Rails and Devise:
+# Target group_ids when publishing a message
+MessageBus.publish "/channel", "hello", group_ids: [1, 2, 3]
+
+# example of MessageBus to set user_ids from an initializer in Rails and Devise:
 # config/inializers/message_bus.rb
 MessageBus.user_id_lookup do |env|
   req = Rack::Request.new(env)
+
   if req.session && req.session["warden.user.user.key"] && req.session["warden.user.user.key"][0][0]
     user = User.find(req.session["warden.user.user.key"][0][0])
     user.id
@@ -105,6 +115,36 @@ MessageBus.user_id_lookup do |env|
 end
 ```
 
+If both `user_ids` and `group_ids` options are supplied when publishing a message, the message will be targetted at clients with lookup return values that  matches on either the `user_ids` **or** the `group_ids` options.
+
+```ruby
+MessageBus.publish "/channel", "hello", user_ids: [1, 2, 3], group_ids: [1, 2, 3]
+```
+
+If the `client_ids` option is supplied with either the `user_ids` or `group_ids` options when publising a message, the `client_ids` option will be applied unconditionally and messages will be filtered further using `user_id` or `group_id` clauses.
+
+```ruby
+MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"], user_ids: [1, 2, 3], group_ids: [1, 2, 3]
+```
+
+Passing `nil` or `[]` to either `client_ids`, `user_ids` or `group_ids` is equivalent to allowing all values on each option.
+
+### Filtering Client Messages
+
+Custom client message filters can be registered via `MessageBus#register_client_message_filter`. This can be useful for filtering away messages from the client based on the message's payload.
+
+For example, ensuring that only messages seen by the server in the last 20 seconds are published to the client:
+
+```
+MessageBus.register_client_message_filter('/test') do |message|
+  (Time.now.to_i - message.data[:published_at]) <= 20
+end
+
+MessageBus.publish('/test/5', { data: "somedata", published_at: Time.now.to_i })
+```
+
+### Error handling
+
 ```ruby
 MessageBus.configure(on_middleware_error: proc do |env, e|
    # If you wish to add special handling based on error
@@ -278,7 +318,8 @@ backgroundCallbackInterval|60000|Interval to poll when long polling is disabled
 minPollInterval|100|When polling requests succeed, this is the minimum amount of time to wait before making the next request.
 maxPollInterval|180000|If request to the server start failing, MessageBus will backoff, this is the upper limit of the backoff.
 alwaysLongPoll|false|For debugging you may want to disable the "is browser in background" check and always long-poll
-baseUrl|/|If message bus is mounted at a sub-path or different domain, you may configure it to perform requests there
+shouldLongPollCallback|undefined|A callback returning true or false that determines if we should long-poll or not, if unset ignore and simply depend on window visibility.
+baseUrl|/|If message bus is mounted at a sub-path or different domain, you may configure it to perform requests there.  See `MessageBus.base_route=` on how to configure the MessageBus server to listen on a sub-path.
 ajax|$.ajax falling back to 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. You may override this option with a function that implements an ajax request by some other means
 headers|{}|Extra headers to be include with requests. Properties and values of object must be valid values for HTTP Headers, i.e. no spaces or control characters.
 minHiddenPollInterval|1500|Time to wait between poll requests performed by background or hidden tabs and windows, shared state via localStorage
@@ -300,8 +341,6 @@ enableChunkedEncoding|true|Allows streaming of message bus data over the HTTP co
 
 `MessageBus.status()` : Returns status (started, paused, stopped)
 
-`MessageBus.noConflict()` : Removes MessageBus from the global namespace by replacing it with whatever was present before MessageBus was loaded. Returns a reference to the MessageBus object.
-
 `MessageBus.diagnostics()` : Returns a log that may be used for diagnostics on the status of message bus.
 
 #### Ruby
@@ -561,6 +600,18 @@ MessageBus.configure(on_middleware_error: proc do |env, e|
 end)
 ```
 
+### Adding extra response headers
+
+In e.g. `config/initializers/message_bus.rb`:
+
+```ruby
+MessageBus.extra_response_headers_lookup do |env|
+  [
+      ["Access-Control-Allow-Origin", "http://example.com:3000"],
+  ]
+end
+```
+
 ## How it works
 
 MessageBus provides durable messaging following the publish-subscribe (pubsub) pattern to subscribers who track their own subscriptions. Durability is by virtue of the persistence of messages in backlogs stored in the selected backend implementation (Redis, Postgres, etc) which can be queried up until a configurable expiry. Subscribers must keep track of the ID of the last message they processed, and request only more-recent messages in subsequent connections.

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'rake/testtask'
 require 'bundler'
@@ -91,3 +92,7 @@ end
 
 desc "Run all tests, link checks and confirms documentation compiles without error"
 task default: [:spec, :rubocop, :test_doc]
+
+Rake::Task['release'].enhance do
+  sh "npm publish"
+end

data/assets/message-bus.js

@@ -1,55 +1,52 @@
 /*jshint bitwise: false*/
-(function(global, document, undefined) {
+
+(function (root, factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as an anonymous module.
+    define([], function (b) {
+      // Also create a global in case some scripts
+      // that are loaded still are looking for
+      // a global even when an AMD loader is in use.
+      return (root.MessageBus = factory());
+    });
+  } else {
+    // Browser globals
+    root.MessageBus = factory();
+  }
+}(typeof self !== 'undefined' ? self : this, function () {
   "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 delayPollTimeout;
-
-  var ajaxInProgress = false;
-
-  uniqueId = function() {
+  var uniqueId = function() {
     return "xxxxxxxxxxxx4xxxyxxxxxxxxxxxxxxx".replace(/[xy]/g, function(c) {
-      var r, v;
-      r = (Math.random() * 16) | 0;
-      v = c === "x" ? r : (r & 0x3) | 0x8;
+      var r = (Math.random() * 16) | 0;
+      var v = c === "x" ? r : (r & 0x3) | 0x8;
       return v.toString(16);
     });
   };
 
-  clientId = uniqueId();
-  responseCallbacks = {};
-  callbacks = [];
-  queue = [];
-  interval = null;
-  failCount = 0;
-  baseUrl = "/";
-  paused = false;
-  later = [];
-  chunkedBackoff = 0;
-  jQuery = global.jQuery;
-  var hiddenProperty;
-
-  (function() {
+  var me;
+  var delayPollTimeout;
+  var ajaxInProgress = false;
+  var started = false;
+  var clientId = uniqueId();
+  var callbacks = [];
+  var queue = [];
+  var interval = null;
+  var failCount = 0;
+  var baseUrl = "/";
+  var paused = false;
+  var later = [];
+  var chunkedBackoff = 0;
+  var stopped;
+  var pollTimeout = null;
+  var totalAjaxFailures = 0;
+  var totalAjaxCalls = 0;
+  var lastAjax;
+
+  var isHidden = (function() {
     var prefixes = ["", "webkit", "ms", "moz"];
+    var hiddenProperty;
     for (var i = 0; i < prefixes.length; i++) {
       var prefix = prefixes[i];
       var check = prefix + (prefix === "" ? "hidden" : "Hidden");
@@ -57,15 +54,15 @@
         hiddenProperty = check;
       }
     }
-  })();
 
-  var isHidden = function() {
-    if (hiddenProperty !== undefined) {
-      return document[hiddenProperty];
-    } else {
-      return !document.hasFocus;
-    }
-  };
+    return function() {
+      if (hiddenProperty !== undefined) {
+        return document[hiddenProperty];
+      } else {
+        return !document.hasFocus;
+      }
+    };
+  })();
 
   var hasLocalStorage = (function() {
     try {
@@ -98,21 +95,19 @@
     return me.enableChunkedEncoding && hasonprogress;
   };
 
-  shouldLongPoll = function() {
-    return me.alwaysLongPoll || !isHidden();
+  var shouldLongPoll = function() {
+    return (
+      me.alwaysLongPoll ||
+      (me.shouldLongPollCallback ? me.shouldLongPollCallback() : !isHidden())
+    );
   };
 
-  var totalAjaxFailures = 0;
-  var totalAjaxCalls = 0;
-  var lastAjax;
-
   var processMessages = function(messages) {
     var gotData = false;
-    if (!messages) return false; // server unexpectedly closed connection
+    if ((!messages) || (messages.length === 0)) { return false; }
 
     for (var i = 0; i < messages.length; i++) {
       var message = messages[i];
-      gotData = true;
       for (var j = 0; j < callbacks.length; j++) {
         var callback = callbacks[j];
         if (callback.channel === message.channel) {
@@ -138,7 +133,7 @@
       }
     }
 
-    return gotData;
+    return true;
   };
 
   var reqSuccess = function(messages) {
@@ -155,7 +150,7 @@
     return false;
   };
 
-  longPoller = function(poll, data) {
+  var longPoller = function(poll, data) {
     if (ajaxInProgress) {
       // never allow concurrent ajax reqs
       return;
@@ -177,9 +172,7 @@
       chunked = false;
     }
 
-    var headers = {
-      "X-SILENCE-LOGGER": "true"
-    };
+    var headers = { "X-SILENCE-LOGGER": "true" };
     for (var name in me.headers) {
       headers[name] = me.headers[name];
     }
@@ -377,13 +370,10 @@
     callbacks: callbacks,
     clientId: clientId,
     alwaysLongPoll: false,
+    shouldLongPollCallback: undefined,
     baseUrl: baseUrl,
     headers: {},
-    ajax: jQuery && jQuery.ajax,
-    noConflict: function() {
-      global.MessageBus = global.MessageBus.previousMessageBus;
-      return this;
-    },
+    ajax: typeof jQuery !== "undefined" && jQuery.ajax,
     diagnostics: function() {
       console.log("Stopped: " + stopped + " Started: " + started);
       console.log("Current callbacks");
@@ -425,15 +415,11 @@
 
     // Start polling
     start: function() {
-      var poll;
-
       if (started) return;
       started = true;
       stopped = false;
 
-      poll = function() {
-        var data;
-
+      var poll = function() {
         if (stopped) {
           return;
         }
@@ -448,7 +434,7 @@
           return;
         }
 
-        data = {};
+        var data = {};
         for (var i = 0; i < callbacks.length; i++) {
           data[callbacks[i].channel] = callbacks[i].last_id;
         }
@@ -462,7 +448,7 @@
 
       // monitor visibility, issue a new long poll when the page shows
       if (document.addEventListener && "hidden" in document) {
-        me.visibilityEvent = global.document.addEventListener(
+        me.visibilityEvent = document.addEventListener(
           "visibilitychange",
           function() {
             if (!document.hidden && !me.longPoll && pollTimeout) {
@@ -528,7 +514,7 @@
       // TODO allow for globbing in the middle of a channel name
       // like /something/*/something
       // at the moment we only support globbing /something/*
-      var glob;
+      var glob = false;
       if (channel.indexOf("*", channel.length - 1) !== -1) {
         channel = channel.substr(0, channel.length - 1);
         glob = true;
@@ -563,5 +549,5 @@
       return removed;
     }
   };
-  global.MessageBus = me;
-})(window, document);
+  return me;
+}));