message_bus 3.3.6 → 4.0.0

data/package.json

@@ -1,18 +1,18 @@
 {
   "name": "message-bus-client",
-  "version": "3.3.5",
+  "version": "0.0.0-version-placeholder",
   "description": "A message bus client in Javascript",
   "main": "assets/message-bus.js",
-  "keywords": "es6, modules",
+  "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"
-  },
+  "repository": "https://github.com/discourse/message_bus",
   "author": "Sam Saffron, Robin Ward",
   "license": "MIT",
   "bugs": {
@@ -20,6 +20,8 @@
   },
   "homepage": "https://github.com/discourse/message_bus#readme",
   "devDependencies": {
-    "eslint": "^7.27.0"
+    "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,20 +1,36 @@
 # 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']
   when :postgres
-    config[:backend_options] = { host: ENV['PGHOST'], user: ENV['PGUSER'] || ENV['USER'], password: ENV['PGPASSWORD'], dbname: ENV['PGDATABASE'] || 'message_bus_test' }
+    config[:backend_options] = {
+      host: ENV['PGHOST'],
+      user: ENV['PGUSER'] || ENV['USER'],
+      password: ENV['PGPASSWORD'],
+      dbname: ENV['PGDATABASE'] || 'message_bus_test'
+    }
   end
   config
 end

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

@@ -7,6 +7,7 @@ class FakeAsyncMiddleware
     @simulate_thin_async = false
     @simulate_hijack = false
     @in_async = false
+    @allow_chunked = false
   end
 
   def app

data/spec/lib/message_bus/backend_spec.rb

@@ -3,19 +3,19 @@
 require_relative '../../spec_helper'
 require 'message_bus'
 
-describe PUB_SUB_CLASS do
-  def new_test_bus
-    PUB_SUB_CLASS.new(MESSAGE_BUS_CONFIG)
+describe BACKEND_CLASS do
+  before do
+    @bus = BACKEND_CLASS.new(test_config_for_backend(CURRENT_BACKEND))
   end
 
-  before do
-    @bus = new_test_bus
+  after do
     @bus.reset!
+    @bus.destroy
   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
 
@@ -30,7 +30,7 @@ describe PUB_SUB_CLASS do
   end
 
   it "should initialize with max_backlog_size" do
-    PUB_SUB_CLASS.new({}, 2000).max_backlog_size.must_equal 2000
+    BACKEND_CLASS.new({}, 2000).max_backlog_size.must_equal 2000
   end
 
   it "should truncate channels correctly" do
@@ -77,7 +77,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 +91,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 +106,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 +130,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 +158,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 +173,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 +191,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 +218,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 +246,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,11 +11,12 @@ 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
 
     after do
+      @client.close
       @bus.reset!
       @bus.destroy
     end
@@ -98,7 +99,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 +108,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 +191,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 +242,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 +292,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/connection_manager_spec.rb

@@ -6,6 +6,10 @@ require 'message_bus'
 class FakeAsync
   attr_accessor :cleanup_timer
 
+  def initialize
+    @sent = nil
+  end
+
   def <<(val)
     sleep 0.01 # simulate IO
     @sent ||= +""

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

@@ -3,7 +3,7 @@
 require_relative '../../spec_helper'
 require 'message_bus'
 
-describe PUB_SUB_CLASS do
+describe BACKEND_CLASS do
   def self.error!
     @error = true
   end
@@ -13,18 +13,20 @@ describe PUB_SUB_CLASS do
   end
 
   def new_bus
-    PUB_SUB_CLASS.new(MESSAGE_BUS_CONFIG.merge(db: 10))
+    BACKEND_CLASS.new(test_config_for_backend(CURRENT_BACKEND).merge(db: 10))
   end
 
   def work_it
     bus = new_bus
-    $stdout.reopen("/dev/null", "w")
-    $stderr.reopen("/dev/null", "w")
-    # subscribe blocks, so we need a new bus to transmit
-    new_bus.subscribe("/echo", 0) do |msg|
-      bus.publish("/response", "#{msg.data}-#{Process.pid.to_s}")
+    bus.subscribe("/echo", 0) do |msg|
+      if msg.data == "done"
+        bus.global_unsubscribe
+      else
+        bus.publish("/response", "#{msg.data}-#{Process.pid.to_s}")
+      end
     end
   ensure
+    bus.destroy
     exit!(0)
   end
 
@@ -44,12 +46,14 @@ describe PUB_SUB_CLASS do
       test_never :memory
       skip("previous error") if self.class.error?
       GC.start
-      new_bus.reset!
+      bus = new_bus
+      bus.reset!
+
       begin
         pids = (1..10).map { spawn_child }
         expected_responses = pids.map { |x| (0...10).map { |i| "0#{i}-#{x}" } }.flatten
         unexpected_responses = []
-        bus = new_bus
+
         t = Thread.new do
           bus.subscribe("/response", 0) do |msg|
             if expected_responses.include?(msg.data)
@@ -59,10 +63,14 @@ describe PUB_SUB_CLASS do
             end
           end
         end
+
         10.times { |i| bus.publish("/echo", "0#{i}") }
-        wait_for 4000 do
+
+        wait_for(2000) do
           expected_responses.empty?
         end
+
+        bus.publish("/echo", "done")
         bus.global_unsubscribe
         t.join
 
@@ -81,7 +89,10 @@ describe PUB_SUB_CLASS do
             Process.wait(pid)
           end
         end
+
         bus.global_unsubscribe
+        bus.reset!
+        bus.destroy
       end
     end
   end

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
@@ -84,7 +83,7 @@ describe MessageBus::Rack::Middleware do
         { "FOO" => "BAR" }
       end
 
-      Thread.new do
+      t = Thread.new do
         wait_for(2000) { middleware.in_async? }
         bus.publish "/foo", "םוֹלשָׁ"
       end
@@ -97,6 +96,7 @@ describe MessageBus::Rack::Middleware do
       parsed[0]["data"].must_equal "םוֹלשָׁ"
 
       last_response.headers["FOO"].must_equal "BAR"
+      t.join
     end
 
     it "should timeout within its alloted slot" do
@@ -142,47 +142,6 @@ describe MessageBus::Rack::Middleware do
     end
   end
 
-  describe "diagnostics" do
-    it "should return a 403 if a 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
-
-      get "/message-bus/_diagnostics"
-      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
-        proc { |_| true }
-      end
-
-      get "/message-bus/_diagnostics/assets/message-bus.js"
-      last_response.status.must_equal 200
-      last_response.content_type.must_equal "application/javascript;charset=UTF-8"
-    end
-  end
-
   describe "polling" do
     before do
       @bus.long_polling_enabled = false
@@ -414,6 +373,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/timer_thread_spec.rb

@@ -52,10 +52,6 @@ describe MessageBus::TimerThread do
   it "should call the error callback if something goes wrong" do
     error = nil
 
-    @timer.queue do
-      boom
-    end
-
     @timer.on_error do |e|
       error = e
     end
@@ -64,7 +60,7 @@ describe MessageBus::TimerThread do
       boom
     end
 
-    wait_for(10) do
+    wait_for(100) do
       error
     end