puma 2.1.1 → 7.2.1

data/lib/puma/util.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'uri/common'
+
 module Puma
   module Util
     module_function
@@ -5,5 +9,126 @@ module Puma
     def pipe
       IO.pipe
     end
+
+    # Escapes and unescapes a URI escaped string with
+    # +encoding+. +encoding+ will be the target encoding of the string
+    # returned, and it defaults to UTF-8
+    if defined?(::Encoding)
+      def escape(s, encoding = Encoding::UTF_8)
+        URI.encode_www_form_component(s, encoding)
+      end
+
+      def unescape(s, encoding = Encoding::UTF_8)
+        URI.decode_www_form_component(s, encoding)
+      end
+    else
+      def escape(s, encoding = nil)
+        URI.encode_www_form_component(s, encoding)
+      end
+
+      def unescape(s, encoding = nil)
+        URI.decode_www_form_component(s, encoding)
+      end
+    end
+    module_function :unescape, :escape
+
+    DEFAULT_SEP = /[&;] */n
+
+    # Stolen from Mongrel, with some small modifications:
+    # Parses a query string by breaking it up at the '&'
+    # and ';' characters.  You can also use this to parse
+    # cookies by changing the characters used in the second
+    # parameter (which defaults to '&;').
+    def parse_query(qs, d = nil, &unescaper)
+      unescaper ||= method(:unescape)
+
+      params = {}
+
+      (qs || '').split(d ? /[#{d}] */n : DEFAULT_SEP).each do |p|
+        next if p.empty?
+        k, v = p.split('=', 2).map(&unescaper)
+
+        if cur = params[k]
+          if cur.class == Array
+            params[k] << v
+          else
+            params[k] = [cur, v]
+          end
+        else
+          params[k] = v
+        end
+      end
+
+      params
+    end
+
+    # A case-insensitive Hash that preserves the original case of a
+    # header when set.
+    class HeaderHash < Hash
+      def self.new(hash={})
+        HeaderHash === hash ? hash : super(hash)
+      end
+
+      def initialize(hash={})
+        super()
+        @names = {}
+        hash.each { |k, v| self[k] = v }
+      end
+
+      def each
+        super do |k, v|
+          yield(k, v.respond_to?(:to_ary) ? v.to_ary.join("\n") : v)
+        end
+      end
+
+      # @!attribute [r] to_hash
+      def to_hash
+        hash = {}
+        each { |k,v| hash[k] = v }
+        hash
+      end
+
+      def [](k)
+        super(k) || super(@names[k.downcase])
+      end
+
+      def []=(k, v)
+        canonical = k.downcase
+        delete k if @names[canonical] && @names[canonical] != k # .delete is expensive, don't invoke it unless necessary
+        @names[k] = @names[canonical] = k
+        super k, v
+      end
+
+      def delete(k)
+        canonical = k.downcase
+        result = super @names.delete(canonical)
+        @names.delete_if { |name,| name.downcase == canonical }
+        result
+      end
+
+      def include?(k)
+        @names.include?(k) || @names.include?(k.downcase)
+      end
+
+      alias_method :has_key?, :include?
+      alias_method :member?, :include?
+      alias_method :key?, :include?
+
+      def merge!(other)
+        other.each { |k, v| self[k] = v }
+        self
+      end
+
+      def merge(other)
+        hash = dup
+        hash.merge! other
+      end
+
+      def replace(other)
+        clear
+        other.each { |k, v| self[k] = v }
+        self
+      end
+    end
   end
 end

data/lib/puma.rb

@@ -1,14 +1,88 @@
+# frozen_string_literal: true
+
 # Standard libraries
 require 'socket'
 require 'tempfile'
-require 'yaml'
-require 'time'
-require 'etc'
 require 'uri'
 require 'stringio'
 
 require 'thread'
 
-# Ruby Puma
-require 'puma/const'
-require 'puma/server'
+# use require, see https://github.com/puma/puma/pull/2381
+require 'puma/puma_http11'
+
+require_relative 'puma/detect'
+require_relative 'puma/json_serialization'
+
+module Puma
+  # when Puma is loaded via `Puma::CLI`, all files are loaded via
+  # `require_relative`.  The below are for non-standard loading
+  autoload :Const,     "#{__dir__}/puma/const"
+  autoload :Server,    "#{__dir__}/puma/server"
+  autoload :Launcher,  "#{__dir__}/puma/launcher"
+  autoload :LogWriter, "#{__dir__}/puma/log_writer"
+
+  # at present, MiniSSL::Engine is only defined in extension code (puma_http11),
+  # not in minissl.rb
+  HAS_SSL = const_defined?(:MiniSSL, false) && MiniSSL.const_defined?(:Engine, false)
+
+  HAS_UNIX_SOCKET = Object.const_defined?(:UNIXSocket) && !IS_WINDOWS
+
+  if HAS_SSL
+    require_relative 'puma/minissl'
+  else
+    module MiniSSL
+      # this class is defined so that it exists when Puma is compiled
+      # without ssl support, as Server and Reactor use it in rescue statements.
+      class SSLError < StandardError ; end
+    end
+  end
+
+  def self.ssl?
+    HAS_SSL
+  end
+
+  def self.abstract_unix_socket?
+    @abstract_unix ||=
+      if HAS_UNIX_SOCKET
+        begin
+          ::UNIXServer.new("\0puma.temp.unix").close
+          true
+        rescue ArgumentError  # darwin
+          false
+        end
+      else
+        false
+      end
+  end
+
+  # @!attribute [rw] stats_object=
+  def self.stats_object=(val)
+    @get_stats = val
+  end
+
+  # @!attribute [rw] stats_object
+  def self.stats
+    Puma::JSONSerialization.generate @get_stats.stats
+  end
+
+  # @!attribute [r] stats_hash
+  # @version 5.0.0
+  def self.stats_hash
+    @get_stats.stats
+  end
+
+  def self.set_thread_name(name)
+    Thread.current.name = "puma #{name}"
+  end
+
+  # Shows deprecated warning for renamed methods.
+  # @example
+  #   Puma.deprecate_method_change :on_booted, __callee__, __method__
+  #
+  def self.deprecate_method_change(method_old, method_caller, method_new)
+    if method_old == method_caller
+      warn "Use '#{method_new}', '#{method_caller}' is deprecated and will be removed in v8"
+    end
+  end
+end

data/lib/rack/handler/puma.rb

@@ -1,66 +1,144 @@
-require 'rack/handler'
-require 'puma'
-
-module Rack
-  module Handler
-    module Puma
-      DEFAULT_OPTIONS = {
-        :Host => '0.0.0.0',
-        :Port => 8080,
-        :Threads => '0:16',
-        :Verbose => false
-      }
+# frozen_string_literal: true
+
+module Puma
+
+  # This module is used as an 'include' file in code at bottom of file. It loads
+  # into either `Rackup::Handler::Puma` or `Rack::Handler::Puma`.
+
+  module RackHandler
+    DEFAULT_OPTIONS = {
+      :Verbose => false,
+      :Silent  => false
+    }
+
+    def config(app, options = {})
+      require_relative '../../puma'
+      require_relative '../../puma/configuration'
+      require_relative '../../puma/log_writer'
+      require_relative '../../puma/launcher'
+
+      default_options = DEFAULT_OPTIONS.dup
+
+      # Libraries pass in values such as :Port and there is no way to determine
+      # if it is a default provided by the library or a special value provided
+      # by the user. A special key `user_supplied_options` can be passed. This
+      # contains an array of all explicitly defined user options. We then
+      # know that all other values are defaults
+      if user_supplied_options = options.delete(:user_supplied_options)
+        (options.keys - user_supplied_options).each do |k|
+          default_options[k] = options.delete(k)
+        end
+      end
 
-      def self.run(app, options = {})
-        options  = DEFAULT_OPTIONS.merge(options)
+      @events = options[:events] || ::Puma::Events.new
 
-        if options[:Verbose]
-          app = Rack::CommonLogger.new(app, STDOUT)
+      conf = ::Puma::Configuration.new(options, default_options.merge({ events: @events })) do |user_config, file_config, default_config|
+        if options.delete(:Verbose)
+          begin
+            require 'rack/commonlogger'  # Rack 1.x
+          rescue LoadError
+            require 'rack/common_logger' # Rack 2 and later
+          end
+          app = ::Rack::CommonLogger.new(app, STDOUT)
         end
 
         if options[:environment]
-          ENV['RACK_ENV'] = options[:environment].to_s
+          user_config.environment options[:environment]
         end
 
-        server   = ::Puma::Server.new(app)
-        min, max = options[:Threads].split(':', 2)
-
-        puts "Puma #{::Puma::Const::PUMA_VERSION} starting..."
-        puts "* Min threads: #{min}, max threads: #{max}"
-        puts "* Environment: #{ENV['RACK_ENV']}"
-        puts "* Listening on tcp://#{options[:Host]}:#{options[:Port]}"
-
-        server.add_tcp_listener options[:Host], options[:Port]
-        server.min_threads = Integer(min)
-        server.max_threads = Integer(max)
-        yield server if block_given?
-
-        begin
-          server.run.join
-        rescue Interrupt
-          puts "* Gracefully stopping, waiting for requests to finish"
-          server.stop(true)
-          puts "* Goodbye!"
+        if options[:Threads]
+          min, max = options.delete(:Threads).split(':', 2)
+          user_config.threads min, max
         end
 
+        if options[:Host] || options[:Port]
+          host = options[:Host] || default_options[:Host]
+          port = options[:Port] || default_options[:Port]
+          self.set_host_port_to_config(host, port, user_config)
+        end
+
+        if default_options[:Host]
+          file_config.set_default_host(default_options[:Host])
+        end
+        self.set_host_port_to_config(default_options[:Host], default_options[:Port], default_config)
+
+        user_config.app app
       end
+      conf
+    end
+
+    def run(app, **options)
+      conf = self.config(app, options)
+
+      log_writer = options.delete(:Silent) ? ::Puma::LogWriter.strings : ::Puma::LogWriter.stdio
+
+      launcher = ::Puma::Launcher.new(conf, log_writer: log_writer, events: @events)
 
-      def self.valid_options
-        {
-          "Host=HOST"       => "Hostname to listen on (default: localhost)",
-          "Port=PORT"       => "Port to listen on (default: 8080)",
-          "Threads=MIN:MAX" => "min:max threads to use (default 0:16)",
-          "Quiet"           => "Don't report each request"
-        }
+      yield launcher if block_given?
+      begin
+        launcher.run
+      rescue Interrupt
+        puts "* Gracefully stopping, waiting for requests to finish"
+        launcher.stop
+        puts "* Goodbye!"
       end
     end
 
-    register :puma, Puma
+    def valid_options
+      {
+        "Host=HOST"       => "Hostname to listen on (default: localhost)",
+        "Port=PORT"       => "Port to listen on (default: 8080)",
+        "Threads=MIN:MAX" => "min:max threads to use (default 0:16)",
+        "Verbose"         => "Don't report each request (default: false)"
+      }
+    end
+
+    def set_host_port_to_config(host, port, config)
+      config.clear_binds! if host || port
+
+      if host&.start_with? '.', '/', '@'
+        config.bind "unix://#{host}"
+      elsif host&.start_with? 'ssl://'
+        uri = URI.parse(host)
+        uri.port ||= port || ::Puma::Configuration::DEFAULTS[:tcp_port]
+        config.bind uri.to_s
+      else
+
+        if host
+          port ||= ::Puma::Configuration::DEFAULTS[:tcp_port]
+        end
+
+        if port
+          host ||= ::Puma::Configuration::DEFAULTS[:tcp_host]
+          config.port port, host
+        end
+      end
+    end
   end
 end
 
-# This is to trick newrelic into enabling the agent automatically.
-module Mongrel
-  class HttpServer
+# rackup was removed in Rack 3, it is now a separate gem
+if Object.const_defined?(:Rackup) && ::Rackup.const_defined?(:Handler)
+  module Rackup
+    module Handler
+      module Puma
+        class << self
+          include ::Puma::RackHandler
+        end
+      end
+      register :puma, Puma
+    end
+  end
+else
+  do_register = Object.const_defined?(:Rack) && ::Rack.release < '3'
+  module Rack
+    module Handler
+      module Puma
+        class << self
+          include ::Puma::RackHandler
+        end
+      end
+    end
   end
+  ::Rack::Handler.register(:puma, ::Rack::Handler::Puma) if do_register
 end

data/tools/Dockerfile

@@ -0,0 +1,26 @@
+# Use this Dockerfile to create minimal reproductions of issues
+# Build (MRI): docker build -f tools/Dockerfile .
+# Build (JRuby): docker build -f tools/Dockerfile --build-arg RUBY_IMAGE=jruby:9.4 .
+
+ARG RUBY_IMAGE=ruby:latest
+FROM ${RUBY_IMAGE}
+
+# Set BUNDLE_FROZEN=false if you need to update Gemfile.lock during a build.
+ARG BUNDLE_FROZEN=true
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends ragel procps git \
+  && rm -rf /var/lib/apt/lists/*
+
+# Only freeze Bundler and compile native extensions when using MRI.
+RUN if [ "$(ruby -e 'print RUBY_ENGINE')" = "ruby" ] && [ "${BUNDLE_FROZEN}" = "true" ]; then bundle config --global frozen 1; fi
+
+WORKDIR /usr/src/app
+
+COPY . .
+
+RUN bundle install
+RUN if [ "$(ruby -e 'print RUBY_ENGINE')" = "ruby" ]; then bundle exec rake compile; fi
+
+EXPOSE 9292
+CMD ["bundle", "exec", "bin/puma", "test/rackup/hello.ru"]

data/tools/trickletest.rb

@@ -0,0 +1,44 @@
+require 'socket'
+require 'stringio'
+
+def do_test(st, chunk)
+  s = TCPSocket.new('127.0.0.1',ARGV[0].to_i);
+  req = StringIO.new(st)
+  nout = 0
+  randstop = rand(st.length / 10)
+  STDERR.puts "stopping after: #{randstop}"
+
+  begin
+    while data = req.read(chunk)
+      nout += s.write(data)
+      s.flush
+      sleep 0.1
+      if nout > randstop
+        STDERR.puts "BANG! after #{nout} bytes."
+        break
+      end
+    end
+  rescue Object => e
+    STDERR.puts "ERROR: #{e}"
+  ensure
+    s.close
+  end
+end
+
+content = "-" * (1024 * 240)
+st = "GET / HTTP/1.1\r\nHost: www.zedshaw.com\r\nContent-Type: text/plain\r\nContent-Length: #{content.length}\r\n\r\n#{content}"
+
+puts "length: #{content.length}"
+
+threads = []
+ARGV[1].to_i.times do
+  t = Thread.new do
+    size = 100
+    puts ">>>> #{size} sized chunks"
+    do_test(st, size)
+  end
+
+  threads << t
+end
+
+threads.each {|t|  t.join}