puma 2.12.3 → 2.16.0

data/lib/puma/binder.rb

@@ -128,6 +128,8 @@ module Puma
 
           @listeners << [str, io]
         when "ssl"
+          MiniSSL.check
+
           params = Util.parse_query uri.query
           require 'puma/minissl'
 
@@ -162,8 +164,9 @@ module Puma
               unless params['ca']
                 @events.error "Please specify the SSL ca via 'ca='"
               end
-              ctx.ca = params['ca']
             end
+            
+            ctx.ca = params['ca'] if params['ca']
 
             if  params['verify_mode']
               ctx.verify_mode = case params['verify_mode']
@@ -227,7 +230,7 @@ module Puma
     # allow to accumulate before returning connection refused.
     #
     def add_tcp_listener(host, port, optimize_for_latency=true, backlog=1024)
-      host = host[1..-2] if host[0..0] == '['
+      host = host[1..-2] if host and host[0..0] == '['
       s = TCPServer.new(host, port)
       if optimize_for_latency
         s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
@@ -253,6 +256,8 @@ module Puma
                          optimize_for_latency=true, backlog=1024)
       require 'puma/minissl'
 
+      MiniSSL.check
+
       host = host[1..-2] if host[0..0] == '['
       s = TCPServer.new(host, port)
       if optimize_for_latency
@@ -272,6 +277,8 @@ module Puma
 
     def inherited_ssl_listener(fd, ctx)
       require 'puma/minissl'
+      MiniSSL.check
+
       s = TCPServer.for_fd(fd)
       ssl = MiniSSL::Server.new(s, ctx)
 

data/lib/puma/capistrano.rb

@@ -1,3 +1,5 @@
+$stderr.puts "DEPRECATED: To manage puma with capistrano, use https://github.com/seuros/capistrano-puma"
+
 Capistrano::Configuration.instance.load do
 
   # Ensure the tmp/sockets directory is created by the deploy:setup task and

data/lib/puma/cli.rb

@@ -25,6 +25,12 @@ module Puma
   # Handles invoke a Puma::Server in a command line style.
   #
   class CLI
+    KEYS_NOT_TO_PERSIST_IN_STATE = [
+      :logger, :lowlevel_error_handler,
+      :before_worker_shutdown, :before_worker_boot, :before_worker_fork,
+      :after_worker_boot, :before_fork, :on_restart
+    ]
+
     # Create a new CLI object using +argv+ as the command line
     # arguments.
     #
@@ -42,8 +48,6 @@ module Puma
 
       @config = nil
 
-      ENV['NEWRELIC_DISPATCHER'] ||= "Puma"
-
       setup_options
       generate_restart_data
 
@@ -96,7 +100,7 @@ module Puma
     end
 
     def env
-      @options[:environment] || ENV['RACK_ENV'] || 'development'
+      @options[:environment] || @cli_options[:environment] || ENV['RACK_ENV'] || 'development'
     end
 
     def write_state
@@ -108,12 +112,7 @@ module Puma
       state = { 'pid' => Process.pid }
       cfg = @config.dup
 
-      [
-        :logger,
-        :before_worker_shutdown, :before_worker_boot, :before_worker_fork,
-        :after_worker_boot,
-        :on_restart, :lowlevel_error_handler
-      ].each { |k| cfg.options.delete(k) }
+      KEYS_NOT_TO_PERSIST_IN_STATE.each { |k| cfg.options.delete(k) }
       state['config'] = cfg
 
       require 'yaml'
@@ -266,7 +265,7 @@ module Puma
   private
     def title
       buffer = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
-      buffer << " [#{@options[:tag]}]" if @options[:tag]
+      buffer << " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
       buffer
     end
 
@@ -289,43 +288,33 @@ module Puma
     end
 
     def find_config
-      if @options[:config_file] == '-'
-        @options[:config_file] = nil
+      if @cli_options[:config_file] == '-'
+        @cli_options[:config_file] = nil
       else
-        @options[:config_file] ||= %W(config/puma/#{env}.rb config/puma.rb).find { |f| File.exist?(f) }
+        @cli_options[:config_file] ||= %W(config/puma/#{env}.rb config/puma.rb).find { |f| File.exist?(f) }
       end
     end
 
     # Build the OptionParser object to handle the available options.
     #
+
     def setup_options
-      @options = {
-        :min_threads => 0,
-        :max_threads => 16,
-        :quiet => false,
-        :debug => false,
-        :binds => [],
-        :workers => 0,
-        :daemon => false,
-        :before_worker_shutdown => [],
-        :before_worker_boot => [],
-        :before_worker_fork => [],
-        :after_worker_boot => []
-      }
+      @cli_options = {}
+      @options = {}
 
       @parser = OptionParser.new do |o|
         o.on "-b", "--bind URI", "URI to bind to (tcp://, unix://, ssl://)" do |arg|
-          @options[:binds] << arg
+          (@cli_options[:binds] ||= []) << arg
         end
 
         o.on "-C", "--config PATH", "Load PATH as a config file" do |arg|
-          @options[:config_file] = arg
+          @cli_options[:config_file] = arg
         end
 
         o.on "--control URL", "The bind url to use for the control server",
                               "Use 'auto' to use temp unix server" do |arg|
           if arg
-            @options[:control_url] = arg
+            @cli_options[:control_url] = arg
           elsif jruby?
             unsupported "No default url available on JRuby"
           end
@@ -333,26 +322,26 @@ module Puma
 
         o.on "--control-token TOKEN",
              "The token to use as authentication for the control server" do |arg|
-          @options[:control_auth_token] = arg
+          @cli_options[:control_auth_token] = arg
         end
 
         o.on "-d", "--daemon", "Daemonize the server into the background" do
-          @options[:daemon] = true
-          @options[:quiet] = true
+          @cli_options[:daemon] = true
+          @cli_options[:quiet] = true
         end
 
         o.on "--debug", "Log lowlevel debugging information" do
-          @options[:debug] = true
+          @cli_options[:debug] = true
         end
 
         o.on "--dir DIR", "Change to DIR before starting" do |d|
-          @options[:directory] = d.to_s
-          @options[:worker_directory] = d.to_s
+          @cli_options[:directory] = d.to_s
+          @cli_options[:worker_directory] = d.to_s
         end
 
         o.on "-e", "--environment ENVIRONMENT",
              "The environment to run the Rack app on (default development)" do |arg|
-          @options[:environment] = arg
+          @cli_options[:environment] = arg
         end
 
         o.on "-I", "--include PATH", "Specify $LOAD_PATH directories" do |arg|
@@ -361,48 +350,49 @@ module Puma
 
         o.on "-p", "--port PORT", "Define the TCP port to bind to",
                                   "Use -b for more advanced options" do |arg|
-          @options[:binds] << "tcp://#{Configuration::DefaultTCPHost}:#{arg}"
+          binds = (@cli_options[:binds] ||= [])
+          binds << "tcp://#{Configuration::DefaultTCPHost}:#{arg}"
         end
 
         o.on "--pidfile PATH", "Use PATH as a pidfile" do |arg|
-          @options[:pidfile] = arg
+          @cli_options[:pidfile] = arg
         end
 
         o.on "--preload", "Preload the app. Cluster mode only" do
-          @options[:preload_app] = true
+          @cli_options[:preload_app] = true
         end
 
         o.on "--prune-bundler", "Prune out the bundler env if possible" do
-          @options[:prune_bundler] = true
+          @cli_options[:prune_bundler] = true
         end
 
         o.on "-q", "--quiet", "Quiet down the output" do
-          @options[:quiet] = true
+          @cli_options[:quiet] = true
         end
 
         o.on "-R", "--restart-cmd CMD",
              "The puma command to run during a hot restart",
              "Default: inferred" do |cmd|
-          @options[:restart_cmd] = cmd
+          @cli_options[:restart_cmd] = cmd
         end
 
         o.on "-S", "--state PATH", "Where to store the state details" do |arg|
-          @options[:state] = arg
+          @cli_options[:state] = arg
         end
 
         o.on '-t', '--threads INT', "min:max threads to use (default 0:16)" do |arg|
           min, max = arg.split(":")
           if max
-            @options[:min_threads] = min
-            @options[:max_threads] = max
+            @cli_options[:min_threads] = min
+            @cli_options[:max_threads] = max
           else
-            @options[:min_threads] = 0
-            @options[:max_threads] = arg
+            @cli_options[:min_threads] = 0
+            @cli_options[:max_threads] = arg
           end
         end
 
         o.on "--tcp-mode", "Run the app in raw TCP mode instead of HTTP mode" do
-          @options[:mode] = :tcp
+          @cli_options[:mode] = :tcp
         end
 
         o.on "-V", "--version", "Print the version information" do
@@ -412,11 +402,23 @@ module Puma
 
         o.on "-w", "--workers COUNT",
                    "Activate cluster mode: How many worker processes to create" do |arg|
-          @options[:workers] = arg.to_i
+          @cli_options[:workers] = arg.to_i
         end
 
         o.on "--tag NAME", "Additional text to display in process listing" do |arg|
-          @options[:tag] = arg
+          @cli_options[:tag] = arg
+        end
+
+        o.on "--redirect-stdout FILE", "Redirect STDOUT to a specific file" do |arg|
+          @cli_options[:redirect_stdout] = arg
+        end
+
+        o.on "--redirect-stderr FILE", "Redirect STDERR to a specific file" do |arg|
+          @cli_options[:redirect_stderr] = arg
+        end
+
+        o.on "--[no-]redirect-append", "Append to redirected files" do |val|
+          @cli_options[:redirect_append] = val
         end
 
         o.banner = "puma <options> <rackup file>"
@@ -528,17 +530,19 @@ module Puma
     def parse_options
       @parser.parse! @argv
 
-      @options[:rackup] = @argv.shift if @argv.last
+      @cli_options[:rackup] = @argv.shift if @argv.last
 
       find_config
 
-      @config = Puma::Configuration.new @options
+      @config = Puma::Configuration.new @cli_options
 
       # Advertise the Configuration
       Puma.cli_config = @config
 
       @config.load
 
+      @options = @config.options
+
       if clustered? && (jruby? || windows?)
         unsupported 'worker mode not supported on JRuby or Windows'
       end
@@ -568,6 +572,7 @@ module Puma
       home = ENV['GEM_HOME']
       Bundler.with_clean_env do
         ENV['GEM_HOME'] = home
+        ENV['PUMA_BUNDLER_PRUNED'] = '1'
         wild = File.expand_path(File.join(puma_lib_dir, "../bin/puma-wild"))
         args = [Gem.ruby, wild, '-I', dirs.join(':'), deps.join(',')] + @original_argv
         Kernel.exec(*args)

data/lib/puma/client.rb

@@ -45,11 +45,18 @@ module Puma
 
       @requests_served = 0
       @hijacked = false
+
+      @peerip = nil
+      @remote_addr_header = nil
     end
 
     attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
                 :tempfile
 
+    attr_writer :peerip
+
+    attr_accessor :remote_addr_header
+
     def inspect
       "#<Puma::Client:0x#{object_id.to_s(16)} @ready=#{@ready.inspect}>"
     end
@@ -297,5 +304,17 @@ module Puma
       rescue StandardError
       end
     end
+
+    def peerip
+      return @peerip if @peerip
+
+      if @remote_addr_header
+        hdr = (@env[@remote_addr_header] || LOCALHOST_ADDR).split(/[\s,]/).first
+        @peerip = hdr
+        return hdr
+      end
+
+      @peerip ||= @io.peeraddr.last
+    end
   end
 end

data/lib/puma/cluster.rb

@@ -65,6 +65,14 @@ module Puma
         @stage = :booted
       end
 
+      def dead?
+        @dead
+      end
+
+      def dead!
+        @dead = true
+      end
+
       def ping!
         @last_checkin = Time.now
       end
@@ -136,6 +144,7 @@ module Puma
       any = false
 
       @workers.each do |w|
+        next if !w.booted? && !w.ping_timeout?(@options[:worker_boot_timeout])
         if w.ping_timeout?(@options[:worker_timeout])
           log "! Terminating timed out worker: #{w.pid}"
           w.kill
@@ -154,6 +163,8 @@ module Puma
         @workers.delete_if { |w| w.pid == pid }
       end
 
+      @workers.delete_if(&:dead?)
+
       spawn_workers
 
       if all_workers_booted?
@@ -186,7 +197,7 @@ module Puma
 
     def worker(index, master)
       title = "puma: cluster worker #{index}: #{master}"
-      title << " [#{@options[:tag]}]" if @options[:tag]
+      title << " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
       $0 = title
 
       Signal.trap "SIGINT", "IGNORE"
@@ -221,7 +232,7 @@ module Puma
       begin
         @worker_write << "b#{Process.pid}\n"
       rescue SystemCallError, IOError
-        STDERR.puts "Master seems to have exitted, exitting."
+        STDERR.puts "Master seems to have exited, exiting."
         return
       end
 
@@ -241,6 +252,7 @@ module Puma
       hooks = @options[:before_worker_shutdown]
       hooks.each { |h| h.call(index) }
     ensure
+      @worker_write << "t#{Process.pid}\n" rescue nil
       @worker_write.close
     end
 
@@ -283,7 +295,9 @@ module Puma
     end
 
     def stats
-      %Q!{ "workers": #{@workers.size}, "phase": #{@phase}, "booted_workers": #{@workers.count{|w| w.booted?}} }!
+      old_worker_count = @workers.count { |w| w.phase != @phase }
+      booted_worker_count = @workers.count { |w| w.booted? }
+      %Q!{ "workers": #{@workers.size}, "phase": #{@phase}, "booted_workers": #{booted_worker_count}, "old_workers": #{old_worker_count} }!
     end
 
     def preload?
@@ -379,6 +393,10 @@ module Puma
       @cli.write_state
 
       @master_read, @worker_write = read, @wakeup
+
+      hooks = @options[:before_fork]
+      hooks.each { |h| h.call }
+
       spawn_workers
 
       Signal.trap "SIGINT" do
@@ -407,6 +425,9 @@ module Puma
                   w.boot!
                   log "- Worker #{w.index} (pid: #{pid}) booted, phase: #{w.phase}"
                   force_check = true
+                when "t"
+                  w.dead!
+                  force_check = true
                 when "p"
                   w.ping!
                 end

data/lib/puma/configuration.rb

@@ -15,26 +15,54 @@ module Puma
     include ConfigDefault
 
     def initialize(options)
-      @options = options
-      @options[:mode] ||= :http
-      @options[:binds] ||= []
-      @options[:on_restart] ||= []
-      @options[:before_worker_shutdown] ||= []
-      @options[:before_worker_boot] ||= []
-      @options[:before_worker_fork] ||= []
-      @options[:after_worker_boot] ||= []
-      @options[:worker_timeout] ||= DefaultWorkerTimeout
-      @options[:worker_shutdown_timeout] ||= DefaultWorkerShutdownTimeout
+      @cli_options = options
+
+      @conf = {}
+      @conf[:mode] ||= :http
+      @conf[:binds] ||= []
+      @conf[:on_restart] ||= []
+      @conf[:before_fork] ||= []
+      @conf[:before_worker_shutdown] ||= []
+      @conf[:before_worker_boot] ||= []
+      @conf[:before_worker_fork] ||= []
+      @conf[:after_worker_boot] ||= []
+      @conf[:worker_timeout] ||= DefaultWorkerTimeout
+      @conf[:worker_boot_timeout] ||= @conf[:worker_timeout]
+      @conf[:worker_shutdown_timeout] ||= DefaultWorkerShutdownTimeout
+      @conf[:remote_address] ||= :socket
+
+      @options = {}
     end
 
     attr_reader :options
 
     def initialize_copy(other)
+      @conf = nil
+      @cli_options = nil
       @options = @options.dup
     end
 
+    def default_options
+      {
+        :min_threads => 0,
+        :max_threads => 16,
+        :quiet => false,
+        :debug => false,
+        :binds => [],
+        :workers => 0,
+        :daemon => false,
+      }
+    end
+
     def load
-      DSL.load(@options, @options[:config_file])
+      @conf.merge! @cli_options
+      DSL.load(@conf, @cli_options[:config_file])
+
+      # Load the options in the right priority
+      #
+      @options.merge! default_options
+      @options.merge! @conf
+      @options.merge! @cli_options
 
       setup_binds
       setup_control
@@ -98,10 +126,33 @@ module Puma
       File.basename(Dir.getwd)
     end
 
+    # Load and use the normal Rack builder if we can, otherwise
+    # fallback to our minimal version.
+    def rack_builder
+      # Load bundler now if we can so that we can pickup rack from
+      # a Gemfile
+      if ENV.key? 'PUMA_BUNDLER_PRUNED'
+        begin
+          require 'bundler/setup'
+        rescue LoadError
+        end
+      end
+
+      begin
+        require 'rack'
+        require 'rack/builder'
+      rescue LoadError
+        # ok, use builtin version
+        return Puma::Rack::Builder
+      else
+        return ::Rack::Builder
+      end
+    end
+
     def load_rackup
       raise "Missing rackup file '#{rackup}'" unless File.exist?(rackup)
 
-      rack_app, rack_options = Puma::Rack::Builder.parse_file(rackup)
+      rack_app, rack_options = rack_builder.parse_file(rackup)
       @options.merge!(rack_options)
 
       config_ru_binds = []

data/lib/puma/const.rb

@@ -99,8 +99,8 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.12.3".freeze
-    CODE_NAME = "Plutonian Photo Shoot".freeze
+    PUMA_VERSION = VERSION = "2.16.0".freeze
+    CODE_NAME = "Midwinter Nights Trance".freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 
@@ -183,6 +183,7 @@ module Puma
     PORT_443 = "443".freeze
     LOCALHOST = "localhost".freeze
     LOCALHOST_IP = "127.0.0.1".freeze
+    LOCALHOST_ADDR = "127.0.0.1:0".freeze
 
     SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
     HTTP_11 = "HTTP/1.1".freeze
@@ -215,11 +216,11 @@ module Puma
     HTTP_10_200 = "HTTP/1.0 200 OK\r\n".freeze
 
     CLOSE = "close".freeze
-    KEEP_ALIVE = "Keep-Alive".freeze
+    KEEP_ALIVE = "keep-alive".freeze
 
-    CONTENT_LENGTH2 = "Content-Length".freeze
+    CONTENT_LENGTH2 = "content-length".freeze
     CONTENT_LENGTH_S = "Content-Length: ".freeze
-    TRANSFER_ENCODING = "Transfer-Encoding".freeze
+    TRANSFER_ENCODING = "transfer-encoding".freeze
 
     CONNECTION_CLOSE = "Connection: close\r\n".freeze
     CONNECTION_KEEP_ALIVE = "Connection: Keep-Alive\r\n".freeze

data/lib/puma/control_cli.rb

@@ -17,37 +17,37 @@ module Puma
       @argv = argv
       @stdout = stdout
       @stderr = stderr
-      @options = {}
+      @cli_options = {}
 
       opts = OptionParser.new do |o|
         o.banner = "Usage: pumactl (-p PID | -P pidfile | -S status_file | -C url -T token | -F config.rb) (#{COMMANDS.join("|")})"
 
         o.on "-S", "--state PATH", "Where the state file to use is" do |arg|
-          @options[:state] = arg
+          @cli_options[:state] = arg
         end
 
         o.on "-Q", "--quiet", "Not display messages" do |arg|
-          @options[:quiet_flag] = true
+          @cli_options[:quiet_flag] = true
         end
 
         o.on "-P", "--pidfile PATH", "Pid file" do |arg|
-          @options[:pidfile] = arg
+          @cli_options[:pidfile] = arg
         end
 
         o.on "-p", "--pid PID", "Pid" do |arg|
-          @options[:pid] = arg.to_i
+          @cli_options[:pid] = arg.to_i
         end
 
         o.on "-C", "--control-url URL", "The bind url to use for the control server" do |arg|
-          @options[:control_url] = arg
+          @cli_options[:control_url] = arg
         end
 
         o.on "-T", "--control-token TOKEN", "The token to use as authentication for the control server" do |arg|
-          @options[:control_auth_token] = arg
+          @cli_options[:control_auth_token] = arg
         end
 
         o.on "-F", "--config-file PATH", "Puma config script" do |arg|
-          @options[:config_file] = arg
+          @cli_options[:config_file] = arg
         end
 
         o.on_tail("-H", "--help", "Show this message") do
@@ -64,18 +64,24 @@ module Puma
       opts.order!(argv) { |a| opts.terminate a }
 
       command = argv.shift
-      @options[:command] = command if command
+      @cli_options[:command] = command if command
 
-      unless @options[:config_file] == '-'
-        if @options[:config_file].nil? and File.exist?('config/puma.rb')
-          @options[:config_file] = 'config/puma.rb'
+      @options = nil
+
+      unless @cli_options[:config_file] == '-'
+        if @cli_options[:config_file].nil? and File.exist?('config/puma.rb')
+          @cli_options[:config_file] = 'config/puma.rb'
         end
 
-        if @options[:config_file]
-          Puma::Configuration.new(@options).load
+        if @cli_options[:config_file]
+          config = Puma::Configuration.new(@cli_options)
+          config.load
+          @options = config.options
         end
       end
 
+      @options ||= @cli_options
+
       # check present of command
       unless @options[:command]
         raise "Available commands: #{COMMANDS.join(", ")}"
@@ -256,6 +262,10 @@ module Puma
 
       events = Puma::Events.new @stdout, @stderr
 
+      # replace $0 because puma use it to generate restart command
+      puma_cmd = $0.gsub(/pumactl$/, 'puma')
+      $0 = puma_cmd if File.exist?(puma_cmd)
+
       cli = Puma::CLI.new run_args, events
       cli.run
     end