puma 4.2.0

data/lib/puma/events.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'puma/const'
+require "puma/null_io"
+require 'stringio'
+
+module Puma
+  # The default implement of an event sink object used by Server
+  # for when certain kinds of events occur in the life of the server.
+  #
+  # The methods available are the events that the Server fires.
+  #
+  class Events
+    class DefaultFormatter
+      def call(str)
+        str
+      end
+    end
+
+    class PidFormatter
+      def call(str)
+        "[#{$$}] #{str}"
+      end
+    end
+
+    include Const
+
+    # Create an Events object that prints to +stdout+ and +stderr+.
+    #
+    def initialize(stdout, stderr)
+      @formatter = DefaultFormatter.new
+      @stdout = stdout
+      @stderr = stderr
+
+      @stdout.sync = true
+      @stderr.sync = true
+
+      @debug = ENV.key? 'PUMA_DEBUG'
+
+      @hooks = Hash.new { |h,k| h[k] = [] }
+    end
+
+    attr_reader :stdout, :stderr
+    attr_accessor :formatter
+
+    # Fire callbacks for the named hook
+    #
+    def fire(hook, *args)
+      @hooks[hook].each { |t| t.call(*args) }
+    end
+
+    # Register a callback for a given hook
+    #
+    def register(hook, obj=nil, &blk)
+      if obj and blk
+        raise "Specify either an object or a block, not both"
+      end
+
+      h = obj || blk
+
+      @hooks[hook] << h
+
+      h
+    end
+
+    # Write +str+ to +@stdout+
+    #
+    def log(str)
+      @stdout.puts format(str)
+    end
+
+    def write(str)
+      @stdout.write format(str)
+    end
+
+    def debug(str)
+      log("% #{str}") if @debug
+    end
+
+    # Write +str+ to +@stderr+
+    #
+    def error(str)
+      @stderr.puts format("ERROR: #{str}")
+      exit 1
+    end
+
+    def format(str)
+      formatter.call(str)
+    end
+
+    # An HTTP parse error has occurred.
+    # +server+ is the Server object, +env+ the request, and +error+ a
+    # 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]}#{env[REQUEST_PATH]}): " \
+        "#{error.inspect}" \
+        "\n---\n"
+    end
+
+    # An SSL error has occurred.
+    # +server+ is the Server object, +peeraddr+ peer address, +peercert+
+    # any peer certificate (if present), and +error+ an exception object.
+    #
+    def ssl_error(server, peeraddr, peercert, error)
+      subject = peercert ? peercert.subject : nil
+      @stderr.puts "#{Time.now}: SSL error, peer: #{peeraddr}, peer cert: #{subject}, #{error.inspect}"
+    end
+
+    # An unknown error has occurred.
+    # +server+ is the Server object, +error+ an exception object,
+    # +kind+ some additional info, and +env+ the request.
+    #
+    def unknown_error(server, error, kind="Unknown", env=nil)
+      if error.respond_to? :render
+        error.render "#{Time.now}: #{kind} error", @stderr
+      else
+        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(&block)
+      register(:on_booted, &block)
+    end
+
+    def fire_on_booted!
+      fire(:on_booted)
+    end
+
+    DEFAULT = new(STDOUT, STDERR)
+
+    # Returns an Events object which writes its status to 2 StringIO
+    # objects.
+    #
+    def self.strings
+      Events.new StringIO.new, StringIO.new
+    end
+
+    def self.stdio
+      Events.new $stdout, $stderr
+    end
+
+    def self.null
+      n = NullIO.new
+      Events.new n, n
+    end
+  end
+end

data/lib/puma/io_buffer.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'puma/detect'
+require 'puma/puma_http11'

data/lib/puma/jruby_restart.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module Puma
+  module JRubyRestart
+    extend FFI::Library
+    ffi_lib 'c'
+
+    attach_function :execlp, [:string, :varargs], :int
+    attach_function :chdir, [:string], :int
+    attach_function :fork, [], :int
+    attach_function :exit, [:int], :void
+    attach_function :setsid, [], :int
+
+    def self.chdir_exec(dir, argv)
+      chdir(dir)
+      cmd = argv.first
+      argv = ([:string] * argv.size).zip(argv).flatten
+      argv << :string
+      argv << nil
+      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[RestartKey] = 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

@@ -0,0 +1,478 @@
+# frozen_string_literal: true
+
+require 'puma/events'
+require 'puma/detect'
+require 'puma/cluster'
+require 'puma/single'
+require 'puma/const'
+require 'puma/binder'
+
+module Puma
+  # 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`.
+  #
+  # It is responsible for either launching a cluster of Puma workers or a single
+  # puma server.
+  class Launcher
+    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
+     ]
+    # Returns an instance of Launcher
+    #
+    # +conf+ A Puma::Configuration object indicating how to run the server.
+    #
+    # +launcher_args+ A Hash that currently has one required key `:events`,
+    # this is expected to hold an object similar to an `Puma::Events.stdio`,
+    # this object will be responsible for broadcasting Puma's internal state
+    # to a logging destination. An optional key `:argv` can be supplied,
+    # this should be an array of strings, these arguments are re-used when
+    # restarting the puma server.
+    #
+    # Examples:
+    #
+    #   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, events: Puma::Events.stdio).run
+    def initialize(conf, launcher_args={})
+      @runner        = nil
+      @events        = launcher_args[:events] || Events::DEFAULT
+      @argv          = launcher_args[:argv] || []
+      @original_argv = @argv.dup
+      @config        = conf
+
+      @binder        = Binder.new(@events)
+      @binder.import_from_env
+
+      @environment = conf.environment
+
+      # Advertise the Configuration
+      Puma.cli_config = @config if defined?(Puma.cli_config)
+
+      @config.load
+
+      @options = @config.options
+      @config.clamp
+
+      @events.formatter = Events::PidFormatter.new if clustered?
+      @events.formatter = options[:log_formatter] if @options[:log_formatter]
+
+      generate_restart_data
+
+      if clustered? && !Process.respond_to?(:fork)
+        unsupported "worker mode not supported on #{RUBY_ENGINE} on this platform"
+      end
+
+      if @options[:daemon] && Puma.windows?
+        unsupported 'daemon mode not supported on Windows'
+      end
+
+      Dir.chdir(@restart_dir)
+
+      prune_bundler if prune_bundler?
+
+      @environment = @options[:environment] if @options[:environment]
+      set_rack_environment
+
+      if clustered?
+        @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, :restart_dir
+
+    # Return stats about the server
+    def stats
+      @runner.stats
+    end
+
+    # Write a state file that can be used by pumactl to control
+    # the server
+    def write_state
+      write_pid
+
+      path = @options[:state]
+      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
+    end
+
+    # Delete the configured pidfile
+    def delete_pidfile
+      path = @options[:pidfile]
+      File.unlink(path) if path && File.exist?(path)
+    end
+
+    # Begin async shutdown of the server
+    def halt
+      @status = :halt
+      @runner.halt
+    end
+
+    # Begin async shutdown of the server gracefully
+    def stop
+      @status = :stop
+      @runner.stop
+    end
+
+    # Begin async restart of the server
+    def restart
+      @status = :restart
+      @runner.restart
+    end
+
+    # Begin a phased restart if supported
+    def phased_restart
+      unless @runner.respond_to?(:phased_restart) and @runner.phased_restart
+        log "* phased-restart called but not available, restarting normally."
+        return restart
+      end
+      true
+    end
+
+    # 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
+
+      setup_signals
+      set_process_title
+      @runner.run
+
+      case @status
+      when :halt
+        log "* Stopping immediately!"
+      when :run, :stop
+        graceful_stop
+      when :restart
+        log "* Restarting..."
+        ENV.replace(previous_env)
+        @runner.before_restart
+        restart!
+      when :exit
+        # nothing
+      end
+    end
+
+    # Return which tcp port the launcher is using, if it's using TCP
+    def connected_port
+      @binder.connected_port
+    end
+
+    def restart_args
+      cmd = @options[:restart_cmd]
+      if cmd
+        cmd.split(' ') + @original_argv
+      else
+        @restart_argv
+      end
+    end
+
+    def close_binder_listeners
+      @binder.close_listeners
+    end
+
+    def close_binder_unix_paths
+      @binder.close_unix_paths
+    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
+
+      if Puma.jruby?
+        close_binder_listeners
+
+        require 'puma/jruby_restart'
+        JRubyRestart.chdir_exec(@restart_dir, restart_args)
+      elsif Puma.windows?
+        close_binder_listeners
+
+        argv = restart_args
+        Dir.chdir(@restart_dir)
+        Kernel.exec(*argv)
+      else
+        argv = restart_args
+        Dir.chdir(@restart_dir)
+        argv += [@binder.redirects_for_restart]
+        Kernel.exec(*argv)
+      end
+    end
+
+    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
+
+    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, dirs = dependencies_and_files_to_require_after_prune
+
+      log '* Pruning Bundler environment'
+      home = ENV['GEM_HOME']
+      Bundler.with_clean_env do
+        ENV['GEM_HOME'] = home
+        ENV['PUMA_BUNDLER_PRUNED'] = '1'
+        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
+
+    def clustered?
+      (@options[:workers] || 0) > 0
+    end
+
+    def unsupported(str)
+      @events.error(str)
+      raise UnsupportedOption
+    end
+
+    def graceful_stop
+      @runner.stop_blocked
+      log "=== puma shutdown: #{Time.now} ==="
+      log "- Goodbye!"
+    end
+
+    def log_thread_status
+      Thread.list.each do |thread|
+        log "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}"
+        logstr = "Thread: TID-#{thread.object_id.to_s(36)}"
+        logstr += " #{thread.name}" if thread.respond_to?(:name)
+        log logstr
+
+        if thread.backtrace
+          log thread.backtrace.join("\n")
+        else
+          log "<no backtrace available>"
+        end
+      end
+    end
+
+    def set_process_title
+      Process.respond_to?(:setproctitle) ? Process.setproctitle(title) : $0 = title
+    end
+
+    def title
+      buffer  = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
+      buffer += " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
+      buffer
+    end
+
+    def set_rack_environment
+      @options[:environment] = environment
+      ENV['RACK_ENV'] = environment
+    end
+
+    def environment
+      @environment
+    end
+
+    def prune_bundler?
+      @options[:prune_bundler] && clustered? && !@options[:preload_app]
+    end
+
+    def generate_restart_data
+      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
+        end
+      end
+
+      @restart_dir ||= Dir.pwd
+
+      # 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.
+      #
+      if File.exist?($0)
+        arg0 = [Gem.ruby, $0]
+      else
+        arg0 = [Gem.ruby, "-S", $0]
+      end
+
+      # 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 [lib, "lib"].include?($LOAD_PATH[0])
+
+      if defined? Puma::WILD_ARGS
+        @restart_argv = arg0 + Puma::WILD_ARGS + @original_argv
+      else
+        @restart_argv = arg0 + @original_argv
+      end
+    end
+
+    def setup_signals
+      begin
+        Signal.trap "SIGUSR2" do
+          restart
+        end
+      rescue Exception
+        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 "SIGTERM" do
+          graceful_stop
+
+          raise(SignalException, "SIGTERM") if @options[:raise_exception_on_sigterm]
+        end
+      rescue Exception
+        log "*** SIGTERM not implemented, signal based gracefully stopping unavailable!"
+      end
+
+      begin
+        Signal.trap "SIGINT" do
+          stop
+        end
+      rescue Exception
+        log "*** SIGINT not implemented, signal based gracefully stopping unavailable!"
+      end
+
+      begin
+        Signal.trap "SIGHUP" do
+          if @runner.redirected_io?
+            @runner.redirect_io
+          else
+            stop
+          end
+        end
+      rescue Exception
+        log "*** SIGHUP not implemented, signal based logs reopening unavailable!"
+      end
+
+      begin
+        Signal.trap "SIGINFO" do
+          log_thread_status
+        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
+  end
+end