puma 4.3.12 → 5.0.0.beta1

data/lib/puma/binder.rb

@@ -11,7 +11,7 @@ module Puma
   class Binder
     include Puma::Const
 
-    RACK_VERSION = [1,3].freeze
+    RACK_VERSION = [1,6].freeze
 
     def initialize(events)
       @events = events
@@ -43,7 +43,8 @@ module Puma
       @ios = []
     end
 
-    attr_reader :ios
+    attr_reader :ios, :listeners, :unix_paths, :proto_env, :envs, :activated_sockets, :inherited_fds
+    attr_writer :ios, :listeners
 
     def env(sock)
       @envs.fetch(sock, @proto_env)
@@ -53,40 +54,39 @@ module Puma
       @ios.each { |i| i.close }
     end
 
-    def import_from_env
-      remove = []
-
-      ENV.each do |k,v|
-        if k =~ /PUMA_INHERIT_\d+/
-          fd, url = v.split(":", 2)
-          @inherited_fds[url] = fd.to_i
-          remove << k
-        elsif k == 'LISTEN_FDS' && ENV['LISTEN_PID'].to_i == $$
-          v.to_i.times do |num|
-            fd = num + 3
-            sock = TCPServer.for_fd(fd)
-            begin
-              key = [ :unix, Socket.unpack_sockaddr_un(sock.getsockname) ]
-            rescue ArgumentError
-              port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
-              if addr =~ /\:/
-                addr = "[#{addr}]"
-              end
-              key = [ :tcp, addr, port ]
-            end
-            @activated_sockets[key] = sock
-            @events.debug "Registered #{key.join ':'} for activation from LISTEN_FDS"
-          end
-          remove << k << 'LISTEN_PID'
-        end
-      end
+    def connected_ports
+      ios.map { |io| io.addr[1] }.uniq
+    end
+
+    def create_inherited_fds(env_hash)
+      env_hash.select {|k,v| k =~ /PUMA_INHERIT_\d+/}.each do |_k, v|
+        fd, url = v.split(":", 2)
+        @inherited_fds[url] = fd.to_i
+      end.keys # pass keys back for removal
+    end
 
-      remove.each do |k|
-        ENV.delete k
+    # systemd socket activation.
+    # LISTEN_FDS = number of listening sockets. e.g. 2 means accept on 2 sockets w/descriptors 3 and 4.
+    # LISTEN_PID = PID of the service process, aka us
+    # see https://www.freedesktop.org/software/systemd/man/systemd-socket-activate.html
+    def create_activated_fds(env_hash)
+      return [] unless env_hash['LISTEN_FDS'] && env_hash['LISTEN_PID'].to_i == $$
+      env_hash['LISTEN_FDS'].to_i.times do |index|
+        sock = TCPServer.for_fd(socket_activation_fd(index))
+        key = begin # Try to parse as a path
+          [:unix, Socket.unpack_sockaddr_un(sock.getsockname)]
+        rescue ArgumentError # Try to parse as a port/ip
+          port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
+          addr = "[#{addr}]" if addr =~ /\:/
+          [:tcp, addr, port]
+        end
+        @activated_sockets[key] = sock
+        @events.debug "Registered #{key.join ':'} for activation from LISTEN_FDS"
       end
+      ["LISTEN_FDS", "LISTEN_PID"] # Signal to remove these keys from ENV
     end
 
-    def parse(binds, logger)
+    def parse(binds, logger, log_msg = 'Listening')
       binds.each do |str|
         uri = URI.parse str
         case uri.scheme
@@ -113,7 +113,7 @@ module Puma
                 i.local_address.ip_unpack.join(':')
               end
 
-              logger.log "* Listening on tcp://#{addr}"
+              logger.log "* #{log_msg} on tcp://#{addr}"
             end
           end
 
@@ -149,7 +149,7 @@ module Puma
             end
 
             io = add_unix_listener path, umask, mode, backlog
-            logger.log "* Listening on #{str}"
+            logger.log "* #{log_msg} on #{str}"
           end
 
           @listeners << [str, io]
@@ -204,12 +204,6 @@ module Puma
       end
     end
 
-    def loopback_addresses
-      Socket.ip_address_list.select do |addrinfo|
-        addrinfo.ipv6_loopback? || addrinfo.ipv4_loopback?
-      end.map { |addrinfo| addrinfo.ip_address }.uniq
-    end
-
     # Tell the server to listen on host +host+, port +port+.
     # If +optimize_for_latency+ is true (the default) then clients connecting
     # will be optimized for latency over throughput.
@@ -226,20 +220,17 @@ module Puma
       end
 
       host = host[1..-2] if host and host[0..0] == '['
-      s = TCPServer.new(host, port)
+      tcp_server = TCPServer.new(host, port)
       if optimize_for_latency
-        s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        tcp_server.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
       end
-      s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
-      s.listen backlog
-      @connected_port = s.addr[1]
+      tcp_server.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
+      tcp_server.listen backlog
 
-      @ios << s
-      s
+      @ios << tcp_server
+      tcp_server
     end
 
-    attr_reader :connected_port
-
     def inherit_tcp_listener(host, port, fd)
       if fd.kind_of? TCPServer
         s = fd
@@ -360,26 +351,37 @@ module Puma
     end
 
     def close_listeners
-      @listeners.each do |l, io|
-        io.close
+      listeners.each do |l, io|
+        io.close unless io.closed? # Ruby 2.2 issue
         uri = URI.parse(l)
         next unless uri.scheme == 'unix'
         unix_path = "#{uri.host}#{uri.path}"
-        File.unlink unix_path if @unix_paths.include? unix_path
+        File.unlink unix_path if unix_paths.include? unix_path
       end
     end
 
-    def close_unix_paths
-      @unix_paths.each { |up| File.unlink(up) if File.exist? up }
+    def redirects_for_restart
+      redirects = listeners.map { |a| [a[1].to_i, a[1].to_i] }.to_h
+      redirects[:close_others] = true
+      redirects
     end
 
-    def redirects_for_restart
-      redirects = {:close_others => true}
-      @listeners.each_with_index do |(l, io), i|
-        ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}"
-        redirects[io.to_i] = io.to_i
+    def redirects_for_restart_env
+      listeners.each_with_object({}).with_index do |(listen, memo), i|
+        memo["PUMA_INHERIT_#{i}"] = "#{listen[1].to_i}:#{listen[0]}"
       end
-      redirects
+    end
+
+    private
+
+    def loopback_addresses
+      Socket.ip_address_list.select do |addrinfo|
+        addrinfo.ipv6_loopback? || addrinfo.ipv4_loopback?
+      end.map { |addrinfo| addrinfo.ip_address }.uniq
+    end
+
+    def socket_activation_fd(int)
+      int + 3 # 3 is the magic number you add to follow the SA protocol
     end
   end
 end

data/lib/puma/cli.rb

@@ -80,7 +80,7 @@ module Puma
       @launcher.run
     end
 
-  private
+    private
     def unsupported(str)
       @events.error(str)
       raise UnsupportedOption
@@ -112,21 +112,11 @@ module Puma
             configure_control_url(arg)
           end
 
-          # alias --control-url for backwards-compatibility
-          o.on "--control URL", "DEPRECATED alias for --control-url" do |arg|
-            configure_control_url(arg)
-          end
-
           o.on "--control-token TOKEN",
             "The token to use as authentication for the control server" do |arg|
             @control_options[:auth_token] = arg
           end
 
-          o.on "-d", "--daemon", "Daemonize the server into the background" do
-            user_config.daemonize
-            user_config.quiet
-          end
-
           o.on "--debug", "Log lowlevel debugging information" do
             user_config.debug
           end
@@ -140,6 +130,12 @@ module Puma
             user_config.environment arg
           end
 
+          o.on "-f", "--fork-worker=[REQUESTS]", OptionParser::DecimalInteger,
+            "Fork new workers from existing worker. Cluster mode only",
+            "Auto-refork after REQUESTS (default 1000)" do |*args|
+            user_config.fork_worker(*args.compact)
+          end
+
           o.on "-I", "--include PATH", "Specify $LOAD_PATH directories" do |arg|
             $LOAD_PATH.unshift(*arg.split(':'))
           end
@@ -192,10 +188,6 @@ module Puma
             end
           end
 
-          o.on "--tcp-mode", "Run the app in raw TCP mode instead of HTTP mode" do
-            user_config.tcp_mode!
-          end
-
           o.on "--early-hints", "Enable early hints support" do
             user_config.early_hints
           end

data/lib/puma/client.rb

@@ -23,8 +23,6 @@ module Puma
 
   class ConnectionError < RuntimeError; end
 
-  class HttpParserError501 < IOError; end
-
   # An instance of this class represents a unique request from a client.
   # For example, this could be a web request from a browser or from CURL.
   #
@@ -37,21 +35,7 @@ module Puma
   # Instances of this class are responsible for knowing if
   # the header and body are fully buffered via the `try_to_finish` method.
   # They can be used to "time out" a response via the `timeout_at` reader.
-  #
   class Client
-
-    # this tests all values but the last, which must be chunked
-    ALLOWED_TRANSFER_ENCODING = %w[compress deflate gzip].freeze
-
-    # chunked body validation
-    CHUNK_SIZE_INVALID = /[^\h]/.freeze
-    CHUNK_VALID_ENDING = "\r\n".freeze
-
-    # Content-Length header value validation
-    CONTENT_LENGTH_VALUE_INVALID = /[^\d]/.freeze
-
-    TE_ERR_MSG = 'Invalid Transfer-Encoding'
-
     # The object used for a request with no body. All requests with
     # no body share this one object since it has no state.
     EmptyBody = NullIO.new
@@ -254,12 +238,23 @@ module Puma
         return false unless IO.select([@to_io], nil, nil, 0)
         try_to_finish
       end
+
+      # For documentation, see https://github.com/puma/puma/issues/1754
+      send(:alias_method, :jruby_eagerly_finish, :eagerly_finish)
     end # IS_JRUBY
 
-    def finish
+    def finish(timeout)
       return true if @ready
       until try_to_finish
-        IO.select([@to_io], nil, nil)
+        can_read = begin
+          IO.select([@to_io], nil, nil, timeout)
+        rescue ThreadPool::ForceShutdown
+          nil
+        end
+        unless can_read
+          write_error(408) if in_data_phase
+          raise ConnectionError
+        end
       end
       true
     end
@@ -275,7 +270,7 @@ module Puma
       return @peerip if @peerip
 
       if @remote_addr_header
-        hdr = (@env[@remote_addr_header] || LOCALHOST_ADDR).split(/[\s,]/).first
+        hdr = (@env[@remote_addr_header] || LOCALHOST_IP).split(/[\s,]/).first
         @peerip = hdr
         return hdr
       end
@@ -283,6 +278,18 @@ module Puma
       @peerip ||= @io.peeraddr.last
     end
 
+    # Returns true if the persistent connection can be closed immediately
+    # without waiting for the configured idle/shutdown timeout.
+    def can_close?
+      # Allow connection to close if it's received at least one full request
+      # and hasn't received any data for a future request.
+      #
+      # From RFC 2616 section 8.1.4:
+      # Servers SHOULD always respond to at least one request per connection,
+      # if at all possible.
+      @requests_served > 0 && @parsed_bytes == 0
+    end
+
     private
 
     def setup_body
@@ -300,40 +307,16 @@ module Puma
       body = @parser.body
 
       te = @env[TRANSFER_ENCODING2]
-      if te
-        te_lwr = te.downcase
-        if te.include? ','
-          te_ary = te_lwr.split ','
-          te_count = te_ary.count CHUNKED
-          te_valid = te_ary[0..-2].all? { |e| ALLOWED_TRANSFER_ENCODING.include? e }
-          if te_ary.last == CHUNKED && te_count == 1 && te_valid
-            @env.delete TRANSFER_ENCODING2
-            return setup_chunked_body body
-          elsif te_count >= 1
-            raise HttpParserError   , "#{TE_ERR_MSG}, multiple chunked: '#{te}'"
-          elsif !te_valid
-            raise HttpParserError501, "#{TE_ERR_MSG}, unknown value: '#{te}'"
-          end
-        elsif te_lwr == CHUNKED
-          @env.delete TRANSFER_ENCODING2
-          return setup_chunked_body body
-        elsif ALLOWED_TRANSFER_ENCODING.include? te_lwr
-          raise HttpParserError     , "#{TE_ERR_MSG}, single value must be chunked: '#{te}'"
-        else
-          raise HttpParserError501  , "#{TE_ERR_MSG}, unknown value: '#{te}'"
-        end
+
+      if te && CHUNKED.casecmp(te) == 0
+        return setup_chunked_body(body)
       end
 
       @chunked_body = false
 
       cl = @env[CONTENT_LENGTH]
 
-      if cl
-        # cannot contain characters that are not \d
-        if cl =~ CONTENT_LENGTH_VALUE_INVALID
-          raise HttpParserError, "Invalid Content-Length: #{cl.inspect}"
-        end
-      else
+      unless cl
         @buffer = body.empty? ? nil : body
         @body = EmptyBody
         set_ready
@@ -429,10 +412,7 @@ module Puma
           raise EOFError
         end
 
-        if decode_chunk(chunk)
-          @env[CONTENT_LENGTH] = @chunked_content_length
-          return true
-        end
+        return true if decode_chunk(chunk)
       end
     end
 
@@ -445,28 +425,19 @@ module Puma
       @body.binmode
       @tempfile = @body
 
-      @chunked_content_length = 0
-
-      if decode_chunk(body)
-        @env[CONTENT_LENGTH] = @chunked_content_length
-        return true
-      end
-    end
-
-    def write_chunk(str)
-      @chunked_content_length += @body.write(str)
+      return decode_chunk(body)
     end
 
     def decode_chunk(chunk)
       if @partial_part_left > 0
         if @partial_part_left <= chunk.size
           if @partial_part_left > 2
-            write_chunk(chunk[0..(@partial_part_left-3)]) # skip the \r\n
+            @body << chunk[0..(@partial_part_left-3)] # skip the \r\n
           end
           chunk = chunk[@partial_part_left..-1]
           @partial_part_left = 0
         else
-          write_chunk(chunk) if @partial_part_left > 2 # don't include the last \r\n
+          @body << chunk if @partial_part_left > 2 # don't include the last \r\n
           @partial_part_left -= chunk.size
           return false
         end
@@ -482,13 +453,7 @@ module Puma
       while !io.eof?
         line = io.gets
         if line.end_with?("\r\n")
-          # Puma doesn't process chunk extensions, but should parse if they're
-          # present, which is the reason for the semicolon regex
-          chunk_hex = line.strip[/\A[^;]+/]
-          if chunk_hex =~ CHUNK_SIZE_INVALID
-            raise HttpParserError, "Invalid chunk size: '#{chunk_hex}'"
-          end
-          len = chunk_hex.to_i(16)
+          len = line.strip.to_i(16)
           if len == 0
             @in_last_chunk = true
             @body.rewind
@@ -519,17 +484,12 @@ module Puma
 
           case
           when got == len
-            # proper chunked segment must end with "\r\n"
-            if part.end_with? CHUNK_VALID_ENDING
-              write_chunk(part[0..-3]) # to skip the ending \r\n
-            else
-              raise HttpParserError, "Chunk size mismatch"
-            end
+            @body << part[0..-3] # to skip the ending \r\n
           when got <= len - 2
-            write_chunk(part)
+            @body << part
             @partial_part_left = len - part.size
           when got == len - 1 # edge where we get just \r but not \n
-            write_chunk(part[0..-2])
+            @body << part[0..-2]
             @partial_part_left = len - part.size
           end
         else