message_bus 2.2.4 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93e3bc28f1411da6037721acabab32fa504542bb68238afe6671f10bfccfa194
-  data.tar.gz: b25d3013be8f3a0efa180db29de0ac6a55e5ce08ea87f80c912f046b9548c821
+  metadata.gz: 659722c1ea3a6a805dbe81099ee2848a11ab7ebffaf8612d119f5062fd740337
+  data.tar.gz: 4b187421f5fb4bdff177d117b059c05314305729885f5ec520127ad827db5369
 SHA512:
-  metadata.gz: c74493de8f9f2dc5305457696988d7f07dce56642a8796d3757a0e5bf4e14f6e9b011ed8bd9255e0d3dc197c290bbdafedcf47e2519f09ca085ec86f33848508
-  data.tar.gz: e4778edb5d540ef011ad29916dd8e4a374b04fb5dcd57ef80542b9f0b0985f5887609bf67b071455ebd15e59386eb0abc30698d015a4585f66a4d7afd217fc05
+  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,36 @@
+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

data/Gemfile

@@ -20,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/README.md

@@ -74,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
@@ -107,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
@@ -281,7 +319,7 @@ minPollInterval|100|When polling requests succeed, this is the minimum amount of
 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
 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
+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
@@ -303,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

data/Rakefile

@@ -92,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,24 +95,19 @@
     return me.enableChunkedEncoding && hasonprogress;
   };
 
-  shouldLongPoll = function() {
+  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) {
@@ -141,7 +133,7 @@
       }
     }
 
-    return gotData;
+    return true;
   };
 
   var reqSuccess = function(messages) {
@@ -158,7 +150,7 @@
     return false;
   };
 
-  longPoller = function(poll, data) {
+  var longPoller = function(poll, data) {
     if (ajaxInProgress) {
       // never allow concurrent ajax reqs
       return;
@@ -180,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];
     }
@@ -383,11 +373,7 @@
     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");
@@ -429,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;
         }
@@ -452,7 +434,7 @@
           return;
         }
 
-        data = {};
+        var data = {};
         for (var i = 0; i < callbacks.length; i++) {
           data[callbacks[i].channel] = callbacks[i].last_id;
         }
@@ -466,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) {
@@ -532,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;
@@ -567,5 +549,5 @@
       return removed;
     }
   };
-  global.MessageBus = me;
-})(window, document);
+  return me;
+}));

data/lib/message_bus.rb

@@ -149,6 +149,19 @@ module MessageBus::Implementation
     @config[:long_polling_interval] || 25 * 1000
   end
 
+  # @param [String] route Message bus will listen to requests on this route.
+  # @return [void]
+  def base_route=(route)
+    configure(base_route: route.gsub(Regexp.new('\A(?!/)|(?<!/)\Z|//+'), "/"))
+  end
+
+  # @return [String] the route that message bus will respond to. If not
+  #   explicitly set, defaults to "/". Requests to "#{base_route}message-bus/*" will be handled
+  #   by the message bus server.
+  def base_route
+    @config[:base_route] || "/"
+  end
+
   # @return [Boolean] whether the bus is disabled or not
   def off?
     @off
@@ -554,6 +567,26 @@ module MessageBus::Implementation
     @config[:keepalive_interval] || 60
   end
 
+  # Registers a client message filter that allows messages to be filtered from the client.
+  #
+  # @param [String,Regexp] channel_prefix channel prefix to match against a message's channel
+  #
+  # @yieldparam [MessageBus::Message] message published to the channel that matched the prefix provided
+  # @yieldreturn [Boolean] whether the message should be published to the client
+  # @return [void]
+  def register_client_message_filter(channel_prefix, &blk)
+    if blk
+      configure(client_message_filters: []) if !@config[:client_message_filters]
+      @config[:client_message_filters] << [channel_prefix, blk]
+    end
+  end
+
+  # @return [Array] returns a hash of message filters that have been registered
+  def client_message_filters
+    configure(client_message_filters: []) if !@config[:client_message_filters]
+    @config[:client_message_filters]
+  end
+
   private
 
   ENCODE_SITE_TOKEN = "$|$"

data/lib/message_bus/backends/redis.rb

@@ -251,11 +251,11 @@ LUA
 
       # (see Base#global_unsubscribe)
       def global_unsubscribe
-        if @redis_global
-          # new connection to avoid deadlock
-          new_redis_connection.publish(redis_channel_name, UNSUB_MESSAGE)
-          @redis_global.disconnect
-          @redis_global = nil
+        begin
+          new_redis = new_redis_connection
+          new_redis.publish(redis_channel_name, UNSUB_MESSAGE)
+        ensure
+          new_redis&.disconnect!
         end
       end
 
@@ -278,13 +278,13 @@ LUA
         end
 
         begin
-          @redis_global = new_redis_connection
+          global_redis = new_redis_connection
 
           if highest_id
             clear_backlog.call(&blk)
           end
 
-          @redis_global.subscribe(redis_channel_name) do |on|
+          global_redis.subscribe(redis_channel_name) do |on|
             on.subscribe do
               if highest_id
                 clear_backlog.call(&blk)
@@ -298,7 +298,7 @@ LUA
 
             on.message do |_c, m|
               if m == UNSUB_MESSAGE
-                @redis_global.unsubscribe
+                global_redis.unsubscribe
                 return
               end
               m = MessageBus::Message.decode m
@@ -320,7 +320,10 @@ LUA
         rescue => error
           @logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack #{error.backtrace}"
           sleep 1
+          global_redis&.disconnect!
           retry
+        ensure
+          global_redis&.disconnect!
         end
       end
 

data/lib/message_bus/client.rb

@@ -128,15 +128,43 @@ class MessageBus::Client
   # @return [Boolean] whether or not the client has permission to receive the
   #   passed message
   def allowed?(msg)
-    allowed = !msg.user_ids || msg.user_ids.include?(self.user_id)
-    allowed &&= !msg.client_ids || msg.client_ids.include?(self.client_id)
-    allowed && (
-      msg.group_ids.nil? ||
-      msg.group_ids.length == 0 ||
-      (
-        msg.group_ids - self.group_ids
+    client_allowed = !msg.client_ids || msg.client_ids.length == 0 || msg.client_ids.include?(self.client_id)
+
+    user_allowed = false
+    group_allowed = false
+
+    # this is an inconsistency we should fix anyway, publishing `user_ids: nil` should work same as groups
+    has_users = msg.user_ids && msg.user_ids.length > 0
+    has_groups = msg.group_ids && msg.group_ids.length > 0
+
+    if has_users
+      user_allowed = msg.user_ids.include?(self.user_id)
+    end
+
+    if has_groups
+      group_allowed = (
+        msg.group_ids - (self.group_ids || [])
       ).length < msg.group_ids.length
-    )
+    end
+
+    has_permission = client_allowed && (user_allowed || group_allowed || (!has_users && !has_groups))
+
+    return has_permission if !has_permission
+
+    filters_allowed = true
+
+    len = @bus.client_message_filters.length
+    while len > 0
+      len -= 1
+      channel_prefix, blk = @bus.client_message_filters[len]
+
+      if msg.channel.start_with?(channel_prefix)
+        filters_allowed = blk.call(msg)
+        break if !filters_allowed
+      end
+    end
+
+    filters_allowed
   end
 
   # @return [Array<MessageBus::Message>] the set of messages the client is due

data/lib/message_bus/diagnostics.rb

@@ -15,7 +15,6 @@ class MessageBus::Diagnostics
       #  process to process comms
       bus.subscribe('/_diagnostics/hup') do |msg|
         if Process.pid == msg.data["pid"] && hostname == msg.data["hostname"]
-          $shutdown = true
           sleep 4
           Process.kill("HUP", $$)
         end

data/lib/message_bus/rack/diagnostics.rb

@@ -16,9 +16,9 @@ class MessageBus::Rack::Diagnostics
   # Process an HTTP request from a subscriber client
   # @param [Rack::Request::Env] env the request environment
   def call(env)
-    return @app.call(env) unless env['PATH_INFO'].start_with? '/message-bus/_diagnostics'
+    return @app.call(env) unless env['PATH_INFO'].start_with? "#{@bus.base_route}message-bus/_diagnostics"
 
-    route = env['PATH_INFO'].split('/message-bus/_diagnostics')[1]
+    route = env['PATH_INFO'].split("#{@bus.base_route}message-bus/_diagnostics")[1]
 
     if @bus.is_admin_lookup.nil? || !@bus.is_admin_lookup.call(env)
       return [403, {}, ['not allowed']]
@@ -45,7 +45,7 @@ class MessageBus::Rack::Diagnostics
       return [200, { 'Content-Type' => 'application/javascript;charset=UTF-8' }, [content]]
     end
 
-    return [404, {}, ['not found']]
+    [404, {}, ['not found']]
   end
 
   private
@@ -92,6 +92,7 @@ class MessageBus::Rack::Diagnostics
         </body>
       </html>
     HTML
-    return [200, { "content-type" => "text/html;" }, [html]]
+
+    [200, { "content-type" => "text/html;" }, [html]]
   end
 end

data/lib/message_bus/rack/middleware.rb

@@ -39,6 +39,10 @@ class MessageBus::Rack::Middleware
     @bus = config[:message_bus] || MessageBus
     @connection_manager = MessageBus::ConnectionManager.new(@bus)
     @started_listener = false
+    @base_route = "#{@bus.base_route}message-bus/"
+    @base_route_length = @base_route.length
+    @diagnostics_route = "#{@base_route}_diagnostics"
+    @broadcast_route = "#{@base_route}broadcast"
     start_listener unless @bus.off?
   end
 
@@ -54,7 +58,7 @@ class MessageBus::Rack::Middleware
   # Process an HTTP request from a subscriber client
   # @param [Rack::Request::Env] env the request environment
   def call(env)
-    return @app.call(env) unless env['PATH_INFO'] =~ /^\/message-bus\//
+    return @app.call(env) unless env['PATH_INFO'].start_with? @base_route
 
     handle_request(env)
   end
@@ -63,18 +67,18 @@ class MessageBus::Rack::Middleware
 
   def handle_request(env)
     # special debug/test route
-    if @bus.allow_broadcast? && env['PATH_INFO'] == '/message-bus/broadcast'
+    if @bus.allow_broadcast? && env['PATH_INFO'] == @broadcast_route
       parsed = Rack::Request.new(env)
       @bus.publish parsed["channel"], parsed["data"]
       return [200, { "Content-Type" => "text/html" }, ["sent"]]
     end
 
-    if env['PATH_INFO'].start_with? '/message-bus/_diagnostics'
+    if env['PATH_INFO'].start_with? @diagnostics_route
       diags = MessageBus::Rack::Diagnostics.new(@app, message_bus: @bus)
       return diags.call(env)
     end
 
-    client_id = env['PATH_INFO'].split("/")[2]
+    client_id = env['PATH_INFO'][@base_route_length..-1].split("/")[0]
     return [404, {}, ["not found"]] unless client_id
 
     user_id = @bus.user_id_lookup.call(env) if @bus.user_id_lookup

data/lib/message_bus/rails/railtie.rb

@@ -11,27 +11,29 @@ class MessageBus::Rails::Railtie < ::Rails::Railtie
     # the Rails app is configured that might be ActionDispatch::Session::CookieStore, or potentially
     # ActionDispatch::Session::ActiveRecordStore.
     #
-    # To handle either case, we insert it before ActionDispatch::Flash.
-    #
-    # For APIs or apps that have ActionDispatch::Flash deleted from the middleware
-    # stack we just push MessageBus to the bottom.
-    if api_only?(app.config) || flash_middleware_deleted?(app.middleware)
-      app.middleware.use(MessageBus::Rack::Middleware)
-    else
-      app.middleware.insert_before(ActionDispatch::Flash, MessageBus::Rack::Middleware)
+    # given https://github.com/rails/rails/commit/fedde239dcee256b417dc9bcfe5fef603bf0d952#diff-533a9a9cc17a8a899cb830626089e5f9
+    # there is no way of walking the stack for operations
+    if !skip_middleware?(app.config)
+      if api_only?(app.config)
+        app.middleware.use(MessageBus::Rack::Middleware)
+      else
+        app.middleware.insert_before(ActionDispatch::Flash, MessageBus::Rack::Middleware)
+      end
     end
 
     MessageBus.logger = Rails.logger
   end
 
+  def skip_middleware?(config)
+    return false if !config.respond_to?(:skip_message_bus_middleware)
+
+    config.skip_message_bus_middleware
+  end
+
   def api_only?(config)
-    return false unless config.respond_to?(:api_only)
+    return false if !config.respond_to?(:api_only)
 
     config.api_only
   end
 
-  def flash_middleware_deleted?(middleware)
-    ops = middleware.instance_variable_get(:@operations)
-    ops.any? { |m| m[0] == :delete && m[1].include?(ActionDispatch::Flash) }
-  end
 end

data/lib/message_bus/version.rb

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

data/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "message-bus-client",
+  "version": "3.3.0",
+  "description": "A message bus client in Javascript",
+  "main": "assets/message-bus.js",
+  "keywords": "es6, modules",
+  "files": ["assets/message-bus.js"],
+  "jsnext:main": "assets/message-bus.js",
+  "module": "assets/message-bus.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/discourse/message_bus.git"
+  },
+  "author": "Sam Saffron, Robin Ward",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/discourse/message_bus/issues"
+  },
+  "homepage": "https://github.com/discourse/message_bus#readme"
+}

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

@@ -75,15 +75,6 @@ describe("Messagebus", function() {
     })
   });
 
-  it('removes itself from root namespace when noConflict is called', function(){
-    expect(window.MessageBus).not.toBeUndefined();
-    var mb = window.MessageBus;
-    expect(mb).toEqual(window.MessageBus.noConflict());
-    expect(window.MessageBus).toBeUndefined();
-    // reset it so afterEach has something to work on
-    window.MessageBus = mb;
-  });
-
   it('respects minPollInterval setting with defaults', function(){
     expect(MessageBus.minPollInterval).toEqual(100);
     MessageBus.minPollInterval = 1000;

data/spec/lib/message_bus/client_spec.rb

@@ -169,37 +169,220 @@ describe MessageBus::Client do
       log[0].data.must_equal 'world'
     end
 
-    it "allows only client_id in list if message contains client_ids" do
-      @message = MessageBus::Message.new(1, 2, '/test', 'hello')
-      @message.client_ids = ["1", "2"]
-      @client.client_id = "2"
-      @client.allowed?(@message).must_equal true
-
-      @client.client_id = "3"
-      @client.allowed?(@message).must_equal false
-    end
-
-    describe "targetted at group" do
-      before do
+    describe '#allowed?' do
+      it "allows only client_id in list if message contains client_ids" do
         @message = MessageBus::Message.new(1, 2, '/test', 'hello')
-        @message.group_ids = [1, 2, 3]
-      end
+        @message.client_ids = ["1", "2"]
+        @client.client_id = "2"
+        @client.allowed?(@message).must_equal true
 
-      it "denies users that are not members of group" do
-        @client.group_ids = [77, 0, 10]
+        @client.client_id = "3"
         @client.allowed?(@message).must_equal false
-      end
 
-      it "allows users that are members of group" do
-        @client.group_ids = [1, 2, 3]
+        @message.client_ids = []
+
+        @client.client_id = "3"
         @client.allowed?(@message).must_equal true
-      end
 
-      it "allows all users if groups not set" do
-        @message.group_ids = nil
-        @client.group_ids = [77, 0, 10]
+        @message.client_ids = nil
+
+        @client.client_id = "3"
         @client.allowed?(@message).must_equal true
       end
+
+      describe 'targetted at user' do
+        before do
+          @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+          @message.user_ids = [1, 2, 3]
+        end
+
+        it "allows client with user_id that is included in message's user_ids" do
+          @client.user_id = 1
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with user_id that is not included in message's user_ids" do
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "denies client with nil user_id" do
+          @client.user_id = nil
+
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client if message's user_ids is not set" do
+          @message.user_ids = nil
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "allows client if message's user_ids is empty" do
+          @message.user_ids = []
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "allows client with client_id that is included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "1"
+          @client.user_id = 1
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with client_id that is not included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "3"
+          @client.user_id = 1
+
+          @client.allowed?(@message).must_equal(false)
+        end
+      end
+
+      describe "targetted at group" do
+        before do
+          @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+          @message.group_ids = [1, 2, 3]
+        end
+
+        it "denies client that are not members of group" do
+          @client.group_ids = [77, 0, 10]
+          @client.allowed?(@message).must_equal false
+        end
+
+        it 'denies client with nil group_ids' do
+          @client.group_ids = nil
+          @client.allowed?(@message).must_equal false
+        end
+
+        it "allows client that are members of group" do
+          @client.group_ids = [1, 2, 3]
+          @client.allowed?(@message).must_equal true
+        end
+
+        it "allows any client if message's group_ids is not set" do
+          @message.group_ids = nil
+          @client.group_ids = [77, 0, 10]
+          @client.allowed?(@message).must_equal true
+        end
+
+        it "allows any client if message's group_ids is empty" do
+          @message.group_ids = []
+          @client.group_ids = [77, 0, 10]
+          @client.allowed?(@message).must_equal true
+        end
+
+        it "allows client with client_id that is included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "1"
+          @client.group_ids = [1]
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with client_id that is not included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "3"
+          @client.group_ids = [1]
+
+          @client.allowed?(@message).must_equal(false)
+        end
+      end
+
+      describe 'targetted at group and user' do
+        before do
+          @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+          @message.group_ids = [1, 2, 3]
+          @message.user_ids = [4, 5, 6]
+        end
+
+        it "allows client with user_id that is included in message's user_ids" do
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with user_id that is not included in message's user_ids" do
+          @client.user_id = 1
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client with group_ids that is included in message's group_ids" do
+          @client.group_ids = [1, 0, 3]
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with group_ids that is not included in message's group_ids" do
+          @client.group_ids = [8, 9, 10]
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client with allowed client_id and user_id" do
+          @message.client_ids = ["1", "2"]
+          @client.user_id = 4
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with allowed client_id but disallowed user_id" do
+          @message.client_ids = ["1", "2"]
+          @client.user_id = 99
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client with allowed client_id and group_id" do
+          @message.client_ids = ["1", "2"]
+          @client.group_ids = [1]
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with allowed client_id but disallowed group_id" do
+          @message.client_ids = ["1", "2"]
+          @client.group_ids = [99]
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(false)
+        end
+      end
+
+      describe 'when MessageBus#client_message_filters has been configured' do
+
+        it 'filters messages correctly' do
+          message = MessageBus::Message.new(1, 2, '/test/5', 'hello')
+          @client.allowed?(message).must_equal(true)
+
+          @bus.register_client_message_filter('/test') do |m|
+            m.data != 'hello'
+          end
+
+          @client.allowed?(message).must_equal(false)
+        end
+
+        it 'filters messages correctly when multiple filters have been configured' do
+
+          bob_message = MessageBus::Message.new(1, 2, '/test/5', 'bob')
+          fred_message = MessageBus::Message.new(1, 2, '/test/5', 'fred')
+          random_message = MessageBus::Message.new(1, 2, '/test/77', 'random')
+
+          @bus.register_client_message_filter('/test') do |message|
+            message.data == 'bob' || message.data == 'fred'
+          end
+
+          @bus.register_client_message_filter('/test') do |message|
+            message.data == 'fred'
+          end
+
+          @client.allowed?(fred_message).must_equal(true)
+          @client.allowed?(bob_message).must_equal(false)
+          @client.allowed?(random_message).must_equal(false)
+        end
+      end
     end
   end
 end

data/spec/lib/message_bus/rack/middleware_spec.rb

@@ -8,11 +8,13 @@ require 'rack/test'
 describe MessageBus::Rack::Middleware do
   include Rack::Test::Methods
   let(:extra_middleware) { nil }
+  let(:base_route) { nil }
 
   before do
     bus = @bus = MessageBus::Instance.new
     @bus.configure(MESSAGE_BUS_CONFIG)
     @bus.long_polling_enabled = false
+    @bus.base_route = base_route if base_route
 
     e_m = extra_middleware
     builder = Rack::Builder.new {
@@ -44,12 +46,27 @@ describe MessageBus::Rack::Middleware do
       @bus.long_polling_enabled = true
     end
 
+    describe "with altered base_route" do
+      let(:base_route) { "/base/route/" }
+
+      it "should respond as normal" do
+        post "/base/route/message-bus/ABC?dlp=t", '/foo1' => 0
+        @async_middleware.in_async?.must_equal false
+        last_response.ok?.must_equal true
+      end
+    end
+
     it "should respond right away if dlp=t" do
       post "/message-bus/ABC?dlp=t", '/foo1' => 0
       @async_middleware.in_async?.must_equal false
       last_response.ok?.must_equal true
     end
 
+    it "should respond with a 404 if the client_id is missing" do
+      post "/message-bus/?dlp=t", '/foo1' => 0
+      last_response.not_found?.must_equal true
+    end
+
     it "should respond right away to long polls that are polling on -1 with the last_id" do
       post "/message-bus/ABC", '/foo' => -1
       last_response.ok?.must_equal true
@@ -141,6 +158,19 @@ describe MessageBus::Rack::Middleware do
       last_response.status.must_equal 200
     end
 
+    describe "with an altered base_route" do
+      let(:base_route) { "/base/route/" }
+
+      it "should get a 200 with html for an authorized user" do
+        def @bus.is_admin_lookup
+          proc { |_| true }
+        end
+
+        get "/base/route/message-bus/_diagnostics"
+        last_response.status.must_equal 200
+      end
+    end
+
     it "should get the script it asks for" do
 
       def @bus.is_admin_lookup
@@ -243,6 +273,38 @@ describe MessageBus::Rack::Middleware do
       parsed[1]["data"].must_equal "borbs"
     end
 
+    it "should use the correct client ID" do
+      id = @bus.last_id('/foo')
+
+      client_id = "aBc123"
+      @bus.publish("/foo", "msg1", client_ids: [client_id])
+      @bus.publish("/foo", "msg2", client_ids: ["not_me#{client_id}"])
+
+      post "/message-bus/#{client_id}",
+           '/foo' => id
+
+      parsed = JSON.parse(last_response.body)
+      parsed.length.must_equal 2
+      parsed[0]["data"].must_equal("msg1")
+      parsed[1]["data"].wont_equal("msg2")
+    end
+
+    it "should use the correct client ID with additional path" do
+      id = @bus.last_id('/foo')
+
+      client_id = "aBc123"
+      @bus.publish("/foo", "msg1", client_ids: [client_id])
+      @bus.publish("/foo", "msg2", client_ids: ["not_me#{client_id}"])
+
+      post "/message-bus/#{client_id}/path/not/needed",
+           '/foo' => id
+
+      parsed = JSON.parse(last_response.body)
+      parsed.length.must_equal 2
+      parsed[0]["data"].must_equal("msg1")
+      parsed[1]["data"].wont_equal("msg2")
+    end
+
     it "should have no cross talk" do
       seq = 0
       @bus.site_id_lookup do

data/spec/lib/message_bus_spec.rb

@@ -37,6 +37,23 @@ describe MessageBus do
     @bus.after_fork
   end
 
+  describe "#base_route=" do
+    it "adds leading and trailing slashes" do
+      @bus.base_route = "my/base/route"
+      @bus.base_route.must_equal '/my/base/route/'
+    end
+
+    it "leaves existing leading and trailing slashes" do
+      @bus.base_route = "/my/base/route/"
+      @bus.base_route.must_equal '/my/base/route/'
+    end
+
+    it "removes duplicate slashes" do
+      @bus.base_route = "//my///base/route"
+      @bus.base_route.must_equal '/my/base/route/'
+    end
+  end
+
   it "can subscribe from a point in time" do
     @bus.publish("/minion", "banana")
 
@@ -292,4 +309,19 @@ describe MessageBus do
 
     data.must_equal(["pre-fork", "from-fork", "continuation"])
   end
+
+  describe '#register_client_message_filter' do
+    it 'should register the message filter correctly' do
+      @bus.register_client_message_filter('/test')
+
+      @bus.client_message_filters.must_equal([])
+
+      @bus.register_client_message_filter('/test') { puts "hello world" }
+
+      channel, blk = @bus.client_message_filters[0]
+
+      blk.must_respond_to(:call)
+      channel.must_equal('/test')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 3.3.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -113,6 +113,7 @@ files:
 - lib/message_bus/timer_thread.rb
 - lib/message_bus/version.rb
 - message_bus.gemspec
+- package.json
 - spec/assets/SpecHelper.js
 - spec/assets/message-bus.spec.js
 - spec/assets/support/jasmine.yml
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ''