rocketjob 5.1.1 → 5.2.0.beta1

data/lib/rocket_job/extensions/mongo/logging.rb

@@ -1,10 +1,10 @@
-require 'mongo/monitoring/command_log_subscriber'
+require "mongo/monitoring/command_log_subscriber"
 
 module Mongo
   class Monitoring
     class CommandLogSubscriber
       include SemanticLogger::Loggable
-      logger.name = 'Mongo'
+      logger.name = "Mongo"
 
       def started(event)
         @event_command = event.command

data/lib/rocket_job/extensions/mongoid/clients/options.rb

@@ -1,5 +1,5 @@
-require 'mongoid/criteria'
-require 'mongoid/document'
+require "mongoid/criteria"
+require "mongoid/document"
 module RocketJob
   module MongoidClients
     module Options

data/lib/rocket_job/extensions/mongoid/contextual/mongo.rb

@@ -3,9 +3,11 @@ module Mongoid
   module Contextual
     class Mongo
       def initialize(criteria)
-        @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
+        @criteria = criteria
+        @klass = criteria.klass
+        @cache = criteria.options[:cache]
         # Only line changed is here, get collection name from criteria, not @klass
-        #@collection = @klass.collection
+        # @collection = @klass.collection
         @collection = criteria.collection
 
         criteria.send(:merge_type_selection)

data/lib/rocket_job/extensions/mongoid/factory.rb

@@ -1,12 +1,20 @@
-require 'mongoid/factory'
+require "mongoid/factory"
 
 module RocketJob
   # Don't convert to Mongoid::Factory since it conflicts with Mongoid use.
   module MongoidFactory
-    def from_db(klass, attributes = nil, criteria = nil)
-      obj                 = super(klass, attributes, criteria)
-      obj.collection_name = criteria.collection_name if criteria
-      obj
+    if Mongoid::VERSION.to_f >= 7.1
+      def from_db(klass, attributes = nil, criteria = nil, selected_fields = nil)
+        obj                 = super(klass, attributes, criteria, selected_fields)
+        obj.collection_name = criteria.collection_name if criteria
+        obj
+      end
+    else
+      def from_db(klass, attributes = nil, criteria = nil)
+        obj                 = super(klass, attributes, criteria)
+        obj.collection_name = criteria.collection_name if criteria
+        obj
+      end
     end
   end
 end

data/lib/rocket_job/extensions/rocket_job_adapter.rb

@@ -71,7 +71,7 @@ module ActiveJob
       end
 
       def self.active_job_params(active_job)
-        params            = {
+        params = {
           description:      active_job.class.name,
           data:             active_job.serialize,
           active_job_id:    active_job.job_id,
@@ -81,6 +81,7 @@ module ActiveJob
         params[:priority] = active_job.priority if active_job.respond_to?(:priority) && active_job.priority
         params
       end
+
       private_class_method :active_job_params
     end
   end

data/lib/rocket_job/job_exception.rb

@@ -18,9 +18,6 @@ module RocketJob
     # Name of the server on which this exception occurred
     field :worker_name, type: String
 
-    # The record within which this exception occurred
-    field :record_number, type: Integer
-
     # Returns [JobException] built from the supplied exception
     def self.from_exception(exc, **args)
       new(

data/lib/rocket_job/jobs/dirmon_job.rb

@@ -1,4 +1,4 @@
-require 'fileutils'
+require "fileutils"
 module RocketJob
   module Jobs
     # Dirmon monitors folders for files matching the criteria specified in DirmonEntry
@@ -79,10 +79,10 @@ module RocketJob
             end
 
             # BSON Keys cannot contain periods
-            key                 = iopath.to_s.tr('.', '_')
-            previous_size       = previous_file_names[key]
+            key           = iopath.to_s.tr(".", "_")
+            previous_size = previous_file_names[key]
             # Check every few minutes for a file size change before trying to process the file.
-            size                = check_file(entry, iopath, previous_size)
+            size = check_file(entry, iopath, previous_size)
             new_file_names[key] = size if size
           end
         end

data/lib/rocket_job/jobs/housekeeping_job.rb

@@ -30,9 +30,9 @@ module RocketJob
       include RocketJob::Plugins::Singleton
 
       self.priority    = 25
-      self.description = 'Cleans out historical jobs, and zombie servers.'
+      self.description = "Cleans out historical jobs, and zombie servers."
       # Runs every 15 minutes
-      self.cron_schedule = '*/15 * * * * UTC'
+      self.cron_schedule = "*/15 * * * * UTC"
 
       # Whether to destroy zombie servers automatically
       field :destroy_zombies, type: Boolean, default: true, user_editable: true, copy_on_restart: true
@@ -46,13 +46,13 @@ module RocketJob
       field :queued_retention, type: Integer, user_editable: true, copy_on_restart: true
 
       def perform
-        RocketJob::Job.aborted.where(completed_at: {'$lte' => aborted_retention.seconds.ago}).destroy_all if aborted_retention
+        RocketJob::Job.aborted.where(completed_at: {"$lte" => aborted_retention.seconds.ago}).destroy_all if aborted_retention
         if completed_retention
-          RocketJob::Job.completed.where(completed_at: {'$lte' => completed_retention.seconds.ago}).destroy_all
+          RocketJob::Job.completed.where(completed_at: {"$lte" => completed_retention.seconds.ago}).destroy_all
         end
-        RocketJob::Job.failed.where(completed_at: {'$lte' => failed_retention.seconds.ago}).destroy_all if failed_retention
-        RocketJob::Job.paused.where(completed_at: {'$lte' => paused_retention.seconds.ago}).destroy_all if paused_retention
-        RocketJob::Job.queued.where(created_at: {'$lte' => queued_retention.seconds.ago}).destroy_all if queued_retention
+        RocketJob::Job.failed.where(completed_at: {"$lte" => failed_retention.seconds.ago}).destroy_all if failed_retention
+        RocketJob::Job.paused.where(completed_at: {"$lte" => paused_retention.seconds.ago}).destroy_all if paused_retention
+        RocketJob::Job.queued.where(created_at: {"$lte" => queued_retention.seconds.ago}).destroy_all if queued_retention
 
         if destroy_zombies
           # Cleanup zombie servers

data/lib/rocket_job/jobs/on_demand_batch_job.rb

@@ -32,8 +32,15 @@
 #   job.cleanup!
 #
 # By default output is not collected, add the option `collect_output: true` to collect output.
+#
 # Example:
-#   job = RocketJob::Jobs::OnDemandBatchJob(description: 'Fix data', code: code, throttle_running_slices: 5, priority: 30, collect_output: true)
+#   job = RocketJob::Jobs::OnDemandBatchJob(
+#     description:              'Fix data',
+#     code:                     code,
+#     throttle_running_workers: 5,
+#     priority:                 30,
+#     collect_output:           true
+#   )
 #
 # Example: Move the upload operation into a before_batch.
 #   upload_code = <<-CODE
@@ -61,7 +68,7 @@ module RocketJob
       include RocketJob::Batch::Statistics
 
       self.priority            = 90
-      self.description         = 'Batch Job'
+      self.description         = "Batch Job"
       self.destroy_on_complete = false
 
       # Code that is performed against every row / record.
@@ -104,23 +111,26 @@ module RocketJob
 
       def validate_code
         return if code.nil?
+
         validate_field(:code) { load_perform_code }
       end
 
       def validate_before_code
         return if before_code.nil?
+
         validate_field(:before_code) { instance_eval("def __before_code\n#{before_code}\nend") }
       end
 
       def validate_after_code
         return if after_code.nil?
+
         validate_field(:after_code) { instance_eval("def __after_code\n#{after_code}\nend") }
       end
 
       def validate_field(field)
         yield
-      rescue Exception => exc
-        errors.add(field, "Failed to load :#{field}, #{exc.inspect}")
+      rescue Exception => e
+        errors.add(field, "Failed to load :#{field}, #{e.inspect}")
       end
     end
   end

data/lib/rocket_job/jobs/on_demand_job.rb

@@ -74,7 +74,7 @@ module RocketJob
       include RocketJob::Plugins::Cron
       include RocketJob::Plugins::Retry
 
-      self.description         = 'On Demand Job'
+      self.description         = "On Demand Job"
       self.destroy_on_complete = false
       self.retry_limit         = 0
 
@@ -95,8 +95,8 @@ module RocketJob
 
       def validate_code
         load_code
-      rescue Exception => exc
-        errors.add(:code, "Failed to parse :code, #{exc.inspect}")
+      rescue Exception => e
+        errors.add(:code, "Failed to parse :code, #{e.inspect}")
       end
     end
   end

data/lib/rocket_job/jobs/performance_job.rb

@@ -4,7 +4,7 @@ module RocketJob
       include RocketJob::Batch
 
       # Define the job's default attributes
-      self.description         = 'Performance Test'
+      self.description         = "Performance Test"
       self.priority            = 5
       self.slice_size          = 100
       self.destroy_on_complete = false

data/lib/rocket_job/jobs/re_encrypt/relational_job.rb

@@ -1,5 +1,5 @@
 begin
-  require 'active_record'
+  require "active_record"
 rescue LoadError
   raise 'RocketJob::Jobs::ReEncrypt::RelationalJob uses ActiveRecord to obtain the database connection, please install the gem "activerecord".'
 end
@@ -20,12 +20,12 @@ module RocketJob
       class RelationalJob < RocketJob::Job
         include RocketJob::Batch
 
-        self.slice_size              = 1000
-        self.priority                = 30
-        self.destroy_on_complete     = false
-        self.compress                = true
-        self.throttle_running_jobs   = 1
-        self.throttle_running_slices = 10
+        self.slice_size               = 1000
+        self.priority                 = 30
+        self.destroy_on_complete      = false
+        self.compress                 = true
+        self.throttle_running_jobs    = 1
+        self.throttle_running_workers = 10
 
         # Name of the table being re-encrypted
         field :table_name, type: String
@@ -43,7 +43,7 @@ module RocketJob
           connection.tables.each do |table|
             columns = connection.columns(table)
             columns.each do |column|
-              if column.name.start_with?('encrypted_')
+              if column.name.start_with?("encrypted_")
                 add_column = column.name
                 (h[table] ||= []) << add_column if add_column
               end
@@ -90,7 +90,7 @@ module RocketJob
               end
             end
             if updates.size.positive?
-              sql << updates.join(', ')
+              sql << updates.join(", ")
               sql << " where id=#{row[1]}"
               logger.trace sql
               self.class.connection.execute sql
@@ -114,7 +114,8 @@ module RocketJob
         end
 
         def re_encrypt(encrypted_value)
-          return encrypted_value if (encrypted_value == '') || encrypted_value.nil?
+          return encrypted_value if (encrypted_value == "") || encrypted_value.nil?
+
           SymmetricEncryption.encrypt(SymmetricEncryption.decrypt(encrypted_value))
         end
 

data/lib/rocket_job/jobs/upload_file_job.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'uri'
+require "fileutils"
+require "uri"
 
 module RocketJob
   module Jobs
@@ -40,10 +40,10 @@ module RocketJob
         job.id = job_id if job_id
         upload_file(job)
         job.save!
-      rescue StandardError => exc
+      rescue StandardError => e
         # Prevent partial uploads
         job&.cleanup! if job.respond_to?(:cleanup!)
-        raise(exc)
+        raise(e)
       end
 
       private
@@ -74,6 +74,7 @@ module RocketJob
       def job_is_a_rocket_job
         klass = job_class
         return if klass.nil? || klass.ancestors&.include?(RocketJob::Job)
+
         errors.add(:job_class_name, "Model #{job_class_name} must be defined and inherit from RocketJob::Job")
       end
 
@@ -83,14 +84,17 @@ module RocketJob
       def job_implements_upload
         klass = job_class
         return if klass.nil? || klass.instance_methods.any? { |m| VALID_INSTANCE_METHODS.include?(m) }
+
         errors.add(:job_class_name, "#{job_class} must implement any one of: :#{VALID_INSTANCE_METHODS.join(' :')} instance methods")
       end
 
       def file_exists
         return if upload_file_name.nil?
+
         uri = URI.parse(upload_file_name)
-        return unless uri.scheme.nil? || uri.scheme == 'file'
+        return unless uri.scheme.nil? || uri.scheme == "file"
         return if File.exist?(upload_file_name)
+
         errors.add(:upload_file_name, "Upload file: #{upload_file_name} does not exist.")
       end
     end

data/lib/rocket_job/performance.rb

@@ -1,6 +1,6 @@
-require 'csv'
-require 'yaml'
-require 'optparse'
+require "csv"
+require "yaml"
+require "optparse"
 module RocketJob
   class Performance
     attr_accessor :count, :servers, :workers, :version, :ruby, :environment, :mongo_config
@@ -11,20 +11,20 @@ module RocketJob
       @count        = 100_000
       @servers      = 0
       @workers      = 0
-      @environment  = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
-      @mongo_config = 'config/mongoid.yml'
+      @environment  = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+      @mongo_config = "config/mongoid.yml"
     end
 
     # Loads the queue with jobs to be processed once the queue is loaded.
     # Retain the first and last job for timings, all others are destroyed on completion.
     def run_test_case(count = self.count)
       if RocketJob::Server.where(:state.in => %w[running paused]).count.zero?
-        raise 'Please start servers before starting the performance test'
+        raise "Please start servers before starting the performance test"
       end
 
       count_running_workers
 
-      puts 'Waiting for workers to pause'
+      puts "Waiting for workers to pause"
       RocketJob::Server.pause_all
       RocketJob::Jobs::SimpleJob.delete_all
 
@@ -36,15 +36,16 @@ module RocketJob
         end
         puts "Waiting for #{running} workers"
         break if running.zero?
+
         sleep 1
       end
 
-      puts 'Enqueuing jobs'
+      puts "Enqueuing jobs"
       first = RocketJob::Jobs::SimpleJob.create!(priority: 1, destroy_on_complete: false)
       (count - 2).times { RocketJob::Jobs::SimpleJob.create! }
       last = RocketJob::Jobs::SimpleJob.create!(priority: 100, destroy_on_complete: false)
 
-      puts 'Resuming workers'
+      puts "Resuming workers"
       RocketJob::Server.resume_all
 
       sleep 3 until last.reload.completed?
@@ -58,7 +59,7 @@ module RocketJob
 
     # Export the Results hash to a CSV file
     def export_results(results)
-      CSV.open("job_results_#{ruby}_#{servers}s_#{workers}w_v#{version}.csv", 'wb') do |csv|
+      CSV.open("job_results_#{ruby}_#{servers}s_#{workers}w_v#{version}.csv", "wb") do |csv|
         csv << results.first.keys
         results.each { |result| csv << result.values }
       end
@@ -66,25 +67,25 @@ module RocketJob
 
     # Parse command line options
     def parse(argv)
-      parser        = OptionParser.new do |o|
-        o.on('-c',
-             '--count COUNT',
-             'Count of jobs to enqueue') do |arg|
+      parser = OptionParser.new do |o|
+        o.on("-c",
+             "--count COUNT",
+             "Count of jobs to enqueue") do |arg|
           self.count = arg.to_i
         end
-        o.on('-m',
-             '--mongo MONGO_CONFIG_FILE_NAME',
-             'Path and filename of config file. Default: config/mongoid.yml') do |arg|
+        o.on("-m",
+             "--mongo MONGO_CONFIG_FILE_NAME",
+             "Path and filename of config file. Default: config/mongoid.yml") do |arg|
           self.mongo_config = arg
         end
-        o.on('-e',
-             '--environment ENVIRONMENT',
-             'The environment to run the app on (Default: RAILS_ENV || RACK_ENV || development)') do |arg|
+        o.on("-e",
+             "--environment ENVIRONMENT",
+             "The environment to run the app on (Default: RAILS_ENV || RACK_ENV || development)") do |arg|
           self.environment = arg
         end
       end
-      parser.banner = 'rocketjob_perf <options>'
-      parser.on_tail '-h', '--help', 'Show help' do
+      parser.banner = "rocketjob_perf <options>"
+      parser.on_tail "-h", "--help", "Show help" do
         puts parser
         exit 1
       end
@@ -96,6 +97,7 @@ module RocketJob
       self.workers = 0
       RocketJob::Server.running.each do |server|
         next if server.zombie?
+
         self.servers += 1
         self.workers += server.heartbeat.workers
       end

data/lib/rocket_job/plugins/cron.rb

@@ -1,4 +1,4 @@
-require 'active_support/concern'
+require "active_support/concern"
 
 module RocketJob
   module Plugins
@@ -26,6 +26,7 @@ module RocketJob
         # Overrides: RocketJob::Plugins::Restart#rocket_job_restart_new_instance
         def rocket_job_restart_new_instance
           return unless cron_schedule
+
           super
         end
 
@@ -35,6 +36,7 @@ module RocketJob
         # Overrides: RocketJob::Plugins::Restart#rocket_job_restart_abort
         def rocket_job_restart_abort
           return unless cron_schedule
+
           rocket_job_restart_new_instance
           update_attribute(:cron_schedule, nil)
         end
@@ -54,14 +56,16 @@ module RocketJob
 
       def rocket_job_cron_set_run_at
         return unless cron_schedule
+
         self.run_at = rocket_job_cron_next_time if cron_schedule_changed? && !run_at_changed?
       end
 
       def rocket_job_cron_valid
         return unless cron_schedule
+
         RocketJob::Plugins::Rufus::CronLine.new(cron_schedule)
-      rescue ArgumentError => exc
-        errors.add(:cron_schedule, exc.message)
+      rescue ArgumentError => e
+        errors.add(:cron_schedule, e.message)
       end
     end
   end