delayed_job_worker_pool 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7e84e64a69a710244b682df783ea1f7f96ce72a
-  data.tar.gz: 75e5bbb9ffe986ded38517b4bb0fb72e7e5049c0
+  metadata.gz: b57aa82422ba29a08e43da4d5f3b46e5841d2ea0
+  data.tar.gz: 342039b94feef2d751f62470642ce7b584b6f7e2
 SHA512:
-  metadata.gz: 071b9234bfd7e3904bc44eb0957508a31bdd9975d644d7de77d06e3f9b0e8af5ccb0ca185c4bd9e754fde55c52698e4add16ebf873964d31d1af3101cb52d163
-  data.tar.gz: d98c55b40a03b8156d96ebfb870a56e75472101f61806dbab4b52300a6082808e225a4d4a738a689e53d0175d73688a7905e46974c9846080d05358176ca374a
+  metadata.gz: cfed1c0e3a15bed2524aebad47ff861a1130617397aa64ae4fa533d106926c1f3dd0f02a3654576a97d06430c5909ec612d8ea4151d312872bda5b8be706ad40
+  data.tar.gz: 9cd73cb2cc25a036c14559f3e1bb61e76262d09346fe1f2713c6a05b656fe95db6e3064bad9eaecdaa4e110b57119c1a71e6b36885f81f1710966a3aa0a53718

data/CHANGELOG.md

@@ -1,4 +1,4 @@
 # Changelog
 
-### 0.2.0 (unreleased)
-* 
+### 0.2.1 (unreleased)
+* Fix race condition in signal handler

data/README.md

@@ -8,9 +8,11 @@
 [travis]: http://travis-ci.org/salsify/delayed_job_worker_pool
 [codeclimate]: https://codeclimate.com/github/salsify/delayed_job_worker_pool
 
-[Delayed Job's](https://github.com/collectiveidea/delayed_job) built-in worker pooling daemonizes all worker processes. This is great for certain environments but not so great for environments like Heroku that really want your processes to run in the foreground. Delayed Job Worker Pool runs a pool of Delayed Job workers **without** daemonizing them. [Salsify](http://salsify.com) is currently using this to run multiple Delayed Job workers on a single Heroku PX dyno.
+[Delayed Job's](https://github.com/collectiveidea/delayed_job) built-in worker pooling daemonizes all worker processes. This is great for certain environments but not so great for environments like Heroku that really want your processes to run in the foreground. Delayed Job Worker Pool runs a pool of Delayed Job workers **without** daemonizing them.
+
+[Salsify](http://salsify.com) is currently using Delayed Job Worker Pool to run multiple Delayed Job workers on a single Heroku PX dyno. Read more about our experience using this gem on our [blog](http://blog.salsify.com/engineering/delayed-job-worker-pooling).
  
-This gem only works with MRI on Linux/MacOS X.
+**This gem only works with MRI on Linux/MacOS X.**
 
 ## Installation
 

data/lib/delayed_job_worker_pool/version.rb

@@ -1,3 +1,3 @@
 module DelayedJobWorkerPool
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/delayed_job_worker_pool/worker_pool.rb

@@ -1,8 +1,13 @@
 module DelayedJobWorkerPool
   class WorkerPool
+    SIGNALS = ['TERM', 'INT'].map(&:freeze).freeze
+
     def initialize(options = {})
       @options = options
       @worker_pids = []
+      @pending_signals = []
+      @pending_signal_read_pipe, @pending_signal_write_pipe = create_pipe(inheritable: false)
+      @master_alive_read_pipe, @master_alive_write_pipe = create_pipe(inheritable: true)
       self.shutting_down = false
     end
 
@@ -18,7 +23,6 @@ module DelayedJobWorkerPool
 
       log_uninheritable_threads
 
-      create_master_alive_pipe
       num_workers.times { fork_worker }
 
       monitor_workers
@@ -31,16 +35,22 @@ module DelayedJobWorkerPool
 
     private
 
-    attr_reader :options, :worker_pids, :master_alive_read_pipe, :master_alive_write_pipe
+    attr_reader :options, :worker_pids, :master_alive_read_pipe, :master_alive_write_pipe,
+                :pending_signals, :pending_signal_read_pipe, :pending_signal_write_pipe
     attr_accessor :shutting_down
 
     def install_signal_handlers
-      trap('TERM') do
-        shutdown('TERM')
+      SIGNALS.each do |signal|
+        trap(signal) do
+          pending_signals << signal
+          pending_signal_write_pipe.write_nonblock('.')
+        end
       end
+    end
 
-      trap('INT') do
-        shutdown('INT')
+    def uninstall_signal_handlers
+      SIGNALS.each do |signal|
+        trap(signal, 'DEFAULT')
       end
     end
 
@@ -55,10 +65,6 @@ module DelayedJobWorkerPool
       end
     end
 
-    def create_master_alive_pipe
-      @master_alive_read_pipe, @master_alive_write_pipe = IO.pipe
-    end
-
     def load_app
       DelayedJobWorkerPool::Application.load
     end
@@ -73,16 +79,32 @@ module DelayedJobWorkerPool
     end
 
     def monitor_workers
-      until worker_pids.empty?
-        worker_pid, status = Process.wait2
+      while has_workers?
+        if has_pending_signal?
+          shutdown(pending_signals.pop)
+        elsif (wait_result = Process.wait2(-1, Process::WNOHANG))
+          handle_dead_worker(wait_result.first, wait_result.last)
+        else
+          wait_for_signal(1)
+        end
+      end
+    end
 
-        next unless worker_pids.include?(worker_pid)
+    def handle_dead_worker(worker_pid, status)
+      return unless worker_pids.include?(worker_pid)
 
-        log("Worker #{worker_pid} exited with status #{status.to_i}")
-        worker_pids.delete(worker_pid)
-        invoke_callback(:after_worker_shutdown, worker_info(worker_pid))
-        fork_worker unless shutting_down
-      end
+      log("Worker #{worker_pid} exited with status #{status.to_i}")
+      worker_pids.delete(worker_pid)
+      invoke_callback(:after_worker_shutdown, worker_info(worker_pid))
+      fork_worker unless shutting_down
+    end
+
+    def has_workers?
+      !worker_pids.empty?
+    end
+
+    def has_pending_signal?
+      !pending_signals.empty?
     end
 
     def invoke_callback(callback_name, *args)
@@ -99,6 +121,8 @@ module DelayedJobWorkerPool
     def run_worker
       master_alive_write_pipe.close
 
+      uninstall_signal_handlers
+
       Thread.new do
         IO.select([master_alive_read_pipe])
         log('Detected dead master. Shutting down worker.')
@@ -135,6 +159,31 @@ module DelayedJobWorkerPool
       options.except(:workers, :preload_app, *DelayedJobWorkerPool::DSL::CALLBACK_SETTINGS).merge(name: worker_name(worker_pid))
     end
 
+    def create_pipe(inheritable: true)
+      read, write = IO.pipe
+      unless inheritable
+        make_file_descriptor_uninheritable(read)
+        make_file_descriptor_uninheritable(write)
+      end
+      [read, write]
+    end
+
+    def make_file_descriptor_uninheritable(io)
+      io.fcntl(Fcntl::F_SETFD)
+    end
+
+    def wait_for_signal(timeout)
+      if IO.select([pending_signal_read_pipe], [], [], timeout)
+        drain_pipe(pending_signal_read_pipe)
+      end
+    end
+
+    def drain_pipe(pipe)
+      loop { pipe.read_nonblock(16) }
+    rescue IO::WaitReadable
+      # We've drained the pipe
+    end
+
     def log(message)
       puts(message)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_worker_pool
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Joel Turkel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job