puma 6.6.0 → 8.0.2

data/lib/puma/events.rb

@@ -3,7 +3,7 @@
 module Puma
 
   # This is an event sink used by `Puma::Server` to handle
-  # lifecycle events such as :on_booted, :on_restart, and :on_stopped.
+  # lifecycle events such as :after_booted, :before_restart, and :after_stopped.
   # Using `Puma::DSL` it is possible to register callback hooks
   # for each event type.
   class Events
@@ -30,28 +30,43 @@ module Puma
       h
     end
 
+    def after_booted(&block)
+      register(:after_booted, &block)
+    end
+
+    def before_restart(&block)
+      register(:before_restart, &block)
+    end
+
+    def after_stopped(&block)
+      register(:after_stopped, &block)
+    end
+
     def on_booted(&block)
-      register(:on_booted, &block)
+      Puma.deprecate_method_change :on_booted, __callee__, :after_booted
+      after_booted(&block)
     end
 
     def on_restart(&block)
-      register(:on_restart, &block)
+      Puma.deprecate_method_change :on_restart, __callee__, :before_restart
+      before_restart(&block)
     end
 
     def on_stopped(&block)
-      register(:on_stopped, &block)
+      Puma.deprecate_method_change :on_stopped, __callee__, :after_stopped
+      after_stopped(&block)
     end
 
-    def fire_on_booted!
-      fire(:on_booted)
+    def fire_after_booted!
+      fire(:after_booted)
     end
 
-    def fire_on_restart!
-      fire(:on_restart)
+    def fire_before_restart!
+      fire(:before_restart)
     end
 
-    def fire_on_stopped!
-      fire(:on_stopped)
+    def fire_after_stopped!
+      fire(:after_stopped)
     end
   end
 end

data/lib/puma/io_buffer.rb

@@ -34,13 +34,17 @@ module Puma
 
     alias_method :clear, :reset
 
-    # before Ruby 2.5, `write` would only take one argument
-    if RUBY_VERSION >= '2.5' && RUBY_ENGINE != 'truffleruby'
-      alias_method :append, :write
-    else
+    # Create an `IoBuffer#append` method that accepts multiple strings and writes them
+    if RUBY_ENGINE == 'truffleruby'
+      # truffleruby (24.2.1, like ruby 3.3.7)
+      #   StringIO.new.write("a", "b") # => `write': wrong number of arguments (given 2, expected 1) (ArgumentError)
       def append(*strs)
         strs.each { |str| write str }
       end
+    else
+      # Ruby 3+
+      #   StringIO.new.write("a", "b") # => 2
+      alias_method :append, :write
     end
   end
 end

data/lib/puma/launcher/bundle_pruner.rb

@@ -28,16 +28,14 @@ module Puma
 
         log '* Pruning Bundler environment'
         home = ENV['GEM_HOME']
-        bundle_gemfile = Bundler.original_env['BUNDLE_GEMFILE']
-        bundle_app_config = Bundler.original_env['BUNDLE_APP_CONFIG']
+        original_bundle_env = Bundler.original_env.select { |k, v| k.start_with?('BUNDLE_') && v }
 
         with_unbundled_env do
           ENV['GEM_HOME'] = home
-          ENV['BUNDLE_GEMFILE'] = bundle_gemfile
           ENV['PUMA_BUNDLER_PRUNED'] = '1'
-          ENV["BUNDLE_APP_CONFIG"] = bundle_app_config
+          original_bundle_env.each { |k, v| ENV[k] = v }
           args = [Gem.ruby, puma_wild_path, '-I', dirs.join(':')] + @original_argv
-          # Ruby 2.0+ defaults to true which breaks socket activation
+          # Defaults to true which breaks socket activation
           args += [{:close_others => false}]
           Kernel.exec(*args)
         end

data/lib/puma/launcher.rb

@@ -22,12 +22,15 @@ module Puma
     #
     # +conf+ A Puma::Configuration object indicating how to run the server.
     #
-    # +launcher_args+ A Hash that currently has one required key `:events`,
-    # this is expected to hold an object similar to an `Puma::LogWriter.stdio`,
-    # this object will be responsible for broadcasting Puma's internal state
-    # to a logging destination. An optional key `:argv` can be supplied,
-    # this should be an array of strings, these arguments are re-used when
-    # restarting the puma server.
+    # +launcher_args+ A Hash that has a few optional keys.
+    # - +:log_writer+:: Expected to hold an object similar to `Puma::LogWriter.stdio`.
+    #   This object will be responsible for broadcasting Puma's internal state
+    #   to a logging destination.
+    # - +:events+:: Expected to hold an object similar to `Puma::Events`.
+    # - +:argv+:: Expected to be an array of strings.
+    # - +:env+:: Expected to hold a hash of environment variables.
+    #
+    # These arguments are re-used when restarting the puma server.
     #
     # Examples:
     #
@@ -39,27 +42,44 @@ module Puma
     #   end
     #   Puma::Launcher.new(conf, log_writer: Puma::LogWriter.stdio).run
     def initialize(conf, launcher_args={})
-      @runner        = nil
-      @log_writer    = launcher_args[:log_writer] || LogWriter::DEFAULT
-      @events        = launcher_args[:events] || Events.new
-      @argv          = launcher_args[:argv] || []
+      ## Minimal initialization before potential early restart (e.g. from bundle pruning)
+
+      @config = conf
+      # Advertise the CLI Configuration before config files are loaded
+      Puma.cli_config = @config if defined?(Puma.cli_config)
+      @config.clamp
+
+      @options = @config.options
+
+      @log_writer = launcher_args[:log_writer] || LogWriter::DEFAULT
+      @log_writer.formatter = LogWriter::PidFormatter.new if clustered?
+      @log_writer.formatter = @options[:log_formatter] if @options[:log_formatter]
+      @log_writer.custom_logger = @options[:custom_logger] if @options[:custom_logger]
+      @options[:log_writer] = @log_writer
+      @options[:logger] = @log_writer if clustered?
+
+      @events = launcher_args[:events] || Events.new
+
+      @argv = launcher_args[:argv] || []
       @original_argv = @argv.dup
-      @config        = conf
 
-      env = launcher_args.delete(:env) || ENV
+      ## End minimal initialization
 
-      @config.options[:log_writer] = @log_writer
+      generate_restart_data
+      Dir.chdir(@restart_dir)
 
-      # Advertise the Configuration
-      Puma.cli_config = @config if defined?(Puma.cli_config)
+      prune_bundler!
+
+      env = launcher_args.delete(:env) || ENV
 
-      @config.load
+      # Log after prune_bundler! to avoid duplicate logging if a restart occurs
+      log_config if env['PUMA_LOG_CONFIG']
 
-      @binder        = Binder.new(@log_writer, conf)
-      @binder.create_inherited_fds(ENV).each { |k| ENV.delete k }
-      @binder.create_activated_fds(ENV).each { |k| ENV.delete k }
+      @binder = Binder.new(@log_writer, @options)
+      @binder.create_inherited_fds(env).each { |k| env.delete k }
+      @binder.create_activated_fds(env).each { |k| env.delete k }
 
-      @environment = conf.environment
+      @environment = @config.environment
 
       # Load the systemd integration if we detect systemd's NOTIFY_SOCKET.
       # Skip this on JRuby though, because it is incompatible with the systemd
@@ -68,37 +88,21 @@ module Puma
         @config.plugins.create('systemd')
       end
 
-      if @config.options[:bind_to_activated_sockets]
-        @config.options[:binds] = @binder.synthesize_binds_from_activated_fs(
-          @config.options[:binds],
-          @config.options[:bind_to_activated_sockets] == 'only'
+      if @options[:bind_to_activated_sockets]
+        @options[:binds] = @binder.synthesize_binds_from_activated_fs(
+          @options[:binds],
+          @options[:bind_to_activated_sockets] == 'only'
         )
       end
 
-      @options = @config.options
-      @config.clamp
-
-      @log_writer.formatter = LogWriter::PidFormatter.new if clustered?
-      @log_writer.formatter = options[:log_formatter] if @options[:log_formatter]
-
-      @log_writer.custom_logger = options[:custom_logger] if @options[:custom_logger]
-
-      generate_restart_data
-
       if clustered? && !Puma.forkable?
         unsupported "worker mode not supported on #{RUBY_ENGINE} on this platform"
       end
 
-      Dir.chdir(@restart_dir)
-
-      prune_bundler!
-
       @environment = @options[:environment] if @options[:environment]
       set_rack_environment
 
       if clustered?
-        @options[:logger] = @log_writer
-
         @runner = Cluster.new(self)
       else
         @runner = Single.new(self)
@@ -106,8 +110,6 @@ module Puma
       Puma.stats_object = @runner
 
       @status = :run
-
-      log_config if env['PUMA_LOG_CONFIG']
     end
 
     attr_reader :binder, :log_writer, :events, :config, :options, :restart_dir
@@ -140,7 +142,10 @@ module Puma
     # Delete the configured pidfile
     def delete_pidfile
       path = @options[:pidfile]
-      File.unlink(path) if path && File.exist?(path)
+      begin
+        File.unlink(path) if path
+      rescue Errno::ENOENT
+      end
     end
 
     # Begin async shutdown of the server
@@ -277,7 +282,7 @@ module Puma
     end
 
     def do_graceful_stop
-      @events.fire_on_stopped!
+      @events.fire_after_stopped!
       @runner.stop_blocked
     end
 
@@ -289,8 +294,8 @@ module Puma
     end
 
     def restart!
-      @events.fire_on_restart!
-      @config.run_hooks :on_restart, self, @log_writer
+      @events.fire_before_restart!
+      @config.run_hooks :before_restart, self, @log_writer
 
       if Puma.jruby?
         close_binder_listeners
@@ -382,9 +387,9 @@ module Puma
         # using it.
         @restart_dir = Dir.pwd
 
-        # Use the same trick as unicorn, namely favor PWD because
-        # it will contain an unresolved symlink, useful for when
-        # the pwd is /data/releases/current.
+      # Use the same trick as unicorn, namely favor PWD because
+      # it will contain an unresolved symlink, useful for when
+      # the pwd is /data/releases/current.
       elsif dir = ENV['PWD']
         s_env = File.stat(dir)
         s_pwd = File.stat(Dir.pwd)
@@ -471,8 +476,8 @@ module Puma
       end
 
       begin
-        unless Puma.jruby? # INFO in use by JVM already
-          Signal.trap "SIGINFO" do
+        if Puma.backtrace_signal
+          Signal.trap Puma.backtrace_signal do
             thread_status do |name, backtrace|
               @log_writer.log(name)
               @log_writer.log(backtrace.map { |bt| "  #{bt}" })
@@ -480,8 +485,7 @@ module Puma
           end
         end
       rescue Exception
-        # Not going to log this one, as SIGINFO is *BSD only and would be pretty annoying
-        # to see this constantly on Linux.
+        log "*** SIGINFO/SIGPWR not implemented, signal based backtrace unavailable!"
       end
     end
 

data/lib/puma/log_writer.rb

@@ -90,8 +90,14 @@ module Puma
       @debug
     end
 
-    def debug(str)
-      log("% #{str}") if @debug
+    def debug(str=nil, &block)
+      if @debug
+        if block_given?
+          log("% #{yield}")
+        else
+          log("% #{str}")
+        end
+      end
     end
 
     # Write +str+ to +@stderr+

data/lib/puma/minissl.rb

@@ -172,7 +172,6 @@ module Puma
             end
           end
         rescue IOError, SystemCallError
-          Puma::Util.purge_interrupt_queue
           # nothing
         ensure
           @socket.close

data/lib/puma/plugin/systemd.rb

@@ -14,9 +14,9 @@ Puma::Plugin.create do
     launcher.log_writer.log "* Enabling systemd notification integration"
 
     # hook_events
-    launcher.events.on_booted { Puma::SdNotify.ready }
-    launcher.events.on_stopped { Puma::SdNotify.stopping }
-    launcher.events.on_restart { Puma::SdNotify.reloading }
+    launcher.events.after_booted { Puma::SdNotify.ready }
+    launcher.events.after_stopped { Puma::SdNotify.stopping }
+    launcher.events.before_restart { Puma::SdNotify.reloading }
 
     # start watchdog
     if Puma::SdNotify.watchdog?

data/lib/puma/rack/urlmap.rb

@@ -70,7 +70,7 @@ module Puma::Rack
         return app.call(env)
       end
 
-      [404, {'Content-Type' => "text/plain", "X-Cascade" => "pass"}, ["Not Found: #{path}"]]
+      [404, {'content-type' => "text/plain", "x-cascade" => "pass"}, ["Not Found: #{path}"]]
 
     ensure
       env['PATH_INFO'] = path

data/lib/puma/reactor.rb

@@ -15,6 +15,12 @@ module Puma
   #
   # The implementation uses a Queue to synchronize adding new objects from the internal select loop.
   class Reactor
+
+    # @!attribute [rw] reactor_max
+    #   Maximum number of clients in the selector.  Reset with calls to `Server.stats`.
+    attr_accessor :reactor_max
+    attr_reader :reactor_size
+
     # Create a new Reactor to monitor IO objects added by #add.
     # The provided block will be invoked when an IO has data available to read,
     # its timeout elapses, or when the Reactor shuts down.
@@ -29,6 +35,8 @@ module Puma
       @input = Queue.new
       @timeouts = []
       @block = block
+      @reactor_size = 0
+      @reactor_max = 0
     end
 
     # Run the internal select loop, using a background thread by default.
@@ -67,17 +75,18 @@ module Puma
     private
 
     def select_loop
-      close_selector = true
       begin
         until @input.closed? && @input.empty?
           # Wakeup any registered object that receives incoming data.
           # Block until the earliest timeout or Selector#wakeup is called.
           timeout = (earliest = @timeouts.first) && earliest.timeout
-          @selector.select(timeout) {|mon| wakeup!(mon.value)}
+          @selector.select(timeout) do |monitor|
+            wakeup!(monitor.value)
+          end
 
           # Wakeup all objects that timed out.
-          timed_out = @timeouts.take_while {|t| t.timeout == 0}
-          timed_out.each { |c| wakeup! c }
+          timed_out = @timeouts.take_while { |client| client.timeout == 0 }
+          timed_out.each { |client| wakeup!(client) }
 
           unless @input.empty?
             until @input.empty?
@@ -91,23 +100,19 @@ module Puma
         STDERR.puts "Error in reactor loop escaped: #{e.message} (#{e.class})"
         STDERR.puts e.backtrace
 
-        # NoMethodError may be rarely raised when calling @selector.select, which
-        # is odd.  Regardless, it may continue for thousands of calls if retried.
-        # Also, when it raises, @selector.close also raises an error.
-        if NoMethodError === e
-          close_selector = false
-        else
-          retry
-        end
+        retry
       end
+
       # Wakeup all remaining objects on shutdown.
       @timeouts.each(&@block)
-      @selector.close if close_selector
+      @selector.close
     end
 
     # Start monitoring the object.
     def register(client)
       @selector.register(client.to_io, :r).value = client
+      @reactor_size += 1
+      @reactor_max = @reactor_size if @reactor_max < @reactor_size
       @timeouts << client
     rescue ArgumentError
       # unreadable clients raise error when processed by NIO
@@ -118,6 +123,7 @@ module Puma
     def wakeup!(client)
       if @block.call client
         @selector.deregister client.to_io
+        @reactor_size -= 1
         @timeouts.delete client
       end
     end