rocketjob 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba34033326ffcb1f7047751977fdca6cd5f2ae6d
-  data.tar.gz: 834c136c510ebad348c84925d8d63f985fd9b612
+  metadata.gz: 1974e77ea4b6aa126dfa57155d15bd49a659ae1e
+  data.tar.gz: 900333f68eb5ee6e378fc19d494b7408944fa83b
 SHA512:
-  metadata.gz: d6cb3e4861f65738fda7ef5a135cc7f48ff446fe35ed5dce3f6058044a3f8bb12e887e2ffdaf1a4985dc37777c1ab02fb38f0587ec831684593f64fc69ea0197
-  data.tar.gz: 75c958355fb7f96e1b7ad6af4aaf10ba740fce214dcdfefe37c638495cb951abe0eb9d60e715f1bbede8c375b8e83d78570303b0d2303e3c4ec401e60f4002f4
+  metadata.gz: 741923205b5e7caa759db125afe234fe4c237e80bfdadbb58db512b2ef2269f42fd9fc58207c4e9eb97a0447f164b9179472ccc0e1ba3ec64aaa155753cf0257
+  data.tar.gz: b44d77f843c6e6342a2be309ec50fbf25eae7f9db26e074eb96143d18283a321981050d70287189cc5c855bc3f9600da5d11328e388ac9b2f5a3aea3420170cf

data/lib/rocket_job/config.rb

@@ -7,7 +7,7 @@ module RocketJob
     # Returns the single instance of the Rocket Job Configuration for this site
     # in a thread-safe way
     def self.instance
-      @@instance ||= begin
+      @instance ||= begin
         first || create
       rescue StandardError
         # In case another process has already created the first document

data/lib/rocket_job/dirmon_entry.rb

@@ -146,8 +146,8 @@ module RocketJob
     # Default: [] ==> Do not enforce whitelists
     #
     # Returns [Array<String>] a copy of the whitelisted paths
-    def self.whitelist_paths
-      @@whitelist_paths.dup
+    def self.get_whitelist_paths
+      self.whitelist_paths.dup
     end
 
     # Add a path to the whitelist
@@ -155,8 +155,8 @@ module RocketJob
     def self.add_whitelist_path(path)
       # Confirms that path exists
       path = Pathname.new(path).realpath.to_s
-      @@whitelist_paths << path
-      @@whitelist_paths.uniq!
+      self.whitelist_paths << path
+      self.whitelist_paths.uniq!
       path
     end
 
@@ -165,8 +165,8 @@ module RocketJob
     def self.delete_whitelist_path(path)
       # Confirms that path exists
       path = Pathname.new(path).realpath.to_s
-      @@whitelist_paths.delete(path)
-      @@whitelist_paths.uniq!
+      self.whitelist_paths.delete(path)
+      self.whitelist_paths.uniq!
       path
     end
 
@@ -203,9 +203,9 @@ module RocketJob
 
     # The default archive directory that is used when the job being queued does not respond
     # to #upload, and does not have an `archive_directory` specified in this entry
-    cattr_accessor :default_archive_directory
+    class_attribute :default_archive_directory
 
-    @@default_archive_directory = '_archive'.freeze
+    self.default_archive_directory = '_archive'.freeze
 
     # Returns [Pathname] the archive_directory if set, otherwise the default_archive_directory
     # Creates the archive directory if one is set
@@ -266,8 +266,6 @@ module RocketJob
       end
     end
 
-    @@whitelist_paths = Concurrent::Array.new
-
     # Returns the Job to be queued
     def job_class
       return if job_class_name.nil?
@@ -292,10 +290,8 @@ module RocketJob
 
     private
 
-    # Instance method to return whitelist paths
-    def whitelist_paths
-      @@whitelist_paths
-    end
+    class_attribute :whitelist_paths
+    self.whitelist_paths = Concurrent::Array.new
 
     # Upload the file to the job
     def upload_file(job, pathname)

data/lib/rocket_job/jobs/housekeeping_job.rb

@@ -30,12 +30,15 @@ module RocketJob
       include RocketJob::Plugins::Singleton
 
       self.priority      = 25
-      self.description   = 'Cleans out historical jobs'
-      # Runs hourly on the hour
-      self.cron_schedule = '0 * * * * America/New_York'
+      self.description   = 'Cleans out historical jobs, and zombie servers.'
+      # Runs every 15 minutes
+      self.cron_schedule = '*/15 * * * * UTC'
 
-      # Retention intervals in seconds
-      # Set to nil to not
+      # Whether to destroy zombie servers automatically
+      field :destroy_zombies, type: Boolean, default: true, user_editable: true, copy_on_restart: true
+
+      # Retention intervals in seconds.
+      # Set to nil to retain everything.
       field :aborted_retention, type: Integer, default: 7.days, user_editable: true, copy_on_restart: true
       field :completed_retention, type: Integer, default: 7.days, user_editable: true, copy_on_restart: true
       field :failed_retention, type: Integer, default: 14.days, user_editable: true, copy_on_restart: true
@@ -43,6 +46,8 @@ module RocketJob
       field :queued_retention, type: Integer, user_editable: true, copy_on_restart: true
 
       def perform
+        RocketJob::Server.destroy_zombies if destroy_zombies
+
         RocketJob::Job.aborted.where(created_at: {'$lte' => aborted_retention.seconds.ago}).destroy_all if aborted_retention
         RocketJob::Job.completed.where(created_at: {'$lte' => completed_retention.seconds.ago}).destroy_all if completed_retention
         RocketJob::Job.failed.where(created_at: {'$lte' => failed_retention.seconds.ago}).destroy_all if failed_retention

data/lib/rocket_job/plugins/restart.rb

@@ -87,8 +87,10 @@ module RocketJob
 
       # Run again in the future, even if this run fails with an exception
       def rocket_job_restart_new_instance
-        logger.info('Job has expired. Not creating a new instance.')
-        return if expired?
+        if expired?
+          logger.info('Job has expired. Not creating a new instance.')
+          return
+        end
         attrs = rocket_job_restart_attributes.reduce({}) { |attrs, attr| attrs[attr] = send(attr); attrs }
         rocket_job_restart_create(attrs)
       end
@@ -112,7 +114,7 @@ module RocketJob
           end
           count += 1
         end
-        logger.warn('New job instance not started since one is already active')
+        logger.warn("New job instance not started: #{job.errors.messages.join(', ')}")
         false
       end
 

data/lib/rocket_job/plugins/transaction.rb

@@ -0,0 +1,44 @@
+require 'active_support/concern'
+
+module RocketJob
+  module Plugins
+    # Perform under a single Active Record transaction / unit or work.
+    #
+    # If the perform raises an exception it will cause any database changes to be rolled back.
+    #
+    # For Batch Jobs the transaction is at the slice level so that the entire slice succeeds,
+    # or is rolled back.
+    #
+    # Example:
+    #   # Update User and create an Audit entry as a single database transaction.
+    #   # If Audit.create! fails then the user change will also be rolled back.
+    #   class MyJob < RocketJob::Job
+    #     include RocketJob::Plugins::Transaction
+    #
+    #     def perform
+    #       u = User.find(name: 'Jack')
+    #       u.age = 21
+    #       u.save!
+    #
+    #       Audit.create!(table: 'user', description: 'Changed age to 21')
+    #     end
+    #   end
+    module Transaction
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:around_slice)
+          around_slice :rocket_job_transaction
+        else
+          around_perform :rocket_job_transaction
+        end
+      end
+
+      private
+
+      def rocket_job_transaction(&block)
+        ActiveRecord::Base.transaction(&block)
+      end
+    end
+  end
+end

data/lib/rocket_job/server.rb

@@ -92,8 +92,8 @@ module RocketJob
     # Requeue any jobs being worked by this server when it is destroyed
     before_destroy :requeue_jobs
 
-    # Destroy's all instances of zombie server and requeue any jobs still "running"
-    # on those servers
+    # Destroy's all instances of zombie servers and requeues any jobs still "running"
+    # on those servers.
     def self.destroy_zombies
       count = 0
       each do |server|
@@ -159,27 +159,27 @@ module RocketJob
     if defined?(Concurrent::JavaAtomicBoolean) || defined?(Concurrent::CAtomicBoolean)
       # Returns [true|false] whether the shutdown indicator has been set for this server process
       def self.shutdown?
-        @@shutdown.value
+        @shutdown.value
       end
 
       # Set shutdown indicator for this server process
       def self.shutdown!
-        @@shutdown.make_true
+        @shutdown.make_true
       end
 
-      @@shutdown = Concurrent::AtomicBoolean.new(false)
+      @shutdown = Concurrent::AtomicBoolean.new(false)
     else
       # Returns [true|false] whether the shutdown indicator has been set for this server process
       def self.shutdown?
-        @@shutdown
+        @shutdown
       end
 
       # Set shutdown indicator for this server process
       def self.shutdown!
-        @@shutdown = true
+        @shutdown = true
       end
 
-      @@shutdown = false
+      @shutdown = false
     end
 
     # Run the server process

data/lib/rocket_job/version.rb

@@ -1,3 +1,3 @@
 module RocketJob #:nodoc
-  VERSION = '3.2.1'
+  VERSION = '3.3.0'
 end

data/lib/rocketjob.rb

@@ -27,6 +27,7 @@ module RocketJob
       autoload :Persistence,         'rocket_job/plugins/job/persistence'
       autoload :Throttle,            'rocket_job/plugins/job/throttle'
       autoload :ThrottleRunningJobs, 'rocket_job/plugins/job/throttle_running_jobs'
+      autoload :Transaction,         'rocket_job/plugins/job/transaction'
       autoload :Worker,              'rocket_job/plugins/job/worker'
     end
     module Rufus

data/test/dirmon_entry_test.rb

@@ -13,15 +13,15 @@ class DirmonEntryTest < Minitest::Test
   end
 
   class SumJob < RocketJob::Job
-    @@result = nil
+    @result = nil
 
     # For temp test data
     def self.result
-      @@result
+      @result
     end
 
     def perform(a, b)
-      @@result = a + b
+      @result = a + b
     end
   end
 

data/test/jobs/housekeeping_job_test.rb

@@ -11,49 +11,79 @@ class HousekeepingJobTest < Minitest::Test
     before do
       HousekeepingJobTest::TestJob.delete_all
       RocketJob::Jobs::HousekeepingJob.delete_all
+      RocketJob::Server.delete_all
+    end
 
-      job = HousekeepingJobTest::TestJob.new(created_at: 2.days.ago)
-      job.abort!
-      job = HousekeepingJobTest::TestJob.new(created_at: 8.days.ago)
-      job.abort!
+    describe 'job retention' do
+      before do
+        job = HousekeepingJobTest::TestJob.new(created_at: 2.days.ago)
+        job.abort!
+        job = HousekeepingJobTest::TestJob.new(created_at: 8.days.ago)
+        job.abort!
 
-      job = HousekeepingJobTest::TestJob.new(created_at: 2.days.ago)
-      job.perform_now
-      job.save!
-      job = HousekeepingJobTest::TestJob.new(created_at: 8.days.ago)
-      job.perform_now
-      job.save!
+        job = HousekeepingJobTest::TestJob.new(created_at: 2.days.ago)
+        job.perform_now
+        job.save!
+        job = HousekeepingJobTest::TestJob.new(created_at: 8.days.ago)
+        job.perform_now
+        job.save!
 
-      job = HousekeepingJobTest::TestJob.new(created_at: 2.days.ago)
-      job.fail!
-      job = HousekeepingJobTest::TestJob.new(created_at: 15.days.ago)
-      job.fail!
+        job = HousekeepingJobTest::TestJob.new(created_at: 2.days.ago)
+        job.fail!
+        job = HousekeepingJobTest::TestJob.new(created_at: 15.days.ago)
+        job.fail!
 
-      job = HousekeepingJobTest::TestJob.new(created_at: 400.days.ago)
-      job.pause!
-      job = HousekeepingJobTest::TestJob.new
-      job.pause!
+        job = HousekeepingJobTest::TestJob.new(created_at: 400.days.ago)
+        job.pause!
+        job = HousekeepingJobTest::TestJob.new
+        job.pause!
 
-      HousekeepingJobTest::TestJob.create!(created_at: 15.days.ago)
-      HousekeepingJobTest::TestJob.create!
+        HousekeepingJobTest::TestJob.create!(created_at: 15.days.ago)
+        HousekeepingJobTest::TestJob.create!
 
-      assert_equal 10, HousekeepingJobTest::TestJob.count, -> { HousekeepingJobTest::TestJob.all.to_a.ai }
-    end
+        assert_equal 10, HousekeepingJobTest::TestJob.count, -> { HousekeepingJobTest::TestJob.all.to_a.ai }
+      end
 
-    after do
-      @job.destroy if @job && !@job.new_record?
+      after do
+        @job.destroy if @job && !@job.new_record?
+      end
+
+      describe 'perform' do
+        it 'destroys jobs' do
+          @job = RocketJob::Jobs::HousekeepingJob.new
+          @job.perform_now
+          assert_equal 1, HousekeepingJobTest::TestJob.aborted.count, -> { HousekeepingJobTest::TestJob.aborted.to_a.ai }
+          assert_equal 1, HousekeepingJobTest::TestJob.completed.count, -> { HousekeepingJobTest::TestJob.completed.to_a.ai }
+          assert_equal 1, HousekeepingJobTest::TestJob.failed.count, -> { HousekeepingJobTest::TestJob.failed.to_a.ai }
+          assert_equal 2, HousekeepingJobTest::TestJob.paused.count, -> { HousekeepingJobTest::TestJob.paused.to_a.ai }
+          assert_equal 2, HousekeepingJobTest::TestJob.queued.count, -> { HousekeepingJobTest::TestJob.queued.to_a.ai }
+        end
+      end
     end
 
-    describe 'perform' do
-      it 'destroys jobs' do
+    describe 'zombie cleanup' do
+      before do
+        @server = RocketJob::Server.new
+        @server.started!
+        assert @server.reload.zombie?
+        assert_equal 1, RocketJob::Server.count, -> { RocketJob::Server.all.to_a.ai }
+      end
+
+      it 'removes zombies' do
         @job = RocketJob::Jobs::HousekeepingJob.new
+        assert @job.destroy_zombies
+        @job.perform_now
+        assert_equal 0, RocketJob::Server.count, -> { RocketJob::Server.all.to_a.ai }
+      end
+
+      it 'leaves zombies' do
+        @job = RocketJob::Jobs::HousekeepingJob.new(destroy_zombies: false)
+        refute @job.destroy_zombies
+        assert_equal 1, RocketJob::Server.count, -> { RocketJob::Server.all.to_a.ai }
         @job.perform_now
-        assert_equal 1, HousekeepingJobTest::TestJob.aborted.count, -> { HousekeepingJobTest::TestJob.aborted.to_a.ai }
-        assert_equal 1, HousekeepingJobTest::TestJob.completed.count, -> { HousekeepingJobTest::TestJob.completed.to_a.ai }
-        assert_equal 1, HousekeepingJobTest::TestJob.failed.count, -> { HousekeepingJobTest::TestJob.failed.to_a.ai }
-        assert_equal 2, HousekeepingJobTest::TestJob.paused.count, -> { HousekeepingJobTest::TestJob.paused.to_a.ai }
-        assert_equal 2, HousekeepingJobTest::TestJob.queued.count, -> { HousekeepingJobTest::TestJob.queued.to_a.ai }
+        assert_equal 1, RocketJob::Server.count, -> { RocketJob::Server.all.to_a.ai }
       end
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketjob
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,6 +111,7 @@ files:
 - lib/rocket_job/plugins/rufus/zo_time.rb
 - lib/rocket_job/plugins/singleton.rb
 - lib/rocket_job/plugins/state_machine.rb
+- lib/rocket_job/plugins/transaction.rb
 - lib/rocket_job/rocket_job.rb
 - lib/rocket_job/server.rb
 - lib/rocket_job/version.rb