puma 2.16.0-java → 3.0.0-java

data/lib/puma/client.rb

@@ -7,6 +7,7 @@ class IO
 end
 
 require 'puma/detect'
+require 'puma/delegation'
 
 if Puma::IS_JRUBY
   # We have to work around some OpenSSL buffer/io-readiness bugs
@@ -21,6 +22,7 @@ module Puma
 
   class Client
     include Puma::Const
+    extend  Puma::Delegation
 
     def initialize(io, env=nil)
       @io = io
@@ -57,6 +59,8 @@ module Puma
 
     attr_accessor :remote_addr_header
 
+    forward :closed?, :@io
+
     def inspect
       "#<Puma::Client:0x#{object_id.to_s(16)} @ready=#{@ready.inspect}>"
     end

data/lib/puma/cluster.rb

@@ -2,8 +2,8 @@ require 'puma/runner'
 
 module Puma
   class Cluster < Runner
-    def initialize(cli)
-      super cli
+    def initialize(cli, events)
+      super cli, events
 
       @phase = 0
       @workers = []
@@ -52,9 +52,11 @@ module Puma
         @options = options
         @first_term_sent = nil
         @last_checkin = Time.now
+        @last_status = '{}'
+        @dead = false
       end
 
-      attr_reader :index, :pid, :phase, :signal, :last_checkin
+      attr_reader :index, :pid, :phase, :signal, :last_checkin, :last_status
 
       def booted?
         @stage == :booted
@@ -73,8 +75,9 @@ module Puma
         @dead = true
       end
 
-      def ping!
+      def ping!(status)
         @last_checkin = Time.now
+        @last_status = status
       end
 
       def ping_timeout?(which)
@@ -83,10 +86,10 @@ module Puma
 
       def term
         begin
-          if @first_term_sent && (Time.new - @first_term_sent) > @options[:worker_shutdown_timeout]
+          if @first_term_sent && (Time.now - @first_term_sent) > @options[:worker_shutdown_timeout]
             @signal = "KILL"
           else
-            @first_term_sent ||= Time.new
+            @first_term_sent ||= Time.now
           end
 
           Process.kill @signal, @pid
@@ -112,12 +115,13 @@ module Puma
 
       diff.times do
         idx = next_worker_index
-        @options[:before_worker_fork].each { |h| h.call(idx) }
+        @launcher.config.run_hooks :before_worker_fork, idx
 
         pid = fork { worker(idx, master) }
-        @cli.debug "Spawned worker: #{pid}"
+        debug "Spawned worker: #{pid}"
         @workers << Worker.new(idx, pid, @phase, @options)
-        @options[:after_worker_boot].each { |h| h.call }
+
+        @launcher.config.run_hooks :after_worker_fork, idx
       end
 
       if diff > 0
@@ -220,8 +224,7 @@ module Puma
 
       # Invoke any worker boot hooks so they can get
       # things in shape before booting the app.
-      hooks = @options[:before_worker_boot]
-      hooks.each { |h| h.call(index) }
+      @launcher.config.run_hooks :before_worker_boot, index
 
       server = start_server
 
@@ -237,11 +240,18 @@ module Puma
       end
 
       Thread.new(@worker_write) do |io|
-        payload = "p#{Process.pid}\n"
+        base_payload = "p#{Process.pid}"
 
         while true
           sleep 5
-          io << payload
+          begin
+            b = server.backlog
+            r = server.running
+            payload = %Q!#{base_payload}{ "backlog":#{b}, "running":#{r} }\n!
+            io << payload
+          rescue IOError
+            break
+          end
         end
       end
 
@@ -249,8 +259,7 @@ module Puma
 
       # Invoke any worker shutdown hooks so they can prevent the worker
       # exiting until any background operations are completed
-      hooks = @options[:before_worker_shutdown]
-      hooks.each { |h| h.call(index) }
+      @launcher.config.run_hooks :before_worker_shutdown, index
     ensure
       @worker_write << "t#{Process.pid}\n" rescue nil
       @worker_write.close
@@ -297,13 +306,47 @@ module Puma
     def stats
       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} }!
+      worker_status = '[' + @workers.map{ |w| %Q!{ "pid": #{w.pid}, "index": #{w.index}, "phase": #{w.phase}, "booted": #{w.booted?}, "last_checkin": "#{w.last_checkin.utc.iso8601}", "last_status": #{w.last_status} }!}.join(",") + ']'
+      %Q!{ "workers": #{@workers.size}, "phase": #{@phase}, "booted_workers": #{booted_worker_count}, "old_workers": #{old_worker_count}, "worker_status": #{worker_status} }!
     end
 
     def preload?
       @options[:preload_app]
     end
 
+    # We do this in a separate method to keep the lambad scope
+    # of the signals handlers as small as possible.
+    def setup_signals
+      Signal.trap "SIGCHLD" do
+        wakeup!
+      end
+
+      Signal.trap "TTIN" do
+        @options[:workers] += 1
+        wakeup!
+      end
+
+      Signal.trap "TTOU" do
+        @options[:workers] -= 1 if @options[:workers] >= 2
+        @workers.last.term
+        wakeup!
+      end
+
+      master_pid = Process.pid
+
+      Signal.trap "SIGTERM" do
+        # The worker installs their own SIGTERM when booted.
+        # Until then, this is run by the worker and the worker
+        # should just exit if they get it.
+        if Process.pid != master_pid
+          log "Early termination of worker"
+          exit! 0
+        else
+          stop
+        end
+      end
+    end
+
     def run
       @status = :run
 
@@ -333,44 +376,17 @@ module Puma
       else
         log "* Phased restart available"
 
-        unless @cli.config.app_configured?
+        unless @launcher.config.app_configured?
           error "No application configured, nothing to run"
           exit 1
         end
 
-        @cli.binder.parse @options[:binds], self
+        @launcher.binder.parse @options[:binds], self
       end
 
       read, @wakeup = Puma::Util.pipe
 
-      Signal.trap "SIGCHLD" do
-        wakeup!
-      end
-
-      Signal.trap "TTIN" do
-        @options[:workers] += 1
-        wakeup!
-      end
-
-      Signal.trap "TTOU" do
-        @options[:workers] -= 1 if @options[:workers] >= 2
-        @workers.last.term
-        wakeup!
-      end
-
-      master_pid = Process.pid
-
-      Signal.trap "SIGTERM" do
-        # The worker installs their own SIGTERM when booted.
-        # Until then, this is run by the worker and the worker
-        # should just exit if they get it.
-        if Process.pid != master_pid
-          log "Early termination of worker"
-          exit! 0
-        else
-          stop
-        end
-      end
+      setup_signals
 
       # Used by the workers to detect if the master process dies.
       # If select says that @check_pipe is ready, it's because the
@@ -390,12 +406,11 @@ module Puma
 
       start_control
 
-      @cli.write_state
+      @launcher.write_state
 
       @master_read, @worker_write = read, @wakeup
 
-      hooks = @options[:before_fork]
-      hooks.each { |h| h.call }
+      @launcher.config.run_hooks :before_fork, nil
 
       spawn_workers
 
@@ -403,7 +418,7 @@ module Puma
         stop
       end
 
-      @cli.events.fire_on_booted!
+      @launcher.events.fire_on_booted!
 
       begin
         while @status == :run
@@ -417,7 +432,8 @@ module Puma
 
               next if !req || req == "!"
 
-              pid = read.gets.to_i
+              result = read.gets
+              pid = result.to_i
 
               if w = @workers.find { |x| x.pid == pid }
                 case req
@@ -429,7 +445,7 @@ module Puma
                   w.dead!
                   force_check = true
                 when "p"
-                  w.ping!
+                  w.ping!(result.sub(/^\d+/,'').chomp)
                 end
               else
                 log "! Out-of-sync worker list, no #{pid} worker"

data/lib/puma/configuration.rb

@@ -1,4 +1,5 @@
 require 'puma/rack/builder'
+require 'puma/plugin'
 
 module Puma
 
@@ -11,30 +12,139 @@ module Puma
     DefaultWorkerShutdownTimeout = 30
   end
 
+  class LeveledOptions
+    def initialize(default={})
+      @cur = {}
+      @set = [@cur]
+      @defaults = default.dup
+    end
+
+    def initialize_copy(other)
+      @set = @set.map { |o| o.dup }
+      @cur = @set.last
+    end
+
+    def shift
+      @cur = {}
+      @set << @cur
+    end
+
+    def [](key)
+      @set.each do |o|
+        if o.key? key
+          return o[key]
+        end
+      end
+
+      v = @defaults[key]
+      if v.respond_to? :call
+        v.call
+      else
+        v
+      end
+    end
+
+    attr_reader :cur
+
+    def all_of(key)
+      all = []
+
+      @set.each do |o|
+        if v = o[key]
+          if v.kind_of? Array
+            all += v
+          else
+            all << v
+          end
+        end
+      end
+
+      all
+    end
+
+    def []=(key, val)
+      @cur[key] = val
+    end
+
+    def key?(key)
+      @set.each do |o|
+        if o.key? key
+          return true
+        end
+      end
+
+      @default.key? key
+    end
+
+    def merge!(o)
+      o.each do |k,v|
+        @cur[k]= v
+      end
+    end
+
+    def flatten
+      options = {}
+
+      @set.each do |o|
+        o.each do |k,v|
+          options[k] ||= v
+        end
+      end
+
+      options
+    end
+
+    def explain
+      indent = ""
+
+      @set.each do |o|
+        o.keys.sort.each do |k|
+          puts "#{indent}#{k}: #{o[k].inspect}"
+        end
+
+        indent = "  #{indent}"
+      end
+    end
+
+    def force_defaults
+      @defaults.each do |k,v|
+        if v.respond_to? :call
+          @defaults[k] = v.call
+        end
+      end
+    end
+  end
+
   class Configuration
     include ConfigDefault
 
-    def initialize(options)
-      @cli_options = options
+    def self.from_file(path)
+      cfg = new
 
-      @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
+      DSL.new(cfg.options, cfg)._load_from path
 
-      @options = {}
+      return cfg
+    end
+
+    def initialize(options={}, &blk)
+      @options = LeveledOptions.new(default_options)
+      @plugins = PluginLoader.new
+
+      # options.each do |k,v|
+        # @options[k] = v
+      # end
+
+      if blk
+        configure(&blk)
+      end
     end
 
-    attr_reader :options
+    attr_reader :options, :plugins
+
+    def configure(&blk)
+      @options.shift
+      DSL.new(@options, self)._run(&blk)
+    end
 
     def initialize_copy(other)
       @conf = nil
@@ -42,31 +152,61 @@ module Puma
       @options = @options.dup
     end
 
+    def flatten
+      dup.flatten!
+    end
+
+    def flatten!
+      @options = @options.flatten
+      self
+    end
+
     def default_options
       {
         :min_threads => 0,
         :max_threads => 16,
-        :quiet => false,
+        :log_requests => false,
         :debug => false,
-        :binds => [],
+        :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
         :workers => 0,
         :daemon => false,
+        :mode => :http,
+        :worker_timeout => DefaultWorkerTimeout,
+        :worker_boot_timeout => DefaultWorkerTimeout,
+        :worker_shutdown_timeout => DefaultWorkerShutdownTimeout,
+        :remote_address => :socket,
+        :tag => method(:infer_tag),
+        :environment => lambda { ENV['RACK_ENV'] || "development" },
+        :rackup => DefaultRackup,
+        :logger => STDOUT
       }
     end
 
     def load
-      @conf.merge! @cli_options
-      DSL.load(@conf, @cli_options[:config_file])
+      files = @options.all_of(:config_files)
+
+      if files.empty?
+        imp = %W(config/puma/#{@options[:environment]}.rb config/puma.rb).find { |f|
+          File.exist?(f)
+        }
 
-      # Load the options in the right priority
-      #
-      @options.merge! default_options
-      @options.merge! @conf
-      @options.merge! @cli_options
+        files << imp
+      elsif files == ["-"]
+        files = []
+      end
 
-      setup_binds
-      setup_control
-      @options[:tag] ||= infer_tag
+      files.each do |f|
+        @options.shift
+
+        DSL.load @options, self, f
+      end
+    end
+
+    # Call once all configuration (included from rackup files)
+    # is loaded to flesh out any defaults
+    def clamp
+      @options.shift
+      @options.force_defaults
     end
 
     # Injects the Configuration object into the env
@@ -89,7 +229,7 @@ module Puma
     end
 
     def rackup
-      @options[:rackup] || DefaultRackup
+      @options[:rackup]
     end
 
     # Load the specified rackup file, pull options from
@@ -101,18 +241,31 @@ module Puma
       if @options[:mode] == :tcp
         require 'puma/tcp_logger'
 
-        logger = @options[:logger] || STDOUT
-        return TCPLogger.new(logger, found, @options[:quiet])
+        logger = @options[:logger]
+        return TCPLogger.new(logger, found, @options[:log_requests])
       end
 
-      if !@options[:quiet] and @options[:environment] == "development"
-        logger = @options[:logger] || STDOUT
+      if @options[:log_requests]
+        logger = @options[:logger]
         found = CommonLogger.new(found, logger)
       end
 
       ConfigMiddleware.new(self, found)
     end
 
+    # Return which environment we're running in
+    def environment
+      @options[:environment]
+    end
+
+    def load_plugin(name)
+      @plugins.create name
+    end
+
+    def run_hooks(key, arg)
+      @options.all_of(key).each { |b| b.call arg }
+    end
+
     def self.temp_path
       require 'tmpdir'
 
@@ -152,6 +305,8 @@ module Puma
     def load_rackup
       raise "Missing rackup file '#{rackup}'" unless File.exist?(rackup)
 
+      @options.shift
+
       rack_app, rack_options = rack_builder.parse_file(rackup)
       @options.merge!(rack_options)
 
@@ -159,37 +314,13 @@ module Puma
       rack_options.each do |k, v|
         config_ru_binds << v if k.to_s.start_with?("bind")
       end
+
       @options[:binds] = config_ru_binds unless config_ru_binds.empty?
 
       rack_app
     end
 
-    def setup_binds
-      # Rakeup default option support
-      host = @options[:Host]
-      if host
-        port = @options[:Port] || DefaultTCPPort
-        @options[:binds] << "tcp://#{host}:#{port}"
-      end
-
-      if @options[:binds].empty?
-        @options[:binds] << "tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"
-      end
-
-      @options[:binds].uniq!
-    end
-
-    def setup_control
-      if @options[:control_url] == 'auto'
-        path = Configuration.temp_path
-        @options[:control_url] = "unix://#{path}"
-        @options[:control_url_temp] = path
-      end
-
-      setup_random_token unless @options[:control_auth_token]
-    end
-
-    def setup_random_token
+    def self.random_token
       begin
         require 'openssl'
       rescue LoadError
@@ -212,7 +343,7 @@ module Puma
         token = (0..count).to_a.map { rand(255).to_s(16) }.join
       end
 
-      @options[:control_auth_token] = token
+      return token
     end
   end
 end