puma 6.0.0 → 6.6.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.
@@ -102,7 +102,8 @@ module Puma
           @ioerr.is_a?(IO) and @ioerr.wait_writable(1)
           @ioerr.write "#{w_str}\n"
           @ioerr.flush unless @ioerr.sync
-        rescue Errno::EPIPE, Errno::EBADF, IOError
+        rescue Errno::EPIPE, Errno::EBADF, IOError, Errno::EINVAL
+        # 'Invalid argument' (Errno::EINVAL) may be raised by flush
         end
       end
     rescue ThreadError

data/lib/puma/io_buffer.rb

@@ -22,6 +22,16 @@ module Puma
       read
     end
 
+    # Read & Reset - returns contents and resets
+    # @return [String] StringIO contents
+    def read_and_reset
+      rewind
+      str = read
+      truncate 0
+      rewind
+      str
+    end
+
     alias_method :clear, :reset
 
     # before Ruby 2.5, `write` would only take one argument

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
@@ -59,6 +61,13 @@ module Puma
 
       @environment = conf.environment
 
+      # 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? && !ENV["PUMA_SKIP_SYSTEMD"]
+        @config.plugins.create('systemd')
+      end
+
       if @config.options[:bind_to_activated_sockets]
         @config.options[:binds] = @binder.synthesize_binds_from_activated_fs(
           @config.options[:binds],
@@ -72,6 +81,8 @@ module Puma
       @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?
@@ -96,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
@@ -156,6 +167,13 @@ module Puma
         log "* phased-restart called but not available, restarting normally."
         return restart
       end
+
+      if @options.file_options[:tag].nil?
+        dir = File.realdirpath(@restart_dir)
+        @options[:tag] = File.basename(dir)
+        set_process_title
+      end
+
       true
     end
 
@@ -180,7 +198,6 @@ module Puma
 
       setup_signals
       set_process_title
-      integrate_with_systemd
 
       # This blocks until the server is stopped
       @runner.run
@@ -279,7 +296,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
 
@@ -311,27 +330,6 @@ module Puma
       @runner.reload_worker_directory if @runner.respond_to?(:reload_worker_directory)
     end
 
-    # Puma's systemd integration allows Puma to inform systemd:
-    #  1. when it has successfully started
-    #  2. when it is starting shutdown
-    #  3. periodically for a liveness check with a watchdog thread
-    def integrate_with_systemd
-      return unless ENV["NOTIFY_SOCKET"]
-
-      begin
-        require_relative 'systemd'
-      rescue LoadError
-        log "Systemd integration failed. It looks like you're trying to use systemd notify but don't have sd_notify gem installed"
-        return
-      end
-
-      log "* Enabling systemd notification integration"
-
-      systemd = Systemd.new(@log_writer, @events)
-      systemd.hook_events
-      systemd.start_watchdog
-    end
-
     def log(str)
       @log_writer.log(str)
     end
@@ -421,12 +419,14 @@ module Puma
     end
 
     def setup_signals
-      begin
-        Signal.trap "SIGUSR2" do
-          restart
+      unless ENV["PUMA_SKIP_SIGUSR2"]
+        begin
+          Signal.trap "SIGUSR2" do
+            restart
+          end
+        rescue Exception
+          log "*** SIGUSR2 not implemented, signal based restart unavailable!"
         end
-      rescue Exception
-        log "*** SIGUSR2 not implemented, signal based restart unavailable!"
       end
 
       unless Puma.jruby?

data/lib/puma/log_writer.rb

@@ -28,38 +28,43 @@ module Puma
     attr_reader :stdout,
                 :stderr
 
-    attr_accessor :formatter
+    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+
     def log(str)
-      internal_write "#{@formatter.call str}\n"
+      if @custom_logger&.respond_to?(:write)
+        @custom_logger.write(format(str))
+      else
+        internal_write "#{@formatter.call str}\n"
+      end
     end
 
     def write(str)
@@ -73,13 +78,18 @@ module Puma
           @stdout.is_a?(IO) and @stdout.wait_writable(1)
           @stdout.write w_str
           @stdout.flush unless @stdout.sync
-        rescue Errno::EPIPE, Errno::EBADF, IOError
+        rescue Errno::EPIPE, Errno::EBADF, IOError, Errno::EINVAL
+        # 'Invalid argument' (Errno::EINVAL) may be raised by flush
         end
       end
     rescue ThreadError
     end
     private :internal_write
 
+    def debug?
+      @debug
+    end
+
     def debug(str)
       log("% #{str}") if @debug
     end
@@ -115,7 +125,7 @@ module Puma
     def ssl_error(error, ssl_socket)
       peeraddr = ssl_socket.peeraddr.last rescue "<unknown>"
       peercert = ssl_socket.peercert
-      subject = peercert ? peercert.subject : nil
+      subject = peercert&.subject
       @error_logger.info(error: error, text: "SSL error, peer: #{peeraddr}, peer cert: #{subject}")
     end
 

data/lib/puma/minissl/context_builder.rb

@@ -38,6 +38,7 @@ module Puma
 
           ctx.key = params['key'] if params['key']
           ctx.key_pem = params['key_pem'] if params['key_pem']
+          ctx.key_password_command = params['key_password_command'] if params['key_password_command']
 
           if params['cert'].nil? && params['cert_pem'].nil?
             log_writer.error "Please specify the SSL cert via 'cert=' or 'cert_pem='"
@@ -50,10 +51,13 @@ module Puma
             unless params['ca']
               log_writer.error "Please specify the SSL ca via 'ca='"
             end
+            # needed for Puma::MiniSSL::Socket#peercert, env['puma.peercert']
+            require 'openssl'
           end
 
           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

@@ -5,6 +5,7 @@ begin
 rescue LoadError
 end
 
+require 'open3'
 # need for Puma::MiniSSL::OPENSSL constants used in `HAS_TLS1_3`
 # use require, see https://github.com/puma/puma/pull/2381
 require 'puma/puma_http11'
@@ -183,6 +184,11 @@ module Puma
         @socket.peeraddr
       end
 
+      # OpenSSL is loaded in `MiniSSL::ContextBuilder` when
+      # `MiniSSL::Context#verify_mode` is not `VERIFY_NONE`.
+      # When `VERIFY_NONE`, `MiniSSL::Engine#peercert` is nil, regardless of
+      # whether the client sends a cert.
+      # @return [OpenSSL::X509::Certificate, nil]
       # @!attribute [r] peercert
       def peercert
         return @peercert if @peercert
@@ -277,11 +283,13 @@ module Puma
       else
         # non-jruby Context properties
         attr_reader :key
+        attr_reader :key_password_command
         attr_reader :cert
         attr_reader :ca
         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
@@ -291,6 +299,10 @@ module Puma
           @key = key
         end
 
+        def key_password_command=(key_password_command)
+          @key_password_command = key_password_command
+        end
+
         def cert=(cert)
           check_file cert, 'Cert'
           @cert = cert
@@ -316,6 +328,17 @@ module Puma
           raise "Cert not configured" if @cert.nil? && @cert_pem.nil?
         end
 
+        # Executes the command to return the password needed to decrypt the key.
+        def key_password
+          raise "Key password command not configured" if @key_password_command.nil?
+
+          stdout_str, stderr_str, status = Open3.capture3(@key_password_command)
+
+          return stdout_str.chomp if status.success?
+
+          raise "Key password failed with code #{status.exitstatus}: #{stderr_str}"
+        end
+
         # Controls session reuse.  Allowed values are as follows:
         # * 'off' - matches the behavior of Puma 5.6 and earlier.  This is included
         #   in case reuse 'on' is made the default in future Puma versions.

data/lib/puma/null_io.rb

@@ -16,15 +16,38 @@ module Puma
     def each
     end
 
+    def pos
+      0
+    end
+
     # Mimics IO#read with no data.
     #
-    def read(count = nil, _buffer = nil)
-      count && count > 0 ? nil : ""
+    def read(length = nil, buffer = nil)
+      if length.to_i < 0
+        raise ArgumentError, "(negative length #{length} given)"
+      end
+
+      buffer = if buffer.nil?
+        "".b
+      else
+        String.try_convert(buffer) or raise TypeError, "no implicit conversion of #{buffer.class} into String"
+      end
+      buffer.clear
+      if length.to_i > 0
+        nil
+      else
+        buffer
+      end
     end
 
     def rewind
     end
 
+    def seek(pos, whence = 0)
+      raise ArgumentError, "negative length #{pos} given" if pos.negative?
+      0
+    end
+
     def close
     end
 
@@ -57,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/plugin/systemd.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative '../plugin'
+
+# Puma's systemd integration allows Puma to inform systemd:
+#  1. when it has successfully started
+#  2. when it is starting shutdown
+#  3. periodically for a liveness check with a watchdog thread
+#  4. periodically set the status
+Puma::Plugin.create do
+  def start(launcher)
+    require_relative '../sd_notify'
+
+    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 }
+
+    # start watchdog
+    if Puma::SdNotify.watchdog?
+      ping_f = watchdog_sleep_time
+
+      in_background do
+        launcher.log_writer.log "Pinging systemd watchdog every #{ping_f.round(1)} sec"
+        loop do
+          sleep ping_f
+          Puma::SdNotify.watchdog
+        end
+      end
+    end
+
+    # start status loop
+    instance = self
+    sleep_time = 1.0
+    in_background do
+      launcher.log_writer.log "Sending status to systemd every #{sleep_time.round(1)} sec"
+
+      loop do
+        sleep sleep_time
+        # TODO: error handling?
+        Puma::SdNotify.status(instance.status)
+      end
+    end
+  end
+
+  def status
+    if clustered?
+      messages = stats[:worker_status].map do |worker|
+        common_message(worker[:last_status])
+      end.join(',')
+
+      "Puma #{Puma::Const::VERSION}: cluster: #{booted_workers}/#{workers}, worker_status: [#{messages}]"
+    else
+      "Puma #{Puma::Const::VERSION}: worker: #{common_message(stats)}"
+    end
+  end
+
+  private
+
+  def watchdog_sleep_time
+    usec = Integer(ENV["WATCHDOG_USEC"])
+
+    sec_f = usec / 1_000_000.0
+    # "It is recommended that a daemon sends a keep-alive notification message
+    # to the service manager every half of the time returned here."
+    sec_f / 2
+  end
+
+  def stats
+    Puma.stats_hash
+  end
+
+  def clustered?
+    stats.has_key?(:workers)
+  end
+
+  def workers
+    stats.fetch(:workers, 1)
+  end
+
+  def booted_workers
+    stats.fetch(:booted_workers, 1)
+  end
+
+  def common_message(stats)
+    "{ #{stats[:running]}/#{stats[:max_threads]} threads, #{stats[:pool_capacity]} available, #{stats[:backlog]} backlog }"
+  end
+end

data/lib/puma/rack/builder.rb

@@ -173,7 +173,7 @@ module Puma::Rack
         TOPLEVEL_BINDING, file, 0
     end
 
-    def initialize(default_app = nil,&block)
+    def initialize(default_app = nil, &block)
       @use, @map, @run, @warmup = [], nil, default_app, nil
 
       # Conditionally load rack now, so that any rack middlewares,
@@ -183,7 +183,7 @@ module Puma::Rack
       rescue LoadError
       end
 
-      instance_eval(&block) if block_given?
+      instance_eval(&block) if block
     end
 
     def self.app(default_app = nil, &block)

data/lib/puma/rack/urlmap.rb

@@ -34,7 +34,7 @@ module Puma::Rack
         end
 
         location = location.chomp('/')
-        match = Regexp.new("^#{Regexp.quote(location).gsub('/', '/+')}(.*)", nil, 'n')
+        match = Regexp.new("^#{Regexp.quote(location).gsub('/', '/+')}(.*)", Regexp::NOENCODING)
 
         [host, location, match, app]
       }.sort_by do |(host, location, _, _)|

data/lib/puma/rack_default.rb

@@ -2,8 +2,23 @@
 
 require_relative '../rack/handler/puma'
 
-module Rack::Handler
-  def self.default(options = {})
-    Rack::Handler::Puma
+# rackup was removed in Rack 3, it is now a separate gem
+if Object.const_defined? :Rackup
+  module Rackup
+    module Handler
+      def self.default(options = {})
+        ::Rackup::Handler::Puma
+      end
+    end
   end
+elsif Object.const_defined?(:Rack) && Rack.release < '3'
+  module Rack
+    module Handler
+      def self.default(options = {})
+        ::Rack::Handler::Puma
+      end
+    end
+  end
+else
+  raise "Rack 3 must be used with the Rackup gem"
 end

data/lib/puma/reactor.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'queue_close' unless ::Queue.instance_methods.include? :close
-
 module Puma
   class UnsupportedBackend < StandardError; end
 
@@ -22,10 +20,12 @@ module Puma
     # its timeout elapses, or when the Reactor shuts down.
     def initialize(backend, &block)
       require 'nio'
-      unless backend == :auto || NIO::Selector.backends.include?(backend)
-        raise "unsupported IO selector backend: #{backend} (available backends: #{NIO::Selector.backends.join(', ')})"
+      valid_backends = [:auto, *::NIO::Selector.backends]
+      unless valid_backends.include?(backend)
+        raise ArgumentError.new("unsupported IO selector backend: #{backend} (available backends: #{valid_backends.join(', ')})")
       end
-      @selector = backend == :auto ? NIO::Selector.new : NIO::Selector.new(backend)
+
+      @selector = ::NIO::Selector.new(NIO::Selector.backends.delete(backend))
       @input = Queue.new
       @timeouts = []
       @block = block
@@ -50,7 +50,7 @@ module Puma
       @input << client
       @selector.wakeup
       true
-    rescue ClosedQueueError
+    rescue ClosedQueueError, IOError # Ignore if selector is already closed
       false
     end
 
@@ -67,6 +67,7 @@ module Puma
     private
 
     def select_loop
+      close_selector = true
       begin
         until @input.closed? && @input.empty?
           # Wakeup any registered object that receives incoming data.
@@ -89,11 +90,19 @@ module Puma
       rescue StandardError => e
         STDERR.puts "Error in reactor loop escaped: #{e.message} (#{e.class})"
         STDERR.puts e.backtrace
-        retry
+
+        # 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
       end
       # Wakeup all remaining objects on shutdown.
       @timeouts.each(&@block)
-      @selector.close
+      @selector.close if close_selector
     end
 
     # Start monitoring the object.