puma 3.0.0.rc1 → 5.0.0.beta1

data/lib/puma/events.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'puma/const'
+require "puma/null_io"
 require 'stringio'
 
 module Puma
@@ -34,8 +37,6 @@ module Puma
 
       @debug = ENV.key? 'PUMA_DEBUG'
 
-      @on_booted = []
-
       @hooks = Hash.new { |h,k| h[k] = [] }
     end
 
@@ -48,7 +49,7 @@ module Puma
       @hooks[hook].each { |t| t.call(*args) }
     end
 
-    # Register a callbock for a given hook
+    # Register a callback for a given hook
     #
     def register(hook, obj=nil, &blk)
       if obj and blk
@@ -92,8 +93,10 @@ module Puma
     # parsing exception.
     #
     def parse_error(server, env, error)
-      @stderr.puts "#{Time.now}: HTTP parse error, malformed request (#{env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR]}): #{error.inspect}"
-      @stderr.puts "#{Time.now}: ENV: #{env.inspect}\n---\n"
+      @stderr.puts "#{Time.now}: HTTP parse error, malformed request " \
+        "(#{env[HTTP_X_FORWARDED_FOR] || env[REMOTE_ADDR]}#{env[REQUEST_PATH]}): " \
+        "#{error.inspect}" \
+        "\n---\n"
     end
 
     # An SSL error has occurred.
@@ -106,24 +109,30 @@ module Puma
     end
 
     # An unknown error has occurred.
-    # +server+ is the Server object, +env+ the request, +error+ an exception
-    # object, and +kind+ some additional info.
+    # +server+ is the Server object, +error+ an exception object,
+    # +kind+ some additional info, and +env+ the request.
     #
-    def unknown_error(server, error, kind="Unknown")
+    def unknown_error(server, error, kind="Unknown", env=nil)
       if error.respond_to? :render
         error.render "#{Time.now}: #{kind} error", @stderr
       else
-        @stderr.puts "#{Time.now}: #{kind} error: #{error.inspect}"
-        @stderr.puts error.backtrace.join("\n")
+        if env
+          string_block = [ "#{Time.now}: #{kind} error handling request { #{env['REQUEST_METHOD']} #{env['PATH_INFO']} }" ]
+          string_block << error.inspect
+        else
+          string_block = [ "#{Time.now}: #{kind} error: #{error.inspect}" ]
+        end
+        string_block << error.backtrace
+        @stderr.puts string_block.join("\n")
       end
     end
 
-    def on_booted(&b)
-      @on_booted << b
+    def on_booted(&block)
+      register(:on_booted, &block)
     end
 
     def fire_on_booted!
-      @on_booted.each { |b| b.call }
+      fire(:on_booted)
     end
 
     DEFAULT = new(STDOUT, STDERR)

data/lib/puma/io_buffer.rb

@@ -1,7 +1,11 @@
-require 'puma/detect'
+# frozen_string_literal: true
 
-if Puma::IS_JRUBY
-  require 'puma/java_io_buffer'
-else
-  require 'puma/puma_http11'
+module Puma
+  class IOBuffer < String
+    def append(*args)
+      args.each { |a| concat(a) }
+    end
+
+    alias reset clear
+  end
 end

data/lib/puma/jruby_restart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ffi'
 
 module Puma
@@ -20,64 +22,5 @@ module Puma
       execlp(cmd, *argv)
       raise SystemCallError.new(FFI.errno)
     end
-
-    PermKey = 'PUMA_DAEMON_PERM'
-    RestartKey = 'PUMA_DAEMON_RESTART'
-
-    # Called to tell things "Your now always in daemon mode,
-    # don't try to reenter it."
-    #
-    def self.perm_daemonize
-      ENV[PermKey] = "1"
-    end
-
-    def self.daemon?
-      ENV.key?(PermKey) || ENV.key?(RestartKey)
-    end
-
-    def self.daemon_init
-      return true if ENV.key?(PermKey)
-
-      return false unless ENV.key? RestartKey
-
-      master = ENV[RestartKey]
-
-      # In case the master disappears early
-      begin
-        Process.kill "SIGUSR2", master.to_i
-      rescue SystemCallError => e
-      end
-
-      ENV[RestartKey] = ""
-
-      setsid
-
-      null = File.open "/dev/null", "w+"
-      STDIN.reopen null
-      STDOUT.reopen null
-      STDERR.reopen null
-
-      true
-    end
-
-    def self.daemon_start(dir, argv)
-      ENV['PUMA_DAEMON_RESTART'] = Process.pid.to_s
-
-      if k = ENV['PUMA_JRUBY_DAEMON_OPTS']
-        ENV['JRUBY_OPTS'] = k
-      end
-
-      cmd = argv.first
-      argv = ([:string] * argv.size).zip(argv).flatten
-      argv << :string
-      argv << nil
-
-      chdir(dir)
-      ret = fork
-      return ret if ret != 0
-      execlp(cmd, *argv)
-      raise SystemCallError.new(FFI.errno)
-    end
   end
 end
-

data/lib/puma/launcher.rb

@@ -1,18 +1,14 @@
-require 'puma/server'
-require 'puma/const'
-require 'puma/configuration'
-require 'puma/binder'
+# frozen_string_literal: true
+
+require 'puma/events'
 require 'puma/detect'
-require 'puma/daemon_ext'
-require 'puma/util'
-require 'puma/single'
 require 'puma/cluster'
-require 'puma/state_file'
-
-require 'puma/commonlogger'
+require 'puma/single'
+require 'puma/const'
+require 'puma/binder'
 
 module Puma
-  # Puam::Launcher is the single entry point for starting a Puma server based on user
+  # Puma::Launcher is the single entry point for starting a Puma server based on user
   # configuration. It is responsible for taking user supplied arguments and resolving them
   # with configuration in `config/puma.rb` or `config/puma/<env>.rb`.
   #
@@ -37,13 +33,13 @@ module Puma
     #
     # Examples:
     #
-    #   conf = Puma::Configuration.new do |c|
-    #     c.threads 1, 10
-    #     c.app do |env|
+    #   conf = Puma::Configuration.new do |user_config|
+    #     user_config.threads 1, 10
+    #     user_config.app do |env|
     #       [200, {}, ["hello world"]]
     #     end
     #   end
-    #   Puma::Launcher.new(conf, argv: Puma::Events.stdio).run
+    #   Puma::Launcher.new(conf, events: Puma::Events.stdio).run
     def initialize(conf, launcher_args={})
       @runner        = nil
       @events        = launcher_args[:events] || Events::DEFAULT
@@ -52,9 +48,8 @@ module Puma
       @config        = conf
 
       @binder        = Binder.new(@events)
-      @binder.import_from_env
-
-      generate_restart_data
+      @binder.create_inherited_fds(ENV).each { |k| ENV.delete k }
+      @binder.create_activated_fds(ENV).each { |k| ENV.delete k }
 
       @environment = conf.environment
 
@@ -64,17 +59,18 @@ module Puma
       @config.load
 
       @options = @config.options
+      @config.clamp
 
-      if clustered? && (Puma.jruby? || Puma.windows?)
-        unsupported 'worker mode not supported on JRuby or Windows'
-      end
+      @events.formatter = Events::PidFormatter.new if clustered?
+      @events.formatter = options[:log_formatter] if @options[:log_formatter]
 
-      if @options[:daemon] && Puma.windows?
-        unsupported 'daemon mode not supported on Windows'
+      generate_restart_data
+
+      if clustered? && !Process.respond_to?(:fork)
+        unsupported "worker mode not supported on #{RUBY_ENGINE} on this platform"
       end
 
-      dir = @options[:directory]
-      Dir.chdir(dir) if dir
+      Dir.chdir(@restart_dir)
 
       prune_bundler if prune_bundler?
 
@@ -82,18 +78,18 @@ module Puma
       set_rack_environment
 
       if clustered?
-        @events.formatter = Events::PidFormatter.new
         @options[:logger] = @events
 
         @runner = Cluster.new(self, @events)
       else
         @runner = Single.new(self, @events)
       end
+      Puma.stats_object = @runner
 
       @status = :run
     end
 
-    attr_reader :binder, :events, :config, :options
+    attr_reader :binder, :events, :config, :options, :restart_dir
 
     # Return stats about the server
     def stats
@@ -106,14 +102,17 @@ module Puma
       write_pid
 
       path = @options[:state]
+      permission = @options[:state_permission]
       return unless path
 
+      require 'puma/state_file'
+
       sf = StateFile.new
       sf.pid = Process.pid
       sf.control_url = @options[:control_url]
       sf.control_auth_token = @options[:control_auth_token]
 
-      sf.save path
+      sf.save path, permission
     end
 
     # Delete the configured pidfile
@@ -122,19 +121,6 @@ module Puma
       File.unlink(path) if path && File.exist?(path)
     end
 
-    # If configured, write the pid of the current process out
-    # to a file.
-    def write_pid
-      path = @options[:pidfile]
-      return unless path
-
-      File.open(path, 'w') { |f| f.puts Process.pid }
-      cur = Process.pid
-      at_exit do
-        delete_pidfile if cur == Process.pid
-      end
-    end
-
     # Begin async shutdown of the server
     def halt
       @status = :halt
@@ -164,6 +150,17 @@ module Puma
 
     # Run the server. This blocks until the server is stopped
     def run
+      previous_env =
+        if defined?(Bundler)
+          env = Bundler::ORIGINAL_ENV.dup
+          # add -rbundler/setup so we load from Gemfile when restarting
+          bundle = "-rbundler/setup"
+          env["RUBYOPT"] = [env["RUBYOPT"], bundle].join(" ").lstrip unless env["RUBYOPT"].to_s.include?(bundle)
+          env
+        else
+          ENV.to_h
+        end
+
       @config.clamp
 
       @config.plugins.fire_starts self
@@ -179,26 +176,66 @@ module Puma
         graceful_stop
       when :restart
         log "* Restarting..."
+        ENV.replace(previous_env)
         @runner.before_restart
         restart!
       when :exit
         # nothing
       end
+      close_binder_listeners unless @status == :restart
     end
 
-    # Return which tcp port the launcher is using, if it's using TCP
-    def connected_port
-      @binder.connected_port
+    # Return all tcp ports the launcher may be using, TCP or SSL
+    def connected_ports
+      @binder.connected_ports
+    end
+
+    def restart_args
+      cmd = @options[:restart_cmd]
+      if cmd
+        cmd.split(' ') + @original_argv
+      else
+        @restart_argv
+      end
+    end
+
+    def close_binder_listeners
+      @runner.close_control_listeners
+      @binder.close_listeners
+    end
+
+    def thread_status
+      Thread.list.each do |thread|
+        name = "Thread: TID-#{thread.object_id.to_s(36)}"
+        name += " #{thread['label']}" if thread['label']
+        name += " #{thread.name}" if thread.respond_to?(:name) && thread.name
+        backtrace = thread.backtrace || ["<no backtrace available>"]
+
+        yield name, backtrace
+      end
     end
 
     private
 
+    # If configured, write the pid of the current process out
+    # to a file.
+    def write_pid
+      path = @options[:pidfile]
+      return unless path
+
+      File.open(path, 'w') { |f| f.puts Process.pid }
+      cur = Process.pid
+      at_exit do
+        delete_pidfile if cur == Process.pid
+      end
+    end
+
     def reload_worker_directory
       @runner.reload_worker_directory if @runner.respond_to?(:reload_worker_directory)
     end
 
     def restart!
-      @config.run_hooks :on_restart, self
+      @config.run_hooks :on_restart, self, @events
 
       if Puma.jruby?
         close_binder_listeners
@@ -212,46 +249,74 @@ module Puma
         Dir.chdir(@restart_dir)
         Kernel.exec(*argv)
       else
-        redirects = {:close_others => true}
-        @binder.listeners.each_with_index do |(l, io), i|
-        ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}"
-        redirects[io.to_i] = io.to_i
-        end
-
         argv = restart_args
         Dir.chdir(@restart_dir)
-        argv += [redirects] if RUBY_VERSION >= '1.9'
+        ENV.update(@binder.redirects_for_restart_env)
+        argv += [@binder.redirects_for_restart]
         Kernel.exec(*argv)
       end
     end
 
-    def prune_bundler
-      return unless defined?(Bundler)
-      puma = Bundler.rubygems.loaded_specs("puma")
-      dirs = puma.require_paths.map { |x| File.join(puma.full_gem_path, x) }
+    def dependencies_and_files_to_require_after_prune
+      puma = spec_for_gem("puma")
+
+      deps = puma.runtime_dependencies.map do |d|
+        "#{d.name}:#{spec_for_gem(d.name).version}"
+      end
+
+      [deps, require_paths_for_gem(puma) + extra_runtime_deps_directories]
+    end
+
+    def extra_runtime_deps_directories
+      Array(@options[:extra_runtime_dependencies]).map do |d_name|
+        if (spec = spec_for_gem(d_name))
+          require_paths_for_gem(spec)
+        else
+          log "* Could not load extra dependency: #{d_name}"
+          nil
+        end
+      end.flatten.compact
+    end
+
+    def puma_wild_location
+      puma = spec_for_gem("puma")
+      dirs = require_paths_for_gem(puma)
       puma_lib_dir = dirs.detect { |x| File.exist? File.join(x, '../bin/puma-wild') }
+      File.expand_path(File.join(puma_lib_dir, "../bin/puma-wild"))
+    end
 
-      unless puma_lib_dir
+    def prune_bundler
+      return unless defined?(Bundler)
+      require_rubygems_min_version!(Gem::Version.new("2.2"), "prune_bundler")
+      unless puma_wild_location
         log "! Unable to prune Bundler environment, continuing"
         return
       end
 
-      deps = puma.runtime_dependencies.map do |d|
-        spec = Bundler.rubygems.loaded_specs(d.name)
-        "#{d.name}:#{spec.version.to_s}"
-      end
+      deps, dirs = dependencies_and_files_to_require_after_prune
 
       log '* Pruning Bundler environment'
       home = ENV['GEM_HOME']
-      Bundler.with_clean_env do
+      bundle_gemfile = Bundler.original_env['BUNDLE_GEMFILE']
+      with_unbundled_env do
         ENV['GEM_HOME'] = home
+        ENV['BUNDLE_GEMFILE'] = bundle_gemfile
         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
+        args = [Gem.ruby, puma_wild_location, '-I', dirs.join(':'), deps.join(',')] + @original_argv
+        # Ruby 2.0+ defaults to true which breaks socket activation
+        args += [{:close_others => false}]
         Kernel.exec(*args)
       end
     end
 
+    def spec_for_gem(gem_name)
+      Bundler.rubygems.loaded_specs(gem_name)
+    end
+
+    def require_paths_for_gem(gem_spec)
+      gem_spec.full_require_paths
+    end
+
     def log(str)
       @events.log str
     end
@@ -260,15 +325,6 @@ module Puma
       (@options[:workers] || 0) > 0
     end
 
-    def restart_args
-      cmd = @options[:restart_cmd]
-      if cmd
-        cmd.split(' ') + @original_argv
-      else
-        @restart_argv
-      end
-    end
-
     def unsupported(str)
       @events.error(str)
       raise UnsupportedOption
@@ -285,8 +341,8 @@ module Puma
     end
 
     def title
-      buffer = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
-      buffer << " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
+      buffer  = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
+      buffer += " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
       buffer
     end
 
@@ -303,34 +359,29 @@ module Puma
       @options[:prune_bundler] && clustered? && !@options[:preload_app]
     end
 
-    def close_binder_listeners
-      @binder.listeners.each do |l, io|
-        io.close
-        uri = URI.parse(l)
-        next unless uri.scheme == 'unix'
-        File.unlink("#{uri.host}#{uri.path}")
-      end
-    end
-
-
     def generate_restart_data
-      # Use the same trick as unicorn, namely favor PWD because
-      # it will contain an unresolved symlink, useful for when
-      # the pwd is /data/releases/current.
-      if dir = ENV['PWD']
+      if dir = @options[:directory]
+        @restart_dir = dir
+
+      elsif Puma.windows?
+        # I guess the value of PWD is garbage on windows so don't bother
+        # using it.
+        @restart_dir = Dir.pwd
+
+        # Use the same trick as unicorn, namely favor PWD because
+        # it will contain an unresolved symlink, useful for when
+        # the pwd is /data/releases/current.
+      elsif dir = ENV['PWD']
         s_env = File.stat(dir)
         s_pwd = File.stat(Dir.pwd)
 
         if s_env.ino == s_pwd.ino and (Puma.jruby? or s_env.dev == s_pwd.dev)
           @restart_dir = dir
-          @config.configure { |c| c.worker_directory dir }
         end
       end
 
       @restart_dir ||= Dir.pwd
 
-      require 'rubygems'
-
       # if $0 is a file in the current directory, then restart
       # it the same, otherwise add -S on there because it was
       # picked up in PATH.
@@ -341,9 +392,10 @@ module Puma
         arg0 = [Gem.ruby, "-S", $0]
       end
 
-      # Detect and reinject -Ilib from the command line
+      # Detect and reinject -Ilib from the command line, used for testing without bundler
+      # cruby has an expanded path, jruby has just "lib"
       lib = File.expand_path "lib"
-      arg0[1,0] = ["-I", lib] if $:[0] == lib
+      arg0[1,0] = ["-I", lib] if [lib, "lib"].include?($LOAD_PATH[0])
 
       if defined? Puma::WILD_ARGS
         @restart_argv = arg0 + Puma::WILD_ARGS + @original_argv
@@ -361,36 +413,74 @@ module Puma
         log "*** SIGUSR2 not implemented, signal based restart unavailable!"
       end
 
+      unless Puma.jruby?
+        begin
+          Signal.trap "SIGUSR1" do
+            phased_restart
+          end
+        rescue Exception
+          log "*** SIGUSR1 not implemented, signal based restart unavailable!"
+        end
+      end
+
       begin
-        Signal.trap "SIGUSR1" do
-          phased_restart
+        Signal.trap "SIGTERM" do
+          graceful_stop
+
+          raise(SignalException, "SIGTERM") if @options[:raise_exception_on_sigterm]
         end
       rescue Exception
-        log "*** SIGUSR1 not implemented, signal based restart unavailable!"
+        log "*** SIGTERM not implemented, signal based gracefully stopping unavailable!"
       end
 
       begin
-        Signal.trap "SIGTERM" do
+        Signal.trap "SIGINT" do
           stop
         end
       rescue Exception
-        log "*** SIGTERM not implemented, signal based gracefully stopping unavailable!"
+        log "*** SIGINT not implemented, signal based gracefully stopping unavailable!"
       end
 
       begin
         Signal.trap "SIGHUP" do
-          @runner.redirect_io
+          if @runner.redirected_io?
+            @runner.redirect_io
+          else
+            stop
+          end
         end
       rescue Exception
         log "*** SIGHUP not implemented, signal based logs reopening unavailable!"
       end
 
-      if Puma.jruby?
-        Signal.trap("INT") do
-          @status = :exit
-          graceful_stop
-          exit
+      begin
+        unless Puma.jruby? # INFO in use by JVM already
+          Signal.trap "SIGINFO" do
+            thread_status do |name, backtrace|
+              @events.log name
+              @events.log backtrace.map { |bt| "  #{bt}" }
+            end
+          end
         end
+      rescue Exception
+        # Not going to log this one, as SIGINFO is *BSD only and would be pretty annoying
+        # to see this constantly on Linux.
+      end
+    end
+
+    def require_rubygems_min_version!(min_version, feature)
+      return if min_version <= Gem::Version.new(Gem::VERSION)
+
+      raise "#{feature} is not supported on your version of RubyGems. " \
+              "You must have RubyGems #{min_version}+ to use this feature."
+    end
+
+    def with_unbundled_env
+      bundler_ver = Gem::Version.new(Bundler::VERSION)
+      if bundler_ver < Gem::Version.new('2.1.0')
+        Bundler.with_clean_env { yield }
+      else
+        Bundler.with_unbundled_env { yield }
       end
     end
   end