puma 2.2.0 → 8.0.2

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.default_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}

metadata

@@ -1,90 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 2.2.0
-  prerelease: 
+  version: 8.0.2
 platform: ruby
 authors:
 - Evan Phoenix
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: nio4r
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - <
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - <
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.6'
-description: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server
-  for Ruby/Rack applications. Puma is intended for use in both development and production
-  environments. In order to get the best throughput, it is highly recommended that
-  you use a  Ruby implementation with real threads like Rubinius or JRuby.
+description: |
+  Puma is a simple, fast, multi-threaded, and highly parallel HTTP 1.1 server
+  for Ruby/Rack applications. Puma is intended for use in both development and
+  production environments. It's great for highly parallel Ruby implementations such as
+  JRuby and TruffleRuby as well as as providing process worker support to support CRuby well.
 email:
 - evan@phx.io
 executables:
@@ -92,132 +35,129 @@ executables:
 - pumactl
 extensions:
 - ext/puma_http11/extconf.rb
-extra_rdoc_files:
-- History.txt
-- Manifest.txt
-- README.md
-- docs/config.md
-- docs/nginx.md
-- tools/jungle/init.d/README.md
-- tools/jungle/upstart/README.md
+extra_rdoc_files: []
 files:
-- COPYING
-- Gemfile
-- History.txt
+- History.md
 - LICENSE
-- Manifest.txt
 - README.md
-- Rakefile
-- TODO
 - bin/puma
+- bin/puma-wild
 - bin/pumactl
-- docs/config.md
+- docs/5.0-Upgrade.md
+- docs/6.0-Upgrade.md
+- docs/7.0-Upgrade.md
+- docs/8.0-Upgrade.md
+- docs/architecture.md
+- docs/compile_options.md
+- docs/deployment.md
+- docs/fork_worker.md
+- docs/grpc.md
+- docs/images/favicon.svg
+- docs/images/puma-connection-flow-no-reactor.png
+- docs/images/puma-connection-flow.png
+- docs/images/puma-general-arch.png
+- docs/images/running-puma.svg
+- docs/images/standard-logo.svg
+- docs/java_options.md
+- docs/jungle/README.md
+- docs/jungle/rc.d/README.md
+- docs/jungle/rc.d/puma
+- docs/jungle/rc.d/puma.conf
+- docs/kubernetes.md
 - docs/nginx.md
+- docs/plugins.md
+- docs/rails_dev_mode.md
+- docs/restart.md
+- docs/signals.md
+- docs/stats.md
+- docs/systemd.md
+- docs/testing_benchmarks_local_files.md
+- docs/testing_test_rackup_ci_files.md
 - ext/puma_http11/PumaHttp11Service.java
-- ext/puma_http11/ext_help.h
 - ext/puma_http11/extconf.rb
 - ext/puma_http11/http11_parser.c
 - ext/puma_http11/http11_parser.h
 - ext/puma_http11/http11_parser.java.rl
 - ext/puma_http11/http11_parser.rl
 - ext/puma_http11/http11_parser_common.rl
-- ext/puma_http11/io_buffer.c
 - ext/puma_http11/mini_ssl.c
+- ext/puma_http11/no_ssl/PumaHttp11Service.java
+- ext/puma_http11/org/jruby/puma/EnvKey.java
 - ext/puma_http11/org/jruby/puma/Http11.java
 - ext/puma_http11/org/jruby/puma/Http11Parser.java
 - ext/puma_http11/org/jruby/puma/MiniSSL.java
 - ext/puma_http11/puma_http11.c
 - lib/puma.rb
-- lib/puma/accept_nonblock.rb
 - lib/puma/app/status.rb
 - lib/puma/binder.rb
-- lib/puma/capistrano.rb
 - lib/puma/cli.rb
 - lib/puma/client.rb
-- lib/puma/compat.rb
+- lib/puma/client_env.rb
+- lib/puma/cluster.rb
+- lib/puma/cluster/worker.rb
+- lib/puma/cluster/worker_handle.rb
+- lib/puma/cluster_accept_loop_delay.rb
+- lib/puma/commonlogger.rb
 - lib/puma/configuration.rb
 - lib/puma/const.rb
 - lib/puma/control_cli.rb
-- lib/puma/daemon_ext.rb
-- lib/puma/delegation.rb
 - lib/puma/detect.rb
+- lib/puma/dsl.rb
+- lib/puma/error_logger.rb
 - lib/puma/events.rb
 - lib/puma/io_buffer.rb
-- lib/puma/java_io_buffer.rb
 - lib/puma/jruby_restart.rb
+- lib/puma/json_serialization.rb
+- lib/puma/launcher.rb
+- lib/puma/launcher/bundle_pruner.rb
+- lib/puma/log_writer.rb
 - lib/puma/minissl.rb
+- lib/puma/minissl/context_builder.rb
 - lib/puma/null_io.rb
+- lib/puma/plugin.rb
+- lib/puma/plugin/systemd.rb
+- lib/puma/plugin/tmp_restart.rb
+- lib/puma/rack/builder.rb
+- lib/puma/rack/urlmap.rb
 - lib/puma/rack_default.rb
-- lib/puma/rack_patch.rb
 - lib/puma/reactor.rb
+- lib/puma/response.rb
+- lib/puma/runner.rb
+- lib/puma/sd_notify.rb
 - lib/puma/server.rb
+- lib/puma/server_plugin_control.rb
+- lib/puma/single.rb
+- lib/puma/state_file.rb
 - lib/puma/thread_pool.rb
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
-- puma.gemspec
-- tools/jungle/init.d/README.md
-- tools/jungle/init.d/puma
-- tools/jungle/init.d/run-puma
-- tools/jungle/upstart/README.md
-- tools/jungle/upstart/puma-manager.conf
-- tools/jungle/upstart/puma.conf
-- test/test_app_status.rb
-- test/test_cli.rb
-- test/test_config.rb
-- test/test_http10.rb
-- test/test_http11.rb
-- test/test_integration.rb
-- test/test_iobuffer.rb
-- test/test_minissl.rb
-- test/test_null_io.rb
-- test/test_persistent.rb
-- test/test_puma_server.rb
-- test/test_rack_handler.rb
-- test/test_rack_server.rb
-- test/test_thread_pool.rb
-- test/test_unix_socket.rb
-- test/test_ws.rb
-homepage: http://puma.io
-licenses: []
-post_install_message: 
-rdoc_options:
-- --main
-- README.md
+- tools/Dockerfile
+- tools/trickletest.rb
+homepage: https://puma.io
+licenses:
+- BSD-3-Clause
+metadata:
+  bug_tracker_uri: https://github.com/puma/puma/issues
+  changelog_uri: https://github.com/puma/puma/blob/main/History.md
+  homepage_uri: https://puma.io
+  source_code_uri: https://github.com/puma/puma
+  rubygems_mfa_required: 'true'
+  msys2_mingw_dependencies: openssl
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: puma
-rubygems_version: 1.8.25
-signing_key: 
-specification_version: 3
-summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for
-  Ruby/Rack applications
-test_files:
-- test/test_app_status.rb
-- test/test_cli.rb
-- test/test_config.rb
-- test/test_http10.rb
-- test/test_http11.rb
-- test/test_integration.rb
-- test/test_iobuffer.rb
-- test/test_minissl.rb
-- test/test_null_io.rb
-- test/test_persistent.rb
-- test/test_puma_server.rb
-- test/test_rack_handler.rb
-- test/test_rack_server.rb
-- test/test_thread_pool.rb
-- test/test_unix_socket.rb
-- test/test_ws.rb
+rubygems_version: 4.0.6
+specification_version: 4
+summary: A Ruby/Rack web server built for parallelism.
+test_files: []