rocketjob 1.3.0 → 2.0.0.rc1

data/lib/rocket_job/dirmon_entry.rb

@@ -1,11 +1,10 @@
-require 'thread_safe'
+require 'concurrent'
 require 'pathname'
 require 'fileutils'
-require 'aasm'
 module RocketJob
   class DirmonEntry
-    include MongoMapper::Document
-    include AASM
+    include Plugins::Document
+    include Plugins::StateMachine
 
     # @formatter:off
     # User defined name used to identify this DirmonEntry in Mission Control
@@ -67,9 +66,6 @@ module RocketJob
     # be created in the archive directory.
     key :archive_directory,  String
 
-    # Method to perform on the job, usually :perform
-    key :perform_method,     Symbol, default: :perform
-
     # If this DirmonEntry is in the failed state, exception contains the cause
     one :exception,          class_name: 'RocketJob::JobException'
 
@@ -85,7 +81,7 @@ module RocketJob
     # Read-only attributes
     #
 
-    # Current state, as set by AASM
+    # Current state, as set by the state machine. Do not modify directly.
     key :state,              Symbol, default: :pending
 
     # State Machine events and transitions
@@ -120,19 +116,13 @@ module RocketJob
         transitions from: :failed,  to: :disabled
       end
 
-      event :fail do
+      event :fail, before: :set_exception do
         transitions from: :enabled, to: :failed
       end
     end
 
     # @formatter:on
-    validates_presence_of :pattern, :job_class_name, :perform_method
-
-    validates_each :perform_method do |record, attr, value|
-      if (klass = record.job_class) && !klass.instance_methods.include?(value)
-        record.errors.add(attr, "Method not implemented by #{record.job_class_name}")
-      end
-    end
+    validates_presence_of :pattern, :job_class_name
 
     validates_each :job_class_name do |record, attr, value|
       exists =
@@ -145,8 +135,8 @@ module RocketJob
     end
 
     validates_each :arguments do |record, attr, value|
-      if (klass = record.job_class) && klass.instance_methods.include?(record.perform_method)
-        count = klass.argument_count(record.perform_method)
+      if klass = record.job_class
+        count = klass.rocket_job_argument_count
         record.errors.add(attr, "There must be #{count} argument(s)") if value.size != count
       end
     end
@@ -206,8 +196,39 @@ module RocketJob
       path
     end
 
+    # Returns [Hash<String:Integer>] of the number of dirmon entries in each state.
+    # Note: If there are no workers in that particular state then the hash will not have a value for it.
+    #
+    # Example dirmon entries in every state:
+    #   RocketJob::DirmonEntry.counts_by_state
+    #   # => {
+    #          :pending => 1,
+    #          :enabled => 37,
+    #          :failed => 1,
+    #          :disabled => 3
+    #        }
+    #
+    # Example no dirmon entries:
+    #   RocketJob::Job.counts_by_state
+    #   # => {}
+    def self.counts_by_state
+      counts = {}
+      collection.aggregate([
+        {
+          '$group' => {
+            _id:   '$state',
+            count: {'$sum' => 1}
+          }
+        }
+      ]
+      ).each do |result|
+        counts[result['_id']] = result['count']
+      end
+      counts
+    end
+
     # The default archive directory that is used when the job being queued does not respond
-    # to #file_store_upload or #upload, and do not have an `archive_directory` specified in this entry
+    # to #upload, and does not have an `archive_directory` specified in this entry
     cattr_accessor :default_archive_directory
 
     @@default_archive_directory = '_archive'.freeze
@@ -217,7 +238,11 @@ module RocketJob
     def archive_pathname(file_pathname)
       if archive_directory
         path = Pathname.new(archive_directory)
-        path.mkpath unless path.exist?
+        begin
+          path.mkpath unless path.exist?
+        rescue Errno::ENOENT => exc
+          raise(Errno::ENOENT, "DirmonJob failed to create archive directory: #{path}, #{exc.message}")
+        end
         path.realpath
       else
         file_pathname.dirname.join(self.class.default_archive_directory).realdirpath
@@ -226,7 +251,7 @@ module RocketJob
 
     # Passes each filename [Pathname] found that matches the pattern into the supplied block
     def each(&block)
-      logger.tagged("DirmonEntry:#{id}") do
+      logger.fast_tag("DirmonEntry:#{id}") do
         # Case insensitive filename matching
         Pathname.glob(pattern, File::FNM_CASEFOLD).each do |pathname|
           next if pathname.directory?
@@ -253,7 +278,7 @@ module RocketJob
     end
 
     # Set exception information for this DirmonEntry and fail it
-    def fail_with_exception!(worker_name, exc_or_message)
+    def set_exception(worker_name, exc_or_message)
       if exc_or_message.is_a?(Exception)
         self.exception        = JobException.from_exception(exc_or_message)
         exception.worker_name = worker_name
@@ -265,10 +290,9 @@ module RocketJob
           worker_name: worker_name
         )
       end
-      fail!
     end
 
-    @@whitelist_paths = ThreadSafe::Array.new
+    @@whitelist_paths = Concurrent::Array.new
 
     # Returns the Job to be queued
     def job_class
@@ -280,19 +304,17 @@ module RocketJob
 
     # Queues the job for the supplied pathname
     def later(pathname)
-      job = job_class.new(
-        properties.merge(
-          arguments:      arguments,
-          properties:     properties,
-          perform_method: perform_method
-        )
-      )
-      upload_file(job, pathname)
-      job.save!
-      job
+      if klass = job_class
+        job = klass.new(properties.merge(arguments: arguments))
+        upload_file(job, pathname)
+        job.save!
+        job
+      else
+        raise(ArgumentError, "Cannot instantiate a class for: #{job_class_name.inspect}")
+      end
     end
 
-    protected
+    private
 
     # Instance method to return whitelist paths
     def whitelist_paths
@@ -301,13 +323,7 @@ module RocketJob
 
     # Upload the file to the job
     def upload_file(job, pathname)
-      if job.respond_to?(:file_store_upload)
-        # Allow the job to determine what to do with the file
-        # Pass the pathname as a string, not a Pathname (IO) instance
-        # so that it can read the file directly
-        job.file_store_upload(pathname.to_s)
-        archive_directory ? archive_file(job, pathname) : pathname.unlink
-      elsif job.respond_to?(:upload)
+      if job.respond_to?(:upload)
         # With RocketJob Pro the file can be uploaded directly into the Job itself
         job.upload(pathname.to_s)
         archive_directory ? archive_file(job, pathname) : pathname.unlink
@@ -316,15 +332,17 @@ module RocketJob
       end
     end
 
-    # Archives the file for a job where there was no #file_store_upload or #upload method
+    # Archives the file for a job where there was no #upload method
     def upload_default(job, pathname)
       full_file_name = archive_file(job, pathname)
-      if job.respond_to?(:full_file_name=)
+      if job.respond_to?(:upload_file_name=)
+        job.upload_file_name = full_file_name
+      elsif job.respond_to?(:full_file_name=)
         job.full_file_name = full_file_name
       elsif job.arguments.first.is_a?(Hash)
         job.arguments.first[:full_file_name] = full_file_name
       else
-        raise(ArgumentError, "#{job_class_name} must either have attribute 'full_file_name' or the first argument must be a Hash")
+        raise(ArgumentError, "#{job_class_name} must either have attribute 'upload_file_name' or the first argument must be a Hash")
       end
     end
 

data/lib/rocket_job/extensions/aasm.rb

@@ -0,0 +1,56 @@
+require 'aasm'
+
+# The following patches can be removed once the following PR has been merged into AASM:
+#   https://github.com/aasm/aasm/pull/269
+
+AASM::Core::Event
+module AASM::Core
+  class Event
+    def initialize_copy(orig)
+      super
+      @transitions = @transitions.collect { |transition| transition.clone }
+      @guards      = @guards.dup
+      @unless      = @unless.dup
+      @options     = {}
+      orig.options.each_pair { |name, setting| @options[name] = setting.is_a?(Hash) || setting.is_a?(Array) ? setting.dup : setting }
+    end
+  end
+end
+
+AASM::Core::State
+module AASM::Core
+  class State
+    # called internally by Ruby 1.9 after clone()
+    def initialize_copy(orig)
+      super
+      @options = {}
+      orig.options.each_pair { |name, setting| @options[name] = setting.is_a?(Hash) || setting.is_a?(Array) ? setting.dup : setting }
+    end
+  end
+end
+
+AASM::Core::Transition
+module AASM::Core
+  class Transition
+    def initialize_copy(orig)
+      super
+      @guards = @guards.dup
+      @unless = @unless.dup
+      @opts   = {}
+      orig.opts.each_pair { |name, setting| @opts[name] = setting.is_a?(Hash) || setting.is_a?(Array) ? setting.dup : setting }
+    end
+  end
+end
+
+AASM::StateMachine
+module AASM
+  class StateMachine
+    def initialize_copy(orig)
+      super
+      @states = orig.states.collect { |state| state.clone }
+      @events = {}
+      orig.events.each_pair { |name, event| @events[name] = event.clone }
+    end
+  end
+end
+

data/lib/rocket_job/extensions/mongo.rb

@@ -0,0 +1,23 @@
+require 'mongo'
+
+Mongo::Logging
+module Mongo
+  module Logging
+
+    # Remove annoying message on startup
+    def write_logging_startup_message
+    end
+
+    # Cleanup output
+    def log(level, msg)
+      MongoClient.logger.send(level, msg)
+    end
+
+    protected
+
+    def log_operation(name, payload, duration)
+      MongoClient.logger.benchmark_trace(name, duration: (duration * 1000), payload: payload)
+    end
+
+  end
+end