puma 5.1.1 → 5.3.1

data/lib/puma/minissl/context_builder.rb

@@ -62,6 +62,12 @@ module Puma
                             end
         end
 
+        if params['verification_flags']
+          ctx.verification_flags = params['verification_flags'].split(',').
+            map { |flag| MiniSSL::VERIFICATION_FLAGS.fetch(flag) }.
+            inject { |sum, flag| sum ? sum | flag : flag }
+        end
+
         ctx
       end
 

data/lib/puma/null_io.rb

@@ -9,6 +9,10 @@ module Puma
       nil
     end
 
+    def string
+      ""
+    end
+
     def each
     end
 
@@ -32,6 +36,10 @@ module Puma
       true
     end
 
+    def sync
+      true
+    end
+
     def sync=(v)
     end
 
@@ -40,5 +48,9 @@ module Puma
 
     def write(*ary)
     end
+
+    def flush
+      self
+    end
   end
 end

data/lib/puma/queue_close.rb

@@ -5,22 +5,22 @@ module Puma
   # Add a simple implementation for earlier Ruby versions.
   #
   module QueueClose
-    def initialize
-      @closed = false
-      super
-    end
     def close
+      num_waiting.times {push nil}
       @closed = true
     end
     def closed?
-      @closed
+      @closed ||= false
     end
     def push(object)
-      @closed ||= false
-      raise ClosedQueueError if @closed
+      raise ClosedQueueError if closed?
       super
     end
     alias << push
+    def pop(non_block=false)
+      return nil if !non_block && closed? && empty?
+      super
+    end
   end
   ::Queue.prepend QueueClose
 end

data/lib/puma/reactor.rb

@@ -3,6 +3,8 @@
 require 'puma/queue_close' unless ::Queue.instance_methods.include? :close
 
 module Puma
+  class UnsupportedBackend < StandardError; end
+
   # Monitors a collection of IO objects, calling a block whenever
   # any monitored object either receives data or times out, or when the Reactor shuts down.
   #
@@ -18,9 +20,12 @@ module Puma
     # Create a new Reactor to monitor IO objects added by #add.
     # The provided block will be invoked when an IO has data available to read,
     # its timeout elapses, or when the Reactor shuts down.
-    def initialize(&block)
+    def initialize(backend, &block)
       require 'nio'
-      @selector = NIO::Selector.new
+      unless backend == :auto || NIO::Selector.backends.include?(backend)
+        raise "unsupported IO selector backend: #{backend} (available backends: #{NIO::Selector.backends.join(', ')})"
+      end
+      @selector = backend == :auto ? NIO::Selector.new : NIO::Selector.new(backend)
       @input = Queue.new
       @timeouts = []
       @block = block

data/lib/puma/request.rb

@@ -30,7 +30,7 @@ module Puma
     #
     def handle_request(client, lines)
       env = client.env
-      io = client.io
+      io  = client.io   # io may be a MiniSSL::Socket
 
       return false if closed_socket?(io)
 
@@ -148,8 +148,9 @@ module Puma
           res_body.each do |part|
             next if part.bytesize.zero?
             if chunked
-              str = part.bytesize.to_s(16) << line_ending << part << line_ending
-              fast_write io, str
+               fast_write io, (part.bytesize.to_s(16) << line_ending)
+               fast_write io, part            # part may have different encoding
+               fast_write io, line_ending
             else
               fast_write io, part
             end
@@ -230,7 +231,11 @@ module Puma
     #
     def normalize_env(env, client)
       if host = env[HTTP_HOST]
-        if colon = host.index(":")
+        # host can be a hostname, ipv4 or bracketed ipv6. Followed by an optional port.
+        if colon = host.rindex("]:") # IPV6 with port
+          env[SERVER_NAME] = host[0, colon+1]
+          env[SERVER_PORT] = host[colon+2, host.bytesize]
+        elsif !host.start_with?("[") && colon = host.index(":") # not hostname or IPV4 with port
           env[SERVER_NAME] = host[0, colon]
           env[SERVER_PORT] = host[colon+1, host.bytesize]
         else

data/lib/puma/runner.rb

@@ -55,7 +55,7 @@ module Puma
       app = Puma::App::Status.new @launcher, token
 
       control = Puma::Server.new app, @launcher.events,
-        { min_threads: 0, max_threads: 1 }
+        { min_threads: 0, max_threads: 1, queue_requests: false }
 
       control.binder.parse [str], self, 'Starting control server'
 
@@ -113,8 +113,8 @@ module Puma
         end
 
         STDOUT.reopen stdout, (append ? "a" : "w")
-        STDOUT.sync = true
         STDOUT.puts "=== puma startup: #{Time.now} ==="
+        STDOUT.flush unless STDOUT.sync
       end
 
       if stderr
@@ -123,8 +123,13 @@ module Puma
         end
 
         STDERR.reopen stderr, (append ? "a" : "w")
-        STDERR.sync = true
         STDERR.puts "=== puma startup: #{Time.now} ==="
+        STDERR.flush unless STDERR.sync
+      end
+
+      if @options[:mutate_stdout_and_stderr_to_sync_on_write]
+        STDOUT.sync = true
+        STDERR.sync = true
       end
     end
 

data/lib/puma/server.rb

@@ -84,13 +84,14 @@ module Puma
 
       @options = options
 
-      @early_hints        = options.fetch :early_hints, nil
-      @first_data_timeout = options.fetch :first_data_timeout, FIRST_DATA_TIMEOUT
-      @min_threads        = options.fetch :min_threads, 0
-      @max_threads        = options.fetch :max_threads , (Puma.mri? ? 5 : 16)
-      @persistent_timeout = options.fetch :persistent_timeout, PERSISTENT_TIMEOUT
-      @queue_requests     = options.fetch :queue_requests, true
-      @max_fast_inline    = options.fetch :max_fast_inline, MAX_FAST_INLINE
+      @early_hints         = options.fetch :early_hints, nil
+      @first_data_timeout  = options.fetch :first_data_timeout, FIRST_DATA_TIMEOUT
+      @min_threads         = options.fetch :min_threads, 0
+      @max_threads         = options.fetch :max_threads , (Puma.mri? ? 5 : 16)
+      @persistent_timeout  = options.fetch :persistent_timeout, PERSISTENT_TIMEOUT
+      @queue_requests      = options.fetch :queue_requests, true
+      @max_fast_inline     = options.fetch :max_fast_inline, MAX_FAST_INLINE
+      @io_selector_backend = options.fetch :io_selector_backend, :auto
 
       temp = !!(@options[:environment] =~ /\A(development|test)\z/)
       @leak_stack_on_error = @options[:environment] ? temp : true
@@ -119,17 +120,13 @@ module Puma
       # :nodoc:
       # @version 5.0.0
       def tcp_cork_supported?
-        RbConfig::CONFIG['host_os'] =~ /linux/ &&
-          Socket.const_defined?(:IPPROTO_TCP) &&
-          Socket.const_defined?(:TCP_CORK)
+        Socket.const_defined?(:TCP_CORK) && Socket.const_defined?(:IPPROTO_TCP)
       end
 
       # :nodoc:
       # @version 5.0.0
       def closed_socket_supported?
-        RbConfig::CONFIG['host_os'] =~ /linux/ &&
-          Socket.const_defined?(:IPPROTO_TCP) &&
-          Socket.const_defined?(:TCP_INFO)
+        Socket.const_defined?(:TCP_INFO) && Socket.const_defined?(:IPPROTO_TCP)
       end
       private :tcp_cork_supported?
       private :closed_socket_supported?
@@ -137,24 +134,25 @@ module Puma
 
     # On Linux, use TCP_CORK to better control how the TCP stack
     # packetizes our stream. This improves both latency and throughput.
+    # socket parameter may be an MiniSSL::Socket, so use to_io
     #
     if tcp_cork_supported?
-      UNPACK_TCP_STATE_FROM_TCP_INFO = "C".freeze
-
       # 6 == Socket::IPPROTO_TCP
       # 3 == TCP_CORK
       # 1/0 == turn on/off
       def cork_socket(socket)
+        skt = socket.to_io
         begin
-          socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 1) if socket.kind_of? TCPSocket
+          skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 1) if skt.kind_of? TCPSocket
         rescue IOError, SystemCallError
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
         end
       end
 
       def uncork_socket(socket)
+        skt = socket.to_io
         begin
-          socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 0) if socket.kind_of? TCPSocket
+          skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 0) if skt.kind_of? TCPSocket
         rescue IOError, SystemCallError
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
         end
@@ -168,12 +166,14 @@ module Puma
     end
 
     if closed_socket_supported?
+      UNPACK_TCP_STATE_FROM_TCP_INFO = "C".freeze
+
       def closed_socket?(socket)
-        return false unless socket.kind_of? TCPSocket
-        return false unless @precheck_closing
+        skt = socket.to_io
+        return false unless skt.kind_of?(TCPSocket) && @precheck_closing
 
         begin
-          tcp_info = socket.getsockopt(Socket::IPPROTO_TCP, Socket::TCP_INFO)
+          tcp_info = skt.getsockopt(Socket::IPPROTO_TCP, Socket::TCP_INFO)
         rescue IOError, SystemCallError
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
           @precheck_closing = false
@@ -237,7 +237,7 @@ module Puma
       @thread_pool.clean_thread_locals = @options[:clean_thread_locals]
 
       if @queue_requests
-        @reactor = Reactor.new(&method(:reactor_wakeup))
+        @reactor = Reactor.new(@io_selector_backend, &method(:reactor_wakeup))
         @reactor.run
       end
 
@@ -295,6 +295,9 @@ module Puma
         @thread_pool << client
       elsif shutdown || client.timeout == 0
         client.timeout!
+      else
+        client.set_timeout(@first_data_timeout)
+        false
       end
     rescue StandardError => e
       client_error(e, client)
@@ -308,6 +311,7 @@ module Puma
         sockets = [check] + @binder.ios
         pool = @thread_pool
         queue_requests = @queue_requests
+        drain = @options[:drain_on_shutdown] ? 0 : nil
 
         remote_addr_value = nil
         remote_addr_header = nil
@@ -319,22 +323,23 @@ module Puma
           remote_addr_header = @options[:remote_address_header]
         end
 
-        while @status == :run
+        while @status == :run || (drain && shutting_down?)
           begin
-            ios = IO.select sockets
+            ios = IO.select sockets, nil, nil, (shutting_down? ? 0 : nil)
+            break unless ios
             ios.first.each do |sock|
               if sock == check
                 break if handle_check
               else
                 pool.wait_until_not_full
-                pool.wait_for_less_busy_worker(
-                  @options[:wait_for_less_busy_worker].to_f)
+                pool.wait_for_less_busy_worker(@options[:wait_for_less_busy_worker])
 
                 io = begin
                   sock.accept_nonblock
                 rescue IO::WaitReadable
                   next
                 end
+                drain += 1 if shutting_down?
                 client = Client.new io, @binder.env(sock)
                 if remote_addr_value
                   client.peerip = remote_addr_value
@@ -349,6 +354,7 @@ module Puma
           end
         end
 
+        @events.debug "Drained #{drain} additional connections." if drain
         @events.fire :state, @status
 
         if queue_requests
@@ -441,15 +447,20 @@ module Puma
 
             requests += 1
 
-            check_for_more_data = @status == :run
+            # Closing keepalive sockets after they've made a reasonable
+            # number of requests allows Puma to service many connections
+            # fairly, even when the number of concurrent connections exceeds
+            # the size of the threadpool. It also allows cluster mode Pumas
+            # to keep load evenly distributed across workers, because clients
+            # are randomly assigned a new worker when opening a new connection.
+            #
+            # Previously, Puma would kick connections in this conditional back
+            # to the reactor. However, because this causes the todo set to increase
+            # in size, the wait_until_full mutex would never unlock, leaving
+            # any additional connections unserviced.
+            break if requests >= @max_fast_inline
 
-            if requests >= @max_fast_inline
-              # This will mean that reset will only try to use the data it already
-              # has buffered and won't try to read more data. What this means is that
-              # every client, independent of their request speed, gets treated like a slow
-              # one once every max_fast_inline requests.
-              check_for_more_data = false
-            end
+            check_for_more_data = @status == :run
 
             next_request_ready = with_force_shutdown(client) do
               client.reset(check_for_more_data)
@@ -494,62 +505,6 @@ module Puma
 
     # :nocov:
 
-    # Given the request +env+ from +client+ and the partial body +body+
-    # plus a potential Content-Length value +cl+, finish reading
-    # the body and return it.
-    #
-    # If the body is larger than MAX_BODY, a Tempfile object is used
-    # for the body, otherwise a StringIO is used.
-    # @deprecated 6.0.0
-    #
-    def read_body(env, client, body, cl)
-      content_length = cl.to_i
-
-      remain = content_length - body.bytesize
-
-      return StringIO.new(body) if remain <= 0
-
-      # Use a Tempfile if there is a lot of data left
-      if remain > MAX_BODY
-        stream = Tempfile.new(Const::PUMA_TMP_BASE)
-        stream.binmode
-      else
-        # The body[0,0] trick is to get an empty string in the same
-        # encoding as body.
-        stream = StringIO.new body[0,0]
-      end
-
-      stream.write body
-
-      # Read an odd sized chunk so we can read even sized ones
-      # after this
-      chunk = client.readpartial(remain % CHUNK_SIZE)
-
-      # No chunk means a closed socket
-      unless chunk
-        stream.close
-        return nil
-      end
-
-      remain -= stream.write(chunk)
-
-      # Read the rest of the chunks
-      while remain > 0
-        chunk = client.readpartial(CHUNK_SIZE)
-        unless chunk
-          stream.close
-          return nil
-        end
-
-        remain -= stream.write(chunk)
-      end
-
-      stream.rewind
-
-      return stream
-    end
-    # :nocov:
-
     # Handle various error types thrown by Client I/O operations.
     def client_error(e, client)
       # Swallow, do not log
@@ -582,7 +537,8 @@ module Puma
       end
 
       if @leak_stack_on_error
-        [status, {}, ["Puma caught this error: #{e.message} (#{e.class})\n#{e.backtrace.join("\n")}"]]
+        backtrace = e.backtrace.nil? ? '<no backtrace available>' : e.backtrace.join("\n")
+        [status, {}, ["Puma caught this error: #{e.message} (#{e.class})\n#{backtrace}"]]
       else
         [status, {}, ["An unhandled lowlevel error occurred. The application logs may have details.\n"]]
       end
@@ -606,28 +562,6 @@ module Puma
         $stdout.syswrite "#{pid}: === End thread backtrace dump ===\n"
       end
 
-      if @options[:drain_on_shutdown]
-        count = 0
-
-        while true
-          ios = IO.select @binder.ios, nil, nil, 0
-          break unless ios
-
-          ios.first.each do |sock|
-            begin
-              if io = sock.accept_nonblock
-                count += 1
-                client = Client.new io, @binder.env(sock)
-                @thread_pool << client
-              end
-            rescue SystemCallError
-            end
-          end
-        end
-
-        @events.debug "Drained #{count} additional connections."
-      end
-
       if @status != :restart
         @binder.close
       end

data/lib/puma/thread_pool.rb

@@ -13,7 +13,7 @@ module Puma
   # a thread pool via the `Puma::ThreadPool#<<` operator where it is stored in a `@todo` array.
   #
   # Each thread in the pool has an internal loop where it pulls a request from the `@todo` array
-  # and proceses it.
+  # and processes it.
   class ThreadPool
     class ForceShutdown < RuntimeError
     end
@@ -220,7 +220,7 @@ module Puma
     # then the `@todo` array would stay the same size as the reactor works
     # to try to buffer the request. In that scenario the next call to this
     # method would not block and another request would be added into the reactor
-    # by the server. This would continue until a fully bufferend request
+    # by the server. This would continue until a fully buffered request
     # makes it through the reactor and can then be processed by the thread pool.
     def wait_until_not_full
       with_mutex do
@@ -240,11 +240,12 @@ module Puma
 
     # @version 5.0.0
     def wait_for_less_busy_worker(delay_s)
+      return unless delay_s && delay_s > 0
+
       # Ruby MRI does GVL, this can result
       # in processing contention when multiple threads
       # (requests) are running concurrently
       return unless Puma.mri?
-      return unless delay_s > 0
 
       with_mutex do
         return if @shutdown