puma 5.3.2 → 6.0.0

data/lib/puma/runner.rb

@@ -1,20 +1,36 @@
 # frozen_string_literal: true
 
-require 'puma/server'
-require 'puma/const'
+require_relative 'server'
+require_relative 'const'
 
 module Puma
   # Generic class that is used by `Puma::Cluster` and `Puma::Single` to
   # serve requests. This class spawns a new instance of `Puma::Server` via
   # a call to `start_server`.
   class Runner
-    def initialize(cli, events)
-      @launcher = cli
-      @events = events
-      @options = cli.options
+    def initialize(launcher)
+      @launcher = launcher
+      @log_writer = launcher.log_writer
+      @events = launcher.events
+      @config = launcher.config
+      @options = launcher.options
       @app = nil
       @control = nil
       @started_at = Time.now
+      @wakeup = nil
+    end
+
+    # Returns the hash of configuration options.
+    # @return [Puma::UserFileDefaultOptions]
+    attr_reader :options
+
+    def wakeup!
+      return unless @wakeup
+
+      @wakeup.write "!" unless @wakeup.closed?
+
+    rescue SystemCallError, IOError
+      Puma::Util.purge_interrupt_queue
     end
 
     def development?
@@ -26,27 +42,27 @@ module Puma
     end
 
     def log(str)
-      @events.log str
+      @log_writer.log str
     end
 
     # @version 5.0.0
     def stop_control
-      @control.stop(true) if @control
+      @control&.stop true
     end
 
     def error(str)
-      @events.error str
+      @log_writer.error str
     end
 
     def debug(str)
-      @events.log "- #{str}" if @options[:debug]
+      @log_writer.log "- #{str}" if @options[:debug]
     end
 
     def start_control
       str = @options[:control_url]
       return unless str
 
-      require 'puma/app/status'
+      require_relative 'app/status'
 
       if token = @options[:control_auth_token]
         token = nil if token.empty? || token == 'none'
@@ -54,12 +70,14 @@ module Puma
 
       app = Puma::App::Status.new @launcher, token
 
-      control = Puma::Server.new app, @launcher.events,
-        { min_threads: 0, max_threads: 1, queue_requests: false }
+      # A Reactor is not created aand nio4r is not loaded when 'queue_requests: false'
+      # Use `nil` for events, no hooks in control server
+      control = Puma::Server.new app, nil,
+        { min_threads: 0, max_threads: 1, queue_requests: false, log_writer: @log_writer }
 
-      control.binder.parse [str], self, 'Starting control server'
+      control.binder.parse [str], nil, 'Starting control server'
 
-      control.run thread_name: 'control'
+      control.run thread_name: 'ctl'
       @control = control
     end
 
@@ -84,12 +102,13 @@ module Puma
     def output_header(mode)
       min_t = @options[:min_threads]
       max_t = @options[:max_threads]
+      environment = @options[:environment]
 
       log "Puma starting in #{mode} mode..."
       log "* Puma version: #{Puma::Const::PUMA_VERSION} (#{ruby_engine}) (\"#{Puma::Const::CODE_NAME}\")"
       log "*  Min threads: #{min_t}"
       log "*  Max threads: #{max_t}"
-      log "*  Environment: #{ENV['RACK_ENV']}"
+      log "*  Environment: #{environment}"
 
       if mode == "cluster"
         log "*   Master PID: #{Process.pid}"
@@ -108,9 +127,7 @@ module Puma
       append = @options[:redirect_append]
 
       if stdout
-        unless Dir.exist?(File.dirname(stdout))
-          raise "Cannot redirect STDOUT to #{stdout}"
-        end
+        ensure_output_directory_exists(stdout, 'STDOUT')
 
         STDOUT.reopen stdout, (append ? "a" : "w")
         STDOUT.puts "=== puma startup: #{Time.now} ==="
@@ -118,9 +135,7 @@ module Puma
       end
 
       if stderr
-        unless Dir.exist?(File.dirname(stderr))
-          raise "Cannot redirect STDERR to #{stderr}"
-        end
+        ensure_output_directory_exists(stderr, 'STDERR')
 
         STDERR.reopen stderr, (append ? "a" : "w")
         STDERR.puts "=== puma startup: #{Time.now} ==="
@@ -134,30 +149,50 @@ module Puma
     end
 
     def load_and_bind
-      unless @launcher.config.app_configured?
+      unless @config.app_configured?
         error "No application configured, nothing to run"
         exit 1
       end
 
       begin
-        @app = @launcher.config.app
+        @app = @config.app
       rescue Exception => e
         log "! Unable to load application: #{e.class}: #{e.message}"
         raise e
       end
 
-      @launcher.binder.parse @options[:binds], self
+      @launcher.binder.parse @options[:binds]
     end
 
     # @!attribute [r] app
     def app
-      @app ||= @launcher.config.app
+      @app ||= @config.app
     end
 
     def start_server
-      server = Puma::Server.new app, @launcher.events, @options
-      server.inherit_binder @launcher.binder
+      server = Puma::Server.new(app, @events, @options)
+      server.inherit_binder(@launcher.binder)
       server
     end
+
+    private
+    def ensure_output_directory_exists(path, io_name)
+      unless Dir.exist?(File.dirname(path))
+        raise "Cannot redirect #{io_name} to #{path}"
+      end
+    end
+
+    def stats
+      {
+        versions: {
+          puma: Puma::Const::PUMA_VERSION,
+          ruby: {
+            engine: RUBY_ENGINE,
+            version: RUBY_VERSION,
+            patchlevel: RUBY_PATCHLEVEL
+          }
+        }
+      }
+    end
   end
 end

data/lib/puma/server.rb

@@ -2,18 +2,20 @@
 
 require 'stringio'
 
-require 'puma/thread_pool'
-require 'puma/const'
-require 'puma/events'
-require 'puma/null_io'
-require 'puma/reactor'
-require 'puma/client'
-require 'puma/binder'
-require 'puma/util'
-require 'puma/io_buffer'
-require 'puma/request'
+require_relative 'thread_pool'
+require_relative 'const'
+require_relative 'log_writer'
+require_relative 'events'
+require_relative 'null_io'
+require_relative 'reactor'
+require_relative 'client'
+require_relative 'binder'
+require_relative 'util'
+require_relative 'io_buffer'
+require_relative 'request'
 
 require 'socket'
+require 'io/wait' unless Puma::HAS_NATIVE_IO_WAIT
 require 'forwardable'
 
 module Puma
@@ -29,12 +31,12 @@ module Puma
   #
   # Each `Puma::Server` will have one reactor and one thread pool.
   class Server
-
     include Puma::Const
     include Request
     extend Forwardable
 
     attr_reader :thread
+    attr_reader :log_writer
     attr_reader :events
     attr_reader :min_threads, :max_threads  # for #stats
     attr_reader :requests_count             # @version 5.0.0
@@ -44,11 +46,6 @@ module Puma
       :leak_stack_on_error,
       :persistent_timeout, :reaping_time
 
-    # @deprecated v6.0.0
-    attr_writer :auto_trim_time, :early_hints, :first_data_timeout,
-      :leak_stack_on_error, :min_threads, :max_threads,
-      :persistent_timeout, :reaping_time
-
     attr_accessor :app
     attr_accessor :binder
 
@@ -59,8 +56,9 @@ module Puma
 
     # Create a server for the rack app +app+.
     #
-    # +events+ is an object which will be called when certain error events occur
-    # to be handled. See Puma::Events for the list of current methods to implement.
+    # +log_writer+ is a Puma::LogWriter object used to log info and error messages.
+    #
+    # +events+ is a Puma::Events object used to notify application status events.
     #
     # Server#run returns a thread that you can join on to wait for the server
     # to do its work.
@@ -69,34 +67,40 @@ module Puma
     #   and have default values set via +fetch+.  Normally the values are set via
     #   `::Puma::Configuration.puma_default_options`.
     #
-    def initialize(app, events=Events.stdio, options={})
+    # @note The `events` parameter is set to nil, and set to `Events.new` in code.
+    #   Often `options` needs to be passed, but `events` does not.  Using nil allows
+    #   calling code to not require events.rb.
+    #
+    def initialize(app, events = nil, options = {})
       @app = app
-      @events = events
+      @events = events || Events.new
 
       @check, @notify = nil
       @status = :stop
 
-      @auto_trim_time = 30
-      @reaping_time = 1
-
       @thread = nil
       @thread_pool = nil
 
-      @options = options
+      @options = if options.is_a?(UserFileDefaultOptions)
+        options
+      else
+        UserFileDefaultOptions.new(options, Configuration::DEFAULTS)
+      end
 
-      @early_hints         = options.fetch :early_hints, nil
-      @first_data_timeout  = options.fetch :first_data_timeout, FIRST_DATA_TIMEOUT
-      @min_threads         = options.fetch :min_threads, 0
-      @max_threads         = options.fetch :max_threads , (Puma.mri? ? 5 : 16)
-      @persistent_timeout  = options.fetch :persistent_timeout, PERSISTENT_TIMEOUT
-      @queue_requests      = options.fetch :queue_requests, true
-      @max_fast_inline     = options.fetch :max_fast_inline, MAX_FAST_INLINE
-      @io_selector_backend = options.fetch :io_selector_backend, :auto
+      @log_writer          = @options.fetch :log_writer, LogWriter.stdio
+      @early_hints         = @options[:early_hints]
+      @first_data_timeout  = @options[:first_data_timeout]
+      @min_threads         = @options[:min_threads]
+      @max_threads         = @options[:max_threads]
+      @persistent_timeout  = @options[:persistent_timeout]
+      @queue_requests      = @options[:queue_requests]
+      @max_fast_inline     = @options[:max_fast_inline]
+      @io_selector_backend = @options[:io_selector_backend]
 
       temp = !!(@options[:environment] =~ /\A(development|test)\z/)
       @leak_stack_on_error = @options[:environment] ? temp : true
 
-      @binder = Binder.new(events)
+      @binder = Binder.new(log_writer)
 
       ENV['RACK_ENV'] ||= "development"
 
@@ -145,7 +149,7 @@ module Puma
         begin
           skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 1) if skt.kind_of? TCPSocket
         rescue IOError, SystemCallError
-          Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+          Puma::Util.purge_interrupt_queue
         end
       end
 
@@ -154,7 +158,7 @@ module Puma
         begin
           skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 0) if skt.kind_of? TCPSocket
         rescue IOError, SystemCallError
-          Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+          Puma::Util.purge_interrupt_queue
         end
       end
     else
@@ -175,7 +179,7 @@ module Puma
         begin
           tcp_info = skt.getsockopt(Socket::IPPROTO_TCP, Socket::TCP_INFO)
         rescue IOError, SystemCallError
-          Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+          Puma::Util.purge_interrupt_queue
           @precheck_closing = false
           false
         else
@@ -192,12 +196,12 @@ module Puma
 
     # @!attribute [r] backlog
     def backlog
-      @thread_pool and @thread_pool.backlog
+      @thread_pool&.backlog
     end
 
     # @!attribute [r] running
     def running
-      @thread_pool and @thread_pool.spawned
+      @thread_pool&.spawned
     end
 
 
@@ -210,7 +214,7 @@ module Puma
     # value would be 4 until it finishes processing.
     # @!attribute [r] pool_capacity
     def pool_capacity
-      @thread_pool and @thread_pool.pool_capacity
+      @thread_pool&.pool_capacity
     end
 
     # Runs the server.
@@ -219,35 +223,23 @@ module Puma
     # up in the background to handle requests. Otherwise requests
     # are handled synchronously.
     #
-    def run(background=true, thread_name: 'server')
+    def run(background=true, thread_name: 'srv')
       BasicSocket.do_not_reverse_lookup = true
 
       @events.fire :state, :booting
 
       @status = :run
 
-      @thread_pool = ThreadPool.new(
-        @min_threads,
-        @max_threads,
-        ::Puma::IOBuffer,
-        &method(:process_client)
-      )
-
-      @thread_pool.out_of_band_hook = @options[:out_of_band]
-      @thread_pool.clean_thread_locals = @options[:clean_thread_locals]
+      @thread_pool = ThreadPool.new(thread_name, @options) { |a, b| process_client a, b }
 
       if @queue_requests
-        @reactor = Reactor.new(@io_selector_backend, &method(:reactor_wakeup))
+        @reactor = Reactor.new(@io_selector_backend) { |c| reactor_wakeup c }
         @reactor.run
       end
 
-      if @reaping_time
-        @thread_pool.auto_reap!(@reaping_time)
-      end
 
-      if @auto_trim_time
-        @thread_pool.auto_trim!(@auto_trim_time)
-      end
+      @thread_pool.auto_reap! if @options[:reaping_time]
+      @thread_pool.auto_trim! if @options[:auto_trim_time]
 
       @check, @notify = Puma::Util.pipe unless @notify
 
@@ -313,14 +305,15 @@ module Puma
         queue_requests = @queue_requests
         drain = @options[:drain_on_shutdown] ? 0 : nil
 
-        remote_addr_value = nil
-        remote_addr_header = nil
-
-        case @options[:remote_address]
+        addr_send_name, addr_value = case @options[:remote_address]
         when :value
-          remote_addr_value = @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]]
+        else
+          [nil, nil]
         end
 
         while @status == :run || (drain && shutting_down?)
@@ -340,22 +333,21 @@ module Puma
                   next
                 end
                 drain += 1 if shutting_down?
-                client = Client.new io, @binder.env(sock)
-                client.listener = sock
-                if remote_addr_value
-                  client.peerip = remote_addr_value
-                elsif remote_addr_header
-                  client.remote_addr_header = remote_addr_header
-                end
-                pool << client
+                pool << Client.new(io, @binder.env(sock)).tap { |c|
+                  c.listener = sock
+                  c.send(addr_send_name, addr_value) if addr_value
+                }
               end
             end
-          rescue Object => e
-            @events.unknown_error e, nil, "Listen loop"
+          rescue IOError, Errno::EBADF
+            # In the case that any of the sockets are unexpectedly close.
+            raise
+          rescue StandardError => e
+            @log_writer.unknown_error e, nil, "Listen loop"
           end
         end
 
-        @events.debug "Drained #{drain} additional connections." if drain
+        @log_writer.debug "Drained #{drain} additional connections." if drain
         @events.fire :state, @status
 
         if queue_requests
@@ -364,15 +356,15 @@ module Puma
         end
         graceful_shutdown if @status == :stop || @status == :restart
       rescue Exception => e
-        @events.unknown_error e, nil, "Exception handling servers"
+        @log_writer.unknown_error e, nil, "Exception handling servers"
       ensure
-        begin
-          @check.close unless @check.closed?
-        rescue Errno::EBADF, RuntimeError
-          # RuntimeError is Ruby 2.2 issue, can't modify frozen IOError
-          # Errno::EBADF is infrequently raised
+        # Errno::EBADF is infrequently raised
+        [@check, @notify].each do |io|
+          begin
+            io.close unless io.closed?
+          rescue Errno::EBADF
+          end
         end
-        @notify.close
         @notify = nil
         @check = nil
       end
@@ -396,7 +388,7 @@ module Puma
         return true
       end
 
-      return false
+      false
     end
 
     # Given a connection on +client+, handle the incoming requests,
@@ -482,10 +474,10 @@ module Puma
         begin
           client.close if close_socket
         rescue IOError, SystemCallError
-          Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+          Puma::Util.purge_interrupt_queue
           # Already closed
         rescue StandardError => e
-          @events.unknown_error e, nil, "Client"
+          @log_writer.unknown_error e, nil, "Client"
         end
       end
     end
@@ -508,13 +500,16 @@ module Puma
       lowlevel_error(e, client.env)
       case e
       when MiniSSL::SSLError
-        @events.ssl_error e, client.io
+        @log_writer.ssl_error e, client.io
       when HttpParserError
         client.write_error(400)
-        @events.parse_error e, client
+        @log_writer.parse_error e, client
+      when HttpParserError501
+        client.write_error(501)
+        @log_writer.parse_error e, client
       else
         client.write_error(500)
-        @events.unknown_error e, nil, "Read"
+        @log_writer.unknown_error e, nil, "Read"
       end
     end
 
@@ -574,11 +569,11 @@ module Puma
       @notify << message
     rescue IOError, NoMethodError, Errno::EPIPE
       # The server, in another thread, is shutting down
-      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+      Puma::Util.purge_interrupt_queue
     rescue RuntimeError => e
       # Temporary workaround for https://bugs.ruby-lang.org/issues/13239
       if e.message.include?('IOError')
-        Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+        Puma::Util.purge_interrupt_queue
       else
         raise e
       end

data/lib/puma/single.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'puma/runner'
-require 'puma/detect'
-require 'puma/plugin'
+require_relative 'runner'
+require_relative 'detect'
+require_relative 'plugin'
 
 module Puma
   # This class is instantiated by the `Puma::Launcher` and used
@@ -17,25 +17,25 @@ module Puma
     def stats
       {
         started_at: @started_at.utc.iso8601
-      }.merge(@server.stats)
+      }.merge(@server.stats).merge(super)
     end
 
     def restart
-      @server.begin_restart
+      @server&.begin_restart
     end
 
     def stop
-      @server.stop(false) if @server
+      @server&.stop false
     end
 
     def halt
-      @server.halt
+      @server&.halt
     end
 
     def stop_blocked
       log "- Gracefully stopping, waiting for requests to finish"
-      @control.stop(true) if @control
-      @server.stop(true) if @server
+      @control&.stop true
+      @server&.stop true
     end
 
     def run
@@ -55,7 +55,7 @@ module Puma
       log "Use Ctrl-C to stop"
       redirect_io
 
-      @launcher.events.fire_on_booted!
+      @events.fire_on_booted!
 
       begin
         server_thread.join

data/lib/puma/state_file.rb

@@ -1,15 +1,37 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
 module Puma
+
+  # Puma::Launcher uses StateFile to write a yaml file for use with Puma::ControlCLI.
+  #
+  # In previous versions of Puma, YAML was used to read/write the state file.
+  # Since Puma is similar to Bundler/RubyGems in that it may load before one's app
+  # does, minimizing the dependencies that may be shared with the app is desired.
+  #
+  # At present, it only works with numeric and string values.  It is still a valid
+  # yaml file, and the CI tests parse it with Psych.
+  #
   class StateFile
+
+    ALLOWED_FIELDS = %w!control_url control_auth_token pid running_from!
+
     def initialize
       @options = {}
     end
 
     def save(path, permission = nil)
-      contents =YAML.dump @options
+      contents = +"---\n"
+      @options.each do |k,v|
+        next unless ALLOWED_FIELDS.include? k
+        case v
+        when Numeric
+          contents << "#{k}: #{v}\n"
+        when String
+          next if v.strip.empty?
+          contents << (k == 'running_from' || v.to_s.include?(' ') ?
+            "#{k}: \"#{v}\"\n" : "#{k}: #{v}\n")
+        end
+      end
       if permission
         File.write path, contents, mode: 'wb:UTF-8'
       else
@@ -18,12 +40,22 @@ module Puma
     end
 
     def load(path)
-      @options = YAML.load File.read(path)
+      File.read(path).lines.each do |line|
+        next if line.start_with? '#'
+        k,v = line.split ':', 2
+        next unless v && ALLOWED_FIELDS.include?(k)
+        v = v.strip
+        @options[k] =
+          case v
+          when ''              then nil
+          when /\A\d+\z/       then v.to_i
+          when /\A\d+\.\d+\z/  then v.to_f
+          else                      v.gsub(/\A"|"\z/, '')
+          end
+      end
     end
 
-    FIELDS = %w!control_url control_auth_token pid running_from!
-
-    FIELDS.each do |f|
+    ALLOWED_FIELDS.each do |f|
       define_method f do
         @options[f]
       end

data/lib/puma/systemd.rb

@@ -4,7 +4,8 @@ require 'sd_notify'
 
 module Puma
   class Systemd
-    def initialize(events)
+    def initialize(log_writer, events)
+      @log_writer = log_writer
       @events = events
     end
 
@@ -40,7 +41,7 @@ module Puma
     end
 
     def log(str)
-      @events.log str
+      @log_writer.log(str)
     end
   end
 end