message_bus 4.3.7 → 4.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed07dd9a2acd5f0a87a3642a5b737a1f3b259fba4b1b9d52047a5a55f80818c7
-  data.tar.gz: 0bec8a9871c476feadd6112fc3054890b3e894af9c80bff58cea296b685c2e8d
+  metadata.gz: 258a314e3749265bd7fbaa9fadcaba10a3e4fdb46d204787ccc96effecdcbc7c
+  data.tar.gz: b14add0ef9b398c2adf721adb725d7dbeb2719066f694e753fde7073a06da502
 SHA512:
-  metadata.gz: 06b571fb6e122c0d366c234ea25a9d2e34405d801f829db1526710f9ba0218fa1ac258781f8aedc9b7b72dff46203d77e3672ce0467d50e09fb00023d4da8cfe
-  data.tar.gz: ed19c42187198b47ac09b5d743e10fa7a36a4957923065930f287e43d83ae032c33c541f3d04b75c95183e9ba273a010b6493fab5665a6ec129af934d9cc26cc
+  metadata.gz: ebc4a907f665282f748fef892398b203b71888c98800350d7061ee870d7848a8a3f1034d501ccb162c5d099dee9edbc411a950921ce063ccac7a7ac58e60e995
+  data.tar.gz: 9b454a1f78c88351865bb277c2831b4f9772113ad865793f7d05ef531816600f828a4cc18f461a969db002038a30b5ae2d472bdd4128b7a0ccf8d2bfab6e6067

data/.github/workflows/ci.yml

@@ -7,7 +7,34 @@ on:
   pull_request:
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    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 }} (redis ${{ matrix.redis }})
     timeout-minutes: 10
@@ -20,12 +47,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, '3.0', 3.1]
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
         redis: [5, 6]
 
     services:
       postgres:
-        image: postgres:14
+        image: postgres:16
         env:
           POSTGRES_DB: message_bus_test
           POSTGRES_PASSWORD: postgres
@@ -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,16 @@
+18-02-2025
+
+- Version 4.3.9
+
+  - Prevent deprecation warning when using Rails 7.1
+
+14-09-2023
+
+- Version 4.3.8
+
+- FIX: Typo in `group_ids_lookup` option name in Redis params exclusion list that was preventing the use of the redis backend along with this option.
+- FIX: Removes close_db_connection! deprecation warning.
+
 28-06-2023
 
 - Version 4.3.7
@@ -35,13 +48,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/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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'redis'
-require 'digest'
+require "redis"
+require "digest"
 
 module MessageBus
   module Backends
@@ -49,9 +49,7 @@ module MessageBus
         @redis_config = redis_config.dup
         @clear_every = redis_config.delete(:clear_every) || 1
         @logger = @redis_config[:logger]
-        unless @redis_config[:enable_redis_logger]
-          @redis_config[:logger] = nil
-        end
+        @redis_config[:logger] = nil unless @redis_config[:enable_redis_logger]
         @max_backlog_size = max_backlog_size
         @max_global_backlog_size = 2000
         @max_in_memory_publish_backlog = 1000
@@ -61,7 +59,7 @@ module MessageBus
         @pub_redis = nil
         @subscribed = false
         # after 7 days inactive backlogs will be removed
-        @max_backlog_age = 604800
+        @max_backlog_age = 604_800
       end
 
       # Reconnects to Redis; used after a process fork, typically triggered by a forking webserver
@@ -72,9 +70,7 @@ module MessageBus
 
       # (see Base#reset!)
       def reset!
-        pub_redis.keys("__mb_*").each do |k|
-          pub_redis.del k
-        end
+        pub_redis.keys("__mb_*").each { |k| pub_redis.del k }
       end
 
       # (see Base#destroy)
@@ -85,9 +81,7 @@ module MessageBus
       # Deletes all backlogs and their data. Does not delete ID pointers, so new publications will get IDs that continue from the last publication before the expiry. Use with extreme caution.
       # @see Base#expire_all_backlogs!
       def expire_all_backlogs!
-        pub_redis.keys("__mb_*backlog_n").each do |k|
-          pub_redis.del k
-        end
+        pub_redis.keys("__mb_*backlog_n").each { |k| pub_redis.del k }
       end
 
       # Note, the script takes care of all expiry of keys, however
@@ -157,15 +151,15 @@ LUA
             max_backlog_size,
             max_global_backlog_size,
             channel,
-            clear_every
+            clear_every,
           ],
           keys: [
             global_id_key,
             backlog_id_key,
             backlog_key,
             global_backlog_key,
-            redis_channel_name
-          ]
+            redis_channel_name,
+          ],
         )
       rescue ::Redis::CommandError => e
         if queue_in_memory && e.message =~ /READONLY/
@@ -173,7 +167,9 @@ LUA
             @in_memory_backlog << [channel, data]
             if @in_memory_backlog.length > @max_in_memory_publish_backlog
               @in_memory_backlog.delete_at(0)
-              @logger.warn("Dropping old message cause max_in_memory_publish_backlog is full: #{e.message}\n#{e.backtrace.join('\n')}")
+              @logger.warn(
+                "Dropping old message cause max_in_memory_publish_backlog is full: #{e.message}\n#{e.backtrace.join('\n')}",
+              )
             end
           end
 
@@ -209,9 +205,7 @@ LUA
         backlog_key = backlog_key(channel)
         items = redis.zrangebyscore backlog_key, last_id.to_i + 1, "+inf"
 
-        items.map do |i|
-          MessageBus::Message.decode(i)
-        end
+        items.map { |i| MessageBus::Message.decode(i) }
       end
 
       # (see Base#global_backlog)
@@ -254,13 +248,9 @@ LUA
           #   we are subscribing on global and global is always going to be bigger than local
           #   so worst case is a replay of a few messages
           message = get_message(channel, last_id)
-          if message
-            last_id = message.global_id
-          end
-        end
-        global_subscribe(last_id) do |m|
-          yield m if m.channel == channel
+          last_id = message.global_id if message
         end
+        global_subscribe(last_id) { |m| yield m if m.channel == channel }
       end
 
       # (see Base#global_unsubscribe)
@@ -280,42 +270,37 @@ LUA
 
         highest_id = last_id
 
-        clear_backlog = lambda do
-          retries = 4
-          begin
-            highest_id = process_global_backlog(highest_id, retries > 0, &blk)
-          rescue BackLogOutOfOrder => e
-            highest_id = e.highest_id
-            retries -= 1
-            sleep(rand(50) / 1000.0)
-            retry
+        clear_backlog =
+          lambda do
+            retries = 4
+            begin
+              highest_id = process_global_backlog(highest_id, retries > 0, &blk)
+            rescue BackLogOutOfOrder => e
+              highest_id = e.highest_id
+              retries -= 1
+              sleep(rand(50) / 1000.0)
+              retry
+            end
           end
-        end
 
         begin
           global_redis = new_redis_connection
 
-          if highest_id
-            clear_backlog.call(&blk)
-          end
+          clear_backlog.call(&blk) if highest_id
 
           global_redis.subscribe(redis_channel_name) do |on|
             on.subscribe do
-              if highest_id
-                clear_backlog.call(&blk)
-              end
+              clear_backlog.call(&blk) if highest_id
               @subscribed = true
             end
 
-            on.unsubscribe do
-              @subscribed = false
-            end
+            on.unsubscribe { @subscribed = false }
 
             on.message do |_c, m|
               if m == UNSUB_MESSAGE
                 @subscribed = false
                 global_redis.unsubscribe
-                return
+                return # rubocop:disable Lint/NonLocalExitFromIterator
               end
               m = MessageBus::Message.decode m
 
@@ -346,29 +331,30 @@ 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
-          ![
-            :backend,
-            :logger,
-            :long_polling_enabled,
-            :long_polling_interval,
-            :backend_options,
-            :base_route,
-            :client_message_filters,
-            :site_id_lookup,
-            :group_id_lookup,
-            :user_id_lookup,
-            :transport_codec
-          ].include?(k)
-        end
+        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)
       end
 
@@ -399,9 +385,7 @@ LUA
       end
 
       def process_global_backlog(highest_id, raise_error)
-        if highest_id > pub_redis.get(global_id_key).to_i
-          highest_id = 0
-        end
+        highest_id = 0 if highest_id > pub_redis.get(global_id_key).to_i
 
         global_backlog(highest_id).each do |old|
           if highest_id + 1 == old.global_id
@@ -444,19 +428,21 @@ LUA
               if e.message =~ /^READONLY/
                 try_again = true
               else
-                @logger.warn("Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}")
+                @logger.warn(
+                  "Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}",
+                )
               end
             rescue => e
-              @logger.warn("Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}")
+              @logger.warn(
+                "Dropping undeliverable message: #{e.message}\n#{e.backtrace.join('\n')}",
+              )
             end
 
             @in_memory_backlog.delete_at(0) unless try_again
           end
         end
       ensure
-        @lock.synchronize do
-          @flush_backlog_thread = nil
-        end
+        @lock.synchronize { @flush_backlog_thread = nil }
       end
 
       def cached_eval(redis, script, script_sha1, params)
@@ -479,10 +465,10 @@ LUA
           # in case we are not connected to the correct server
           # which can happen when sharing ips
           pub_redis.disconnect!
-          pub_redis.set(key, '1')
+          pub_redis.set(key, "1")
           false
         rescue ::Redis::CommandError => e
-          return true if e.message =~ /^READONLY/
+          true if e.message =~ /^READONLY/
         end
       end
 

data/lib/message_bus/rack/middleware.rb

@@ -199,7 +199,13 @@ class MessageBus::Rack::Middleware
     # ConnectionManagement in Rails puts a BodyProxy around stuff
     #  this means connections are not returned until rack.async is
     #  closed
-    if defined? ActiveRecord::Base.clear_active_connections!
+    if defined? ActiveRecord::Base.connection_handler
+      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
   end

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "4.3.7"
+  VERSION = "4.3.9"
 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"
@@ -772,7 +771,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