message_bus 3.3.3 → 3.3.7

data/package.json

@@ -1,10 +1,15 @@
 {
   "name": "message-bus-client",
-  "version": "3.3.0",
+  "version": "3.3.5",
   "description": "A message bus client in Javascript",
   "main": "assets/message-bus.js",
-  "keywords": "es6, modules",
-  "files": ["assets/message-bus.js"],
+  "keywords": [
+    "es6",
+    "modules"
+  ],
+  "files": [
+    "assets/message-bus.js"
+  ],
   "jsnext:main": "assets/message-bus.js",
   "module": "assets/message-bus.js",
   "repository": {
@@ -16,5 +21,10 @@
   "bugs": {
     "url": "https://github.com/discourse/message_bus/issues"
   },
-  "homepage": "https://github.com/discourse/message_bus#readme"
+  "homepage": "https://github.com/discourse/message_bus#readme",
+  "devDependencies": {
+    "eslint": "^7.27.0",
+    "jasmine-browser-runner": "^0.10.0",
+    "jasmine-core": "^3.10.1"
+  }
 }

data/spec/assets/SpecHelper.js

@@ -1,3 +1,5 @@
+/* global beforeEach, afterEach, it, spyOn, MessageBus */
+
 var message_id = 1;
 var SEPARATOR = "\r\n|\r\n";
 
@@ -12,7 +14,7 @@ var encodeChunks = function(xhr, chunks) {
   }
   if (xhr.onprogress){ // using longPoll if onprogress is set
     var responses = []
-    for (var i=0;i<chunks.length;i++) {
+    for (var j=0;j<chunks.length;j++) {
       responses.push( JSON.stringify([chunk]) );
     }
     return responses.join(SEPARATOR) + SEPARATOR;
@@ -26,7 +28,7 @@ beforeEach(function () {
 
   function MockedXMLHttpRequest(){
     this.headers = {};
-  };
+  }
 
   MockedXMLHttpRequest.prototype.send              = function(){
     this.readyState = 4
@@ -75,8 +77,8 @@ window.testMB = function(description, testFn, path, data){
     {channel: path || '/test', data: data || {password: 'MessageBusRocks!'}}
   ];
   it(description, function(done){
-    spec = this;
-    promisy = {
+    var spec = this;
+    var promisy = {
       finally: function(fn){
         this.resolve = fn;
       }
@@ -105,4 +107,3 @@ window.testMB = function(description, testFn, path, data){
   });
 
 }
-

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

@@ -1,3 +1,5 @@
+/* global describe, it, spyOn, MessageBus, expect, jasmine, testMB */
+
 describe("Messagebus", function() {
 
   it("submits change requests", function(done){
@@ -6,10 +8,11 @@ describe("Messagebus", function() {
     MessageBus.subscribe('/test', function(){
       expect(spec.MockedXMLHttpRequest.prototype.send)
         .toHaveBeenCalled()
-      var req = JSON.parse(spec.MockedXMLHttpRequest.prototype.send.calls.argsFor(0)[0]);
-      expect(req['/test']).toEqual(-1)
-      expect(req['__seq']).not.toBeUndefined();
-      done()
+      var data = spec.MockedXMLHttpRequest.prototype.send.calls.argsFor(0)[0];
+      var params = new URLSearchParams(data);
+      expect(params.get("/test")).toEqual("-1");
+      expect(params.get("__seq")).toMatch(/\d+/);
+      done();
     });
   });
 
@@ -57,7 +60,7 @@ describe("Messagebus", function() {
     });
   });
 
-  testMB('sets dlp paramater when longPolling is disabled', function(){
+  testMB('sets dlp parameter when longPolling is disabled', function(){
     MessageBus.enableLongPolling = false
     this.perform(function(message, xhr){
       expect(xhr.url).toMatch("dlp=t");
@@ -87,7 +90,7 @@ describe("Messagebus", function() {
       expect(xhr.headers).toEqual({
         'X-SILENCE-LOGGER': 'true',
         'X-MB-TEST-VALUE': '42',
-        'Content-Type': 'application/json'
+        'Content-Type': 'application/x-www-form-urlencoded'
       });
     }).finally(function(){
       MessageBus.headers = {};

data/spec/helpers.rb

@@ -1,15 +1,26 @@
 # frozen_string_literal: true
-def wait_for(timeout_milliseconds = 2000)
-  timeout = (timeout_milliseconds + 0.0) / 1000
+
+require 'logger'
+require 'method_source'
+
+def wait_for(timeout_milliseconds = 2000, &blk)
+  timeout = timeout_milliseconds / 1000.0
   finish = Time.now + timeout
+  result = nil
 
-  Thread.new do
-    sleep(0.001) while Time.now < finish && !yield
-  end.join
+  while Time.now < finish && !(result = blk.call)
+    sleep(0.001)
+  end
+
+  flunk("wait_for timed out:\n#{blk.source}") if !result
 end
 
 def test_config_for_backend(backend)
-  config = { backend: backend }
+  config = {
+    backend: backend,
+    logger: Logger.new(IO::NULL),
+  }
+
   case backend
   when :redis
     config[:url] = ENV['REDISURL']

data/spec/integration/http_client_spec.rb

@@ -71,7 +71,7 @@ describe MessageBus::HTTPClient do
           # that we sleep for the right interval after failure
           sleep 0.5
 
-          assert_equal(1, fake.string.scan("Errno::ECONNREFUSED").size)
+          assert_match(/Errno::ECONNREFUSED|SocketError/, fake.string)
         ensure
           $stderr = original_stderr
         end

data/spec/lib/message_bus/backend_spec.rb

@@ -4,18 +4,17 @@ require_relative '../../spec_helper'
 require 'message_bus'
 
 describe PUB_SUB_CLASS do
-  def new_test_bus
-    PUB_SUB_CLASS.new(MESSAGE_BUS_CONFIG)
+  before do
+    @bus = PUB_SUB_CLASS.new(test_config_for_backend(CURRENT_BACKEND))
   end
 
-  before do
-    @bus = new_test_bus
+  after do
     @bus.reset!
   end
 
   describe "API parity" do
     it "has the same public methods as the base class" do
-      @bus.public_methods.sort.must_equal MessageBus::Backends::Base.new(MESSAGE_BUS_CONFIG).public_methods.sort
+      @bus.public_methods.sort.must_equal MessageBus::Backends::Base.new(test_config_for_backend(CURRENT_BACKEND)).public_methods.sort
     end
   end
 
@@ -77,7 +76,7 @@ describe PUB_SUB_CLASS do
     end
 
     threads.each(&:join)
-    @bus.backlog("/foo").length == 100
+    @bus.backlog("/foo").length.must_equal 100
   end
 
   it "should be able to encode and decode messages properly" do
@@ -91,37 +90,6 @@ describe PUB_SUB_CLASS do
     @bus.last_id("/foo").must_equal 1
   end
 
-  describe "readonly" do
-    after do
-      @bus.pub_redis.slaveof "no", "one"
-    end
-
-    it "should be able to store messages in memory for a period while in read only" do
-      test_only :redis
-      skip "This spec changes redis behavior that in turn means other specs run slow"
-
-      @bus.pub_redis.slaveof "127.0.0.80", "666"
-      @bus.max_in_memory_publish_backlog = 2
-
-      current_threads = Thread.list
-      current_threads_length = current_threads.count
-
-      3.times do
-        result = @bus.publish "/foo", "bar"
-        assert_nil result
-        Thread.list.length.must_equal(current_threads_length + 1)
-      end
-
-      @bus.pub_redis.slaveof "no", "one"
-      sleep 0.01
-
-      (Thread.list - current_threads).each(&:join)
-      Thread.list.length.must_equal current_threads_length
-
-      @bus.backlog("/foo", 0).map(&:data).must_equal ["bar", "bar"]
-    end
-  end
-
   it "can set backlog age" do
     @bus.max_backlog_age = 1
 
@@ -137,7 +105,7 @@ describe PUB_SUB_CLASS do
     sleep 1.25 # Should now be at time =~ 1.25s. Our backlog should have expired by now.
     expected_backlog_size = 0
 
-    case MESSAGE_BUS_CONFIG[:backend]
+    case CURRENT_BACKEND
     when :postgres
       # Force triggering backlog expiry: postgres backend doesn't expire backlogs on a timer, but at publication time.
       @bus.global_backlog.length.wont_equal expected_backlog_size
@@ -161,7 +129,7 @@ describe PUB_SUB_CLASS do
     @bus.publish "/foo", "baz" # Publish something else to ward off another expiry
     expected_backlog_size += 1
 
-    case MESSAGE_BUS_CONFIG[:backend]
+    case CURRENT_BACKEND
     when :postgres
       # Postgres expires individual messages that have lived longer than the TTL, not whole backlogs
       expected_backlog_size -= 1
@@ -189,7 +157,7 @@ describe PUB_SUB_CLASS do
     sleep 1.25 # Should now be at time =~ 1.25s. Our backlog should have expired by now.
     expected_backlog_size = 0
 
-    case MESSAGE_BUS_CONFIG[:backend]
+    case CURRENT_BACKEND
     when :postgres
       # Force triggering backlog expiry: postgres backend doesn't expire backlogs on a timer, but at publication time.
       @bus.global_backlog.length.wont_equal expected_backlog_size
@@ -204,7 +172,7 @@ describe PUB_SUB_CLASS do
 
     # for the time being we can give pg a pass here
     # TODO: make the implementation here consistent
-    if MESSAGE_BUS_CONFIG[:backend] != :postgres
+    if CURRENT_BACKEND != :postgres
       # ids are not opaque we expect them to be reset on our channel if it
       # got cleared due to an expire, the reason for this is cause we will leak entries due to tracking
       # this in turn can bloat storage for the backend
@@ -222,7 +190,7 @@ describe PUB_SUB_CLASS do
     @bus.publish "/foo", "baz", max_backlog_age: 1 # Publish something else to ward off another expiry
     expected_backlog_size += 1
 
-    case MESSAGE_BUS_CONFIG[:backend]
+    case CURRENT_BACKEND
     when :postgres
       # Postgres expires individual messages that have lived longer than the TTL, not whole backlogs
       expected_backlog_size -= 1
@@ -249,7 +217,7 @@ describe PUB_SUB_CLASS do
     @bus.publish "/foo", "baz"
     @bus.publish "/hello", "planet"
 
-    expected_messages = case MESSAGE_BUS_CONFIG[:backend]
+    expected_messages = case CURRENT_BACKEND
                         when :redis
                           # Redis has channel-specific message IDs
                           [
@@ -277,7 +245,7 @@ describe PUB_SUB_CLASS do
     @bus.publish "/bar", "a1"
     @bus.publish "/bar", "b1"
 
-    expected_messages = case MESSAGE_BUS_CONFIG[:backend]
+    expected_messages = case CURRENT_BACKEND
                         when :redis
                           # Redis has channel-specific message IDs
                           [

data/spec/lib/message_bus/client_spec.rb

@@ -11,7 +11,7 @@ describe MessageBus::Client do
 
     before do
       @bus = MessageBus::Instance.new
-      @bus.configure(MESSAGE_BUS_CONFIG)
+      @bus.configure(test_config_for_backend(CURRENT_BACKEND))
       @client = setup_client('abc')
     end
 
@@ -98,7 +98,7 @@ describe MessageBus::Client do
       chunk2.length.must_equal 0
     end
 
-    it "does not bleed data accross sites" do
+    it "does not bleed data across sites" do
       @client.site_id = "test"
 
       @client.subscribe('/hello', nil)
@@ -107,7 +107,7 @@ describe MessageBus::Client do
       log.length.must_equal 0
     end
 
-    it "does not bleed status accross sites" do
+    it "does not bleed status across sites" do
       @client.site_id = "test"
 
       @client.subscribe('/hello', -1)
@@ -190,7 +190,7 @@ describe MessageBus::Client do
         @client.allowed?(@message).must_equal true
       end
 
-      describe 'targetted at user' do
+      describe 'targeted at user' do
         before do
           @message = MessageBus::Message.new(1, 2, '/test', 'hello')
           @message.user_ids = [1, 2, 3]
@@ -241,7 +241,7 @@ describe MessageBus::Client do
         end
       end
 
-      describe "targetted at group" do
+      describe "targeted at group" do
         before do
           @message = MessageBus::Message.new(1, 2, '/test', 'hello')
           @message.group_ids = [1, 2, 3]
@@ -291,7 +291,7 @@ describe MessageBus::Client do
         end
       end
 
-      describe 'targetted at group and user' do
+      describe 'targeted at group and user' do
         before do
           @message = MessageBus::Message.new(1, 2, '/test', 'hello')
           @message.group_ids = [1, 2, 3]

data/spec/lib/message_bus/distributed_cache_spec.rb

@@ -6,13 +6,16 @@ require 'message_bus'
 require 'message_bus/distributed_cache'
 
 describe MessageBus::DistributedCache do
-  before :all do
+  before do
     @bus = MessageBus::Instance.new
     @bus.configure(backend: :memory)
     @manager = MessageBus::DistributedCache::Manager.new(@bus)
+    @cache1 = cache(cache_name)
+    @cache2 = cache(cache_name)
   end
 
-  after :all do
+  after do
+    @bus.reset!
     @bus.destroy
   end
 
@@ -24,11 +27,6 @@ describe MessageBus::DistributedCache do
     SecureRandom.hex
   end
 
-  before do
-    @cache1 = cache(cache_name)
-    @cache2 = cache(cache_name)
-  end
-
   it 'supports arrays with hashes' do
     c1 = cache("test1")
     c2 = cache("test1")

data/spec/lib/message_bus/multi_process_spec.rb

@@ -13,7 +13,7 @@ describe PUB_SUB_CLASS do
   end
 
   def new_bus
-    PUB_SUB_CLASS.new(MESSAGE_BUS_CONFIG.merge(db: 10))
+    PUB_SUB_CLASS.new(test_config_for_backend(CURRENT_BACKEND).merge(db: 10))
   end
 
   def work_it

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

@@ -12,7 +12,7 @@ describe MessageBus::Rack::Middleware do
 
   before do
     bus = @bus = MessageBus::Instance.new
-    @bus.configure(MESSAGE_BUS_CONFIG)
+    @bus.configure(test_config_for_backend(CURRENT_BACKEND))
     @bus.long_polling_enabled = false
     @bus.base_route = base_route if base_route
 
@@ -26,7 +26,6 @@ describe MessageBus::Rack::Middleware do
 
     @async_middleware = builder.to_app
     @message_bus_middleware = @async_middleware.app
-    @bus.reset!
   end
 
   after do
@@ -143,13 +142,12 @@ describe MessageBus::Rack::Middleware do
   end
 
   describe "diagnostics" do
-    it "should return a 403 if a user attempts to get at the _diagnostics path" do
+    it "should return a 403 if an unauthorized user attempts to get at the _diagnostics path" do
       get "/message-bus/_diagnostics"
       last_response.status.must_equal 403
     end
 
     it "should get a 200 with html for an authorized user" do
-
       def @bus.is_admin_lookup
         proc { |_| true }
       end
@@ -172,7 +170,6 @@ describe MessageBus::Rack::Middleware do
     end
 
     it "should get the script it asks for" do
-
       def @bus.is_admin_lookup
         proc { |_| true }
       end
@@ -181,6 +178,15 @@ describe MessageBus::Rack::Middleware do
       last_response.status.must_equal 200
       last_response.content_type.must_equal "application/javascript;charset=UTF-8"
     end
+
+    it "should return 404 for invalid assets path" do
+      def @bus.is_admin_lookup
+        proc { |_| true }
+      end
+
+      get "/message-bus/_diagnostics/assets/../Gemfile"
+      last_response.status.must_equal 404
+    end
   end
 
   describe "polling" do
@@ -414,6 +420,11 @@ describe MessageBus::Rack::Middleware do
       JSON.parse(last_response.body).first["data"].must_equal('json' => true)
     end
 
+    it "should tell Rack to skip committing the session" do
+      post "/message-bus/1234", {}, { "rack.session.options" => {} }
+      last_request.env["rack.session.options"][:skip].must_equal true
+    end
+
     describe "on_middleware_error handling" do
       it "allows error handling of middleware failures" do
         @bus.on_middleware_error do |_env, err|

data/spec/lib/message_bus_spec.rb

@@ -2,7 +2,6 @@
 
 require_relative '../spec_helper'
 require 'message_bus'
-require 'redis'
 
 describe MessageBus do
   before do
@@ -10,7 +9,7 @@ describe MessageBus do
     @bus.site_id_lookup do
       "magic"
     end
-    @bus.configure(MESSAGE_BUS_CONFIG)
+    @bus.configure(test_config_for_backend(CURRENT_BACKEND))
   end
 
   after do
@@ -98,7 +97,7 @@ describe MessageBus do
     client_ids.must_equal ['a', 'b']
   end
 
-  it "should recover from a redis flush" do
+  it "should recover from a reset" do
     data = nil
     @bus.subscribe("/chuck") do |msg|
       data = msg.data
@@ -162,7 +161,7 @@ describe MessageBus do
     data.must_equal 'norris'
     site_id.must_equal 'magic'
     channel.must_equal '/chuck'
-    user_ids.must_equal [1, 2, 3]
+    user_ids.to_a.must_equal [1, 2, 3]
   end
 
   it "should get global messages if it subscribes to them" do
@@ -201,6 +200,13 @@ describe MessageBus do
     @bus.backlog("/chuck").map { |i| i.data }.to_a.must_equal ['norris', 'foo']
   end
 
+  it "should correctly restrict the backlog size of a channel" do
+    @bus.publish("/chuck", "norris")
+    @bus.publish("/chuck", "foo", max_backlog_size: 1)
+
+    @bus.backlog("/chuck").map { |i| i.data }.to_a.must_equal ['foo']
+  end
+
   it "allows you to look up last_message" do
     @bus.publish("/bob", "dylan")
     @bus.publish("/bob", "marley")
@@ -300,7 +306,7 @@ describe MessageBus do
     end
   end
 
-  it "should support forking properly do" do
+  it "should support forking properly" do
     test_never :memory
 
     data = []
@@ -309,7 +315,7 @@ describe MessageBus do
     end
 
     @bus.publish("/hello", "pre-fork")
-    wait_for(2000) { data.length > 0 }
+    wait_for(2000) { data.length == 1 }
 
     if child = Process.fork
       # The child was forked and we received its PID
@@ -321,6 +327,7 @@ describe MessageBus do
     else
       begin
         @bus.after_fork
+        GC.start
         @bus.publish("/hello", "from-fork")
       ensure
         exit!(0)
@@ -329,7 +336,11 @@ describe MessageBus do
 
     wait_for(2000) { data.length == 3 }
 
-    data.must_equal(["pre-fork", "from-fork", "continuation"])
+    @bus.publish("/hello", "after-fork")
+
+    wait_for(2000) { data.length == 4 }
+
+    data.must_equal(["pre-fork", "from-fork", "continuation", "after-fork"])
   end
 
   describe '#register_client_message_filter' do

data/spec/spec_helper.rb

@@ -11,18 +11,17 @@ require 'minitest/global_expectations'
 
 require_relative "helpers"
 
-backend = (ENV['MESSAGE_BUS_BACKEND'] || :redis).to_sym
-MESSAGE_BUS_CONFIG = test_config_for_backend(backend)
-require "message_bus/backends/#{backend}"
-PUB_SUB_CLASS = MessageBus::BACKENDS.fetch(backend)
-puts "Running with backend: #{backend}"
+CURRENT_BACKEND = (ENV['MESSAGE_BUS_BACKEND'] || :redis).to_sym
+
+require "message_bus/backends/#{CURRENT_BACKEND}"
+PUB_SUB_CLASS = MessageBus::BACKENDS.fetch(CURRENT_BACKEND)
+
+puts "Running with backend: #{CURRENT_BACKEND}"
 
 def test_only(*backends)
-  backend = MESSAGE_BUS_CONFIG[:backend]
-  skip "Test doesn't apply to #{backend}" unless backends.include?(backend)
+  skip "Test doesn't apply to #{CURRENT_BACKEND}" unless backends.include?(CURRENT_BACKEND)
 end
 
 def test_never(*backends)
-  backend = MESSAGE_BUS_CONFIG[:backend]
-  skip "Test doesn't apply to #{backend}" if backends.include?(backend)
+  skip "Test doesn't apply to #{CURRENT_BACKEND}" if backends.include?(CURRENT_BACKEND)
 end

data/spec/support/jasmine-browser.json

@@ -0,0 +1,16 @@
+{
+  "srcDir": "assets",
+  "srcFiles": [
+    "message-bus.js",
+    "message-bus-ajax.js"
+  ],
+  "specDir": "spec/assets",
+  "specFiles": [
+    "message-bus.spec.js"
+  ],
+  "helpers": [
+    "SpecHelper.js"
+  ],
+  "random": true,
+  "browser": "headlessChrome"
+}