puma 4.3.12 → 6.0.0

data/lib/puma/single.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'puma/runner'
-require 'puma/detect'
-require 'puma/plugin'
+require_relative 'runner'
+require_relative 'detect'
+require_relative 'plugin'
 
 module Puma
   # This class is instantiated by the `Puma::Launcher` and used
@@ -13,90 +13,35 @@ module Puma
   # gets created via the `start_server` method from the `Puma::Runner` class
   # that this inherits from.
   class Single < Runner
+    # @!attribute [r] stats
     def stats
-      b = @server.backlog || 0
-      r = @server.running || 0
-      t = @server.pool_capacity || 0
-      m = @server.max_threads || 0
-      %Q!{ "started_at": "#{@started_at.utc.iso8601}", "backlog": #{b}, "running": #{r}, "pool_capacity": #{t}, "max_threads": #{m} }!
+      {
+        started_at: @started_at.utc.iso8601
+      }.merge(@server.stats).merge(super)
     end
 
     def restart
-      @server.begin_restart
+      @server&.begin_restart
     end
 
     def stop
-      @server.stop(false) if @server
+      @server&.stop false
     end
 
     def halt
-      @server.halt
+      @server&.halt
     end
 
     def stop_blocked
       log "- Gracefully stopping, waiting for requests to finish"
-      @control.stop(true) if @control
-      @server.stop(true) if @server
-    end
-
-    def jruby_daemon?
-      daemon? and Puma.jruby?
-    end
-
-    def jruby_daemon_start
-      require 'puma/jruby_restart'
-      JRubyRestart.daemon_start(@restart_dir, @launcher.restart_args)
+      @control&.stop true
+      @server&.stop true
     end
 
     def run
-      already_daemon = false
-
-      if jruby_daemon?
-        require 'puma/jruby_restart'
-
-        if JRubyRestart.daemon?
-          # load and bind before redirecting IO so errors show up on stdout/stderr
-          load_and_bind
-          redirect_io
-        end
-
-        already_daemon = JRubyRestart.daemon_init
-      end
-
       output_header "single"
 
-      if jruby_daemon?
-        if already_daemon
-          JRubyRestart.perm_daemonize
-        else
-          pid = nil
-
-          Signal.trap "SIGUSR2" do
-            log "* Started new process #{pid} as daemon..."
-
-            # Must use exit! so we don't unwind and run the ensures
-            # that will be run by the new child (such as deleting the
-            # pidfile)
-            exit!(true)
-          end
-
-          Signal.trap "SIGCHLD" do
-            log "! Error starting new process as daemon, exiting"
-            exit 1
-          end
-
-          jruby_daemon_start
-          sleep
-        end
-      else
-        if daemon?
-          log "* Daemonizing..."
-          Process.daemon(true)
-          redirect_io
-        end
-
-        load_and_bind
-      end
+      load_and_bind
 
       Plugins.fire_background
 
@@ -105,16 +50,15 @@ module Puma
       start_control
 
       @server = server = start_server
+      server_thread = server.run
 
-      unless daemon?
-        log "Use Ctrl-C to stop"
-        redirect_io
-      end
+      log "Use Ctrl-C to stop"
+      redirect_io
 
-      @launcher.events.fire_on_booted!
+      @events.fire_on_booted!
 
       begin
-        server.run.join
+        server_thread.join
       rescue Interrupt
         # Swallow it
       end

data/lib/puma/state_file.rb

@@ -1,24 +1,61 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module Puma
+
+  # Puma::Launcher uses StateFile to write a yaml file for use with Puma::ControlCLI.
+  #
+  # In previous versions of Puma, YAML was used to read/write the state file.
+  # Since Puma is similar to Bundler/RubyGems in that it may load before one's app
+  # does, minimizing the dependencies that may be shared with the app is desired.
+  #
+  # At present, it only works with numeric and string values.  It is still a valid
+  # yaml file, and the CI tests parse it with Psych.
+  #
   class StateFile
+
+    ALLOWED_FIELDS = %w!control_url control_auth_token pid running_from!
+
     def initialize
       @options = {}
     end
 
-    def save(path)
-      File.write path, YAML.dump(@options)
+    def save(path, permission = nil)
+      contents = +"---\n"
+      @options.each do |k,v|
+        next unless ALLOWED_FIELDS.include? k
+        case v
+        when Numeric
+          contents << "#{k}: #{v}\n"
+        when String
+          next if v.strip.empty?
+          contents << (k == 'running_from' || v.to_s.include?(' ') ?
+            "#{k}: \"#{v}\"\n" : "#{k}: #{v}\n")
+        end
+      end
+      if permission
+        File.write path, contents, mode: 'wb:UTF-8'
+      else
+        File.write path, contents, mode: 'wb:UTF-8', perm: permission
+      end
     end
 
     def load(path)
-      @options = YAML.load File.read(path)
+      File.read(path).lines.each do |line|
+        next if line.start_with? '#'
+        k,v = line.split ':', 2
+        next unless v && ALLOWED_FIELDS.include?(k)
+        v = v.strip
+        @options[k] =
+          case v
+          when ''              then nil
+          when /\A\d+\z/       then v.to_i
+          when /\A\d+\.\d+\z/  then v.to_f
+          else                      v.gsub(/\A"|"\z/, '')
+          end
+      end
     end
 
-    FIELDS = %w!control_url control_auth_token pid!
-
-    FIELDS.each do |f|
+    ALLOWED_FIELDS.each do |f|
       define_method f do
         @options[f]
       end

data/lib/puma/systemd.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'sd_notify'
+
+module Puma
+  class Systemd
+    def initialize(log_writer, events)
+      @log_writer = log_writer
+      @events = events
+    end
+
+    def hook_events
+      @events.on_booted { SdNotify.ready }
+      @events.on_stopped { SdNotify.stopping }
+      @events.on_restart { SdNotify.reloading }
+    end
+
+    def start_watchdog
+      return unless SdNotify.watchdog?
+
+      ping_f = watchdog_sleep_time
+
+      log "Pinging systemd watchdog every #{ping_f.round(1)} sec"
+      Thread.new do
+        loop do
+          sleep ping_f
+          SdNotify.watchdog
+        end
+      end
+    end
+
+    private
+
+    def watchdog_sleep_time
+      usec = Integer(ENV["WATCHDOG_USEC"])
+
+      sec_f = usec / 1_000_000.0
+      # "It is recommended that a daemon sends a keep-alive notification message
+      # to the service manager every half of the time returned here."
+      sec_f / 2
+    end
+
+    def log(str)
+      @log_writer.log(str)
+    end
+  end
+end

data/lib/puma/thread_pool.rb

@@ -2,6 +2,8 @@
 
 require 'thread'
 
+require_relative 'io_buffer'
+
 module Puma
   # Internal Docs for A simple thread pool management object.
   #
@@ -13,7 +15,7 @@ module Puma
   # a thread pool via the `Puma::ThreadPool#<<` operator where it is stored in a `@todo` array.
   #
   # Each thread in the pool has an internal loop where it pulls a request from the `@todo` array
-  # and proceses it.
+  # and processes it.
   class ThreadPool
     class ForceShutdown < RuntimeError
     end
@@ -29,7 +31,7 @@ module Puma
     # The block passed is the work that will be performed in each
     # thread.
     #
-    def initialize(min, max, *extra, &block)
+    def initialize(name, options = {}, &block)
       @not_empty = ConditionVariable.new
       @not_full = ConditionVariable.new
       @mutex = Mutex.new
@@ -39,14 +41,20 @@ module Puma
       @spawned = 0
       @waiting = 0
 
-      @min = Integer(min)
-      @max = Integer(max)
+      @name = name
+      @min = Integer(options[:min_threads])
+      @max = Integer(options[:max_threads])
       @block = block
-      @extra = extra
+      @extra = [::Puma::IOBuffer]
+      @out_of_band = options[:out_of_band]
+      @clean_thread_locals = options[:clean_thread_locals]
+      @reaping_time = options[:reaping_time]
+      @auto_trim_time = options[:auto_trim_time]
 
       @shutdown = false
 
       @trim_requested = 0
+      @out_of_band_pending = false
 
       @workers = []
 
@@ -54,17 +62,20 @@ module Puma
       @reaper = nil
 
       @mutex.synchronize do
-        @min.times { spawn_thread }
+        @min.times do
+          spawn_thread
+          @not_full.wait(@mutex)
+        end
       end
 
-      @clean_thread_locals = false
+      @force_shutdown = false
+      @shutdown_mutex = Mutex.new
     end
 
     attr_reader :spawned, :trim_requested, :waiting
-    attr_accessor :clean_thread_locals
 
     def self.clean_thread_locals
-      Thread.current.keys.each do |key| # rubocop: disable Performance/HashEachMethods
+      Thread.current.keys.each do |key| # rubocop: disable Style/HashEachMethods
         Thread.current[key] = nil unless key == :__recursive_key__
       end
     end
@@ -72,13 +83,20 @@ module Puma
     # How many objects have yet to be processed by the pool?
     #
     def backlog
-      @mutex.synchronize { @todo.size }
+      with_mutex { @todo.size }
     end
 
+    # @!attribute [r] pool_capacity
     def pool_capacity
       waiting + (@max - spawned)
     end
 
+    # @!attribute [r] busy_threads
+    # @version 5.0.0
+    def busy_threads
+      with_mutex { @spawned - @waiting + @todo.size }
+    end
+
     # :nodoc:
     #
     # Must be called with @mutex held!
@@ -87,7 +105,7 @@ module Puma
       @spawned += 1
 
       th = Thread.new(@spawned) do |spawned|
-        Puma.set_thread_name 'threadpool %03i' % spawned
+        Puma.set_thread_name '%s tp %03i' % [@name, spawned]
         todo  = @todo
         block = @block
         mutex = @mutex
@@ -99,48 +117,41 @@ module Puma
         while true
           work = nil
 
-          continue = true
-
           mutex.synchronize do
             while todo.empty?
               if @trim_requested > 0
                 @trim_requested -= 1
-                continue = false
+                @spawned -= 1
+                @workers.delete th
                 not_full.signal
-                break
-              end
-
-              if @shutdown
-                continue = false
-                break
+                Thread.exit
               end
 
               @waiting += 1
+              if @out_of_band_pending && trigger_out_of_band_hook
+                @out_of_band_pending = false
+              end
               not_full.signal
-              not_empty.wait mutex
-              @waiting -= 1
+              begin
+                not_empty.wait mutex
+              ensure
+                @waiting -= 1
+              end
             end
 
-            work = todo.shift if continue
+            work = todo.shift
           end
 
-          break unless continue
-
           if @clean_thread_locals
             ThreadPool.clean_thread_locals
           end
 
           begin
-            block.call(work, *extra)
+            @out_of_band_pending = true if block.call(work, *extra)
           rescue Exception => e
             STDERR.puts "Error reached top of thread-pool: #{e.message} (#{e.class})"
           end
         end
-
-        mutex.synchronize do
-          @spawned -= 1
-          @workers.delete th
-        end
       end
 
       @workers << th
@@ -150,9 +161,32 @@ module Puma
 
     private :spawn_thread
 
+    # @version 5.0.0
+    def trigger_out_of_band_hook
+      return false unless @out_of_band&.any?
+
+      # we execute on idle hook when all threads are free
+      return false unless @spawned == @waiting
+
+      @out_of_band.each(&:call)
+      true
+    rescue Exception => e
+      STDERR.puts "Exception calling out_of_band_hook: #{e.message} (#{e.class})"
+      true
+    end
+
+    private :trigger_out_of_band_hook
+
+    # @version 5.0.0
+    def with_mutex(&block)
+      @mutex.owned? ?
+        yield :
+        @mutex.synchronize(&block)
+    end
+
     # Add +work+ to the todo list for a Thread to pickup and process.
     def <<(work)
-      @mutex.synchronize do
+      with_mutex do
         if @shutdown
           raise "Unable to add work while shutting down"
         end
@@ -191,13 +225,10 @@ module Puma
     # then the `@todo` array would stay the same size as the reactor works
     # to try to buffer the request. In that scenario the next call to this
     # method would not block and another request would be added into the reactor
-    # by the server. This would continue until a fully bufferend request
+    # by the server. This would continue until a fully buffered request
     # makes it through the reactor and can then be processed by the thread pool.
-    #
-    # Returns the current number of busy threads, or +nil+ if shutting down.
-    #
     def wait_until_not_full
-      @mutex.synchronize do
+      with_mutex do
         while true
           return if @shutdown
 
@@ -205,21 +236,42 @@ module Puma
           # is work queued that cannot be handled by waiting
           # threads, then accept more work until we would
           # spin up the max number of threads.
-          busy_threads = @spawned - @waiting + @todo.size
-          return busy_threads if @max > busy_threads
+          return if busy_threads < @max
 
           @not_full.wait @mutex
         end
       end
     end
 
-    # If too many threads are in the pool, tell one to finish go ahead
+    # @version 5.0.0
+    def wait_for_less_busy_worker(delay_s)
+      return unless delay_s && delay_s > 0
+
+      # Ruby MRI does GVL, this can result
+      # in processing contention when multiple threads
+      # (requests) are running concurrently
+      return unless Puma.mri?
+
+      with_mutex do
+        return if @shutdown
+
+        # do not delay, if we are not busy
+        return unless busy_threads > 0
+
+        # this will be signaled once a request finishes,
+        # which can happen earlier than delay
+        @not_full.wait @mutex, delay_s
+      end
+    end
+
+    # If there are any free threads in the pool, tell one to go ahead
     # and exit. If +force+ is true, then a trim request is requested
     # even if all threads are being utilized.
     #
     def trim(force=false)
-      @mutex.synchronize do
-        if (force or @waiting > 0) and @spawned - @trim_requested > @min
+      with_mutex do
+        free = @waiting - @todo.size
+        if (force or free > 0) and @spawned - @trim_requested > @min
           @trim_requested += 1
           @not_empty.signal
         end
@@ -229,7 +281,7 @@ module Puma
     # If there are dead threads in the pool make them go away while decreasing
     # spawned counter so that new healthy threads could be created again.
     def reap
-      @mutex.synchronize do
+      with_mutex do
         dead_workers = @workers.reject(&:alive?)
 
         dead_workers.each do |worker|
@@ -270,26 +322,43 @@ module Puma
       end
     end
 
-    def auto_trim!(timeout=30)
-      @auto_trim = Automaton.new(self, timeout, "threadpool trimmer", :trim)
+    def auto_trim!(timeout=@auto_trim_time)
+      @auto_trim = Automaton.new(self, timeout, "#{@name} threadpool trimmer", :trim)
       @auto_trim.start!
     end
 
-    def auto_reap!(timeout=5)
-      @reaper = Automaton.new(self, timeout, "threadpool reaper", :reap)
+    def auto_reap!(timeout=@reaping_time)
+      @reaper = Automaton.new(self, timeout, "#{@name} threadpool reaper", :reap)
       @reaper.start!
     end
 
+    # Allows ThreadPool::ForceShutdown to be raised within the
+    # provided block if the thread is forced to shutdown during execution.
+    def with_force_shutdown
+      t = Thread.current
+      @shutdown_mutex.synchronize do
+        raise ForceShutdown if @force_shutdown
+        t[:with_force_shutdown] = true
+      end
+      yield
+    ensure
+      t[:with_force_shutdown] = false
+    end
+
     # Tell all threads in the pool to exit and wait for them to finish.
+    # Wait +timeout+ seconds then raise +ForceShutdown+ in remaining threads.
+    # Next, wait an extra +grace+ seconds then force-kill remaining threads.
+    # Finally, wait +kill_grace+ seconds for remaining threads to exit.
     #
     def shutdown(timeout=-1)
-      threads = @mutex.synchronize do
+      threads = with_mutex do
         @shutdown = true
+        @trim_requested = @spawned
         @not_empty.broadcast
         @not_full.broadcast
 
-        @auto_trim.stop if @auto_trim
-        @reaper.stop if @reaper
+        @auto_trim&.stop
+        @reaper&.stop
         # dup workers so that we join them all safely
         @workers.dup
       end
@@ -298,27 +367,29 @@ module Puma
         # Wait for threads to finish without force shutdown.
         threads.each(&:join)
       else
-        # Wait for threads to finish after n attempts (+timeout+).
-        # If threads are still running, it will forcefully kill them.
-        timeout.times do
-          threads.delete_if do |t|
-            t.join 1
-          end
-
-          if threads.empty?
-            break
-          else
-            sleep 1
+        join = ->(inner_timeout) do
+          start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          threads.reject! do |t|
+            elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+            t.join inner_timeout - elapsed
           end
         end
 
-        threads.each do |t|
-          t.raise ForceShutdown
-        end
+        # Wait +timeout+ seconds for threads to finish.
+        join.call(timeout)
 
-        threads.each do |t|
-          t.join SHUTDOWN_GRACE_TIME
+        # If threads are still running, raise ForceShutdown and wait to finish.
+        @shutdown_mutex.synchronize do
+          @force_shutdown = true
+          threads.each do |t|
+            t.raise ForceShutdown if t[:with_force_shutdown]
+          end
         end
+        join.call(SHUTDOWN_GRACE_TIME)
+
+        # If threads are _still_ running, forcefully kill them and wait to finish.
+        threads.each(&:kill)
+        join.call(1)
       end
 
       @spawned = 0

data/lib/puma/util.rb

@@ -10,18 +10,34 @@ module Puma
       IO.pipe
     end
 
-    # Unescapes a URI escaped string with +encoding+. +encoding+ will be the
-    # target encoding of the string returned, and it defaults to UTF-8
+    # An instance method on Thread has been provided to address https://bugs.ruby-lang.org/issues/13632,
+    # which currently effects some older versions of Ruby: 2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1
+    # Additional context: https://github.com/puma/puma/pull/1345
+    def purge_interrupt_queue
+      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+    end
+
+    # Escapes and unescapes a URI escaped string with
+    # +encoding+. +encoding+ will be the target encoding of the string
+    # returned, and it defaults to UTF-8
     if defined?(::Encoding)
+      def escape(s, encoding = Encoding::UTF_8)
+        URI.encode_www_form_component(s, encoding)
+      end
+
       def unescape(s, encoding = Encoding::UTF_8)
         URI.decode_www_form_component(s, encoding)
       end
     else
+      def escape(s, encoding = nil)
+        URI.encode_www_form_component(s, encoding)
+      end
+
       def unescape(s, encoding = nil)
         URI.decode_www_form_component(s, encoding)
       end
     end
-    module_function :unescape
+    module_function :unescape, :escape
 
     DEFAULT_SEP = /[&;] */n
 
@@ -50,7 +66,7 @@ module Puma
         end
       end
 
-      return params
+      params
     end
 
     # A case-insensitive Hash that preserves the original case of a
@@ -72,6 +88,7 @@ module Puma
         end
       end
 
+      # @!attribute [r] to_hash
       def to_hash
         hash = {}
         each { |k,v| hash[k] = v }