puma 6.6.1 → 7.0.3

data/lib/puma/thread_pool.rb

@@ -25,6 +25,8 @@ module Puma
     # up its work before leaving the thread to die on the vine.
     SHUTDOWN_GRACE_TIME = 5 # seconds
 
+    attr_reader :out_of_band_running
+
     # Maintain a minimum of +min+ and maximum of +max+ threads
     # in the pool.
     #
@@ -35,9 +37,9 @@ module Puma
       @not_empty = ConditionVariable.new
       @not_full = ConditionVariable.new
       @mutex = Mutex.new
+      @todo = Queue.new
 
-      @todo = []
-
+      @backlog_max = 0
       @spawned = 0
       @waiting = 0
 
@@ -50,7 +52,8 @@ module Puma
       @shutdown_grace_time = Float(options[:pool_shutdown_grace_time] || SHUTDOWN_GRACE_TIME)
       @block = block
       @out_of_band = options[:out_of_band]
-      @clean_thread_locals = options[:clean_thread_locals]
+      @out_of_band_running = false
+      @out_of_band_condvar = ConditionVariable.new
       @before_thread_start = options[:before_thread_start]
       @before_thread_exit = options[:before_thread_exit]
       @reaping_time = options[:reaping_time]
@@ -79,30 +82,37 @@ module Puma
 
     attr_reader :spawned, :trim_requested, :waiting
 
-    def self.clean_thread_locals
-      Thread.current.keys.each do |key| # rubocop: disable Style/HashEachMethods
-        Thread.current[key] = nil unless key == :__recursive_key__
-      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
+        temp = @backlog_max
+        @backlog_max = 0
         { backlog: @todo.size,
           running: @spawned,
           pool_capacity: @waiting + (@max - @spawned),
-          busy_threads: @spawned - @waiting + @todo.size
+          busy_threads: @spawned - @waiting + @todo.size,
+          backlog_max: temp
         }
       end
     end
 
+    def reset_max
+      with_mutex { @backlog_max = 0 }
+    end
+
     # How many objects have yet to be processed by the pool?
     #
     def backlog
       with_mutex { @todo.size }
     end
 
+    # The maximum size of the backlog
+    #
+    def backlog_max
+      with_mutex { @backlog_max }
+    end
+
     # @!attribute [r] pool_capacity
     def pool_capacity
       waiting + (@max - spawned)
@@ -159,10 +169,6 @@ module Puma
             work = todo.shift
           end
 
-          if @clean_thread_locals
-            ThreadPool.clean_thread_locals
-          end
-
           begin
             @out_of_band_pending = true if block.call(work)
           rescue Exception => e
@@ -183,7 +189,7 @@ module Puma
 
       @before_thread_start.each do |b|
         begin
-          b.call
+          b[:block].call
         rescue Exception => e
           STDERR.puts "WARNING before_thread_start hook failed with exception (#{e.class}) #{e.message}"
         end
@@ -198,7 +204,7 @@ module Puma
 
       @before_thread_exit.each do |b|
         begin
-          b.call
+          b[:block].call
         rescue Exception => e
           STDERR.puts "WARNING before_thread_exit hook failed with exception (#{e.class}) #{e.message}"
         end
@@ -214,16 +220,27 @@ module Puma
 
       # we execute on idle hook when all threads are free
       return false unless @spawned == @waiting
-
-      @out_of_band.each(&:call)
+      @out_of_band_running = true
+      @out_of_band.each { |b| b[:block].call }
       true
     rescue Exception => e
       STDERR.puts "Exception calling out_of_band_hook: #{e.message} (#{e.class})"
       true
+    ensure
+      @out_of_band_running = false
+      @out_of_band_condvar.broadcast
     end
 
     private :trigger_out_of_band_hook
 
+    def wait_while_out_of_band_running
+      return unless @out_of_band_running
+
+      with_mutex do
+        @out_of_band_condvar.wait(@mutex) while @out_of_band_running
+      end
+    end
+
     # @version 5.0.0
     def with_mutex(&block)
       @mutex.owned? ?
@@ -239,6 +256,8 @@ module Puma
         end
 
         @todo << work
+        t = @todo.size
+        @backlog_max = t if t > @backlog_max
 
         if @waiting < @todo.size and @spawned < @max
           spawn_thread
@@ -248,69 +267,6 @@ module Puma
       end
     end
 
-    # This method is used by `Puma::Server` to let the server know when
-    # the thread pool can pull more requests from the socket and
-    # pass to the reactor.
-    #
-    # The general idea is that the thread pool can only work on a fixed
-    # number of requests at the same time. If it is already processing that
-    # number of requests then it is at capacity. If another Puma process has
-    # spare capacity, then the request can be left on the socket so the other
-    # worker can pick it up and process it.
-    #
-    # For example: if there are 5 threads, but only 4 working on
-    # requests, this method will not wait and the `Puma::Server`
-    # can pull a request right away.
-    #
-    # If there are 5 threads and all 5 of them are busy, then it will
-    # pause here, and wait until the `not_full` condition variable is
-    # signaled, usually this indicates that a request has been processed.
-    #
-    # It's important to note that even though the server might accept another
-    # request, it might not be added to the `@todo` array right away.
-    # For example if a slow client has only sent a header, but not a body
-    # 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 buffered request
-    # makes it through the reactor and can then be processed by the thread pool.
-    def wait_until_not_full
-      with_mutex do
-        while true
-          return if @shutdown
-
-          # If we can still spin up new threads and there
-          # is work queued that cannot be handled by waiting
-          # threads, then accept more work until we would
-          # spin up the max number of threads.
-          return if busy_threads < @max
-
-          @not_full.wait @mutex
-        end
-      end
-    end
-
-    # @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?
-
-      with_mutex do
-        return if @shutdown
-
-        # do not delay, if we are not busy
-        return unless busy_threads > 0
-
-        # this will be signaled once a request finishes,
-        # which can happen earlier than delay
-        @not_full.wait @mutex, delay_s
-      end
-    end
-
     # If there are any free threads in the pool, tell one to go ahead
     # and exit. If +force+ is true, then a trim request is requested
     # even if all threads are being utilized.

data/lib/puma/util.rb

@@ -10,13 +10,6 @@ module Puma
       IO.pipe
     end
 
-    # An instance method on Thread has been provided to address https://bugs.ruby-lang.org/issues/13632,
-    # 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
-    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

data/lib/puma.rb

@@ -75,4 +75,14 @@ module Puma
   def self.set_thread_name(name)
     Thread.current.name = "puma #{name}"
   end
+
+  # Shows deprecated warning for renamed methods.
+  # @example
+  #   Puma.deprecate_method_change :on_booted, __callee__, __method__
+  #
+  def self.deprecate_method_change(method_old, method_caller, method_new)
+    if method_old == method_caller
+      warn "Use '#{method_new}', '#{method_caller}' is deprecated and will be removed in v8"
+    end
+  end
 end

data/lib/rack/handler/puma.rb

@@ -32,7 +32,7 @@ module Puma
 
       @events = options[:events] || ::Puma::Events.new
 
-      conf = ::Puma::Configuration.new(options, default_options.merge({events: @events})) do |user_config, file_config, default_config|
+      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
@@ -72,7 +72,7 @@ module Puma
 
       log_writer = options.delete(:Silent) ? ::Puma::LogWriter.strings : ::Puma::LogWriter.stdio
 
-      launcher = ::Puma::Launcher.new(conf, :log_writer => log_writer, events: @events)
+      launcher = ::Puma::Launcher.new(conf, log_writer: log_writer, events: @events)
 
       yield launcher if block_given?
       begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 6.6.1
+  version: 7.0.3
 platform: ruby
 authors:
 - Evan Phoenix
@@ -138,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="