puma 2.16.0 → 3.11.4

data/lib/puma/configuration.rb

@@ -1,4 +1,6 @@
 require 'puma/rack/builder'
+require 'puma/plugin'
+require 'puma/const'
 
 module Puma
 
@@ -11,62 +13,204 @@ module Puma
     DefaultWorkerShutdownTimeout = 30
   end
 
+  # A class used for storing "leveled" configuration options.
+  #
+  # In this class any "user" specified options take precedence over any
+  # "file" specified options, take precedence over any "default" options.
+  #
+  # User input is prefered over "defaults":
+  #   user_options    = { foo: "bar" }
+  #   default_options = { foo: "zoo" }
+  #   options = UserFileDefaultOptions.new(user_options, default_options)
+  #   puts options[:foo]
+  #   # => "bar"
+  #
+  # All values can be accessed via `all_of`
+  #
+  #   puts options.all_of(:foo)
+  #   # => ["bar", "zoo"]
+  #
+  # A "file" option can be set. This config will be prefered over "default" options
+  # but will defer to any available "user" specified options.
+  #
+  #   user_options    = { foo: "bar" }
+  #   default_options = { rackup: "zoo.rb" }
+  #   options = UserFileDefaultOptions.new(user_options, default_options)
+  #   options.file_options[:rackup] = "sup.rb"
+  #   puts options[:rackup]
+  #   # => "sup.rb"
+  #
+  # The "default" options can be set via procs. These are resolved during runtime
+  # via calls to `finalize_values`
+  class UserFileDefaultOptions
+    def initialize(user_options, default_options)
+      @user_options    = user_options
+      @file_options    = {}
+      @default_options = default_options
+    end
+
+    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)
+    end
+
+    def []=(key, value)
+      user_options[key] = value
+    end
+
+    def fetch(key, default_value = nil)
+      self[key] || default_value
+    end
+
+    def all_of(key)
+      user    = user_options[key]
+      file    = file_options[key]
+      default = default_options[key]
+
+      user    = [user]    unless user.is_a?(Array)
+      file    = [file]    unless file.is_a?(Array)
+      default = [default] unless default.is_a?(Array)
+
+      user.compact!
+      file.compact!
+      default.compact!
+
+      user + file + default
+    end
+
+    def finalize_values
+      @default_options.each do |k,v|
+        if v.respond_to? :call
+          @default_options[k] = v.call
+        end
+      end
+    end
+  end
+
+  # The main configuration class of Puma.
+  #
+  # It can be initialized with a set of "user" options and "default" options.
+  # Defaults will be merged with `Configuration.puma_default_options`.
+  #
+  # This class works together with 2 main other classes the `UserFileDefaultOptions`
+  # which stores configuration options in order so the precedence is that user
+  # set configuration wins over "file" based configuration wins over "default"
+  # configuration. These configurations are set via the `DSL` class. This
+  # class powers the Puma config file syntax and does double duty as a configuration
+  # DSL used by the `Puma::CLI` and Puma rack handler.
+  #
+  # It also handles loading plugins.
+  #
+  # > Note: `:port` and `:host` are not valid keys. By they 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
+  #
+  # 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
+  # correct configuration option hash.
+  #
+  # Once all configuration is complete it is expected that `clamp` will be called
+  # on the instance. This will expand any procs stored under "default" values. This
+  # is done because an environment variable may have been modified while loading
+  # configuration files.
   class Configuration
     include ConfigDefault
 
-    def initialize(options)
-      @cli_options = options
+    def initialize(user_options={}, default_options = {}, &block)
+      default_options = self.puma_default_options.merge(default_options)
 
-      @conf = {}
-      @conf[:mode] ||= :http
-      @conf[:binds] ||= []
-      @conf[:on_restart] ||= []
-      @conf[:before_fork] ||= []
-      @conf[:before_worker_shutdown] ||= []
-      @conf[:before_worker_boot] ||= []
-      @conf[:before_worker_fork] ||= []
-      @conf[:after_worker_boot] ||= []
-      @conf[:worker_timeout] ||= DefaultWorkerTimeout
-      @conf[:worker_boot_timeout] ||= @conf[:worker_timeout]
-      @conf[:worker_shutdown_timeout] ||= DefaultWorkerShutdownTimeout
-      @conf[:remote_address] ||= :socket
+      @options     = UserFileDefaultOptions.new(user_options, default_options)
+      @plugins     = PluginLoader.new
+      @user_dsl    = DSL.new(@options.user_options, self)
+      @file_dsl    = DSL.new(@options.file_options, self)
+      @default_dsl = DSL.new(@options.default_options, self)
 
-      @options = {}
+      if block
+        configure(&block)
+      end
     end
 
-    attr_reader :options
+    attr_reader :options, :plugins
+
+    def configure
+      yield @user_dsl, @file_dsl, @default_dsl
+    ensure
+      @user_dsl._offer_plugins
+      @file_dsl._offer_plugins
+      @default_dsl._offer_plugins
+    end
 
     def initialize_copy(other)
-      @conf = nil
+      @conf        = nil
       @cli_options = nil
-      @options = @options.dup
+      @options     = @options.dup
+    end
+
+    def flatten
+      dup.flatten!
+    end
+
+    def flatten!
+      @options = @options.flatten
+      self
     end
 
-    def default_options
+    def puma_default_options
       {
         :min_threads => 0,
         :max_threads => 16,
-        :quiet => false,
+        :log_requests => false,
         :debug => false,
-        :binds => [],
+        :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
       }
     end
 
     def load
-      @conf.merge! @cli_options
-      DSL.load(@conf, @cli_options[:config_file])
+      config_files.each { |config_file| @file_dsl._load_from(config_file) }
 
-      # Load the options in the right priority
-      #
-      @options.merge! default_options
-      @options.merge! @conf
-      @options.merge! @cli_options
+      @options
+    end
+
+    def config_files
+      files = @options.all_of(:config_files)
+
+      return [] if files == ['-']
+      return files if files.any?
+
+      first_default_file = %W(config/puma/#{environment_str}.rb config/puma.rb).find do |f|
+        File.exist?(f)
+      end
+
+      [first_default_file]
+    end
 
-      setup_binds
-      setup_control
-      @options[:tag] ||= infer_tag
+    # Call once all configuration (included from rackup files)
+    # is loaded to flesh out any defaults
+    def clamp
+      @options.finalize_values
     end
 
     # Injects the Configuration object into the env
@@ -89,7 +233,7 @@ module Puma
     end
 
     def rackup
-      @options[:rackup] || DefaultRackup
+      @options[:rackup]
     end
 
     # Load the specified rackup file, pull options from
@@ -101,18 +245,37 @@ module Puma
       if @options[:mode] == :tcp
         require 'puma/tcp_logger'
 
-        logger = @options[:logger] || STDOUT
-        return TCPLogger.new(logger, found, @options[:quiet])
+        logger = @options[:logger]
+        quiet = !@options[:log_requests]
+        return TCPLogger.new(logger, found, quiet)
       end
 
-      if !@options[:quiet] and @options[:environment] == "development"
-        logger = @options[:logger] || STDOUT
+      if @options[:log_requests]
+        require 'puma/commonlogger'
+        logger = @options[:logger]
         found = CommonLogger.new(found, logger)
       end
 
       ConfigMiddleware.new(self, found)
     end
 
+    # Return which environment we're running in
+    def environment
+      @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 }
+    end
+
     def self.temp_path
       require 'tmpdir'
 
@@ -153,43 +316,19 @@ module Puma
       raise "Missing rackup file '#{rackup}'" unless File.exist?(rackup)
 
       rack_app, rack_options = rack_builder.parse_file(rackup)
-      @options.merge!(rack_options)
+      @options.file_options.merge!(rack_options)
 
       config_ru_binds = []
       rack_options.each do |k, v|
         config_ru_binds << v if k.to_s.start_with?("bind")
       end
-      @options[:binds] = config_ru_binds unless config_ru_binds.empty?
 
-      rack_app
-    end
+      @options.file_options[:binds] = config_ru_binds unless config_ru_binds.empty?
 
-    def setup_binds
-      # Rakeup default option support
-      host = @options[:Host]
-      if host
-        port = @options[:Port] || DefaultTCPPort
-        @options[:binds] << "tcp://#{host}:#{port}"
-      end
-
-      if @options[:binds].empty?
-        @options[:binds] << "tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"
-      end
-
-      @options[:binds].uniq!
-    end
-
-    def setup_control
-      if @options[:control_url] == 'auto'
-        path = Configuration.temp_path
-        @options[:control_url] = "unix://#{path}"
-        @options[:control_url_temp] = path
-      end
-
-      setup_random_token unless @options[:control_auth_token]
+      rack_app
     end
 
-    def setup_random_token
+    def self.random_token
       begin
         require 'openssl'
       rescue LoadError
@@ -206,13 +345,13 @@ module Puma
       end
 
       if bytes
-        token = ""
+        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
 
-      @options[:control_auth_token] = token
+      return token
     end
   end
 end

data/lib/puma/const.rb

@@ -1,3 +1,4 @@
+#encoding: utf-8
 module Puma
   class UnsupportedOption < RuntimeError
   end
@@ -52,6 +53,8 @@ module Puma
     415 => 'Unsupported Media Type',
     416 => 'Range Not Satisfiable',
     417 => 'Expectation Failed',
+    418 => 'I\'m A Teapot',
+    421 => 'Misdirected Request',
     422 => 'Unprocessable Entity',
     423 => 'Locked',
     424 => 'Failed Dependency',
@@ -59,6 +62,7 @@ module Puma
     428 => 'Precondition Required',
     429 => 'Too Many Requests',
     431 => 'Request Header Fields Too Large',
+    451 => 'Unavailable For Legal Reasons',
     500 => 'Internal Server Error',
     501 => 'Not Implemented',
     502 => 'Bad Gateway',
@@ -72,19 +76,14 @@ module Puma
     511 => 'Network Authentication Required'
   }
 
-  SYMBOL_TO_STATUS_CODE = Hash[*HTTP_STATUS_CODES.map { |code, message|
-    [message.downcase.gsub(/\s|-|'/, '_').to_sym, code]
-  }.flatten]
-
   # For some HTTP status codes the client only expects headers.
   #
 
-  no_body = {}
-  ((100..199).to_a << 204 << 205 << 304).each do |code|
-    no_body[code] = true
-  end
-
-  STATUS_WITH_NO_ENTITY_BODY = no_body
+  STATUS_WITH_NO_ENTITY_BODY = {
+    204 => true,
+    205 => true,
+    304 => true
+  }
 
   # Frequently used constants when constructing requests or responses.  Many times
   # the constant just refers to a string with the same contents.  Using these constants
@@ -99,8 +98,9 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.16.0".freeze
-    CODE_NAME = "Midwinter Nights Trance".freeze
+    PUMA_VERSION = VERSION = "3.11.4".freeze
+    CODE_NAME = "Love Song".freeze
+    PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 
@@ -116,13 +116,10 @@ module Puma
     # sending data back
     WRITE_TIMEOUT = 10
 
-    DATE = "Date".freeze
-
-    SCRIPT_NAME = "SCRIPT_NAME".freeze
-
     # The original URI requested by the client.
     REQUEST_URI= 'REQUEST_URI'.freeze
     REQUEST_PATH = 'REQUEST_PATH'.freeze
+    QUERY_STRING = 'QUERY_STRING'.freeze
 
     PATH_INFO = 'PATH_INFO'.freeze
 
@@ -155,26 +152,12 @@ module Puma
     # Maximum request body size before it is moved out of memory and into a tempfile for reading.
     MAX_BODY = MAX_HEADER
 
-    # A frozen format for this is about 15% faster
-    STATUS_FORMAT = "HTTP/1.1 %d %s\r\nConnection: close\r\n".freeze
-
-    CONTENT_TYPE = "Content-Type".freeze
-
-    LAST_MODIFIED = "Last-Modified".freeze
-    ETAG = "ETag".freeze
-    SLASH = "/".freeze
     REQUEST_METHOD = "REQUEST_METHOD".freeze
-    GET = "GET".freeze
     HEAD = "HEAD".freeze
     # ETag is based on the apache standard of hex mtime-size-inode (inode is 0 on win32)
-    ETAG_FORMAT = "\"%x-%x-%x\"".freeze
     LINE_END = "\r\n".freeze
     REMOTE_ADDR = "REMOTE_ADDR".freeze
     HTTP_X_FORWARDED_FOR = "HTTP_X_FORWARDED_FOR".freeze
-    HTTP_IF_MODIFIED_SINCE = "HTTP_IF_MODIFIED_SINCE".freeze
-    HTTP_IF_NONE_MATCH = "HTTP_IF_NONE_MATCH".freeze
-    REDIRECT = "HTTP/1.1 302 Found\r\nLocation: %s\r\nConnection: close\r\n\r\n".freeze
-    HOST = "HOST".freeze
 
     SERVER_NAME = "SERVER_NAME".freeze
     SERVER_PORT = "SERVER_PORT".freeze
@@ -187,7 +170,6 @@ module Puma
 
     SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
     HTTP_11 = "HTTP/1.1".freeze
-    HTTP_10 = "HTTP/1.0".freeze
 
     SERVER_SOFTWARE = "SERVER_SOFTWARE".freeze
     GATEWAY_INTERFACE = "GATEWAY_INTERFACE".freeze
@@ -211,7 +193,10 @@ module Puma
 
     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".freeze
     HTTP_11_200 = "HTTP/1.1 200 OK\r\n".freeze
     HTTP_10_200 = "HTTP/1.0 200 OK\r\n".freeze
 
@@ -221,6 +206,7 @@ module Puma
     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".freeze
     CONNECTION_KEEP_ALIVE = "Connection: Keep-Alive\r\n".freeze
@@ -228,6 +214,8 @@ module Puma
     TRANSFER_ENCODING_CHUNKED = "Transfer-Encoding: chunked\r\n".freeze
     CLOSE_CHUNKED = "0\r\n\r\n".freeze
 
+    CHUNKED = "chunked".freeze
+
     COLON = ": ".freeze
 
     NEWLINE = "\n".freeze
@@ -235,5 +223,7 @@ module Puma
     HIJACK_P = "rack.hijack?".freeze
     HIJACK = "rack.hijack".freeze
     HIJACK_IO = "rack.hijack_io".freeze
+
+    EARLY_HINTS = "rack.early_hints".freeze
   end
 end