beetle 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5f5128c31760c138a20945e91916f87f3da03794c9b342ba94a810325b88fa6
-  data.tar.gz: 6166c1d54ac5266f1fd66e306736df5f27ee3286e4f12d9dbb20de690367be9b
+  metadata.gz: 136ef3ee13c61c833081834cca6ad34323af71328f3ec1f21b6aa412167cf1a2
+  data.tar.gz: 026b2705d3b6d202b756ff6da3b56a385da5dc16453e2099419fe69c7f69905f
 SHA512:
-  metadata.gz: e5ead5bd603609b459e3d76f7a917d5d9b3346e641936b20695f15e53740de358f25c796f6a69e97c644544b92e28832bcf11532dd9d13a50253174d7922b6f0
-  data.tar.gz: 3b5edb7ff6978a85ce29a426148918a2354ad6f065afb6124753e624b588f1e479bf4c81f556434d1d3a01638bfdd826e1de39976c44cbdaa2bc0b80cf073b5a
+  metadata.gz: 40233f2af492cccd37792173a1541dc6f3bb55c59a1709fec2d2fb437ff62d12e3ff6d0243284a142dd0b8d51dacf2e5d2b45afd2bd244e8f5eae6dbdbd81257
+  data.tar.gz: 4dc724d9f5566102642191bc0628b83fc9b933f6a03418b5f9e5dbb0433e66ec8d6450d91d3ba7593d4436b91d5511a297287db393970d4aba30d5856cd269fb

data/RELEASE_NOTES.rdoc

@@ -1,5 +1,11 @@
 = Release Notes
 
+== Version 2.2.0
+
+* Support specifying a whitelist of retriable exceptions when registering a
+  message handler. Exceptions which are not on the list will be regarded as
+  irrecoverable failures.
+
 == Version 2.1.2
 
 * Fixed that redis key GC would never complete when a key scheduled

data/lib/beetle/message.rb

@@ -1,7 +1,7 @@
 require "timeout"
 
 module Beetle
-  # Instances of class Message are created when a scubscription callback fires. Class
+  # Instances of class Message are created when a subscription callback fires. Class
   # Message contains the code responsible for message deduplication and determining if it
   # should retry executing the message handler after a handler has crashed (or forcefully
   # aborted).
@@ -52,6 +52,8 @@ module Beetle
     attr_reader :attempts_limit
     # how many exceptions we should tolerate before giving up
     attr_reader :exceptions_limit
+    # array of exceptions accepted to be rescued and retried
+    attr_reader :retry_on
     # exception raised by handler execution
     attr_reader :exception
     # value returned by handler execution
@@ -72,6 +74,7 @@ module Beetle
       @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
@@ -79,7 +82,6 @@ module Beetle
 
     # extracts various values from the AMQP header properties
     def decode #:nodoc:
-      # p header.attributes
       amqp_headers = header.attributes
       @uuid = amqp_headers[:message_id]
       @timestamp = amqp_headers[:timestamp]
@@ -138,7 +140,7 @@ module Beetle
       Time.now.to_i
     end
 
-    # a message has expired if the header expiration timestamp is msaller than the current time
+    # a message has expired if the header expiration timestamp is smaller than the current time
     def expired?
       @expires_at < now
     end
@@ -218,6 +220,10 @@ module Beetle
       @store.get(msg_id, :exceptions).to_i > exceptions_limit
     end
 
+    def exception_accepted?
+      @exception.nil? || retry_on.nil? || retry_on.any?{ |klass| @exception.is_a? klass}
+    end
+
     # 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?
@@ -347,6 +353,11 @@ module Beetle
         ack!
         logger.debug "Beetle: reached the handler exceptions limit: #{exceptions_limit} on #{msg_id}"
         RC::ExceptionsLimitReached
+      elsif !exception_accepted?
+        completed!
+        ack!
+        logger.debug "Beetle: `#{@exception.class.name}` not accepted: `retry_on`=[#{retry_on.join(',')}] on #{msg_id}"
+        RC::ExceptionNotAccepted
       else
         delete_mutex!
         timed_out!

data/lib/beetle/r_c.rb

@@ -30,6 +30,7 @@ module Beetle
     rc :Ancient
     rc :AttemptsLimitReached, :failure
     rc :ExceptionsLimitReached, :failure
+    rc :ExceptionNotAccepted, :failure
     rc :Delayed, :reject
     rc :HandlerCrash, :reject
     rc :HandlerNotYetTimedOut, :reject

data/lib/beetle/version.rb

@@ -1,3 +1,3 @@
 module Beetle
-  VERSION = "2.1.2"
+  VERSION = "2.2.0"
 end

data/test/beetle/message_test.rb

@@ -345,7 +345,7 @@ module Beetle
       assert_equal "52", @store.get(message.msg_id, :delay)
     end
 
-    test "a message should delete the mutex before resetting the timer if attempts and exception limits havn't been reached" do
+    test "a message should delete the mutex before resetting the timer if attempts and exception limits haven't been reached" do
       Message.stubs(:now).returns(9)
       header = header_with_params({})
       message = Message.new("somequeue", header, 'foo', :delay => 42, :timeout => 10.seconds, :exceptions => 1, :store => @store)
@@ -377,6 +377,41 @@ module Beetle
       assert_equal RC::ExceptionsLimitReached, message.__send__(:process_internal, proc)
     end
 
+    test "a message should not be acked if the handler crashes and the exception has been registered" do
+      header = header_with_params({})
+      RegisteredException = Class.new(StandardError)
+      message = Message.new("somequeue", header, 'foo', :timeout => 10.seconds, :exceptions => 2,
+                            :retry_on => [RegisteredException], :store => @store)
+      assert !message.attempts_limit_reached?
+      assert !message.exceptions_limit_reached?
+      assert !message.timed_out?
+      assert !message.simple?
+      assert message.exception_accepted? # @exception yet nil, hence 'accepted'
+
+      proc = lambda {|_| raise RegisteredException, "crash"}
+      message.expects(:completed!).never
+      header.expects(:ack).never
+      assert_equal RC::HandlerCrash, message.__send__(:process_internal, proc)
+    end
+
+    test "a message should be acked if the handler crashes and the exception has not been registered" do
+      header = header_with_params({})
+      RegisteredException = Class.new(StandardError)
+      OtherException = Class.new(StandardError)
+      message = Message.new("somequeue", header, 'foo', :timeout => 10.seconds, :exceptions => 2,
+                            :retry_on => [RegisteredException], :store => @store)
+      assert !message.attempts_limit_reached?
+      assert !message.exceptions_limit_reached?
+      assert !message.timed_out?
+      assert !message.simple?
+      assert message.exception_accepted? # @exception yet nil, hence 'accepted'
+
+      proc = lambda {|_| raise OtherException, "crash"}
+      message.expects(:completed!).once
+      header.expects(:ack)
+      assert_equal RC::ExceptionNotAccepted, message.__send__(:process_internal, proc)
+    end
+
     test "a message should be acked if the handler crashes and the attempts limit has been reached" do
       header = header_with_params({})
       message = Message.new("somequeue", header, 'foo', :timeout => 10.seconds, :attempts => 2, :store => @store)
@@ -647,8 +682,8 @@ module Beetle
         adapter:  "mysql2",
         username: "root",
         encoding: "utf8",
-        host: "127.0.0.1",
-        port: 3306
+        host: ENV['MYSQL_HOST'] || "127.0.0.1",
+        port: ENV['MYSQL_PORT'] || 3306
       )
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beetle
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Stefan Kaes
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid4r