message_bus 2.2.3 → 3.3.0

data/examples/bench/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 
 require 'message_bus'

data/examples/bench/puma.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 on_worker_boot do
   MessageBus.after_fork

data/examples/bench/unicorn.conf.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 after_fork do |_server, _worker|
   MessageBus.after_fork

data/examples/chat/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 gem 'puma'
 gem 'redis'
 gem 'sinatra'

data/examples/chat/chat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
 require 'message_bus'
 require 'sinatra'

data/examples/chat/config.ru

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require './chat'
 run Chat

data/examples/diagnostics/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'message_bus', path: '../..'

data/examples/diagnostics/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 
 MessageBus.configure(backend: :redis, url: ENV['REDISURL'])

data/examples/minimal/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'message_bus'

data/examples/minimal/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 
 # MessageBus.long_polling_interval = 1000 * 2

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/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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # MessageBus diagnostics are used for troubleshooting the bus and optimising its configuration
 # @see MessageBus::Rack::Diagnostics
 class MessageBus::Diagnostics
@@ -14,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/em_ext.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EM
   def self.reactor_pid
     @reactor_pid

data/lib/message_bus/http_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'securerandom'
 require 'net/http'
 require 'json'
@@ -245,7 +246,7 @@ module MessageBus
       request.body = poll_payload
 
       if @enable_long_polling
-        buffer = ''
+        buffer = +""
 
         http.request(request) do |response|
           response.read_body do |chunk|

data/lib/message_bus/http_client/channel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MessageBus
   class HTTPClient
     # @private

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.3"
+  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/assets/support/jasmine_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Jasmine.configure do |_config|
   # patch for travis
   if ENV['TRAVIS']

data/spec/fixtures/test/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'message_bus'

data/spec/fixtures/test/config.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'message_bus'
 
 MessageBus.config[:backend] = :memory

data/spec/helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def wait_for(timeout_milliseconds = 2000)
   timeout = (timeout_milliseconds + 0.0) / 1000
   finish = Time.now + timeout

data/spec/integration/http_client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require 'message_bus/http_client'
 

data/spec/lib/fake_async_middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'http/parser'
 class FakeAsyncMiddleware
   def initialize(app, config = {})
@@ -53,7 +54,7 @@ class FakeAsyncMiddleware
 
   def translate_io_result(io)
     data = io.string
-    body = ""
+    body = +""
 
     parser = Http::Parser.new
     parser.on_body = proc { |chunk| body << chunk }
@@ -112,7 +113,7 @@ class FakeAsyncMiddleware
         # more judo with deferrable body, at this point we just have headers
         r[2].callback do
           # even more judo cause rack test does not call each like the spec says
-          body = ""
+          body = +""
           r[2].each do |m|
             body << m
           end

data/spec/lib/message_bus/assets/asset_encoding_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../../../spec_helper'
 asset_directory = File.expand_path('../../../../../assets', __FILE__)
 asset_file_paths = Dir.glob(File.join(asset_directory, 'message-bus.js'))

data/spec/lib/message_bus/backend_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 

data/spec/lib/message_bus/client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 
@@ -83,7 +85,7 @@ describe MessageBus::Client do
 
       data[-5..-1].must_equal "0\r\n\r\n"
 
-      _, _, chunks = http_parse("HTTP/1.1 200 OK\r\n\r\n" << data)
+      _, _, chunks = http_parse(+"HTTP/1.1 200 OK\r\n\r\n" << data)
 
       chunks.length.must_equal 2
 
@@ -167,36 +169,219 @@ 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
+    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.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
+        @client.client_id = "3"
+        @client.allowed?(@message).must_equal false
 
-    describe "targetted at group" do
-      before do
-        @message = MessageBus::Message.new(1, 2, '/test', 'hello')
-        @message.group_ids = [1, 2, 3]
+        @message.client_ids = []
+
+        @client.client_id = "3"
+        @client.allowed?(@message).must_equal true
+
+        @message.client_ids = nil
+
+        @client.client_id = "3"
+        @client.allowed?(@message).must_equal true
       end
 
-      it "denies users that are not members of group" do
-        @client.group_ids = [77, 0, 10]
-        @client.allowed?(@message).must_equal false
+      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
 
-      it "allows users that are members of group" do
-        @client.group_ids = [1, 2, 3]
-        @client.allowed?(@message).must_equal true
+      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
 
-      it "allows all users if groups not set" do
-        @message.group_ids = nil
-        @client.group_ids = [77, 0, 10]
-        @client.allowed?(@message).must_equal true
+      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