qless-pool 0.1.0

data/features/support/aruba_daemon_support.rb

@@ -0,0 +1,76 @@
+require 'aruba/cucumber'
+require 'aruba/api'
+require 'aruba/process'
+
+module Aruba
+
+  module Api
+
+    # this is a horrible hack, to make sure that it's done what it needs to do
+    # before we do our next step
+    def keep_trying(timeout=10, tries=0)
+      puts "Try: #{tries}" if @announce_env
+      yield
+    rescue RSpec::Expectations::ExpectationNotMetError
+      if tries < timeout
+        sleep 1
+        tries += 1
+        retry
+      else
+        raise
+      end
+    end
+
+    def run_background(cmd)
+      @background = run(cmd)
+    end
+
+    def send_signal(cmd, signal)
+      announce_or_puts "$ kill -#{signal} #{processes[cmd].pid}" if @announce_env
+      processes[cmd].send_signal signal
+    end
+
+    def background_pid
+      @pid_from_pidfile || @background.pid
+    end
+
+    # like all_stdout, but doesn't stop processes first
+    def interactive_stdout
+      only_processes.inject("") { |out, ps| out << ps.stdout(@aruba_keep_ansi) }
+    end
+
+    # like all_stderr, but doesn't stop processes first
+    def interactive_stderr
+      only_processes.inject("") { |out, ps| out << ps.stderr(@aruba_keep_ansi) }
+    end
+
+    # like all_output, but doesn't stop processes first
+    def interactive_output
+      interactive_stdout << interactive_stderr
+    end
+
+    def interpolate_background_pid(string)
+      interpolated = string.gsub('$PID', background_pid.to_s)
+      announce_or_puts interpolated if @announce_env
+      interpolated
+    end
+
+    def kill_all_processes!
+    #  stop_processes!
+    #rescue
+    #  processes.each {|cmd,process| send_signal(cmd, 'KILL') }
+    #  raise
+    end
+
+  end
+
+  class Process
+    def pid
+      @process.pid
+    end
+    def send_signal signal
+      @process.send :send_signal, signal
+    end
+  end
+
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+ENV["RAILS_ENV"] = "test"

data/lib/qless/pool.rb

@@ -0,0 +1,415 @@
+# -*- encoding: utf-8 -*-
+require 'qless'
+require 'qless/worker'
+require 'qless/pool/version'
+require 'qless/pool/logging'
+require 'qless/pool/pooled_worker'
+require 'qless/pool/pool_factory'
+require 'erb'
+require 'fcntl'
+require 'yaml'
+
+module Qless
+  class Pool
+    SIG_QUEUE_MAX_SIZE = 5
+    DEFAULT_WORKER_INTERVAL = 5
+    QUEUE_SIGS = [ :QUIT, :INT, :TERM, :USR1, :USR2, :CONT, :HUP, :WINCH, ]
+    CHUNK_SIZE = (16 * 1024)
+
+    include Logging
+    extend  Logging
+    attr_reader :config
+    attr_reader :workers
+
+    def initialize(config)
+      init_config(config)
+      @workers = Hash.new { |workers, queues| workers[queues] = {} }
+      procline "(initialized)"
+    end
+
+    def self.pool_factory
+      @pool_factory ||= Qless::PoolFactory.new
+    end
+    
+    def pool_factory
+      self.class.pool_factory
+    end
+    
+    def self.pool_factory=(factory)
+      @pool_factory = factory
+    end
+    
+    # Config: after_prefork {{{
+
+    # The `after_prefork` hook will be run in workers if you are using the
+    # preforking master worker to save memory. Use this hook to reload
+    # database connections and so forth to ensure that they're not shared
+    # among workers.
+    #
+    # Call with a block to set the hook.
+    # Call with no arguments to return the hook.
+    def self.after_prefork(&block)
+      block ? (@after_prefork = block) : @after_prefork
+    end
+
+    # Set the after_prefork proc.
+    def self.after_prefork=(after_prefork)
+      @after_prefork = after_prefork
+    end
+
+    def call_after_prefork!
+      self.class.after_prefork && self.class.after_prefork.call
+    end
+
+    # }}}
+    # Config: class methods to start up the pool using the default config {{{
+
+    @config_files = ["qless-pool.yml", "config/qless-pool.yml"]
+    class << self; attr_accessor :config_files, :app_name; end
+
+    def self.app_name
+      @app_name ||= File.basename(Dir.pwd)
+    end
+
+    def self.handle_winch?
+      @handle_winch ||= false
+    end
+    def self.handle_winch=(bool)
+      @handle_winch = bool
+    end
+
+    def self.choose_config_file
+      if ENV["QLESS_POOL_CONFIG"]
+        ENV["QLESS_POOL_CONFIG"]
+      else
+        @config_files.detect { |f| File.exist?(f) }
+      end
+    end
+
+    def self.run
+      if GC.respond_to?(:copy_on_write_friendly=)
+        GC.copy_on_write_friendly = true
+      end
+      Qless::Pool.new(choose_config_file).start.join
+    end
+
+    # }}}
+    # Config: load config and config file {{{
+
+    def config_file
+      @config_file || (!@config && ::Qless::Pool.choose_config_file)
+    end
+
+    def init_config(config)
+      case config
+      when String, nil
+        @config_file = config
+      else
+        @config = config.dup
+      end
+      load_config
+    end
+
+    def load_config
+      if config_file
+        @config = YAML.load(ERB.new(IO.read(config_file)).result)
+      else
+        @config ||= {}
+      end
+      environment and @config[environment] and config.merge!(@config[environment])
+      config.delete_if {|key, value| value.is_a? Hash }
+    end
+
+    def environment
+      if defined?(Rails) && Rails.respond_to?(:env)
+        Rails.env
+      elsif defined? RAILS_ENV
+        RAILS_ENV
+      else
+        ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['QLESS_ENV']
+      end
+    end
+
+    # }}}
+
+    # Sig handlers and self pipe management {{{
+
+    def self_pipe; @self_pipe ||= [] end
+    def sig_queue; @sig_queue ||= [] end
+
+    def init_self_pipe!
+      self_pipe.each { |io| io.close rescue nil }
+      self_pipe.replace(IO.pipe)
+      self_pipe.each { |io| io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) }
+    end
+
+    def init_sig_handlers!
+      QUEUE_SIGS.each { |sig| trap_deferred(sig) }
+      trap(:CHLD)     { |_| awaken_master }
+    end
+
+    def awaken_master
+      begin
+        self_pipe.last.write_nonblock('.') # wakeup master process from select
+      rescue Errno::EAGAIN, Errno::EINTR
+        # pipe is full, master should wake up anyways
+        retry
+      end
+    end
+
+    class QuitNowException < Exception; end
+    # defer a signal for later processing in #join (master process)
+    def trap_deferred(signal)
+      trap(signal) do |sig_nr|
+        if @waiting_for_reaper && [:INT, :TERM].include?(signal)
+          log "Recieved #{signal}: short circuiting QUIT waitpid"
+          raise QuitNowException
+        end
+        if sig_queue.size < SIG_QUEUE_MAX_SIZE
+          sig_queue << signal
+          awaken_master
+        else
+          log "ignoring SIG#{signal}, queue=#{sig_queue.inspect}"
+        end
+      end
+    end
+
+    def reset_sig_handlers!
+      QUEUE_SIGS.each {|sig| trap(sig, "DEFAULT") }
+    end
+
+    def handle_sig_queue!
+      case signal = sig_queue.shift
+      when :USR1, :USR2, :CONT
+        log "#{signal}: sending to all workers"
+        signal_all_workers(signal)
+      when :HUP
+        log "HUP: reload config file and reload logfiles"
+        load_config
+        Logging.reopen_logs!
+        log "HUP: gracefully shutdown old children (which have old logfiles open)"
+        signal_all_workers(:QUIT)
+        log "HUP: new children will inherit new logfiles"
+        maintain_worker_count
+      when :WINCH
+        if self.class.handle_winch?
+          log "WINCH: gracefully stopping all workers"
+          @config = {}
+          maintain_worker_count
+        end
+      when :QUIT
+        graceful_worker_shutdown_and_wait!(signal)
+      when :INT
+        graceful_worker_shutdown!(signal)
+      when :TERM
+        case self.class.term_behavior
+        when "graceful_worker_shutdown_and_wait"
+          graceful_worker_shutdown_and_wait!(signal)
+        when "graceful_worker_shutdown"
+          graceful_worker_shutdown!(signal)
+        else
+          shutdown_everything_now!(signal)
+        end
+      end
+    end
+
+    class << self
+      attr_accessor :term_behavior
+    end
+
+    def graceful_worker_shutdown_and_wait!(signal)
+      log "#{signal}: graceful shutdown, waiting for children"
+      signal_all_workers(:QUIT)
+      reap_all_workers(0) # will hang until all workers are shutdown
+      :break
+    end
+
+    def graceful_worker_shutdown!(signal)
+      log "#{signal}: immediate shutdown (graceful worker shutdown)"
+      signal_all_workers(:QUIT)
+      :break
+    end
+
+    def shutdown_everything_now!(signal)
+      log "#{signal}: immediate shutdown (and immediate worker shutdown)"
+      signal_all_workers(:TERM)
+      :break
+    end
+
+    # }}}
+    # start, join, and master sleep {{{
+
+    def start
+      procline("(starting)")
+      init_self_pipe!
+      init_sig_handlers!
+      maintain_worker_count
+      procline("(started)")
+      log "started manager"
+      report_worker_pool_pids
+      self
+    end
+
+    def report_worker_pool_pids
+      if workers.empty?
+        log "Pool is empty"
+      else
+        log "Pool contains worker PIDs: #{all_pids.inspect}"
+      end
+    end
+
+    def join
+      loop do
+        reap_all_workers
+        break if handle_sig_queue! == :break
+        if sig_queue.empty?
+          master_sleep
+          maintain_worker_count
+        end
+        procline("managing #{all_pids.inspect}")
+      end
+      procline("(shutting down)")
+      #stop # gracefully shutdown all workers on our way out
+      log "manager finished"
+      #unlink_pid_safe(pid) if pid
+    end
+
+    def master_sleep
+      begin
+        ready = IO.select([self_pipe.first], nil, nil, 1) or return
+        ready.first && ready.first.first or return
+        loop { self_pipe.first.read_nonblock(CHUNK_SIZE) }
+      rescue Errno::EAGAIN, Errno::EINTR
+      end
+    end
+
+    # }}}
+    # worker process management {{{
+
+    def reap_all_workers(waitpid_flags=Process::WNOHANG)
+      @waiting_for_reaper = waitpid_flags == 0
+      begin
+        loop do
+          # -1, wait for any child process
+          wpid, status = Process.waitpid2(-1, waitpid_flags)
+          break unless wpid
+
+          if worker = delete_worker(wpid)
+            log "Reaped qless worker[#{status.pid}] (status: #{status.exitstatus}) queues: #{worker.job_reserver.queues.collect(&:name).join(",")}"
+          else
+            # this died before it could be killed, so it's not going to have any extra info
+            log "Tried to reap worker [#{status.pid}], but it had already died. (status: #{status.exitstatus})"
+          end
+        end
+      rescue Errno::EINTR
+        retry
+      rescue Errno::ECHILD, QuitNowException
+      end
+    end
+
+    # TODO: close any file descriptors connected to worker, if any
+    def delete_worker(pid)
+      worker = nil
+      workers.detect do |queues, pid_to_worker|
+        worker = pid_to_worker.delete(pid)
+      end
+      worker
+    end
+
+    def all_pids
+      workers.map {|q,workers| workers.keys }.flatten
+    end
+
+    def signal_all_workers(signal)
+      all_pids.each do |pid|
+        Process.kill signal, pid
+      end
+    end
+
+    # }}}
+    # ???: maintain_worker_count, all_known_queues {{{
+
+    def maintain_worker_count
+      all_known_queues.each do |queues|
+        delta = worker_delta_for(queues)
+        spawn_missing_workers_for(queues, delta) if delta > 0
+        quit_excess_workers_for(queues, delta.abs)   if delta < 0
+      end
+    end
+
+    def all_known_queues
+      config.keys | workers.keys
+    end
+
+    # }}}
+    # methods that operate on a single grouping of queues {{{
+    # perhaps this means a class is waiting to be extracted
+
+    def spawn_missing_workers_for(queues, delta)
+      delta.times { spawn_worker!(queues) }
+    end
+
+    def quit_excess_workers_for(queues, delta)
+      pids_for(queues)[0...delta].each do |pid|
+        Process.kill("QUIT", pid)
+      end
+    end
+    
+    # use qless to get a number for currently running workers on
+    # a machine so we don't double up after a restart with long
+    # running jobs still active
+    def running_worker_count
+      # may want to do a zcard on ql:workers instead
+      count = 0
+      machine_hostname = Socket.gethostname
+      worker_info = pool_factory.client.workers.counts
+      worker_info.each do |worker|
+        hostname, pid = worker['name'].split('-')
+        count += 1 if machine_hostname == hostname
+      end
+      count
+    end
+
+    def configured_worker_count
+      config.values.inject {|sum,x| sum + x }
+    end
+
+    def worker_delta_for(queues)
+      delta = config.fetch(queues, 0) - workers.fetch(queues, []).size
+      delta = 0 if delta > 0 && running_worker_count > configured_worker_count
+      delta
+    end
+
+    def pids_for(queues)
+      workers[queues].keys
+    end
+
+    def spawn_worker!(queues)
+      worker = create_worker(queues)
+      pid = fork do
+        # This var gets cached, so need to clear it out in forks
+        # so that workers report the correct name to qless
+        Qless.instance_variable_set(:@worker_name, nil)
+        pool_factory.client.redis.client.reconnect
+        log_worker "Starting worker #{worker}"
+        call_after_prefork!
+        reset_sig_handlers!
+        #self_pipe.each {|io| io.close }
+        begin
+          worker.work(ENV['INTERVAL'] || DEFAULT_WORKER_INTERVAL) # interval, will block
+        rescue Errno::EINTR
+          log "Caught interrupted system call Errno::EINTR. Retrying."
+          retry
+        end
+      end
+      workers[queues][pid] = worker
+    end
+
+    def create_worker(queues)
+      pool_factory.worker(queues)
+    end
+
+    # }}}
+
+  end
+end