rocketjob 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73879d59ee0d46f407f77acfc5b443b693e16727
-  data.tar.gz: 27d8a5a990b39d19c00ff086d57b3df2263eb727
+  metadata.gz: 39e1ecc5af4c504fb096f81dd86504bbd80d2336
+  data.tar.gz: 0b25172aa4de31ae79713a7c5427d1c985163384
 SHA512:
-  metadata.gz: 3fb4043fb6aca63ecb3968393aada59cd81101d69453592cc5032722d1751ce3716c095dee54baa0be77136df05f36ce49687d1a4f1a66a37c68feeae22870b9
-  data.tar.gz: ff2c14ea7b456f59f86b85f34174a2ab0d90d72799c7e839b90def2a288b44969f8a558a915129df0dce726d9b0d28252c91d1f9d5aefaf331dcf43d9500cd51
+  metadata.gz: 62efb08e25832d84977ec3060982167c0e6958d4b9380f8ecf67f7a64c18b1a4be2765e086bc9d07cade9edaf6a3d8077a725329df6c1c27543d35072b0918c1
+  data.tar.gz: 3f4380575fc99756a2fd63f9d84f571c9ff1ce12dbeab8d642aacd2c4c4b04a54ba98416d6d04dd00760aeb59427304815a755e0dc205770fcf8293776db97cc

data/lib/rocket_job/active_worker.rb

@@ -16,7 +16,7 @@ module RocketJob
     def self.all(server_name = nil)
       servers = []
       # Need paused, failed or aborted since servers may still be working on active slices
-      query   = RocketJob::Job.where(:state.in => [:running, :paused, :failed, :aborted])
+      query = RocketJob::Job.where(:state.in => [:running, :paused, :failed, :aborted])
       query = query.where(worker_name: /\A#{server_name}/) if server_name
       query.each do |job|
         servers += job.rocket_job_active_workers

data/lib/rocket_job/cli.rb

@@ -7,8 +7,8 @@ module RocketJob
   class CLI
     include SemanticLogger::Loggable
     attr_accessor :name, :workers, :environment, :pidfile, :directory, :quiet,
-      :log_level, :log_file, :mongo_config, :symmetric_encryption_config,
-      :filter
+                  :log_level, :log_file, :mongo_config, :symmetric_encryption_config,
+                  :filter
 
     def initialize(argv)
       @name                        = nil

data/lib/rocket_job/dirmon_entry.rb

@@ -234,7 +234,7 @@ module RocketJob
           next if file_name.include?(self.class.default_archive_directory)
 
           # Security check?
-          if (whitelist_paths.size > 0) && whitelist_paths.none? {|whitepath| file_name.to_s.start_with?(whitepath)}
+          if (whitelist_paths.size > 0) && whitelist_paths.none? { |whitepath| file_name.to_s.start_with?(whitepath) }
             logger.error "Skipping file: #{file_name} since it is not in any of the whitelisted paths: #{whitelist_paths.join(', ')}"
             next
           end

data/lib/rocket_job/jobs/housekeeping_job.rb

@@ -29,8 +29,8 @@ module RocketJob
       include RocketJob::Plugins::Cron
       include RocketJob::Plugins::Singleton
 
-      self.priority      = 25
-      self.description   = 'Cleans out historical jobs, and zombie servers.'
+      self.priority    = 25
+      self.description = 'Cleans out historical jobs, and zombie servers.'
       # Runs every 15 minutes
       self.cron_schedule = '*/15 * * * * UTC'
 

data/lib/rocket_job/plugins/job/persistence.rb

@@ -70,14 +70,15 @@ module RocketJob
           #        }
           def counts_by_state
             counts = {}
-            collection.aggregate([
-              {
-                '$group' => {
-                  _id:   '$state',
-                  count: {'$sum' => 1}
+            collection.aggregate(
+              [
+                {
+                  '$group' => {
+                    _id:   '$state',
+                    count: {'$sum' => 1}
+                  }
                 }
-              }
-            ]
+              ]
             ).each do |result|
               counts[result['_id'].to_sym] = result['count']
             end

data/lib/rocket_job/plugins/job/state_machine.rb

@@ -77,9 +77,9 @@ module RocketJob
             end
 
             event :requeue do
-              transitions from: :running, to: :queued,
-                if:             -> server_name { worker_on_server?(server_name) },
-                after:          :rocket_job_clear_started_at
+              transitions from:  :running, to: :queued,
+                          if:    -> server_name { worker_on_server?(server_name) },
+                          after: :rocket_job_clear_started_at
             end
           end
           # @formatter:on

data/lib/rocket_job/plugins/job/throttle_running_jobs.rb

@@ -38,8 +38,8 @@ module RocketJob
         def throttle_running_jobs_exceeded?
           throttle_running_jobs &&
             (throttle_running_jobs != 0) &&
-              # Cannot use class since it will include instances of parent job classes.
-              (RocketJob::Job.running.where('_type' => self.class.name, :id.ne => id).count >= throttle_running_jobs)
+            # Cannot use the class since it will include instances of parent job classes.
+            (RocketJob::Job.running.where('_type' => self.class.name, :id.ne => id).count >= throttle_running_jobs)
         end
       end
     end

data/lib/rocket_job/plugins/restart.rb

@@ -114,7 +114,7 @@ module RocketJob
           end
           count += 1
         end
-        logger.warn("New job instance not started: #{job.errors.messages.join(', ')}")
+        logger.warn("New job instance not started: #{job.errors.messages.inspect}")
         false
       end
 

data/lib/rocket_job/plugins/retry.rb

@@ -25,7 +25,7 @@ module RocketJob
     #   include RocketJob::Plugins::Retry
     #
     #   # Set the default retry_count
-    #   self.max_retries = 3
+    #   self.retry_limit = 3
     #
     #   def perform
     #     puts "DONE"
@@ -36,10 +36,10 @@ module RocketJob
     # MyJob.create!
     #
     # # Replace the default retry_count
-    # MyCronJob.create!(max_retries: 10)
+    # MyCronJob.create!(retry_limit: 10)
     #
     # # Disable retries for this job instance
-    # MyCronJob.create!(max_retries: 0)
+    # MyCronJob.create!(retry_limit: 0)
     #
     module Retry
       extend ActiveSupport::Concern
@@ -49,17 +49,21 @@ module RocketJob
 
         # Maximum number of times to retry this job
         # 25 is approximately 3 weeks of retries
-        field :max_retries, type: Integer, default: 25, class_attribute: true, user_editable: true, copy_on_restart: true
+        field :retry_limit, type: Integer, default: 25, class_attribute: true, user_editable: true, copy_on_restart: true
 
         # List of times when this job failed
-        field :failed_times, type: Array, default: []
+        field :failed_at_list, type: Array, default: []
 
-        validates_presence_of :max_retries
+        validates_presence_of :retry_limit
       end
 
-      # Returns [true|false] whether this job will be automatically retried on failure
+      # Returns [true|false] whether this job should be retried on failure.
       def rocket_job_retry_on_fail?
-        failure_count > max_retries
+        rocket_job_failure_count < retry_limit
+      end
+
+      def rocket_job_failure_count
+        failed_at_list.size
       end
 
       private
@@ -73,8 +77,8 @@ module RocketJob
 
         now         = Time.now
         self.run_at = now + delay_seconds
-        self.failed_times << now
-        new_record? ? retry : retry!
+        self.failed_at_list << now
+        new_record? ? self.retry : self.retry!
       end
 
       # Prevent exception from being cleared on retry
@@ -85,9 +89,9 @@ module RocketJob
       end
 
       # Returns [Time] when to retry this job at
-      # Same basic formula as Sidekiq and Delayed Job
+      # Same basic formula as Delayed Job
       def rocket_job_retry_seconds_to_delay
-        (failure_count ** 4) + 15 + (rand(30)*(failure_count+1))
+        (rocket_job_failure_count ** 4) + 15 + (rand(30) * (rocket_job_failure_count + 1))
       end
 
     end

data/lib/rocket_job/plugins/rufus/cron_line.rb

@@ -21,6 +21,7 @@
 #
 # Made in Japan.
 #++
+#@formatter:off
 
 require 'set'
 

data/lib/rocket_job/plugins/rufus/zo_time.rb

@@ -21,6 +21,7 @@
 #
 # Made in Japan.
 #++
+#@formatter:off
 
 module RocketJob::Plugins::Rufus
   #

data/lib/rocket_job/server.rb

@@ -141,14 +141,15 @@ module RocketJob
     #   # => {}
     def self.counts_by_state
       counts = {}
-      collection.aggregate([
-        {
-          '$group' => {
-            _id:   '$state',
-            count: {'$sum' => 1}
+      collection.aggregate(
+        [
+          {
+            '$group' => {
+              _id:   '$state',
+              count: {'$sum' => 1}
+            }
           }
-        }
-      ]
+        ]
       ).each do |result|
         counts[result['_id'].to_sym] = result['count']
       end

data/lib/rocket_job/version.rb

@@ -1,3 +1,3 @@
 module RocketJob #:nodoc
-  VERSION = '3.3.1'
+  VERSION = '3.3.2'
 end

data/lib/rocketjob.rb

@@ -38,6 +38,7 @@ module RocketJob
     autoload :Document,         'rocket_job/plugins/document'
     autoload :ProcessingWindow, 'rocket_job/plugins/processing_window'
     autoload :Restart,          'rocket_job/plugins/restart'
+    autoload :Retry,            'rocket_job/plugins/retry'
     autoload :Singleton,        'rocket_job/plugins/singleton'
     autoload :StateMachine,     'rocket_job/plugins/state_machine'
     autoload :Transaction,      'rocket_job/plugins/transaction'

data/test/plugins/job/throttle_test.rb

@@ -86,15 +86,15 @@ module Plugins
             ThrottleJob.create!(state: :failed)
             ThrottleJob.create!(state: :complete)
             ThrottleJob.create!(state: :paused)
-            assert job = RocketJob::Job.rocket_job_next_job(@worker_name), -> {ThrottleJob.all.to_a.ai}
-            assert_equal @job.id, job.id, -> {ThrottleJob.all.to_a.ai}
+            assert job = RocketJob::Job.rocket_job_next_job(@worker_name), -> { ThrottleJob.all.to_a.ai }
+            assert_equal @job.id, job.id, -> { ThrottleJob.all.to_a.ai }
           end
 
           it 'return nil when other jobs are running' do
             ThrottleJob.create!
             @job = ThrottleJob.new
             @job.start!
-            assert_nil RocketJob::Job.rocket_job_next_job(@worker_name), -> {ThrottleJob.all.to_a.ai}
+            assert_nil RocketJob::Job.rocket_job_next_job(@worker_name), -> { ThrottleJob.all.to_a.ai }
           end
 
           it 'add job to filter when other jobs are running' do
@@ -102,7 +102,7 @@ module Plugins
             @job = ThrottleJob.new
             @job.start!
             filter = {}
-            assert_nil RocketJob::Job.rocket_job_next_job(@worker_name, filter), -> {ThrottleJob.all.to_a.ai}
+            assert_nil RocketJob::Job.rocket_job_next_job(@worker_name, filter), -> { ThrottleJob.all.to_a.ai }
             assert_equal 1, filter.size
           end
         end

data/test/plugins/retry_test.rb

@@ -0,0 +1,89 @@
+require_relative '../test_helper'
+
+module Plugins
+  class RetryTest < Minitest::Test
+    class RetryJob < RocketJob::Job
+      include RocketJob::Plugins::Retry
+
+      # Fails 5 times before succeeding
+      def perform
+        raise "Oh No" unless rocket_job_failure_count >= 5
+        'DONE'
+      end
+    end
+
+    describe RocketJob::Plugins::Retry do
+      before do
+        RetryJob.delete_all
+      end
+
+      after do
+        @job.delete if @job && !@job.new_record?
+      end
+
+      describe '#perform' do
+        it 're-queues job on failure' do
+          @job = RetryJob.create!
+          assert created_at = @job.created_at
+          assert_equal 0, @job.failed_at_list.size
+
+          assert_raises RuntimeError do
+            @job.perform_now
+          end
+
+          assert @job.queued?, -> { @job.attributes.ai }
+
+          # Includes failure time
+          assert_equal 1, @job.rocket_job_failure_count
+          assert failed_at = @job.failed_at_list.first
+          assert failed_at >= created_at
+
+          assert next_time = @job.run_at
+          assert next_time > failed_at
+        end
+
+        it 're-queues until it succeeds' do
+          @job = RetryJob.create!
+
+          # 5 retries
+          5.times do |i|
+            assert_raises RuntimeError do
+              @job.perform_now
+            end
+            assert @job.queued?, -> { @job.attributes.ai }
+            assert_equal (i + 1), @job.rocket_job_failure_count
+          end
+
+          assert_equal 5, @job.rocket_job_failure_count
+
+          # Should succeed on the 6th attempt
+          @job.perform_now
+          assert @job.completed?, -> { @job.attributes.ai }
+          assert_equal 5, @job.rocket_job_failure_count
+        end
+
+        it 'stops re-queueing after limit is reached' do
+          @job = RetryJob.create!(retry_limit: 3)
+
+          # 3 attempts are retried
+          3.times do |i|
+            assert_raises RuntimeError do
+              @job.perform_now
+            end
+            assert @job.queued?, -> { @job.attributes.ai }
+            assert_equal (i + 1), @job.rocket_job_failure_count
+          end
+
+          # Should fail on the 4th attempt
+          assert_equal 3, @job.rocket_job_failure_count
+          assert_raises RuntimeError do
+            @job.perform_now
+          end
+
+          assert @job.failed?, -> { @job.attributes.ai }
+        end
+      end
+
+    end
+  end
+end

data/test/plugins/transaction_test.rb

@@ -53,9 +53,9 @@ module Plugins
 
         describe '#rocket_job_transaction' do
           it 'is registered' do
-            assert CommitTransactionJob.send(:get_callbacks, :perform).find {|c| c.filter == :rocket_job_transaction}
-            assert RollbackTransactionJob.send(:get_callbacks, :perform).find {|c| c.filter == :rocket_job_transaction}
-            refute RocketJob::Job.send(:get_callbacks, :perform).find {|c| c.filter == :rocket_job_transaction}
+            assert CommitTransactionJob.send(:get_callbacks, :perform).find { |c| c.filter == :rocket_job_transaction }
+            assert RollbackTransactionJob.send(:get_callbacks, :perform).find { |c| c.filter == :rocket_job_transaction }
+            refute RocketJob::Job.send(:get_callbacks, :perform).find { |c| c.filter == :rocket_job_transaction }
           end
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketjob
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -135,6 +135,7 @@ files:
 - test/plugins/job/worker_test.rb
 - test/plugins/processing_window_test.rb
 - test/plugins/restart_test.rb
+- test/plugins/retry_test.rb
 - test/plugins/singleton_test.rb
 - test/plugins/state_machine_event_callbacks_test.rb
 - test/plugins/state_machine_test.rb
@@ -185,6 +186,7 @@ test_files:
 - test/plugins/job/worker_test.rb
 - test/plugins/processing_window_test.rb
 - test/plugins/restart_test.rb
+- test/plugins/retry_test.rb
 - test/plugins/singleton_test.rb
 - test/plugins/state_machine_event_callbacks_test.rb
 - test/plugins/state_machine_test.rb