rocketjob 3.4.3 → 3.5.0

data/lib/rocket_job/plugins/processing_window.rb

@@ -7,7 +7,7 @@ module RocketJob
     # specific time window. If the time window is already active the job is able to be processed
     # immediately.
     #
-    # Example: Process this job on Monday’s between 8am and 10am.
+    # Example: Process this job on Monday's between 8am and 10am.
     #
     # Example: Run this job on the 1st of every month from midnight for the entire day.
     #
@@ -70,7 +70,7 @@ module RocketJob
         return if rocket_job_processing_window_active?
         logger.warn("Processing window closed before job was processed. Job is re-scheduled to run at: #{rocket_job_processing_schedule.next_time}")
         self.worker_name ||= 'inline'
-        self.requeue!(worker_name)
+        requeue!(worker_name)
       end
 
       def rocket_job_processing_window_set_run_at

data/lib/rocket_job/plugins/restart.rb

@@ -23,7 +23,7 @@ module RocketJob
     # class RestartableJob < RocketJob::Job
     #   include RocketJob::Plugins::Restart
     #
-    #   # Retain the completed job under the completed tab in Rocket Job Mission Control.
+    #   # Retain the completed job under the completed tab in Rocket Job Web Interface.
     #   self.destroy_on_complete = false
     #
     #   # Will be copied to the new job on restart.
@@ -91,8 +91,8 @@ module RocketJob
           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)
+        attributes = rocket_job_restart_attributes.each_with_object({}) { |attr, attrs| attrs[attr] = send(attr) }
+        rocket_job_restart_create(attributes)
       end
 
       def rocket_job_restart_abort
@@ -117,7 +117,6 @@ module RocketJob
         logger.warn("New job instance not started: #{job.errors.messages.inspect}")
         false
       end
-
     end
   end
 end

data/lib/rocket_job/plugins/retry.rb

@@ -77,8 +77,8 @@ module RocketJob
 
         now         = Time.now
         self.run_at = now + delay_seconds
-        self.failed_at_list << now
-        new_record? ? self.retry : self.retry!
+        failed_at_list << now
+        new_record? ? self.retry : retry!
       end
 
       # Prevent exception from being cleared on retry
@@ -93,7 +93,6 @@ module RocketJob
       def rocket_job_retry_seconds_to_delay
         (rocket_job_failure_count ** 4) + 15 + (rand(30) * (rocket_job_failure_count + 1))
       end
-
     end
   end
 end

data/lib/rocket_job/plugins/singleton.rb

@@ -8,7 +8,7 @@ module RocketJob
 
       included do
         # Validation prevents a new job from being saved while one is already running
-        validates_each :state do |record, attr, value|
+        validates_each :state do |record, attr, _value|
           if (record.running? || record.queued? || record.paused?) && record.rocket_job_singleton_active?
             record.errors.add(attr, "Another instance of #{record.class.name} is already queued or running")
           end
@@ -16,10 +16,9 @@ module RocketJob
 
         # Returns [true|false] whether another instance of this job is already active
         def rocket_job_singleton_active?
-          self.class.where(:state.in => [:running, :queued], :id.ne => id).exists?
+          self.class.where(:state.in => %i[running queued], :id.ne => id).exists?
         end
       end
-
     end
   end
 end

data/lib/rocket_job/plugins/state_machine.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'active_support/concern'
 require 'aasm'
 
@@ -34,32 +33,31 @@ module RocketJob
         # Adds a :before or :after callback to an event
         #  state_machine_add_event_callback(:start, :before, :my_method)
         def self.state_machine_add_event_callback(event_name, action, *methods, &block)
-          raise(ArgumentError, 'Cannot supply both a method name and a block') if (methods.size > 0) && block
-          raise(ArgumentError, 'Must supply either a method name or a block') unless (methods.size > 0) || block
+          raise(ArgumentError, 'Cannot supply both a method name and a block') if methods.size.positive? && block
+          raise(ArgumentError, 'Must supply either a method name or a block') unless methods.size.positive? || block
 
-          # TODO Somehow get AASM to support options such as :if and :unless to be consistent with other callbacks
+          # TODO: Somehow get AASM to support options such as :if and :unless to be consistent with other callbacks
           # For example:
           #    before_start :my_callback, unless: :encrypted?
           #    before_start :my_callback, if: :encrypted?
-          if event = aasm.state_machine.events[event_name]
-            values = Array(event.options[action])
-            code   =
-              if block
-                block
-              else
-                # Validate methods are any of Symbol String Proc
-                methods.each do |method|
-                  unless method.is_a?(Symbol) || method.is_a?(String)
-                    raise(ArgumentError, "#{action}_#{event_name} currently does not support any options. Only Symbol and String method names can be supplied.")
-                  end
+          event = aasm.state_machine.events[event_name]
+          raise(ArgumentError, "Unknown event: #{event_name.inspect}") unless event
+
+          values = Array(event.options[action])
+          code   =
+            if block
+              block
+            else
+              # Validate methods are any of Symbol String Proc
+              methods.each do |method|
+                unless method.is_a?(Symbol) || method.is_a?(String)
+                  raise(ArgumentError, "#{action}_#{event_name} currently does not support any options. Only Symbol and String method names can be supplied.")
                 end
-                methods
               end
-            action == :before ? values.push(code) : values.unshift(code)
-            event.options[action] = values.flatten.uniq
-          else
-            raise(ArgumentError, "Unknown event: #{event_name.inspect}")
-          end
+              methods
+            end
+          action == :before ? values.push(code) : values.unshift(code)
+          event.options[action] = values.flatten.uniq
         end
 
         def self.state_machine_define_event_callbacks(*event_names)
@@ -75,9 +73,7 @@ module RocketJob
             RUBY
           end
         end
-
       end
-
     end
   end
 end

data/lib/rocket_job/rocket_job.rb

@@ -19,20 +19,20 @@ module RocketJob
   # Returns a human readable duration from the supplied [Float] number of seconds
   def self.seconds_as_duration(seconds)
     return nil unless seconds
-    if seconds >= 86400.0 # 1 day
-      "#{(seconds / 86400).to_i}d #{Time.at(seconds).strftime('%-Hh %-Mm')}"
+    if seconds >= 86_400.0 # 1 day
+      "#{(seconds / 86_400).to_i}d #{Time.at(seconds).strftime('%-Hh %-Mm')}"
     elsif seconds >= 3600.0 # 1 hour
       Time.at(seconds).strftime('%-Hh %-Mm')
     elsif seconds >= 60.0 # 1 minute
       Time.at(seconds).strftime('%-Mm %-Ss')
     elsif seconds >= 1.0 # 1 second
-      "#{'%.3f' % seconds}s"
+      format('%.3fs', seconds)
     else
       duration = seconds * 1000
       if defined? JRuby
         "#{duration.to_i}ms"
       else
-        duration < 10.0 ? "#{'%.3f' % duration}ms" : "#{'%.1f' % duration}ms"
+        duration < 10.0 ? format('%.3fms', duration) : format('%.1fms', duration)
       end
     end
   end
@@ -49,5 +49,4 @@ module RocketJob
   def self.rails!
     @rails = true
   end
-
 end

data/lib/rocket_job/server.rb

@@ -107,7 +107,7 @@ module RocketJob
 
     # Stop all running, paused, or starting servers
     def self.stop_all
-      where(:state.in => [:running, :paused, :starting]).each(&:stop!)
+      where(:state.in => %i[running paused starting]).each(&:stop!)
     end
 
     # Pause all running servers
@@ -194,7 +194,7 @@ module RocketJob
       server = create!(attrs)
       server.send(:run)
     ensure
-      server.destroy if server
+      server&.destroy
     end
 
     # Returns [Boolean] whether the server is shutting down
@@ -207,10 +207,10 @@ module RocketJob
       dead_seconds        = Config.instance.heartbeat_seconds * missed
       last_heartbeat_time = Time.now - dead_seconds
       where(
-        :state.in => [:stopping, :running, :paused],
+        :state.in => %i[stopping running paused],
         '$or'     => [
-          {"heartbeat.updated_at" => {'$exists' => false}},
-          {"heartbeat.updated_at" => {'$lte' => last_heartbeat_time}}
+          {'heartbeat.updated_at' => {'$exists' => false}},
+          {'heartbeat.updated_at' => {'$lte' => last_heartbeat_time}}
         ]
       )
     end
@@ -230,8 +230,6 @@ module RocketJob
 
     private
 
-    attr_reader :workers
-
     # Returns [Array<Worker>] collection of workers
     def workers
       @workers ||= []
@@ -242,7 +240,7 @@ module RocketJob
       logger.info "Using MongoDB Database: #{RocketJob::Job.collection.database.name}"
       build_heartbeat(updated_at: Time.now, workers: 0)
       started!
-      logger.info 'RocketJob Server started'
+      logger.info 'Rocket Job Server started'
 
       run_workers
 
@@ -250,7 +248,7 @@ module RocketJob
       # Tell each worker to shutdown cleanly
       workers.each(&:shutdown!)
 
-      while worker = workers.first
+      while (worker = workers.first)
         if worker.join(5)
           # Worker thread is dead
           workers.shift
@@ -270,9 +268,7 @@ module RocketJob
       logger.error('RocketJob::Server is stopping due to an exception', exc)
     ensure
       # Logs the backtrace for each running worker
-      if SemanticLogger::VERSION.to_i >= 4
-        workers.each { |worker| logger.backtrace(thread: worker.thread) if worker.thread && worker.alive? }
-      end
+      workers.each { |worker| logger.backtrace(thread: worker.thread) if worker.thread && worker.alive? }
     end
 
     def run_workers
@@ -332,18 +328,18 @@ module RocketJob
       return unless running?
 
       # Need to add more workers?
-      if count < max_workers
-        worker_count = max_workers - count
-        logger.info "Starting #{worker_count} workers"
-        worker_count.times.each do
-          sleep (Config.instance.max_poll_seconds.to_f / max_workers) if stagger_workers
-          return if shutdown?
-          # Start worker
-          begin
-            workers << Worker.new(id: next_worker_id, server_name: name, filter: filter)
-          rescue Exception => exc
-            logger.fatal('Cannot start worker', exc)
-          end
+      return unless count < max_workers
+
+      worker_count = max_workers - count
+      logger.info "Starting #{worker_count} workers"
+      worker_count.times.each do
+        sleep(Config.instance.max_poll_seconds.to_f / max_workers) if stagger_workers
+        return if shutdown?
+        # Start worker
+        begin
+          workers << Worker.new(id: next_worker_id, server_name: name, filter: filter)
+        rescue Exception => exc
+          logger.fatal('Cannot start worker', exc)
         end
       end
     end
@@ -353,30 +349,28 @@ module RocketJob
     #   Perform clean shutdown
     #
     def self.register_signal_handlers
-      begin
-        Signal.trap 'SIGTERM' do
-          shutdown!
-          message = 'Shutdown signal (SIGTERM) received. Will shutdown as soon as active jobs/slices have completed.'
-          # Logging uses a mutex to access Queue on MRI/CRuby
-          defined?(JRuby) ? logger.warn(message) : puts(message)
-        end
+      Signal.trap 'SIGTERM' do
+        shutdown!
+        message = 'Shutdown signal (SIGTERM) received. Will shutdown as soon as active jobs/slices have completed.'
+        # Logging uses a mutex to access Queue on MRI/CRuby
+        defined?(JRuby) ? logger.warn(message) : puts(message)
+      end
 
-        Signal.trap 'INT' do
-          shutdown!
-          message = 'Shutdown signal (INT) received. Will shutdown as soon as active jobs/slices have completed.'
-          # Logging uses a mutex to access Queue on MRI/CRuby
-          defined?(JRuby) ? logger.warn(message) : puts(message)
-        end
-      rescue StandardError
-        logger.warn 'SIGTERM handler not installed. Not able to shutdown gracefully'
+      Signal.trap 'INT' do
+        shutdown!
+        message = 'Shutdown signal (INT) received. Will shutdown as soon as active jobs/slices have completed.'
+        # Logging uses a mutex to access Queue on MRI/CRuby
+        defined?(JRuby) ? logger.warn(message) : puts(message)
       end
+    rescue StandardError
+      logger.warn 'SIGTERM handler not installed. Not able to shutdown gracefully'
     end
 
+    private_class_method :register_signal_handlers
+
     # Requeue any jobs assigned to this server when it is destroyed
     def requeue_jobs
       RocketJob::Job.requeue_dead_server(name)
     end
-
   end
 end
-

data/lib/rocket_job/version.rb

@@ -1,3 +1,3 @@
-module RocketJob #:nodoc
-  VERSION = '3.4.3'
+module RocketJob
+  VERSION = '3.5.0'.freeze
 end

data/lib/rocket_job/worker.rb

@@ -4,7 +4,7 @@ module RocketJob
   # Worker
   #
   # A worker runs on a single operating system thread
-  # Is usually started under a RocketJob server process.
+  # Is usually started under a Rocket Job server process.
   class Worker
     include SemanticLogger::Loggable
     include ActiveSupport::Callbacks
@@ -31,14 +31,19 @@ module RocketJob
       set_callback(:running, :around, *filters, &blk)
     end
 
-    def initialize(id: 0, server_name: 'inline:0', inline: false, re_check_seconds: Config.instance.re_check_seconds, filter: nil)
-      @id          = id
-      @server_name = server_name
-      if defined?(Concurrent::JavaAtomicBoolean) || defined?(Concurrent::CAtomicBoolean)
-        @shutdown = Concurrent::AtomicBoolean.new(false)
-      else
-        @shutdown = false
-      end
+    def initialize(id: 0,
+                   server_name: 'inline:0',
+                   inline: false,
+                   re_check_seconds: Config.instance.re_check_seconds,
+                   filter: nil)
+      @id               = id
+      @server_name      = server_name
+      @shutdown         =
+        if defined?(Concurrent::JavaAtomicBoolean) || defined?(Concurrent::CAtomicBoolean)
+          Concurrent::AtomicBoolean.new(false)
+        else
+          false
+        end
       @name             = "#{server_name}:#{id}"
       @re_check_seconds = (re_check_seconds || 60).to_f
       @re_check_start   = Time.now
@@ -74,9 +79,9 @@ module RocketJob
     #   worker_id [Integer]
     #     The number of this worker for logging purposes
     def run
-      Thread.current.name = 'rocketjob %03i' % id
+      Thread.current.name = format('rocketjob %03i', id)
       logger.info 'Started'
-      while !shutdown?
+      until shutdown?
         if process_available_jobs
           # Keeps workers staggered across the poll interval so that
           # all workers don't poll at the same time
@@ -97,15 +102,13 @@ module RocketJob
     # Returns [Boolean] whether any job was actually processed
     def process_available_jobs
       processed = false
-      while !shutdown?
+      until shutdown?
         reset_filter_if_expired
         job = Job.rocket_job_next_job(name, current_filter)
         break unless job
 
         SemanticLogger.named_tagged(job: job.id.to_s) do
-          unless job.rocket_job_work(self, false, current_filter)
-            processed = true
-          end
+          processed = true unless job.rocket_job_work(self, false, current_filter)
         end
       end
       processed
@@ -115,12 +118,10 @@ module RocketJob
     def reset_filter_if_expired
       # Only clear out the current_filter after every `re_check_seconds`
       time = Time.now
-      if (time - @re_check_start) > re_check_seconds
-        @re_check_start     = time
-        self.current_filter = filter.dup
-      end
-    end
+      return unless (time - @re_check_start) > re_check_seconds
 
+      @re_check_start     = time
+      self.current_filter = filter.dup
+    end
   end
 end
-

data/lib/rocketjob.rb

@@ -47,8 +47,10 @@ module RocketJob
   module Jobs
     autoload :ActiveJob,        'rocket_job/jobs/active_job'
     autoload :DirmonJob,        'rocket_job/jobs/dirmon_job'
+    autoload :OnDemandJob,      'rocket_job/jobs/on_demand_job'
     autoload :HousekeepingJob,  'rocket_job/jobs/housekeeping_job'
     autoload :SimpleJob,        'rocket_job/jobs/simple_job'
+    autoload :UploadFileJob,    'rocket_job/jobs/upload_file_job'
   end
 end
 

data/test/config/mongoid.yml

@@ -38,7 +38,7 @@ mongoid_options: &mongoid_options
 development:
   clients:
     default: &default_development
-      uri: mongodb://localhost:27017/rocketjob_development
+      uri: mongodb://127.0.0.1:27017/rocketjob_development
       options:
         <<: *client_options
         write:
@@ -55,7 +55,7 @@ development:
 test:
   clients:
     default: &default_test
-      uri: mongodb://localhost:27017/rocketjob_test
+      uri: mongodb://127.0.0.1:27017/rocketjob_test
       options:
         <<: *client_options
         write: