pitchfork 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3a7c87f91b13b474f5c204a251c380cd091190f3ecfca8ac3107d697e883f12
-  data.tar.gz: '00116558f20d20e4aad0cda6a1866fc7104e3712df27b1668470c52346812258'
+  metadata.gz: 05372d35dd4784eb22e204b614b1c7add13fd0e298495543c5395e2f03b42073
+  data.tar.gz: 14f241efeb95774f6de6e9fc8926815eb7f10c25965a09a0700f77dae75dbb92
 SHA512:
-  metadata.gz: 2b51ac98fdc2fc2d83a72c6a55c5e26e42996b43bb6e33815e8958c6f5c729f11b17676b9b8bdb098d75b53ebac5bc98114f2bfa864550b3111162824ae6597f
-  data.tar.gz: 5bbf64cf105b20930fd6627001abfb610c9f87ad8510b35a7ab1fcb5c5ccd5437eec011eb6253aefdf87f7d7bc353ac2abbaeb30ac6afad91ddd48fbe81f475c
+  metadata.gz: f26ebeeb3bc9f7533d25cc41b29a317fb8a80ce108a1859657adfa80b9eb8f88812cfe85dfecf0fbd8093b6e91f45c6ce51ab7b9a15864d96b9d0f5f77835786
+  data.tar.gz: 8d1f09bb24226f2c89b2db2d549c28508a9f2ea716a1612fcc3367d27445657b9d9da281e623af696dc803acd649847a724366306caf672dbc523a3e7495579b

data/.github/workflows/ci.yml

@@ -10,7 +10,6 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        redis: ["6.2"]
         ruby: ["3.2", "3.1", "3.0", "2.7", "2.6"]
     runs-on: ubuntu-latest
     steps:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Unreleased
 
+# 0.7.0
+
+- Set nicer `proctile` to better see the state of the process tree at a glance.
+- Pass the last request env to `after_request_complete` callback.
+- Fix the slow rollout of workers on a new generation.
+- Expose `Pitchfork::Info.fork_safe?` and `Pitchfork::Info.no_longer_fork_safe!`.
+
 # 0.6.0
 
 - Expose `Pitchfork::Info.workers_count` and `.live_workers_count` to be consumed by application health checks.

data/Dockerfile

@@ -1,4 +1,4 @@
 FROM ruby:3.2
-RUN apt-get update -y && apt-get install -y ragel socat netcat smem apache2-utils
+RUN apt-get update -y && apt-get install -y ragel socat netcat-traditional smem apache2-utils
 WORKDIR /app
 CMD [ "bash" ]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pitchfork (0.6.0)
+    pitchfork (0.7.0)
       rack (>= 2.0)
       raindrops (~> 0.7)
 
@@ -9,8 +9,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     minitest (5.15.0)
-    nio4r (2.5.8)
-    puma (6.1.1)
+    nio4r (2.5.9)
+    puma (6.3.0)
       nio4r (~> 2.0)
     rack (3.0.8)
     raindrops (0.20.1)

data/docs/CONFIGURATION.md

@@ -371,7 +371,7 @@ Called in the worker processes after a request has completed.
 Can be used for out of band work, or to exit unhealthy workers.
 
 ```ruby
-after_request_complete do |server, worker|
+after_request_complete do |server, worker, env|
   if something_wrong?
     exit
   end

data/docs/FORK_SAFETY.md

@@ -76,10 +76,12 @@ impact of discovering such bug.
 
 ## Known Incompatible Gems
 
-- [The `grpc` isn't fork safe](https://github.com/grpc/grpc/issues/8798) and doesn't provide any before or after fork callback to re-establish connection.
-  It can only be used in forking environment if the client is never used in the parent before fork.
-  If you application uses `grpc`, you shouldn't enable reforking.
-  But frankly, that gem is such a tire fire, you shouldn't use it regardless.
-  If you really have to consume a gRPC API, you can consider `grpc_kit` as a replacement.
+- The `grpc` isn't fork safe by default, but starting from version `1.57.0`, it does provide an experimental
+  fork safe option that requires setting an environment variable before loading the library, and calling
+  `GRPC.prefork`, `GRPC.postfork_parent` and `GRPC.postfork_child` around fork calls.
+  (https://github.com/grpc/grpc/pull/33430)
 
-No other gem is known to be incompatible, but if you find one please open an issue to add it to the list.
+- The `ruby-vips` gem binds the `libvips` image processing library that isn't fork safe.
+  (https://github.com/libvips/libvips/discussions/3577)
+
+No other gem is known to be incompatible for now, but if you find one please open an issue to add it to the list.

data/lib/pitchfork/configurator.rb

@@ -158,7 +158,7 @@ module Pitchfork
     end
 
     def after_request_complete(*args, &block)
-      set_hook(:after_request_complete, block_given? ? block : args[0])
+      set_hook(:after_request_complete, block_given? ? block : args[0], 3)
     end
 
     def timeout(seconds, cleanup: 2)

data/lib/pitchfork/flock.rb

@@ -19,6 +19,10 @@ module Pitchfork
       nil
     end
 
+    def to_io
+      @file
+    end
+
     def unlink
       File.unlink(@file.path)
     rescue Errno::ENOENT

data/lib/pitchfork/http_server.rb

@@ -91,7 +91,7 @@ module Pitchfork
     # in new projects
     LISTENERS = []
 
-    NOOP = '.'
+    NOOP = '.'.freeze
 
     # :startdoc:
     # This Hash is considered a stable interface and changing its contents
@@ -129,6 +129,7 @@ module Pitchfork
       @respawn = false
       @last_check = Pitchfork.time_now
       @promotion_lock = Flock.new("pitchfork-promotion")
+      Info.keep_io(@promotion_lock)
 
       options = options.dup
       @ready_pipe = options.delete(:ready_pipe)
@@ -137,6 +138,8 @@ module Pitchfork
       self.config = Pitchfork::Configurator.new(options)
       self.listener_opts = {}
 
+      proc_name role: 'monitor', status: START_CTX[:argv].join(' ')
+
       # We use @control_socket differently in the master and worker processes:
       #
       # * The master process never closes or reinitializes this once
@@ -180,6 +183,7 @@ module Pitchfork
       # It's also used by newly spawned children to send their soft_signal pipe
       # to the master when they are spawned.
       @control_socket.replace(Pitchfork.socketpair)
+      Info.keep_ios(@control_socket)
       @master_pid = $$
 
       # setup signal handlers before writing pid file in case people get
@@ -264,6 +268,7 @@ module Pitchfork
           io = server_cast(io)
         end
         logger.info "listening on addr=#{sock_name(io)} fd=#{io.fileno}"
+        Info.keep_io(io)
         LISTENERS << io
         io
       rescue Errno::EADDRINUSE => err
@@ -287,7 +292,8 @@ module Pitchfork
     def join
       @respawn = true
 
-      proc_name 'master'
+      proc_name role: 'monitor', status: START_CTX[:argv].join(' ')
+
       logger.info "master process ready" # test_exec.rb relies on this message
       if @ready_pipe
         begin
@@ -347,7 +353,11 @@ module Pitchfork
         stop(false)
         return StopIteration
       when :USR2 # trigger a promotion
-        trigger_refork
+        if @respawn
+          trigger_refork
+        else
+          logger.error "Can't trigger a refork as the server is shutting down"
+        end
       when :TTIN
         @respawn = true
         self.worker_processes += 1
@@ -376,6 +386,7 @@ module Pitchfork
 
     # Terminates all workers, but does not exit master process
     def stop(graceful = true)
+      proc_name role: 'monitor', status: 'shutting down'
       @respawn = false
       SharedMemory.shutting_down!
       wait_for_pending_workers
@@ -396,6 +407,8 @@ module Pitchfork
     end
 
     def worker_exit(worker)
+      proc_name status: "exiting"
+
       if @before_worker_exit
         begin
           @before_worker_exit.call(self, worker)
@@ -514,7 +527,7 @@ module Pitchfork
 
     def trigger_refork
       unless REFORKING_AVAILABLE
-        logger.error("This system doesn't support PR_SET_CHILD_SUBREAPER, can't promote a worker")
+        logger.error("This system doesn't support PR_SET_CHILD_SUBREAPER, can't refork")
       end
 
       unless @children.pending_promotion?
@@ -523,7 +536,6 @@ module Pitchfork
         else
           logger.error("No children at all???")
         end
-      else
       end
     end
 
@@ -622,8 +634,13 @@ module Pitchfork
       if workers_to_restart > 0
         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(:TERM)
+          if worker.soft_kill(:TERM)
+            logger.info("Sent SIGTERM to worker=#{worker.nr} pid=#{worker.pid} gen=#{worker.generation}")
+            workers_to_restart -= 1
+          else
+            logger.info("Failed to send SIGTERM to worker=#{worker.nr} pid=#{worker.pid} gen=#{worker.generation}")
+          end
+          break if workers_to_restart <= 0
         end
       end
     end
@@ -678,6 +695,9 @@ module Pitchfork
       env = nil
       @request = Pitchfork::HttpParser.new
       env = @request.read(client)
+
+      proc_name status: "processing: #{env["PATH_INFO"]}"
+
       timeout_handler.rack_env = env
       env["pitchfork.timeout"] = timeout_handler
 
@@ -692,12 +712,12 @@ module Pitchfork
       status, headers, body = @app.call(env)
 
       begin
-        return if @request.hijacked?
+        return env if @request.hijacked?
 
         if 100 == status.to_i
           e100_response_write(client, env)
           status, headers, body = @app.call(env)
-          return if @request.hijacked?
+          return env if @request.hijacked?
         end
         @request.headers? or headers = nil
         http_response_write(client, status, headers, body, @request)
@@ -712,11 +732,14 @@ module Pitchfork
         end
         client.close # flush and uncork socket immediately, no keepalive
       end
+      env
     rescue => e
       handle_error(client, e)
+      env
     ensure
       env["rack.after_reply"].each(&:call) if env
       timeout_handler.finished
+      env
     end
 
     def nuke_listeners!(readers)
@@ -731,6 +754,7 @@ module Pitchfork
     # traps for USR2, and HUP may be set in the after_fork Proc
     # by the user.
     def init_worker_process(worker)
+      proc_name role: "(gen:#{worker.generation}) worker[#{worker.nr}]", status: "init"
       worker.reset
       worker.register_to_master(@control_socket[1])
       # we'll re-trap :QUIT and :TERM later for graceful shutdown iff we accept clients
@@ -740,7 +764,6 @@ module Pitchfork
       (@queue_sigs - exit_sigs).each { |sig| trap(sig, nil) }
       trap(:CHLD, 'DEFAULT')
       @sig_queue.clear
-      proc_name "(gen:#{worker.generation}) worker[#{worker.nr}]"
       @children = nil
 
       after_worker_fork.call(self, worker) # can drop perms and create listeners
@@ -756,7 +779,7 @@ module Pitchfork
     end
 
     def init_mold_process(mold)
-      proc_name "(gen: #{mold.generation}) mold"
+      proc_name role: "(gen:#{mold.generation}) mold", status: "ready"
       after_mold_fork.call(self, mold)
       readers = [mold]
       trap(:QUIT) { nuke_listeners!(readers) }
@@ -785,6 +808,8 @@ module Pitchfork
       ready = readers.dup
       @after_worker_ready.call(self, worker)
 
+      proc_name status: "ready"
+
       while readers[0]
         begin
           worker.update_deadline(@timeout)
@@ -796,12 +821,16 @@ module Pitchfork
             if client
               case client
               when Message::PromoteWorker
-                spawn_mold(worker.generation)
+                if Info.fork_safe?
+                  spawn_mold(worker.generation)
+                else
+                  logger.error("worker=#{worker.nr} gen=#{worker.generation} is no longer fork safe, can't refork")
+                end
               when Message
                 worker.update(client)
               else
-                process_client(client, prepare_timeout(worker))
-                @after_request_complete&.call(self, worker)
+                request_env = process_client(client, prepare_timeout(worker))
+                @after_request_complete&.call(self, worker, request_env)
                 worker.increment_requests_count
               end
               worker.update_deadline(@timeout)
@@ -811,7 +840,7 @@ module Pitchfork
           # timeout so we can update .deadline and keep parent from SIGKILL-ing us
           worker.update_deadline(@timeout)
 
-          if @refork_condition && !worker.outdated?
+          if @refork_condition && Info.fork_safe? && !worker.outdated?
             if @refork_condition.met?(worker, logger)
               if spawn_mold(worker.generation)
                 logger.info("Refork condition met, promoting ourselves")
@@ -820,6 +849,7 @@ module Pitchfork
             end
           end
 
+          proc_name status: "waiting"
           waiter.get_readers(ready, readers, @timeout * 500) # to milliseconds, but halved
         rescue => e
           Pitchfork.log_error(@logger, "listen loop error", e) if readers[0]
@@ -911,6 +941,8 @@ module Pitchfork
     def build_app!
       return unless app.respond_to?(:arity)
 
+      proc_name status: "booting"
+
       self.app = case app.arity
       when 0
         app.call
@@ -921,9 +953,11 @@ module Pitchfork
       end
     end
 
-    def proc_name(tag)
-      $0 = ([ File.basename(START_CTX[0]), tag
-            ]).concat(START_CTX[:argv]).join(' ')
+    def proc_name(role: nil, status: nil)
+      @proctitle_role = role if role
+      @proctitle_status = status if status
+
+      Process.setproctitle("#{File.basename(START_CTX[0])} #{@proctitle_role} - #{@proctitle_status}")
     end
 
     def bind_listeners!

data/lib/pitchfork/info.rb

@@ -5,10 +5,58 @@ require 'pitchfork/shared_memory'
 module Pitchfork
   module Info
     @workers_count = 0
+    @fork_safe = true
+    @kept_ios = ObjectSpace::WeakMap.new
 
     class << self
       attr_accessor :workers_count
 
+      def keep_io(io)
+        raise ArgumentError, "#{io.inspect} doesn't respond to :to_io" unless io.respond_to?(:to_io)
+        @kept_ios[io] = io
+        io
+      end
+
+      def keep_ios(ios)
+        ios.each { |io| keep_io(io) }
+      end
+
+      def close_all_ios!
+        ignored_ios = [$stdin, $stdout, $stderr]
+
+        @kept_ios.each_value do |io_like|
+          ignored_ios << (io_like.is_a?(IO) ? io_like : io_like.to_io)
+        end
+
+        ObjectSpace.each_object(IO) do |io|
+          closed = begin
+            io.closed?
+          rescue IOError
+            true
+          end
+
+          if !closed && io.autoclose? && !ignored_ios.include?(io)
+            if io.is_a?(TCPSocket)
+              # If we inherited a TCP Socket, calling #close directly could send FIN or RST.
+              # So we first reopen /dev/null to avoid that.
+              io.reopen(File::NULL)
+            end
+            begin
+              io.close
+            rescue Errno::EBADF
+            end
+          end
+        end
+      end
+
+      def fork_safe?
+        @fork_safe
+      end
+
+      def no_longer_fork_safe!
+        @fork_safe = false
+      end
+
       def live_workers_count
         now = Pitchfork.time_now(true)
         (0...workers_count).count do |nr|

data/lib/pitchfork/version.rb

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

data/lib/pitchfork/worker.rb

@@ -198,7 +198,7 @@ module Pitchfork
     end
 
     def create_socketpair!
-      @to_io, @master = Pitchfork.socketpair
+      @to_io, @master = Info.keep_ios(Pitchfork.socketpair)
     end
 
     def after_fork_in_child
@@ -208,11 +208,14 @@ module Pitchfork
     private
 
     def pipe=(socket)
+      raise ArgumentError, "pipe can't be nil" unless socket
+      Info.keep_io(socket)
       @master = MessageSocket.new(socket)
     end
 
     def send_message_nonblock(message)
       success = false
+      return false unless @master
       begin
         case @master.sendmsg_nonblock(message, exception: false)
         when :wait_writable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pitchfork
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raindrops