message_bus 3.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb9967cb1c20e9a7c2f02ea36bfd54a3a13dac00ef44dcd0f27f7f878504ee2c
-  data.tar.gz: 6ad58769e032468f20411b507aab0c7eaf72e09ab904641f1f635a5061c42c3c
+  metadata.gz: 65630299cab9aae5df5b4f3131043d42063575978d5a83e9267436bed2b7d729
+  data.tar.gz: 2bd69d120552b01ae82c73a775d065c23575ac623016d2bd2ac25a5ebd637d6f
 SHA512:
-  metadata.gz: e6f3ab3af97533e26cf7fc91eb529dd5bd90f7e3b7a818b6c86636bbd4cbfb5b8f38479ee81ca1230da1ec5d6101d59a56273186f46c8d3b52807a467c40abdb
-  data.tar.gz: ab4a57f673a4cb99c1a00225a041dfe69dfbc6f9c7213774a6e4f64e6250241d3c69148fc14cf900409e15f1574d0a6b41be43b9b3c5819f2313d25ab0713418
+  metadata.gz: 65a5d250126fc935053dfffef037baaf780678764ac95e4924603b901016f82b451a79a51f18fc699f2cfd8006cb805cd4887d206c12ca68ac68f059f1f13409
+  data.tar.gz: 2ebcc465985827a16866a948690a7bb4c03252050c8bfb1ee458809c6f0eda8c8fd581ba2f9bb1b496d3c7952456a11ad6ac51dd63e69c465238cffa17d7c2da

data/.eslintrc.js

@@ -10,12 +10,5 @@ module.exports = {
     sourceType: 'module',
   },
   rules: {},
-  ignorePatterns: [
-    '/vendor',
-    '/doc',
-    '/assets/babel.min.js',
-    '/assets/jquery-1.8.2.js',
-    '/assets/react-dom.js',
-    '/assets/react.js',
-  ],
+  ignorePatterns: ['/vendor', '/doc', '/assets/jquery-1.8.2.js'],
 };

data/CHANGELOG

@@ -1,8 +1,16 @@
+11-01-2022
+
+- Version 4.0.0
+
+  - DEV: Remove backend diagnostics
+  - DEV: Rename reliable_pub_sub to backend_instance
+  - FIX: `destroy` following `after_fork` could thread lock
+
 31-12-2021
 
 - Version 3.4.0
 
-   - FEATURE: remove "suicide" feature from message_bus - (message_bus used to terminate process when keepalive exceeded)
+  - FEATURE: Remove process auto-termination on missed keepalives
 
 20-12-2021
 

data/README.md

@@ -169,32 +169,6 @@ curl -H "Content-Type: application/x-www-form-urlencoded" -X POST --data "/messa
 
 You should see a reply with the messages of that channel you requested (in this case `/message`) starting at the message ID you requested (`0`). The URL parameter `dlp=t` disables long-polling: we do not want this request to stay open.
 
-### Diagnostics
-
-MessageBus comes with a diagnostics interface, which you can access at `/message-bus/_diagnostics`. This interface allows you visibility into the runtime behaviour of message_bus.
-
-In order to use the diagnostics UI in your application, it is necessary to:
-
-* Enable it
-* Define a user ID for requests
-* Define a check for admin role
-
-as an example, you can do something like this:
-
-```ruby
-MessageBus.enable_diagnostics # Must be called after `MessageBus.after_fork` if using a forking webserver
-
-MessageBus.user_id_lookup do |_env|
-  1
-end
-
-MessageBus.is_admin_lookup do |_env|
-  true
-end
-```
-
-Of course, in your real-world application, you would define these values according to your authentication/authorization logic.
-
 ### Transport
 
 MessageBus ships with 3 transport mechanisms.
@@ -416,17 +390,17 @@ The redis client message_bus uses is [redis-rb](https://github.com/redis/redis-r
 
 Out of the box Redis keeps track of 2000 messages in the global backlog and 1000 messages in a per-channel backlog. Per-channel backlogs get cleared automatically after 7 days of inactivity.
 
-This is configurable via accessors on the ReliablePubSub instance.
+This is configurable via accessors on the Backend instance.
 
 ```ruby
 # only store 100 messages per channel
-MessageBus.reliable_pub_sub.max_backlog_size = 100
+MessageBus.backend_instance.max_backlog_size = 100
 
 # only store 100 global messages
-MessageBus.reliable_pub_sub.max_global_backlog_size = 100
+MessageBus.backend_instance.max_global_backlog_size = 100
 
 # flush per-channel backlog after 100 seconds of inactivity
-MessageBus.reliable_pub_sub.max_backlog_age = 100
+MessageBus.backend_instance.max_backlog_age = 100
 ```
 
 ### PostgreSQL
@@ -750,7 +724,3 @@ While working on documentation, it is useful to automatically re-build it as you
 ### Benchmarks
 
 Some simple benchmarks are implemented in `spec/performance` and can be executed using `rake performance` (or `docker-compose run tests rake performance`). You should run these before and after your changes to avoid introducing performance regressions.
-
-### Diagnostics Interface
-
-It is possible to manually test the diagnostics interface by executing `docker-compose up example` and then `open http://localhost:9292`.

data/docker-compose.yml

@@ -36,7 +36,7 @@ services:
   example:
     build:
       context: .
-    command: bash -c "cd examples/diagnostics && bundle install && bundle exec rackup --server puma --host 0.0.0.0"
+    command: bash -c "cd examples/chat && bundle install && bundle exec rackup --server puma --host 0.0.0.0"
     environment:
       BUNDLE_TO: /usr/local/bundle
       REDISURL: redis://redis:6379

data/lib/message_bus/backends/postgres.rb

@@ -45,6 +45,7 @@ module MessageBus
           @available = []
           @allocated = {}
           @subscribe_connection = nil
+          @subscribed = false
           @mutex = Mutex.new
           @pid = Process.pid
         end

data/lib/message_bus/backends/redis.rb

@@ -59,6 +59,7 @@ module MessageBus
         @lock = Mutex.new
         @flush_backlog_thread = nil
         @pub_redis = nil
+        @subscribed = false
         # after 7 days inactive backlogs will be removed
         @max_backlog_age = 604800
       end
@@ -260,6 +261,7 @@ LUA
           new_redis.publish(redis_channel_name, UNSUB_MESSAGE)
         ensure
           new_redis&.disconnect!
+          @subscribed = false
         end
       end
 
@@ -302,6 +304,7 @@ LUA
 
             on.message do |_c, m|
               if m == UNSUB_MESSAGE
+                @subscribed = false
                 global_redis.unsubscribe
                 return
               end

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
@@ -79,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "3.4.0"
+  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"
@@ -47,21 +45,6 @@ module MessageBus::Implementation
     @subscriber_thread = nil
   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
-  end
-
   # @param [Logger] logger a logger object to be used by the bus
   # @return [void]
   def logger=(logger)
@@ -297,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
 
@@ -313,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
@@ -321,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
@@ -398,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
@@ -414,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
 
@@ -495,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|
@@ -513,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
@@ -536,8 +523,8 @@ module MessageBus::Implementation
   def destroy
     return if @destroyed
 
-    reliable_pub_sub.global_unsubscribe
-    reliable_pub_sub.destroy
+    backend_instance.global_unsubscribe
+    backend_instance.destroy
 
     @mutex.synchronize do
       return if @destroyed
@@ -555,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 {}
@@ -564,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
@@ -697,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
@@ -720,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
@@ -760,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/spec/lib/message_bus/backend_spec.rb

@@ -3,9 +3,9 @@
 require_relative '../../spec_helper'
 require 'message_bus'
 
-describe PUB_SUB_CLASS do
+describe BACKEND_CLASS do
   before do
-    @bus = PUB_SUB_CLASS.new(test_config_for_backend(CURRENT_BACKEND))
+    @bus = BACKEND_CLASS.new(test_config_for_backend(CURRENT_BACKEND))
   end
 
   after do
@@ -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

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,7 +13,7 @@ describe PUB_SUB_CLASS do
   end
 
   def new_bus
-    PUB_SUB_CLASS.new(test_config_for_backend(CURRENT_BACKEND).merge(db: 10))
+    BACKEND_CLASS.new(test_config_for_backend(CURRENT_BACKEND).merge(db: 10))
   end
 
   def work_it

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

@@ -142,54 +142,6 @@ describe MessageBus::Rack::Middleware do
     end
   end
 
-  describe "diagnostics" do
-    it "should return a 403 if an unauthorized 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
-
-    it "should return 404 for invalid assets path" do
-      def @bus.is_admin_lookup
-        proc { |_| true }
-      end
-
-      get "/message-bus/_diagnostics/assets/../Gemfile"
-      last_response.status.must_equal 404
-    end
-  end
-
   describe "polling" do
     before do
       @bus.long_polling_enabled = false

data/spec/lib/message_bus_spec.rb

@@ -37,6 +37,14 @@ describe MessageBus do
     @bus.after_fork
   end
 
+  it "destroying immediately after `after_fork` does not lock" do
+    10.times do
+      @bus.on
+      @bus.after_fork
+      @bus.destroy
+    end
+  end
+
   describe "#base_route=" do
     it "adds leading and trailing slashes" do
       @bus.base_route = "my/base/route"
@@ -107,7 +115,7 @@ describe MessageBus do
     @bus.publish("/chuck", norris: true)
     @bus.publish("/chuck", norris: true)
 
-    @bus.reliable_pub_sub.reset!
+    @bus.backend_instance.reset!
 
     @bus.publish("/chuck", yeager: true)
 
@@ -125,7 +133,7 @@ describe MessageBus do
     @bus.publish("/chuck", norris: true)
     @bus.publish("/chuck", norris: true)
 
-    @bus.reliable_pub_sub.expire_all_backlogs!
+    @bus.backend_instance.expire_all_backlogs!
 
     @bus.publish("/chuck", yeager: true)
 

data/spec/performance/publish.rb

@@ -32,8 +32,8 @@ benchmark_subscription_no_trimming = lambda do |bm, backend|
   bus = MessageBus::Instance.new
   bus.configure(test_config_for_backend(backend))
 
-  bus.reliable_pub_sub.max_backlog_size = iterations
-  bus.reliable_pub_sub.max_global_backlog_size = iterations
+  bus.backend_instance.max_backlog_size = iterations
+  bus.backend_instance.max_global_backlog_size = iterations
 
   messages_received = 0
   bus.after_fork
@@ -58,8 +58,8 @@ benchmark_subscription_with_trimming = lambda do |bm, backend|
   bus = MessageBus::Instance.new
   bus.configure(test_config_for_backend(backend))
 
-  bus.reliable_pub_sub.max_backlog_size = (iterations / 10)
-  bus.reliable_pub_sub.max_global_backlog_size = (iterations / 10)
+  bus.backend_instance.max_backlog_size = (iterations / 10)
+  bus.backend_instance.max_global_backlog_size = (iterations / 10)
 
   messages_received = 0
   bus.after_fork

data/spec/spec_helper.rb

@@ -14,7 +14,7 @@ require_relative "helpers"
 CURRENT_BACKEND = (ENV['MESSAGE_BUS_BACKEND'] || :redis).to_sym
 
 require "message_bus/backends/#{CURRENT_BACKEND}"
-PUB_SUB_CLASS = MessageBus::BACKENDS.fetch(CURRENT_BACKEND)
+BACKEND_CLASS = MessageBus::BACKENDS.fetch(CURRENT_BACKEND)
 
 puts "Running with backend: #{CURRENT_BACKEND}"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Sam Saffron
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -282,13 +282,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- assets/application.jsx
-- assets/babel.min.js
 - assets/jquery-1.8.2.js
 - assets/message-bus-ajax.js
 - assets/message-bus.js
-- assets/react-dom.js
-- assets/react.js
 - bench/codecs/all_codecs.rb
 - bench/codecs/marshal.rb
 - bench/codecs/packed_string.rb
@@ -306,8 +302,6 @@ files:
 - examples/chat/config.ru
 - examples/chat/docker_container/chat.yml
 - examples/chat/docker_container/update_chat
-- examples/diagnostics/Gemfile
-- examples/diagnostics/config.ru
 - examples/minimal/Gemfile
 - examples/minimal/config.ru
 - lib/message_bus.rb
@@ -321,13 +315,11 @@ files:
 - lib/message_bus/codec/json.rb
 - lib/message_bus/codec/oj.rb
 - lib/message_bus/connection_manager.rb
-- lib/message_bus/diagnostics.rb
 - lib/message_bus/distributed_cache.rb
 - lib/message_bus/http_client.rb
 - lib/message_bus/http_client/channel.rb
 - lib/message_bus/http_client/version.rb
 - lib/message_bus/message.rb
-- lib/message_bus/rack/diagnostics.rb
 - lib/message_bus/rack/middleware.rb
 - lib/message_bus/rack/thin_ext.rb
 - lib/message_bus/rails/railtie.rb
@@ -362,7 +354,7 @@ homepage: https://github.com/discourse/message_bus
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -377,8 +369,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ''
 test_files: