message_bus 2.2.3 → 3.3.1

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

data/spec/lib/message_bus/connection_manager_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../spec_helper'
 require 'message_bus'
 
@@ -6,7 +8,7 @@ class FakeAsync
 
   def <<(val)
     sleep 0.01 # simulate IO
-    @sent ||= ""
+    @sent ||= +""
     @sent << val
   end
 

data/spec/lib/message_bus/distributed_cache_spec.rb

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

data/spec/lib/message_bus/multi_process_spec.rb

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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # coding: utf-8
 
 require_relative '../../../spec_helper'
@@ -7,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 {
@@ -43,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
@@ -140,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
@@ -242,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/timer_thread_spec.rb

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

data/spec/lib/message_bus_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require 'message_bus'
 require 'redis'
@@ -35,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")
 
@@ -290,4 +309,19 @@ describe MessageBus do
 
     data.must_equal(["pre-fork", "from-fork", "continuation"])
   end
+
+  describe '#register_client_message_filter' do
+    it 'should register the message filter correctly' do
+      @bus.register_client_message_filter('/test')
+
+      @bus.client_message_filters.must_equal([])
+
+      @bus.register_client_message_filter('/test') { puts "hello world" }
+
+      channel, blk = @bus.client_message_filters[0]
+
+      blk.must_respond_to(:call)
+      channel.must_equal('/test')
+    end
+  end
 end