puma 5.3.2 → 5.6.9

data/lib/puma/server.rb

@@ -14,6 +14,7 @@ require 'puma/io_buffer'
 require 'puma/request'
 
 require 'socket'
+require 'io/wait'
 require 'forwardable'
 
 module Puma
@@ -38,6 +39,7 @@ module Puma
     attr_reader :events
     attr_reader :min_threads, :max_threads  # for #stats
     attr_reader :requests_count             # @version 5.0.0
+    attr_reader :log_writer                 # to help with backports
 
     # @todo the following may be deprecated in the future
     attr_reader :auto_trim_time, :early_hints, :first_data_timeout,
@@ -72,6 +74,7 @@ module Puma
     def initialize(app, events=Events.stdio, options={})
       @app = app
       @events = events
+      @log_writer = events
 
       @check, @notify = nil
       @status = :stop
@@ -145,7 +148,7 @@ module Puma
         begin
           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
+          Puma::Util.purge_interrupt_queue
         end
       end
 
@@ -154,7 +157,7 @@ module Puma
         begin
           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
+          Puma::Util.purge_interrupt_queue
         end
       end
     else
@@ -175,7 +178,7 @@ module Puma
         begin
           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
+          Puma::Util.purge_interrupt_queue
           @precheck_closing = false
           false
         else
@@ -219,7 +222,7 @@ module Puma
     # up in the background to handle requests. Otherwise requests
     # are handled synchronously.
     #
-    def run(background=true, thread_name: 'server')
+    def run(background=true, thread_name: 'srv')
       BasicSocket.do_not_reverse_lookup = true
 
       @events.fire :state, :booting
@@ -227,6 +230,7 @@ module Puma
       @status = :run
 
       @thread_pool = ThreadPool.new(
+        thread_name,
         @min_threads,
         @max_threads,
         ::Puma::IOBuffer,
@@ -313,14 +317,15 @@ module Puma
         queue_requests = @queue_requests
         drain = @options[:drain_on_shutdown] ? 0 : nil
 
-        remote_addr_value = nil
-        remote_addr_header = nil
-
-        case @options[:remote_address]
+        addr_send_name, addr_value = case @options[:remote_address]
         when :value
-          remote_addr_value = @options[:remote_address_value]
+          [:peerip=, @options[:remote_address_value]]
         when :header
-          remote_addr_header = @options[:remote_address_header]
+          [:remote_addr_header=, @options[:remote_address_header]]
+        when :proxy_protocol
+          [:expect_proxy_proto=, @options[:remote_address_proxy_protocol]]
+        else
+          [nil, nil]
         end
 
         while @status == :run || (drain && shutting_down?)
@@ -340,17 +345,16 @@ module Puma
                   next
                 end
                 drain += 1 if shutting_down?
-                client = Client.new io, @binder.env(sock)
-                client.listener = sock
-                if remote_addr_value
-                  client.peerip = remote_addr_value
-                elsif remote_addr_header
-                  client.remote_addr_header = remote_addr_header
-                end
-                pool << client
+                pool << Client.new(io, @binder.env(sock)).tap { |c|
+                  c.listener = sock
+                  c.send(addr_send_name, addr_value) if addr_value
+                }
               end
             end
-          rescue Object => e
+          rescue IOError, Errno::EBADF
+            # In the case that any of the sockets are unexpectedly close.
+            raise
+          rescue StandardError => e
             @events.unknown_error e, nil, "Listen loop"
           end
         end
@@ -366,13 +370,14 @@ module Puma
       rescue Exception => e
         @events.unknown_error e, nil, "Exception handling servers"
       ensure
-        begin
-          @check.close unless @check.closed?
-        rescue Errno::EBADF, RuntimeError
-          # RuntimeError is Ruby 2.2 issue, can't modify frozen IOError
-          # Errno::EBADF is infrequently raised
+        # RuntimeError is Ruby 2.2 issue, can't modify frozen IOError
+        # Errno::EBADF is infrequently raised
+        [@check, @notify].each do |io|
+          begin
+            io.close unless io.closed?
+          rescue Errno::EBADF, RuntimeError
+          end
         end
-        @notify.close
         @notify = nil
         @check = nil
       end
@@ -396,7 +401,7 @@ module Puma
         return true
       end
 
-      return false
+      false
     end
 
     # Given a connection on +client+, handle the incoming requests,
@@ -482,7 +487,7 @@ module Puma
         begin
           client.close if close_socket
         rescue IOError, SystemCallError
-          Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+          Puma::Util.purge_interrupt_queue
           # Already closed
         rescue StandardError => e
           @events.unknown_error e, nil, "Client"
@@ -512,6 +517,9 @@ module Puma
       when HttpParserError
         client.write_error(400)
         @events.parse_error e, client
+      when HttpParserError501
+        client.write_error(501)
+        @events.parse_error e, client
       else
         client.write_error(500)
         @events.unknown_error e, nil, "Read"
@@ -574,11 +582,11 @@ module Puma
       @notify << message
     rescue IOError, NoMethodError, Errno::EPIPE
       # The server, in another thread, is shutting down
-      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+      Puma::Util.purge_interrupt_queue
     rescue RuntimeError => e
       # Temporary workaround for https://bugs.ruby-lang.org/issues/13239
       if e.message.include?('IOError')
-        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+        Puma::Util.purge_interrupt_queue
       else
         raise e
       end

data/lib/puma/state_file.rb

@@ -1,15 +1,40 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module Puma
+
+  # Puma::Launcher uses StateFile to write a yaml file for use with Puma::ControlCLI.
+  #
+  # In previous versions of Puma, YAML was used to read/write the state file.
+  # Since Puma is similar to Bundler/RubyGems in that it may load before one's app
+  # does, minimizing the dependencies that may be shared with the app is desired.
+  #
+  # At present, it only works with numeric and string values.  It is still a valid
+  # yaml file, and the CI tests parse it with Psych.
+  #
   class StateFile
+
+    ALLOWED_FIELDS = %w!control_url control_auth_token pid running_from!
+
+    # @deprecated 6.0.0
+    FIELDS = ALLOWED_FIELDS
+
     def initialize
       @options = {}
     end
 
     def save(path, permission = nil)
-      contents =YAML.dump @options
+      contents = "---\n".dup
+      @options.each do |k,v|
+        next unless ALLOWED_FIELDS.include? k
+        case v
+        when Numeric
+          contents << "#{k}: #{v}\n"
+        when String
+          next if v.strip.empty?
+          contents << (k == 'running_from' || v.to_s.include?(' ') ?
+            "#{k}: \"#{v}\"\n" : "#{k}: #{v}\n")
+        end
+      end
       if permission
         File.write path, contents, mode: 'wb:UTF-8'
       else
@@ -18,12 +43,22 @@ module Puma
     end
 
     def load(path)
-      @options = YAML.load File.read(path)
+      File.read(path).lines.each do |line|
+        next if line.start_with? '#'
+        k,v = line.split ':', 2
+        next unless v && ALLOWED_FIELDS.include?(k)
+        v = v.strip
+        @options[k] =
+          case v
+          when ''              then nil
+          when /\A\d+\z/       then v.to_i
+          when /\A\d+\.\d+\z/  then v.to_f
+          else                      v.gsub(/\A"|"\z/, '')
+          end
+      end
     end
 
-    FIELDS = %w!control_url control_auth_token pid running_from!
-
-    FIELDS.each do |f|
+    ALLOWED_FIELDS.each do |f|
       define_method f do
         @options[f]
       end

data/lib/puma/thread_pool.rb

@@ -29,7 +29,7 @@ module Puma
     # The block passed is the work that will be performed in each
     # thread.
     #
-    def initialize(min, max, *extra, &block)
+    def initialize(name, min, max, *extra, &block)
       @not_empty = ConditionVariable.new
       @not_full = ConditionVariable.new
       @mutex = Mutex.new
@@ -39,6 +39,7 @@ module Puma
       @spawned = 0
       @waiting = 0
 
+      @name = name
       @min = Integer(min)
       @max = Integer(max)
       @block = block
@@ -71,7 +72,7 @@ module Puma
     attr_accessor :out_of_band_hook # @version 5.0.0
 
     def self.clean_thread_locals
-      Thread.current.keys.each do |key| # rubocop: disable Performance/HashEachMethods
+      Thread.current.keys.each do |key| # rubocop: disable Style/HashEachMethods
         Thread.current[key] = nil unless key == :__recursive_key__
       end
     end
@@ -101,7 +102,7 @@ module Puma
       @spawned += 1
 
       th = Thread.new(@spawned) do |spawned|
-        Puma.set_thread_name 'threadpool %03i' % spawned
+        Puma.set_thread_name '%s tp %03i' % [@name, spawned]
         todo  = @todo
         block = @block
         mutex = @mutex
@@ -119,6 +120,7 @@ module Puma
                 @trim_requested -= 1
                 @spawned -= 1
                 @workers.delete th
+                not_full.signal
                 Thread.exit
               end
 
@@ -318,12 +320,12 @@ module Puma
     end
 
     def auto_trim!(timeout=30)
-      @auto_trim = Automaton.new(self, timeout, "threadpool trimmer", :trim)
+      @auto_trim = Automaton.new(self, timeout, "#{@name} threadpool trimmer", :trim)
       @auto_trim.start!
     end
 
     def auto_reap!(timeout=5)
-      @reaper = Automaton.new(self, timeout, "threadpool reaper", :reap)
+      @reaper = Automaton.new(self, timeout, "#{@name} threadpool reaper", :reap)
       @reaper.start!
     end
 

data/lib/puma/util.rb

@@ -10,18 +10,34 @@ module Puma
       IO.pipe
     end
 
-    # Unescapes a URI escaped string with +encoding+. +encoding+ will be the
-    # target encoding of the string returned, and it defaults to UTF-8
+    # An instance method on Thread has been provided to address https://bugs.ruby-lang.org/issues/13632,
+    # which currently effects some older versions of Ruby: 2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1
+    # Additional context: https://github.com/puma/puma/pull/1345
+    def purge_interrupt_queue
+      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+    end
+
+    # Escapes and unescapes a URI escaped string with
+    # +encoding+. +encoding+ will be the target encoding of the string
+    # returned, and it defaults to UTF-8
     if defined?(::Encoding)
+      def escape(s, encoding = Encoding::UTF_8)
+        URI.encode_www_form_component(s, encoding)
+      end
+
       def unescape(s, encoding = Encoding::UTF_8)
         URI.decode_www_form_component(s, encoding)
       end
     else
+      def escape(s, encoding = nil)
+        URI.encode_www_form_component(s, encoding)
+      end
+
       def unescape(s, encoding = nil)
         URI.decode_www_form_component(s, encoding)
       end
     end
-    module_function :unescape
+    module_function :unescape, :escape
 
     # @version 5.0.0
     def nakayoshi_gc(events)
@@ -61,7 +77,7 @@ module Puma
         end
       end
 
-      return params
+      params
     end
 
     # A case-insensitive Hash that preserves the original case of a

data/lib/puma.rb

@@ -10,9 +10,11 @@ require 'stringio'
 
 require 'thread'
 
+# extension files should not be loaded with `require_relative`
 require 'puma/puma_http11'
-require 'puma/detect'
-require 'puma/json'
+require_relative 'puma/detect'
+require_relative 'puma/json_serialization'
+require_relative 'rack/version_restriction'
 
 module Puma
   autoload :Const, 'puma/const'
@@ -23,7 +25,7 @@ module Puma
   # not in minissl.rb
   HAS_SSL = const_defined?(:MiniSSL, false) && MiniSSL.const_defined?(:Engine, false)
 
-  HAS_UNIX_SOCKET = Object.const_defined? :UNIXSocket
+  HAS_UNIX_SOCKET = Object.const_defined?(:UNIXSocket) && !IS_WINDOWS
 
   if HAS_SSL
     require 'puma/minissl'
@@ -60,7 +62,7 @@ module Puma
 
   # @!attribute [rw] stats_object
   def self.stats
-    Puma::JSON.generate @get_stats.stats
+    Puma::JSONSerialization.generate @get_stats.stats
   end
 
   # @!attribute [r] stats_hash

data/lib/rack/version_restriction.rb

@@ -0,0 +1,15 @@
+begin
+  begin
+    # rack/version exists in Rack 2.2.0 and later, compatible with Ruby 2.3 and later
+    # we prefer to not load Rack
+    require 'rack/version'
+  rescue LoadError
+    require 'rack'
+  end
+
+  # Rack.release is needed for Rack v1, Rack::RELEASE was added in v2
+  if Gem::Version.new(Rack.release) >= Gem::Version.new("3.0.0")
+    raise StandardError.new "Puma 5 is not compatible with Rack 3, please upgrade to Puma 6 or higher."
+  end
+rescue LoadError
+end

data/tools/Dockerfile

@@ -1,6 +1,6 @@
 # Use this Dockerfile to create minimal reproductions of issues
 
-FROM ruby:2.6
+FROM ruby:3.1
 
 # throw errors if Gemfile has been modified since Gemfile.lock
 RUN bundle config --global frozen 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 5.6.9
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -24,9 +24,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server
+description: Puma is a simple, fast, threaded, and highly parallel HTTP 1.1 server
   for Ruby/Rack applications. Puma is intended for use in both development and production
-  environments. It's great for highly concurrent Ruby implementations such as Rubinius
+  environments. It's great for highly parallel Ruby implementations such as Rubinius
   and JRuby as well as as providing process worker support to support CRuby well.
 email:
 - evan@phx.io
@@ -94,7 +94,7 @@ files:
 - lib/puma/events.rb
 - lib/puma/io_buffer.rb
 - lib/puma/jruby_restart.rb
-- lib/puma/json.rb
+- lib/puma/json_serialization.rb
 - lib/puma/launcher.rb
 - lib/puma/minissl.rb
 - lib/puma/minissl/context_builder.rb
@@ -115,6 +115,7 @@ files:
 - lib/puma/thread_pool.rb
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
+- lib/rack/version_restriction.rb
 - tools/Dockerfile
 - tools/trickletest.rb
 homepage: https://puma.io
@@ -140,9 +141,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for
+summary: Puma is a simple, fast, threaded, and highly parallel HTTP 1.1 server for
   Ruby/Rack applications
 test_files: []