sidekiq-pool 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b8e14e29f0d6c84a30148c3e6ad2b18bc4f5c3d
-  data.tar.gz: bc8370193f03b299eb2dbdbdc4f28a6f9cf8670f
+  metadata.gz: 1eae1143714aedde01e2e9b38713e1d017836950
+  data.tar.gz: f4ffeca132df5655eb44cfd6fe8e7d67236312e4
 SHA512:
-  metadata.gz: 513c0b7b8d2306e24cadec43b58ea46cba3dfc329ccf98a750ca477442528be1fcf06be4b0eaaf8bf686e61fabc0d89c3f87facef90c43683a485523f9164bcc
-  data.tar.gz: b265f6ee9de615966096ad2f55f482926ef185a8dac989cee72504348b10865a389c467630a4472a9eb953b3c0b62110561acd08ea558f1d266631783f611fb5
+  metadata.gz: fe81588f152fcf36f0b52888180c5b70dd2e4fbcdd258ccc01ac2cda72327af7d37e4a6533e5b052e6c274ef9b7cdc5ec9dcb4e941410b8ee2cdc0fef967ccd6
+  data.tar.gz: da14ea02a6af1ff6c71e30eaf968edff21996e80fef4cd0aedd24ecc91524f88dd4c0e3474a4938f16d83d517075c0438642f6885b0a7bd8a359c61c892a3887

data/README.md

@@ -16,6 +16,7 @@ Create a config file and specify it's path with the *p* command line option (the
 Paste the following config and modify it to your needs:
 
 ```yaml
+:working_directory: /path/to/working/direcory # optional, needed if HUP reload is used with symlink
 :workers:
   -
     :command: '-q default -q high'
@@ -39,6 +40,11 @@ Start pool with a non-default path config
 
 Signals `USR1`, `USR2` are forwarded to the children.
 
+Signal `HUP` to parent starts new children and then stops old.
+
+When using symlinked working directory `working_directory` configuration
+option must be used to pick up new code.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/laurynas/sidekiq-pool.

data/lib/sidekiq/pool/cli.rb

@@ -14,18 +14,11 @@ module Sidekiq
       alias_method :run_child, :run
 
       def run
-        @settings = parse_config_file(@pool_config)
-        @types = @settings[:workers]
         @master_pid = $$
 
         trap_signals
         update_process_name
-        @types.each do |type|
-          type[:amount].times do
-            sleep @fork_wait || DEFAULT_FORK_WAIT
-            add_child(type[:command])
-          end
-        end
+        start_new_pool
 
         wait_for_signals
       end
@@ -48,6 +41,19 @@ module Sidekiq
 
       DEFAULT_FORK_WAIT = 1
 
+      def start_new_pool
+        logger.info 'Starting new pool'
+        @settings = parse_config_file(@pool_config)
+        Dir.chdir(@settings[:working_directory]) if @settings[:working_directory]
+        @types = @settings[:workers]
+        @types.each do |type|
+          type[:amount].times do
+            sleep @fork_wait || DEFAULT_FORK_WAIT
+            add_child(type[:command])
+          end
+        end
+      end
+
       def parse_options(argv)
         opts = {}
 
@@ -132,7 +138,7 @@ module Sidekiq
       def trap_signals
         @self_read, @self_write = IO.pipe
 
-        %w(INT TERM USR1 USR2 CHLD).each do |sig|
+        %w(INT TERM USR1 USR2 CHLD HUP).each do |sig|
           begin
             trap sig do
               @self_write.puts(sig) unless fork?
@@ -178,6 +184,23 @@ module Sidekiq
         when 'USR2'
           logger.info "Sending #{sig} signal to the pool"
           signal_to_pool(sig)
+        when 'HUP'
+          logger.info 'Gracefully reloading pool'
+          old_pool = @pool.dup
+
+          # Signal old pool
+          # USR1 tells Sidekiq it will be shutting down in near future.
+          signal_to_pool('USR1')
+
+          # Reset pool
+          @pool = []
+
+          # Start new pool
+          start_new_pool
+
+          # Stop old pool
+          stop_children(old_pool)
+          logger.info 'Graceful reload completed'
         end
       end
 
@@ -186,9 +209,8 @@ module Sidekiq
         fork_child(*arg)
       end
 
-
-      def signal_to_pool(sig)
-        @pool.each { |child| signal_to_child(sig, child[:pid]) }
+      def signal_to_pool(sig, given_pool = @pool)
+        given_pool.each { |child| signal_to_child(sig, child[:pid]) }
       end
 
       def signal_to_child(sig, pid)
@@ -218,7 +240,7 @@ module Sidekiq
         false
       end
 
-      def stop_children
+      def stop_children(given_pool = @pool)
         @done = true
         logger.info 'Stopping children'
         update_process_name
@@ -228,13 +250,13 @@ module Sidekiq
           wait_time = (Time.now - time).to_i
           if wait_time > options[:timeout] + 2
             logger.warn("Children didn't stop in #{wait_time}s, killing")
-            signal_to_pool('KILL')
+            signal_to_pool('KILL', given_pool)
           else
-            signal_to_pool('TERM')
+            signal_to_pool('TERM', given_pool)
           end
           sleep(1)
           ::Process.waitpid2(-1, ::Process::WNOHANG)
-          break if @pool.none? { |child| alive?(child[:pid]) }
+          break if given_pool.none? { |child| alive?(child[:pid]) }
         end
       end
 

data/lib/sidekiq/pool/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Pool
-    VERSION = '1.0.2'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-pool
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Laurynas Butkus