perfectqueue 0.8.11 → 0.8.12

data/ChangeLog

@@ -1,4 +1,9 @@
 
+== 2012-08-05 version 0.8.12
+
+* Support 'process detach' feature for a replacement of binary replace
+
+
 == 2012-08-05 version 0.8.11
 
 * Support child_fork_frequency_limit option to wait before forking child

data/README.md

@@ -142,13 +142,12 @@ PerfectQueue::Worker.run(Dispatch) {
 
 ### Signal handlers
 
-- **TERM**,**INT:** graceful shutdown
+- **TERM:** graceful shutdown
 - **QUIT:** immediate shutdown
 - **USR1:** graceful restart
 - **HUP:** immediate restart
-- **EMT:** immediate binary replace
-- **WINCH:** graceful binary replace
 - **USR2:** reopen log files
+- **INT:** detach process
 
 ## Configuration
 

data/lib/perfectqueue.rb

@@ -39,6 +39,7 @@ module PerfectQueue
     :TaskMetadataAccessors => 'perfectqueue/task_metadata',
     :TaskStatus => 'perfectqueue/task_status',
     :Worker => 'perfectqueue/worker',
+    :Supervisor => 'perfectqueue/supervisor',
     :SignalQueue => 'perfectqueue/signal_queue',
     :VERSION => 'perfectqueue/version',
   }.each_pair {|k,v|

data/lib/perfectqueue/multiprocess/child_process.rb

@@ -40,7 +40,7 @@ module PerfectQueue
 
       # override
       def stop(immediate)
-        @log.info "Exiting worker pid=#{Process.pid}"
+        @log.info "Exiting processor id=#{@processor_id} pid=#{Process.pid}"
         super
       end
 
@@ -63,7 +63,7 @@ module PerfectQueue
       def child_heartbeat
         @wpipe.write HEARTBEAT_PACKET
       rescue
-        @log.error "Parent process unexpectedly died. Exiting worker pid=#{Process.pid}: #{$!}"
+        @log.error "Parent process unexpectedly died. Exiting processor pid=#{Process.pid}: #{$!}"
         stop(true)
         Process.kill(:KILL, Process.pid)
         exit! 137

data/lib/perfectqueue/multiprocess/child_process_monitor.rb

@@ -72,12 +72,12 @@ module PerfectQueue
 
         begin
           if Process.waitpid(@pid, Process::WNOHANG)
-            @log.info "Worker exited pid=#{@pid}"
+            @log.info "Processor exited pid=#{@pid}"
             return true
           end
         rescue Errno::ECHILD
-          # SIGCHLD is trapped in Worker#install_signal_handlers
-          @log.info "Worker exited pid=#{@pid}"
+          # SIGCHLD is trapped in Supervisor#install_signal_handlers
+          @log.info "Processor exited pid=#{@pid}"
           return true
         end
 

data/lib/perfectqueue/multiprocess/thread_processor.rb

@@ -69,7 +69,7 @@ module PerfectQueue
       end
 
       def stop(immediate)
-        @log.info immediate ? "Stopping worker thread immediately id=#{@processor_id}" : "Stopping worker thread gracefully id=#{@processor_id}"
+        @log.info immediate ? "Stopping thread immediately id=#{@processor_id}" : "Stopping thread gracefully id=#{@processor_id}"
         @tm.stop_task(immediate)
         @finish_flag.set!
       end
@@ -95,7 +95,7 @@ module PerfectQueue
           end
         }
       rescue
-        @log.error "Unknown error #{$!.class}: #{$!}: Exiting worker id=#{@processor_id}"
+        @log.error "Unknown error #{$!.class}: #{$!}: Exiting thread id=#{@processor_id}"
         $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
       ensure
         @tm.stop

data/lib/perfectqueue/supervisor.rb

@@ -0,0 +1,151 @@
+#
+# PerfectQueue
+#
+# Copyright (C) 2012 FURUHASHI Sadayuki
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+module PerfectQueue
+
+  class Supervisor
+    def self.run(runner, config=nil, &block)
+      new(runner, config, &block).run
+    end
+
+    def initialize(runner, config=nil, &block)
+      # initial logger
+      STDERR.sync = true
+      @log = DaemonsLogger.new(STDERR)
+
+      @runner = runner
+      block = Proc.new { config } if config
+      @config_load_proc = block
+    end
+
+    def run
+      @log.info "PerfectQueue #{VERSION}"
+
+      install_signal_handlers do
+        @engine = Engine.new(@runner, load_config)
+        begin
+          @engine.run
+        ensure
+          @engine.shutdown(true)
+        end
+      end
+
+      return nil
+    rescue
+      @log.error "#{$!.class}: #{$!}"
+      $!.backtrace.each {|x| @log.warn "\t#{x}" }
+      return nil
+    end
+
+    def stop(immediate)
+      @log.info immediate ? "Received immediate stop" : "Received graceful stop"
+      begin
+        @engine.stop(immediate) if @engine
+      rescue
+        @log.error "failed to stop: #{$!}"
+        $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
+        return false
+      end
+      return true
+    end
+
+    def restart(immediate)
+      @log.info immediate ? "Received immediate restart" : "Received graceful restart"
+      begin
+        @engine.restart(immediate, load_config)
+      rescue
+        @log.error "failed to restart: #{$!}"
+        $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
+        return false
+      end
+      return true
+    end
+
+    def replace(immediate, command=[$0]+ARGV)
+      @log.info immediate ? "Received immediate binary replace" : "Received graceful binary replace"
+      begin
+        @engine.replace(immediate, command)
+      rescue
+        @log.error "failed to replace: #{$!}"
+        $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
+        return false
+      end
+      return true
+    end
+
+    def logrotated
+      @log.info "reopen a log file"
+      @engine.logrotated
+      @log.reopen!
+      return true
+    end
+
+    private
+    def load_config
+      raw_config = @config_load_proc.call
+      config = {}
+      raw_config.each_pair {|k,v| config[k.to_sym] = v }
+
+      old_log = @log
+      log = DaemonsLogger.new(config[:log] || STDERR)
+      old_log.close if old_log
+      @log = log
+
+      config[:logger] = log
+
+      return config
+    end
+
+    def install_signal_handlers(&block)
+      sig = SignalQueue.start do |sig|
+        sig.trap :TERM do
+          stop(false)
+        end
+        sig.trap :INT do
+          stop(false)
+        end
+
+        sig.trap :QUIT do
+          stop(true)
+        end
+
+        sig.trap :USR1 do
+          restart(false)
+        end
+
+        sig.trap :HUP do
+          restart(true)
+        end
+
+        sig.trap :USR2 do
+          logrotated
+        end
+
+        trap :CHLD, "SIG_IGN"
+      end
+
+      begin
+        block.call
+      ensure
+        sig.shutdown
+      end
+    end
+  end
+
+end
+

data/lib/perfectqueue/version.rb

@@ -1,3 +1,3 @@
 module PerfectQueue
-  VERSION = "0.8.11"
+  VERSION = "0.8.12"
 end

data/lib/perfectqueue/worker.rb

@@ -24,100 +24,76 @@ module PerfectQueue
     end
 
     def initialize(runner, config=nil, &block)
-      # initial logger
-      STDERR.sync = true
-      @log = DaemonsLogger.new(STDERR)
+      block = Proc.new { config } if config
+      config = block.call
 
+      @config = config
       @runner = runner
-      block = Proc.new { config } if config
-      @config_load_proc = block
+
+      @detach_wait = config[:detach_wait] || config['detach_wait'] || 10.0
+
+      @sv = Supervisor.new(runner, &block)
+      @finish_flag = BlockingFlag.new
     end
 
     def run
-      @log.info "PerfectQueue #{VERSION}"
-
-      install_signal_handlers do
-        @engine = Engine.new(@runner, load_config)
-        begin
-          @engine.run
-        ensure
-          @engine.shutdown(true)
-        end
+      @pid = fork do
+        $0 = "perfectqueue-supervisor:#{@runner}"
+        @sv.run
+        exit! 0
       end
 
-      return nil
-    rescue
-      @log.error "#{$!.class}: #{$!}"
-      $!.backtrace.each {|x| @log.warn "\t#{x}" }
-      return nil
-    end
+      install_signal_handlers
 
-    def stop(immediate)
-      @log.info immediate ? "Received immediate stop" : "Received graceful stop"
       begin
-        @engine.stop(immediate) if @engine
-      rescue
-        @log.error "failed to stop: #{$!}"
-        $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
-        return false
+        until @finish_flag.set?
+          pid, status = Process.waitpid2(@pid, Process::WNOHANG)
+          @finish_flag.wait(1)
+        end
+
+        unless pid
+          # child process is alive but detached
+          sleep @detach_wait
+        end
+
+      rescue Errno::ECHILD
       end
-      return true
     end
 
-    def restart(immediate)
-      @log.info immediate ? "Received immediate restart" : "Received graceful restart"
-      begin
-        @engine.restart(immediate, load_config)
-      rescue
-        @log.error "failed to restart: #{$!}"
-        $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
-        return false
-      end
-      return true
+    def stop(immediate)
+      send_signal(immediate ? :TERM : :QUIT)
     end
 
-    def replace(immediate, command=[$0]+ARGV)
-      @log.info immediate ? "Received immediate binary replace" : "Received graceful binary replace"
-      begin
-        @engine.replace(immediate, command)
-      rescue
-        @log.error "failed to replace: #{$!}"
-        $!.backtrace.each {|bt| @log.warn "\t#{bt}" }
-        return false
-      end
-      return true
+    def restart(immediate)
+      send_signal(immediate ? :HUP : :USR1)
     end
 
     def logrotated
-      @log.info "reopen a log file"
-      @engine.logrotated
-      @log.reopen!
-      return true
+      send_signal(:USR2)
     end
 
-    private
-    def load_config
-      raw_config = @config_load_proc.call
-      config = {}
-      raw_config.each_pair {|k,v| config[k.to_sym] = v }
-
-      old_log = @log
-      log = DaemonsLogger.new(config[:log] || STDERR)
-      old_log.close if old_log
-      @log = log
-
-      config[:logger] = log
+    def detach
+      send_signal(:INT)
+      @finish_flag.set!
+    end
 
-      return config
+    private
+    def send_signal(sig)
+      begin
+        Process.kill(sig, @pid)
+      rescue Errno::ESRCH, Errno::EPERM
+      end
     end
 
-    def install_signal_handlers(&block)
-      sig = SignalQueue.start do |sig|
+    def install_signal_handlers
+      SignalQueue.start do |sig|
         sig.trap :TERM do
           stop(false)
         end
+
+        # override
         sig.trap :INT do
-          stop(false)
+          detach
         end
 
         sig.trap :QUIT do
@@ -132,33 +108,9 @@ module PerfectQueue
           restart(true)
         end
 
-        begin
-          sig.trap :WINCH do
-            replace(false)
-          end
-        rescue
-          # FIXME some platforms might not support SIGWINCH
-        end
-
-        begin
-          sig.trap :PWR do
-            replace(true)
-          end
-        rescue
-          # FIXME some platforms might not support SIGPWR (such as Darwin)
-        end
-
         sig.trap :USR2 do
           logrotated
         end
-
-        trap :CHLD, "SIG_IGN"
-      end
-
-      begin
-        block.call
-      ensure
-        sig.shutdown
       end
     end
   end

data/spec/{worker_spec.rb → supervisor_spec.rb}

@@ -28,18 +28,18 @@ class TestApp < PerfectQueue::Application::Dispatch
   route /reg.*/ => RegexpHandler
 end
 
-describe Worker do
+describe Supervisor do
   include QueueTest
 
   before do
-    @worker = Worker.new(TestApp, queue_config)
+    @sv = Supervisor.new(TestApp, queue_config)
     @thread = Thread.new {
-      @worker.run
+      @sv.run
     }
   end
 
   after do
-    @worker.stop(true)
+    @sv.stop(true)
     @thread.join
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perfectqueue
 version: !ruby/object:Gem::Version
-  version: 0.8.11
+  version: 0.8.12
   prerelease: 
 platform: ruby
 authors:
@@ -127,6 +127,7 @@ files:
 - lib/perfectqueue/queue.rb
 - lib/perfectqueue/runner.rb
 - lib/perfectqueue/signal_queue.rb
+- lib/perfectqueue/supervisor.rb
 - lib/perfectqueue/task.rb
 - lib/perfectqueue/task_metadata.rb
 - lib/perfectqueue/task_monitor.rb
@@ -138,7 +139,7 @@ files:
 - spec/rdb_compat_backend_spec.rb
 - spec/spec_helper.rb
 - spec/stress.rb
-- spec/worker_spec.rb
+- spec/supervisor_spec.rb
 homepage: https://github.com/treasure-data/perfectqueue
 licenses: []
 post_install_message: 
@@ -168,5 +169,5 @@ test_files:
 - spec/rdb_compat_backend_spec.rb
 - spec/spec_helper.rb
 - spec/stress.rb
-- spec/worker_spec.rb
+- spec/supervisor_spec.rb
 has_rdoc: false