puma 4.3.12 → 6.3.1

data/lib/puma.rb

@@ -3,29 +3,76 @@
 # Standard libraries
 require 'socket'
 require 'tempfile'
-require 'time'
-require 'etc'
 require 'uri'
 require 'stringio'
 
 require 'thread'
 
+# 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
-  autoload :Const, 'puma/const'
-  autoload :Server, 'puma/server'
-  autoload :Launcher, 'puma/launcher'
+  # 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
 
-  # Thread name is new in Ruby 2.3
   def self.set_thread_name(name)
-    return unless Thread.current.respond_to?(:name=)
     Thread.current.name = "puma #{name}"
   end
 end

data/lib/rack/handler/puma.rb

@@ -1,115 +1,141 @@
 # frozen_string_literal: true
 
-require 'rack/handler'
-
-module Rack
-  module Handler
-    module Puma
-      DEFAULT_OPTIONS = {
-        :Verbose => false,
-        :Silent  => false
-      }
-
-      def self.config(app, options = {})
-        require 'puma'
-        require 'puma/configuration'
-        require 'puma/events'
-        require '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
+# This module is used as an 'include' file in code at bottom of file
+module 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
 
-        conf = ::Puma::Configuration.new(options, default_options) do |user_config, file_config, default_config|
-          user_config.quiet
-
-          if options.delete(:Verbose)
-            app = Rack::CommonLogger.new(app, STDOUT)
-          end
+      @events = options[:events] || ::Puma::Events.new
 
-          if options[:environment]
-            user_config.environment options[:environment]
+      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[:Threads]
-            min, max = options.delete(:Threads).split(':', 2)
-            user_config.threads min, max
-          end
+        if options[:environment]
+          user_config.environment options[:environment]
+        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 options[:Threads]
+          min, max = options.delete(:Threads).split(':', 2)
+          user_config.threads min, max
+        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)
+        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
 
-          user_config.app app
+        if default_options[:Host]
+          file_config.set_default_host(default_options[:Host])
         end
-        conf
+        self.set_host_port_to_config(default_options[:Host], default_options[:Port], default_config)
+
+        user_config.app app
       end
+      conf
+    end
 
-      def self.run(app, options = {})
-        conf   = self.config(app, options)
+    def run(app, **options)
+      conf = self.config(app, options)
 
-        events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio
+      log_writer = options.delete(:Silent) ? ::Puma::LogWriter.strings : ::Puma::LogWriter.stdio
 
-        launcher = ::Puma::Launcher.new(conf, :events => events)
+      launcher = ::Puma::Launcher.new(conf, :log_writer => log_writer, events: @events)
 
-        yield launcher if block_given?
-        begin
-          launcher.run
-        rescue Interrupt
-          puts "* Gracefully stopping, waiting for requests to finish"
-          launcher.stop
-          puts "* Goodbye!"
-        end
+      yield launcher if block_given?
+      begin
+        launcher.run
+      rescue Interrupt
+        puts "* Gracefully stopping, waiting for requests to finish"
+        launcher.stop
+        puts "* Goodbye!"
       end
+    end
 
-      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)",
-          "Verbose"         => "Don't report each request (default: false)"
-        }
-      end
+    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 self.set_host_port_to_config(host, port, config)
-        config.clear_binds! if host || port
+    def set_host_port_to_config(host, port, config)
+      config.clear_binds! if host || port
 
-        if host && (host[0,1] == '.' || host[0,1] == '/')
-          config.bind "unix://#{host}"
-        elsif host && host =~ /^ssl:\/\//
-          uri = URI.parse(host)
-          uri.port ||= port || ::Puma::Configuration::DefaultTCPPort
-          config.bind uri.to_s
-        else
+      if host && (host[0,1] == '.' || host[0,1] == '/')
+        config.bind "unix://#{host}"
+      elsif host && host =~ /^ssl:\/\//
+        uri = URI.parse(host)
+        uri.port ||= port || ::Puma::Configuration::DEFAULTS[:tcp_port]
+        config.bind uri.to_s
+      else
 
-          if host
-            port ||= ::Puma::Configuration::DefaultTCPPort
-          end
+        if host
+          port ||= ::Puma::Configuration::DEFAULTS[:tcp_port]
+        end
 
-          if port
-            host ||= ::Puma::Configuration::DefaultTCPHost
-            config.port port, host
-          end
+        if port
+          host ||= ::Puma::Configuration::DEFAULTS[:tcp_host]
+          config.port port, host
         end
       end
     end
+  end
+end
 
-    register :puma, Puma
+# rackup was removed in Rack 3, it is now a separate gem
+if Object.const_defined? :Rackup
+  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/{docker/Dockerfile → Dockerfile}

@@ -1,6 +1,6 @@
 # Use this Dockerfile to create minimal reproductions of issues
 
-FROM ruby:2.6
+FROM ruby:3.1
 
 # throw errors if Gemfile has been modified since Gemfile.lock
 RUN bundle config --global frozen 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 4.3.12
+  version: 6.3.1
 platform: ruby
 authors:
 - Evan Phoenix
@@ -24,9 +24,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server
+description: Puma is a simple, fast, 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 concurrent Ruby implementations such as Rubinius
+  environments. It's great for highly parallel Ruby implementations such as Rubinius
   and JRuby as well as as providing process worker support to support CRuby well.
 email:
 - evan@phx.io
@@ -44,16 +44,26 @@ files:
 - bin/puma-wild
 - bin/pumactl
 - docs/architecture.md
+- docs/compile_options.md
 - docs/deployment.md
+- docs/fork_worker.md
 - docs/images/puma-connection-flow-no-reactor.png
 - docs/images/puma-connection-flow.png
 - docs/images/puma-general-arch.png
+- 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/tcp_mode.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
@@ -62,65 +72,64 @@ files:
 - 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/Http11.java
 - ext/puma_http11/org/jruby/puma/Http11Parser.java
-- ext/puma_http11/org/jruby/puma/IOBuffer.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/cli.rb
 - lib/puma/client.rb
 - lib/puma/cluster.rb
+- lib/puma/cluster/worker.rb
+- lib/puma/cluster/worker_handle.rb
 - lib/puma/commonlogger.rb
 - lib/puma/configuration.rb
 - lib/puma/const.rb
 - lib/puma/control_cli.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/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/reactor.rb
+- lib/puma/request.rb
 - lib/puma/runner.rb
+- lib/puma/sd_notify.rb
 - lib/puma/server.rb
 - lib/puma/single.rb
 - lib/puma/state_file.rb
-- lib/puma/tcp_logger.rb
 - lib/puma/thread_pool.rb
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
-- tools/docker/Dockerfile
-- tools/jungle/README.md
-- tools/jungle/init.d/README.md
-- tools/jungle/init.d/puma
-- tools/jungle/init.d/run-puma
-- tools/jungle/rc.d/README.md
-- tools/jungle/rc.d/puma
-- tools/jungle/rc.d/puma.conf
-- tools/jungle/upstart/README.md
-- tools/jungle/upstart/puma-manager.conf
-- tools/jungle/upstart/puma.conf
+- tools/Dockerfile
 - tools/trickletest.rb
-homepage: http://puma.io
+homepage: https://puma.io
 licenses:
 - BSD-3-Clause
 metadata:
-  msys2_mingw_dependencies: openssl
+  bug_tracker_uri: https://github.com/puma/puma/issues
   changelog_uri: https://github.com/puma/puma/blob/master/History.md
+  homepage_uri: https://puma.io
+  source_code_uri: https://github.com/puma/puma
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -129,16 +138,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for
+summary: Puma is a simple, fast, threaded, and highly parallel HTTP 1.1 server for
   Ruby/Rack applications
 test_files: []

data/docs/tcp_mode.md

@@ -1,96 +0,0 @@
-# TCP mode
-
-Puma also could be used as a TCP server to process incoming TCP
-connections.
-
-
-## Configuration
-
-TCP mode can be enabled with CLI option `--tcp-mode`:
-
-```
-$ puma --tcp-mode
-```
-
-Default ip and port to listen to are `0.0.0.0` and `9292`. You can configure
-them with `--port` and `--bind` options:
-
-```
-$ puma --tcp-mode --bind tcp://127.0.0.1:9293
-$ puma --tcp-mode --port 9293
-```
-
-TCP mode could be set with a configuration file as well with `tcp_mode`
-and `tcp_mode!` methods:
-
-```
-# config/puma.rb
-tcp_mode
-```
-
-When Puma starts in the TCP mode it prints the corresponding message:
-
-```
-puma --tcp-mode
-Puma starting in single mode...
-...
-* Mode: Lopez Express (tcp)
-```
-
-
-## How to declare an application
-
-An application to process TCP connections should be declared as a
-callable object which accepts `env` and `socket` arguments.
-
-`env` argument is a Hash with following structure:
-
-```ruby
-{ "thread" => {}, "REMOTE_ADDR" => "127.0.0.1:51133", "log" => "#<Proc:0x000..." }
-```
-
-It consists of:
-* `thread` - a Hash for each thread in the thread pool that could be
-  used to store information between requests
-* `REMOTE_ADDR` - a client ip address
-* `log` - a proc object to write something down
-
-`log` object could be used this way:
-
-```ruby
-env['log'].call('message to log')
-#> 19/Oct/2019 20:28:53 - 127.0.0.1:51266 - message to log
-```
-
-
-## Example of an application
-
-Let's look at an example of a simple application which just echoes
-incoming string:
-
-```ruby
-# config/puma.rb
-app do |env, socket|
-  s = socket.gets
-  socket.puts "Echo #{s}"
-end
-```
-
-We can easily access the TCP server with `telnet` command and receive an
-echo:
-
-```shell
-telnet 0.0.0.0 9293
-Trying 0.0.0.0...
-Connected to 0.0.0.0.
-Escape character is '^]'.
-sssss
-Echo sssss
-^CConnection closed by foreign host.
-```
-
-
-## Socket management
-
-After the application finishes, Puma closes the socket. In order to
-prevent this, the application should set `env['detach'] = true`.