puma 3.5.0 → 3.12.0

data/lib/puma/events.rb

@@ -1,4 +1,5 @@
 require 'puma/const'
+require "puma/null_io"
 require 'stringio'
 
 module Puma
@@ -34,8 +35,6 @@ module Puma
 
       @debug = ENV.key? 'PUMA_DEBUG'
 
-      @on_booted = []
-
       @hooks = Hash.new { |h,k| h[k] = [] }
     end
 
@@ -48,7 +47,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 +91,7 @@ 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]}): #{error.inspect}\n---\n"
     end
 
     # An SSL error has occurred.
@@ -124,12 +122,12 @@ module Puma
       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,6 +1,6 @@
 require 'puma/detect'
 
-if Puma::IS_JRUBY
+if Puma.jruby?
   require 'puma/java_io_buffer'
 else
   require 'puma/puma_http11'

data/lib/puma/jruby_restart.rb

@@ -80,4 +80,3 @@ module Puma
     end
   end
 end
-

data/lib/puma/launcher.rb

@@ -1,15 +1,12 @@
-require 'puma/server'
-require 'puma/const'
-require 'puma/configuration'
-require 'puma/binder'
+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/single'
+
+require 'puma/const'
 
-require 'puma/commonlogger'
+require 'puma/binder'
 
 module Puma
   # Puma::Launcher is the single entry point for starting a Puma server based on user
@@ -37,13 +34,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
@@ -62,6 +59,7 @@ module Puma
       @config.load
 
       @options = @config.options
+      @config.clamp
 
       generate_restart_data
 
@@ -88,6 +86,7 @@ module Puma
       else
         @runner = Single.new(self, @events)
       end
+      Puma.stats_object = @runner
 
       @status = :run
     end
@@ -107,6 +106,8 @@ module Puma
       path = @options[:state]
       return unless path
 
+      require 'puma/state_file'
+
       sf = StateFile.new
       sf.pid = Process.pid
       sf.control_url = @options[:control_url]
@@ -163,6 +164,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
@@ -178,6 +190,7 @@ module Puma
         graceful_stop
       when :restart
         log "* Restarting..."
+        ENV.replace(previous_env)
         @runner.before_restart
         restart!
       when :exit
@@ -222,8 +235,8 @@ module Puma
       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
+          ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}"
+          redirects[io.to_i] = io.to_i
         end
 
         argv = restart_args
@@ -256,6 +269,8 @@ module Puma
         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
+        # Ruby 2.0+ defaults to true which breaks socket activation
+        args += [{:close_others => false}] if RUBY_VERSION >= '2.0'
         Kernel.exec(*args)
       end
     end
@@ -284,8 +299,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
 
@@ -316,6 +331,11 @@ module Puma
       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.
@@ -330,8 +350,6 @@ module Puma
 
       @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.
@@ -342,9 +360,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
@@ -374,26 +393,38 @@ module Puma
 
       begin
         Signal.trap "SIGTERM" do
-          stop
+          graceful_stop
+
+          raise SignalException, "SIGTERM"
         end
       rescue Exception
         log "*** SIGTERM not implemented, signal based gracefully stopping unavailable!"
       end
 
       begin
-        Signal.trap "SIGHUP" do
-          @runner.redirect_io
+        Signal.trap "SIGINT" do
+          if Puma.jruby?
+            @status = :exit
+            graceful_stop
+            exit
+          end
+
+          stop
         end
       rescue Exception
-        log "*** SIGHUP not implemented, signal based logs reopening unavailable!"
+        log "*** SIGINT not implemented, signal based gracefully stopping unavailable!"
       end
 
-      if Puma.jruby?
-        Signal.trap("INT") do
-          @status = :exit
-          graceful_stop
-          exit
+      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
     end
   end

data/lib/puma/minissl.rb

@@ -1,3 +1,8 @@
+begin
+  require 'io/wait'
+  rescue LoadError
+end
+
 module Puma
   module MiniSSL
     class Socket
@@ -11,6 +16,10 @@ module Puma
         @socket
       end
 
+      def closed?
+        @socket.closed?
+      end
+
       def readpartial(size)
         while true
           output = @engine.read
@@ -36,12 +45,29 @@ module Puma
         output
       end
 
-      def read_nonblock(size)
+      def read_nonblock(size, *_)
+        # *_ is to deal with keyword args that were added
+        # at some point (and being used in the wild)
         while true
           output = engine_read_all
           return output if output
 
-          data = @socket.read_nonblock(size)
+          begin
+            data = @socket.read_nonblock(size, exception: false)
+            if data == :wait_readable || data == :wait_writable
+              if @socket.to_io.respond_to?(data)
+                @socket.to_io.__send__(data)
+              elsif data == :wait_readable
+                IO.select([@socket.to_io])
+              else
+                IO.select(nil, [@socket.to_io])
+              end
+            elsif !data
+              return nil
+            else
+              break
+            end
+          end while true
 
           @engine.inject(data)
           output = engine_read_all
@@ -55,6 +81,8 @@ module Puma
       end
 
       def write(data)
+        return 0 if data.empty?
+
         need = data.bytesize
 
         while true
@@ -75,13 +103,52 @@ module Puma
       end
 
       alias_method :syswrite, :write
+      alias_method :<<, :write
+
+      # This is a temporary fix to deal with websockets code using
+      # write_nonblock. The problem with implementing it properly
+      # is that it means we'd have to have the ability to rewind
+      # an engine because after we write+extract, the socket
+      # write_nonblock call might raise an exception and later
+      # code would pass the same data in, but the engine would think
+      # it had already written the data in. So for the time being
+      # (and since write blocking is quite rare), go ahead and actually
+      # block in write_nonblock.
+      def write_nonblock(data, *_)
+        write data
+      end
 
       def flush
         @socket.flush
       end
 
+      def read_and_drop(timeout = 1)
+        return :timeout unless IO.select([@socket], nil, nil, timeout)
+        return :eof unless read_nonblock(1024)
+        :drop
+      rescue Errno::EAGAIN
+        # do nothing
+        :eagain
+      end
+
+      def should_drop_bytes?
+        @engine.init? || !@engine.shutdown
+      end
+
       def close
-        @socket.close
+        begin
+          # Read any drop any partially initialized sockets and any received bytes during shutdown.
+          # Don't let this socket hold this loop forever.
+          # If it can't send more packets within 1s, then give up.
+          while should_drop_bytes?
+            return if [:timeout, :eof].include?(read_and_drop(1))
+          end
+        rescue IOError, SystemCallError
+          Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+          # nothing
+        ensure
+          @socket.close
+        end
       end
 
       def peeraddr
@@ -113,16 +180,23 @@ module Puma
         # jruby-specific Context properties: java uses a keystore and password pair rather than a cert/key pair
         attr_reader :keystore
         attr_accessor :keystore_pass
+        attr_accessor :ssl_cipher_list
 
         def keystore=(keystore)
           raise ArgumentError, "No such keystore file '#{keystore}'" unless File.exist? keystore
           @keystore = keystore
         end
+
+        def check
+          raise "Keystore not configured" unless @keystore
+        end
+
       else
         # non-jruby Context properties
         attr_reader :key
         attr_reader :cert
         attr_reader :ca
+        attr_accessor :ssl_cipher_filter
 
         def key=(key)
           raise ArgumentError, "No such key file '#{key}'" unless File.exist? key
@@ -138,6 +212,11 @@ module Puma
           raise ArgumentError, "No such ca file '#{ca}'" unless File.exist? ca
           @ca = ca
         end
+
+        def check
+          raise "Key not configured" unless @key
+          raise "Cert not configured" unless @cert
+        end
       end
     end
 
@@ -156,6 +235,7 @@ module Puma
       end
 
       def accept
+        @ctx.check
         io = @socket.accept
         engine = Engine.server @ctx
 
@@ -163,6 +243,7 @@ module Puma
       end
 
       def accept_nonblock
+        @ctx.check
         io = @socket.accept_nonblock
         engine = Engine.server @ctx
 
@@ -170,7 +251,7 @@ module Puma
       end
 
       def close
-        @socket.close
+        @socket.close unless @socket.closed?       # closed? call is for Windows
       end
     end
   end

data/lib/puma/null_io.rb

@@ -1,42 +1,35 @@
 module Puma
-
   # Provides an IO-like object that always appears to contain no data.
   # Used as the value for rack.input when the request has no body.
   #
   class NullIO
-    # Always returns nil
-    #
     def gets
       nil
     end
 
-    # Never yields
-    #
     def each
     end
 
-    # Mimics IO#read with no data
+    # Mimics IO#read with no data.
     #
-    def read(count=nil,buffer=nil)
+    def read(count = nil, _buffer = nil)
       (count && count > 0) ? nil : ""
     end
 
-    # Does nothing
-    #
     def rewind
     end
 
-    # Does nothing
-    #
     def close
     end
 
-    # Always zero
-    #
     def size
       0
     end
 
+    def eof?
+      true
+    end
+
     def sync=(v)
     end