puma 4.3.12 → 6.0.2

data/lib/puma/commonlogger.rb

@@ -3,7 +3,7 @@
 module Puma
   # Rack::CommonLogger forwards every request to the given +app+, and
   # logs a line in the
-  # {Apache common log format}[http://httpd.apache.org/docs/1.3/logs.html#common]
+  # {Apache common log format}[https://httpd.apache.org/docs/1.3/logs.html#common]
   # to the +logger+.
   #
   # If +logger+ is nil, CommonLogger will fall back +rack.errors+, which is
@@ -16,7 +16,7 @@ module Puma
   # (which is called without arguments in order to make the error appear for
   # sure)
   class CommonLogger
-    # Common Log Format: http://httpd.apache.org/docs/1.3/logs.html#common
+    # Common Log Format: https://httpd.apache.org/docs/1.3/logs.html#common
     #
     #   lilith.local - - [07/Aug/2006 23:58:02 -0400] "GET / HTTP/1.1" 500 -
     #

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
@@ -54,9 +45,7 @@ module Puma
     attr_reader :user_options, :file_options, :default_options
 
     def [](key)
-      return user_options[key]    if user_options.key?(key)
-      return file_options[key]    if file_options.key?(key)
-      return default_options[key] if default_options.key?(key)
+      fetch(key)
     end
 
     def []=(key, value)
@@ -64,7 +53,11 @@ module Puma
     end
 
     def fetch(key, default_value = nil)
-      self[key] || default_value
+      return user_options[key]    if user_options.key?(key)
+      return file_options[key]    if file_options.key?(key)
+      return default_options[key] if default_options.key?(key)
+
+      default_value
     end
 
     def all_of(key)
@@ -90,6 +83,12 @@ module Puma
         end
       end
     end
+
+    def final_options
+      default_options
+        .merge(file_options)
+        .merge(user_options)
+    end
   end
 
   # The main configuration class of Puma.
@@ -106,16 +105,17 @@ module Puma
   #
   # It also handles loading plugins.
   #
-  # > Note: `:port` and `:host` are not valid keys. By they time they make it to the
+  # [Note:]
+  #   `:port` and `:host` are not valid keys. By the time they make it to the
   #   configuration options they are expected to be incorporated into a `:binds` key.
   #   Under the hood the DSL maps `port` and `host` calls to `:binds`
   #
-  #   config = Configuration.new({}) do |user_config, file_config, default_config|
-  #     user_config.port 3003
-  #   end
-  #   config.load
-  #   puts config.options[:port]
-  #   # => 3003
+  #     config = Configuration.new({}) do |user_config, file_config, default_config|
+  #       user_config.port 3003
+  #     end
+  #     config.load
+  #     puts config.options[:port]
+  #     # => 3003
   #
   # It is expected that `load` is called on the configuration instance after setting
   # config. This method expands any values in `config_file` and puts them into the
@@ -126,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)
@@ -137,6 +178,10 @@ module Puma
       @file_dsl    = DSL.new(@options.file_options, self)
       @default_dsl = DSL.new(@options.default_options, self)
 
+      if !@options[:prune_bundler]
+        default_options[:preload_app] = (@options[:workers] > 1) && Puma.forkable?
+      end
+
       if block
         configure(&block)
       end
@@ -168,26 +213,21 @@ module Puma
     end
 
     def puma_default_options
+      defaults = DEFAULTS.dup
+      puma_options_from_env.each { |k,v| defaults[k] = v if v }
+      defaults
+    end
+
+    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 => 0,
-        :max_threads => 16,
-        :log_requests => false,
-        :debug => false,
-        :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
-        :workers => 0,
-        :daemon => 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'] || "development" },
-        :rackup => DefaultRackup,
-        :logger => STDOUT,
-        :persistent_timeout => Const::PERSISTENT_TIMEOUT,
-        :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
-        :raise_exception_on_sigterm => 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
 
@@ -203,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
 
@@ -245,16 +285,8 @@ module Puma
     def app
       found = options[:app] || load_rackup
 
-      if @options[:mode] == :tcp
-        require 'puma/tcp_logger'
-
-        logger = @options[:logger]
-        quiet = !@options[:log_requests]
-        return TCPLogger.new(logger, found, quiet)
-      end
-
       if @options[:log_requests]
-        require 'puma/commonlogger'
+        require_relative 'commonlogger'
         logger = @options[:logger]
         found = CommonLogger.new(found, logger)
       end
@@ -267,16 +299,31 @@ 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)
-      @options.all_of(key).each { |b| b.call arg }
+    # @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
+          if Array === b
+            hook_data[b[1]] ||= Hash.new
+            b[0].call arg, hook_data[b[1]]
+          else
+            b.call arg
+          end
+        rescue => e
+          log_writer.log "WARNING hook #{key} failed with exception (#{e.class}) #{e.message}"
+          log_writer.debug e.backtrace.join("\n")
+        end
+      end
+    end
+
+    def final_options
+      @options.final_options
     end
 
     def self.temp_path
@@ -288,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
@@ -319,6 +362,8 @@ module Puma
       raise "Missing rackup file '#{rackup}'" unless File.exist?(rackup)
 
       rack_app, rack_options = rack_builder.parse_file(rackup)
+      rack_options = rack_options || {}
+
       @options.file_options.merge!(rack_options)
 
       config_ru_binds = []
@@ -332,31 +377,11 @@ module Puma
     end
 
     def self.random_token
-      begin
-        require 'openssl'
-      rescue LoadError
-      end
-
-      count = 16
-
-      bytes = nil
-
-      if defined? OpenSSL::Random
-        bytes = OpenSSL::Random.random_bytes(count)
-      elsif File.exist?("/dev/urandom")
-        File.open('/dev/urandom') { |f| bytes = f.read(count) }
-      end
-
-      if bytes
-        token = "".dup
-        bytes.each_byte { |b| token << b.to_s(16) }
-      else
-        token = (0..count).to_a.map { rand(255).to_s(16) }.join
-      end
+      require 'securerandom' unless defined?(SecureRandom)
 
-      return token
+      SecureRandom.hex(16)
     end
   end
 end
 
-require 'puma/dsl'
+require_relative 'dsl'

data/lib/puma/const.rb

@@ -5,7 +5,6 @@ module Puma
   class UnsupportedOption < RuntimeError
   end
 
-
   # Every standard HTTP code mapped to the appropriate message.  These are
   # used so frequently that they are placed directly in Puma for easy
   # access rather than Puma::Const itself.
@@ -100,54 +99,40 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "4.3.12".freeze
-    CODE_NAME = "Mysterious Traveller".freeze
-    PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
-
-    FAST_TRACK_KA_TIMEOUT = 0.2
+    PUMA_VERSION = VERSION = "6.0.2"
+    CODE_NAME = "Sunflower"
 
-    # The default number of seconds for another request within a persistent
-    # session.
-    PERSISTENT_TIMEOUT = 20
+    PUMA_SERVER_STRING = ["puma", PUMA_VERSION, CODE_NAME].join(" ").freeze
 
-    # The default number of seconds to wait until we get the first data
-    # for the request
-    FIRST_DATA_TIMEOUT = 30
+    FAST_TRACK_KA_TIMEOUT = 0.2
 
     # 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
-    QUERY_STRING = 'QUERY_STRING'.freeze
-    CONTENT_LENGTH = "CONTENT_LENGTH".freeze
+    REQUEST_URI= "REQUEST_URI"
+    REQUEST_PATH = "REQUEST_PATH"
+    QUERY_STRING = "QUERY_STRING"
+    CONTENT_LENGTH = "CONTENT_LENGTH"
 
-    PATH_INFO = 'PATH_INFO'.freeze
+    PATH_INFO = "PATH_INFO"
 
-    PUMA_TMP_BASE = "puma".freeze
+    PUMA_TMP_BASE = "puma"
 
     ERROR_RESPONSE = {
       # Indicate that we couldn't parse the request
-      400 => "HTTP/1.1 400 Bad Request\r\n\r\n".freeze,
+      400 => "HTTP/1.1 400 Bad Request\r\n\r\n",
       # The standard empty 404 response for bad requests.  Use Error4040Handler for custom stuff.
-      404 => "HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND".freeze,
+      404 => "HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND",
       # The standard empty 408 response for requests that timed out.
-      408 => "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze,
+      408 => "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n",
       # Indicate that there was an internal error, obviously.
-      500 => "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze,
+      500 => "HTTP/1.1 500 Internal Server Error\r\n\r\n",
       # Incorrect or invalid header value
-      501 => "HTTP/1.1 501 Not Implemented\r\n\r\n".freeze,
+      501 => "HTTP/1.1 501 Not Implemented\r\n\r\n",
       # 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
+      503 => "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY"
     }.freeze
 
     # The basic max request size we'll try to read.
@@ -160,86 +145,96 @@ module Puma
     # Maximum request body size before it is moved out of memory and into a tempfile for reading.
     MAX_BODY = MAX_HEADER
 
-    REQUEST_METHOD = "REQUEST_METHOD".freeze
-    HEAD = "HEAD".freeze
+    REQUEST_METHOD = "REQUEST_METHOD"
+    HEAD = "HEAD"
+    SUPPORTED_HTTP_METHODS = %w[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
-    HTTP_X_FORWARDED_FOR = "HTTP_X_FORWARDED_FOR".freeze
-    HTTP_X_FORWARDED_SSL = "HTTP_X_FORWARDED_SSL".freeze
-    HTTP_X_FORWARDED_SCHEME = "HTTP_X_FORWARDED_SCHEME".freeze
-    HTTP_X_FORWARDED_PROTO = "HTTP_X_FORWARDED_PROTO".freeze
+    LINE_END = "\r\n"
+    REMOTE_ADDR = "REMOTE_ADDR"
+    HTTP_X_FORWARDED_FOR = "HTTP_X_FORWARDED_FOR"
+    HTTP_X_FORWARDED_SSL = "HTTP_X_FORWARDED_SSL"
+    HTTP_X_FORWARDED_SCHEME = "HTTP_X_FORWARDED_SCHEME"
+    HTTP_X_FORWARDED_PROTO = "HTTP_X_FORWARDED_PROTO"
+
+    SERVER_NAME = "SERVER_NAME"
+    SERVER_PORT = "SERVER_PORT"
+    HTTP_HOST = "HTTP_HOST"
+    PORT_80 = "80"
+    PORT_443 = "443"
+    LOCALHOST = "localhost"
+    LOCALHOST_IPV4 = "127.0.0.1"
+    LOCALHOST_IPV6 = "::1"
+    UNSPECIFIED_IPV4 = "0.0.0.0"
+    UNSPECIFIED_IPV6 = "::"
 
-    SERVER_NAME = "SERVER_NAME".freeze
-    SERVER_PORT = "SERVER_PORT".freeze
-    HTTP_HOST = "HTTP_HOST".freeze
-    PORT_80 = "80".freeze
-    PORT_443 = "443".freeze
-    LOCALHOST = "localhost".freeze
-    LOCALHOST_IP = "127.0.0.1".freeze
-    LOCALHOST_ADDR = "127.0.0.1:0".freeze
+    SERVER_PROTOCOL = "SERVER_PROTOCOL"
+    HTTP_11 = "HTTP/1.1"
 
-    SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
-    HTTP_11 = "HTTP/1.1".freeze
+    SERVER_SOFTWARE = "SERVER_SOFTWARE"
+    GATEWAY_INTERFACE = "GATEWAY_INTERFACE"
+    CGI_VER = "CGI/1.2"
 
-    SERVER_SOFTWARE = "SERVER_SOFTWARE".freeze
-    GATEWAY_INTERFACE = "GATEWAY_INTERFACE".freeze
-    CGI_VER = "CGI/1.2".freeze
+    STOP_COMMAND = "?"
+    HALT_COMMAND = "!"
+    RESTART_COMMAND = "R"
 
-    STOP_COMMAND = "?".freeze
-    HALT_COMMAND = "!".freeze
-    RESTART_COMMAND = "R".freeze
+    RACK_INPUT = "rack.input"
+    RACK_URL_SCHEME = "rack.url_scheme"
+    RACK_AFTER_REPLY = "rack.after_reply"
+    PUMA_SOCKET = "puma.socket"
+    PUMA_CONFIG = "puma.config"
+    PUMA_PEERCERT = "puma.peercert"
 
-    RACK_INPUT = "rack.input".freeze
-    RACK_URL_SCHEME = "rack.url_scheme".freeze
-    RACK_AFTER_REPLY = "rack.after_reply".freeze
-    PUMA_SOCKET = "puma.socket".freeze
-    PUMA_CONFIG = "puma.config".freeze
-    PUMA_PEERCERT = "puma.peercert".freeze
+    HTTP = "http"
+    HTTPS = "https"
 
-    HTTP = "http".freeze
-    HTTPS = "https".freeze
+    HTTPS_KEY = "HTTPS"
 
-    HTTPS_KEY = "HTTPS".freeze
+    HTTP_VERSION = "HTTP_VERSION"
+    HTTP_CONNECTION = "HTTP_CONNECTION"
+    HTTP_EXPECT = "HTTP_EXPECT"
+    CONTINUE = "100-continue"
 
-    HTTP_VERSION = "HTTP_VERSION".freeze
-    HTTP_CONNECTION = "HTTP_CONNECTION".freeze
-    HTTP_EXPECT = "HTTP_EXPECT".freeze
-    CONTINUE = "100-continue".freeze
+    HTTP_11_100 = "HTTP/1.1 100 Continue\r\n\r\n"
+    HTTP_11_200 = "HTTP/1.1 200 OK\r\n"
+    HTTP_10_200 = "HTTP/1.0 200 OK\r\n"
 
-    HTTP_11_100 = "HTTP/1.1 100 Continue\r\n\r\n".freeze
-    HTTP_11_200 = "HTTP/1.1 200 OK\r\n".freeze
-    HTTP_10_200 = "HTTP/1.0 200 OK\r\n".freeze
+    CLOSE = "close"
+    KEEP_ALIVE = "keep-alive"
 
-    CLOSE = "close".freeze
-    KEEP_ALIVE = "keep-alive".freeze
+    CONTENT_LENGTH2 = "content-length"
+    CONTENT_LENGTH_S = "Content-Length: "
+    TRANSFER_ENCODING = "transfer-encoding"
+    TRANSFER_ENCODING2 = "HTTP_TRANSFER_ENCODING"
 
-    CONTENT_LENGTH2 = "content-length".freeze
-    CONTENT_LENGTH_S = "Content-Length: ".freeze
-    TRANSFER_ENCODING = "transfer-encoding".freeze
-    TRANSFER_ENCODING2 = "HTTP_TRANSFER_ENCODING".freeze
+    CONNECTION_CLOSE = "Connection: close\r\n"
+    CONNECTION_KEEP_ALIVE = "Connection: Keep-Alive\r\n"
 
-    CONNECTION_CLOSE = "Connection: close\r\n".freeze
-    CONNECTION_KEEP_ALIVE = "Connection: Keep-Alive\r\n".freeze
+    TRANSFER_ENCODING_CHUNKED = "Transfer-Encoding: chunked\r\n"
+    CLOSE_CHUNKED = "0\r\n\r\n"
 
-    TRANSFER_ENCODING_CHUNKED = "Transfer-Encoding: chunked\r\n".freeze
-    CLOSE_CHUNKED = "0\r\n\r\n".freeze
+    CHUNKED = "chunked"
 
-    CHUNKED = "chunked".freeze
+    COLON = ": "
 
-    COLON = ": ".freeze
+    NEWLINE = "\n"
 
-    NEWLINE = "\n".freeze
-    HTTP_INJECTION_REGEX = /[\r\n]/.freeze
+    HIJACK_P = "rack.hijack?"
+    HIJACK = "rack.hijack"
+    HIJACK_IO = "rack.hijack_io"
 
-    HIJACK_P = "rack.hijack?".freeze
-    HIJACK = "rack.hijack".freeze
-    HIJACK_IO = "rack.hijack_io".freeze
+    EARLY_HINTS = "rack.early_hints"
 
-    EARLY_HINTS = "rack.early_hints".freeze
+    # Illegal character in the key or value of response header
+    DQUOTE = "\""
+    HTTP_HEADER_DELIMITER = Regexp.escape("(),/:;<=>?@[]{}\\").freeze
+    ILLEGAL_HEADER_KEY_REGEX = /[\x00-\x20#{DQUOTE}#{HTTP_HEADER_DELIMITER}]/.freeze
+    # header values can contain HTAB?
+    ILLEGAL_HEADER_VALUE_REGEX = /[\x00-\x08\x0A-\x1F]/.freeze
 
-    # Mininum interval to checks worker health
-    WORKER_CHECK_INTERVAL = 5
+    # 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