message_bus 3.3.6 → 4.0.0

data/lib/message_bus/client.rb

@@ -46,6 +46,9 @@ class MessageBus::Client
     @bus = opts[:message_bus] || MessageBus
     @subscriptions = {}
     @chunks_sent = 0
+    @async_response = nil
+    @io = nil
+    @wrote_headers = false
   end
 
   # @yield executed with a lock on the Client instance
@@ -220,7 +223,7 @@ class MessageBus::Client
 
   private
 
-  # heavily optimised to avoid all uneeded allocations
+  # heavily optimised to avoid all unneeded allocations
   NEWLINE = "\r\n".freeze
   COLON_SPACE = ": ".freeze
   HTTP_11 = "HTTP/1.1 200 OK\r\n".freeze
@@ -261,7 +264,7 @@ class MessageBus::Client
       @wrote_headers = true
     end
 
-    # chunked encoding may be "re-chunked" by proxies, so add a seperator
+    # chunked encoding may be "re-chunked" by proxies, so add a separator
     postfix = NEWLINE + "|" + NEWLINE
     data = data.gsub(postfix, NEWLINE + "||" + NEWLINE)
     chunk_length = data.bytesize + postfix.bytesize
@@ -275,11 +278,7 @@ class MessageBus::Client
       @async_response << postfix
       @async_response << NEWLINE
     else
-      @io.write(chunk_length.to_s(16))
-      @io.write(NEWLINE)
-      @io.write(data)
-      @io.write(postfix)
-      @io.write(NEWLINE)
+      @io.write(chunk_length.to_s(16) << NEWLINE << data << postfix << NEWLINE)
     end
   end
 

data/lib/message_bus/connection_manager.rb

@@ -37,7 +37,7 @@ class MessageBus::ConnectionManager
             rescue
               # pipe may be broken, move on
             end
-            # turns out you can delete from a set while itereating
+            # turns out you can delete from a set while iterating
             remove_client(client) if client.closed?
           end
         end

data/lib/message_bus/distributed_cache.rb

@@ -22,6 +22,7 @@ module MessageBus
         @lock = Mutex.new
         @message_bus = message_bus || MessageBus
         @publish_queue_in_memory = publish_queue_in_memory
+        @app_version = nil
       end
 
       def subscribers
@@ -45,7 +46,8 @@ module MessageBus
             hash = current.hash(message.site_id || DEFAULT_SITE_ID)
 
             case payload["op"]
-            when "set" then hash[payload["key"]] = payload["marshalled"] ? Marshal.load(Base64.decode64(payload["value"])) : payload["value"]
+            # TODO: consider custom marshal support with a restricted set
+            when "set" then hash[payload["key"]] = payload["marshalled"] ? Marshal.load(Base64.decode64(payload["value"])) : payload["value"] # rubocop:disable Security/MarshalLoad
             when "delete" then hash.delete(payload["key"])
             when "clear"  then hash.clear
             end

data/lib/message_bus/http_client.rb

@@ -146,8 +146,8 @@ module MessageBus
     #
     # A last_message_id may be provided.
     #  * -1 will subscribe to all new messages
-    #  * -2 will recieve last message + all new messages
-    #  * -3 will recieve last 2 message + all new messages
+    #  * -2 will receive last message + all new messages
+    #  * -3 will receive last 2 message + all new messages
     #
     # @example Subscribing to a channel with `last_message_id`
     #   client.subscribe("/test", last_message_id: -2) do |payload|

data/lib/message_bus/rack/middleware.rb

@@ -41,7 +41,6 @@ class MessageBus::Rack::Middleware
     @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
@@ -66,6 +65,12 @@ class MessageBus::Rack::Middleware
   private
 
   def handle_request(env)
+    # Prevent simple polling from clobbering the session
+    # See: https://github.com/discourse/message_bus/issues/257
+    if (rack_session_options = env[Rack::RACK_SESSION_OPTIONS])
+      rack_session_options[:skip] = true
+    end
+
     # special debug/test route
     if @bus.allow_broadcast? && env['PATH_INFO'] == @broadcast_route
       parsed = Rack::Request.new(env)
@@ -73,11 +78,6 @@ class MessageBus::Rack::Middleware
       return [200, { "Content-Type" => "text/html" }, ["sent"]]
     end
 
-    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'][@base_route_length..-1].split("/")[0]
     return [404, {}, ["not found"]] unless client_id
 

data/lib/message_bus/rack/thin_ext.rb

@@ -9,6 +9,7 @@ module Thin
 
       def initialize
         @queue = []
+        @body_callback = nil
       end
 
       def call(body)
@@ -38,7 +39,7 @@ module Thin
     end
   end
 
-  # Response whos body is sent asynchronously.
+  # Response which body is sent asynchronously.
   class AsyncResponse
     include Rack::Response::Helpers
 

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "3.3.6"
+  VERSION = "4.0.0"
 end

data/lib/message_bus.rb

@@ -7,9 +7,7 @@ require_relative "message_bus/version"
 require_relative "message_bus/message"
 require_relative "message_bus/client"
 require_relative "message_bus/connection_manager"
-require_relative "message_bus/diagnostics"
 require_relative "message_bus/rack/middleware"
-require_relative "message_bus/rack/diagnostics"
 require_relative "message_bus/timer_thread"
 require_relative "message_bus/codec/base"
 require_relative "message_bus/backends"
@@ -41,21 +39,10 @@ module MessageBus::Implementation
   def initialize
     @config = {}
     @mutex = Synchronizer.new
-  end
-
-  # @param [Boolean] val whether or not to cache static assets for the diagnostics pages
-  # @return [void]
-  def cache_assets=(val)
-    configure(cache_assets: val)
-  end
-
-  # @return [Boolean] whether or not to cache static assets for the diagnostics pages
-  def cache_assets
-    if defined? @config[:cache_assets]
-      @config[:cache_assets]
-    else
-      true
-    end
+    @off = false
+    @destroyed = false
+    @timer_thread = nil
+    @subscriber_thread = nil
   end
 
   # @param [Logger] logger a logger object to be used by the bus
@@ -100,14 +87,14 @@ module MessageBus::Implementation
     configure(long_polling_enabled: val)
   end
 
-  # @param [Integer] val The number of simultanuous clients we can service;
+  # @param [Integer] val The number of simultaneous clients we can service;
   #   will revert to polling if we are out of slots
   # @return [void]
   def max_active_clients=(val)
     configure(max_active_clients: val)
   end
 
-  # @return [Integer] The number of simultanuous clients we can service;
+  # @return [Integer] The number of simultaneous clients we can service;
   #   will revert to polling if we are out of slots. Defaults to 1000 if not
   #   explicitly set.
   def max_active_clients
@@ -275,7 +262,7 @@ module MessageBus::Implementation
   #   set, defaults to false unless we're in Rails test or development mode.
   def allow_broadcast?
     @config[:allow_broadcast] ||=
-      if defined? ::Rails
+      if defined? ::Rails.env
         ::Rails.env.test? || ::Rails.env.development?
       else
         false
@@ -285,7 +272,7 @@ module MessageBus::Implementation
   # @param [MessageBus::Codec::Base] codec used to encode and decode Message payloads
   # @return [void]
   def transport_codec=(codec)
-    configure(trasport_codec: codec)
+    configure(transport_codec: codec)
   end
 
   # @return [MessageBus::Codec::Base] codec used to encode and decode Message payloads
@@ -293,15 +280,20 @@ module MessageBus::Implementation
     @config[:transport_codec] ||= MessageBus::Codec::Json.new
   end
 
-  # @param [MessageBus::Backend::Base] pub_sub a configured backend
+  # @param [MessageBus::Backend::Base] backend_instance A configured backend
   # @return [void]
+  def backend_instance=(backend_instance)
+    configure(backend_instance: backend_instance)
+  end
+
   def reliable_pub_sub=(pub_sub)
-    configure(reliable_pub_sub: pub_sub)
+    logger.warn "MessageBus.reliable_pub_sub= is deprecated, use MessageBus.backend_instance= instead."
+    self.backend_instance = pub_sub
   end
 
   # @return [MessageBus::Backend::Base] the configured backend. If not
   #   explicitly set, will be loaded based on the configuration provided.
-  def reliable_pub_sub
+  def backend_instance
     @mutex.synchronize do
       return nil if @destroyed
 
@@ -309,7 +301,7 @@ module MessageBus::Implementation
       # passed to backend.
       logger
 
-      @config[:reliable_pub_sub] ||= begin
+      @config[:backend_instance] ||= begin
         @config[:backend_options] ||= {}
         require "message_bus/backends/#{backend}"
         MessageBus::BACKENDS[backend].new @config
@@ -317,17 +309,16 @@ module MessageBus::Implementation
     end
   end
 
+  def reliable_pub_sub
+    logger.warn "MessageBus.reliable_pub_sub is deprecated, use MessageBus.backend_instance instead."
+    backend_instance
+  end
+
   # @return [Symbol] the name of the backend implementation configured
   def backend
     @config[:backend] || :redis
   end
 
-  # Enables diagnostics tracking
-  # @return [void]
-  def enable_diagnostics
-    MessageBus::Diagnostics.enable(self)
-  end
-
   # Publishes a message to a channel
   #
   # @param [String] channel the name of the channel to which the message should be published
@@ -338,7 +329,7 @@ module MessageBus::Implementation
   # @option opts [Array<String,Integer>] :group_ids (`nil`) the group IDs to which the message should be available. If nil, available to all.
   # @option opts [String] :site_id (`nil`) the site ID to scope the message to; used for hosting multiple
   #   applications or instances of an application against a single message_bus
-  # @option opts [nil,Integer] :max_backlog_age the longest amount of time a message may live in a backlog before beging removed, in seconds
+  # @option opts [nil,Integer] :max_backlog_age the longest amount of time a message may live in a backlog before being removed, in seconds
   # @option opts [nil,Integer] :max_backlog_size the largest permitted size (number of messages) for the channel backlog; beyond this capacity, old messages will be dropped
   #
   # @return [Integer] the channel-specific ID the message was given
@@ -394,7 +385,7 @@ module MessageBus::Implementation
     end
 
     encoded_channel_name = encode_channel_name(channel, site_id)
-    reliable_pub_sub.publish(encoded_channel_name, encoded_data, channel_opts)
+    backend_instance.publish(encoded_channel_name, encoded_data, channel_opts)
   end
 
   # Subscribe to messages. Each message will be delivered by yielding to the
@@ -410,9 +401,9 @@ module MessageBus::Implementation
   # @return [void]
   def blocking_subscribe(channel = nil, &blk)
     if channel
-      reliable_pub_sub.subscribe(encode_channel_name(channel), &blk)
+      backend_instance.subscribe(encode_channel_name(channel), &blk)
     else
-      reliable_pub_sub.global_subscribe(&blk)
+      backend_instance.global_subscribe(&blk)
     end
   end
 
@@ -491,9 +482,9 @@ module MessageBus::Implementation
   def backlog(channel = nil, last_id = nil, site_id = nil)
     old =
       if channel
-        reliable_pub_sub.backlog(encode_channel_name(channel, site_id), last_id)
+        backend_instance.backlog(encode_channel_name(channel, site_id), last_id)
       else
-        reliable_pub_sub.global_backlog(last_id)
+        backend_instance.global_backlog(last_id)
       end
 
     old.each do |m|
@@ -509,7 +500,7 @@ module MessageBus::Implementation
   #
   # @return [Integer] the channel-specific ID of the last message published to the given channel
   def last_id(channel, site_id = nil)
-    reliable_pub_sub.last_id(encode_channel_name(channel, site_id))
+    backend_instance.last_id(encode_channel_name(channel, site_id))
   end
 
   # Get the last message published on a channel
@@ -527,12 +518,13 @@ module MessageBus::Implementation
   end
 
   # Stops listening for publications and stops executing scheduled tasks.
-  # Mostly used in tests to detroy entire bus.
+  # Mostly used in tests to destroy entire bus.
   # @return [void]
   def destroy
     return if @destroyed
 
-    reliable_pub_sub.global_unsubscribe
+    backend_instance.global_unsubscribe
+    backend_instance.destroy
 
     @mutex.synchronize do
       return if @destroyed
@@ -550,7 +542,7 @@ module MessageBus::Implementation
   #   scheduled tasks.
   # @return [void]
   def after_fork
-    reliable_pub_sub.after_fork
+    backend_instance.after_fork
     ensure_subscriber_thread
     # will ensure timer is running
     timer.queue {}
@@ -559,12 +551,12 @@ module MessageBus::Implementation
   # @return [Boolean] whether or not the server is actively listening for
   #   publications on the bus
   def listening?
-    @subscriber_thread && @subscriber_thread.alive?
+    @subscriber_thread&.alive?
   end
 
   # (see MessageBus::Backend::Base#reset!)
   def reset!
-    reliable_pub_sub.reset! if reliable_pub_sub
+    backend_instance.reset! if backend_instance
   end
 
   # @return [MessageBus::TimerThread] the timer thread used for triggering
@@ -692,12 +684,6 @@ module MessageBus::Implementation
     @subscriptions[site_id][channel] << blk
     ensure_subscriber_thread
 
-    attempts = 100
-    while attempts > 0 && !reliable_pub_sub.subscribed
-      sleep 0.001
-      attempts -= 1
-    end
-
     raise MessageBus::BusDestroyed if @destroyed
 
     blk
@@ -715,10 +701,17 @@ module MessageBus::Implementation
 
   def ensure_subscriber_thread
     @mutex.synchronize do
-      return if (@subscriber_thread && @subscriber_thread.alive?) || @destroyed
+      return if @destroyed
+      next if @subscriber_thread&.alive?
 
       @subscriber_thread = new_subscriber_thread
     end
+
+    attempts = 100
+    while attempts > 0 && !backend_instance.subscribed
+      sleep 0.001
+      attempts -= 1
+    end
   end
 
   MIN_KEEPALIVE = 20
@@ -739,34 +732,11 @@ module MessageBus::Implementation
       if !@destroyed && thread.alive? && keepalive_interval > MIN_KEEPALIVE
 
         publish("/__mb_keepalive__/", Process.pid, user_ids: [-1])
-        # going for x3 keepalives missed for a restart, need to ensure this only very rarely happens
-        # note: after_fork will sort out a bad @last_message date, but thread will be dead anyway
         if (Time.now - (@last_message || Time.now)) > keepalive_interval * 3
-          logger.warn "Global messages on #{Process.pid} timed out, restarting process"
-          # No other clean way to remove this thread, its listening on a socket
-          #   no data is arriving
-          #
-          # In production we see this kind of situation ... sometimes ... when there is
-          # a VRRP failover, or weird networking condition
-          pid = Process.pid
-
-          # do the best we can to terminate self cleanly
-          fork do
-            Process.kill('TERM', pid)
-            sleep 10
-            begin
-              Process.kill('KILL', pid)
-            rescue Errno::ESRCH
-              logger.warn "#{Process.pid} successfully terminated by `TERM` signal."
-            end
-          end
-
-          sleep 10
-          Process.kill('KILL', pid)
-
-        else
-          timer.queue(keepalive_interval, &blk) if keepalive_interval > MIN_KEEPALIVE
+          logger.warn "Global messages on #{Process.pid} timed out, message bus is no longer functioning correctly"
         end
+
+        timer.queue(keepalive_interval, &blk) if keepalive_interval > MIN_KEEPALIVE
       end
     end
 
@@ -778,7 +748,7 @@ module MessageBus::Implementation
   def global_subscribe_thread
     # pretend we just got a message
     @last_message = Time.now
-    reliable_pub_sub.global_subscribe do |msg|
+    backend_instance.global_subscribe do |msg|
       begin
         @last_message = Time.now
         decode_message!(msg)

data/message_bus.gemspec

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# -*- encoding: utf-8 -*-
 
 require File.expand_path('../lib/message_bus/version', __FILE__)
 
@@ -8,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["sam.saffron@gmail.com"]
   gem.description   = %q{A message bus for rack}
   gem.summary       = %q{}
-  gem.homepage      = "https://github.com/SamSaffron/message_bus"
+  gem.homepage      = "https://github.com/discourse/message_bus"
   gem.license       = "MIT"
   gem.files         = `git ls-files`.split($\) +
                       ["vendor/assets/javascripts/message-bus.js", "vendor/assets/javascripts/message-bus-ajax.js"]
@@ -17,8 +16,27 @@ Gem::Specification.new do |gem|
   gem.name          = "message_bus"
   gem.require_paths = ["lib"]
   gem.version       = MessageBus::VERSION
-  gem.required_ruby_version = ">= 2.4.0"
+  gem.required_ruby_version = ">= 2.6.0"
+
   gem.add_runtime_dependency 'rack', '>= 1.1.3'
+
+  # Optional runtime dependencies
   gem.add_development_dependency 'redis'
   gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'concurrent-ruby' # for distributed-cache
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-hooks'
+  gem.add_development_dependency 'minitest-global_expectations'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'http_parser.rb'
+  gem.add_development_dependency 'thin'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'puma'
+  gem.add_development_dependency 'm'
+  gem.add_development_dependency 'byebug'
+  gem.add_development_dependency 'oj'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rubocop-discourse'
+  gem.add_development_dependency 'rubocop-rspec'
 end