delayed_job_tgmerritt 4.0.7

data/lib/delayed/command.rb

@@ -0,0 +1,170 @@
+unless ENV['RAILS_ENV'] == 'test'
+  begin
+    require 'daemons'
+  rescue LoadError
+    raise "You need to add gem 'daemons' to your Gemfile if you wish to use it."
+  end
+end
+require 'optparse'
+require 'pathname'
+
+module Delayed
+  class Command # rubocop:disable ClassLength
+    attr_accessor :worker_count, :worker_pools
+
+    DIR_PWD = Pathname.new Dir.pwd
+
+    def initialize(args) # rubocop:disable MethodLength
+      @options = {
+        :quiet => true,
+        :pid_dir => "#{root}/tmp/pids",
+        :log_dir => "#{root}/log"
+      }
+
+      @worker_count = 1
+      @monitor = false
+
+      opts = OptionParser.new do |opt|
+        opt.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] start|stop|restart|run"
+
+        opt.on('-h', '--help', 'Show this message') do
+          puts opt
+          exit 1
+        end
+        opt.on('-e', '--environment=NAME', 'Specifies the environment to run this delayed jobs under (test/development/production).') do |_e|
+          STDERR.puts 'The -e/--environment option has been deprecated and has no effect. Use RAILS_ENV and see http://github.com/collectiveidea/delayed_job/issues/#issue/7'
+        end
+        opt.on('--min-priority N', 'Minimum priority of jobs to run.') do |n|
+          @options[:min_priority] = n
+        end
+        opt.on('--max-priority N', 'Maximum priority of jobs to run.') do |n|
+          @options[:max_priority] = n
+        end
+        opt.on('-n', '--number_of_workers=workers', 'Number of unique workers to spawn') do |worker_count|
+          @worker_count = worker_count.to_i rescue 1 # rubocop:disable RescueModifier
+        end
+        opt.on('--pid-dir=DIR', 'Specifies an alternate directory in which to store the process ids.') do |dir|
+          @options[:pid_dir] = dir
+        end
+        opt.on('--log-dir=DIR', 'Specifies an alternate directory in which to store the delayed_job log.') do |dir|
+          @options[:log_dir] = dir
+        end
+        opt.on('-i', '--identifier=n', 'A numeric identifier for the worker.') do |n|
+          @options[:identifier] = n
+        end
+        opt.on('-m', '--monitor', 'Start monitor process.') do
+          @monitor = true
+        end
+        opt.on('--sleep-delay N', 'Amount of time to sleep when no jobs are found') do |n|
+          @options[:sleep_delay] = n.to_i
+        end
+        opt.on('--read-ahead N', 'Number of jobs from the queue to consider') do |n|
+          @options[:read_ahead] = n
+        end
+        opt.on('-p', '--prefix NAME', 'String to be prefixed to worker process names') do |prefix|
+          @options[:prefix] = prefix
+        end
+        opt.on('--queues=queues', 'Specify which queue DJ must look up for jobs') do |queues|
+          @options[:queues] = queues.split(',')
+        end
+        opt.on('--queue=queue', 'Specify which queue DJ must look up for jobs') do |queue|
+          @options[:queues] = queue.split(',')
+        end
+        opt.on('--pool=queue1[,queue2][:worker_count]', 'Specify queues and number of workers for a worker pool') do |pool|
+          parse_worker_pool(pool)
+        end
+        opt.on('--exit-on-complete', 'Exit when no more jobs are available to run. This will exit if all jobs are scheduled to run in the future.') do
+          @options[:exit_on_complete] = true
+        end
+      end
+      @args = opts.parse!(args)
+    end
+
+    def daemonize # rubocop:disable PerceivedComplexity
+      dir = @options[:pid_dir]
+      Dir.mkdir(dir) unless File.exist?(dir)
+
+      if worker_pools
+        setup_pools
+      elsif @options[:identifier]
+        if worker_count > 1
+          raise ArgumentError, 'Cannot specify both --number-of-workers and --identifier'
+        else
+          run_process("delayed_job.#{@options[:identifier]}", @options)
+        end
+      else
+        worker_count.times do |worker_index|
+          process_name = worker_count == 1 ? 'delayed_job' : "delayed_job.#{worker_index}"
+          run_process(process_name, @options)
+        end
+      end
+    end
+
+    def setup_pools
+      worker_index = 0
+      @worker_pools.each do |queues, worker_count|
+        options = @options.merge(:queues => queues)
+        worker_count.times do
+          process_name = "delayed_job.#{worker_index}"
+          run_process(process_name, options)
+          worker_index += 1
+        end
+      end
+    end
+
+    def run_process(process_name, options = {})
+      Delayed::Worker.before_fork
+      Daemons.run_proc(process_name, :dir => options[:pid_dir], :dir_mode => :normal, :monitor => @monitor, :ARGV => @args) do |*_args|
+        $0 = File.join(options[:prefix], process_name) if @options[:prefix]
+        run process_name, options
+      end
+    end
+
+    def run(worker_name = nil, options = {})
+      Dir.chdir(root)
+
+      Delayed::Worker.after_fork
+      Delayed::Worker.logger ||= Logger.new(File.join(@options[:log_dir], 'delayed_job.log'))
+
+      worker = Delayed::Worker.new(options)
+      worker.name_prefix = "#{worker_name} "
+      worker.start
+    rescue => e
+      STDERR.puts e.message
+      STDERR.puts e.backtrace
+      ::Rails.logger.fatal(e) if rails_logger_defined?
+      exit_with_error_status
+    end
+
+  private
+
+    def parse_worker_pool(pool)
+      @worker_pools ||= []
+
+      queues, worker_count = pool.split(':')
+      if ['*', '', nil].include?(queues)
+        queues = []
+      else
+        queues = queues.split(',')
+      end
+      worker_count = (worker_count || 1).to_i rescue 1
+      @worker_pools << [queues, worker_count]
+    end
+
+    def root
+      @root ||= rails_root_defined? ? ::Rails.root : DIR_PWD
+    end
+
+    def rails_root_defined?
+      defined?(::Rails.root)
+    end
+
+    def rails_logger_defined?
+      defined?(::Rails.logger)
+    end
+
+    def exit_with_error_status
+      exit 1
+    end
+  end
+end

data/lib/delayed/compatibility.rb

@@ -0,0 +1,27 @@
+require 'active_support/version'
+
+module Delayed
+  module Compatibility
+    if ActiveSupport::VERSION::MAJOR >= 4
+      require 'active_support/proxy_object'
+
+      def self.executable_prefix
+        'bin'
+      end
+
+      def self.proxy_object_class
+        ActiveSupport::ProxyObject
+      end
+    else
+      require 'active_support/basic_object'
+
+      def self.executable_prefix
+        'script'
+      end
+
+      def self.proxy_object_class
+        ActiveSupport::BasicObject
+      end
+    end
+  end
+end

data/lib/delayed/deserialization_error.rb

@@ -0,0 +1,4 @@
+module Delayed
+  class DeserializationError < StandardError
+  end
+end

data/lib/delayed/exceptions.rb

@@ -0,0 +1,12 @@
+require 'timeout'
+
+module Delayed
+  class WorkerTimeout < Timeout::Error
+    def message
+      seconds = Delayed::Worker.max_run_time.to_i
+      "#{super} (Delayed::Worker.max_run_time is only #{seconds} second#{seconds == 1 ? '' : 's'})"
+    end
+  end
+
+  class FatalBackendError < Exception; end
+end

data/lib/delayed/lifecycle.rb

@@ -0,0 +1,85 @@
+module Delayed
+  class InvalidCallback < Exception; end
+
+  class Lifecycle
+    EVENTS = {
+      :enqueue    => [:job],
+      :execute    => [:worker],
+      :loop       => [:worker],
+      :perform    => [:worker, :job],
+      :error      => [:worker, :job],
+      :failure    => [:worker, :job],
+      :invoke_job => [:job]
+    }
+
+    def initialize
+      @callbacks = EVENTS.keys.each_with_object({}) do |e, hash|
+        hash[e] = Callback.new
+      end
+    end
+
+    def before(event, &block)
+      add(:before, event, &block)
+    end
+
+    def after(event, &block)
+      add(:after, event, &block)
+    end
+
+    def around(event, &block)
+      add(:around, event, &block)
+    end
+
+    def run_callbacks(event, *args, &block)
+      missing_callback(event) unless @callbacks.key?(event)
+
+      unless EVENTS[event].size == args.size
+        raise ArgumentError, "Callback #{event} expects #{EVENTS[event].size} parameter(s): #{EVENTS[event].join(', ')}"
+      end
+
+      @callbacks[event].execute(*args, &block)
+    end
+
+  private
+
+    def add(type, event, &block)
+      missing_callback(event) unless @callbacks.key?(event)
+      @callbacks[event].add(type, &block)
+    end
+
+    def missing_callback(event)
+      raise InvalidCallback, "Unknown callback event: #{event}"
+    end
+  end
+
+  class Callback
+    def initialize
+      @before = []
+      @after = []
+
+      # Identity proc. Avoids special cases when there is no existing around chain.
+      @around = lambda { |*args, &block| block.call(*args) }
+    end
+
+    def execute(*args, &block)
+      @before.each { |c| c.call(*args) }
+      result = @around.call(*args, &block)
+      @after.each { |c| c.call(*args) }
+      result
+    end
+
+    def add(type, &callback)
+      case type
+      when :before
+        @before << callback
+      when :after
+        @after << callback
+      when :around
+        chain = @around # use a local variable so that the current chain is closed over in the following lambda
+        @around = lambda { |*a, &block| chain.call(*a) { |*b| callback.call(*b, &block) } }
+      else
+        raise InvalidCallback, "Invalid callback type: #{type}"
+      end
+    end
+  end
+end

data/lib/delayed/message_sending.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/module/aliasing'
+
+module Delayed
+  class DelayProxy < Delayed::Compatibility.proxy_object_class
+    def initialize(payload_class, target, options)
+      @payload_class = payload_class
+      @target = target
+      @options = options
+    end
+
+    def method_missing(method, *args)
+      Job.enqueue({:payload_object => @payload_class.new(@target, method.to_sym, args)}.merge(@options))
+    end
+  end
+
+  module MessageSending
+    def delay(options = {})
+      DelayProxy.new(PerformableMethod, self, options)
+    end
+    alias_method :__delay__, :delay
+
+    def send_later(method, *args)
+      warn '[DEPRECATION] `object.send_later(:method)` is deprecated. Use `object.delay.method'
+      __delay__.__send__(method, *args)
+    end
+
+    def send_at(time, method, *args)
+      warn '[DEPRECATION] `object.send_at(time, :method)` is deprecated. Use `object.delay(:run_at => time).method'
+      __delay__(:run_at => time).__send__(method, *args)
+    end
+
+    module ClassMethods
+      def handle_asynchronously(method, opts = {})
+        aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1 # rubocop:disable PerlBackrefs
+        with_method, without_method = "#{aliased_method}_with_delay#{punctuation}", "#{aliased_method}_without_delay#{punctuation}"
+        define_method(with_method) do |*args|
+          curr_opts = opts.clone
+          curr_opts.each_key do |key|
+            next unless (val = curr_opts[key]).is_a?(Proc)
+            curr_opts[key] = if val.arity == 1
+              val.call(self)
+            else
+              val.call
+            end
+          end
+          delay(curr_opts).__send__(without_method, *args)
+        end
+        alias_method_chain method, :delay
+      end
+    end
+  end
+end

data/lib/delayed/performable_mailer.rb

@@ -0,0 +1,22 @@
+require 'mail'
+
+module Delayed
+  class PerformableMailer < PerformableMethod
+    def perform
+      mailer = object.send(method_name, *args)
+      mailer.respond_to?(:deliver_now) ? mailer.deliver_now : mailer.deliver
+    end
+  end
+
+  module DelayMail
+    def delay(options = {})
+      DelayProxy.new(PerformableMailer, self, options)
+    end
+  end
+end
+
+Mail::Message.class_eval do
+  def delay(*_args)
+    raise 'Use MyMailer.delay.mailer_action(args) to delay sending of emails.'
+  end
+end

data/lib/delayed/performable_method.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext/module/delegation'
+
+module Delayed
+  class PerformableMethod
+    attr_accessor :object, :method_name, :args
+
+    delegate :method, :to => :object
+
+    def initialize(object, method_name, args)
+      raise NoMethodError, "undefined method `#{method_name}' for #{object.inspect}" unless object.respond_to?(method_name, true)
+
+      if object.respond_to?(:persisted?) && !object.persisted?
+        raise(ArgumentError, "job cannot be created for non-persisted record: #{object.inspect}")
+      end
+
+      self.object       = object
+      self.args         = args
+      self.method_name  = method_name.to_sym
+    end
+
+    def display_name
+      if object.is_a?(Class)
+        "#{object}.#{method_name}"
+      else
+        "#{object.class}##{method_name}"
+      end
+    end
+
+    def perform
+      object.send(method_name, *args) if object
+    end
+
+    def method_missing(symbol, *args)
+      object.send(symbol, *args)
+    end
+
+    def respond_to?(symbol, include_private = false)
+      super || object.respond_to?(symbol, include_private)
+    end
+  end
+end

data/lib/delayed/plugin.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/class/attribute'
+
+module Delayed
+  class Plugin
+    class_attribute :callback_block
+
+    def self.callbacks(&block)
+      self.callback_block = block
+    end
+
+    def initialize
+      self.class.callback_block.call(Delayed::Worker.lifecycle) if self.class.callback_block
+    end
+  end
+end

data/lib/delayed/plugins/clear_locks.rb

@@ -0,0 +1,15 @@
+module Delayed
+  module Plugins
+    class ClearLocks < Plugin
+      callbacks do |lifecycle|
+        lifecycle.around(:execute) do |worker, &block|
+          begin
+            block.call(worker)
+          ensure
+            Delayed::Job.clear_locks!(worker.name)
+          end
+        end
+      end
+    end
+  end
+end