puma 2.16.0 → 3.11.4

data/lib/puma/client.rb

@@ -7,6 +7,8 @@ class IO
 end
 
 require 'puma/detect'
+require 'puma/delegation'
+require 'tempfile'
 
 if Puma::IS_JRUBY
   # We have to work around some OpenSSL buffer/io-readiness bugs
@@ -21,6 +23,7 @@ module Puma
 
   class Client
     include Puma::Const
+    extend  Puma::Delegation
 
     def initialize(io, env=nil)
       @io = io
@@ -57,6 +60,8 @@ module Puma
 
     attr_accessor :remote_addr_header
 
+    forward :closed?, :@io
+
     def inspect
       "#<Puma::Client:0x#{object_id.to_s(16)} @ready=#{@ready.inspect}>"
     end
@@ -106,6 +111,7 @@ module Puma
       begin
         @io.close
       rescue IOError
+        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
       end
     end
 
@@ -113,9 +119,123 @@ module Puma
     # no body share this one object since it has no state.
     EmptyBody = NullIO.new
 
+    def setup_chunked_body(body)
+      @chunked_body = true
+      @partial_part_left = 0
+      @prev_chunk = ""
+
+      @body = Tempfile.new(Const::PUMA_TMP_BASE)
+      @body.binmode
+      @tempfile = @body
+
+      return decode_chunk(body)
+    end
+
+    def decode_chunk(chunk)
+      if @partial_part_left > 0
+        if @partial_part_left <= chunk.size
+          @body << chunk[0..(@partial_part_left-3)] # skip the \r\n
+          chunk = chunk[@partial_part_left..-1]
+        else
+          @body << chunk
+          @partial_part_left -= chunk.size
+          return false
+        end
+      end
+
+      if @prev_chunk.empty?
+        io = StringIO.new(chunk)
+      else
+        io = StringIO.new(@prev_chunk+chunk)
+        @prev_chunk = ""
+      end
+
+      while !io.eof?
+        line = io.gets
+        if line.end_with?("\r\n")
+          len = line.strip.to_i(16)
+          if len == 0
+            @body.rewind
+            rest = io.read
+            @buffer = rest.empty? ? nil : rest
+            @requests_served += 1
+            @ready = true
+            return true
+          end
+
+          len += 2
+
+          part = io.read(len)
+
+          unless part
+            @partial_part_left = len
+            next
+          end
+
+          got = part.size
+
+          case
+          when got == len
+            @body << part[0..-3] # to skip the ending \r\n
+          when got <= len - 2
+            @body << part
+            @partial_part_left = len - part.size
+          when got == len - 1 # edge where we get just \r but not \n
+            @body << part[0..-2]
+            @partial_part_left = len - part.size
+          end
+        else
+          @prev_chunk = line
+          return false
+        end
+      end
+
+      return false
+    end
+
+    def read_chunked_body
+      while true
+        begin
+          chunk = @io.read_nonblock(4096)
+        rescue Errno::EAGAIN
+          return false
+        rescue SystemCallError, IOError
+          raise ConnectionError, "Connection error detected during read"
+        end
+
+        # No chunk means a closed socket
+        unless chunk
+          @body.close
+          @buffer = nil
+          @requests_served += 1
+          @ready = true
+          raise EOFError
+        end
+
+        return true if decode_chunk(chunk)
+      end
+    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.casecmp(te) == 0
+        return setup_chunked_body(body)
+      end
+
+      @chunked_body = false
+
       cl = @env[CONTENT_LENGTH]
 
       unless cl
@@ -150,8 +270,6 @@ module Puma
 
       @body_remain = remain
 
-      @read_header = false
-
       return false
     end
 
@@ -166,6 +284,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
@@ -180,7 +306,7 @@ module Puma
         raise HttpParserError,
           "HEADER is longer than allowed, aborting client early."
       end
-      
+
       false
     end
 
@@ -195,6 +321,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
@@ -242,6 +376,10 @@ module Puma
     end
 
     def read_body
+      if @chunked_body
+        return read_chunked_body
+      end
+
       # Read an odd sized chunk so we can read even sized ones
       # after this
       remain = @body_remain

data/lib/puma/cluster.rb

@@ -1,9 +1,15 @@
 require 'puma/runner'
+require 'puma/util'
+require 'puma/plugin'
+
+require 'time'
 
 module Puma
   class Cluster < Runner
-    def initialize(cli)
-      super cli
+    WORKER_CHECK_INTERVAL = 5
+
+    def initialize(cli, events)
+      super cli, events
 
       @phase = 0
       @workers = []
@@ -18,7 +24,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
@@ -30,10 +36,9 @@ module Puma
 
       # Be sure to change the directory again before loading
       # the app. This way we can pick up new code.
-      if dir = @options[:worker_directory]
-        log "+ Changing to #{dir}"
-        Dir.chdir dir
-      end
+      dir = @launcher.restart_dir
+      log "+ Changing to #{dir}"
+      Dir.chdir dir
     end
 
     def redirect_io
@@ -52,9 +57,11 @@ module Puma
         @options = options
         @first_term_sent = nil
         @last_checkin = Time.now
+        @last_status = '{}'
+        @dead = false
       end
 
-      attr_reader :index, :pid, :phase, :signal, :last_checkin
+      attr_reader :index, :pid, :phase, :signal, :last_checkin, :last_status
 
       def booted?
         @stage == :booted
@@ -73,8 +80,9 @@ module Puma
         @dead = true
       end
 
-      def ping!
+      def ping!(status)
         @last_checkin = Time.now
+        @last_status = status
       end
 
       def ping_timeout?(which)
@@ -83,10 +91,10 @@ module Puma
 
       def term
         begin
-          if @first_term_sent && (Time.new - @first_term_sent) > @options[:worker_shutdown_timeout]
+          if @first_term_sent && (Time.now - @first_term_sent) > @options[:worker_shutdown_timeout]
             @signal = "KILL"
           else
-            @first_term_sent ||= Time.new
+            @first_term_sent ||= Time.now
           end
 
           Process.kill @signal, @pid
@@ -107,17 +115,25 @@ module Puma
 
     def spawn_workers
       diff = @options[:workers] - @workers.size
+      return if diff < 1
 
       master = Process.pid
 
       diff.times do
         idx = next_worker_index
-        @options[:before_worker_fork].each { |h| h.call(idx) }
+        @launcher.config.run_hooks :before_worker_fork, idx
 
         pid = fork { worker(idx, master) }
-        @cli.debug "Spawned worker: #{pid}"
+        if !pid
+          log "! Complete inability to spawn new workers detected"
+          log "! Seppuku is the only choice."
+          exit! 1
+        end
+
+        debug "Spawned worker: #{pid}"
         @workers << Worker.new(idx, pid, @phase, @options)
-        @options[:after_worker_boot].each { |h| h.call }
+
+        @launcher.config.run_hooks :after_worker_fork, idx
       end
 
       if diff > 0
@@ -125,6 +141,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 }
@@ -139,7 +170,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
 
@@ -165,6 +196,7 @@ module Puma
 
       @workers.delete_if(&:dead?)
 
+      cull_workers
       spawn_workers
 
       if all_workers_booted?
@@ -192,12 +224,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"
@@ -214,14 +247,17 @@ module Puma
 
       # If we're not running under a Bundler context, then
       # report the info about the context we will be using
-      if !ENV['BUNDLE_GEMFILE'] and File.exist?("Gemfile")
-        log "+ Gemfile in context: #{File.expand_path("Gemfile")}"
+      if !ENV['BUNDLE_GEMFILE']
+        if File.exist?("Gemfile")
+          log "+ Gemfile in context: #{File.expand_path("Gemfile")}"
+        elsif File.exist?("gems.rb")
+          log "+ Gemfile in context: #{File.expand_path("gems.rb")}"
+        end
       end
 
       # Invoke any worker boot hooks so they can get
       # things in shape before booting the app.
-      hooks = @options[:before_worker_boot]
-      hooks.each { |h| h.call(index) }
+      @launcher.config.run_hooks :before_worker_boot, index
 
       server = start_server
 
@@ -232,16 +268,25 @@ 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
 
       Thread.new(@worker_write) do |io|
-        payload = "p#{Process.pid}\n"
+        base_payload = "p#{Process.pid}"
 
         while true
-          sleep 5
-          io << payload
+          sleep WORKER_CHECK_INTERVAL
+          begin
+            b = server.backlog || 0
+            r = server.running || 0
+            payload = %Q!#{base_payload}{ "backlog":#{b}, "running":#{r} }\n!
+            io << payload
+          rescue IOError
+            Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+            break
+          end
         end
       end
 
@@ -249,8 +294,7 @@ module Puma
 
       # Invoke any worker shutdown hooks so they can prevent the worker
       # exiting until any background operations are completed
-      hooks = @options[:before_worker_shutdown]
-      hooks.each { |h| h.call(index) }
+      @launcher.config.run_hooks :before_worker_shutdown, index
     ensure
       @worker_write << "t#{Process.pid}\n" rescue nil
       @worker_write.close
@@ -288,22 +332,57 @@ module Puma
     end
 
     def reload_worker_directory
-      if dir = @options[:worker_directory]
-        log "+ Changing to #{dir}"
-        Dir.chdir dir
-      end
+      dir = @launcher.restart_dir
+      log "+ Changing to #{dir}"
+      Dir.chdir dir
     end
 
     def stats
       old_worker_count = @workers.count { |w| w.phase != @phase }
       booted_worker_count = @workers.count { |w| w.booted? }
-      %Q!{ "workers": #{@workers.size}, "phase": #{@phase}, "booted_workers": #{booted_worker_count}, "old_workers": #{old_worker_count} }!
+      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
 
     def preload?
       @options[:preload_app]
     end
 
+    # We do this in a separate method to keep the lambda scope
+    # of the signals handlers as small as possible.
+    def setup_signals
+      Signal.trap "SIGCHLD" do
+        wakeup!
+      end
+
+      Signal.trap "TTIN" do
+        @options[:workers] += 1
+        wakeup!
+      end
+
+      Signal.trap "TTOU" do
+        @options[:workers] -= 1 if @options[:workers] >= 2
+        wakeup!
+      end
+
+      master_pid = Process.pid
+
+      Signal.trap "SIGTERM" do
+        # The worker installs their own SIGTERM when booted.
+        # Until then, this is run by the worker and the worker
+        # should just exit if they get it.
+        if Process.pid != master_pid
+          log "Early termination of worker"
+          exit! 0
+        else
+          stop_workers
+          stop
+
+          raise SignalException, "SIGTERM"
+        end
+      end
+    end
+
     def run
       @status = :run
 
@@ -333,44 +412,17 @@ module Puma
       else
         log "* Phased restart available"
 
-        unless @cli.config.app_configured?
+        unless @launcher.config.app_configured?
           error "No application configured, nothing to run"
           exit 1
         end
 
-        @cli.binder.parse @options[:binds], self
+        @launcher.binder.parse @options[:binds], self
       end
 
       read, @wakeup = Puma::Util.pipe
 
-      Signal.trap "SIGCHLD" do
-        wakeup!
-      end
-
-      Signal.trap "TTIN" do
-        @options[:workers] += 1
-        wakeup!
-      end
-
-      Signal.trap "TTOU" do
-        @options[:workers] -= 1 if @options[:workers] >= 2
-        @workers.last.term
-        wakeup!
-      end
-
-      master_pid = Process.pid
-
-      Signal.trap "SIGTERM" do
-        # The worker installs their own SIGTERM when booted.
-        # Until then, this is run by the worker and the worker
-        # should just exit if they get it.
-        if Process.pid != master_pid
-          log "Early termination of worker"
-          exit! 0
-        else
-          stop
-        end
-      end
+      setup_signals
 
       # Used by the workers to detect if the master process dies.
       # If select says that @check_pipe is ready, it's because the
@@ -388,14 +440,15 @@ module Puma
 
       redirect_io
 
-      start_control
+      Plugins.fire_background
 
-      @cli.write_state
+      @launcher.write_state
+
+      start_control
 
       @master_read, @worker_write = read, @wakeup
 
-      hooks = @options[:before_fork]
-      hooks.each { |h| h.call }
+      @launcher.config.run_hooks :before_fork, nil
 
       spawn_workers
 
@@ -403,21 +456,31 @@ module Puma
         stop
       end
 
-      @cli.events.fire_on_booted!
+      @launcher.events.fire_on_booted!
 
       begin
+        force_check = false
+
         while @status == :run
           begin
-            res = IO.select([read], nil, nil, 5)
+            if @phased_restart
+              start_phased_restart
+              @phased_restart = false
+            end
+
+            check_workers force_check
 
             force_check = false
 
+            res = IO.select([read], nil, nil, WORKER_CHECK_INTERVAL)
+
             if res
               req = read.read_nonblock(1)
 
               next if !req || req == "!"
 
-              pid = read.gets.to_i
+              result = read.gets
+              pid = result.to_i
 
               if w = @workers.find { |x| x.pid == pid }
                 case req
@@ -429,20 +492,13 @@ module Puma
                   w.dead!
                   force_check = true
                 when "p"
-                  w.ping!
+                  w.ping!(result.sub(/^\d+/,'').chomp)
                 end
               else
                 log "! Out-of-sync worker list, no #{pid} worker"
               end
             end
 
-            if @phased_restart
-              start_phased_restart
-              @phased_restart = false
-            end
-
-            check_workers force_check
-
           rescue Interrupt
             @status = :stop
           end

data/lib/puma/commonlogger.rb

@@ -21,6 +21,13 @@ module Puma
     #   %{%s - %s [%s] "%s %s%s %s" %d %s\n} %
     FORMAT = %{%s - %s [%s] "%s %s%s %s" %d %s %0.4f\n}
 
+    HIJACK_FORMAT = %{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
+
+    CONTENT_LENGTH = 'Content-Length'.freeze
+    PATH_INFO      = 'PATH_INFO'.freeze
+    QUERY_STRING   = 'QUERY_STRING'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
     def initialize(app, logger=nil)
       @app = app
       @logger = logger
@@ -42,36 +49,23 @@ module Puma
       [status, header, body]
     end
 
-    HIJACK_FORMAT = %{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
-
     private
 
     def log_hijacking(env, status, header, began_at)
       now = Time.now
 
-      logger = @logger || env['rack.errors']
-      logger.write HIJACK_FORMAT % [
+      msg = HIJACK_FORMAT % [
         env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
         env["REMOTE_USER"] || "-",
         now.strftime("%d/%b/%Y %H:%M:%S"),
-        env["REQUEST_METHOD"],
-        env["PATH_INFO"],
-        env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
+        env[REQUEST_METHOD],
+        env[PATH_INFO],
+        env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
         env["HTTP_VERSION"],
         now - began_at ]
-    end
 
-    PATH_INFO      = 'PATH_INFO'.freeze
-    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-    SCRIPT_NAME    = 'SCRIPT_NAME'.freeze
-    QUERY_STRING   = 'QUERY_STRING'.freeze
-    CACHE_CONTROL  = 'Cache-Control'.freeze
-    CONTENT_LENGTH = 'Content-Length'.freeze
-    CONTENT_TYPE   = 'Content-Type'.freeze
-
-    GET  = 'GET'.freeze
-    HEAD = 'HEAD'.freeze
-    
+      write(msg)
+    end
 
     def log(env, status, header, began_at)
       now = Time.now
@@ -83,13 +77,18 @@ module Puma
         now.strftime("%d/%b/%Y:%H:%M:%S %z"),
         env[REQUEST_METHOD],
         env[PATH_INFO],
-        env[QUERY_STRING].empty? ? "" : "?"+env[QUERY_STRING],
+        env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
         env["HTTP_VERSION"],
         status.to_s[0..3],
         length,
         now - began_at ]
 
+      write(msg)
+    end
+
+    def write(msg)
       logger = @logger || env['rack.errors']
+
       # Standard library logger doesn't support write but it supports << which actually
       # calls to write on the log device without formatting
       if logger.respond_to?(:write)

data/lib/puma/compat.rb

@@ -6,13 +6,9 @@ class String
   end
 
   unless method_defined? :byteslice
-    if RUBY_VERSION < '1.9'
-      alias_method :byteslice, :[]
-    else
-      def byteslice(*arg)
-        enc = self.encoding
-        self.dup.force_encoding(Encoding::ASCII_8BIT).slice(*arg).force_encoding(enc)
-      end
+    def byteslice(*arg)
+      enc = self.encoding
+      self.dup.force_encoding(Encoding::ASCII_8BIT).slice(*arg).force_encoding(enc)
     end
   end
 end