message_bus 4.3.6 → 4.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4df966b88978a23a9caeb38eec64b374d66ce1e364c419d1ac04c722dba36a7
-  data.tar.gz: 7bb707ad44b5fb96d8682ed25993d535700a1f8617e3af70ead34c5514b842dc
+  metadata.gz: 8919c0fad186b16833bee6f60c2cbab838be989395dbb63d5ea83ea25770a817
+  data.tar.gz: 12223e8d6cb7c4ef043ea4bfed14e0993a0d826380c4a3f5d8faed4fa55bfc1a
 SHA512:
-  metadata.gz: 600284061dbb261638b47f69535ddf937eaea43038bfce18495be6bcaa7550b9ce910bb32221ed8773e62a855b4adcc829131d9f74f0115d4777d25d451bf11f
-  data.tar.gz: 2ec82be8cf27b4eca3da26e7d122a9a7640d8294ffe2212a3f13c0995238276c3ef5519c03869bbb8ce584651d91620bcf464c56ca5017eaf239237a70deee2b
+  metadata.gz: ecc907090650eb544f36dee2f1ffac2e5e27408ff570d91d104ba118f20c03d9815dc441e08929128d60bb54640e929ea1ca0123bf9790f9caf562e6860441ee
+  data.tar.gz: a899cf220f0838916462e97146d50c0a297237c0f0569abf92da8d401a02f5a303ef769cb3318e33c4ffcef99092b01845bb6070c9b4282eb8c0cd08de37091e

data/CHANGELOG

@@ -1,5 +1,16 @@
+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
+
+  - FIX: Allow using `:long_polling_interval` with Redis gem version 5+.
+
 - Version 4.3.6
 
   - Don't error when trying to write a message to a closed client take 2

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,36 +270,31 @@ 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
@@ -346,28 +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,
-            :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
 
@@ -398,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
@@ -443,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)
@@ -478,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,9 @@ 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
+      ActiveRecord::Base.connection_handler.clear_active_connections!
+    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.6"
+  VERSION = "4.3.8"
 end

data/package-lock.json

@@ -2003,9 +2003,9 @@
       }
     },
     "node_modules/word-wrap": {
-      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
-      "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==",
+      "version": "1.2.4",
+      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.4.tgz",
+      "integrity": "sha512-2V81OA4ugVo5pRo46hAoD2ivUJx8jXmWXfUkY4KFNw0hEptvN0QfH3K4nHiwzGeKl5rFKedV48QVoqYavy4YpA==",
       "dev": true,
       "engines": {
         "node": ">=0.10.0"
@@ -3553,9 +3553,9 @@
       }
     },
     "word-wrap": {
-      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
-      "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==",
+      "version": "1.2.4",
+      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.4.tgz",
+      "integrity": "sha512-2V81OA4ugVo5pRo46hAoD2ivUJx8jXmWXfUkY4KFNw0hEptvN0QfH3K4nHiwzGeKl5rFKedV48QVoqYavy4YpA==",
       "dev": true
     },
     "wrappy": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 4.3.6
+  version: 4.3.8
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack