puma 5.6.9-java → 6.6.0-java

data/lib/puma/thread_pool.rb

@@ -2,6 +2,8 @@
 
 require 'thread'
 
+require_relative 'io_buffer'
+
 module Puma
   # Internal Docs for A simple thread pool management object.
   #
@@ -29,7 +31,7 @@ module Puma
     # The block passed is the work that will be performed in each
     # thread.
     #
-    def initialize(name, min, max, *extra, &block)
+    def initialize(name, options = {}, &block)
       @not_empty = ConditionVariable.new
       @not_full = ConditionVariable.new
       @mutex = Mutex.new
@@ -40,10 +42,19 @@ module Puma
       @waiting = 0
 
       @name = name
-      @min = Integer(min)
-      @max = Integer(max)
+      @min = Integer(options[:min_threads])
+      @max = Integer(options[:max_threads])
+      # Not an 'exposed' option, options[:pool_shutdown_grace_time] is used in CI
+      # to shorten @shutdown_grace_time from SHUTDOWN_GRACE_TIME. Parallel CI
+      # makes stubbing constants difficult.
+      @shutdown_grace_time = Float(options[:pool_shutdown_grace_time] || SHUTDOWN_GRACE_TIME)
       @block = block
-      @extra = extra
+      @out_of_band = options[:out_of_band]
+      @clean_thread_locals = options[:clean_thread_locals]
+      @before_thread_start = options[:before_thread_start]
+      @before_thread_exit = options[:before_thread_exit]
+      @reaping_time = options[:reaping_time]
+      @auto_trim_time = options[:auto_trim_time]
 
       @shutdown = false
 
@@ -62,14 +73,11 @@ module Puma
         end
       end
 
-      @clean_thread_locals = false
       @force_shutdown = false
       @shutdown_mutex = Mutex.new
     end
 
     attr_reader :spawned, :trim_requested, :waiting
-    attr_accessor :clean_thread_locals
-    attr_accessor :out_of_band_hook # @version 5.0.0
 
     def self.clean_thread_locals
       Thread.current.keys.each do |key| # rubocop: disable Style/HashEachMethods
@@ -77,6 +85,18 @@ 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),
+          busy_threads: @spawned - @waiting + @todo.size
+        }
+      end
+    end
+
     # How many objects have yet to be processed by the pool?
     #
     def backlog
@@ -101,6 +121,7 @@ module Puma
     def spawn_thread
       @spawned += 1
 
+      trigger_before_thread_start_hooks
       th = Thread.new(@spawned) do |spawned|
         Puma.set_thread_name '%s tp %03i' % [@name, spawned]
         todo  = @todo
@@ -109,8 +130,6 @@ module Puma
         not_empty = @not_empty
         not_full = @not_full
 
-        extra = @extra.map { |i| i.new }
-
         while true
           work = nil
 
@@ -121,6 +140,7 @@ module Puma
                 @spawned -= 1
                 @workers.delete th
                 not_full.signal
+                trigger_before_thread_exit_hooks
                 Thread.exit
               end
 
@@ -144,7 +164,7 @@ module Puma
           end
 
           begin
-            @out_of_band_pending = true if block.call(work, *extra)
+            @out_of_band_pending = true if block.call(work)
           rescue Exception => e
             STDERR.puts "Error reached top of thread-pool: #{e.message} (#{e.class})"
           end
@@ -158,14 +178,44 @@ module Puma
 
     private :spawn_thread
 
+    def trigger_before_thread_start_hooks
+      return unless @before_thread_start&.any?
+
+      @before_thread_start.each do |b|
+        begin
+          b.call
+        rescue Exception => e
+          STDERR.puts "WARNING before_thread_start hook failed with exception (#{e.class}) #{e.message}"
+        end
+      end
+      nil
+    end
+
+    private :trigger_before_thread_start_hooks
+
+    def trigger_before_thread_exit_hooks
+      return unless @before_thread_exit&.any?
+
+      @before_thread_exit.each do |b|
+        begin
+          b.call
+        rescue Exception => e
+          STDERR.puts "WARNING before_thread_exit hook failed with exception (#{e.class}) #{e.message}"
+        end
+      end
+      nil
+    end
+
+    private :trigger_before_thread_exit_hooks
+
     # @version 5.0.0
     def trigger_out_of_band_hook
-      return false unless out_of_band_hook && out_of_band_hook.any?
+      return false unless @out_of_band&.any?
 
       # we execute on idle hook when all threads are free
       return false unless @spawned == @waiting
 
-      out_of_band_hook.each(&:call)
+      @out_of_band.each(&:call)
       true
     rescue Exception => e
       STDERR.puts "Exception calling out_of_band_hook: #{e.message} (#{e.class})"
@@ -319,13 +369,13 @@ module Puma
       end
     end
 
-    def auto_trim!(timeout=30)
-      @auto_trim = Automaton.new(self, timeout, "#{@name} threadpool trimmer", :trim)
+    def auto_trim!(timeout=@auto_trim_time)
+      @auto_trim = Automaton.new(self, timeout, "#{@name} tp trim", :trim)
       @auto_trim.start!
     end
 
-    def auto_reap!(timeout=5)
-      @reaper = Automaton.new(self, timeout, "#{@name} threadpool reaper", :reap)
+    def auto_reap!(timeout=@reaping_time)
+      @reaper = Automaton.new(self, timeout, "#{@name} tp reap", :reap)
       @reaper.start!
     end
 
@@ -344,8 +394,8 @@ module Puma
 
     # Tell all threads in the pool to exit and wait for them to finish.
     # Wait +timeout+ seconds then raise +ForceShutdown+ in remaining threads.
-    # Next, wait an extra +grace+ seconds then force-kill remaining threads.
-    # Finally, wait +kill_grace+ seconds for remaining threads to exit.
+    # Next, wait an extra +@shutdown_grace_time+ seconds then force-kill remaining
+    # threads. Finally, wait 1 second for remaining threads to exit.
     #
     def shutdown(timeout=-1)
       threads = with_mutex do
@@ -354,8 +404,8 @@ module Puma
         @not_empty.broadcast
         @not_full.broadcast
 
-        @auto_trim.stop if @auto_trim
-        @reaper.stop if @reaper
+        @auto_trim&.stop
+        @reaper&.stop
         # dup workers so that we join them all safely
         @workers.dup
       end
@@ -382,7 +432,7 @@ module Puma
             t.raise ForceShutdown if t[:with_force_shutdown]
           end
         end
-        join.call(SHUTDOWN_GRACE_TIME)
+        join.call(@shutdown_grace_time)
 
         # If threads are _still_ running, forcefully kill them and wait to finish.
         threads.each(&:kill)

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
@@ -39,17 +39,6 @@ module Puma
     end
     module_function :unescape, :escape
 
-    # @version 5.0.0
-    def nakayoshi_gc(events)
-      events.log "! Promoting existing objects to old generation..."
-      4.times { GC.start(full_mark: false) }
-      if GC.respond_to?(:compact)
-        events.log "! Compacting..."
-        GC.compact
-      end
-      events.log "! Friendly fork preparation complete."
-    end
-
     DEFAULT_SEP = /[&;] */n
 
     # Stolen from Mongrel, with some small modifications:

data/lib/puma.rb

@@ -3,23 +3,24 @@
 # Standard libraries
 require 'socket'
 require 'tempfile'
-require 'time'
-require 'etc'
 require 'uri'
 require 'stringio'
 
 require 'thread'
 
-# extension files should not be loaded with `require_relative`
+# use require, see https://github.com/puma/puma/pull/2381
 require 'puma/puma_http11'
+
 require_relative 'puma/detect'
 require_relative 'puma/json_serialization'
-require_relative 'rack/version_restriction'
 
 module Puma
-  autoload :Const, 'puma/const'
-  autoload :Server, 'puma/server'
-  autoload :Launcher, 'puma/launcher'
+  # when Puma is loaded via `Puma::CLI`, all files are loaded via
+  # `require_relative`.  The below are for non-standard loading
+  autoload :Const,     "#{__dir__}/puma/const"
+  autoload :Server,    "#{__dir__}/puma/server"
+  autoload :Launcher,  "#{__dir__}/puma/launcher"
+  autoload :LogWriter, "#{__dir__}/puma/log_writer"
 
   # at present, MiniSSL::Engine is only defined in extension code (puma_http11),
   # not in minissl.rb
@@ -28,7 +29,7 @@ module Puma
   HAS_UNIX_SOCKET = Object.const_defined?(:UNIXSocket) && !IS_WINDOWS
 
   if HAS_SSL
-    require 'puma/minissl'
+    require_relative 'puma/minissl'
   else
     module MiniSSL
       # this class is defined so that it exists when Puma is compiled
@@ -71,9 +72,7 @@ module Puma
     @get_stats.stats
   end
 
-  # Thread name is new in Ruby 2.3
   def self.set_thread_name(name)
-    return unless Thread.current.respond_to?(:name=)
     Thread.current.name = "puma #{name}"
   end
 end

data/lib/rack/handler/puma.rb

@@ -1,114 +1,144 @@
 # frozen_string_literal: true
 
-require 'rack/handler'
-
-module Rack
-  module Handler
-    module Puma
-      DEFAULT_OPTIONS = {
-        :Verbose => false,
-        :Silent  => false
-      }
-
-      def self.config(app, options = {})
-        require 'puma'
-        require 'puma/configuration'
-        require 'puma/events'
-        require 'puma/launcher'
-
-        default_options = DEFAULT_OPTIONS.dup
-
-        # Libraries pass in values such as :Port and there is no way to determine
-        # if it is a default provided by the library or a special value provided
-        # by the user. A special key `user_supplied_options` can be passed. This
-        # contains an array of all explicitly defined user options. We then
-        # know that all other values are defaults
-        if user_supplied_options = options.delete(:user_supplied_options)
-          (options.keys - user_supplied_options).each do |k|
-            default_options[k] = options.delete(k)
-          end
+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,
+      :Silent  => false
+    }
+
+    def config(app, options = {})
+      require_relative '../../puma'
+      require_relative '../../puma/configuration'
+      require_relative '../../puma/log_writer'
+      require_relative '../../puma/launcher'
+
+      default_options = DEFAULT_OPTIONS.dup
+
+      # Libraries pass in values such as :Port and there is no way to determine
+      # if it is a default provided by the library or a special value provided
+      # by the user. A special key `user_supplied_options` can be passed. This
+      # contains an array of all explicitly defined user options. We then
+      # know that all other values are defaults
+      if user_supplied_options = options.delete(:user_supplied_options)
+        (options.keys - user_supplied_options).each do |k|
+          default_options[k] = options.delete(k)
         end
+      end
 
-        conf = ::Puma::Configuration.new(options, default_options) do |user_config, file_config, default_config|
-          if options.delete(:Verbose)
-            require 'rack/common_logger'
-            app = Rack::CommonLogger.new(app, STDOUT)
-          end
+      @events = options[:events] || ::Puma::Events.new
 
-          if options[:environment]
-            user_config.environment options[:environment]
+      conf = ::Puma::Configuration.new(options, default_options.merge({events: @events})) do |user_config, file_config, default_config|
+        if options.delete(:Verbose)
+          begin
+            require 'rack/commonlogger'  # Rack 1.x
+          rescue LoadError
+            require 'rack/common_logger' # Rack 2 and later
           end
+          app = ::Rack::CommonLogger.new(app, STDOUT)
+        end
 
-          if options[:Threads]
-            min, max = options.delete(:Threads).split(':', 2)
-            user_config.threads min, max
-          end
+        if options[:environment]
+          user_config.environment options[:environment]
+        end
 
-          if options[:Host] || options[:Port]
-            host = options[:Host] || default_options[:Host]
-            port = options[:Port] || default_options[:Port]
-            self.set_host_port_to_config(host, port, user_config)
-          end
+        if options[:Threads]
+          min, max = options.delete(:Threads).split(':', 2)
+          user_config.threads min, max
+        end
 
-          if default_options[:Host]
-            file_config.set_default_host(default_options[:Host])
-          end
-          self.set_host_port_to_config(default_options[:Host], default_options[:Port], default_config)
+        if options[:Host] || options[:Port]
+          host = options[:Host] || default_options[:Host]
+          port = options[:Port] || default_options[:Port]
+          self.set_host_port_to_config(host, port, user_config)
+        end
 
-          user_config.app app
+        if default_options[:Host]
+          file_config.set_default_host(default_options[:Host])
         end
-        conf
+        self.set_host_port_to_config(default_options[:Host], default_options[:Port], default_config)
+
+        user_config.app app
       end
+      conf
+    end
 
-      def self.run(app, **options)
-        conf   = self.config(app, options)
+    def run(app, **options)
+      conf = self.config(app, options)
 
-        events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio
+      log_writer = options.delete(:Silent) ? ::Puma::LogWriter.strings : ::Puma::LogWriter.stdio
 
-        launcher = ::Puma::Launcher.new(conf, :events => events)
+      launcher = ::Puma::Launcher.new(conf, :log_writer => log_writer, events: @events)
 
-        yield launcher if block_given?
-        begin
-          launcher.run
-        rescue Interrupt
-          puts "* Gracefully stopping, waiting for requests to finish"
-          launcher.stop
-          puts "* Goodbye!"
-        end
+      yield launcher if block_given?
+      begin
+        launcher.run
+      rescue Interrupt
+        puts "* Gracefully stopping, waiting for requests to finish"
+        launcher.stop
+        puts "* Goodbye!"
       end
+    end
 
-      def self.valid_options
-        {
-          "Host=HOST"       => "Hostname to listen on (default: localhost)",
-          "Port=PORT"       => "Port to listen on (default: 8080)",
-          "Threads=MIN:MAX" => "min:max threads to use (default 0:16)",
-          "Verbose"         => "Don't report each request (default: false)"
-        }
-      end
+    def valid_options
+      {
+        "Host=HOST"       => "Hostname to listen on (default: localhost)",
+        "Port=PORT"       => "Port to listen on (default: 8080)",
+        "Threads=MIN:MAX" => "min:max threads to use (default 0:16)",
+        "Verbose"         => "Don't report each request (default: false)"
+      }
+    end
 
-      def self.set_host_port_to_config(host, port, config)
-        config.clear_binds! if host || port
+    def set_host_port_to_config(host, port, config)
+      config.clear_binds! if host || port
 
-        if host && (host[0,1] == '.' || host[0,1] == '/')
-          config.bind "unix://#{host}"
-        elsif host && host =~ /^ssl:\/\//
-          uri = URI.parse(host)
-          uri.port ||= port || ::Puma::Configuration::DefaultTCPPort
-          config.bind uri.to_s
-        else
+      if host&.start_with? '.', '/', '@'
+        config.bind "unix://#{host}"
+      elsif host&.start_with? 'ssl://'
+        uri = URI.parse(host)
+        uri.port ||= port || ::Puma::Configuration::DEFAULTS[:tcp_port]
+        config.bind uri.to_s
+      else
 
-          if host
-            port ||= ::Puma::Configuration::DefaultTCPPort
-          end
+        if host
+          port ||= ::Puma::Configuration::DEFAULTS[:tcp_port]
+        end
 
-          if port
-            host ||= ::Puma::Configuration::DefaultTCPHost
-            config.port port, host
-          end
+        if port
+          host ||= ::Puma::Configuration::DEFAULTS[:tcp_host]
+          config.port port, host
         end
       end
     end
+  end
+end
 
-    register :puma, Puma
+# rackup was removed in Rack 3, it is now a separate gem
+if Object.const_defined?(:Rackup) && ::Rackup.const_defined?(:Handler)
+  module Rackup
+    module Handler
+      module Puma
+        class << self
+          include ::Puma::RackHandler
+        end
+      end
+      register :puma, Puma
+    end
+  end
+else
+  do_register = Object.const_defined?(:Rack) && ::Rack.release < '3'
+  module Rack
+    module Handler
+      module Puma
+        class << self
+          include ::Puma::RackHandler
+        end
+      end
+    end
   end
+  ::Rack::Handler.register(:puma, ::Rack::Handler::Puma) if do_register
 end

data/tools/Dockerfile

@@ -1,6 +1,6 @@
 # Use this Dockerfile to create minimal reproductions of issues
 
-FROM ruby:3.1
+FROM ruby:3.2
 
 # throw errors if Gemfile has been modified since Gemfile.lock
 RUN bundle config --global frozen 1
@@ -8,7 +8,7 @@ RUN bundle config --global frozen 1
 WORKDIR /usr/src/app
 
 COPY . .
-RUN gem install bundler
+
 RUN bundle install
 RUN bundle exec rake compile
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.6.9
+  version: 6.6.0
 platform: java
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -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:
@@ -49,6 +50,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
@@ -61,6 +63,8 @@ files:
 - docs/signals.md
 - docs/stats.md
 - docs/systemd.md
+- docs/testing_benchmarks_local_files.md
+- docs/testing_test_rackup_ci_files.md
 - ext/puma_http11/PumaHttp11Service.java
 - ext/puma_http11/ext_help.h
 - ext/puma_http11/extconf.rb
@@ -95,27 +99,28 @@ files:
 - lib/puma/jruby_restart.rb
 - lib/puma/json_serialization.rb
 - lib/puma/launcher.rb
+- lib/puma/launcher/bundle_pruner.rb
+- lib/puma/log_writer.rb
 - lib/puma/minissl.rb
 - lib/puma/minissl/context_builder.rb
 - lib/puma/null_io.rb
 - lib/puma/plugin.rb
+- lib/puma/plugin/systemd.rb
 - lib/puma/plugin/tmp_restart.rb
 - lib/puma/puma_http11.jar
-- lib/puma/queue_close.rb
 - lib/puma/rack/builder.rb
 - lib/puma/rack/urlmap.rb
 - lib/puma/rack_default.rb
 - lib/puma/reactor.rb
 - lib/puma/request.rb
 - lib/puma/runner.rb
+- lib/puma/sd_notify.rb
 - lib/puma/server.rb
 - lib/puma/single.rb
 - lib/puma/state_file.rb
-- lib/puma/systemd.rb
 - 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
@@ -126,6 +131,7 @@ metadata:
   changelog_uri: https://github.com/puma/puma/blob/master/History.md
   homepage_uri: https://puma.io
   source_code_uri: https://github.com/puma/puma
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -134,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -144,6 +150,5 @@ requirements: []
 rubygems_version: 3.3.26
 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: []

data/lib/puma/queue_close.rb

@@ -1,26 +0,0 @@
-class ClosedQueueError < StandardError; end
-module Puma
-
-  # Queue#close was added in Ruby 2.3.
-  # Add a simple implementation for earlier Ruby versions.
-  #
-  module QueueClose
-    def close
-      num_waiting.times {push nil}
-      @closed = true
-    end
-    def closed?
-      @closed ||= false
-    end
-    def push(object)
-      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