puma 6.4.3 → 6.5.0

data/lib/puma/error_logger.rb

@@ -15,14 +15,14 @@ module Puma
 
     LOG_QUEUE = Queue.new
 
-    def initialize(ioerr)
+    def initialize(ioerr, env: ENV)
       @ioerr = ioerr
 
-      @debug = ENV.key? 'PUMA_DEBUG'
+      @debug = env.key?('PUMA_DEBUG')
     end
 
-    def self.stdio
-      new $stderr
+    def self.stdio(env: ENV)
+      new($stderr, env: env)
     end
 
     # Print occurred error details.

data/lib/puma/jruby_restart.rb

@@ -6,22 +6,6 @@ module Puma
   module JRubyRestart
     extend FFI::Library
     ffi_lib 'c'
-
-    attach_function :execlp, [:string, :varargs], :int
     attach_function :chdir, [:string], :int
-    attach_function :fork, [], :int
-    attach_function :exit, [:int], :void
-    attach_function :setsid, [], :int
-
-    def self.chdir_exec(dir, argv)
-      chdir(dir)
-      cmd = argv.first
-      argv = ([:string] * argv.size).zip(argv)
-      argv.flatten!
-      argv << :string
-      argv << nil
-      execlp(cmd, *argv)
-      raise SystemCallError.new(FFI.errno)
-    end
   end
 end

data/lib/puma/launcher.rb

@@ -46,6 +46,8 @@ module Puma
       @original_argv = @argv.dup
       @config        = conf
 
+      env = launcher_args.delete(:env) || ENV
+
       @config.options[:log_writer] = @log_writer
 
       # Advertise the Configuration
@@ -62,7 +64,7 @@ module Puma
       # Load the systemd integration if we detect systemd's NOTIFY_SOCKET.
       # Skip this on JRuby though, because it is incompatible with the systemd
       # integration due to https://github.com/jruby/jruby/issues/6504
-      if ENV["NOTIFY_SOCKET"] && !Puma.jruby?
+      if ENV["NOTIFY_SOCKET"] && !Puma.jruby? && !ENV["PUMA_SKIP_SYSTEMD"]
         @config.plugins.create('systemd')
       end
 
@@ -105,7 +107,7 @@ module Puma
 
       @status = :run
 
-      log_config if ENV['PUMA_LOG_CONFIG']
+      log_config if env['PUMA_LOG_CONFIG']
     end
 
     attr_reader :binder, :log_writer, :events, :config, :options, :restart_dir
@@ -287,7 +289,9 @@ module Puma
         close_binder_listeners
 
         require_relative 'jruby_restart'
-        JRubyRestart.chdir_exec(@restart_dir, restart_args)
+        argv = restart_args
+        JRubyRestart.chdir(@restart_dir)
+        Kernel.exec(*argv)
       elsif Puma.windows?
         close_binder_listeners
 

data/lib/puma/log_writer.rb

@@ -31,31 +31,31 @@ module Puma
     attr_accessor :formatter, :custom_logger
 
     # Create a LogWriter that prints to +stdout+ and +stderr+.
-    def initialize(stdout, stderr)
+    def initialize(stdout, stderr, env: ENV)
       @formatter = DefaultFormatter.new
       @custom_logger = nil
       @stdout = stdout
       @stderr = stderr
 
-      @debug = ENV.key?('PUMA_DEBUG')
-      @error_logger = ErrorLogger.new(@stderr)
+      @debug = env.key?('PUMA_DEBUG')
+      @error_logger = ErrorLogger.new(@stderr, env: env)
     end
 
     DEFAULT = new(STDOUT, STDERR)
 
     # Returns an LogWriter object which writes its status to
     # two StringIO objects.
-    def self.strings
-      LogWriter.new(StringIO.new, StringIO.new)
+    def self.strings(env: ENV)
+      LogWriter.new(StringIO.new, StringIO.new, env: env)
     end
 
-    def self.stdio
-      LogWriter.new($stdout, $stderr)
+    def self.stdio(env: ENV)
+      LogWriter.new($stdout, $stderr, env: env)
     end
 
-    def self.null
+    def self.null(env: ENV)
       n = NullIO.new
-      LogWriter.new(n, n)
+      LogWriter.new(n, n, env: env)
     end
 
     # Write +str+ to +@stdout+

data/lib/puma/minissl/context_builder.rb

@@ -57,6 +57,7 @@ module Puma
 
           ctx.ca = params['ca'] if params['ca']
           ctx.ssl_cipher_filter = params['ssl_cipher_filter'] if params['ssl_cipher_filter']
+          ctx.ssl_ciphersuites = params['ssl_ciphersuites'] if params['ssl_ciphersuites'] && HAS_TLS1_3
 
           ctx.reuse = params['reuse'] if params['reuse']
         end

data/lib/puma/minissl.rb

@@ -289,6 +289,7 @@ module Puma
         attr_reader :cert_pem
         attr_reader :key_pem
         attr_accessor :ssl_cipher_filter
+        attr_accessor :ssl_ciphersuites
         attr_accessor :verification_flags
 
         attr_reader :reuse, :reuse_cache_size, :reuse_timeout

data/lib/puma/null_io.rb

@@ -16,6 +16,10 @@ module Puma
     def each
     end
 
+    def pos
+      0
+    end
+
     # Mimics IO#read with no data.
     #
     def read(length = nil, buffer = nil)
@@ -39,6 +43,11 @@ module Puma
     def rewind
     end
 
+    def seek(pos, whence = 0)
+      raise ArgumentError, "negative length #{pos} given" if pos.negative?
+      0
+    end
+
     def close
     end
 
@@ -71,5 +80,22 @@ module Puma
     def closed?
       false
     end
+
+    def set_encoding(enc)
+      self
+    end
+
+    # per rack spec
+    def external_encoding
+      Encoding::ASCII_8BIT
+    end
+
+    def binmode
+      self
+    end
+
+    def binmode?
+      true
+    end
   end
 end

data/lib/puma/request.rb

@@ -53,7 +53,6 @@ module Puma
       socket  = client.io   # io may be a MiniSSL::Socket
       app_body = nil
 
-
       return false if closed_socket?(socket)
 
       if client.http_content_length_limit_exceeded
@@ -135,7 +134,7 @@ module Puma
       io_buffer.reset
       uncork_socket client.io
       app_body.close if app_body.respond_to? :close
-      client.tempfile&.unlink
+      client&.tempfile_close
       after_reply = env[RACK_AFTER_REPLY] || []
       begin
         after_reply.each { |o| o.call }
@@ -165,9 +164,14 @@ module Puma
       # if the server is at capacity and the listener has a new connection ready.
       # This allows Puma to service connections fairly when the number
       # of concurrent connections exceeds the size of the threadpool.
-      force_keep_alive = requests < @max_fast_inline ||
+      force_keep_alive = if @enable_keep_alives
+        requests < @max_fast_inline ||
         @thread_pool.busy_threads < @max_threads ||
         !client.listener.to_io.wait_readable(0)
+      else
+        # Always set force_keep_alive to false if the server has keep-alives not enabled.
+        false
+      end
 
       resp_info = str_headers(env, status, headers, res_body, io_buffer, force_keep_alive)
 

data/lib/puma/runner.rb

@@ -27,7 +27,7 @@ module Puma
     def wakeup!
       return unless @wakeup
 
-      @wakeup.write "!" unless @wakeup.closed?
+      @wakeup.write Puma::Const::PipeRequest::WAKEUP unless @wakeup.closed?
 
     rescue SystemCallError, IOError
       Puma::Util.purge_interrupt_queue
@@ -91,7 +91,10 @@ module Puma
     end
 
     # @!attribute [r] ruby_engine
+    # @deprecated Use `RUBY_DESCRIPTION` instead
     def ruby_engine
+      warn "Puma::Runner#ruby_engine is deprecated; use RUBY_DESCRIPTION instead. It will be removed in puma v7."
+
       if !defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby"
         "ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
       else
@@ -109,7 +112,8 @@ module Puma
       environment = @options[:environment]
 
       log "Puma starting in #{mode} mode..."
-      log "* Puma version: #{Puma::Const::PUMA_VERSION} (#{ruby_engine}) (\"#{Puma::Const::CODE_NAME}\")"
+      log "* Puma version: #{Puma::Const::PUMA_VERSION} (\"#{Puma::Const::CODE_NAME}\")"
+      log "* Ruby version: #{RUBY_DESCRIPTION}"
       log "*  Min threads: #{min_t}"
       log "*  Max threads: #{max_t}"
       log "*  Environment: #{environment}"

data/lib/puma/server.rb

@@ -18,6 +18,9 @@ require 'io/wait' unless Puma::HAS_NATIVE_IO_WAIT
 
 module Puma
 
+  # This method was private on Ruby 2.4 but became public on Ruby 2.5+:
+  Thread.send(:attr_accessor, :puma_server)
+
   # The HTTP Server itself. Serves out a single Rack app.
   #
   # This class is used by the `Puma::Single` and `Puma::Cluster` classes
@@ -32,6 +35,7 @@ module Puma
     include Puma::Const
     include Request
 
+    attr_reader :options
     attr_reader :thread
     attr_reader :log_writer
     attr_reader :events
@@ -46,7 +50,6 @@ module Puma
     attr_accessor :app
     attr_accessor :binder
 
-    THREAD_LOCAL_KEY = :puma_server
 
     # Create a server for the rack app +app+.
     #
@@ -92,6 +95,7 @@ module Puma
       @max_threads               = @options[:max_threads]
       @queue_requests            = @options[:queue_requests]
       @max_fast_inline           = @options[:max_fast_inline]
+      @enable_keep_alives        = @options[:enable_keep_alives]
       @io_selector_backend       = @options[:io_selector_backend]
       @http_content_length_limit = @options[:http_content_length_limit]
 
@@ -130,7 +134,7 @@ module Puma
     class << self
       # @!attribute [r] current
       def current
-        Thread.current[THREAD_LOCAL_KEY]
+        Thread.current.puma_server
       end
 
       # :nodoc:
@@ -242,7 +246,7 @@ module Puma
 
       @status = :run
 
-      @thread_pool = ThreadPool.new(thread_name, @options) { |client| process_client client }
+      @thread_pool = ThreadPool.new(thread_name, options) { |client| process_client client }
 
       if @queue_requests
         @reactor = Reactor.new(@io_selector_backend) { |c| reactor_wakeup c }
@@ -250,8 +254,8 @@ module Puma
       end
 
 
-      @thread_pool.auto_reap! if @options[:reaping_time]
-      @thread_pool.auto_trim! if @options[:auto_trim_time]
+      @thread_pool.auto_reap! if options[:reaping_time]
+      @thread_pool.auto_trim! if options[:auto_trim_time]
 
       @check, @notify = Puma::Util.pipe unless @notify
 
@@ -315,15 +319,15 @@ module Puma
         sockets = [check] + @binder.ios
         pool = @thread_pool
         queue_requests = @queue_requests
-        drain = @options[:drain_on_shutdown] ? 0 : nil
+        drain = options[:drain_on_shutdown] ? 0 : nil
 
-        addr_send_name, addr_value = case @options[:remote_address]
+        addr_send_name, addr_value = case options[:remote_address]
         when :value
-          [:peerip=, @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]]
+          [:expect_proxy_proto=, options[:remote_address_proxy_protocol]]
         else
           [nil, nil]
         end
@@ -336,7 +340,7 @@ module Puma
                 @idle_timeout_reached = true
 
                 if @clustered
-                  @worker_write << "i#{Process.pid}\n" rescue nil
+                  @worker_write << "#{PipeRequest::IDLE}#{Process.pid}\n" rescue nil
                   next
                 else
                   @log_writer.log "- Idle timeout reached"
@@ -349,7 +353,7 @@ module Puma
 
             if @idle_timeout_reached && @clustered
               @idle_timeout_reached = false
-              @worker_write << "i#{Process.pid}\n" rescue nil
+              @worker_write << "#{PipeRequest::IDLE}#{Process.pid}\n" rescue nil
             end
 
             ios.first.each do |sock|
@@ -357,7 +361,7 @@ module Puma
                 break if handle_check
               else
                 pool.wait_until_not_full
-                pool.wait_for_less_busy_worker(@options[:wait_for_less_busy_worker])
+                pool.wait_for_less_busy_worker(options[:wait_for_less_busy_worker]) if @clustered
 
                 io = begin
                   sock.accept_nonblock
@@ -437,9 +441,9 @@ module Puma
     # Return true if one or more requests were processed.
     def process_client(client)
       # Advertise this server into the thread
-      Thread.current[THREAD_LOCAL_KEY] = self
+      Thread.current.puma_server = self
 
-      clean_thread_locals = @options[:clean_thread_locals]
+      clean_thread_locals = options[:clean_thread_locals]
       close_socket = true
 
       requests = 0
@@ -548,7 +552,7 @@ module Puma
     # A fallback rack response if +@app+ raises as exception.
     #
     def lowlevel_error(e, env, status=500)
-      if handler = @options[:lowlevel_error_handler]
+      if handler = options[:lowlevel_error_handler]
         if handler.arity == 1
           return handler.call(e)
         elsif handler.arity == 2
@@ -569,14 +573,13 @@ module Puma
     def response_to_error(client, requests, err, status_code)
       status, headers, res_body = lowlevel_error(err, client.env, status_code)
       prepare_response(status, headers, res_body, requests, client)
-      client.write_error(status_code)
     end
     private :response_to_error
 
     # Wait for all outstanding requests to finish.
     #
     def graceful_shutdown
-      if @options[:shutdown_debug]
+      if options[:shutdown_debug]
         threads = Thread.list
         total = threads.size
 
@@ -596,7 +599,7 @@ module Puma
       end
 
       if @thread_pool
-        if timeout = @options[:force_shutdown_after]
+        if timeout = options[:force_shutdown_after]
           @thread_pool.shutdown timeout.to_f
         else
           @thread_pool.shutdown
@@ -648,8 +651,12 @@ module Puma
     # Returns a hash of stats about the running server for reporting purposes.
     # @version 5.0.0
     # @!attribute [r] stats
+    # @return [Hash] hash containing stat info from `Server` and `ThreadPool`
     def stats
-      STAT_METHODS.map {|name| [name, send(name) || 0]}.to_h
+      stats = @thread_pool&.stats || {}
+      stats[:max_threads]    = @max_threads
+      stats[:requests_count] = @requests_count
+      stats
     end
 
     # below are 'delegations' to binder

data/lib/puma/thread_pool.rb

@@ -85,6 +85,17 @@ module Puma
       end
     end
 
+    # generate stats hash so as not to perform multiple locks
+    # @return [Hash] hash containing stat info from ThreadPool
+    def stats
+      with_mutex do
+        { backlog: @todo.size,
+          running: @spawned,
+          pool_capacity: @waiting + (@max - @spawned)
+        }
+      end
+    end
+
     # How many objects have yet to be processed by the pool?
     #
     def backlog

data/lib/puma/util.rb

@@ -11,7 +11,7 @@ module Puma
     end
 
     # 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
+    # which currently affects 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

data/lib/rack/handler/puma.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
-# This module is used as an 'include' file in code at bottom of file
 module Puma
+
+  # This module is used as an 'include' file in code at bottom of file. It loads
+  # into either `Rackup::Handler::Puma` or `Rack::Handler::Puma`.
+
   module RackHandler
     DEFAULT_OPTIONS = {
       :Verbose => false,
@@ -93,9 +96,9 @@ module Puma
     def set_host_port_to_config(host, port, config)
       config.clear_binds! if host || port
 
-      if host && (host[0,1] == '.' || host[0,1] == '/')
+      if host&.start_with? '.', '/', '@'
         config.bind "unix://#{host}"
-      elsif host && host =~ /^ssl:\/\//
+      elsif host&.start_with? 'ssl://'
         uri = URI.parse(host)
         uri.port ||= port || ::Puma::Configuration::DEFAULTS[:tcp_port]
         config.bind uri.to_s
@@ -115,7 +118,7 @@ module Puma
 end
 
 # rackup was removed in Rack 3, it is now a separate gem
-if Object.const_defined? :Rackup
+if Object.const_defined?(:Rackup) && ::Rackup.const_defined?(:Handler)
   module Rackup
     module Handler
       module Puma
@@ -127,7 +130,7 @@ if Object.const_defined? :Rackup
     end
   end
 else
-  do_register = Object.const_defined?(:Rack) && Rack.release < '3'
+  do_register = Object.const_defined?(:Rack) && ::Rack.release < '3'
   module Rack
     module Handler
       module Puma

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 6.4.3
+  version: 6.5.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -24,10 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-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 parallel Ruby implementations such as Rubinius
-  and JRuby as well as as providing process worker support to support CRuby well.
+description: |
+  Puma is a simple, fast, multi-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 parallel Ruby implementations such as
+  JRuby and TruffleRuby as well as as providing process worker support to support CRuby well.
 email:
 - evan@phx.io
 executables:
@@ -50,6 +51,7 @@ files:
 - docs/images/puma-connection-flow-no-reactor.png
 - docs/images/puma-connection-flow.png
 - docs/images/puma-general-arch.png
+- docs/java_options.md
 - docs/jungle/README.md
 - docs/jungle/rc.d/README.md
 - docs/jungle/rc.d/puma
@@ -145,9 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Puma is a simple, fast, threaded, and highly parallel HTTP 1.1 server for
-  Ruby/Rack applications
+summary: A Ruby/Rack web server built for parallelism.
 test_files: []