puma 3.8.2 → 4.0.0

data/lib/puma/cluster.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puma/runner'
 require 'puma/util'
 require 'puma/plugin'
@@ -5,9 +7,18 @@ 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
 
@@ -24,7 +35,35 @@ module Puma
       @workers.each { |x| x.term }
 
       begin
-        Process.waitall
+        if RUBY_VERSION < '2.6'
+          @workers.each do |w|
+            begin
+              Process.waitpid(w.pid)
+            rescue Errno::ECHILD
+              # child is already terminated
+            end
+          end
+        else
+          # below code is for a bug in Ruby 2.6+, above waitpid call hangs
+          t_st = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          pids = @workers.map(&:pid)
+          loop do
+            pids.reject! do |w_pid|
+              begin
+                if Process.waitpid(w_pid, Process::WNOHANG)
+                  log "    worker status: #{$?}"
+                  true
+                end
+              rescue Errno::ECHILD
+                true # child is already terminated
+              end
+            end
+            break if pids.empty?
+            sleep 0.5
+          end
+          t_end = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          log format("    worker shutdown time: %6.2f", t_end - t_st)
+        end
       rescue Interrupt
         log "! Cancelled waiting for workers"
       end
@@ -170,7 +209,7 @@ module Puma
     def check_workers(force=false)
       return if !force && @next_check && @next_check >= Time.now
 
-      @next_check = Time.now + WORKER_CHECK_INTERVAL
+      @next_check = Time.now + Const::WORKER_CHECK_INTERVAL
 
       any = false
 
@@ -187,14 +226,9 @@ module Puma
       # during this loop by giving the kernel time to kill them.
       sleep 1 if any
 
-      while @workers.any?
-        pid = Process.waitpid(-1, Process::WNOHANG)
-        break unless pid
+      @workers.reject! { |w| Process.waitpid(w.pid, Process::WNOHANG) }
 
-        @workers.delete_if { |w| w.pid == pid }
-      end
-
-      @workers.delete_if(&:dead?)
+      @workers.reject!(&:dead?)
 
       cull_workers
       spawn_workers
@@ -224,12 +258,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"
@@ -267,6 +302,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
@@ -275,13 +311,16 @@ module Puma
         base_payload = "p#{Process.pid}"
 
         while true
-          sleep WORKER_CHECK_INTERVAL
+          sleep Const::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
@@ -337,7 +376,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
 
@@ -372,7 +411,13 @@ module Puma
           log "Early termination of worker"
           exit! 0
         else
+          @launcher.close_binder_listeners
+
+          stop_workers
           stop
+
+          raise(SignalException, "SIGTERM") if @options[:raise_exception_on_sigterm]
+          exit 0 # Clean exit, workers were stopped
         end
       end
     end
@@ -466,7 +511,7 @@ module Puma
 
             force_check = false
 
-            res = IO.select([read], nil, nil, WORKER_CHECK_INTERVAL)
+            res = IO.select([read], nil, nil, Const::WORKER_CHECK_INTERVAL)
 
             if res
               req = read.read_nonblock(1)

data/lib/puma/commonlogger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puma
   # Rack::CommonLogger forwards every request to the given +app+, and
   # logs a line in the

data/lib/puma/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puma/rack/builder'
 require 'puma/plugin'
 require 'puma/const'
@@ -180,30 +182,32 @@ module Puma
         :worker_shutdown_timeout => DefaultWorkerShutdownTimeout,
         :remote_address => :socket,
         :tag => method(:infer_tag),
-        :environment => ->{ ENV['RACK_ENV'] || "development" },
+        :environment => -> { ENV['RACK_ENV'] || "development" },
         :rackup => DefaultRackup,
         :logger => STDOUT,
-        :persistent_timeout => Const::PERSISTENT_TIMEOUT
+        :persistent_timeout => Const::PERSISTENT_TIMEOUT,
+        :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
+        :raise_exception_on_sigterm => true
       }
     end
 
     def load
+      config_files.each { |config_file| @file_dsl._load_from(config_file) }
+
+      @options
+    end
+
+    def config_files
       files = @options.all_of(:config_files)
 
-      if files.empty?
-        imp = %W(config/puma/#{@options[:environment]}.rb config/puma.rb).find { |f|
-          File.exist?(f)
-        }
+      return [] if files == ['-']
+      return files if files.any?
 
-        files << imp
-      elsif files == ["-"]
-        files = []
+      first_default_file = %W(config/puma/#{environment_str}.rb config/puma.rb).find do |f|
+        File.exist?(f)
       end
 
-      files.each do |f|
-        @file_dsl._load_from(f)
-      end
-      @options
+      [first_default_file]
     end
 
     # Call once all configuration (included from rackup files)
@@ -263,6 +267,10 @@ module Puma
       @options[:environment]
     end
 
+    def environment_str
+      environment.respond_to?(:call) ? environment.call : environment
+    end
+
     def load_plugin(name)
       @plugins.create name
     end
@@ -340,7 +348,7 @@ 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

data/lib/puma/const.rb

@@ -1,4 +1,6 @@
 #encoding: utf-8
+# frozen_string_literal: true
+
 module Puma
   class UnsupportedOption < RuntimeError
   end
@@ -53,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',
@@ -60,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',
@@ -95,8 +100,8 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "3.8.2".freeze
-    CODE_NAME = "Sassy Salamander".freeze
+    PUMA_VERSION = VERSION = "4.0.0".freeze
+    CODE_NAME = "4 Fast 4 Furious".freeze
     PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
@@ -220,5 +225,11 @@ module Puma
     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,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'optparse'
-require 'puma/state_file'
-require 'puma/const'
-require 'puma/detect'
-require 'puma/configuration'
+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}
 
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
       @state = nil
@@ -69,6 +71,7 @@ module Puma
       end
 
       opts.order!(argv) { |a| opts.terminate a }
+      opts.parse!
 
       @command = argv.shift
 
@@ -128,7 +131,7 @@ module Puma
       uri = URI.parse @control_url
 
       # create server object by scheme
-      @server = case uri.scheme
+      server = case uri.scheme
                 when "tcp"
                   TCPSocket.new uri.host, uri.port
                 when "unix"
@@ -146,9 +149,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
 
@@ -169,10 +172,10 @@ 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
+    ensure
+      server.close if server && !server.closed?
     end
 
     def send_signal
@@ -203,8 +206,17 @@ module Puma
         when "phased-restart"
           Process.kill "SIGUSR1", @pid
 
+        when "status"
+          begin
+            Process.kill 0, @pid
+            puts "Puma is started"
+          rescue Errno::ESRCH
+            raise "Puma is not running"
+          end
+
+          return
+
         else
-          message "Puma is started"
           return
         end
 
@@ -220,7 +232,7 @@ module Puma
     end
 
     def run
-      start if @command == "start"
+      return start if @command == "start"
 
       prepare_configuration
 
@@ -245,7 +257,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puma/launcher'
 require 'puma/configuration'
 

data/lib/puma/daemon_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Process
 
   # This overrides the default version because it is broken if it

data/lib/puma/delegation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puma
   module Delegation
     def forward(what, who)

data/lib/puma/detect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puma
   IS_JRUBY = defined?(JRUBY_VERSION)
 

data/lib/puma/dsl.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'puma/const'
+
 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
@@ -55,6 +59,14 @@ module Puma
       @plugins.clear
     end
 
+    def set_default_host(host)
+      @options[:default_host] = host
+    end
+
+    def default_host
+      @options[:default_host] || Configuration::DefaultTCPHost
+    end
+
     def inject(&blk)
       instance_eval(&blk)
     end
@@ -93,7 +105,12 @@ module Puma
       end
 
       if opts[:no_token]
-        auth_token = :none
+        # We need to use 'none' rather than :none because this value will be
+        # passed on to an instance of OptionParser, which doesn't support
+        # symbols as option values.
+        #
+        # See: https://github.com/puma/puma/issues/1193#issuecomment-305995488
+        auth_token = 'none'
       else
         auth_token = opts[:auth_token]
         auth_token ||= Configuration.random_token
@@ -110,18 +127,35 @@ module Puma
       @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)
       @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.
     #
     def port(port, host=nil)
-      host ||= Configuration::DefaultTCPHost
+      host ||= default_host
       bind "tcp://#{host}:#{port}"
     end
 
@@ -129,7 +163,13 @@ module Puma
     # them
     #
     def persistent_timeout(seconds)
-      @options[: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
@@ -146,7 +186,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)
@@ -231,6 +271,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
@@ -258,12 +302,15 @@ module Puma
 
     def ssl_bind(host, port, opts)
       verify = opts.fetch(:verify_mode, 'none')
+      no_tlsv1 = opts.fetch(:no_tlsv1, 'false')
+      ca_additions = "&ca=#{opts[:ca]}" if ['peer', 'force_peer'].include?(verify)
 
       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}&verify_mode=#{verify}"
+        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}&verify_mode=#{verify}&no_tlsv1=#{no_tlsv1}#{ca_additions}"
       else
-        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&verify_mode=#{verify}"
+        ssl_cipher_filter = "&ssl_cipher_filter=#{opts[:ssl_cipher_filter]}" if opts[:ssl_cipher_filter]
+        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}#{ssl_cipher_filter}&verify_mode=#{verify}&no_tlsv1=#{no_tlsv1}#{ca_additions}"
       end
     end
 
@@ -338,6 +385,21 @@ module Puma
 
     alias_method :after_worker_boot, :after_worker_fork
 
+    # Code to run out-of-band when the worker is idle.
+    # These hooks run immediately after a request has finished
+    # processing and there are no busy threads on the worker.
+    # The worker doesn't accept new requests until this code finishes.
+    #
+    # This hook is useful for running out-of-band garbage collection
+    # or scheduling asynchronous tasks to execute after a response.
+    #
+    # This can be called multiple times to add hooks.
+    #
+    def out_of_band(&block)
+      @options[:out_of_band] ||= []
+      @options[:out_of_band] << block
+    end
+
     # The directory to operate out of.
     def directory(dir)
       @options[:directory] = dir.to_s
@@ -387,6 +449,16 @@ module Puma
       @options[:prune_bundler] = answer
     end
 
+    # In environments where SIGTERM is something expected, instructing
+    # puma to shutdown gracefully ( for example in Kubernetes, where
+    # rolling restart is guaranteed usually on infrastructure level )
+    # SignalException should not be raised for SIGTERM
+    #
+    # When set to false, if puma process receives SIGTERM, it won't raise SignalException
+    def raise_exception_on_sigterm(answer=true)
+      @options[:raise_exception_on_sigterm] = answer
+    end
+
     # Additional text to display in process listing
     def tag(string)
       @options[:tag] = string.to_s
@@ -397,17 +469,24 @@ 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
+      timeout = Integer(timeout)
+      min = Const::WORKER_CHECK_INTERVAL
+
+      if timeout <= min
+        raise "The minimum worker_timeout must be greater than the worker reporting interval (#{min})"
+      end
+
+      @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
@@ -466,7 +545,7 @@ module Puma
       when Hash
         if hdr = val[:header]
           @options[:remote_address] = :header
-          @options[:remote_address_header] = "HTTP_" + hdr.upcase.gsub("-", "_")
+          @options[:remote_address_header] = "HTTP_" + hdr.upcase.tr("-", "_")
         else
           raise "Invalid value for set_remote_address - #{val.inspect}"
         end