puma 5.0.0 → 5.0.1

data/lib/puma.rb

@@ -10,23 +10,26 @@ require 'stringio'
 
 require 'thread'
 
-require_relative 'puma/puma_http11'
-require_relative 'puma/detect'
+require 'puma/puma_http11'
+require 'puma/detect'
 
 module Puma
   autoload :Const, 'puma/const'
   autoload :Server, 'puma/server'
   autoload :Launcher, 'puma/launcher'
 
+  # @!attribute [rw] stats_object=
   def self.stats_object=(val)
     @get_stats = val
   end
 
+  # @!attribute [rw] stats_object
   def self.stats
     require 'json'
     @get_stats.stats.to_json
   end
 
+  # @!attribute [r] stats_hash
   # @version 5.0.0
   def self.stats_hash
     @get_stats.stats

data/lib/puma/binder.rb

@@ -66,6 +66,7 @@ module Puma
       @ios.each { |i| i.close }
     end
 
+    # @!attribute [r] connected_ports
     # @version 5.0.0
     def connected_ports
       ios.map { |io| io.addr[1] }.uniq
@@ -391,6 +392,7 @@ module Puma
 
     private
 
+    # @!attribute [r] loopback_addresses
     def loopback_addresses
       Socket.ip_address_list.select do |addrinfo|
         addrinfo.ipv6_loopback? || addrinfo.ipv4_loopback?

data/lib/puma/client.rb

@@ -85,6 +85,7 @@ module Puma
 
     def_delegators :@io, :closed?
 
+    # @!attribute [r] inspect
     def inspect
       "#<Puma::Client:0x#{object_id.to_s(16)} @ready=#{@ready.inspect}>"
     end
@@ -96,6 +97,7 @@ module Puma
       env[HIJACK_IO] ||= @io
     end
 
+    # @!attribute [r] in_data_phase
     def in_data_phase
       !@read_header
     end
@@ -155,7 +157,9 @@ module Puma
         data = @io.read_nonblock(CHUNK_SIZE)
       rescue IO::WaitReadable
         return false
-      rescue SystemCallError, IOError, EOFError
+      rescue EOFError
+        # Swallow error, don't log
+      rescue SystemCallError, IOError
         raise ConnectionError, "Connection error detected during read"
       end
 

data/lib/puma/cluster.rb

@@ -194,6 +194,7 @@ module Puma
       end
     end
 
+    # @!attribute [r] next_worker_index
     def next_worker_index
       all_positions =  0...@options[:workers]
       occupied_positions = @workers.map { |w| w.index }
@@ -396,6 +397,7 @@ module Puma
 
     # Inside of a child process, this will return all zeroes, as @workers is only populated in
     # the master process.
+    # @!attribute [r] stats
     def stats
       old_worker_count = @workers.count { |w| w.phase != @phase }
       worker_status = @workers.map do |w|

data/lib/puma/const.rb

@@ -100,7 +100,7 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "5.0.0".freeze
+    PUMA_VERSION = VERSION = "5.0.1".freeze
     CODE_NAME = "Spoony Bard".freeze
 
     PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze

data/lib/puma/error_logger.rb

@@ -51,8 +51,8 @@ module Puma
 
       string_block = []
       string_block << title(options)
-      string_block << request_dump(req) if req
-      string_block << error_backtrace(options) if error
+      string_block << request_dump(req) if request_parsed?(req)
+      string_block << error.backtrace if error
 
       ioerr.puts string_block.join("\n")
     end

data/lib/puma/events.rb

@@ -106,10 +106,12 @@ module Puma
     end
 
     # An SSL error has occurred.
-    # +error+ an exception object, +peeraddr+ peer address,
-    # and +peercert+ any peer certificate (if present).
+    # @param error <Puma::MiniSSL::SSLError>
+    # @param ssl_socket <Puma::MiniSSL::Socket>
     #
-    def ssl_error(error, peeraddr, peercert)
+    def ssl_error(error, ssl_socket)
+      peeraddr = ssl_socket.peeraddr.last rescue "<unknown>"
+      peercert = ssl_socket.peercert
       subject = peercert ? peercert.subject : nil
       @error_logger.info(error: error, text: "SSL error, peer: #{peeraddr}, peer cert: #{subject}")
     end

data/lib/puma/launcher.rb

@@ -188,11 +188,13 @@ module Puma
     end
 
     # Return all tcp ports the launcher may be using, TCP or SSL
+    # @!attribute [r] connected_ports
     # @version 5.0.0
     def connected_ports
       @binder.connected_ports
     end
 
+    # @!attribute [r] restart_args
     def restart_args
       cmd = @options[:restart_cmd]
       if cmd
@@ -207,6 +209,7 @@ module Puma
       @binder.close_listeners
     end
 
+    # @!attribute [r] thread_status
     # @version 5.0.0
     def thread_status
       Thread.list.each do |thread|
@@ -261,6 +264,7 @@ module Puma
       end
     end
 
+    # @!attribute [r] dependencies_and_files_to_require_after_prune
     def dependencies_and_files_to_require_after_prune
       puma = spec_for_gem("puma")
 
@@ -271,6 +275,7 @@ module Puma
       [deps, require_paths_for_gem(puma) + extra_runtime_deps_directories]
     end
 
+    # @!attribute [r] extra_runtime_deps_directories
     def extra_runtime_deps_directories
       Array(@options[:extra_runtime_dependencies]).map do |d_name|
         if (spec = spec_for_gem(d_name))
@@ -282,6 +287,7 @@ module Puma
       end.flatten.compact
     end
 
+    # @!attribute [r] puma_wild_location
     def puma_wild_location
       puma = spec_for_gem("puma")
       dirs = require_paths_for_gem(puma)
@@ -345,6 +351,7 @@ module Puma
       Process.respond_to?(:setproctitle) ? Process.setproctitle(title) : $0 = title
     end
 
+    # @!attribute [r] title
     def title
       buffer  = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
       buffer += " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
@@ -356,6 +363,7 @@ module Puma
       ENV['RACK_ENV'] = environment
     end
 
+    # @!attribute [r] environment
     def environment
       @environment
     end

data/lib/puma/minissl.rb

@@ -24,6 +24,7 @@ module Puma
         @peercert = nil
       end
 
+      # @!attribute [r] to_io
       def to_io
         @socket
       end
@@ -38,6 +39,7 @@ module Puma
       #
       # Used for dropping tcp connections to ssl.
       # See OpenSSL ssl/ssl_stat.c SSL_state_string for info
+      # @!attribute [r] ssl_version_state
       # @version 5.0.0
       #
       def ssl_version_state
@@ -188,10 +190,12 @@ module Puma
         end
       end
 
+      # @!attribute [r] peeraddr
       def peeraddr
         @socket.peeraddr
       end
 
+      # @!attribute [r] peercert
       def peercert
         return @peercert if @peercert
 
@@ -264,12 +268,14 @@ module Puma
       end
 
       # disables TLSv1
+      # @!attribute [w] no_tlsv1=
       def no_tlsv1=(tlsv1)
         raise ArgumentError, "Invalid value of no_tlsv1=" unless ['true', 'false', true, false].include?(tlsv1)
         @no_tlsv1 = tlsv1
       end
 
       # disables TLSv1 and TLSv1.1.  Overrides `#no_tlsv1=`
+      # @!attribute [w] no_tlsv1_1=
       def no_tlsv1_1=(tlsv1_1)
         raise ArgumentError, "Invalid value of no_tlsv1_1=" unless ['true', 'false', true, false].include?(tlsv1_1)
         @no_tlsv1_1 = tlsv1_1
@@ -287,6 +293,7 @@ module Puma
         @ctx = ctx
       end
 
+      # @!attribute [r] to_io
       def to_io
         @socket
       end
@@ -307,6 +314,7 @@ module Puma
         Socket.new io, engine
       end
 
+      # @!attribute [r] addr
       # @version 5.0.0
       def addr
         @socket.addr

data/lib/puma/reactor.rb

@@ -237,23 +237,12 @@ module Puma
 
               # SSL handshake failure
               rescue MiniSSL::SSLError => e
-                @server.lowlevel_error(e, c.env)
-
-                ssl_socket = c.io
-                begin
-                  addr = ssl_socket.peeraddr.last
-                # EINVAL can happen when browser closes socket w/security exception
-                rescue IOError, Errno::EINVAL
-                  addr = "<unknown>"
-                end
-
-                cert = ssl_socket.peercert
+                @server.lowlevel_error e, c.env
+                @events.ssl_error e, c.io
 
                 c.close
                 clear_monitor mon
 
-                @events.ssl_error e, addr, cert
-
               # The client doesn't know HTTP well
               rescue HttpParserError => e
                 @server.lowlevel_error(e, c.env)

data/lib/puma/runner.rb

@@ -54,9 +54,8 @@ module Puma
 
       app = Puma::App::Status.new @launcher, token
 
-      control = Puma::Server.new app, @launcher.events
-      control.min_threads = 0
-      control.max_threads = 1
+      control = Puma::Server.new app, @launcher.events,
+        { min_threads: 0, max_threads: 1 }
 
       control.binder.parse [str], self, 'Starting control server'
 
@@ -69,6 +68,7 @@ module Puma
       @control.binder.close_listeners if @control
     end
 
+    # @!attribute [r] ruby_engine
     def ruby_engine
       if !defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby"
         "ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
@@ -137,27 +137,14 @@ module Puma
       @launcher.binder.parse @options[:binds], self
     end
 
+    # @!attribute [r] app
     def app
       @app ||= @launcher.config.app
     end
 
     def start_server
-      min_t = @options[:min_threads]
-      max_t = @options[:max_threads]
-
       server = Puma::Server.new app, @launcher.events, @options
-      server.min_threads = min_t
-      server.max_threads = max_t
       server.inherit_binder @launcher.binder
-
-      if @options[:early_hints]
-        server.early_hints = true
-      end
-
-      unless development? || test?
-        server.leak_stack_on_error = false
-      end
-
       server
     end
   end

data/lib/puma/server.rb

@@ -34,15 +34,21 @@ module Puma
 
     attr_reader :thread
     attr_reader :events
-    attr_reader :requests_count # @version 5.0.0
+    attr_reader :min_threads, :max_threads  # for #stats
+    attr_reader :requests_count             # @version 5.0.0
+
+    # the following may be deprecated in the future
+    attr_reader :auto_trim_time
+    attr_reader :first_data_timeout
+    attr_reader :persistent_timeout
+    attr_reader :reaping_time
+
     attr_accessor :app
+    attr_accessor :binder
 
-    attr_accessor :min_threads
-    attr_accessor :max_threads
-    attr_accessor :persistent_timeout
-    attr_accessor :auto_trim_time
-    attr_accessor :reaping_time
-    attr_accessor :first_data_timeout
+    def_delegators :@binder, :add_tcp_listener, :add_ssl_listener, :add_unix_listener, :connected_ports
+
+    ThreadLocalKey = :puma_server
 
     # Create a server for the rack app +app+.
     #
@@ -52,6 +58,10 @@ module Puma
     # Server#run returns a thread that you can join on to wait for the server
     # to do its work.
     #
+    # @note Several instance variables exist so they are available for testing,
+    #   and have default values set via +fetch+.  Normally the values are set via
+    #   `::Puma::Configuration.puma_default_options`.
+    #
     def initialize(app, events=Events.stdio, options={})
       @app = app
       @events = events
@@ -59,24 +69,24 @@ module Puma
       @check, @notify = nil
       @status = :stop
 
-      @min_threads = 0
-      @max_threads = 16
       @auto_trim_time = 30
       @reaping_time = 1
 
       @thread = nil
       @thread_pool = nil
-      @early_hints = nil
 
-      @persistent_timeout = options.fetch(:persistent_timeout, PERSISTENT_TIMEOUT)
-      @first_data_timeout = options.fetch(:first_data_timeout, FIRST_DATA_TIMEOUT)
+      @options = options
 
-      @binder = Binder.new(events)
+      @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
 
-      @leak_stack_on_error = true
+      @leak_stack_on_error = !!(@options[:environment] =~ /\A(development|test)\z/)
 
-      @options = options
-      @queue_requests = options[:queue_requests].nil? ? true : options[:queue_requests]
+      @binder = Binder.new(events)
 
       ENV['RACK_ENV'] ||= "development"
 
@@ -85,26 +95,37 @@ module Puma
       @precheck_closing = true
 
       @requests_count = 0
-    end
 
-    attr_accessor :binder, :leak_stack_on_error, :early_hints
-
-    def_delegators :@binder, :add_tcp_listener, :add_ssl_listener, :add_unix_listener, :connected_ports
+      @shutdown_mutex = Mutex.new
+    end
 
     def inherit_binder(bind)
       @binder = bind
     end
 
     class << self
+      # @!attribute [r] current
+      def current
+        Thread.current[ThreadLocalKey]
+      end
+
       # :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)
+      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)
       end
       private :tcp_cork_supported?
+      private :closed_socket_supported?
     end
 
     # On Linux, use TCP_CORK to better control how the TCP stack
@@ -131,7 +152,15 @@ module Puma
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
         end
       end
+    else
+      def cork_socket(socket)
+      end
+
+      def uncork_socket(socket)
+      end
+    end
 
+    if closed_socket_supported?
       def closed_socket?(socket)
         return false unless socket.kind_of? TCPSocket
         return false unless @precheck_closing
@@ -149,21 +178,17 @@ module Puma
         end
       end
     else
-      def cork_socket(socket)
-      end
-
-      def uncork_socket(socket)
-      end
-
       def closed_socket?(socket)
         false
       end
     end
 
+    # @!attribute [r] backlog
     def backlog
       @thread_pool and @thread_pool.backlog
     end
 
+    # @!attribute [r] running
     def running
       @thread_pool and @thread_pool.spawned
     end
@@ -176,6 +201,7 @@ module Puma
     # there are 5 threads sitting idle ready to take
     # a request. If one request comes in, then the
     # value would be 4 until it finishes processing.
+    # @!attribute [r] pool_capacity
     def pool_capacity
       @thread_pool and @thread_pool.pool_capacity
     end
@@ -206,33 +232,36 @@ module Puma
           if @queue_requests
             process_now = client.eagerly_finish
           else
-            client.finish(@first_data_timeout)
+            @thread_pool.with_force_shutdown do
+              client.finish(@first_data_timeout)
+            end
             process_now = true
           end
         rescue MiniSSL::SSLError => e
-          ssl_socket = client.io
-          addr = ssl_socket.peeraddr.last
-          cert = ssl_socket.peercert
-
+          @events.ssl_error e, client.io
           client.close
 
-          @events.ssl_error e, addr, cert
         rescue HttpParserError => e
           client.write_error(400)
           client.close
 
           @events.parse_error e, client
-        rescue ConnectionError, EOFError => e
+        rescue EOFError => e
+          client.close
+
+          # Swallow, do not log
+        rescue ConnectionError, ThreadPool::ForceShutdown => e
           client.close
 
           @events.connection_error e, client
         else
-          if process_now
-            process_client client, buffer
-          else
-            client.set_timeout @first_data_timeout
-            @reactor.add client
-          end
+          process_now ||= @shutdown_mutex.synchronize do
+                            next true unless @queue_requests
+                            client.set_timeout @first_data_timeout
+                            @reactor.add client
+                            false
+                          end
+          process_client client, buffer if process_now
         end
 
         process_now
@@ -318,7 +347,9 @@ module Puma
         @events.fire :state, @status
 
         if queue_requests
-          @queue_requests = false
+          @shutdown_mutex.synchronize do
+            @queue_requests = false
+          end
           @reactor.clear!
           @reactor.shutdown
         end
@@ -397,32 +428,32 @@ module Puma
               check_for_more_data = false
             end
 
-            unless client.reset(check_for_more_data)
-              return unless @queue_requests
-              close_socket = false
-              client.set_timeout @persistent_timeout
-              @reactor.add client
-              return
+            next_request_ready = @thread_pool.with_force_shutdown do
+              client.reset(check_for_more_data)
+            end
+
+            unless next_request_ready
+              @shutdown_mutex.synchronize do
+                return unless @queue_requests
+                close_socket = false
+                client.set_timeout @persistent_timeout
+                @reactor.add client
+                return
+              end
             end
           end
         end
 
       # The client disconnected while we were reading data
-      rescue ConnectionError
+      rescue ConnectionError, ThreadPool::ForceShutdown
         # Swallow them. The ensure tries to close +client+ down
 
       # SSL handshake error
       rescue MiniSSL::SSLError => e
-        lowlevel_error(e, client.env)
-
-        ssl_socket = client.io
-        addr = ssl_socket.peeraddr.last
-        cert = ssl_socket.peercert
-
+        lowlevel_error e, client.env
+        @events.ssl_error e, client.io
         close_socket = true
 
-        @events.ssl_error e, addr, cert
-
       # The client doesn't know HTTP well
       rescue HttpParserError => e
         lowlevel_error(e, client.env)
@@ -617,7 +648,9 @@ module Puma
 
       begin
         begin
-          status, headers, res_body = @app.call(env)
+          status, headers, res_body = @thread_pool.with_force_shutdown do
+            @app.call(env)
+          end
 
           return :async if req.hijacked
 
@@ -915,7 +948,7 @@ module Puma
 
       if @thread_pool
         if timeout = @options[:force_shutdown_after]
-          @thread_pool.shutdown timeout.to_i
+          @thread_pool.shutdown timeout.to_f
         else
           @thread_pool.shutdown
         end
@@ -979,12 +1012,6 @@ module Puma
     end
     private :fast_write
 
-    ThreadLocalKey = :puma_server
-
-    def self.current
-      Thread.current[ThreadLocalKey]
-    end
-
     def shutting_down?
       @status == :stop || @status == :restart
     end
@@ -1000,6 +1027,7 @@ module Puma
 
     # Returns a hash of stats about the running server for reporting purposes.
     # @version 5.0.0
+    # @!attribute [r] stats
     def stats
       STAT_METHODS.map {|name| [name, send(name) || 0]}.to_h
     end