message_bus 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff8ef38b49e1ca6d2fa08b0f56a62929247d71256ea5e717c2952dde35b63bf
-  data.tar.gz: 158ca236805f872f60737d3af030bb38319c0b7355499b9c9d26006cb001121f
+  metadata.gz: d4103e822baabb87e382a7c3c960605fa31d737fd89ed2b2f2036a9983fbf8fc
+  data.tar.gz: d3f83ce786dd1a06b495a3773041145bea990869462238d46e723c4f9e82a0e7
 SHA512:
-  metadata.gz: b8b0a6c5079e5a1fd025dbaa8bde07140160fc9041ee7ac25defb32fb658c5817472efe1a98f25875e67e74ce81d1ff20ab32209f89af995ff87529bb5c8da92
-  data.tar.gz: 40baa9cb6ca20f986591ee766f1c52fbc6a73595b5beca94f2d80be1211915668f5555fd4a1c9db80b9ddf191e3dd065d9d244c4356b8c47420aca62102cb375
+  metadata.gz: f2623043461d284141e727cd28c20750d544ac6edc047c2332f1f306bceb6afc79f154261d4f94085cc6f18396274c2d9ec8fc662cb6185c54e7220675f352c2
+  data.tar.gz: 12b3027295123f1c17468ef56920c19f57aeec82bc9ffb75bb0054fb8a426560c52f552b5150f02cab02ae3979a3161777bd2ae42d023aee53e1a2b37d41f772

data/CHANGELOG

@@ -1,3 +1,9 @@
+- Unreleased
+
+   - 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

data/README.md

@@ -319,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
@@ -341,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/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

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 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")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-27 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