surety 0.1.9 → 0.1.10

data/README.md

@@ -35,10 +35,18 @@ Configuration
 
 Both the prefix for the ActiveRecord database connection name (as specified in database.yml) and the class to which Surety delegates messages for processing after pulling them off the queue are configurable.
 
+Also configurable are three parameters related to failure retries: 
+ * retry interval: base amount of time to wait before a retry, in minutes. Defaults to 10. 
+ * backoff factor: factor to divide the failure count by before calculating an exponential backoff. The backoff factor is (2^floor(failure count/backoff interval)). Defaults to 2.
+ * max backoff: maximum number of powers of 2 to backoff. Defaults to 7 (which gives a backoff factor of 128; together with the default retry interval of 10, this produces a default max backoff amount of 1280 minutes ~ 1 day).
+
 Example configuration (from a sample config/initializers/surety.rb file)
 
 Surety::Configuration.database_prefix = 'surety_'
 Surety::Configuration.message_processing_delegate = MessageDistributor
+Surety::Configuration.retry_interval = 20
+Surety::Configuration.backoff_factor = 4
+Surety::Configuration.max_backoff = 5
 
 
 Install

data/lib/surety/configuration.rb

@@ -2,7 +2,7 @@ module Surety
   module Configuration
     extend self
     
-    attr_accessor :database_prefix, :message_processing_delegate
+    attr_accessor :database_prefix, :message_processing_delegate, :retry_interval, :backoff_factor, :max_backoff
     
     def database
       "#{database_prefix}#{ENV['RAILS_ENV'] || Rails.env}"

data/lib/surety/generator.rb

@@ -1,14 +1,9 @@
 module Surety
   module Generator
-    extend ActiveSupport::Concern
-    
-    module InstanceMethods
-      
-      def send_message(message_content)
-        Surety::Message.generate_message(message_content)
-      end
-      
+
+    def send_message(message_content)
+      Surety::Message.generate_message(message_content)
     end
-  
+
   end
-end
+end

data/lib/surety/message.rb

@@ -9,11 +9,13 @@ module Surety
     scope :failed,      where(:state => 'failed')
     
     scope :needs_processing, lambda {
-      puts ActiveRecord::Base.default_timezone
-      puts ActiveRecord::Base.default_timezone.to_s=='utc'
       db_time = Time.now.send(ActiveRecord::Base.default_timezone.to_s=='utc' ? :utc : :localtime)
-      puts db_time
-      {:conditions=>"(messages.state='unprocessed') or (messages.state='failed' and messages.failed_at<'#{(db_time-10.minutes).strftime('%Y-%m-%d %H:%M:%S')}')",
+      {:conditions=>"(messages.state='unprocessed') or (messages.state='failed' and messages.failed_at<('#{(db_time).strftime('%Y-%m-%d %H:%M:%S')}' - 
+        INTERVAL (#{Surety::Configuration.retry_interval || 10}*
+        POW(2, if(floor(failure_count/#{Surety::Configuration.backoff_factor || 2})>#{Surety::Configuration.max_backoff || 7}, 
+        #{Surety::Configuration.max_backoff || 7},
+        floor(failure_count/#{Surety::Configuration.backoff_factor || 2})))) 
+        MINUTE))",
       :order => :created_at, :limit=>1}
     }
 

data/surety.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'surety'
-  s.version           = '0.1.9'
+  s.version           = '0.1.10'
   s.date              = Time.now.strftime('%Y-%m-%d')
   s.summary           = 'A lightweight guaranteed-delivery messaging system.'
   s.homepage          = ''

data/test/message_backoff_test.rb

@@ -0,0 +1,50 @@
+require File.expand_path('test_helper.rb', File.dirname(__FILE__))
+
+class MessageBackoffTest < Test::Unit::TestCase
+  
+  def setup
+    Surety::Configuration.database_prefix = 'surety_'
+    Surety::Message.new.connection.execute("truncate table messages")
+    @message = Surety::Message.generate_message('Testing message')
+    @message.begin_processing!
+    @message.fail_processing!
+  end
+  
+  def test_backoff_with_one_failure
+    # Before interval
+    message = Surety::Message.needs_processing.first
+    assert message.nil?
+    # After interval
+    @message.failed_at = Time.now-12.minutes
+    @message.save
+    message = Surety::Message.needs_processing.first
+    assert message.present?
+  end
+  
+  def test_backoff_with_backoff_factor_failures
+    @message.failed_at = Time.now-12.minutes
+    @message.failure_count = 2
+    # Before interval
+    message = Surety::Message.needs_processing.first
+    assert message.nil?
+    # After interval
+    @message.failed_at = Time.now-21.minutes
+    @message.save
+    message = Surety::Message.needs_processing.first
+    assert message.present?
+  end
+  
+  def test_max_backoff
+    @message.failed_at = Time.now-1277.minutes
+    @message.failure_count = 20
+    # Before interval
+    message = Surety::Message.needs_processing.first
+    assert message.nil?
+    # After interval
+    @message.failed_at = Time.now-1285.minutes
+    @message.save
+    message = Surety::Message.needs_processing.first
+    assert message.present?
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: surety
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 1
-  - 9
-  version: 0.1.9
+  - 10
+  version: 0.1.10
 platform: ruby
 authors: 
 - Monica McArthur
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-26 00:00:00 Z
+date: 2012-01-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yajl-ruby
@@ -138,6 +138,7 @@ files:
 - test/fixtures/test_delegate.rb
 - test/fixtures/test_generator.rb
 - test/generator_test.rb
+- test/message_backoff_test.rb
 - test/message_test.rb
 - test/message_timezone_test.rb
 - test/processor_test.rb
@@ -183,6 +184,7 @@ test_files:
 - test/fixtures/test_delegate.rb
 - test/fixtures/test_generator.rb
 - test/generator_test.rb
+- test/message_backoff_test.rb
 - test/message_test.rb
 - test/message_timezone_test.rb
 - test/processor_test.rb