puma 3.4.0 → 3.12.0

data/lib/puma/const.rb

@@ -53,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',
@@ -60,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',
@@ -73,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
@@ -100,10 +98,10 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "3.4.0".freeze
-    CODE_NAME = "Owl Bowl Brawl".freeze
+    PUMA_VERSION = VERSION = "3.12.0".freeze
+    CODE_NAME = "Llamas in Pajamas".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
@@ -118,15 +116,6 @@ module Puma
     # sending data back
     WRITE_TIMEOUT = 10
 
-    # How long, after raising the ForceShutdown of a thread during
-    # forced shutdown mode, to wait for the thread to try and finish
-    # up it's work before leaving the thread to die on the vine.
-    SHUTDOWN_GRACE_TIME = 5 # seconds
-
-    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
@@ -163,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
@@ -195,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
@@ -219,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
 
@@ -229,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
@@ -236,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
@@ -243,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

data/lib/puma/control_cli.rb

@@ -1,5 +1,5 @@
 require 'optparse'
-require 'puma'
+require 'puma/state_file'
 require 'puma/const'
 require 'puma/detect'
 require 'puma/configuration'
@@ -9,7 +9,7 @@ require 'socket'
 module Puma
   class ControlCLI
 
-    COMMANDS = %w{halt restart phased-restart start stats status stop reload-worker-directory}
+    COMMANDS = %w{halt restart phased-restart start stats status stop reload-worker-directory gc gc-stats}
 
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
       @state = nil
@@ -69,6 +69,7 @@ module Puma
       end
 
       opts.order!(argv) { |a| opts.terminate a }
+      opts.parse!
 
       @command = argv.shift
 
@@ -78,11 +79,12 @@ module Puma
         end
 
         if @config_file
-          config = Puma::Configuration.from_file @config_file
-          @state ||= config.options[:state]
-          @control_url ||= config.options[:control_url]
+          config = Puma::Configuration.new({ config_files: [@config_file] }, {})
+          config.load
+          @state              ||= config.options[:state]
+          @control_url        ||= config.options[:control_url]
           @control_auth_token ||= config.options[:control_auth_token]
-          @pidfile ||= config.options[:pidfile]
+          @pidfile            ||= config.options[:pidfile]
         end
       end
 
@@ -97,6 +99,7 @@ module Puma
 
     rescue => e
       @stdout.puts e.message
+      @stdout.puts e.backtrace
       exit 1
     end
 
@@ -167,7 +170,7 @@ module Puma
         end
 
         message "Command #{@command} sent success"
-        message response.last if @command == "stats"
+        message response.last if @command == "stats" || @command == "gc-stats"
       end
 
       @server.close
@@ -179,46 +182,45 @@ module Puma
       end
 
       begin
-        Process.getpgid @pid
-      rescue SystemCallError
-        if @command == "restart"
-          start
-        else
-          raise "No pid '#{@pid}' found"
-        end
-      end
 
-      case @command
-      when "restart"
-        Process.kill "SIGUSR2", @pid
+        case @command
+        when "restart"
+          Process.kill "SIGUSR2", @pid
 
-      when "halt"
-        Process.kill "QUIT", @pid
+        when "halt"
+          Process.kill "QUIT", @pid
 
-      when "stop"
-        Process.kill "SIGTERM", @pid
+        when "stop"
+          Process.kill "SIGTERM", @pid
 
-      when "stats"
-        puts "Stats not available via pid only"
-        return
+        when "stats"
+          puts "Stats not available via pid only"
+          return
 
-      when "reload-worker-directory"
-        puts "reload-worker-directory not available via pid only"
-        return
+        when "reload-worker-directory"
+          puts "reload-worker-directory not available via pid only"
+          return
 
-      when "phased-restart"
-        Process.kill "SIGUSR1", @pid
+        when "phased-restart"
+          Process.kill "SIGUSR1", @pid
 
-      else
-        message "Puma is started"
-        return
+        else
+          return
+        end
+
+      rescue SystemCallError
+        if @command == "restart"
+          start
+        else
+          raise "No pid '#{@pid}' found"
+        end
       end
 
       message "Command #{@command} sent success"
     end
 
     def run
-      start if @command == "start"
+      return start if @command == "start"
 
       prepare_configuration
 
@@ -230,6 +232,7 @@ module Puma
 
     rescue => e
       message e.message
+      message e.backtrace
       exit 1
     end
 
@@ -242,7 +245,7 @@ module Puma
       run_args += ["-S", @state]  if @state
       run_args += ["-q"] if @quiet
       run_args += ["--pidfile", @pidfile] if @pidfile
-      run_args += ["--control", @control_url] if @control_url
+      run_args += ["--control-url", @control_url] if @control_url
       run_args += ["--control-token", @control_auth_token] if @control_auth_token
       run_args += ["-C", @config_file] if @config_file
 

data/lib/puma/convenient.rb

@@ -3,12 +3,12 @@ require 'puma/configuration'
 
 module Puma
   def self.run(opts={})
-    cfg = Puma::Configuration.new do |c|
+    cfg = Puma::Configuration.new do |user_config|
       if port = opts[:port]
-        c.port port
+        user_config.port port
       end
 
-      c.quiet
+      user_config.quiet
 
       yield c
     end

data/lib/puma/detect.rb

@@ -5,7 +5,9 @@ module Puma
     IS_JRUBY
   end
 
+  IS_WINDOWS = RUBY_PLATFORM =~ /mswin|ming|cygwin/
+
   def self.windows?
-    RUBY_PLATFORM =~ /mswin32|ming32/
+    IS_WINDOWS
   end
 end

data/lib/puma/dsl.rb

@@ -1,20 +1,35 @@
 module Puma
   # The methods that are available for use inside the config file.
+  # These same methods are used in Puma cli and the rack handler
+  # internally.
   #
+  # Used manually (via CLI class):
+  #
+  #   config = Configuration.new({}) do |user_config|
+  #     user_config.port 3001
+  #   end
+  #   config.load
+  #
+  #   puts config.options[:binds]
+  #   "tcp://127.0.0.1:3001"
+  #
+  # Used to load file:
+  #
+  #   $ cat puma_config.rb
+  #     port 3002
+  #
+  #   config = Configuration.new(config_file: "puma_config.rb")
+  #   config.load
+  #
+  #   puts config.options[:binds]
+  #   # => "tcp://127.0.0.1:3002"
+  #
+  # Detailed docs can be found in `examples/config.rb`
   class DSL
     include ConfigDefault
 
-    def self.load(options, cfg, path)
-      d = new(options, cfg)
-      d._load_from(path)
-
-      options
-    ensure
-      d._offer_plugins
-    end
-
     def initialize(options, config)
-      @config = config
+      @config  = config
       @options = options
 
       @plugins = []
@@ -40,36 +55,10 @@ module Puma
       @plugins.clear
     end
 
-    def _run(&blk)
-      blk.call self
-    ensure
-      _offer_plugins
-    end
-
     def inject(&blk)
       instance_eval(&blk)
     end
 
-    # Load configuration from another named file. If the file name is absolute,
-    # load the file as an absolute path. Otherwise load it relative to the
-    # current config file.
-    #
-    def import(file)
-      if File.extname(file) == ""
-        file += ".rb"
-      end
-
-      if file[0,1] == "/"
-        path = file
-      elsif @path
-        path = File.join File.dirname(@path), file
-      else
-        raise "No original configuration path to import relative to"
-      end
-
-      DSL.new(@options, @config)._load_from(path)
-    end
-
     def get(key,default=nil)
       @options[key.to_sym] || default
     end
@@ -115,15 +104,35 @@ module Puma
     end
 
     # Load additional configuration from a file
+    # Files get loaded later via Configuration#load
     def load(file)
-      _ary(:config_files) << file
+      @options[:config_files] ||= []
+      @options[:config_files] << file
     end
 
-    # Bind the server to +url+. tcp:// and unix:// are the only accepted
-    # protocols.
+    # Adds a binding for the server to +url+. tcp://, unix://, and ssl:// are the only accepted
+    # protocols. Use query parameters within the url to specify options.
+    #
+    # @note multiple urls can be bound to, calling `bind` does not overwrite previous bindings.
+    #
+    # @example Explicitly the socket backlog depth (default is 1024)
+    #   bind('unix:///var/run/puma.sock?backlog=2048')
     #
+    # @example Set up ssl cert
+    #   bind('ssl://127.0.0.1:9292?key=key.key&cert=cert.pem')
+    #
+    # @example Prefer low-latency over higher throughput (via `Socket::TCP_NODELAY`)
+    #   bind('tcp://0.0.0.0:9292?low_latency=true')
+    #
+    # @example Set socket permissions
+    #   bind('unix:///var/run/puma.sock?umask=0111')
     def bind(url)
-      _ary(:binds) << url
+      @options[:binds] ||= []
+      @options[:binds] << url
+    end
+
+    def clear_binds!
+      @options[:binds] = []
     end
 
     # Define the TCP port to bind to. Use +bind+ for more advanced options.
@@ -133,6 +142,19 @@ module Puma
       bind "tcp://#{host}:#{port}"
     end
 
+    # Define how long persistent connections can be idle before puma closes
+    # them
+    #
+    def persistent_timeout(seconds)
+      @options[:persistent_timeout] = Integer(seconds)
+    end
+
+    # Define how long the tcp socket stays open, if no data has been received
+    #
+    def first_data_timeout(seconds)
+      @options[:first_data_timeout] = Integer(seconds)
+    end
+
     # Work around leaky apps that leave garbage in Thread locals
     # across requests
     #
@@ -147,7 +169,7 @@ module Puma
     end
 
     # When shutting down, drain the accept socket of pending
-    # connections and proces them. This loops over the accept
+    # connections and process them. This loops over the accept
     # socket until there are no more read events and then stops
     # looking and waits for the requests to finish.
     def drain_on_shutdown(which=true)
@@ -185,7 +207,8 @@ module Puma
     # This can be called multiple times to add code each time.
     #
     def on_restart(&block)
-      _ary(:on_restart) << block
+      @options[:on_restart] ||= []
+      @options[:on_restart] << block
     end
 
     # Command to use to restart puma. This should be just how to
@@ -231,6 +254,10 @@ module Puma
       @options[:mode] = :tcp
     end
 
+    def early_hints(answer=true)
+      @options[:early_hints] = answer
+    end
+
     # Redirect STDOUT and STDERR to files specified.
     def stdout_redirect(stdout=nil, stderr=nil, append=false)
       @options[:redirect_stdout] = stdout
@@ -257,11 +284,13 @@ module Puma
     end
 
     def ssl_bind(host, port, opts)
+      verify = opts.fetch(:verify_mode, 'none')
+
       if defined?(JRUBY_VERSION)
         keystore_additions = "keystore=#{opts[:keystore]}&keystore-pass=#{opts[:keystore_pass]}"
-        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}"
+        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}&verify_mode=#{verify}"
       else
-        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}"
+        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&verify_mode=#{verify}"
       end
     end
 
@@ -288,7 +317,8 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def before_fork(&block)
-      _ary(:before_fork) << block
+      @options[:before_fork] ||= []
+      @options[:before_fork] << block
     end
 
     # *Cluster mode only* Code to run in a worker when it boots to setup
@@ -297,7 +327,8 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def on_worker_boot(&block)
-      _ary(:before_worker_boot) << block
+      @options[:before_worker_boot] ||= []
+      @options[:before_worker_boot] << block
     end
 
     # *Cluster mode only* Code to run immediately before a worker shuts
@@ -308,7 +339,8 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def on_worker_shutdown(&block)
-      _ary(:before_worker_shutdown) << block
+      @options[:before_worker_shutdown] ||= []
+      @options[:before_worker_shutdown] << block
     end
 
     # *Cluster mode only* Code to run in the master when it is
@@ -317,7 +349,8 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def on_worker_fork(&block)
-      _ary(:before_worker_fork) << block
+      @options[:before_worker_fork] ||= []
+      @options[:before_worker_fork] << block
     end
 
     # *Cluster mode only* Code to run in the master after it starts
@@ -326,7 +359,8 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def after_worker_fork(&block)
-      _ary(:after_worker_fork) << block
+      @options[:after_worker_fork] ||= []
+      @options[:after_worker_fork] = block
     end
 
     alias_method :after_worker_boot, :after_worker_fork
@@ -390,17 +424,17 @@ module Puma
     # that have not checked in within the given +timeout+.
     # This mitigates hung processes. Default value is 60 seconds.
     def worker_timeout(timeout)
-      @options[:worker_timeout] = timeout
+      @options[:worker_timeout] = Integer(timeout)
     end
 
     # *Cluster mode only* Set the timeout for workers to boot
     def worker_boot_timeout(timeout)
-      @options[:worker_boot_timeout] = timeout
+      @options[:worker_boot_timeout] = Integer(timeout)
     end
 
     # *Cluster mode only* Set the timeout for worker shutdown
     def worker_shutdown_timeout(timeout)
-      @options[:worker_shutdown_timeout] = timeout
+      @options[:worker_shutdown_timeout] = Integer(timeout)
     end
 
     # When set to true (the default), workers accept all requests
@@ -468,10 +502,5 @@ module Puma
       end
     end
 
-    private
-
-    def _ary(key)
-      (@options.cur[key] ||= [])
-    end
   end
 end