activejob-retry 0.0.1 → 0.1.1

data/test/support/integration/adapters/sidekiq.rb

@@ -0,0 +1,58 @@
+require 'sidekiq/cli'
+require 'sidekiq/api'
+
+module SidekiqJobsManager
+
+  def setup
+    ActiveJob::Base.queue_adapter = :sidekiq
+    unless can_run?
+      puts "Cannot run integration tests for sidekiq. To be able to run integration tests for sidekiq you need to install and start redis.\n"
+      exit
+    end
+  end
+
+  def clear_jobs
+    Sidekiq::ScheduledSet.new.clear
+    Sidekiq::Queue.new("integration_tests").clear
+  end
+
+  def start_workers
+    fork do
+      sidekiq = Sidekiq::CLI.instance
+      logfile = Rails.root.join("log/sidekiq.log").to_s
+      pidfile = Rails.root.join("tmp/sidekiq.pid").to_s
+      sidekiq.parse([ "--require", Rails.root.to_s,
+                      "--queue",   "integration_tests",
+                      "--logfile", logfile,
+                      "--pidfile", pidfile,
+                      "--environment", "test",
+                      "--concurrency", "1",
+                      "--timeout", "1",
+                      "--daemon",
+                      ])
+      require 'celluloid'
+      require 'sidekiq/scheduled'
+      Sidekiq.poll_interval = 0.5
+      Sidekiq::Scheduled.const_set :INITIAL_WAIT, 1
+      sidekiq.run
+    end
+    sleep 1
+  end
+
+  def stop_workers
+    pidfile = Rails.root.join("tmp/sidekiq.pid").to_s
+    Process.kill 'TERM', File.open(pidfile).read.to_i
+    FileUtils.rm_f pidfile
+  rescue
+  end
+
+  def can_run?
+    begin
+      Sidekiq.redis(&:info)
+      Sidekiq.logger = nil
+    rescue
+      return false
+    end
+    true
+  end
+end

data/test/support/integration/dummy_app_template.rb

@@ -0,0 +1,28 @@
+rake("db:create")
+
+if ENV['AJADAPTER'] == 'delayed_job'
+  generate "delayed_job:active_record", "--quiet"
+  rake("db:migrate")
+end
+
+initializer 'activejob.rb', <<-CODE
+require "#{File.expand_path("../jobs_manager.rb",  __FILE__)}"
+JobsManager.current_manager.setup
+CODE
+
+file 'app/jobs/test_job.rb', <<-CODE
+class TestJob < ActiveJob::Base
+  include ActiveJob::Retry
+
+  queue_as :integration_tests
+  constant_retry limit: 2, delay: 3
+
+  def perform(x, fail_first = false)
+    raise "Failing first" if fail_first && retry_attempt == 1
+
+    File.open(Rails.root.join("tmp/\#{x}"), "w+") do |f|
+      f.write x
+    end
+  end
+end
+CODE

data/test/support/integration/helper.rb

@@ -0,0 +1,30 @@
+puts "*** rake aj:integration:#{ENV['AJADAPTER']} ***\n"
+
+ENV["RAILS_ENV"] = "test"
+ActiveJob::Base.queue_name_prefix = nil
+
+require 'rails/generators/rails/app/app_generator'
+
+dummy_app_path     = Dir.mktmpdir + "/dummy"
+dummy_app_template = File.expand_path("../dummy_app_template.rb",  __FILE__)
+args = Rails::Generators::ARGVScrubber.new(["new", dummy_app_path, "--skip-gemfile", "--skip-bundle",
+  "--skip-git", "--skip-spring", "-d", "sqlite3", "--skip-javascript", "--force", "--quiet",
+  "--template", dummy_app_template]).prepare!
+Rails::Generators::AppGenerator.start args
+
+require "#{dummy_app_path}/config/environment.rb"
+
+ActiveRecord::Migrator.migrations_paths = [ Rails.root.join('db/migrate').to_s ]
+require 'rails/test_help'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+require_relative 'test_case_helpers'
+ActiveSupport::TestCase.send(:include, TestCaseHelpers)
+
+JobsManager.current_manager.start_workers
+
+Minitest.after_run do
+  JobsManager.current_manager.stop_workers
+  JobsManager.current_manager.clear_jobs
+end

data/test/support/integration/jobs_manager.rb

@@ -0,0 +1,27 @@
+class JobsManager
+  @@managers = {}
+  attr :adapter_name
+
+  def self.current_manager
+    @@managers[ENV['AJADAPTER']] ||= new(ENV['AJADAPTER'])
+  end
+
+  def initialize(adapter_name)
+    @adapter_name = adapter_name
+    require_relative "adapters/#{adapter_name}"
+    extend "#{adapter_name.camelize}JobsManager".constantize
+  end
+
+  def setup
+    ActiveJob::Base.queue_adapter = nil
+  end
+
+  def clear_jobs
+  end
+
+  def start_workers
+  end
+
+  def stop_workers
+  end
+end

data/test/support/integration/test_case_helpers.rb

@@ -0,0 +1,48 @@
+require 'active_support/concern'
+require 'support/integration/jobs_manager'
+
+module TestCaseHelpers
+  extend ActiveSupport::Concern
+
+  included do
+    self.use_transactional_fixtures = false
+
+    setup do
+      clear_jobs
+      @id = "AJ-#{SecureRandom.uuid}"
+    end
+
+    teardown do
+      clear_jobs
+    end
+  end
+
+  protected
+
+    def jobs_manager
+      JobsManager.current_manager
+    end
+
+    def clear_jobs
+      jobs_manager.clear_jobs
+    end
+
+    def adapter_is?(adapter)
+      ActiveJob::Base.queue_adapter.name.split("::").last.gsub(/Adapter$/, '').underscore==adapter.to_s
+    end
+
+    def wait_for_jobs_to_finish_for(seconds=60)
+      begin
+        Timeout.timeout(seconds) do
+          while !job_executed do
+            sleep 0.25
+          end
+        end
+      rescue Timeout::Error
+      end
+    end
+
+    def job_executed
+      Dummy::Application.root.join("tmp/#{@id}").exist?
+    end
+end

data/test/support/job_buffer.rb

@@ -0,0 +1,19 @@
+module JobBuffer
+  class << self
+    def clear
+      values.clear
+    end
+
+    def add(value)
+      values << value
+    end
+
+    def values
+      @values ||= []
+    end
+
+    def last_value
+      values.last
+    end
+  end
+end

data/test/support/que/inline.rb

@@ -0,0 +1,9 @@
+require 'que'
+
+Que::Job.class_eval do
+  class << self; alias_method :original_enqueue, :enqueue; end
+  def self.enqueue(*args)
+    args.pop if args.last.is_a?(Hash)
+    self.run(*args)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob-retry
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Isaac Seymour
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -95,12 +95,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
-      activejob-retry provides a simple DSL for automatically retrying ActiveJobs when they
-      fail, with exponential backoff.
+      activejob-retry provides automatic retry functionality for failed
+      ActiveJobs, with exponential backoff.
 
       Features:
 
-      * (Should) work with any queue adapter that supports retries.
+      * Works with any queue adapter that supports retries.
       * Whitelist/blacklist exceptions to retry on.
       * Exponential backoff (varying the delay between retries).
       * Light and easy to override retry logic.
@@ -112,6 +112,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -120,17 +121,64 @@ files:
 - README.md
 - Rakefile
 - activejob-retry.gemspec
-- lib/active_job-retry.rb
 - lib/active_job/retry.rb
+- lib/active_job/retry/constant_backoff_strategy.rb
+- lib/active_job/retry/constant_options_validator.rb
 - lib/active_job/retry/deserialize_monkey_patch.rb
-- lib/active_job/retry/exponential_backoff.rb
-- lib/active_job/retry/exponential_options_validator.rb
-- lib/active_job/retry/invalid_configuration_error.rb
-- lib/active_job/retry/options_validator.rb
+- lib/active_job/retry/errors.rb
+- lib/active_job/retry/variable_backoff_strategy.rb
+- lib/active_job/retry/variable_options_validator.rb
 - lib/active_job/retry/version.rb
+- spec/retry/constant_backoff_strategy_spec.rb
+- spec/retry/constant_options_validator_spec.rb
+- spec/retry/variable_backoff_strategy_spec.rb
+- spec/retry/variable_options_validator_spec.rb
 - spec/retry_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/isaacseymour/activejob-retry
+- test/adapters/backburner.rb
+- test/adapters/delayed_job.rb
+- test/adapters/inline.rb
+- test/adapters/qu.rb
+- test/adapters/que.rb
+- test/adapters/queue_classic.rb
+- test/adapters/resque.rb
+- test/adapters/sidekiq.rb
+- test/adapters/sneakers.rb
+- test/adapters/sucker_punch.rb
+- test/cases/adapter_test.rb
+- test/cases/argument_serialization_test.rb
+- test/cases/callbacks_test.rb
+- test/cases/job_serialization_test.rb
+- test/cases/logging_test.rb
+- test/cases/queue_naming_test.rb
+- test/cases/queuing_test.rb
+- test/cases/rescue_test.rb
+- test/cases/test_case_test.rb
+- test/cases/test_helper_test.rb
+- test/helper.rb
+- test/integration/queuing_test.rb
+- test/jobs/callback_job.rb
+- test/jobs/gid_job.rb
+- test/jobs/hello_job.rb
+- test/jobs/logging_job.rb
+- test/jobs/nested_job.rb
+- test/jobs/rescue_job.rb
+- test/models/person.rb
+- test/support/backburner/inline.rb
+- test/support/delayed_job/delayed/backend/test.rb
+- test/support/delayed_job/delayed/serialization/test.rb
+- test/support/integration/adapters/backburner.rb
+- test/support/integration/adapters/delayed_job.rb
+- test/support/integration/adapters/que.rb
+- test/support/integration/adapters/resque.rb
+- test/support/integration/adapters/sidekiq.rb
+- test/support/integration/dummy_app_template.rb
+- test/support/integration/helper.rb
+- test/support/integration/jobs_manager.rb
+- test/support/integration/test_case_helpers.rb
+- test/support/job_buffer.rb
+- test/support/que/inline.rb
+homepage: http://github.com/gocardless/activejob-retry
 licenses:
 - MIT
 metadata: {}
@@ -153,6 +201,6 @@ rubyforge_project:
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: Automatic retrying DSL for ActiveJob
+summary: Automatic retry functionality for ActiveJob.
 test_files: []
 has_rdoc: false

data/lib/active_job-retry.rb

@@ -1,14 +0,0 @@
-require 'active_job'
-require 'active_support'
-
-require 'active_job/retry'
-require 'active_job/retry/exponential_backoff'
-require 'active_job/retry/invalid_configuration_error'
-require 'active_job/retry/options_validator'
-require 'active_job/retry/exponential_options_validator'
-
-require 'active_job/retry/version'
-
-unless ActiveJob::Base.method_defined?(:deserialize)
-  require 'active_job/retry/deserialize_monkey_patch'
-end

data/lib/active_job/retry/exponential_backoff.rb

@@ -1,92 +0,0 @@
-module ActiveJob
-  module Retry
-    # If you want your job to retry on failure using a varying delay, simply
-    # extend your class with this module:
-    #
-    #   class DeliverSMS < ActiveJob::Base
-    #     extend ActiveJob::Retry::ExponentialBackoff
-    #     queue_as :messages
-    #
-    #     def perform(mobile_number, message)
-    #       SmsService.deliver!(mobile_number, message)
-    #     end
-    #   end
-    #
-    # Easily do something custom:
-    #
-    #   class DeliverSMS
-    #     extend ActiveJob::Retry::ExponentialBackoff
-    #     queue_as :messages
-    #
-    #     # Options from ActiveJob::Retry can also be used
-    #     retry_with strategy: [0, 60], # retry immediately, then after 60 seconds
-    #                min_delay_multiplier: 0.8, # multiply the delay by a random number
-    #                max_delay_multiplier: 1.5  # between 0.8 and 1.5
-    #
-    #     def perform(mobile_number, message)
-    #       SmsService.deliver!(mobile_number, message)
-    #     end
-    #   end
-    #
-    module ExponentialBackoff
-      include ActiveJob::Retry
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        include ActiveJob::Retry::ClassMethods
-
-        # Setup DSL
-        def backoff_with(options)
-          retry_with(options)
-          ExponentialOptionsValidator.new(options).validate!
-
-          @retry_limit          = options[:limit] || options[:strategy].length if options[:strategy]
-          @backoff_strategy     = options[:strategy]             if options[:strategy]
-          @min_delay_multiplier = options[:min_delay_multiplier] if options[:min_delay_multiplier]
-          @max_delay_multiplier = options[:max_delay_multiplier] if options[:max_delay_multiplier]
-        end
-
-        ############
-        # Defaults #
-        ############
-        def retry_limit
-          @retry_limit ||= (backoff_strategy || []).length
-        end
-
-        def backoff_strategy
-          @backoff_strategy ||= nil
-        end
-
-        def min_delay_multiplier
-          @min_delay_multiplier ||= 1.0
-        end
-
-        def max_delay_multiplier
-          @max_delay_multiplier ||= 1.0
-        end
-      end
-
-      ###############
-      # Retry logic #
-      ###############
-      def retry_delay
-        delay = self.class.backoff_strategy[retry_attempt]
-
-        return (delay * self.class.max_delay_multiplier).to_i unless random_delay?
-
-        (delay * rand(random_delay_range)).to_i
-      end
-
-      def random_delay?
-        self.class.min_delay_multiplier != self.class.max_delay_multiplier
-      end
-
-      def random_delay_range
-        self.class.min_delay_multiplier..self.class.max_delay_multiplier
-      end
-    end
-  end
-end