pitchfork 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccd444fbdc89d5a253819e7be03e5d097c5aaf8b061980e15d4ec5326d2c54b5
-  data.tar.gz: f300bd3135e8d8d9e15f14dfe2780c75521ececeb72b8245fef0380e2ba338f5
+  metadata.gz: b3a7c87f91b13b474f5c204a251c380cd091190f3ecfca8ac3107d697e883f12
+  data.tar.gz: '00116558f20d20e4aad0cda6a1866fc7104e3712df27b1668470c52346812258'
 SHA512:
-  metadata.gz: b054a33d46f4b60c14e44fbac330bc4318a1b52259e89f2e8a1c16a58d8467f02eef981dbe018906a0c7a027c98db75a8efd483619d7ea5e2ece234b30b3846f
-  data.tar.gz: b12a622275fe638d49be5d9457d11309421119f9628044dec9898231f83425cab6aa6434b9f42372c5f8954b261f7e979e300a41fa75c39172fb8e1832cb0805
+  metadata.gz: 2b51ac98fdc2fc2d83a72c6a55c5e26e42996b43bb6e33815e8958c6f5c729f11b17676b9b8bdb098d75b53ebac5bc98114f2bfa864550b3111162824ae6597f
+  data.tar.gz: 5bbf64cf105b20930fd6627001abfb610c9f87ad8510b35a7ab1fcb5c5ccd5437eec011eb6253aefdf87f7d7bc353ac2abbaeb30ac6afad91ddd48fbe81f475c

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Unreleased
 
+# 0.6.0
+
+- Expose `Pitchfork::Info.workers_count` and `.live_workers_count` to be consumed by application health checks.
+- Implement `before_worker_exit` callback.
+- Make each mold and worker a process group leader.
+- Get rid of `Pitchfork::PrereadInput`.
+- Add `Pitchfork.shutting_down?` to allow health check endpoints to fail sooner on graceful shutdowns.
+- Treat `TERM` as graceful shutdown rather than quick shutdown.
+- Implement `after_worker_hard_timeout` callback.
+
+# 0.5.0
+
 - Added a soft timeout in addition to the historical Unicorn hard timeout.
   On soft timeout, the `after_worker_timeout` callback is invoked.
 - Implement `after_request_complete` callback.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pitchfork (0.5.0)
+    pitchfork (0.6.0)
       rack (>= 2.0)
       raindrops (~> 0.7)
 

data/benchmark/cow_benchmark.rb

@@ -13,5 +13,5 @@ sleep 3
 puts "Memory Usage:"
 puts Net::HTTP.get(URI(app_url))
 
-Process.kill("TERM", pid)
+Process.kill("INT", pid)
 Process.wait

data/docs/CONFIGURATION.md

@@ -336,6 +336,21 @@ really have to, make sure to configure the `cleanup` timeout so that the
 callback has time to complete before the "hard" timeout triggers.
 By default the cleanup timeout is 2 seconds.
 
+### `after_worker_hard_timeout`
+
+Called in the master process when a worker hard timeout is elapsed:
+
+```ruby
+after_worker_timeout do |server, worker|
+  $stderr.puts "Worker hard timeout, pid=#{worker.pid}"
+end
+```
+
+Once the callback complete, the worker will be signaled with `SIGKILL`.
+
+This callback being called in an indication that something is preventing the
+soft timeout from working.
+
 ### `after_worker_exit`
 
 Called in the master process after a worker exits.

data/docs/SIGNALS.md

@@ -6,9 +6,9 @@ processes are documented here as well.
 
 ### Master Process
 
-* `INT/TERM` - quick shutdown, kills all workers immediately
+* `INT` - quick shutdown, kills all workers immediately
 
-* `QUIT` - graceful shutdown, waits for workers to finish their
+* `QUIT/TERM` - graceful shutdown, waits for workers to finish their
   current request before finishing.
 
 * `USR2` - trigger a manual refork. A worker is promoted as
@@ -29,10 +29,10 @@ Sending signals directly to the worker processes should not normally be
 needed.  If the master process is running, any exited worker will be
 automatically respawned.
 
-* `INT/TERM` - Quick shutdown, immediately exit.
+* `INT` - Quick shutdown, immediately exit.
   The master process will respawn a worker to replace this one.
   Immediate shutdown is still triggered using kill(2) and not the
   internal pipe as of unicorn 4.8
 
-* `QUIT` - Gracefully exit after finishing the current request.
+* `QUIT/TERM` - Gracefully exit after finishing the current request.
   The master process will respawn a worker to replace this one.

data/lib/pitchfork/configurator.rb

@@ -26,11 +26,15 @@ module Pitchfork
     }
 
     # Default settings for Pitchfork
+    default_logger = Logger.new($stderr)
+    default_logger.formatter = Logger::Formatter.new
+    default_logger.progname = "[Pitchfork]"
+
     DEFAULTS = {
       :soft_timeout => 20,
       :cleanup_timeout => 2,
       :timeout => 22,
-      :logger => Logger.new($stderr),
+      :logger => default_logger,
       :worker_processes => 1,
       :after_worker_fork => lambda { |server, worker|
         server.logger.info("worker=#{worker.nr} gen=#{worker.generation} pid=#{$$} spawned")
@@ -38,6 +42,7 @@ module Pitchfork
       :after_mold_fork => lambda { |server, worker|
         server.logger.info("mold gen=#{worker.generation} pid=#{$$} spawned")
       },
+      :before_worker_exit => nil,
       :after_worker_exit => lambda { |server, worker, status|
         m = if worker.nil?
           "repead unknown process (#{status.inspect})"
@@ -56,6 +61,7 @@ module Pitchfork
         server.logger.info("worker=#{worker.nr} gen=#{worker.generation} ready")
       },
       :after_worker_timeout => nil,
+      :after_worker_hard_timeout => nil,
       :after_request_complete => nil,
       :early_hints => false,
       :refork_condition => nil,
@@ -139,6 +145,14 @@ module Pitchfork
       set_hook(:after_worker_timeout, block_given? ? block : args[0], 3)
     end
 
+    def after_worker_hard_timeout(*args, &block)
+      set_hook(:after_worker_hard_timeout, block_given? ? block : args[0], 2)
+    end
+
+    def before_worker_exit(*args, &block)
+      set_hook(:before_worker_exit, block_given? ? block : args[0], 2)
+    end
+
     def after_worker_exit(*args, &block)
       set_hook(:after_worker_exit, block_given? ? block : args[0], 3)
     end

data/lib/pitchfork/http_server.rb

@@ -2,6 +2,8 @@
 require 'pitchfork/pitchfork_http'
 require 'pitchfork/flock'
 require 'pitchfork/soft_timeout'
+require 'pitchfork/shared_memory'
+require 'pitchfork/info'
 
 module Pitchfork
   # This is the process manager of Pitchfork. This manages worker
@@ -44,14 +46,15 @@ module Pitchfork
       end
 
       def call(original_thread) # :nodoc:
-        @server.logger.error("worker=#{@worker.nr} pid=#{@worker.pid} timed out, exiting")
-        if @callback
-          @callback.call(@server, @worker, Info.new(original_thread, @rack_env))
+        begin
+          @server.logger.error("worker=#{@worker.nr} pid=#{@worker.pid} timed out, exiting")
+          if @callback
+            @callback.call(@server, @worker, Info.new(original_thread, @rack_env))
+          end
+        rescue => error
+          Pitchfork.log_error(@server.logger, "after_worker_timeout error", error)
         end
-      rescue => error
-        Pitchfork.log_error(@server.logger, "after_worker_timeout error", error)
-      ensure
-        exit
+        @server.worker_exit(@worker)
       end
 
       def finished # :nodoc:
@@ -76,8 +79,8 @@ module Pitchfork
                   :listener_opts, :children,
                   :orig_app, :config, :ready_pipe,
                   :default_middleware, :early_hints
-    attr_writer   :after_worker_exit, :after_worker_ready, :after_request_complete, :refork_condition,
-                  :after_worker_timeout
+    attr_writer   :after_worker_exit, :before_worker_exit, :after_worker_ready, :after_request_complete,
+                  :refork_condition, :after_worker_timeout, :after_worker_hard_timeout
 
     attr_reader :logger
     include Pitchfork::SocketHelper
@@ -163,7 +166,9 @@ module Pitchfork
       # list of signals we care about and trap in master.
       @queue_sigs = [
         :QUIT, :INT, :TERM, :USR2, :TTIN, :TTOU ]
-      Worker.preallocate_drops(worker_processes)
+
+      Info.workers_count = worker_processes
+      SharedMemory.preallocate_drops(worker_processes)
     end
 
     # Runs the thing.  Returns self so you can run join on it
@@ -312,7 +317,7 @@ module Pitchfork
       if REFORKING_AVAILABLE && @respawn && @children.molds.empty?
         logger.info("No mold alive, shutting down")
         @exit_status = 1
-        @sig_queue << :QUIT
+        @sig_queue << :TERM
         @respawn = false
       end
 
@@ -332,10 +337,12 @@ module Pitchfork
         end
 
         master_sleep(sleep_time) if sleep
-      when :QUIT # graceful shutdown
-        logger.info "QUIT received, starting graceful shutdown"
+      when :QUIT, :TERM # graceful shutdown
+        SharedMemory.shutting_down!
+        logger.info "#{message} received, starting graceful shutdown"
         return StopIteration
-      when :TERM, :INT # immediate shutdown
+      when :INT # immediate shutdown
+        SharedMemory.shutting_down!
         logger.info "#{message} received, starting immediate shutdown"
         stop(false)
         return StopIteration
@@ -359,7 +366,7 @@ module Pitchfork
         logger.info("mold pid=#{new_mold.pid} gen=#{new_mold.generation} ready")
         old_molds.each do |old_mold|
           logger.info("Terminating old mold pid=#{old_mold.pid} gen=#{old_mold.generation}")
-          old_mold.soft_kill(:QUIT)
+          old_mold.soft_kill(:TERM)
         end
       else
         logger.error("Unexpected message in sig_queue #{message.inspect}")
@@ -370,14 +377,15 @@ module Pitchfork
     # Terminates all workers, but does not exit master process
     def stop(graceful = true)
       @respawn = false
+      SharedMemory.shutting_down!
       wait_for_pending_workers
       self.listeners = []
       limit = Pitchfork.time_now + timeout
       until @children.workers.empty? || Pitchfork.time_now > limit
         if graceful
-          soft_kill_each_child(:QUIT)
+          soft_kill_each_child(:TERM)
         else
-          kill_each_child(:TERM)
+          kill_each_child(:INT)
         end
         if monitor_loop(false) == StopIteration
           return StopIteration
@@ -387,6 +395,17 @@ module Pitchfork
       @promotion_lock.unlink
     end
 
+    def worker_exit(worker)
+      if @before_worker_exit
+        begin
+          @before_worker_exit.call(self, worker)
+        rescue => error
+          Pitchfork.log_error(logger, "before_worker_exit error", error)
+        end
+      end
+      Process.exit
+    end
+
     def rewindable_input
       Pitchfork::HttpParser.input_class.method_defined?(:rewind)
     end
@@ -473,10 +492,19 @@ module Pitchfork
         else # worker is out of time
           next_sleep = 0
           if worker.mold?
-            logger.error "mold pid=#{worker.pid} deadline=#{deadline} timed out, killing"
+            logger.error "mold pid=#{worker.pid} timed out, killing"
           else
-            logger.error "worker=#{worker.nr} pid=#{worker.pid} deadline=#{deadline} timed out, killing"
+            logger.error "worker=#{worker.nr} pid=#{worker.pid} timed out, killing"
+          end
+
+          if @after_worker_hard_timeout
+            begin
+              @after_worker_hard_timeout.call(self, worker)
+            rescue => error
+              Pitchfork.log_error(@logger, "after_worker_hard_timeout callback", error)
+            end
           end
+
           kill_worker(:KILL, worker.pid) # take no prisoners for hard timeout violations
         end
       end
@@ -519,6 +547,7 @@ module Pitchfork
 
         after_fork_internal
         worker_loop(worker)
+        worker_exit(worker)
       end
 
       worker
@@ -577,7 +606,7 @@ module Pitchfork
     def maintain_worker_count
       (off = @children.workers_count - worker_processes) == 0 and return
       off < 0 and return spawn_missing_workers
-      @children.each_worker { |w| w.nr >= worker_processes and w.soft_kill(:QUIT) }
+      @children.each_worker { |w| w.nr >= worker_processes and w.soft_kill(:TERM) }
     end
 
     def restart_outdated_workers
@@ -594,7 +623,7 @@ module Pitchfork
         outdated_workers = @children.workers.select { |w| !w.exiting? && w.generation < @children.mold.generation }
         outdated_workers.each do |worker|
           logger.info("worker=#{worker.nr} pid=#{worker.pid} gen=#{worker.generation} restarting")
-          worker.soft_kill(:QUIT)
+          worker.soft_kill(:TERM)
         end
       end
     end
@@ -704,7 +733,7 @@ module Pitchfork
     def init_worker_process(worker)
       worker.reset
       worker.register_to_master(@control_socket[1])
-      # we'll re-trap :QUIT later for graceful shutdown iff we accept clients
+      # we'll re-trap :QUIT and :TERM later for graceful shutdown iff we accept clients
       exit_sigs = [ :QUIT, :TERM, :INT ]
       exit_sigs.each { |sig| trap(sig) { exit!(0) } }
       exit!(0) if (@sig_queue & exit_sigs)[0]
@@ -722,6 +751,7 @@ module Pitchfork
       readers = LISTENERS.dup
       readers << worker
       trap(:QUIT) { nuke_listeners!(readers) }
+      trap(:TERM) { nuke_listeners!(readers) }
       readers
     end
 
@@ -730,6 +760,7 @@ module Pitchfork
       after_mold_fork.call(self, mold)
       readers = [mold]
       trap(:QUIT) { nuke_listeners!(readers) }
+      trap(:TERM) { nuke_listeners!(readers) }
       readers
     end
 

data/lib/pitchfork/info.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'pitchfork/shared_memory'
+
+module Pitchfork
+  module Info
+    @workers_count = 0
+
+    class << self
+      attr_accessor :workers_count
+
+      def live_workers_count
+        now = Pitchfork.time_now(true)
+        (0...workers_count).count do |nr|
+          SharedMemory.worker_deadline(nr).value > now
+        end
+      end
+
+      # Returns true if the server is shutting down.
+      # This can be useful to implement health check endpoints, so they
+      # can fail immediately after TERM/QUIT/INT was received by the master
+      # process.
+      # Otherwise they may succeed while Pitchfork is draining requests causing
+      # more requests to be sent.
+      def shutting_down?
+        SharedMemory.shutting_down?
+      end
+    end
+  end
+end

data/lib/pitchfork/shared_memory.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'raindrops'
+
+module Pitchfork
+  module SharedMemory
+    extend self
+
+    PER_DROP = Raindrops::PAGE_SIZE / Raindrops::SIZE
+    CURRENT_GENERATION_OFFSET = 0
+    SHUTDOWN_OFFSET = 1
+    MOLD_TICK_OFFSET = 2
+    WORKER_TICK_OFFSET = 3
+
+    DROPS = [Raindrops.new(PER_DROP)]
+
+    def current_generation
+      DROPS[0][CURRENT_GENERATION_OFFSET]
+    end
+
+    def current_generation=(value)
+      DROPS[0][CURRENT_GENERATION_OFFSET] = value
+    end
+
+    def shutting_down!
+      DROPS[0][SHUTDOWN_OFFSET] = 1
+    end
+
+    def shutting_down?
+      DROPS[0][SHUTDOWN_OFFSET] > 0
+    end
+
+    class Field
+      def initialize(offset)
+        @drop = DROPS.fetch(offset / PER_DROP)
+        @offset = offset % PER_DROP
+      end
+
+      def value
+        @drop[@offset]
+      end
+
+      def value=(value)
+        @drop[@offset] = value
+      end
+    end
+
+    def mold_deadline
+      self[MOLD_TICK_OFFSET]
+    end
+
+    def worker_deadline(worker_nr)
+      self[WORKER_TICK_OFFSET + worker_nr]
+    end
+
+    def [](offset)
+      Field.new(offset)
+    end
+
+    # Since workers are created from another process, we have to
+    # pre-allocate the drops so they are shared between everyone.
+    #
+    # However this doesn't account for TTIN signals that increase the
+    # number of workers, but we should probably remove that feature too.
+    def preallocate_drops(workers_count)
+      0.upto(((WORKER_TICK_OFFSET + workers_count) / PER_DROP.to_f).ceil) do |i|
+        DROPS[i] ||= Raindrops.new(PER_DROP)
+      end
+    end
+  end
+end

data/lib/pitchfork/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pitchfork
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
   module Const
     UNICORN_VERSION = '6.1.0'
   end

data/lib/pitchfork/worker.rb

@@ -1,5 +1,5 @@
 # -*- encoding: binary -*-
-require "raindrops"
+require 'pitchfork/shared_memory'
 
 module Pitchfork
   # This class and its members can be considered a stable interface
@@ -24,7 +24,8 @@ module Pitchfork
       @exiting = false
       @requests_count = 0
       if nr
-        build_raindrops(nr)
+        @deadline_drop = SharedMemory.worker_deadline(nr)
+        self.deadline = 0
       else
         promoted!
       end
@@ -47,7 +48,7 @@ module Pitchfork
     end
 
     def outdated?
-      CURRENT_GENERATION_DROP[0] > @generation
+      SharedMemory.current_generation > @generation
     end
 
     def update(message)
@@ -73,7 +74,7 @@ module Pitchfork
     def finish_promotion(control_socket)
       message = Message::MoldReady.new(@nr, @pid, generation)
       control_socket.sendmsg(message)
-      CURRENT_GENERATION_DROP[0] = @generation
+      SharedMemory.current_generation = @generation
     end
 
     def promote(generation)
@@ -92,8 +93,8 @@ module Pitchfork
     def promoted!
       @mold = true
       @nr = nil
-      @drop_offset = 0
-      @deadline_drop = MOLD_DROP
+      @deadline_drop = SharedMemory.mold_deadline
+      self.deadline = 0
       self
     end
 
@@ -173,20 +174,12 @@ module Pitchfork
 
     # called in the worker process
     def deadline=(value) # :nodoc:
-      if mold?
-        MOLD_DROP[0] = value
-      else
-        @deadline_drop[@drop_offset] = value
-      end
+      @deadline_drop.value = value
     end
 
     # called in the master process
     def deadline # :nodoc:
-      if mold?
-        MOLD_DROP[0]
-      else
-        @deadline_drop[@drop_offset]
-      end
+      @deadline_drop.value
     end
 
     def reset
@@ -199,6 +192,7 @@ module Pitchfork
 
     # called in both the master (reaping worker) and worker (SIGQUIT handler)
     def close # :nodoc:
+      self.deadline = 0
       @master.close if @master
       @to_io.close if @to_io
     end
@@ -225,35 +219,10 @@ module Pitchfork
         else
           success = true
         end
-      rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED
+      rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED, Errno::ENOTCONN
         # worker will be reaped soon
       end
       success
     end
-
-    MOLD_DROP = Raindrops.new(1)
-    CURRENT_GENERATION_DROP = Raindrops.new(1)
-    PER_DROP = Raindrops::PAGE_SIZE / Raindrops::SIZE
-    TICK_DROPS = []
-
-    class << self
-      # Since workers are created from another process, we have to
-      # pre-allocate the drops so they are shared between everyone.
-      #
-      # However this doesn't account for TTIN signals that increase the
-      # number of workers, but we should probably remove that feature too.
-      def preallocate_drops(workers_count)
-        0.upto(workers_count / PER_DROP) do |i|
-          TICK_DROPS[i] = Raindrops.new(PER_DROP)
-        end
-      end
-    end
-
-    def build_raindrops(drop_nr)
-      drop_index = drop_nr / PER_DROP
-      @drop_offset = drop_nr % PER_DROP
-      @deadline_drop = TICK_DROPS[drop_index] ||= Raindrops.new(PER_DROP)
-      @deadline_drop[@drop_offset] = 0
-    end
   end
 end

data/lib/pitchfork.rb

@@ -26,9 +26,10 @@ module Pitchfork
   # application dispatch.  This is always raised with an empty backtrace
   # since there is nothing in the application stack that is responsible
   # for client shutdowns/disconnects.  This exception is visible to Rack
-  # applications unless PrereadInput middleware is loaded.  This
-  # is a subclass of the standard EOFError class and applications should
-  # not rescue it explicitly, but rescue EOFError instead.
+  # applications.  This is a subclass of the standard EOFError class and
+  # applications should not rescue it explicitly, but rescue EOFError instead.
+  # Such an error is likely an indication that the reverse proxy in front
+  # of Pitchfork isn't properly buffering requests.
   ClientShutdown = Class.new(EOFError)
 
   BootFailure = Class.new(StandardError)
@@ -120,8 +121,11 @@ module Pitchfork
     end
   end
 
-  def self.clean_fork(&block)
+  def self.clean_fork(setpgid: true, &block)
     if pid = Process.fork
+      if setpgid
+        Process.setpgid(pid, pid) # Make into a group leader
+      end
       return pid
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pitchfork
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-21 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raindrops
@@ -101,12 +101,13 @@ files:
 - lib/pitchfork/http_parser.rb
 - lib/pitchfork/http_response.rb
 - lib/pitchfork/http_server.rb
+- lib/pitchfork/info.rb
 - lib/pitchfork/launcher.rb
 - lib/pitchfork/mem_info.rb
 - lib/pitchfork/message.rb
-- lib/pitchfork/preread_input.rb
 - lib/pitchfork/refork_condition.rb
 - lib/pitchfork/select_waiter.rb
+- lib/pitchfork/shared_memory.rb
 - lib/pitchfork/socket_helper.rb
 - lib/pitchfork/soft_timeout.rb
 - lib/pitchfork/stream_input.rb

data/lib/pitchfork/preread_input.rb

@@ -1,33 +0,0 @@
-# -*- encoding: binary -*-
-
-module Pitchfork
-  # This middleware is used to ensure input is buffered to memory
-  # or disk (depending on size) before the application is dispatched
-  # by entirely consuming it (from TeeInput) beforehand.
-  #
-  # Usage (in config.ru):
-  #
-  #     require 'pitchfork/preread_input'
-  #     if defined?(Pitchfork)
-  #       use Pitchfork::PrereadInput
-  #     end
-  #     run YourApp.new
-  class PrereadInput
-
-    # :stopdoc:
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      buf = ""
-      input = env["rack.input"]
-      if input.respond_to?(:rewind)
-        true while input.read(16384, buf)
-        input.rewind
-      end
-      @app.call(env)
-    end
-    # :startdoc:
-  end
-end