message_bus 4.3.8 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8919c0fad186b16833bee6f60c2cbab838be989395dbb63d5ea83ea25770a817
-  data.tar.gz: 12223e8d6cb7c4ef043ea4bfed14e0993a0d826380c4a3f5d8faed4fa55bfc1a
+  metadata.gz: 357d1643581a819f8b51412902cf1e3c666d87f8971b1e56ae2d1d822a60c984
+  data.tar.gz: 86fe067d70065dab59e4a8a739fd040d858af8b4e7658a4e4bcb36c79d41514a
 SHA512:
-  metadata.gz: ecc907090650eb544f36dee2f1ffac2e5e27408ff570d91d104ba118f20c03d9815dc441e08929128d60bb54640e929ea1ca0123bf9790f9caf562e6860441ee
-  data.tar.gz: a899cf220f0838916462e97146d50c0a297237c0f0569abf92da8d401a02f5a303ef769cb3318e33c4ffcef99092b01845bb6070c9b4282eb8c0cd08de37091e
+  metadata.gz: ef5368939b9c41b4a9faf41ac10f621a07d26d15760d6a5ab5dcc3eb6cc9f845923fc1400761fe2911fcb85f9eab8016778c20127228112618f67c0ccb77c238
+  data.tar.gz: f2cfded03670efd4d8f3098002a4709781b4f59e98c6f19102f462f5965aa51cfd6a11b4dcacd4b82470305cd85d04a6ce623029e2c0dde2ad7cbad1ca8b3fc8

data/.github/workflows/ci.yml

@@ -7,9 +7,36 @@ on:
   pull_request:
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }} (redis ${{ matrix.redis }})
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Setup npm
+        run: npm install
+
+      - name: Rubocop
+        run: bundle exec rubocop
+
+      - name: ESLint
+        run: npx eslint .
+
+  test:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }} (${{ matrix.redis }})
     timeout-minutes: 10
 
     env:
@@ -20,12 +47,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, '3.0', 3.1]
-        redis: [5, 6]
+        ruby: ["3.2", "3.3", "3.4"]
+        redis: ["redis:5", "redis:6", "valkey/valkey"]
 
     services:
       postgres:
-        image: postgres:14
+        image: postgres:16
         env:
           POSTGRES_DB: message_bus_test
           POSTGRES_PASSWORD: postgres
@@ -33,7 +60,7 @@ jobs:
           - 5432:5432
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
       redis:
-        image: ${{ format('redis:{0}', matrix.redis) }}
+        image: ${{ matrix.redis }}
         ports:
           - 6379:6379
         options: >-
@@ -43,41 +70,28 @@ jobs:
           --health-retries 5
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18
-          cache: npm
-
-      - name: Setup npm
-        run: npm install
-
       - name: Tests
         env:
           TESTOPTS: --verbose
         run: bundle exec rake
-        timeout-minutes: 3
-
-      - name: Linting
-        run: npx eslint .
 
   publish:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    needs: build
+    needs: [lint, test]
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release gem
-        uses: discourse/publish-rubygems-action@v2
+        uses: discourse/publish-rubygems-action@v3
         id: publish-gem
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
@@ -95,7 +109,7 @@ jobs:
           git commit -m 'bump'
 
       - name: Publish package
-        uses: JS-DevTools/npm-publish@v1
+        uses: JS-DevTools/npm-publish@v3
         if: steps.publish-gem.outputs.new_version == 'true'
         with:
           token: ${{ secrets.NPM_TOKEN }}

data/.rubocop.yml

@@ -1,11 +1,15 @@
 inherit_gem:
-  rubocop-discourse: .rubocop.yml
+  rubocop-discourse: stree-compat.yml
 inherit_mode:
   merge:
     - Exclude
+
 AllCops:
   Exclude:
-    - 'examples/**/*'
+    - "examples/**/*"
+
+Discourse/Plugins:
+  Enabled: false
 
 RSpec:
   Enabled: false

data/CHANGELOG

@@ -1,3 +1,15 @@
+14-03-2025
+
+- Version 4.4.0
+
+  - Add compatibility with the redis gem version 5+.
+
+18-02-2025
+
+- Version 4.3.9
+
+  - Prevent deprecation warning when using Rails 7.1
+
 14-09-2023
 
 - Version 4.3.8
@@ -42,13 +54,13 @@
 
 06-01-2023
 
-- Version 4.2.1
+- Version 4.3.1
 
   - FIX: Ensure non-long-polling requests are always spaced out
 
 04-11-2022
 
-- Version 4.2.0
+- Version 4.3.0
 
   - FIX: Add redis gem version 5 support
   - FEATURE: Allow disabling subscriptions without disabling publication

data/README.md

@@ -12,7 +12,7 @@ Read the generated docs: <https://www.rubydoc.info/gems/message_bus>
 
 ## Ruby version support
 
-MessageBus only support officially supported versions of Ruby; as of [2021-03-31](https://www.ruby-lang.org/en/downloads/branches/) this means we only support Ruby version 2.6 and up.
+MessageBus only support officially supported versions of Ruby; as of [2025-03-14](https://www.ruby-lang.org/en/downloads/branches/) this means we only support Ruby version 3.2 and up.
 
 ## Can you handle concurrent requests?
 

data/Rakefile

@@ -4,12 +4,10 @@ require 'rake/testtask'
 require 'bundler'
 require 'bundler/gem_tasks'
 require 'bundler/setup'
-require 'rubocop/rake_task'
 require 'yard'
 
 Bundler.require(:default, :test)
 
-RuboCop::RakeTask.new
 YARD::Rake::YardocTask.new
 
 BACKENDS = Dir["lib/message_bus/backends/*.rb"].map { |file| file.match(%r{backends/(?<backend>.*).rb})[:backend] } - ["base"]
@@ -99,5 +97,5 @@ task :performance do
   end
 end
 
-desc "Run all tests, link checks and confirms documentation compiles without error"
-task default: [:spec, :rubocop, :test_doc]
+desc "Run all tests and confirm the documentation compiles without error"
+task default: [:spec, :test_doc]

data/lib/message_bus/backends/base.rb

@@ -48,7 +48,6 @@ module MessageBus
     #
     # @abstract
     class Base
-      # rubocop:disable Lint/UnusedMethodArgument
 
       # Raised to indicate that the concrete backend implementation does not implement part of the API
       ConcreteClassMustImplementError = Class.new(StandardError)

data/lib/message_bus/backends/postgres.rb

@@ -406,7 +406,7 @@ module MessageBus
             on.message do |_c, m|
               if m == UNSUB_MESSAGE
                 @subscribed = false
-                return
+                return # rubocop:disable Lint/NonLocalExitFromIterator
               end
               m = MessageBus::Message.decode m
 

data/lib/message_bus/backends/redis.rb

@@ -40,16 +40,18 @@ module MessageBus
         end
       end
 
-      # @param [Hash] redis_config in addition to the options listed, see https://github.com/redis/redis-rb for other available options
-      # @option redis_config [Logger] :logger a logger to which logs will be output
-      # @option redis_config [Boolean] :enable_redis_logger (false) whether or not to enable logging by the underlying Redis library
-      # @option redis_config [Integer] :clear_every (1) the interval of publications between which the backlog will not be cleared
+      # @param [Hash] config
+      # @option config [Hash] :redis_config options for the redis connection (see https://github.com/redis/redis-rb)
+      # @option config [Logger] :logger a logger to which logs will be output
+      # @option config [Boolean] :enable_redis_logger (false) whether or not to enable logging by the underlying Redis library
+      # @option config [Integer] :clear_every (1) the interval of publications between which the backlog will not be cleared
       # @param [Integer] max_backlog_size the largest permitted size (number of messages) for per-channel backlogs; beyond this capacity, old messages will be dropped.
-      def initialize(redis_config = {}, max_backlog_size = 1000)
-        @redis_config = redis_config.dup
-        @clear_every = redis_config.delete(:clear_every) || 1
-        @logger = @redis_config[:logger]
-        @redis_config[:logger] = nil unless @redis_config[:enable_redis_logger]
+      def initialize(config = {}, max_backlog_size = 1000)
+        @config = config.dup
+        @redis_config = config[:redis_config].dup || {}
+        @clear_every = config[:clear_every] || 1
+        @logger = @config[:logger]
+        @config[:logger] = nil unless @config[:enable_redis_logger]
         @max_backlog_size = max_backlog_size
         @max_global_backlog_size = 2000
         @max_in_memory_publish_backlog = 1000
@@ -300,7 +302,7 @@ LUA
               if m == UNSUB_MESSAGE
                 @subscribed = false
                 global_redis.unsubscribe
-                return
+                return # rubocop:disable Lint/NonLocalExitFromIterator
               end
               m = MessageBus::Message.decode m
 
@@ -331,31 +333,7 @@ LUA
       private
 
       def new_redis_connection
-        config =
-          @redis_config.filter do |k, v|
-            # This is not ideal, required for Redis gem version 5
-            # redis-client no longer accepts arbitrary params
-            # anything unknown will error out.
-            # https://github.com/redis-rb/redis-client/blob/4c8e05acfb3477c1651138a4924616e79e6116f2/lib/redis_client/config.rb#L21-L39
-            #
-            #
-            # We should be doing the opposite and allowlisting params
-            # or splitting the object up. Starting with the smallest change that is backwards compatible
-            !%i[
-              backend
-              logger
-              long_polling_enabled
-              long_polling_interval
-              backend_options
-              base_route
-              client_message_filters
-              site_id_lookup
-              group_ids_lookup
-              user_id_lookup
-              transport_codec
-            ].include?(k)
-          end
-        ::Redis.new(config)
+        ::Redis.new(@redis_config)
       end
 
       # redis connection used for publishing messages

data/lib/message_bus/rack/middleware.rb

@@ -200,7 +200,11 @@ class MessageBus::Rack::Middleware
     #  this means connections are not returned until rack.async is
     #  closed
     if defined? ActiveRecord::Base.connection_handler
-      ActiveRecord::Base.connection_handler.clear_active_connections!
+      if Gem::Version.new(Rails.version) >= "7.1"
+        ActiveRecord::Base.connection_handler.clear_active_connections!(:all)
+      else
+        ActiveRecord::Base.connection_handler.clear_active_connections!
+      end
     elsif defined? ActiveRecord::Base.clear_active_connections!
       ActiveRecord::Base.clear_active_connections!
     end

data/lib/message_bus/version.rb

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

data/lib/message_bus.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "monitor"
-require "set"
 
 require_relative "message_bus/version"
 require_relative "message_bus/message"
@@ -185,10 +184,12 @@ module MessageBus::Implementation
   # @param [Hash<Symbol => Object>] config values to merge into existing config
   # @return [void]
   def redis_config=(config)
-    configure(config.merge(backend: :redis))
+    configure(backend: :redis, redis_config: config)
   end
 
-  alias redis_config config
+  def redis_config
+    @config[:redis_config] || {}
+  end
 
   # @yield [env] a routine to determine the site ID for a subscriber
   # @yieldparam [optional, Rack::Request::Env] env the subscriber request environment
@@ -772,7 +773,7 @@ module MessageBus::Implementation
         globals, locals, local_globals, global_globals = nil
 
         @mutex.synchronize do
-          return if @destroyed
+          return if @destroyed # rubocop:disable Lint/NonLocalExitFromIterator
           next unless @subscriptions
 
           globals = @subscriptions[nil]

data/message_bus.gemspec

@@ -35,6 +35,8 @@ Gem::Specification.new do |gem|
   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'
+
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
+    gem.add_development_dependency 'rubocop-discourse', '3.8.1'
+  end
 end