beetle 3.3.8 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b64b9ad7d4d36c450c8219f666db52323d1d30e6f741ccb5791469f9f9c7b7a0
-  data.tar.gz: 860d8813af202e5463aa70d2b33466c0cb1d0f0ed8afe7490ae82e106c2cc3f7
+  metadata.gz: 28836e3040ba8ef4415a6aae49f3ae805384e61b45cd76993a29d7589c23b7bf
+  data.tar.gz: bed46b58fe787d79a21b1fb3413a0359d948e79e70da0de92bfb717ad5e4e7be
 SHA512:
-  metadata.gz: b97d517694c27bfa3bcbb6d7714374b998a6e1268e0012e59a9d8e0c57e7fac0904cf978a9e5dee7c92c03f183c679ad238102704152e1f1115bedcc9280b70a
-  data.tar.gz: 63875a03bf6cd2c0221ce925d9b14d49aae0fbf547a40177ef4eee77a5913894b64df82967c45a3aecc0eff8a7631a8038e4fae1e5b7618dea3a66be030a472d
+  metadata.gz: 5b92b7588bcdd74a13a211d76997bae5f2255f729bb62b3c673ef00ec0fbda9a69e609055ad1a65797350c8151da6aa059093af3a27016069f22f1fa77c347d6
+  data.tar.gz: 7baa29a222dea24a7ce3f90fbeb90634d7b816197aa34c7fb5401e0d4754ab339f36c733d67aeccbeaf61524e9f74a59f07e697e931af96d94343d9977209dea

data/RELEASE_NOTES.rdoc

@@ -1,5 +1,26 @@
 = Release Notes
 
+== Version 3.4.0
+* Require redis gem version 4.2.1. This version changes the exists to check for the
+  existence of multiple keys, return the number of keys in the list that exist. This
+  requires at least redis gem version 4.2.0, but 4.2.1 contains a bug fix for said
+  command.
+
+== Version 3.3.12
+* Support queue level declaration of dead letter queue message TTL.
+
+== Version 3.3.11
+* Fixed that dead lettering only works correctly with global config option.
+
+== Version 3.3.10
+* Support configuring RabbitMQ write timeout.
+
+== Version 3.3.9
+* Reduce the number of queue policies created on the servers by allowing
+  the spefication of a default broker policy. You need to install the
+  default policy with a priority of zero to match all queues ever
+  created. This feature is optional.
+
 == Version 3.3.8
 * Avoid needless put call when updating queue policies.
   It seems the additional call to get the current definition of a policy

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",                   ">= 2.2.2"
+  s.add_runtime_dependency "redis",                   ">= 4.2.1"
   s.add_runtime_dependency "hiredis",                 ">= 0.4.5"
   s.add_runtime_dependency "amq-protocol",            "= 2.3.0"
   s.add_runtime_dependency "amqp",                    "= 1.8.0"

data/lib/beetle/base.rb

@@ -78,7 +78,8 @@ module Beetle
     end
 
     def bind_dead_letter_queue!(channel, target_queue, creation_keys = {})
-      policy_options = @client.queues[target_queue].slice(:dead_lettering, :lazy)
+      policy_options = @client.queues[target_queue].slice(:dead_lettering, :lazy, :dead_lettering_msg_ttl)
+      policy_options[:message_ttl] = policy_options.delete(:dead_lettering_msg_ttl)
       dead_letter_queue_name = "#{target_queue}_dead_letter"
       if policy_options[:dead_lettering]
         logger.debug("Beetle: creating dead letter queue #{dead_letter_queue_name} with opts: #{creation_keys.inspect}")
@@ -88,7 +89,7 @@ module Beetle
         :queue_name => target_queue,
         :bindings => @client.bindings[target_queue],
         :dead_letter_queue_name => dead_letter_queue_name,
-        :message_ttl => @client.config.dead_lettering_msg_ttl,
+        :message_ttl => policy_options[:message_ttl]
       }.merge(policy_options)
     end
 

data/lib/beetle/client.rb

@@ -96,7 +96,8 @@ module Beetle
       raise ConfigurationError.new("queue #{name} already configured") if queues.include?(name)
       opts = {
         :exchange => name, :key => name, :auto_delete => false, :amqp_name => name,
-        :lazy => config.lazy_queues_enabled, :dead_lettering => config.dead_lettering_enabled
+        :lazy => config.lazy_queues_enabled, :dead_lettering => config.dead_lettering_enabled,
+        :dead_lettering_msg_ttl => config.dead_lettering_msg_ttl
       }.merge!(options.symbolize_keys)
       opts.merge! :durable => true, :passive => false, :exclusive => false
       exchange = opts.delete(:exchange).to_s

data/lib/beetle/configuration.rb

@@ -14,6 +14,9 @@ module Beetle
     # Name of the policy update routing key
     attr_accessor :beetle_policy_updates_routing_key
     # default logger (defaults to <tt>Logger.new(log_file)</tt>)
+    attr_accessor :broker_default_policy
+    # set this to whatever your brokers have installed as default policy. For example, if you have installed
+    # a policy that makes every queue lazy, it should be set to <tt>{"queue-moode" => "lazy"}</tt>.
     attr_accessor :logger
     # defaults to <tt>STDOUT</tt>
     attr_accessor :redis_logger
@@ -104,8 +107,10 @@ module Beetle
     # Whether to update quueue policies synchronously or asynchronously.
     attr_accessor :update_queue_properties_synchronously
 
-    # Read timeout for http requests to create dead letter bindings
+    # Read timeout for http requests to RabbitMQ HTTP API
     attr_accessor :rabbitmq_api_read_timeout
+    # Write timeout for http requests to RabbitMQ HTTP API
+    attr_accessor :rabbitmq_api_write_timeout
 
     # Returns the port on which the Rabbit API is hosted
     attr_accessor :api_port
@@ -146,6 +151,7 @@ module Beetle
       self.beetle_policy_exchange_name = "beetle-policies"
       self.beetle_policy_updates_queue_name = "beetle-policy-updates"
       self.beetle_policy_updates_routing_key = "beetle.policy.update"
+      self.broker_default_policy = {}
 
       self.gc_threshold = 1.hour.to_i
       self.redis_server = "localhost:6379"
@@ -174,6 +180,7 @@ module Beetle
       self.dead_lettering_enabled = false
       self.dead_lettering_msg_ttl = 1000   # 1 second
       self.rabbitmq_api_read_timeout = 60  # 60 seconds
+      self.rabbitmq_api_write_timeout = 60  # 60 seconds
 
       self.lazy_queues_enabled = false
       self.throttling_refresh_interval = 60 # seconds

data/lib/beetle/deduplication_store.rb

@@ -120,7 +120,7 @@ module Beetle
 
     # check whether key with given suffix exists for a given <tt>msg_id</tt>.
     def exists(msg_id, suffix)
-      with_failover { redis.exists(key(msg_id, suffix)) }
+      with_failover { redis.exists?(key(msg_id, suffix)) }
     end
 
     # flush the configured redis database. useful for testing.

data/lib/beetle/queue_properties.rb

@@ -45,9 +45,11 @@ module Beetle
       return unless options[:dead_lettering] || options[:lazy]
 
       # no need to worry that the server has the port 5672. Net:HTTP will take care of this. See below.
-      request_url = URI("http://#{server}/api/policies/#{vhost}/#{queue_name}_policy")
+      policy_name = "#{queue_name}_policy"
+      request_url = URI("http://#{server}/api/policies/#{vhost}/#{policy_name}")
       get_request = Net::HTTP::Get.new(request_url)
       put_request = Net::HTTP::Put.new(request_url)
+      delete_request = Net::HTTP::Delete.new(request_url)
 
       # set up queue policy
       definition = {}
@@ -66,13 +68,26 @@ module Beetle
         "definition" => definition,
       }
 
+      is_default_policy = definition == config.broker_default_policy
+
       get_response = run_rabbit_http_request(request_url, get_request) do |http|
         http.request(get_request, nil)
       end
 
-      if get_response.code == "200"
+      case get_response.code
+      when "200"
         response_body = JSON.parse(get_response.body) rescue {}
-        return :ok if put_request_body.all? { |k,v| response_body[k] == v }
+        same_policy = put_request_body.all? { |k,v| response_body[k] == v }
+        if same_policy
+          if is_default_policy
+            run_rabbit_http_request(request_url, delete_request) do |http|
+              http.request(get_request, nil)
+            end
+          end
+          return :ok
+        end
+      when "404"
+        return :ok if is_default_policy
       end
 
       put_response = run_rabbit_http_request(request_url, put_request) do |http|
@@ -141,13 +156,15 @@ module Beetle
 
     def run_rabbit_http_request(uri, request, &block)
       request.basic_auth(config.user, config.password)
-      if request.class::METHOD == 'GET'
+      case request.class::METHOD
+      when 'GET'
         request["Accept"] = "application/json"
-      else
+      when 'PUT'
         request["Content-Type"] = "application/json"
       end
       http = Net::HTTP.new(uri.hostname, config.api_port)
       http.read_timeout = config.rabbitmq_api_read_timeout
+      http.write_timeout = config.rabbitmq_api_write_timeout if http.respond_to?(:write_timeout=)
       # don't do this in production:
       # http.set_debug_output(logger.instance_eval{ @logdev.dev })
       http.start do |instance|

data/lib/beetle/subscriber.rb

@@ -180,7 +180,7 @@ module Beetle
           processor = Handler.create(handler, opts)
           result = m.process(processor)
           if result.reject?
-            if @client.config.dead_lettering_enabled?
+            if @client.queues[queue_name][:dead_lettering]
               header.reject(:requeue => false)
             else
               sleep 1

data/lib/beetle/version.rb

@@ -1,3 +1,3 @@
 module Beetle
-  VERSION = "3.3.8"
+  VERSION = "3.4.0"
 end

data/test/beetle/client_test.rb

@@ -79,7 +79,7 @@ module Beetle
 
     test "registering a queue should store it in the configuration with symbolized option keys and force durable=true and passive=false and set the amqp queue name" do
       @client.register_queue("some_queue", "durable" => false, "exchange" => "some_exchange")
-      assert_equal({:durable => true, :passive => false, :lazy=>false, :dead_lettering=>false, :auto_delete => false, :exclusive => false, :amqp_name => "some_queue"}, @client.queues["some_queue"])
+      assert_equal({:durable => true, :passive => false, :lazy=>false, :dead_lettering=>false, :dead_lettering_msg_ttl=>1000, :auto_delete => false, :exclusive => false, :amqp_name => "some_queue"}, @client.queues["some_queue"])
     end
 
     test "registering a queue should add the queue to the list of queues of the queue's exchange" do

data/test/beetle/deduplication_store_test.rb

@@ -9,7 +9,7 @@ module Beetle
     end
 
     test "trying to delete a non existent key doesn't throw an error" do
-      assert !@r.exists("hahahaha")
+      assert !@r.exists?("hahahaha")
       assert_equal 0, @r.del("hahahaha")
     end
 

data/test/beetle/message_test.rb

@@ -141,9 +141,7 @@ module Beetle
 
       message.process(@null_handler)
       keys = @store.keys(message.msg_id)
-      keys.each do |key|
-        assert !@store.redis.exists(key)
-      end
+      assert_equal 0, @store.redis.exists(*keys)
     end
 
     test "successful processing of a non redundant message should delete all keys from the database (except the status key, which should be set to expire)" do
@@ -159,11 +157,9 @@ module Beetle
       message.process(@null_handler)
       keys = @store.keys(message.msg_id)
       status_key = keys.shift
-      assert @store.redis.exists(status_key)
+      assert @store.redis.exists?(status_key)
       assert @store.redis.ttl(status_key) <= @config.redis_status_key_expiry_interval
-      keys.each do |key|
-        assert !@store.redis.exists(key)
-      end
+      assert_equal 0, @store.redis.exists(*keys)
     end
 
     test "successful processing of a redundant message twice should delete all keys from the database" do
@@ -179,9 +175,7 @@ module Beetle
       message.process(@null_handler)
 
       keys = @store.keys(message.msg_id)
-      keys.each do |key|
-        assert !@store.redis.exists(key)
-      end
+      assert_equal 0, @store.redis.exists(*keys)
     end
 
     test "successful processing of a redundant message twice should delete all keys from the database (except the status key, which should be set to expire)" do
@@ -199,11 +193,9 @@ module Beetle
 
       keys = @store.keys(message.msg_id)
       status_key = keys.shift
-      assert @store.redis.exists(status_key)
+      assert @store.redis.exists?(status_key)
       assert @store.redis.ttl(status_key) <= @config.redis_status_key_expiry_interval
-      keys.each do |key|
-        assert !@store.redis.exists(key)
-      end
+      assert_equal 0, @store.redis.exists(*keys)
     end
 
     test "successful processing of a redundant message once should insert all but the delay key and the exception count key into the database" do

data/test/beetle/queue_properties_test.rb

@@ -78,6 +78,36 @@ module Beetle
       @queue_properties.set_queue_policy!(@server, @queue_name, :lazy => false, :dead_lettering => true, :routing_key => "QUEUE_NAME_dead_letter")
     end
 
+    test "deletes policy if its definition corresponds to the broker default policy" do
+      @config.broker_default_policy = { "queue-mode" => "lazy" }
+      stub_request(:get, "http://localhost:15672/api/policies/%2F/QUEUE_NAME_policy")
+        .with(basic_auth: ['guest', 'guest'])
+        .to_return(:status => 200,
+                   :body => {
+                     "vhost" => "/",
+                     "name" => "QUEUE_NAME_policy",
+                     "pattern" => "^QUEUE_NAME$",
+                     "priority" => 1,
+                     "apply-to" => "queues",
+                     "definition" => {
+                       "queue-mode" => "lazy",
+                     }}.to_json)
+      stub_request(:delete, "http://localhost:15672/api/policies/%2F/QUEUE_NAME_policy")
+        .with(basic_auth: ['guest', 'guest'])
+        .to_return(:status => 204)
+
+      @queue_properties.set_queue_policy!(@server, @queue_name, :lazy => true, :dead_lettering => false, :routing_key => "QUEUE_NAME_dead_letter")
+    end
+
+    test "does nothing if its definition corresponds to the broker default policy and the policy does not exist on the server" do
+      @config.broker_default_policy = { "queue-mode" => "lazy" }
+      stub_request(:get, "http://localhost:15672/api/policies/%2F/QUEUE_NAME_policy")
+        .with(basic_auth: ['guest', 'guest'])
+        .to_return(:status => 404)
+
+      @queue_properties.set_queue_policy!(@server, @queue_name, :lazy => true, :dead_lettering => false, :routing_key => "QUEUE_NAME_dead_letter")
+    end
+
     test "creates a policy by posting to the rabbitmq if lazy queues are enabled" do
       stub_request(:get, "http://localhost:15672/api/policies/%2F/QUEUE_NAME_policy")
         .with(basic_auth: ['guest', 'guest'])

data/test/beetle/subscriber_test.rb

@@ -224,13 +224,11 @@ module Beetle
     end
   end
 
-
   class DeadLetteringCallBackExecutionTest < Minitest::Test
     def setup
       @client = Client.new
-      @client.config.dead_lettering_enabled = true
       @queue = "somequeue"
-      @client.register_queue(@queue)
+      @client.register_queue(@queue, :dead_lettering => true)
       @sub = @client.send(:subscriber)
       mq = mock("MQ")
       mq.expects(:closing?).returns(false)
@@ -239,11 +237,7 @@ module Beetle
       @handler = Handler.create(lambda{|*args| raise @exception})
       # handler method 'processing_completed' should be called under all circumstances
       @handler.expects(:processing_completed).once
-      @callback = @sub.send(:create_subscription_callback, "my myessage", @queue, @handler, :exceptions => 1)
-    end
-
-    def teardown
-      @client.config.dead_lettering_enabled = false
+      @callback = @sub.send(:create_subscription_callback, @queue, @queue, @handler, :exceptions => 1)
     end
 
     test "should call reject on the message header when processing the handler returns true on reject? if dead lettering has been enabled" do
@@ -255,19 +249,18 @@ module Beetle
       header.expects(:reject).with(:requeue => false)
       @callback.call(header, 'foo')
     end
-
   end
 
   class CallBackExecutionTest < Minitest::Test
     def setup
-      client = Client.new
+      @client = Client.new
       @queue = "somequeue"
-      client.register_queue(@queue)
-      @sub = client.send(:subscriber)
+      @client.register_queue(@queue)
+      @sub = @client.send(:subscriber)
       @exception = Exception.new "murks"
       @handler = Handler.create(lambda{|*args| raise @exception})
       @handler.instance_eval { def post_process; raise "shoot"; end }
-      @callback = @sub.send(:create_subscription_callback, "my myessage", @queue, @handler, :exceptions => 1)
+      @callback = @sub.send(:create_subscription_callback, @queue, @queue, @handler, :exceptions => 1)
     end
 
     test "exceptions raised from message processing should be ignored" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beetle
 version: !ruby/object:Gem::Version
-  version: 3.3.8
+  version: 3.4.0
 platform: ruby
 authors:
 - Stefan Kaes
@@ -9,10 +9,10 @@ authors:
 - Ali Jelveh
 - Sebastian Roebke
 - Larry Baltz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -34,14 +34,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: hiredis
   requirement: !ruby/object:Gem::Requirement
@@ -359,7 +359,7 @@ homepage: https://xing.github.com/beetle/
 licenses: []
 metadata:
   changelog_uri: https://github.com/xing/beetle/blob/master/RELEASE_NOTES.rdoc
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -376,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 3
 summary: High Availability AMQP Messaging with Redundant Queues
 test_files: