puma 3.6.0 → 3.12.0

data/lib/puma/app/status.rb

@@ -55,6 +55,14 @@ module Puma
             return rack_response(200, OK_STATUS)
           end
 
+        when /\/gc$/
+          GC.start
+          return rack_response(200, OK_STATUS)
+
+        when /\/gc-stats$/
+          json = "{" + GC.stat.map { |k, v| "\"#{k}\": #{v}" }.join(",") + "}"
+          return rack_response(200, json)
+
         when /\/stats$/
           return rack_response(200, @cli.stats)
         else

data/lib/puma/binder.rb

@@ -1,5 +1,8 @@
-require 'puma/const'
 require 'uri'
+require 'socket'
+
+require 'puma/const'
+require 'puma/util'
 
 module Puma
   class Binder
@@ -102,7 +105,7 @@ module Puma
             io = add_tcp_listener uri.host, uri.port, opt, bak
           end
 
-          @listeners << [str, io]
+          @listeners << [str, io] if io
         when "unix"
           path = "#{uri.host}#{uri.path}".gsub("%20", " ")
 
@@ -117,7 +120,7 @@ module Puma
 
             umask = nil
             mode = nil
-            backlog = nil
+            backlog = 1024
 
             if uri.query
               params = Util.parse_query uri.query
@@ -140,11 +143,11 @@ module Puma
 
           @listeners << [str, io]
         when "ssl"
-          MiniSSL.check
-
           params = Util.parse_query uri.query
           require 'puma/minissl'
 
+          MiniSSL.check
+
           ctx = MiniSSL::Context.new
 
           if defined?(JRUBY_VERSION)
@@ -159,6 +162,7 @@ module Puma
             end
 
             ctx.keystore_pass = params['keystore-pass']
+            ctx.ssl_cipher_list = params['ssl_cipher_list'] if params['ssl_cipher_list']
           else
             unless params['key']
               @events.error "Please specify the SSL key via 'key='"
@@ -179,6 +183,7 @@ module Puma
             end
 
             ctx.ca = params['ca'] if params['ca']
+            ctx.ssl_cipher_filter = params['ssl_cipher_filter'] if params['ssl_cipher_filter']
           end
 
           if params['verify_mode']
@@ -206,7 +211,7 @@ module Puma
             io = add_ssl_listener uri.host, uri.port, ctx
           end
 
-          @listeners << [str, io]
+          @listeners << [str, io] if io
         else
           logger.error "Invalid URI: #{str}"
         end
@@ -242,9 +247,10 @@ module Puma
       end
     end
 
-    def localhost_addresses
-      addrs = TCPSocket.gethostbyname "localhost"
-      addrs[3..-1].uniq
+    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+.
@@ -256,7 +262,7 @@ module Puma
     #
     def add_tcp_listener(host, port, optimize_for_latency=true, backlog=1024)
       if host == "localhost"
-        localhost_addresses.each do |addr|
+        loopback_addresses.each do |addr|
           add_tcp_listener addr, port, optimize_for_latency, backlog
         end
         return
@@ -295,8 +301,8 @@ module Puma
       MiniSSL.check
 
       if host == "localhost"
-        localhost_addresses.each do |addr|
-          add_ssl_listener addr, port, optimize_for_latency, backlog
+        loopback_addresses.each do |addr|
+          add_ssl_listener addr, port, ctx, optimize_for_latency, backlog
         end
         return
       end
@@ -309,6 +315,7 @@ module Puma
       s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
       s.listen backlog
 
+
       ssl = MiniSSL::Server.new s, ctx
       env = @proto_env.dup
       env[HTTPS_KEY] = HTTPS
@@ -340,7 +347,7 @@ module Puma
 
     # Tell the server to listen on +path+ as a UNIX domain socket.
     #
-    def add_unix_listener(path, umask=nil, mode=nil, backlog=nil)
+    def add_unix_listener(path, umask=nil, mode=nil, backlog=1024)
       @unix_paths << path
 
       # Let anyone connect by default
@@ -361,7 +368,7 @@ module Puma
         end
 
         s = UNIXServer.new(path)
-        s.listen backlog if backlog
+        s.listen backlog
         @ios << s
       ensure
         File.umask old_mask

data/lib/puma/cli.rb

@@ -1,7 +1,11 @@
 require 'optparse'
 require 'uri'
 
+require 'puma'
+require 'puma/configuration'
 require 'puma/launcher'
+require 'puma/const'
+require 'puma/events'
 
 module Puma
   class << self
@@ -44,21 +48,21 @@ module Puma
         @parser.parse! @argv
 
         if file = @argv.shift
-          @conf.configure do |c|
-            c.rackup file
+          @conf.configure do |user_config, file_config|
+            file_config.rackup file
           end
         end
       rescue UnsupportedOption
         exit 1
       end
 
-      @conf.configure do |c|
+      @conf.configure do |user_config, file_config|
         if @stdout || @stderr
-          c.stdout_redirect @stdout, @stderr, @append
+          user_config.stdout_redirect @stdout, @stderr, @append
         end
 
         if @control_url
-          c.activate_control_app @control_url, @control_options
+          user_config.activate_control_app @control_url, @control_options
         end
       end
 
@@ -80,27 +84,35 @@ module Puma
       raise UnsupportedOption
     end
 
+    def configure_control_url(command_line_arg)
+      if command_line_arg
+        @control_url = command_line_arg
+      elsif Puma.jruby?
+        unsupported "No default url available on JRuby"
+      end
+    end
+
     # Build the OptionParser object to handle the available options.
     #
 
     def setup_options
-      @conf = Configuration.new do |c|
+      @conf = Configuration.new do |user_config, file_config|
         @parser = OptionParser.new do |o|
           o.on "-b", "--bind URI", "URI to bind to (tcp://, unix://, ssl://)" do |arg|
-            c.bind arg
+            user_config.bind arg
           end
 
           o.on "-C", "--config PATH", "Load PATH as a config file" do |arg|
-            c.load arg
+            file_config.load arg
           end
 
-          o.on "--control URL", "The bind url to use for the control server",
-            "Use 'auto' to use temp unix server" do |arg|
-            if arg
-              @control_url = arg
-            elsif Puma.jruby?
-              unsupported "No default url available on JRuby"
-            end
+          o.on "--control-url URL", "The bind url to use for the control server. Use 'auto' to use temp unix server" do |arg|
+            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",
@@ -109,21 +121,21 @@ module Puma
           end
 
           o.on "-d", "--daemon", "Daemonize the server into the background" do
-            c.daemonize
-            c.quiet
+            user_config.daemonize
+            user_config.quiet
           end
 
           o.on "--debug", "Log lowlevel debugging information" do
-            c.debug
+            user_config.debug
           end
 
           o.on "--dir DIR", "Change to DIR before starting" do |d|
-            c.directory d
+            user_config.directory d
           end
 
           o.on "-e", "--environment ENVIRONMENT",
             "The environment to run the Rack app on (default development)" do |arg|
-            c.environment arg
+            user_config.environment arg
           end
 
           o.on "-I", "--include PATH", "Specify $LOAD_PATH directories" do |arg|
@@ -132,50 +144,54 @@ module Puma
 
           o.on "-p", "--port PORT", "Define the TCP port to bind to",
             "Use -b for more advanced options" do |arg|
-            c.bind "tcp://#{Configuration::DefaultTCPHost}:#{arg}"
+            user_config.bind "tcp://#{Configuration::DefaultTCPHost}:#{arg}"
           end
 
           o.on "--pidfile PATH", "Use PATH as a pidfile" do |arg|
-            c.pidfile arg
+            user_config.pidfile arg
           end
 
           o.on "--preload", "Preload the app. Cluster mode only" do
-            c.preload_app!
+            user_config.preload_app!
           end
 
           o.on "--prune-bundler", "Prune out the bundler env if possible" do
-            c.prune_bundler
+            user_config.prune_bundler
           end
 
           o.on "-q", "--quiet", "Do not log requests internally (default true)" do
-            c.quiet
+            user_config.quiet
           end
 
           o.on "-v", "--log-requests", "Log requests as they occur" do
-            c.log_requests
+            user_config.log_requests
           end
 
           o.on "-R", "--restart-cmd CMD",
             "The puma command to run during a hot restart",
             "Default: inferred" do |cmd|
-            c.restart_command cmd
+            user_config.restart_command cmd
           end
 
           o.on "-S", "--state PATH", "Where to store the state details" do |arg|
-            c.state_path arg
+            user_config.state_path arg
           end
 
           o.on '-t', '--threads INT', "min:max threads to use (default 0:16)" do |arg|
             min, max = arg.split(":")
             if max
-              c.threads min, max
+              user_config.threads min, max
             else
-              c.threads min, min
+              user_config.threads min, min
             end
           end
 
           o.on "--tcp-mode", "Run the app in raw TCP mode instead of HTTP mode" do
-            c.tcp_mode!
+            user_config.tcp_mode!
+          end
+
+          o.on "--early-hints", "Enable early hints support" do
+            user_config.early_hints
           end
 
           o.on "-V", "--version", "Print the version information" do
@@ -185,11 +201,11 @@ module Puma
 
           o.on "-w", "--workers COUNT",
             "Activate cluster mode: How many worker processes to create" do |arg|
-            c.workers arg
+            user_config.workers arg
           end
 
           o.on "--tag NAME", "Additional text to display in process listing" do |arg|
-            c.tag arg
+            user_config.tag arg
           end
 
           o.on "--redirect-stdout FILE", "Redirect STDOUT to a specific file" do |arg|

data/lib/puma/client.rb

@@ -21,6 +21,17 @@ module Puma
 
   class ConnectionError < RuntimeError; end
 
+  # An instance of this class represents a unique request from a client.
+  # For example a web request from a browser or from CURL. This
+  #
+  # An instance of `Puma::Client` can be used as if it were an IO object
+  # for example it is passed into `IO.select` inside of the `Puma::Reactor`.
+  # This is accomplished by the `to_io` method which gets called on any
+  # non-IO objects being used with the IO api such as `IO.select.
+  #
+  # 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
     include Puma::Const
     extend  Puma::Delegation
@@ -111,6 +122,7 @@ module Puma
       begin
         @io.close
       rescue IOError
+        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
       end
     end
 
@@ -155,7 +167,8 @@ module Puma
           len = line.strip.to_i(16)
           if len == 0
             @body.rewind
-            @buffer = nil
+            rest = io.read
+            @buffer = rest.empty? ? nil : rest
             @requests_served += 1
             @ready = true
             return true
@@ -215,14 +228,20 @@ module Puma
     end
 
     def setup_body
-      @in_data_phase = true
+      if @env[HTTP_EXPECT] == CONTINUE
+        # TODO allow a hook here to check the headers before
+        # going forward
+        @io << HTTP_11_100
+        @io.flush
+      end
+
       @read_header = false
 
       body = @parser.body
 
       te = @env[TRANSFER_ENCODING2]
 
-      if te == CHUNKED
+      if te && CHUNKED.casecmp(te) == 0
         return setup_chunked_body(body)
       end
 
@@ -276,6 +295,14 @@ module Puma
         raise ConnectionError, "Connection error detected during read"
       end
 
+      # No data means a closed socket
+      unless data
+        @buffer = nil
+        @requests_served += 1
+        @ready = true
+        raise EOFError
+      end
+
       if @buffer
         @buffer << data
       else
@@ -290,7 +317,7 @@ module Puma
         raise HttpParserError,
           "HEADER is longer than allowed, aborting client early."
       end
-      
+
       false
     end
 
@@ -305,6 +332,14 @@ module Puma
           raise e
         end
 
+        # No data means a closed socket
+        unless data
+          @buffer = nil
+          @requests_served += 1
+          @ready = true
+          raise EOFError
+        end
+
         if @buffer
           @buffer << data
         else

data/lib/puma/cluster.rb

@@ -1,8 +1,24 @@
 require 'puma/runner'
+require 'puma/util'
+require 'puma/plugin'
+
 require 'time'
 
 module Puma
+  # This class is instantiated by the `Puma::Launcher` and used
+  # to boot and serve a Ruby application when puma "workers" are needed
+  # i.e. when using multi-processes. For example `$ puma -w 5`
+  #
+  # At the core of this class is running an instance of `Puma::Server` which
+  # gets created via the `start_server` method from the `Puma::Runner` class
+  # that this inherits from.
+  #
+  # An instance of this class will spawn the number of processes passed in
+  # via the `spawn_workers` method call. Each worker will have it's own
+  # instance of a `Puma::Server`.
   class Cluster < Runner
+    WORKER_CHECK_INTERVAL = 5
+
     def initialize(cli, events)
       super cli, events
 
@@ -19,7 +35,7 @@ module Puma
       @workers.each { |x| x.term }
 
       begin
-        Process.waitall
+        @workers.each { |w| Process.waitpid(w.pid) }
       rescue Interrupt
         log "! Cancelled waiting for workers"
       end
@@ -110,6 +126,7 @@ module Puma
 
     def spawn_workers
       diff = @options[:workers] - @workers.size
+      return if diff < 1
 
       master = Process.pid
 
@@ -135,6 +152,21 @@ module Puma
       end
     end
 
+    def cull_workers
+      diff = @workers.size - @options[:workers]
+      return if diff < 1
+
+      debug "Culling #{diff.inspect} workers"
+
+      workers_to_cull = @workers[-diff,diff]
+      debug "Workers to cull: #{workers_to_cull.inspect}"
+
+      workers_to_cull.each do |worker|
+        log "- Worker #{worker.index} (pid: #{worker.pid}) terminating"
+        worker.term
+      end
+    end
+
     def next_worker_index
       all_positions =  0...@options[:workers]
       occupied_positions = @workers.map { |w| w.index }
@@ -149,7 +181,7 @@ module Puma
     def check_workers(force=false)
       return if !force && @next_check && @next_check >= Time.now
 
-      @next_check = Time.now + 5
+      @next_check = Time.now + WORKER_CHECK_INTERVAL
 
       any = false
 
@@ -175,6 +207,7 @@ module Puma
 
       @workers.delete_if(&:dead?)
 
+      cull_workers
       spawn_workers
 
       if all_workers_booted?
@@ -202,12 +235,13 @@ module Puma
       begin
         @wakeup.write "!" unless @wakeup.closed?
       rescue SystemCallError, IOError
+        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
       end
     end
 
     def worker(index, master)
-      title = "puma: cluster worker #{index}: #{master}"
-      title << " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
+      title  = "puma: cluster worker #{index}: #{master}"
+      title += " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
       $0 = title
 
       Signal.trap "SIGINT", "IGNORE"
@@ -245,6 +279,7 @@ module Puma
       begin
         @worker_write << "b#{Process.pid}\n"
       rescue SystemCallError, IOError
+        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
         STDERR.puts "Master seems to have exited, exiting."
         return
       end
@@ -253,13 +288,16 @@ module Puma
         base_payload = "p#{Process.pid}"
 
         while true
-          sleep 5
+          sleep WORKER_CHECK_INTERVAL
           begin
-            b = server.backlog
-            r = server.running
-            payload = %Q!#{base_payload}{ "backlog":#{b}, "running":#{r} }\n!
+            b = server.backlog || 0
+            r = server.running || 0
+            t = server.pool_capacity || 0
+            m = server.max_threads || 0
+            payload = %Q!#{base_payload}{ "backlog":#{b}, "running":#{r}, "pool_capacity":#{t}, "max_threads": #{m} }\n!
             io << payload
           rescue IOError
+            Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
             break
           end
         end
@@ -315,7 +353,7 @@ module Puma
     def stats
       old_worker_count = @workers.count { |w| w.phase != @phase }
       booted_worker_count = @workers.count { |w| w.booted? }
-      worker_status = '[' + @workers.map{ |w| %Q!{ "pid": #{w.pid}, "index": #{w.index}, "phase": #{w.phase}, "booted": #{w.booted?}, "last_checkin": "#{w.last_checkin.utc.iso8601}", "last_status": #{w.last_status} }!}.join(",") + ']'
+      worker_status = '[' + @workers.map { |w| %Q!{ "pid": #{w.pid}, "index": #{w.index}, "phase": #{w.phase}, "booted": #{w.booted?}, "last_checkin": "#{w.last_checkin.utc.iso8601}", "last_status": #{w.last_status} }!}.join(",") + ']'
       %Q!{ "workers": #{@workers.size}, "phase": #{@phase}, "booted_workers": #{booted_worker_count}, "old_workers": #{old_worker_count}, "worker_status": #{worker_status} }!
     end
 
@@ -337,7 +375,6 @@ module Puma
 
       Signal.trap "TTOU" do
         @options[:workers] -= 1 if @options[:workers] >= 2
-        @workers.last.term
         wakeup!
       end
 
@@ -351,7 +388,10 @@ module Puma
           log "Early termination of worker"
           exit! 0
         else
+          stop_workers
           stop
+
+          raise SignalException, "SIGTERM"
         end
       end
     end
@@ -445,7 +485,7 @@ module Puma
 
             force_check = false
 
-            res = IO.select([read], nil, nil, 5)
+            res = IO.select([read], nil, nil, WORKER_CHECK_INTERVAL)
 
             if res
               req = read.read_nonblock(1)