message_bus 3.1.0 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe33cef07b7712b1bbcc2ab444e123fd1121665a5ecf1db7fb24dba190e48b38
-  data.tar.gz: 325300ad20aeb221d468326247c7755022dc8e594e8de1311601dec89b4a2c2b
+  metadata.gz: 2df4ed426f8b349c63bd56de7f73f846a65cef0a689de7c3d5a017a7eabaf2ac
+  data.tar.gz: a1f05881617167d9b680c8a1ac192fdd02dea903e1ff4b5fa692fe26c4533633
 SHA512:
-  metadata.gz: 216a6156aad68865beb14a519bda4f709e10d96bcc8c58fa4bc042ef596fd7563926517f5b5c82d547f4ff26ce7bd3ac0a74998ce9cf7b4b2d66c792f049c602
-  data.tar.gz: fb521cf6b6928586f7ba1f2da19a8def8d3f77acc0d6cb1c417fe03d8a36f0af8a470c29cc26ce400c12ba8648223ded2de43109a4616b5c89b967ed4e6a67aa
+  metadata.gz: a9feb43d0b0725bcc3190704f9f673bf3b7ce2e6d1c5c6e70212f21ebad241e082c0095ed08b1144d73cbef50f0585f858cc4cd1215e72e668eeb37df4d2f1bd
+  data.tar.gz: e69da95765f2017b005977486f4be3077055357b9ff17a70894a4a0d95c2e9fa02cd2b50dc14d301961d07eccb097733be378f2b05fb3edbd0c1b9a32376999c

data/.travis.yml

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

data/CHANGELOG

@@ -1,3 +1,49 @@
+- Unrelease
+
+18-09-2020
+
+- Version 3.3.3
+
+  - FIX: `queue_in_memory` option not being passed to the backends.
+  - FIX: `MessageBus::DistributedCache#publish` should raise on error.
+
+    On the redis backend, any errors encountered during `MessageBus#publish`
+    will add the message into an in memory queue and silently swallow the
+    error. While this is behavior is OK for normal message_bus usage, it may
+    lead to inconsistency when using `DistributedCache`. If a process
+    doesn't publish successfully to another process, it will still update
+    its in memory cache leaving the other processes unaware. As such, the
+    distributed cache is out of sync and will require another successful
+    write to the cache to resync all the caches.
+
+15-09-2020
+
+- Version 3.3.2
+
+  - FIX: In the JavaScript client throw when when lastId is given but is not a number.
+  - FEATURE: raise when attempting to publish to invalid targets
+  - Log when DistributedCache encounters an error when publishing.
+
+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

data/README.md

@@ -304,6 +304,11 @@ MessageBus.subscribe("/channel", function(data){
 MessageBus.subscribe("/channel", function(data){
   // data shipped from server
 }, -3);
+
+// you will get the entire backlog
+MessageBus.subscribe("/channel", function(data){
+  // data shipped from server
+}, 0);
 ```
 
 #### JavaScript Client settings
@@ -319,7 +324,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
@@ -341,8 +346,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) {
@@ -502,13 +484,16 @@
     // -1 will subscribe to all new messages
     // -2 will recieve last message + all new messages
     // -3 will recieve last 2 messages + all new messages
+    // if undefined will default to -1
     subscribe: function(channel, func, lastId) {
       if (!started && !stopped) {
         me.start();
       }
 
-      if (typeof lastId !== "number") {
+      if (lastId === null || typeof lastId === "undefined") {
         lastId = -1;
+      } else if (typeof lastId !== "number") {
+        throw "lastId has type " + typeof lastId + " but a number was expected.";
       }
 
       if (typeof channel !== "string") {
@@ -532,7 +517,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 +552,5 @@
       return removed;
     }
   };
-  global.MessageBus = me;
-})(window, document);
+  return me;
+}));

data/lib/message_bus.rb

@@ -20,6 +20,7 @@ end
 module MessageBus; end
 MessageBus::BACKENDS = {}
 class MessageBus::InvalidMessage < StandardError; end
+class MessageBus::InvalidMessageTarget < MessageBus::InvalidMessage; end
 class MessageBus::BusDestroyed < StandardError; end
 
 # The main server-side interface to a message bus for the purposes of
@@ -149,6 +150,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
@@ -316,6 +330,7 @@ module MessageBus::Implementation
   #
   # @raise [MessageBus::BusDestroyed] if the bus is destroyed
   # @raise [MessageBus::InvalidMessage] if attempting to put permission restrictions on a globally-published message
+  # @raise [MessageBus::InvalidMessageTarget] if attempting to publish to a empty group of users
   def publish(channel, data, opts = nil)
     return if @off
 
@@ -335,7 +350,13 @@ module MessageBus::Implementation
       site_id = opts[:site_id]
     end
 
-    raise ::MessageBus::InvalidMessage if (user_ids || group_ids) && global?(channel)
+    if (user_ids || group_ids) && global?(channel)
+      raise ::MessageBus::InvalidMessage
+    end
+
+    if (user_ids == []) || (group_ids == []) || (client_ids == [])
+      raise ::MessageBus::InvalidMessageTarget
+    end
 
     encoded_data = JSON.dump(
       data: data,
@@ -344,13 +365,17 @@ module MessageBus::Implementation
       client_ids: client_ids
     )
 
-    channel_opts = nil
+    channel_opts = {}
+
+    if opts
+      if ((age = opts[:max_backlog_age]) || (size = opts[:max_backlog_size]))
+        channel_opts[:max_backlog_size] = size,
+        channel_opts[:max_backlog_age] = age
+      end
 
-    if opts && ((age = opts[:max_backlog_age]) || (size = opts[:max_backlog_size]))
-      channel_opts = {
-        max_backlog_size: size,
-        max_backlog_age: age
-      }
+      if opts.has_key?(:queue_in_memory)
+        channel_opts[:queue_in_memory] = opts[:queue_in_memory]
+      end
     end
 
     encoded_channel_name = encode_channel_name(channel, site_id)

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
@@ -318,9 +318,12 @@ LUA
             end
           end
         rescue => error
-          @logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack #{error.backtrace}"
+          @logger.warn "#{error} subscribe failed, reconnecting in 1 second. Call stack #{error.backtrace.join("\n")}"
           sleep 1
+          global_redis&.disconnect!
           retry
+        ensure
+          global_redis&.disconnect!
         end
       end
 

data/lib/message_bus/client.rb

@@ -133,7 +133,6 @@ class MessageBus::Client
     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
 

data/lib/message_bus/distributed_cache.rb

@@ -16,11 +16,12 @@ module MessageBus
 
       attr_accessor :app_version
 
-      def initialize(message_bus = nil)
+      def initialize(message_bus = nil, publish_queue_in_memory: true)
         @subscribers = []
         @subscribed = false
         @lock = Mutex.new
         @message_bus = message_bus || MessageBus
+        @publish_queue_in_memory = publish_queue_in_memory
       end
 
       def subscribers
@@ -75,7 +76,11 @@ module MessageBus
         message[:origin] = hash.identity
         message[:hash_key] = hash.key
         message[:app_version] = @app_version if @app_version
-        @message_bus.publish(CHANNEL_NAME, message, user_ids: [-1])
+
+        @message_bus.publish(CHANNEL_NAME, message,
+          user_ids: [-1],
+          queue_in_memory: @publish_queue_in_memory
+        )
       end
 
       def set(hash, key, value)

data/lib/message_bus/message.rb

@@ -20,10 +20,10 @@ class MessageBus::Message < Struct.new(:global_id, :message_id, :channel, :data)
 
   # only tricky thing to encode is pipes in a channel name ... do a straight replace
   def encode
-    global_id.to_s << "|" << message_id.to_s << "|" << channel.gsub("|", "$$123$$") << "|" << data
+    "#{global_id}|#{message_id}|#{channel.gsub("|", "$$123$$")}|#{data}"
   end
 
   def encode_without_ids
-    channel.gsub("|", "$$123$$") << "|" << data
+    "#{channel.gsub("|", "$$123$$")}|#{data}"
   end
 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']]

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/timer_thread.rb

@@ -45,7 +45,14 @@ class MessageBus::TimerThread
     while running
       @mutex.synchronize do
         running = @thread && @thread.alive?
-        @thread.wakeup if running
+
+        if running
+          begin
+            @thread.wakeup
+          rescue ThreadError
+            raise if @thread.alive?
+          end
+        end
       end
       sleep 0
     end

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "3.1.0"
+  VERSION = "3.3.3"
 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/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")
 
@@ -249,15 +266,37 @@ describe MessageBus do
     end
 
     it "should exception if publishing restricted messages to user" do
-      lambda do
+      assert_raises(MessageBus::InvalidMessage) do
         @bus.publish("/global/test", "test", user_ids: [1])
-      end.must_raise(MessageBus::InvalidMessage)
+      end
     end
 
     it "should exception if publishing restricted messages to group" do
-      lambda do
+      assert_raises(MessageBus::InvalidMessage) do
         @bus.publish("/global/test", "test", user_ids: [1])
-      end.must_raise(MessageBus::InvalidMessage)
+      end
+    end
+
+    it "should raise if we publish to an empty group or user list" do
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", user_ids: []
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", group_ids: []
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", client_ids: []
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", group_ids: [], user_ids: [1]
+      end
+
+      assert_raises(MessageBus::InvalidMessageTarget) do
+        @bus.publish "/foo", "bar", group_ids: [1], user_ids: []
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.3
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-09-18 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: ''