puma 3.0.0.rc1 → 5.0.0.beta1

data/lib/puma/const.rb

@@ -1,3 +1,6 @@
+#encoding: utf-8
+# frozen_string_literal: true
+
 module Puma
   class UnsupportedOption < RuntimeError
   end
@@ -52,6 +55,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 +64,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 +78,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 +100,9 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "3.0.0.rc1".freeze
-    CODE_NAME = "Schneems Sleak Shoes".freeze
+    PUMA_VERSION = VERSION = "5.0.0.beta1".freeze
+    CODE_NAME = "Spoony Bard".freeze
+    PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 
@@ -116,34 +118,35 @@ module Puma
     # sending data back
     WRITE_TIMEOUT = 10
 
-    DATE = "Date".freeze
-
-    SCRIPT_NAME = "SCRIPT_NAME".freeze
+    # 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
 
     PATH_INFO = 'PATH_INFO'.freeze
 
     PUMA_TMP_BASE = "puma".freeze
 
-    # Indicate that we couldn't parse the request
-    ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\n\r\n".freeze
-
-    # The standard empty 404 response for bad requests.  Use Error4040Handler for custom stuff.
-    ERROR_404_RESPONSE = "HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND".freeze
-
-    # The standard empty 408 response for requests that timed out.
-    ERROR_408_RESPONSE = "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze
-
-    CONTENT_LENGTH = "CONTENT_LENGTH".freeze
-
-    # Indicate that there was an internal error, obviously.
-    ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze
-
-    # A common header for indicating the server is too busy.  Not used yet.
-    ERROR_503_RESPONSE = "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY".freeze
+    ERROR_RESPONSE = {
+      # Indicate that we couldn't parse the request
+      400 => "HTTP/1.1 400 Bad Request\r\n\r\n".freeze,
+      # 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,
+      # 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,
+      # Indicate that there was an internal error, obviously.
+      500 => "HTTP/1.1 500 Internal Server Error\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
+    }
 
     # The basic max request size we'll try to read.
     CHUNK_SIZE = 16 * 1024
@@ -155,26 +158,15 @@ 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
+    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
 
     SERVER_NAME = "SERVER_NAME".freeze
     SERVER_PORT = "SERVER_PORT".freeze
@@ -183,11 +175,9 @@ module Puma
     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".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 +201,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 +214,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,12 +222,21 @@ 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
+    HTTP_INJECTION_REGEX = /[\r\n]/.freeze
 
     HIJACK_P = "rack.hijack?".freeze
     HIJACK = "rack.hijack".freeze
     HIJACK_IO = "rack.hijack_io".freeze
+
+    EARLY_HINTS = "rack.early_hints".freeze
+
+    # Mininum interval to checks worker health
+    WORKER_CHECK_INTERVAL = 5
+
   end
 end

data/lib/puma/control_cli.rb

@@ -1,13 +1,18 @@
+# frozen_string_literal: true
+
 require 'optparse'
-require 'puma/const'
-require 'puma/configuration'
-require 'yaml'
+require_relative 'state_file'
+require_relative 'const'
+require_relative 'detect'
+require_relative 'configuration'
 require 'uri'
 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 thread-backtraces refork}
+    PRINTABLE_COMMANDS = %w{gc-stats stats thread-backtraces}
 
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
       @state = nil
@@ -18,6 +23,7 @@ module Puma
       @control_auth_token = nil
       @config_file = nil
       @command = nil
+      @environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
 
       @argv = argv.dup
       @stdout = stdout
@@ -55,6 +61,11 @@ module Puma
           @config_file = arg
         end
 
+        o.on "-e", "--environment ENVIRONMENT",
+          "The environment to run the Rack app on (default development)" do |arg|
+          @environment = arg
+        end
+
         o.on_tail("-H", "--help", "Show this message") do
           @stdout.puts o
           exit
@@ -67,24 +78,11 @@ module Puma
       end
 
       opts.order!(argv) { |a| opts.terminate a }
+      opts.parse!
 
       @command = argv.shift
 
-      unless @config_file == '-'
-        if @config_file.nil? and File.exist?('config/puma.rb')
-          @config_file = 'config/puma.rb'
-        end
-
-        if @config_file
-          config = Puma::Configuration.from_file @config_file
-          @state ||= config.options[:state]
-          @control_url ||= config.options[:control_url]
-          @control_auth_token ||= config.options[:control_auth_token]
-          @pidfile ||= config.options[:pidfile]
-        end
-      end
-
-      # check present of command
+      # check presence of command
       unless @command
         raise "Available commands: #{COMMANDS.join(", ")}"
       end
@@ -93,6 +91,24 @@ module Puma
         raise "Invalid command: #{@command}"
       end
 
+      unless @config_file == '-'
+        environment = @environment || 'development'
+
+        if @config_file.nil?
+          @config_file = %W(config/puma/#{environment}.rb config/puma.rb).find do |f|
+            File.exist?(f)
+          end
+        end
+
+        if @config_file
+          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]
+        end
+      end
     rescue => e
       @stdout.puts e.message
       exit 1
@@ -108,7 +124,7 @@ module Puma
           raise "State file not found: #{@state}"
         end
 
-        sf = StateFile.new
+        sf = Puma::StateFile.new
         sf.load @state
 
         @control_url = sf.control_url
@@ -116,7 +132,7 @@ module Puma
         @pid = sf.pid
       elsif @pidfile
         # get pid from pid_file
-        @pid = File.open(@pidfile).gets.to_i
+        File.open(@pidfile) { |f| @pid = f.read.to_i }
       end
     end
 
@@ -124,7 +140,14 @@ module Puma
       uri = URI.parse @control_url
 
       # create server object by scheme
-      @server = case uri.scheme
+      server = case uri.scheme
+                when "ssl"
+                  require 'openssl'
+                  OpenSSL::SSL::SSLSocket.new(
+                    TCPSocket.new(uri.host, uri.port),
+                    OpenSSL::SSL::SSLContext.new)
+                    .tap { |ssl| ssl.sync_close = true }  # default is false
+                    .tap(&:connect)
                 when "tcp"
                   TCPSocket.new uri.host, uri.port
                 when "unix"
@@ -142,9 +165,9 @@ module Puma
           url = url + "?token=#{@control_auth_token}"
         end
 
-        @server << "GET #{url} HTTP/1.0\r\n\r\n"
+        server << "GET #{url} HTTP/1.0\r\n\r\n"
 
-        unless data = @server.read
+        unless data = server.read
           raise "Server closed connection before responding"
         end
 
@@ -165,10 +188,16 @@ module Puma
         end
 
         message "Command #{@command} sent success"
-        message response.last if @command == "stats"
+        message response.last if PRINTABLE_COMMANDS.include?(@command)
+      end
+    ensure
+      if server
+        if uri.scheme == "ssl"
+          server.sysclose
+        else
+          server.close unless server.closed?
+        end
       end
-
-      @server.close
     end
 
     def send_signal
@@ -177,46 +206,58 @@ 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
+        when "status"
+          begin
+            Process.kill 0, @pid
+            puts "Puma is started"
+          rescue Errno::ESRCH
+            raise "Puma is not running"
+          end
+
+          return
+
+        when "refork"
+          Process.kill "SIGURG", @pid
+
+        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
 
@@ -231,19 +272,19 @@ module Puma
       exit 1
     end
 
-  private
+    private
     def start
       require 'puma/cli'
 
-      run_args = @argv
+      run_args = []
 
-      if path = @state
-        run_args = ["-S", path] + run_args
-      end
-
-      if path = @config_file
-        run_args = ["-C", path] + run_args
-      end
+      run_args += ["-S", @state]  if @state
+      run_args += ["-q"] if @quiet
+      run_args += ["--pidfile", @pidfile] if @pidfile
+      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
+      run_args += ["-e", @environment] if @environment
 
       events = Puma::Events.new @stdout, @stderr