beetle 3.5.4 → 3.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38849c0467ba80b057fa8bc659ad98b025dd1c6d9ce416a4f2c48dff91f50fac
-  data.tar.gz: 791b45e82bcddf8bca2923db816475aa16bb81efa96d7c38381de12ea18fe65b
+  metadata.gz: 05c783e8ae2cd39837e587954e252f6f8cd772756536cb51de030fdebddfa808
+  data.tar.gz: 63403a3e7c70a2840daedfbb41f067c260ac6ae0b34920334f0e26bb999b936b
 SHA512:
-  metadata.gz: cbd464c6759316b86ab5732029fefa39518360dc40f055e729d585b9304ad84c9597c7e37908826bfc0347c109c89e7729db8096b2bf51ec64c536c272c9b6b3
-  data.tar.gz: c7ef92729c7d9cf38c7ec5e0a90fff5147fb4350d568c82c93e58c76b5c358d74929517b888bb8f96386230f0b2f50272488981668d183294fbda5ac86893ade
+  metadata.gz: c43c533f5946971f25cbc664809842498f0e52b0404e0a23b772940707adf53288be74d7ca1f8f3cae1943a1d311a19f15b2fc4e3458b6347597367002e65af0
+  data.tar.gz: ae915f36ce7d9e78a10421b17bca59710b87964b3904db14ea1064dc6d87147d3e9c2faf6b552982d73ed227e88b4bd8b2d06d4a9d8335654d6008c95eade00b

data/beetle.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 3
   s.add_runtime_dependency "bunny",                   "~> 0.7.12"
-  s.add_runtime_dependency "redis",                   [">= 4.2.1", "< 5.0"]
+  s.add_runtime_dependency "redis",                   ">= 4.2.1"
   s.add_runtime_dependency "hiredis",                 ">= 0.4.5"
   s.add_runtime_dependency "amq-protocol",            "= 2.3.2"
   s.add_runtime_dependency "amqp",                    "= 1.8.0"
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "daemons",             ">= 1.2.0"
   s.add_development_dependency "i18n"
   s.add_development_dependency "minitest",            "~> 5.1"
+  s.add_development_dependency "minitest-reporters"
   s.add_development_dependency "mocha",               "~> 1.14"
   s.add_development_dependency "mysql2",              "~> 0.5"
   s.add_development_dependency "rake",                "~> 13.0"
@@ -46,4 +47,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'github-markup'
   s.add_development_dependency 'byebug'
+  s.add_development_dependency 'appraisal'
 end

data/features/support/env.rb

@@ -46,7 +46,7 @@ end
 
 def system_notification_log_path
   log_path = tmp_path + "/system_notifications.log"
-  `touch #{log_path}` unless File.exists?(log_path)
+  `touch #{log_path}` unless File.exist?(log_path)
   log_path
 end
 

data/features/support/test_daemons/redis.rb

@@ -131,11 +131,11 @@ module TestDaemons
     private
 
     def create_dir
-      FileUtils.mkdir(dir) unless File.exists?(dir)
+      FileUtils.mkdir(dir) unless File.exist?(dir)
     end
 
     def remove_dir
-      FileUtils.rm_r(dir) if File.exists?(dir)
+      FileUtils.rm_r(dir) if File.exist?(dir)
     end
 
     def create_config
@@ -145,11 +145,11 @@ module TestDaemons
     end
 
     def remove_config
-      FileUtils.rm(config_filename) if File.exists?(config_filename)
+      FileUtils.rm(config_filename) if File.exist?(config_filename)
     end
 
     def remove_pid_file
-      FileUtils.rm(pid_file) if File.exists?(pid_file)
+      FileUtils.rm(pid_file) if File.exist?(pid_file)
     end
 
     def tmp_path

data/lib/beetle/configuration.rb

@@ -33,6 +33,12 @@ module Beetle
     attr_accessor :redis_servers
     # redis database number to use for the message deduplication store (defaults to <tt>4</tt>)
     attr_accessor :redis_db
+    # redis connect timeout. defaults to 5 seconds.
+    attr_accessor :redis_connect_timeout
+    # redis read timeout. defaults to 5 seconds.
+    attr_accessor :redis_read_timeout
+    # redis write timeout. defaults to 5 seconds.
+    attr_accessor :redis_write_timeout
 
     # how long we should repeatedly retry a redis operation before giving up, with a one
     # second sleep between retries (defaults to <tt>180.seconds</tt>). this value needs to be
@@ -157,6 +163,9 @@ module Beetle
       self.redis_server = "localhost:6379"
       self.redis_servers = ""
       self.redis_db = 4
+      self.redis_connect_timeout = 5.0
+      self.redis_read_timeout = 5.0
+      self.redis_write_timeout = 5.0
       self.redis_failover_timeout = 180.seconds
       self.redis_status_key_expiry_interval = 0.seconds
       self.redis_failover_client_heartbeat_interval = 10.seconds
@@ -217,6 +226,17 @@ module Beetle
         end
     end
 
+    # redis optins to be passed to Redis.new
+    def redis_options
+      {
+        db: redis_db,
+        connect_timeout: redis_connect_timeout,
+        read_timeout: redis_read_timeout,
+        write_timeout: redis_write_timeout,
+        logger: redis_logger,
+      }
+    end
+
     private
     def load_config
       raw = ERB.new(IO.read(config_file)).result

data/lib/beetle/deduplication_store.rb

@@ -62,7 +62,7 @@ module Beetle
     # store completion status for given <tt>msg_id</tt> if it doesn't exist yet. Returns whether the
     # operation was successful.
     def setnx_completed!(msg_id)
-      expiry = @config.redis_status_key_expiry_interval
+      expiry = @config.redis_status_key_expiry_interval.to_i
       return true if expiry == 0
       with_failover do
         redis.set(
@@ -109,7 +109,7 @@ module Beetle
 
     # delete all keys associated with the given <tt>msg_id</tt>.
     def del_keys(msg_id)
-      expiry = @config.redis_status_key_expiry_interval
+      expiry = @config.redis_status_key_expiry_interval.to_i
       keys = keys(msg_id)
       status_key = keys.shift if expiry > 0
       with_failover do
@@ -150,7 +150,7 @@ module Beetle
 
     # set current redis master instance (as specified in the Beetle::Configuration)
     def redis_master_from_server_string
-      @current_master ||= Redis.from_server_string(@config.redis_server, :db => @config.redis_db, :logger => @config.redis_logger)
+      @current_master ||= Redis.from_server_string(@config.redis_server, @config.redis_options)
     end
 
     # set current redis master from master file
@@ -168,7 +168,7 @@ module Beetle
     def set_current_redis_master_from_master_file
       @last_time_master_file_changed = File.mtime(@config.redis_server)
       server_string = extract_redis_master(read_master_file)
-      @current_master = !server_string.blank? ? Redis.from_server_string(server_string, :db => @config.redis_db, :logger => @config.redis_logger) : nil
+      @current_master = !server_string.blank? ? Redis.from_server_string(server_string, @config.redis_options ) : nil
     end
 
     # extract redis master from file content and return the server for our system

data/lib/beetle/message.rb

@@ -72,15 +72,15 @@ module Beetle
 
     def setup(opts) #:nodoc:
       @server           = opts[:server]
-      @timeout          = opts[:timeout]    || DEFAULT_HANDLER_TIMEOUT
-      @delay            = opts[:delay]      || DEFAULT_HANDLER_EXECUTION_ATTEMPTS_DELAY
+      @timeout          = opts[:timeout]    || DEFAULT_HANDLER_TIMEOUT.to_i
+      @delay            = (opts[:delay]     || DEFAULT_HANDLER_EXECUTION_ATTEMPTS_DELAY).ceil
       @attempts_limit   = opts[:attempts]   || DEFAULT_HANDLER_EXECUTION_ATTEMPTS
       @exceptions_limit = opts[:exceptions] || DEFAULT_EXCEPTION_LIMIT
       @attempts_limit   = @exceptions_limit + 1 if @attempts_limit <= @exceptions_limit
       @retry_on         = opts[:retry_on] || nil
       @store            = opts[:store]
       max_delay         = opts[:max_delay] || @delay
-      @max_delay        = max_delay if max_delay >= 2*@delay
+      @max_delay        = max_delay.ceil if max_delay >= 2*@delay
     end
 
     # extracts various values from the AMQP header properties
@@ -101,7 +101,7 @@ module Beetle
     def self.publishing_options(opts = {}) #:nodoc:
       flags = 0
       flags |= FLAG_REDUNDANT if opts[:redundant]
-      expires_at = now + (opts[:ttl] || DEFAULT_TTL)
+      expires_at = now + (opts[:ttl] || DEFAULT_TTL).to_i
       opts = opts.slice(*PUBLISHING_KEYS)
       opts[:message_id] = generate_uuid.to_s
       opts[:timestamp] = now
@@ -165,7 +165,7 @@ module Beetle
 
     # store handler timeout timestamp in the deduplication store
     def set_timeout!
-      @store.set(msg_id, :timeout, now + timeout)
+      @store.set(msg_id, :timeout, (now + timeout).ceil)
     end
 
     # handler timed out?
@@ -230,7 +230,7 @@ module Beetle
     # have we already seen this message? if not, set the status to "incomplete" and store
     # the message exipration timestamp in the deduplication store.
     def key_exists?
-      old_message = !@store.msetnx(msg_id, :status =>"incomplete", :expires => @expires_at, :timeout => now + timeout)
+      old_message = !@store.msetnx(msg_id, :status =>"incomplete", :expires => @expires_at.to_i, :timeout => (now + timeout).to_i)
       if old_message
         logger.debug "Beetle: received duplicate message: #{msg_id} on queue: #{@queue}"
       end

data/lib/beetle/redis_ext.rb

@@ -3,6 +3,7 @@ class Redis #:nodoc:
   def self.from_server_string(server_string, options = {})
     host, port = server_string.split(':')
     options = {:host => host, :port => port}.update(options)
+    options.delete(:logger) if Redis::VERSION >= "5.0"
     new(options)
   end
 
@@ -79,6 +80,19 @@ class Redis #:nodoc:
       super != 0
     end
 
+  elsif Redis::VERSION >= "5.0.0"
+
+    # redis 5.0.0 has a shutdown method which raises if a connection to the redis server
+    # cannot be established.
+    module SaneShutdown
+      def shutdown
+        super
+      rescue RedisClient::CannotConnectError
+        nil
+      end
+    end
+    prepend SaneShutdown
+
   elsif Redis::VERSION >= "4.0.0"
 
     # redis 4.0.0 has a shutdown method which raises if a connection to the redis server

data/lib/beetle/version.rb

@@ -1,3 +1,3 @@
 module Beetle
-  VERSION = "3.5.4"
+  VERSION = "3.5.6"
 end

data/lib/beetle.rb

@@ -1,8 +1,19 @@
 $:.unshift(File.expand_path('..', __FILE__))
 require 'bunny'                    # which bunny picks up
 require 'qrack/errors'             # needed by the publisher
-require 'redis/connection/hiredis' # require *before* redis as specified in the redis-rb gem docs
-require 'redis'
+
+if Gem::Version.new(Bunny::VERSION) <= Gem::Version.new("0.7.12") && !defined?(::Fixnum)
+  require 'qrack/transport/buffer09'
+  Qrack::Transport09::Buffer.class_eval "Fixnum = Integer"
+end
+
+begin
+  require 'redis/connection/hiredis' # require *before* redis as specified in the redis-rb gem docs
+  require 'redis'
+rescue LoadError
+  require 'redis'
+  require 'hiredis-client'
+end
 require 'active_support/all'
 require 'set'
 require 'socket'

data/test/beetle/bunny_behavior_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class BunnyBehaviorTest < Minitest::Test
+  test "publishing fixnums and hashes works in amqp headers" do
+    client = Beetle::Client.new
+    client.register_queue(:test)
+    client.register_message(:test)
+
+    # purge the test queue
+    client.purge(:test)
+
+    # empty the dedup store
+    client.deduplication_store.flushdb
+
+    # register our handler to the message, check out the message.rb for more stuff you can get from the message object
+    message = nil
+    client.register_handler(:test) {|msg| message = msg; client.stop_listening }
+
+    # publish our message (NOTE: empty message bodies don't work, most likely due to bugs in bunny/amqp)
+    published = client.publish(:test, 'bam', headers: { foo: 1, table: {bar: "baz"}})
+
+    # start listening
+    client.listen
+    client.stop_publishing
+
+    assert_equal 1, published
+    assert_equal "bam", message.data
+    headers = message.header.attributes[:headers]
+    assert_equal 1, headers["foo"]
+    assert_equal({"bar" => "baz"}, headers["table"])
+  end
+end

data/test/beetle/redis_ext_test.rb

@@ -57,7 +57,11 @@ module Beetle
 
   class HiredisLoadedTest < Minitest::Test
     test "should be using hiredis instead of the redis ruby backend" do
-      assert defined?(Hiredis)
+      if Redis::VERSION < "5.0"
+        assert defined?(Hiredis)
+      else
+        assert_equal RedisClient.default_driver, RedisClient::HiredisConnection
+      end
     end
   end
 

data/test/test_helper.rb

@@ -7,9 +7,15 @@ end
 
 require 'minitest/autorun'
 require 'minitest/unit'
-require 'minitest/pride' if ENV['RAINBOW_COLORED_TESTS'] == "1" && $stdout.tty?
 require 'mocha/minitest'
 
+require 'minitest/reporters'
+if ENV['MINITEST_REPORTER']
+  Minitest::Reporters.use!
+else
+  Minitest::Reporters.use!([Minitest::Reporters::DefaultReporter.new])
+end
+
 require File.expand_path(File.dirname(__FILE__) + '/../lib/beetle')
 require 'eventmachine'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beetle
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.5.6
 platform: ruby
 authors:
 - Stefan Kaes
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -35,9 +35,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -45,9 +42,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: hiredis
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +182,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -328,6 +336,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A highly available, reliable messaging infrastructure
 email: opensource@xing.com
 executables: []
@@ -385,6 +407,7 @@ files:
 - test/beetle/amqp_gem_behavior_test.rb
 - test/beetle/base_test.rb
 - test/beetle/beetle_test.rb
+- test/beetle/bunny_behavior_test.rb
 - test/beetle/client_test.rb
 - test/beetle/configuration_test.rb
 - test/beetle/deduplication_store_test.rb
@@ -418,7 +441,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-rubygems_version: 3.3.19
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 3
 summary: High Availability AMQP Messaging with Redundant Queues
@@ -426,6 +449,7 @@ test_files:
 - test/beetle/amqp_gem_behavior_test.rb
 - test/beetle/base_test.rb
 - test/beetle/beetle_test.rb
+- test/beetle/bunny_behavior_test.rb
 - test/beetle/client_test.rb
 - test/beetle/configuration_test.rb
 - test/beetle/deduplication_store_test.rb