puma 3.0.0.rc1 → 5.0.0.beta1

data/lib/puma/commonlogger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puma
   # Rack::CommonLogger forwards every request to the given +app+, and
   # logs a line in the
@@ -21,6 +23,13 @@ module Puma
     #   %{%s - %s [%s] "%s %s%s %s" %d %s\n} %
     FORMAT = %{%s - %s [%s] "%s %s%s %s" %d %s %0.4f\n}
 
+    HIJACK_FORMAT = %{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
+
+    CONTENT_LENGTH = 'Content-Length'.freeze
+    PATH_INFO      = 'PATH_INFO'.freeze
+    QUERY_STRING   = 'QUERY_STRING'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
     def initialize(app, logger=nil)
       @app = app
       @logger = logger
@@ -42,36 +51,23 @@ module Puma
       [status, header, body]
     end
 
-    HIJACK_FORMAT = %{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
-
     private
 
     def log_hijacking(env, status, header, began_at)
       now = Time.now
 
-      logger = @logger || env['rack.errors']
-      logger.write HIJACK_FORMAT % [
+      msg = HIJACK_FORMAT % [
         env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
         env["REMOTE_USER"] || "-",
         now.strftime("%d/%b/%Y %H:%M:%S"),
-        env["REQUEST_METHOD"],
-        env["PATH_INFO"],
-        env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
+        env[REQUEST_METHOD],
+        env[PATH_INFO],
+        env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
         env["HTTP_VERSION"],
         now - began_at ]
-    end
 
-    PATH_INFO      = 'PATH_INFO'.freeze
-    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-    SCRIPT_NAME    = 'SCRIPT_NAME'.freeze
-    QUERY_STRING   = 'QUERY_STRING'.freeze
-    CACHE_CONTROL  = 'Cache-Control'.freeze
-    CONTENT_LENGTH = 'Content-Length'.freeze
-    CONTENT_TYPE   = 'Content-Type'.freeze
-
-    GET  = 'GET'.freeze
-    HEAD = 'HEAD'.freeze
-    
+      write(msg)
+    end
 
     def log(env, status, header, began_at)
       now = Time.now
@@ -83,13 +79,18 @@ module Puma
         now.strftime("%d/%b/%Y:%H:%M:%S %z"),
         env[REQUEST_METHOD],
         env[PATH_INFO],
-        env[QUERY_STRING].empty? ? "" : "?"+env[QUERY_STRING],
+        env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
         env["HTTP_VERSION"],
         status.to_s[0..3],
         length,
         now - began_at ]
 
+      write(msg)
+    end
+
+    def write(msg)
       logger = @logger || env['rack.errors']
+
       # Standard library logger doesn't support write but it supports << which actually
       # calls to write on the log device without formatting
       if logger.respond_to?(:write)

data/lib/puma/configuration.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'puma/rack/builder'
 require 'puma/plugin'
+require 'puma/const'
 
 module Puma
 
@@ -12,144 +15,153 @@ 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
+  # A class used for storing "leveled" configuration options.
+  #
+  # In this class any "user" specified options take precedence over any
+  # "file" specified options, take precedence over any "default" options.
+  #
+  # User input is preferred over "defaults":
+  #   user_options    = { foo: "bar" }
+  #   default_options = { foo: "zoo" }
+  #   options = UserFileDefaultOptions.new(user_options, default_options)
+  #   puts options[:foo]
+  #   # => "bar"
+  #
+  # All values can be accessed via `all_of`
+  #
+  #   puts options.all_of(:foo)
+  #   # => ["bar", "zoo"]
+  #
+  # A "file" option can be set. This config will be preferred over "default" options
+  # but will defer to any available "user" specified options.
+  #
+  #   user_options    = { foo: "bar" }
+  #   default_options = { rackup: "zoo.rb" }
+  #   options = UserFileDefaultOptions.new(user_options, default_options)
+  #   options.file_options[:rackup] = "sup.rb"
+  #   puts options[:rackup]
+  #   # => "sup.rb"
+  #
+  # The "default" options can be set via procs. These are resolved during runtime
+  # via calls to `finalize_values`
+  class UserFileDefaultOptions
+    def initialize(user_options, default_options)
+      @user_options    = user_options
+      @file_options    = {}
+      @default_options = default_options
+    end
+
+    attr_reader :user_options, :file_options, :default_options
 
     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
+      fetch(key)
     end
 
-    def []=(key, val)
-      @cur[key] = val
+    def []=(key, value)
+      user_options[key] = value
     end
 
-    def key?(key)
-      @set.each do |o|
-        if o.key? key
-          return true
-        end
-      end
-
-      @default.key? key
-    end
+    def fetch(key, default_value = nil)
+      return user_options[key]    if user_options.key?(key)
+      return file_options[key]    if file_options.key?(key)
+      return default_options[key] if default_options.key?(key)
 
-    def merge!(o)
-      o.each do |k,v|
-        @cur[k]= v
-      end
+      default_value
     end
 
-    def flatten
-      options = {}
-
-      @set.each do |o|
-        o.each do |k,v|
-          options[k] ||= v
-        end
-      end
-
-      options
-    end
+    def all_of(key)
+      user    = user_options[key]
+      file    = file_options[key]
+      default = default_options[key]
 
-    def explain
-      indent = ""
+      user    = [user]    unless user.is_a?(Array)
+      file    = [file]    unless file.is_a?(Array)
+      default = [default] unless default.is_a?(Array)
 
-      @set.each do |o|
-        o.keys.sort.each do |k|
-          puts "#{indent}#{k}: #{o[k].inspect}"
-        end
+      user.compact!
+      file.compact!
+      default.compact!
 
-        indent = "  #{indent}"
-      end
+      user + file + default
     end
 
-    def force_defaults
-      @defaults.each do |k,v|
+    def finalize_values
+      @default_options.each do |k,v|
         if v.respond_to? :call
-          @defaults[k] = v.call
+          @default_options[k] = v.call
         end
       end
     end
   end
 
+  # The main configuration class of Puma.
+  #
+  # It can be initialized with a set of "user" options and "default" options.
+  # Defaults will be merged with `Configuration.puma_default_options`.
+  #
+  # This class works together with 2 main other classes the `UserFileDefaultOptions`
+  # which stores configuration options in order so the precedence is that user
+  # set configuration wins over "file" based configuration wins over "default"
+  # configuration. These configurations are set via the `DSL` class. This
+  # class powers the Puma config file syntax and does double duty as a configuration
+  # DSL used by the `Puma::CLI` and Puma rack handler.
+  #
+  # It also handles loading plugins.
+  #
+  # > Note: `:port` and `:host` are not valid keys. By the time they make it to the
+  #   configuration options they are expected to be incorporated into a `:binds` key.
+  #   Under the hood the DSL maps `port` and `host` calls to `:binds`
+  #
+  #   config = Configuration.new({}) do |user_config, file_config, default_config|
+  #     user_config.port 3003
+  #   end
+  #   config.load
+  #   puts config.options[:port]
+  #   # => 3003
+  #
+  # It is expected that `load` is called on the configuration instance after setting
+  # config. This method expands any values in `config_file` and puts them into the
+  # correct configuration option hash.
+  #
+  # Once all configuration is complete it is expected that `clamp` will be called
+  # on the instance. This will expand any procs stored under "default" values. This
+  # is done because an environment variable may have been modified while loading
+  # configuration files.
   class Configuration
     include ConfigDefault
 
-    def self.from_file(path)
-      cfg = new
-
-      DSL.new(cfg.options, cfg)._load_from path
-
-      return cfg
-    end
+    def initialize(user_options={}, default_options = {}, &block)
+      default_options = self.puma_default_options.merge(default_options)
 
-    def initialize(options={}, &blk)
-      @options = LeveledOptions.new(default_options)
-      @plugins = PluginLoader.new
+      @options     = UserFileDefaultOptions.new(user_options, default_options)
+      @plugins     = PluginLoader.new
+      @user_dsl    = DSL.new(@options.user_options, self)
+      @file_dsl    = DSL.new(@options.file_options, self)
+      @default_dsl = DSL.new(@options.default_options, self)
 
-      # options.each do |k,v|
-        # @options[k] = v
-      # end
+      if !@options[:prune_bundler]
+        default_options[:preload_app] = (@options[:workers] > 1) && Puma.forkable?
+      end
 
-      if blk
-        configure(&blk)
+      if block
+        configure(&block)
       end
     end
 
     attr_reader :options, :plugins
 
-    def configure(&blk)
-      @options.shift
-      DSL.new(@options, self)._run(&blk)
+    def configure
+      yield @user_dsl, @file_dsl, @default_dsl
+    ensure
+      @user_dsl._offer_plugins
+      @file_dsl._offer_plugins
+      @default_dsl._offer_plugins
     end
 
     def initialize_copy(other)
-      @conf = nil
+      @conf        = nil
       @cli_options = nil
-      @options = @options.dup
+      @options     = @options.dup
     end
 
     def flatten
@@ -161,52 +173,56 @@ module Puma
       self
     end
 
-    def default_options
+    def default_max_threads
+      Puma.mri? ? 5 : 16
+    end
+
+    def puma_default_options
       {
-        :min_threads => 0,
-        :max_threads => 16,
-        :quiet => false,
+        :min_threads => Integer(ENV['PUMA_MIN_THREADS'] || ENV['MIN_THREADS'] || 0),
+        :max_threads => Integer(ENV['PUMA_MAX_THREADS'] || ENV['MAX_THREADS'] || default_max_threads),
+        :log_requests => false,
         :debug => false,
         :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
-        :workers => 0,
-        :daemon => false,
+        :workers => Integer(ENV['WEB_CONCURRENCY'] || 0),
         :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" },
+        :environment => -> { ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development" },
         :rackup => DefaultRackup,
-        :logger => STDOUT
+        :logger => STDOUT,
+        :persistent_timeout => Const::PERSISTENT_TIMEOUT,
+        :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
+        :raise_exception_on_sigterm => true
       }
     end
 
     def load
-      files = @options.all_of(:config_files)
+      config_files.each { |config_file| @file_dsl._load_from(config_file) }
 
-      if files.empty?
-        imp = %W(config/puma/#{@options[:environment]}.rb config/puma.rb).find { |f|
-          File.exist?(f)
-        }
+      @options
+    end
 
-        files << imp
-      elsif files == ["-"]
-        files = []
-      end
+    def config_files
+      files = @options.all_of(:config_files)
 
-      files.each do |f|
-        @options.shift
+      return [] if files == ['-']
+      return files if files.any?
 
-        DSL.load @options, self, f
+      first_default_file = %W(config/puma/#{environment_str}.rb config/puma.rb).find do |f|
+        File.exist?(f)
       end
+
+      [first_default_file]
     end
 
     # Call once all configuration (included from rackup files)
     # is loaded to flesh out any defaults
     def clamp
-      @options.shift
-      @options.force_defaults
+      @options.finalize_values
     end
 
     # Injects the Configuration object into the env
@@ -238,14 +254,8 @@ module Puma
     def app
       found = options[:app] || load_rackup
 
-      if @options[:mode] == :tcp
-        require 'puma/tcp_logger'
-
-        logger = @options[:logger]
-        return TCPLogger.new(logger, found, @options[:quiet])
-      end
-
-      if !@options[:quiet] and @options[:environment] == "development"
+      if @options[:log_requests]
+        require 'puma/commonlogger'
         logger = @options[:logger]
         found = CommonLogger.new(found, logger)
       end
@@ -258,12 +268,23 @@ module Puma
       @options[:environment]
     end
 
+    def environment_str
+      environment.respond_to?(:call) ? environment.call : environment
+    end
+
     def load_plugin(name)
       @plugins.create name
     end
 
-    def run_hooks(key, arg)
-      @options.all_of(key).each { |b| b.call arg }
+    def run_hooks(key, arg, events)
+      @options.all_of(key).each do |b|
+        begin
+          b.call arg
+        rescue => e
+          events.log "WARNING hook #{key} failed with exception (#{e.class}) #{e.message}"
+          events.debug e.backtrace.join("\n")
+        end
+      end
     end
 
     def self.temp_path
@@ -305,45 +326,23 @@ 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)
+      @options.file_options.merge!(rack_options)
 
       config_ru_binds = []
       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?
+      @options.file_options[:binds] = config_ru_binds unless config_ru_binds.empty?
 
       rack_app
     end
 
     def self.random_token
-      begin
-        require 'openssl'
-      rescue LoadError
-      end
-
-      count = 16
-
-      bytes = nil
-
-      if defined? OpenSSL::Random
-        bytes = OpenSSL::Random.random_bytes(count)
-      elsif File.exist?("/dev/urandom")
-        File.open('/dev/urandom') { |f| bytes = f.read(count) }
-      end
-
-      if bytes
-        token = ""
-        bytes.each_byte { |b| token << b.to_s(16) }
-      else
-        token = (0..count).to_a.map { rand(255).to_s(16) }.join
-      end
+      require 'securerandom' unless defined?(SecureRandom)
 
-      return token
+      SecureRandom.hex(16)
     end
   end
 end