rabbit-wq 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99990b341472fc45fb672ae58b4248c85ef210b3
-  data.tar.gz: 392e5f66abc7537ec8ea1b14c25bb81d2f791acd
+  metadata.gz: c97ac243defa2aac2f23a698f956eac51dfa8574
+  data.tar.gz: 3339d19f9f1d53523e05343c2e69e906111f3afb
 SHA512:
-  metadata.gz: 30582b9f999ad7e9296ac8f79094882bfca690d20cd2163551e3122a53d4e428e9c1fb4a0bed51b14599ebc6aa27a8ce6bd3ef723519b4af8ee998eb213aea75
-  data.tar.gz: 5e21ba5f485f56d472482febfd6af03c61dc1bf2d8b9bd0c781402297eb1d4bb5d818a1523041e72b2bff349324491265431c109e438d640a8d54dca1146287f
+  metadata.gz: a411faf8ad4c6a2fc5c79059898172754f0661f42ce7dd35db00709c487b322c2ac94ef0c2cdabb18974c5f7de0fdb38b67ffae7c1e111966680ae4ae69dbb27
+  data.tar.gz: f4042f81efaa480cdb975f1e8df376e1d504b1d934a02888150085d124f0eeb875df25387f161c4e430768c989cdfc2a096301dbae2d390f0b8962a644210422

data/README.md

@@ -68,6 +68,30 @@ Or install it yourself as:
 
     RabbitWQ::Work.enqueue( worker, retry: 1, retry_delay: 30000 )
 
+#### Skipping Retry by Forcing a Final Error
+
+You can use the RabbitWQ::FinalError to skip retry functionality in the case of an error that will never recover given a time delay.
+
+    class SomeWorker < Struct.new( :some_variable )
+      def call
+        final_error( "Some message" )
+      end
+    end
+
+The #final_error method will raise a RabbitWQ::FinalError which triggers the normal final error functionality (callbacks, logging, 
+error queue queueing).  If you owuld like to treat the final error as something other than an error level occurence, you can pass the level
+to #final_error.
+
+    class SomeWorker < Struct.new( :some_variable )
+      def call
+        final_error( "Some message", :info )
+      end
+    end
+
+When a level other than :error is provided, an log entry to the work log is created at the level provided, ie. :info.  However, an error is
+not logged and an error is not queued on the error queue.  The error callbacks are still executed.  If you want to avoid functionality in 
+an existing callback, you can test the #level of the error.
+
 ### Queueing Work with a Retry and Auto-Scaling Retry Dealy
 
     RabbitWQ::Work.enqueue( worker, retry: 1, retry_delay: 'auto-scale' )

data/lib/rabbit_wq.rb

@@ -10,6 +10,7 @@ module RabbitWQ
 
   autoload :Command,        'rabbit_wq/command'
   autoload :Configuration,  'rabbit_wq/configuration'
+  autoload :FinalError,     'rabbit_wq/final_error'
   autoload :Logging,        'rabbit_wq/logging'
   autoload :Queues,         'rabbit_wq/queues'
   autoload :MessageHandler, 'rabbit_wq/message_handler'

data/lib/rabbit_wq/final_error.rb

@@ -0,0 +1,11 @@
+module RabbitWQ
+  class FinalError < StandardError
+
+    attr_reader :level
+
+    def initialize( level=:error )
+      @level = level
+    end
+
+  end
+end

data/lib/rabbit_wq/message_handler.rb

@@ -24,7 +24,6 @@ module RabbitWQ
       try_on_success_callback( worker )
       channel.ack delivery_info.delivery_tag
     rescue => e
-      error e
       handle_error( worker, e, channel, delivery_info, payload, metadata )
     end
 
@@ -49,7 +48,7 @@ module RabbitWQ
                          message: e.message,
                          backtrace: e.backtrace }
 
-      if headers && headers['retry']
+      if headers && headers['retry'] && !e.is_a?( RabbitWQ::FinalError )
         attempt = headers.fetch( 'attempt', 1 ).to_i
 
         if attempt < headers['retry']
@@ -61,6 +60,7 @@ module RabbitWQ
 
           Work.enqueue_payload( payload, headers.merge( delay: retry_delay, attempt: attempt + 1 ).
                                                  merge( error: error_metadata ))
+          error( e )
           worker_error( worker, "ERROR WITH RETRY " + error_metadata.inspect )
           try_on_error_callback( worker, e )
           try_on_retryable_error_callback( worker, e )
@@ -69,7 +69,16 @@ module RabbitWQ
         end
       end
 
+      if e.is_a?( RabbitWQ::FinalError ) && e.level != :error
+        RabbitWQ.work_logger.send( e.level, worker, e.message )
+        try_on_error_callback( worker, e )
+        try_on_final_error_callback( worker, e )
+        channel.nack delivery_info.delivery_tag
+        return
+      end
+
       Work.enqueue_error_payload( payload, error: error_metadata )
+      error( e )
       worker_error( worker, "FINAL ERROR " + error_metadata.inspect )
       try_on_error_callback( worker, e )
       try_on_final_error_callback( worker, e )

data/lib/rabbit_wq/version.rb

@@ -1,3 +1,3 @@
 module RabbitWQ
-  VERSION = "1.6.3"
+  VERSION = "1.7.0"
 end

data/lib/rabbit_wq/worker.rb

@@ -37,6 +37,10 @@ module RabbitWQ
       true
     end
 
+    def final_error( msg, level=:error )
+      raise RabbitWQ::FinalError.new( level ), msg
+    end
+
     # When true, will place the worker in error queue
     #
     def error_on_disabled?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbit-wq
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - C. Jason Harrelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ files:
 - lib/rabbit_wq/cli.rb
 - lib/rabbit_wq/command.rb
 - lib/rabbit_wq/configuration.rb
+- lib/rabbit_wq/final_error.rb
 - lib/rabbit_wq/logging.rb
 - lib/rabbit_wq/message_handler.rb
 - lib/rabbit_wq/queues.rb