puma 5.3.2 → 6.0.0

data/lib/puma/cluster.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'puma/runner'
-require 'puma/util'
-require 'puma/plugin'
-require 'puma/cluster/worker_handle'
-require 'puma/cluster/worker'
+require_relative 'runner'
+require_relative 'util'
+require_relative 'plugin'
+require_relative 'cluster/worker_handle'
+require_relative 'cluster/worker'
 
 require 'time'
 
@@ -17,8 +17,8 @@ module Puma
   # via the `spawn_workers` method call. Each worker will have it's own
   # instance of a `Puma::Server`.
   class Cluster < Runner
-    def initialize(cli, events)
-      super cli, events
+    def initialize(launcher)
+      super(launcher)
 
       @phase = 0
       @workers = []
@@ -27,6 +27,10 @@ module Puma
       @phased_restart = false
     end
 
+    # Returns the list of cluster worker handles.
+    # @return [Array<Puma::Cluster::WorkerHandle>]
+    attr_reader :workers
+
     def stop_workers
       log "- Gracefully shutting down workers..."
       @workers.each { |x| x.term }
@@ -92,7 +96,7 @@ module Puma
 
     # @version 5.0.0
     def spawn_worker(idx, master)
-      @launcher.config.run_hooks :before_worker_fork, idx, @launcher.events
+      @config.run_hooks(:before_worker_fork, idx, @log_writer)
 
       pid = fork { worker(idx, master) }
       if !pid
@@ -101,31 +105,49 @@ module Puma
         exit! 1
       end
 
-      @launcher.config.run_hooks :after_worker_fork, idx, @launcher.events
+      @config.run_hooks(:after_worker_fork, idx, @log_writer)
       pid
     end
 
     def cull_workers
       diff = @workers.size - @options[:workers]
       return if diff < 1
+      debug "Culling #{diff} workers"
 
-      debug "Culling #{diff.inspect} workers"
-
-      workers_to_cull = @workers[-diff,diff]
-      debug "Workers to cull: #{workers_to_cull.inspect}"
+      workers = workers_to_cull(diff)
+      debug "Workers to cull: #{workers.inspect}"
 
-      workers_to_cull.each do |worker|
+      workers.each do |worker|
         log "- Worker #{worker.index} (PID: #{worker.pid}) terminating"
         worker.term
       end
     end
 
+    def workers_to_cull(diff)
+      workers = @workers.sort_by(&:started_at)
+
+      # In fork_worker mode, worker 0 acts as our master process.
+      # We should avoid culling it to preserve copy-on-write memory gains.
+      workers.reject! { |w| w.index == 0 } if @options[:fork_worker]
+
+      workers[cull_start_index(diff), diff]
+    end
+
+    def cull_start_index(diff)
+      case @options[:worker_culling_strategy]
+      when :oldest
+        0
+      else # :youngest
+        -diff
+      end
+    end
+
     # @!attribute [r] next_worker_index
     def next_worker_index
-      all_positions =  0...@options[:workers]
-      occupied_positions = @workers.map { |w| w.index }
-      available_positions = all_positions.to_a - occupied_positions
-      available_positions.first
+      occupied_positions = @workers.map(&:index)
+      idx = 0
+      idx += 1 until !occupied_positions.include?(idx)
+      idx
     end
 
     def all_workers_booted?
@@ -135,7 +157,7 @@ module Puma
     def check_workers
       return if @next_check >= Time.now
 
-      @next_check = Time.now + Const::WORKER_CHECK_INTERVAL
+      @next_check = Time.now + @options[:worker_check_interval]
 
       timeout_workers
       wait_workers
@@ -158,20 +180,10 @@ module Puma
         end
       end
 
-      @next_check = [
-        @workers.reject(&:term?).map(&:ping_timeout).min,
-        @next_check
-      ].compact.min
-    end
-
-    def wakeup!
-      return unless @wakeup
+      t = @workers.reject(&:term?)
+      t.map!(&:ping_timeout)
 
-      begin
-        @wakeup.write "!" unless @wakeup.closed?
-      rescue SystemCallError, IOError
-        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
-      end
+      @next_check = [t.min, @next_check].compact.min
     end
 
     def worker(index, master)
@@ -201,8 +213,8 @@ module Puma
       stop
     end
 
-    def phased_restart
-      return false if @options[:preload_app]
+    def phased_restart(refork = false)
+      return false if @options[:preload_app] && !refork
 
       @phased_restart = true
       wakeup!
@@ -218,7 +230,7 @@ module Puma
     def stop_blocked
       @status = :stop if @status == :run
       wakeup!
-      @control.stop(true) if @control
+      @control&.stop true
       Process.waitall
     end
 
@@ -257,7 +269,7 @@ module Puma
         booted_workers: worker_status.count { |w| w[:booted] },
         old_workers: old_worker_count,
         worker_status: worker_status,
-      }
+      }.merge(super)
     end
 
     def preload?
@@ -269,7 +281,7 @@ module Puma
       if (worker = @workers.find { |w| w.index == 0 })
         worker.phase += 1
       end
-      phased_restart
+      phased_restart(true)
     end
 
     # We do this in a separate method to keep the lambda scope
@@ -282,7 +294,7 @@ module Puma
 
         # Auto-fork after the specified number of requests.
         if (fork_requests = @options[:fork_worker].to_i) > 0
-          @launcher.events.register(:ping!) do |w|
+          @events.register(:ping!) do |w|
             fork_worker! if w.index == 0 &&
               w.phase == 0 &&
               w.last_status[:requests_count] >= fork_requests
@@ -364,12 +376,12 @@ module Puma
       else
         log "*     Restarts: (\u2714) hot (\u2714) phased"
 
-        unless @launcher.config.app_configured?
+        unless @config.app_configured?
           error "No application configured, nothing to run"
           exit 1
         end
 
-        @launcher.binder.parse @options[:binds], self
+        @launcher.binder.parse @options[:binds]
       end
 
       read, @wakeup = Puma::Util.pipe
@@ -401,8 +413,7 @@ module Puma
 
       @master_read, @worker_write = read, @wakeup
 
-      @launcher.config.run_hooks :before_fork, nil, @launcher.events
-      Puma::Util.nakayoshi_gc @events if @options[:nakayoshi_fork]
+      @config.run_hooks(:before_fork, nil, @log_writer)
 
       spawn_workers
 
@@ -426,9 +437,7 @@ module Puma
 
             check_workers
 
-            res = IO.select([read], nil, nil, [0, @next_check - Time.now].max)
-
-            if res
+            if read.wait_readable([0, @next_check - Time.now].max)
               req = read.read_nonblock(1)
 
               @next_check = Time.now if req == "!"
@@ -452,14 +461,14 @@ module Puma
                   workers_not_booted -= 1
                 when "e"
                   # external term, see worker method, Signal.trap "SIGTERM"
-                  w.instance_variable_set :@term, true
+                  w.term!
                 when "t"
                   w.term unless w.term?
                 when "p"
                   w.ping!(result.sub(/^\d+/,'').chomp)
-                  @launcher.events.fire(:ping!, w)
+                  @events.fire(:ping!, w)
                   if !booted && @workers.none? {|worker| worker.last_status.empty?}
-                    @launcher.events.fire_on_booted!
+                    @events.fire_on_booted!
                     booted = true
                   end
                 end

data/lib/puma/configuration.rb

@@ -1,20 +1,11 @@
 # frozen_string_literal: true
 
-require 'puma/rack/builder'
-require 'puma/plugin'
-require 'puma/const'
+require_relative 'rack/builder'
+require_relative 'plugin'
+require_relative 'const'
+# note that dsl is loaded at end of file, requires ConfigDefault constants
 
 module Puma
-
-  module ConfigDefault
-    DefaultRackup = "config.ru"
-
-    DefaultTCPHost = "0.0.0.0"
-    DefaultTCPPort = 9292
-    DefaultWorkerTimeout = 60
-    DefaultWorkerShutdownTimeout = 30
-  end
-
   # A class used for storing "leveled" configuration options.
   #
   # In this class any "user" specified options take precedence over any
@@ -135,7 +126,48 @@ module Puma
   # is done because an environment variable may have been modified while loading
   # configuration files.
   class Configuration
-    include ConfigDefault
+    DEFAULTS = {
+      auto_trim_time: 30,
+      binds: ['tcp://0.0.0.0:9292'.freeze],
+      clean_thread_locals: false,
+      debug: false,
+      early_hints: nil,
+      environment: 'development'.freeze,
+      # Number of seconds to wait until we get the first data for the request
+      first_data_timeout: 30,
+      io_selector_backend: :auto,
+      log_requests: false,
+      logger: STDOUT,
+      # How many requests to attempt inline before sending a client back to
+      # the reactor to be subject to normal ordering. The idea here is that
+      # we amortize the cost of going back to the reactor for a well behaved
+      # but very "greedy" client across 10 requests. This prevents a not
+      # well behaved client from monopolizing the thread forever.
+      max_fast_inline: 10,
+      max_threads: Puma.mri? ? 5 : 16,
+      min_threads: 0,
+      mode: :http,
+      mutate_stdout_and_stderr_to_sync_on_write: true,
+      out_of_band: [],
+      # Number of seconds for another request within a persistent session.
+      persistent_timeout: 20,
+      queue_requests: true,
+      rackup: 'config.ru'.freeze,
+      raise_exception_on_sigterm: true,
+      reaping_time: 1,
+      remote_address: :socket,
+      silence_single_worker_warning: false,
+      tag: File.basename(Dir.getwd),
+      tcp_host: '0.0.0.0'.freeze,
+      tcp_port: 9292,
+      wait_for_less_busy_worker: 0.005,
+      worker_boot_timeout: 60,
+      worker_check_interval: 5,
+      worker_culling_strategy: :youngest,
+      worker_shutdown_timeout: 30,
+      worker_timeout: 60,
+      workers: 0,
+    }
 
     def initialize(user_options={}, default_options = {}, &block)
       default_options = self.puma_default_options.merge(default_options)
@@ -180,35 +212,22 @@ module Puma
       self
     end
 
-    # @version 5.0.0
-    def default_max_threads
-      Puma.mri? ? 5 : 16
+    def puma_default_options
+      defaults = DEFAULTS.dup
+      puma_options_from_env.each { |k,v| defaults[k] = v if v }
+      defaults
     end
 
-    def puma_default_options
+    def puma_options_from_env
+      min = ENV['PUMA_MIN_THREADS'] || ENV['MIN_THREADS']
+      max = ENV['PUMA_MAX_THREADS'] || ENV['MAX_THREADS']
+      workers = ENV['WEB_CONCURRENCY']
+
       {
-        :min_threads => Integer(ENV['PUMA_MIN_THREADS'] || ENV['MIN_THREADS'] || 0),
-        :max_threads => Integer(ENV['PUMA_MAX_THREADS'] || ENV['MAX_THREADS'] || default_max_threads),
-        :log_requests => false,
-        :debug => false,
-        :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
-        :workers => Integer(ENV['WEB_CONCURRENCY'] || 0),
-        :silence_single_worker_warning => false,
-        :mode => :http,
-        :worker_timeout => DefaultWorkerTimeout,
-        :worker_boot_timeout => DefaultWorkerTimeout,
-        :worker_shutdown_timeout => DefaultWorkerShutdownTimeout,
-        :remote_address => :socket,
-        :tag => method(:infer_tag),
-        :environment => -> { ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development" },
-        :rackup => DefaultRackup,
-        :logger => STDOUT,
-        :persistent_timeout => Const::PERSISTENT_TIMEOUT,
-        :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
-        :raise_exception_on_sigterm => true,
-        :max_fast_inline => Const::MAX_FAST_INLINE,
-        :io_selector_backend => :auto,
-        :mutate_stdout_and_stderr_to_sync_on_write => true,
+        min_threads: min && Integer(min),
+        max_threads: max && Integer(max),
+        workers: workers && Integer(workers),
+        environment: ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'],
       }
     end
 
@@ -224,7 +243,7 @@ module Puma
       return [] if files == ['-']
       return files if files.any?
 
-      first_default_file = %W(config/puma/#{environment_str}.rb config/puma.rb).find do |f|
+      first_default_file = %W(config/puma/#{@options[:environment]}.rb config/puma.rb).find do |f|
         File.exist?(f)
       end
 
@@ -267,7 +286,7 @@ module Puma
       found = options[:app] || load_rackup
 
       if @options[:log_requests]
-        require 'puma/commonlogger'
+        require_relative 'commonlogger'
         logger = @options[:logger]
         found = CommonLogger.new(found, logger)
       end
@@ -280,21 +299,25 @@ module Puma
       @options[:environment]
     end
 
-    def environment_str
-      environment.respond_to?(:call) ? environment.call : environment
-    end
-
     def load_plugin(name)
       @plugins.create name
     end
 
-    def run_hooks(key, arg, events)
+    # @param key [:Symbol] hook to run
+    # @param arg [Launcher, Int] `:on_restart` passes Launcher
+    #
+    def run_hooks(key, arg, log_writer, hook_data = nil)
       @options.all_of(key).each do |b|
         begin
-          b.call arg
+          if Array === b
+            hook_data[b[1]] ||= Hash.new
+            b[0].call arg, hook_data[b[1]]
+          else
+            b.call arg
+          end
         rescue => e
-          events.log "WARNING hook #{key} failed with exception (#{e.class}) #{e.message}"
-          events.debug e.backtrace.join("\n")
+          log_writer.log "WARNING hook #{key} failed with exception (#{e.class}) #{e.message}"
+          log_writer.debug e.backtrace.join("\n")
         end
       end
     end
@@ -312,10 +335,6 @@ module Puma
 
     private
 
-    def infer_tag
-      File.basename(Dir.getwd)
-    end
-
     # Load and use the normal Rack builder if we can, otherwise
     # fallback to our minimal version.
     def rack_builder
@@ -365,4 +384,4 @@ module Puma
   end
 end
 
-require 'puma/dsl'
+require_relative 'dsl'

data/lib/puma/const.rb

@@ -76,7 +76,7 @@ module Puma
     508 => 'Loop Detected',
     510 => 'Not Extended',
     511 => 'Network Authentication Required'
-  }
+  }.freeze
 
   # For some HTTP status codes the client only expects headers.
   #
@@ -85,7 +85,7 @@ module Puma
     204 => true,
     205 => true,
     304 => true
-  }
+  }.freeze
 
   # Frequently used constants when constructing requests or responses.  Many times
   # the constant just refers to a string with the same contents.  Using these constants
@@ -100,32 +100,17 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "5.3.2".freeze
-    CODE_NAME = "Sweetnighter".freeze
+    PUMA_VERSION = VERSION = "6.0.0".freeze
+    CODE_NAME = "Sunflower".freeze
 
     PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 
-    # The default number of seconds for another request within a persistent
-    # session.
-    PERSISTENT_TIMEOUT = 20
-
-    # The default number of seconds to wait until we get the first data
-    # for the request
-    FIRST_DATA_TIMEOUT = 30
-
     # How long to wait when getting some write blocking on the socket when
     # sending data back
     WRITE_TIMEOUT = 10
 
-    # How many requests to attempt inline before sending a client back to
-    # the reactor to be subject to normal ordering. The idea here is that
-    # we amortize the cost of going back to the reactor for a well behaved
-    # but very "greedy" client across 10 requests. This prevents a not
-    # well behaved client from monopolizing the thread forever.
-    MAX_FAST_INLINE = 10
-
     # The original URI requested by the client.
     REQUEST_URI= 'REQUEST_URI'.freeze
     REQUEST_PATH = 'REQUEST_PATH'.freeze
@@ -145,9 +130,11 @@ module Puma
       408 => "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze,
       # Indicate that there was an internal error, obviously.
       500 => "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze,
+      # Incorrect or invalid header value
+      501 => "HTTP/1.1 501 Not Implemented\r\n\r\n".freeze,
       # A common header for indicating the server is too busy.  Not used yet.
       503 => "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY".freeze
-    }
+    }.freeze
 
     # The basic max request size we'll try to read.
     CHUNK_SIZE = 16 * 1024
@@ -161,6 +148,14 @@ module Puma
 
     REQUEST_METHOD = "REQUEST_METHOD".freeze
     HEAD = "HEAD".freeze
+    GET = "GET".freeze
+    POST = "POST".freeze
+    PUT = "PUT".freeze
+    DELETE = "DELETE".freeze
+    OPTIONS = "OPTIONS".freeze
+    TRACE = "TRACE".freeze
+    PATCH = "PATCH".freeze
+    SUPPORTED_HTTP_METHODS = [HEAD, GET, POST, PUT, DELETE, OPTIONS, TRACE, PATCH].freeze
     # ETag is based on the apache standard of hex mtime-size-inode (inode is 0 on win32)
     LINE_END = "\r\n".freeze
     REMOTE_ADDR = "REMOTE_ADDR".freeze
@@ -175,7 +170,10 @@ module Puma
     PORT_80 = "80".freeze
     PORT_443 = "443".freeze
     LOCALHOST = "localhost".freeze
-    LOCALHOST_IP = "127.0.0.1".freeze
+    LOCALHOST_IPV4 = "127.0.0.1".freeze
+    LOCALHOST_IPV6 = "::1".freeze
+    UNSPECIFIED_IPV4 = "0.0.0.0".freeze
+    UNSPECIFIED_IPV6 = "::".freeze
 
     SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
     HTTP_11 = "HTTP/1.1".freeze
@@ -235,9 +233,6 @@ module Puma
 
     EARLY_HINTS = "rack.early_hints".freeze
 
-    # Minimum interval to checks worker health
-    WORKER_CHECK_INTERVAL = 5
-
     # Illegal character in the key or value of response header
     DQUOTE = "\"".freeze
     HTTP_HEADER_DELIMITER = Regexp.escape("(),/:;<=>?@[]{}\\").freeze
@@ -247,5 +242,7 @@ module Puma
 
     # Banned keys of response header
     BANNED_HEADER_KEY = /\A(rack\.|status\z)/.freeze
+
+    PROXY_PROTOCOL_V1_REGEX = /^PROXY (?:TCP4|TCP6|UNKNOWN) ([^\r]+)\r\n/.freeze
   end
 end

data/lib/puma/control_cli.rb

@@ -17,26 +17,27 @@ module Puma
     CMD_PATH_SIG_MAP = {
       'gc'       => nil,
       'gc-stats' => nil,
-      'halt'     => 'SIGQUIT',
-      'phased-restart' => 'SIGUSR1',
-      'refork'   => 'SIGURG',
+      'halt'              => 'SIGQUIT',
+      'info'              => 'SIGINFO',
+      'phased-restart'    => 'SIGUSR1',
+      'refork'            => 'SIGURG',
       'reload-worker-directory' => nil,
-      'restart'  => 'SIGUSR2',
+      'reopen-log'        => 'SIGHUP',
+      'restart'           => 'SIGUSR2',
       'start'    => nil,
       'stats'    => nil,
       'status'   => '',
-      'stop'     => 'SIGTERM',
-      'thread-backtraces' => nil
+      'stop'              => 'SIGTERM',
+      'thread-backtraces' => nil,
+      'worker-count-down' => 'SIGTTOU',
+      'worker-count-up'   => 'SIGTTIN'
     }.freeze
 
-    # @deprecated 6.0.0
-    COMMANDS = CMD_PATH_SIG_MAP.keys.freeze
-
     # commands that cannot be used in a request
-    NO_REQ_COMMANDS = %w{refork}.freeze
+    NO_REQ_COMMANDS = %w[info reopen-log worker-count-down worker-count-up].freeze
 
     # @version 5.0.0
-    PRINTABLE_COMMANDS = %w{gc-stats stats thread-backtraces}.freeze
+    PRINTABLE_COMMANDS = %w[gc-stats stats thread-backtraces].freeze
 
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
       @state = nil
@@ -47,7 +48,7 @@ module Puma
       @control_auth_token = nil
       @config_file = nil
       @command = nil
-      @environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
+      @environment = ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV']
 
       @argv = argv.dup
       @stdout = stdout
@@ -185,8 +186,6 @@ module Puma
 
       if @command == 'status'
         message 'Puma is started'
-      elsif NO_REQ_COMMANDS.include? @command
-        raise "Invalid request command: #{@command}"
       else
         url = "/#{@command}"
 
@@ -242,7 +241,11 @@ module Puma
           @stdout.flush unless @stdout.sync
           return
         elsif sig.start_with? 'SIG'
-          Process.kill sig, @pid
+          if Signal.list.key? sig.sub(/\ASIG/, '')
+            Process.kill sig, @pid
+          else
+            raise "Signal '#{sig}' not available'"
+          end
         elsif @command == 'status'
           begin
             Process.kill 0, @pid
@@ -268,7 +271,7 @@ module Puma
       return start if @command == 'start'
       prepare_configuration
 
-      if Puma.windows? || @control_url
+      if Puma.windows? || @control_url && !NO_REQ_COMMANDS.include?(@command)
         send_request
       else
         send_signal
@@ -281,7 +284,7 @@ module Puma
 
     private
     def start
-      require 'puma/cli'
+      require_relative 'cli'
 
       run_args = []
 
@@ -293,13 +296,13 @@ module Puma
       run_args += ["-C", @config_file] if @config_file
       run_args += ["-e", @environment] if @environment
 
-      events = Puma::Events.new @stdout, @stderr
+      log_writer = Puma::LogWriter.new(@stdout, @stderr)
 
       # replace $0 because puma use it to generate restart command
       puma_cmd = $0.gsub(/pumactl$/, 'puma')
       $0 = puma_cmd if File.exist?(puma_cmd)
 
-      cli = Puma::CLI.new run_args, events
+      cli = Puma::CLI.new run_args, log_writer
       cli.run
     end
   end

data/lib/puma/detect.rb

@@ -8,10 +8,14 @@ module Puma
   # @version 5.2.1
   HAS_FORK = ::Process.respond_to? :fork
 
+  HAS_NATIVE_IO_WAIT = ::IO.public_instance_methods(false).include? :wait_readable
+
   IS_JRUBY = Object.const_defined? :JRUBY_VERSION
 
-  IS_WINDOWS = !!(RUBY_PLATFORM =~ /mswin|ming|cygwin/ ||
-    IS_JRUBY && RUBY_DESCRIPTION =~ /mswin/)
+  IS_OSX = RUBY_PLATFORM.include? 'darwin'
+
+  IS_WINDOWS = !!(RUBY_PLATFORM =~ /mswin|ming|cygwin/) ||
+    IS_JRUBY && RUBY_DESCRIPTION.include?('mswin')
 
   # @version 5.2.0
   IS_MRI = (RUBY_ENGINE == 'ruby' || RUBY_ENGINE.nil?)
@@ -20,6 +24,10 @@ module Puma
     IS_JRUBY
   end
 
+  def self.osx?
+    IS_OSX
+  end
+
   def self.windows?
     IS_WINDOWS
   end