RubyGems - message_bus - Versions diffs - 2.1.6 → 2.2.0.pre - Mend

message_bus 2.1.6 → 2.2.0.pre

Potentially problematic release.

This version of message_bus might be problematic. Click here for more details.

Files changed (49) hide show

checksums.yaml +4 -4
data/.rubocop.yml +13 -92
data/.rubocop_todo.yml +659 -0
data/.travis.yml +1 -1
data/CHANGELOG +61 -0
data/Dockerfile +18 -0
data/Gemfile +3 -1
data/Guardfile +0 -1
data/README.md +188 -101
data/Rakefile +12 -1
data/assets/message-bus.js +1 -1
data/docker-compose.yml +46 -0
data/examples/bench/config.ru +8 -9
data/examples/bench/unicorn.conf.rb +1 -1
data/examples/chat/chat.rb +150 -153
data/examples/minimal/config.ru +2 -3
data/lib/message_bus.rb +224 -36
data/lib/message_bus/backends.rb +7 -0
data/lib/message_bus/backends/base.rb +184 -0
data/lib/message_bus/backends/memory.rb +304 -226
data/lib/message_bus/backends/postgres.rb +359 -318
data/lib/message_bus/backends/redis.rb +380 -337
data/lib/message_bus/client.rb +99 -41
data/lib/message_bus/connection_manager.rb +29 -21
data/lib/message_bus/diagnostics.rb +50 -41
data/lib/message_bus/distributed_cache.rb +5 -7
data/lib/message_bus/message.rb +2 -2
data/lib/message_bus/rack/diagnostics.rb +65 -55
data/lib/message_bus/rack/middleware.rb +64 -44
data/lib/message_bus/rack/thin_ext.rb +13 -9
data/lib/message_bus/rails/railtie.rb +2 -0
data/lib/message_bus/timer_thread.rb +2 -2
data/lib/message_bus/version.rb +2 -1
data/message_bus.gemspec +3 -2
data/spec/assets/support/jasmine_helper.rb +1 -1
data/spec/lib/fake_async_middleware.rb +1 -6
data/spec/lib/message_bus/assets/asset_encoding_spec.rb +3 -3
data/spec/lib/message_bus/backend_spec.rb +409 -0
data/spec/lib/message_bus/client_spec.rb +8 -11
data/spec/lib/message_bus/connection_manager_spec.rb +8 -14
data/spec/lib/message_bus/distributed_cache_spec.rb +0 -4
data/spec/lib/message_bus/multi_process_spec.rb +6 -7
data/spec/lib/message_bus/rack/middleware_spec.rb +47 -43
data/spec/lib/message_bus/timer_thread_spec.rb +0 -2
data/spec/lib/message_bus_spec.rb +59 -43
data/spec/spec_helper.rb +16 -4
metadata +12 -9
data/spec/lib/message_bus/backends/postgres_spec.rb +0 -221
data/spec/lib/message_bus/backends/redis_spec.rb +0 -271

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-class MessageBus::Message < Struct.new(:global_id, :message_id, :channel , :data)
+# Represents a published message and its encoding for persistence.
+class MessageBus::Message < Struct.new(:global_id, :message_id, :channel, :data)
   attr_accessor :site_id, :user_ids, :group_ids, :client_ids
   def self.decode(encoded)

data/lib/message_bus/rack/diagnostics.rb CHANGED

@@ -1,68 +1,21 @@
 # frozen_string_literal: true
 module MessageBus::Rack; end
+# Accepts requests from clients interested in using diagnostics functionality
+# @see MessageBus::Diagnostics
 class MessageBus::Rack::Diagnostics
+  # @param [Proc] app the rack app
+  # @param [Hash] config
+  # @option config [MessageBus::Instance] :message_bus (`MessageBus`) a specific instance of message_bus
   def initialize(app, config = {})
     @app = app
     @bus = config[:message_bus] || MessageBus
   end
-  def js_asset(name)
-    return generate_script_tag(name) unless @bus.cache_assets
-    @@asset_cache ||= {}
-    @@asset_cache[name] ||= generate_script_tag(name)
-    @@asset_cache[name]
-  end
-  def  generate_script_tag(name)
-    "<script src='/message-bus/_diagnostics/assets/#{name}?#{file_hash(name)}' type='text/javascript'></script>"
-  end
-  def file_hash(asset)
-    require 'digest/sha1'
-    Digest::SHA1.hexdigest(asset_contents(asset))
-  end
-  def asset_contents(asset)
-    File.open(asset_path(asset)).read
-  end
-  def asset_path(asset)
-    File.expand_path("../../../../assets/#{asset}", __FILE__)
-  end
-  def index
-    html = <<HTML
-<!DOCTYPE html>
-<html>
-  <head>
-  </head>
-  <body>
-    <div id="app"></div>
-    #{js_asset "jquery-1.8.2.js"}
-    #{js_asset "handlebars.js"}
-    #{js_asset "ember.js"}
-    #{js_asset "message-bus.js"}
-    #{js_asset "application.handlebars"}
-    #{js_asset "index.handlebars"}
-    #{js_asset "application.js"}
-  </body>
-</html>
-HTML
-    return [200, { "content-type" => "text/html;" }, [html]]
-  end
-  def translate_handlebars(name, content)
-    "Ember.TEMPLATES['#{name}'] = Ember.Handlebars.compile(#{indent(content).inspect});"
-  end
-  # from ember-rails
-  def indent(string)
-    string.gsub(/$(.)/m, "\\1  ").strip
-  end
+  # 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'
     route = env['PATH_INFO'].split('/message-bus/_diagnostics')[1]
@@ -97,4 +50,61 @@ HTML
     return [404, {}, ['not found']]
   end
+  private
+  def js_asset(name)
+    return generate_script_tag(name) unless @bus.cache_assets
+    @@asset_cache ||= {}
+    @@asset_cache[name] ||= generate_script_tag(name)
+    @@asset_cache[name]
+  end
+  def generate_script_tag(name)
+    "<script src='/message-bus/_diagnostics/assets/#{name}?#{file_hash(name)}' type='text/javascript'></script>"
+  end
+  def file_hash(asset)
+    require 'digest/sha1'
+    Digest::SHA1.hexdigest(asset_contents(asset))
+  end
+  def asset_contents(asset)
+    File.open(asset_path(asset)).read
+  end
+  def asset_path(asset)
+    File.expand_path("../../../../assets/#{asset}", __FILE__)
+  end
+  def index
+    html = <<~HTML
+      <!DOCTYPE html>
+      <html>
+        <head>
+        </head>
+        <body>
+          <div id="app"></div>
+          #{js_asset "jquery-1.8.2.js"}
+          #{js_asset "handlebars.js"}
+          #{js_asset "ember.js"}
+          #{js_asset "message-bus.js"}
+          #{js_asset "application.handlebars"}
+          #{js_asset "index.handlebars"}
+          #{js_asset "application.js"}
+        </body>
+      </html>
+    HTML
+    return [200, { "content-type" => "text/html;" }, [html]]
+  end
+  def translate_handlebars(name, content)
+    "Ember.TEMPLATES['#{name}'] = Ember.Handlebars.compile(#{indent(content).inspect});"
+  end
+  # from ember-rails
+  def indent(string)
+    string.gsub(/$(.)/m, "\\1  ").strip
+  end
 end

data/lib/message_bus/rack/middleware.rb CHANGED

@@ -1,44 +1,49 @@
 # frozen_string_literal: true
 require 'json'
 # our little message bus, accepts long polling and polling
 module MessageBus::Rack; end
+# Accepts requests from subscribers, validates and authenticates them,
+# delivers existing messages from the backlog and informs a
+# `MessageBus::ConnectionManager` of a connection which is remaining open.
 class MessageBus::Rack::Middleware
-  def start_listener
-    unless @started_listener
-      thin = defined?(Thin::Server) && ObjectSpace.each_object(Thin::Server).to_a.first
-      thin_running = thin && thin.running?
-      @subscription = @bus.subscribe do |msg|
-        run = proc do
-          begin
-            @connection_manager.notify_clients(msg) if @connection_manager
-          rescue
-            @bus.logger.warn "Failed to notify clients: #{$!} #{$!.backtrace}"
-          end
-        end
-        if thin_running
-          EM.next_tick(&run)
-        else
-          @bus.timer.queue(&run)
-        end
-        @started_listener = true
-      end
-    end
+  # @param [Array<MessageBus::Message>] backlog a list of messages for delivery
+  # @return [JSON] a JSON representation of the backlog, compliant with the
+  #   subscriber API specification
+  def self.backlog_to_json(backlog)
+    m = backlog.map do |msg|
+      {
+        global_id: msg.global_id,
+        message_id: msg.message_id,
+        channel: msg.channel,
+        data: msg.data
+      }
+    end.to_a
+    JSON.dump(m)
   end
+  # @return [Boolean] whether the message listener (subscriber) is started or not)
+  attr_reader :started_listener
+  # Sets up the middleware to receive subscriber client requests and begins
+  # listening for messages published on the bus for re-distribution (unless
+  # the bus is disabled).
+  #
+  # @param [Proc] app the rack app
+  # @param [Hash] config
+  # @option config [MessageBus::Instance] :message_bus (`MessageBus`) a specific instance of message_bus
   def initialize(app, config = {})
     @app = app
     @bus = config[:message_bus] || MessageBus
     @connection_manager = MessageBus::ConnectionManager.new(@bus)
-    self.start_listener
+    @started_listener = false
+    start_listener unless @bus.off?
   end
+  # Stops listening for messages on the bus
+  # @return [void]
   def stop_listener
     if @subscription
       @bus.unsubscribe(&@subscription)
@@ -46,20 +51,9 @@ class MessageBus::Rack::Middleware
     end
   end
-  def self.backlog_to_json(backlog)
-    m = backlog.map do |msg|
-      {
-        global_id: msg.global_id,
-        message_id: msg.message_id,
-        channel: msg.channel,
-        data: msg.data
-      }
-    end.to_a
-    JSON.dump(m)
-  end
+  # 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\//
     # special debug/test route
@@ -136,9 +130,9 @@ class MessageBus::Rack::Middleware
     backlog = client.backlog
     if backlog.length > 0 && !allow_chunked
-      client.cancel
+      client.close
       @bus.logger.debug "Delivering backlog #{backlog} to client #{client_id} for user #{user_id}"
-      [200, headers, [self.class.backlog_to_json(backlog)] ]
+      [200, headers, [self.class.backlog_to_json(backlog)]]
     elsif long_polling && env['rack.hijack'] && @bus.rack_hijack_enabled?
       io = env['rack.hijack'].call
       # TODO disable client till deliver backlog is called
@@ -182,7 +176,6 @@ class MessageBus::Rack::Middleware
     else
       [200, headers, [self.class.backlog_to_json(backlog)]]
     end
   rescue => e
     if @bus.on_middleware_error && result = @bus.on_middleware_error.call(env, e)
       result
@@ -191,6 +184,8 @@ class MessageBus::Rack::Middleware
     end
   end
+  private
   def close_db_connection!
     # IMPORTANT
     # ConnectionManagement in Rails puts a BodyProxy around stuff
@@ -206,12 +201,37 @@ class MessageBus::Rack::Middleware
     client.cleanup_timer = @bus.timer.queue(@bus.long_polling_interval.to_f / 1000) {
       begin
-        client.cleanup_timer = nil
-        client.ensure_closed!
+        client.close
         @connection_manager.remove_client(client)
       rescue
         @bus.logger.warn "Failed to clean up client properly: #{$!} #{$!.backtrace}"
       end
     }
   end
+  def start_listener
+    unless @started_listener
+      thin = defined?(Thin::Server) && ObjectSpace.each_object(Thin::Server).to_a.first
+      thin_running = thin && thin.running?
+      @subscription = @bus.subscribe do |msg|
+        run = proc do
+          begin
+            @connection_manager.notify_clients(msg) if @connection_manager
+          rescue
+            @bus.logger.warn "Failed to notify clients: #{$!} #{$!.backtrace}"
+          end
+        end
+        if thin_running
+          EM.next_tick(&run)
+        else
+          @bus.timer.queue(&run)
+        end
+        @started_listener = true
+      end
+    end
+  end
 end

data/lib/message_bus/rack/thin_ext.rb CHANGED

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 # there is also another in cramp this is from https://github.com/macournoyer/thin_async/blob/master/lib/thin/async.rb
 module Thin
   unless defined?(DeferrableBody)
@@ -21,16 +22,19 @@ module Thin
       end
       private
-        def schedule_dequeue
-          return unless @body_callback
-          ::EM.next_tick do
-            next unless body = @queue.shift
-            body.each do |chunk|
-              @body_callback.call(chunk)
-            end
-            schedule_dequeue unless @queue.empty?
+      def schedule_dequeue
+        return unless @body_callback
+        ::EM.next_tick do
+          next unless body = @queue.shift
+          body.each do |chunk|
+            @body_callback.call(chunk)
           end
+          schedule_dequeue unless @queue.empty?
         end
+      end
     end
   end
@@ -51,6 +55,7 @@ module Thin
     def send_headers
       return if @headers_sent
       @callback.call [@status, @headers, @body]
       @headers_sent = true
     end
@@ -67,6 +72,5 @@ module Thin
       send_headers
       ::EM.next_tick { @body.succeed }
     end
   end
 end

data/lib/message_bus/rails/railtie.rb CHANGED

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 module MessageBus; module Rails; end; end
 # rails engine for asset pipeline
@@ -25,6 +26,7 @@ class MessageBus::Rails::Railtie < ::Rails::Railtie
   def api_only?(config)
     return false unless config.respond_to?(:api_only)
     config.api_only
   end

data/lib/message_bus/timer_thread.rb CHANGED

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-class MessageBus::TimerThread
+class MessageBus::TimerThread
   attr_reader :jobs
   class Cancelable
@@ -16,6 +16,7 @@ class MessageBus::TimerThread
     def initialize(job)
       @job = job
     end
     def cancel
       @job[1] = NOOP
     end
@@ -123,5 +124,4 @@ class MessageBus::TimerThread
       end
     end
   end
 end

data/lib/message_bus/version.rb CHANGED

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 module MessageBus
-  VERSION = "2.1.6"
+  VERSION = "2.2.0.pre"
 end

data/message_bus.gemspec CHANGED

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/message_bus/version', __FILE__)
 Gem::Specification.new do |gem|
@@ -10,13 +11,13 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/SamSaffron/message_bus"
   gem.license       = "MIT"
   gem.files         = `git ls-files`.split($\) +
-    ["vendor/assets/javascripts/message-bus.js", "vendor/assets/javascripts/message-bus-ajax.js"]
+                      ["vendor/assets/javascripts/message-bus.js", "vendor/assets/javascripts/message-bus-ajax.js"]
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "message_bus"
   gem.require_paths = ["lib"]
   gem.version       = MessageBus::VERSION
-  gem.required_ruby_version = ">= 2.2.0"
+  gem.required_ruby_version = ">= 2.3.0"
   gem.add_runtime_dependency 'rack', '>= 1.1.3'
   gem.add_development_dependency 'redis'
   gem.add_development_dependency 'pg'

data/spec/assets/support/jasmine_helper.rb CHANGED

@@ -1,4 +1,4 @@
-Jasmine.configure do |config|
+Jasmine.configure do |_config|
   # patch for travis
   if ENV['TRAVIS']
     module ::Phantomjs

data/spec/lib/fake_async_middleware.rb CHANGED

@@ -1,7 +1,6 @@
 require 'http/parser'
 class FakeAsyncMiddleware
-  def initialize(app,config={})
+  def initialize(app, config = {})
     @app = app
     @bus = config[:message_bus] || MessageBus
     @simulate_thin_async = false
@@ -31,7 +30,6 @@ class FakeAsyncMiddleware
     @in_async
   end
   def simulate_thin_async?
     @simulate_thin_async && @bus.long_polling_enabled?
   end
@@ -64,7 +62,6 @@ class FakeAsyncMiddleware
     [parser.status_code, parser.headers, [body]]
   end
   def call_rack_hijack(env)
     # this is not to spec, the spec actually return, but here we will simply simulate and block
     result = nil
@@ -106,7 +103,6 @@ class FakeAsyncMiddleware
     @in_async = false
     result || [500, {}, ['timeout']]
   end
   def call_thin_async(env)
@@ -147,4 +143,3 @@ class FakeAsyncMiddleware
     result || [500, {}, ['timeout']]
   end
 end