resque-exponential-backoff 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Luke Antins <luke@lividpenguin.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+Software), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+resque-exponential-backoff
+==========================
+
+A [Resque][rq] plugin. Requires Resque 1.8.0 & [resque-scheduler][rqs].
+
+resque-exponential-backoff is a plugin to add retry/exponential backoff to
+your resque jobs.
+
+Usage
+-----
+Simply extend your module/class with this module:
+
+    require 'resque-exponential-backoff'
+    
+    class DeliverWebHook
+        extend Resque::Plugins::ExponentialBackoff
+        
+        def self.perform(url, hook_id, hmac_key)
+            heavy_lifting
+        end
+    end
+  
+
+### BEFORE performing job
+The job increments the number of `attempts` in redis. The first attempt == 1.
+
+### SUCSESSFULL job
+Sucsessful jobs clean up any 'attempts state' from redis.
+
+### FAILED job
+If `attempts < max_attempts` the job will be requeued. The delay between retry
+attempts is determine using the backoff strategy.
+
+*Exceptions are always passed the failure backends.*
+
+Customise & Extend
+------------------
+
+### Defaults
+
+If you just extend with this module and nothing else, these are the defaults:
+
+    @max_attempts = 7
+    
+                # key: m = minutes, h = hours
+                # no delay, 1m, 10m,   1h,    3h,    6h
+    @backoff_strategy = [0, 60, 600, 3600, 10800, 21600]
+
+### Job identifier/key
+
+**n.b.** The job attempts count is incremented/stored in a redis key, the key
+is built using the name of your jobs class/module and its arguments.
+
+If you have lots of arguments, really long ones, you should consider overriding
+`#identifier` to implement a more suitable custom identifier.
+
+    def self.identifier(database_id, massive_url_list, meow_purr)
+        "#{database_id}"
+    end
+
+For the examples in this readme, the default key looks like this:
+
+    exponential-backoff:<name>:<args>
+    exponential-backoff:DeliverWebHook:http://lividpenguin.com-1305-cd8079192'
+
+
+### Custom max attempts, backoff strategy
+
+    # 4 attempts maximum.
+    #
+    # 1st retry: no delay
+    # 2nd retry: 60 seconds delay
+    # nth retry:  2 minutes delay
+    class DeliverWebHook
+        extend Resque::Plugins::ExponentialBackoff
+        
+        @max_attempts = 5
+        @backoff_strategy = [0, 60, 120]
+        
+        def self.perform(url, hook_id, hmac_key)
+            heavy_lifting
+        end
+    end
+
+### Custom delay handling
+
+Override `#retry_delay_seconds` to implement your own delay handling.
+
+    class DeliverWebHook
+        extend Resque::Plugins::ExponentialBackoff
+        @max_attempts = 5
+        
+        def self.perform(url, hook_id, hmac_key)
+            heavy_lifting
+        end
+        
+        def self.retry_delay_seconds
+            (attempts * 60) ** 2
+        end
+    end
+
+
+Install
+-------
+
+    # Once I figure out how to push to rubygems.org...
+    gem install resque-exponential-backoff
+
+
+License
+-------
+Copyright (c) 2010 Luke Antins <luke@lividpenguin.com>
+
+Released under the MIT license. See LICENSE file for details.
+
+[rq]: http://github.com/defunkt/resque
+[rqs]: http://github.com/bvandenbos/resque-scheduler

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/testtask'
+require 'fileutils'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+task :default => :test
+
+##
+# Test task.
+Rake::TestTask.new(:test) do |task|
+    task.libs << 'lib' << 'test'
+    task.test_files = FileList['test/*_test.rb']
+    task.verbose = true
+end
+
+##
+# docs task.
+YARD::Rake::YardocTask.new :yardoc do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--output-dir', "doc/",
+                 '--files', 'LICENSE',
+                 '--readme', 'README.md',
+                 '--title', 'resque-exponential-backoff documentation']
+end

data/lib/resque-exponential-backoff.rb

@@ -0,0 +1,2 @@
+require 'resque_scheduler'
+require 'resque/plugins/exponential_backoff'

data/lib/resque/plugins/exponential_backoff.rb

@@ -0,0 +1,160 @@
+module Resque
+    module Plugins
+        ##
+        # resque-exponential-backoff is a plugin to add retry/exponential backoff
+        # to your resque jobs.
+        # 
+        # Simply extend your module/class with this module:
+        # 
+        #   require 'resque-exponential-backoff'
+        #   
+        #   class DeliverWebHook
+        #       extend Resque::Plugins::ExponentialBackoff
+        #       
+        #       def self.perform(url, hook_id, hmac_key)
+        #           heavy_lifting
+        #       end
+        #   end
+        #
+        # Or do something more custom:
+        #
+        #   class DeliverWebHook
+        #       extend Resque::Plugins::ExponentialBackoff
+        #       
+        #       # max number of attempts.
+        #       @max_attempts = 4
+        #       # retry delay in seconds.
+        #       @backoff_strategy = [0, 60]
+        #
+        #       # used to build redis key to store job attempts counter.
+        #       def self.identifier(url, hook_id, hmac_key)
+        #           "#{url}-#{hook_id}"
+        #       end
+        #
+        #       def self.perform(url, hook_id, hmac_key)
+        #           heavy_lifting
+        #       end
+        #   end
+        module ExponentialBackoff
+            
+            ##
+            # @abstract You may override to implement a custom identifier,
+            #           you should consider doing this if your job arguments
+            #           are many/long or may not cleanly cleanly to strings.
+            #
+            # Builds an identifier using the job arguments. This identifier
+            # is used as part of the redis key.
+            #
+            # @param [Array] args job arguments
+            # @return [String] job identifier
+            def identifier(*args)
+                args.join('-')
+            end
+            
+            ##
+            # Builds the redis key to be used for keeping state of the job
+            # attempts.
+            #
+            # @return [String] redis key
+            def key(*args)
+                ['exponential-backoff', name, identifier(*args)].compact.join(":")
+            end
+            
+            ##
+            # Maximum number of attempts we can use to successfully perform the job.
+            # Default value: 7
+            #
+            # @return [Fixnum] number of attempts
+            def max_attempts
+                @max_attempts ||= 7
+            end
+            
+            ##
+            # Number of attempts so far to try and perform the job.
+            # Default value: 0
+            #
+            # @return [Fixnum] number of attempts
+            def attempts
+                @attempts ||= 0
+            end
+            
+            ##
+            # @abstract You may override to implement your own delay logic.
+            #
+            # Returns the number of seconds to delay until the job is tried
+            # again. By default, this delay is taken from the `#backoff_strategy`.
+            # 
+            # @return [Number, #to_i] number of seconds to delay.
+            def retry_delay_seconds
+                backoff_strategy[attempts - 1] || backoff_strategy.last
+            end
+            
+            ##
+            # Default backoff strategy.
+            # 
+            #   1st retry  :  0 delay
+            #   2nd retry  :  1 minute
+            #   3rd retry  : 10 minutes
+            #   4th retry  :  1 hour
+            #   5th retry  :  3 hours
+            #   6th retry  :  6 hours
+            #
+            # You can set your own backoff strategy in your job module/class:
+            #
+            # @example custom backoff strategy, in your class/module:
+            #   @backoff_strategy = [0, 0, 120]
+            #
+            # Using this strategy, the first two retries will be immediate,
+            # the third and any subsequent retries will be delayed by 2 minutes.
+            def backoff_strategy
+                @backoff_strategy ||= [0, 60, 600, 3600, 10_800, 21_600]
+            end
+            
+            ##
+            # Called before `#perform`.
+            # - Initialise or increment attempts counter.
+            def before_perform_exponential_backoff(*args)
+                Resque.redis.setnx(key(*args), 0)         # default to 0 if not set.
+                @attempts = Resque.redis.incr(key(*args)) # increment by 1.
+            end
+            
+            ##
+            # Called after if `#perform` was successfully.
+            # - Delete attempts counter from redis.
+            def after_perform_exponential_backoff(*args)
+                delete_attempts_counter(*args)
+            end
+            
+            ##
+            # Called if the job raises an exception.
+            # - Requeue the job if maximum attempts has not been reached.
+            def on_failure_exponential_backoff(exception, *args)
+                if attempts >= max_attempts
+                    delete_attempts_counter(*args)
+                    return
+                end
+                
+                requeue(*args)
+            end
+            
+            ##
+            # Delete the attempts counter from redis, keepin it clean ;-)
+            def delete_attempts_counter(*args)
+                Resque.redis.del(key(*args))
+            end
+            
+            ##
+            # Requeue the current job, immediately or delayed if `#retry_delay_seconds`
+            # returns grater then zero.
+            # 
+            # @param [Array] args job arguments
+            def requeue(*args)
+                if retry_delay_seconds > 0
+                    Resque.enqueue_in(retry_delay_seconds, self, *args)
+                else
+                    Resque.enqueue(self, *args)
+                end
+            end
+        end
+    end
+end

data/test/exponential_backoff_test.rb

@@ -0,0 +1,107 @@
+require 'test_helper'
+
+class GoodJob
+    extend Resque::Plugins::ExponentialBackoff
+    @queue = :testing
+    
+    def self.perform(*args)
+    end
+end
+
+module BadJob
+    extend Resque::Plugins::ExponentialBackoff
+    @queue = :testing
+    
+    def self.perform(*args)
+        raise
+    end
+end
+
+module CustomBackoffStrategyJob
+    extend Resque::Plugins::ExponentialBackoff
+    @queue = :testing
+    @backoff_strategy = [3600, 86_400]
+    
+    def self.perform(*args)
+        raise
+    end
+end
+
+module DeliverWebHook
+    extend Resque::Plugins::ExponentialBackoff
+    @queue = :testing
+    
+    def self.retry_delay_seconds
+        attempts * 10
+    end
+    
+    def self.perform(url, hook_id, hmac_key)
+        
+        raise
+    end
+end
+
+class ExponentialBackoffTest < Test::Unit::TestCase
+    def setup
+        Resque.redis.flushall
+        @worker = Resque::Worker.new(:testing)
+    end
+    
+    def test_resque_plugin_lint
+        assert_nothing_raised do
+            Resque::Plugin.lint(Resque::Plugins::ExponentialBackoff)
+        end
+    end
+    
+    def test_resque_version
+        major, minor, patch = Resque::Version.split('.')
+        assert_equal 1, major.to_i, 'major version does not match'
+        assert_operator minor.to_i, :>=, 8, 'minor version is too low'
+    end
+    
+    def test_good_job
+        Resque.enqueue(GoodJob, 1234, { :cats => :maiow }, [true, false, false])
+        @worker.work(0)
+        
+        assert_equal 1, Resque.info[:processed]
+        assert_equal 0, Resque.info[:failed]
+        assert_equal 0, Resque.delayed_queue_schedule_size
+    end
+    
+    def test_retry_job
+        Resque.enqueue(BadJob, 1234)
+        @worker.work(0)
+        
+        assert_equal 2, Resque.info[:processed]
+        assert_equal 2, Resque.info[:failed]
+        assert_equal 1, Resque.delayed_queue_schedule_size
+        # FIXME: below test can be a bit brittle when off by a second.
+        assert_equal Time.now.to_i + 60, Resque.delayed_queue_peek(0, 1).first
+    end
+    
+    def test_custom_backoff_strategy_job
+        Resque.enqueue(CustomBackoffStrategyJob, 1234)
+        Resque.enqueue(CustomBackoffStrategyJob, 1234)
+        @worker.work(0)
+        
+        assert_equal 2, Resque.info[:processed]
+        assert_equal 2, Resque.info[:failed]
+        
+        delayed = Resque.delayed_queue_peek(0, 2)
+        assert_equal Time.now.to_i + 3600, delayed.first
+        assert_equal Time.now.to_i + 86_400, delayed.last
+    end
+    
+    def test_custom_backoff_job
+        Resque.enqueue(DeliverWebHook, 'http://lividpenguin.com', 1305, 'cd8079192d379dc612f17c660591a6cfb05f1dda')
+        Resque.enqueue(DeliverWebHook, 'http://lividpenguin.com', 1305, 'cd8079192d379dc612f17c660591a6cfb05f1dda')
+        @worker.work(0)
+        
+        assert_equal 2, Resque.info[:processed]
+        assert_equal 2, Resque.info[:failed]
+        
+        delayed = Resque.delayed_queue_peek(0, 2)
+        assert_equal Time.now.to_i + 10, delayed.first
+        assert_equal Time.now.to_i + 20, delayed.last
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+rootdir = File.dirname(File.dirname(__FILE__))
+$LOAD_PATH.unshift rootdir + '/test'
+$LOAD_PATH.unshift rootdir + '/lib'
+
+require 'test/unit'
+require 'resque'
+
+begin
+    require 'turn' # nicer test output.
+rescue LoadError
+end
+
+require 'resque-exponential-backoff'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: resque-exponential-backoff
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Luke Antins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-scheduler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: |
+  A resque plugin that adds retry/exponential backoff functionality to your
+  resque jobs.
+  
+  Simply extend your module/class with this module:
+      
+      require 'resque-exponential-backoff'
+      
+      class DeliverWebHook
+          extend Resque::Plugins::ExponentialBackoff
+          
+          def self.perform(url, hook_id, hmac_key)
+              heavy_lifting
+          end
+      end
+
+email: luke@lividpenguin.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README.md
+- test/exponential_backoff_test.rb
+- test/test_helper.rb
+- lib/resque/plugins/exponential_backoff.rb
+- lib/resque-exponential-backoff.rb
+has_rdoc: false
+homepage: http://github.com/lantins/resque-exponential-backoff
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A resque plugin, add retry/exponential backoff to your resque jobs.
+test_files: []
+