puma 3.12.0 → 5.6.8

data/lib/puma/util.rb

@@ -1,10 +1,6 @@
-major, minor, patch = RUBY_VERSION.split('.').map { |v| v.to_i }
+# frozen_string_literal: true
 
-if major == 1 && minor == 9 && patch == 3 && RUBY_PATCHLEVEL < 125
-  require 'puma/rack/backports/uri/common_193'
-else
-  require 'uri/common'
-end
+require 'uri/common'
 
 module Puma
   module Util
@@ -14,18 +10,45 @@ module Puma
       IO.pipe
     end
 
-    # Unescapes a URI escaped string with +encoding+. +encoding+ will be the
-    # target encoding of the string returned, and it defaults to UTF-8
+    # An instance method on Thread has been provided to address https://bugs.ruby-lang.org/issues/13632,
+    # which currently effects some older versions of Ruby: 2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1
+    # Additional context: https://github.com/puma/puma/pull/1345
+    def purge_interrupt_queue
+      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
+    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
+    module_function :unescape, :escape
+
+    # @version 5.0.0
+    def nakayoshi_gc(events)
+      events.log "! Promoting existing objects to old generation..."
+      4.times { GC.start(full_mark: false) }
+      if GC.respond_to?(:compact)
+        events.log "! Compacting..."
+        GC.compact
+      end
+      events.log "! Friendly fork preparation complete."
+    end
 
     DEFAULT_SEP = /[&;] */n
 
@@ -54,7 +77,7 @@ module Puma
         end
       end
 
-      return params
+      params
     end
 
     # A case-insensitive Hash that preserves the original case of a
@@ -76,6 +99,7 @@ module Puma
         end
       end
 
+      # @!attribute [r] to_hash
       def to_hash
         hash = {}
         each { |k,v| hash[k] = v }

data/lib/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Standard libraries
 require 'socket'
 require 'tempfile'
@@ -8,16 +10,70 @@ require 'stringio'
 
 require 'thread'
 
+# extension files should not be loaded with `require_relative`
+require 'puma/puma_http11'
+require_relative 'puma/detect'
+require_relative 'puma/json_serialization'
+require_relative 'rack/version_restriction'
+
 module Puma
   autoload :Const, 'puma/const'
   autoload :Server, 'puma/server'
   autoload :Launcher, 'puma/launcher'
 
+  # 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 '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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/handler'
 
 module Rack
@@ -28,9 +30,8 @@ module Rack
         end
 
         conf = ::Puma::Configuration.new(options, default_options) do |user_config, file_config, default_config|
-          user_config.quiet
-
           if options.delete(:Verbose)
+            require 'rack/common_logger'
             app = Rack::CommonLogger.new(app, STDOUT)
           end
 
@@ -49,6 +50,9 @@ module Rack
             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
@@ -56,9 +60,7 @@ module Rack
         conf
       end
 
-
-
-      def self.run(app, options = {})
+      def self.run(app, **options)
         conf   = self.config(app, options)
 
         events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio
@@ -83,7 +85,7 @@ module Rack
           "Verbose"         => "Don't report each request (default: false)"
         }
       end
-    private
+
       def self.set_host_port_to_config(host, port, config)
         config.clear_binds! if host || port
 

data/lib/rack/version_restriction.rb

@@ -0,0 +1,15 @@
+begin
+  begin
+    # rack/version exists in Rack 2.2.0 and later, compatible with Ruby 2.3 and later
+    # we prefer to not load Rack
+    require 'rack/version'
+  rescue LoadError
+    require 'rack'
+  end
+
+  # Rack.release is needed for Rack v1, Rack::RELEASE was added in v2
+  if Gem::Version.new(Rack.release) >= Gem::Version.new("3.0.0")
+    raise StandardError.new "Puma 5 is not compatible with Rack 3, please upgrade to Puma 6 or higher."
+  end
+rescue LoadError
+end

data/tools/Dockerfile

@@ -0,0 +1,16 @@
+# Use this Dockerfile to create minimal reproductions of issues
+
+FROM ruby:3.1
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+WORKDIR /usr/src/app
+
+COPY . .
+RUN gem install bundler
+RUN bundle install
+RUN bundle exec rake compile
+
+EXPOSE 9292
+CMD bundle exec bin/puma test/rackup/hello.ru

data/tools/trickletest.rb

@@ -38,7 +38,6 @@ ARGV[1].to_i.times do
     do_test(st, size)
   end
 
-  t.abort_on_exception = true
   threads << t
 end
 

metadata

@@ -1,18 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 5.6.8
 platform: ruby
 authors:
 - Evan Phoenix
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
-dependencies: []
-description: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server
+date: 2024-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nio4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+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
@@ -30,14 +44,23 @@ 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
 - ext/puma_http11/PumaHttp11Service.java
 - ext/puma_http11/ext_help.h
@@ -47,68 +70,63 @@ 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/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/compat.rb
 - lib/puma/configuration.rb
 - lib/puma/const.rb
 - lib/puma/control_cli.rb
-- lib/puma/convenient.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/minissl.rb
+- lib/puma/minissl/context_builder.rb
 - lib/puma/null_io.rb
 - lib/puma/plugin.rb
 - lib/puma/plugin/tmp_restart.rb
-- lib/puma/rack/backports/uri/common_193.rb
+- lib/puma/queue_close.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/server.rb
 - lib/puma/single.rb
 - lib/puma/state_file.rb
-- lib/puma/tcp_logger.rb
+- lib/puma/systemd.rb
 - lib/puma/thread_pool.rb
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
-- 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
+- lib/rack/version_restriction.rb
+- tools/Dockerfile
 - tools/trickletest.rb
-homepage: http://puma.io
+homepage: https://puma.io
 licenses:
 - BSD-3-Clause
 metadata:
-  msys2_mingw_dependencies: openssl
-post_install_message: 
+  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
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,10 +141,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.5.3
+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/ext/puma_http11/io_buffer.c

@@ -1,155 +0,0 @@
-#define RSTRING_NOT_MODIFIED 1
-#include "ruby.h"
-
-#include <sys/types.h>
-
-struct buf_int {
-  uint8_t* top;
-  uint8_t* cur;
-
-  size_t size;
-};
-
-#define BUF_DEFAULT_SIZE 4096
-#define BUF_TOLERANCE 32
-
-static void buf_free(struct buf_int* internal) {
-  xfree(internal->top);
-  xfree(internal);
-}
-
-static VALUE buf_alloc(VALUE self) {
-  VALUE buf;
-  struct buf_int* internal;
-
-  buf = Data_Make_Struct(self, struct buf_int, 0, buf_free, internal);
-
-  internal->size = BUF_DEFAULT_SIZE;
-  internal->top = ALLOC_N(uint8_t, BUF_DEFAULT_SIZE);
-  internal->cur = internal->top;
-
-  return buf;
-}
-
-static VALUE buf_append(VALUE self, VALUE str) {
-  struct buf_int* b;
-  size_t used, str_len, new_size;
-
-  Data_Get_Struct(self, struct buf_int, b);
-
-  used = b->cur - b->top;
-
-  StringValue(str);
-  str_len = RSTRING_LEN(str);
-
-  new_size = used + str_len;
-
-  if(new_size > b->size) {
-    size_t n = b->size + (b->size / 2);
-    uint8_t* top;
-    uint8_t* old;
-
-    new_size = (n > new_size ? n : new_size + BUF_TOLERANCE);
-
-    top = ALLOC_N(uint8_t, new_size);
-    old = b->top;
-    memcpy(top, old, used);
-    b->top = top;
-    b->cur = top + used;
-    b->size = new_size;
-    xfree(old);
-  }
-
-  memcpy(b->cur, RSTRING_PTR(str), str_len);
-  b->cur += str_len;
-
-  return self;
-}
-
-static VALUE buf_append2(int argc, VALUE* argv, VALUE self) {
-  struct buf_int* b;
-  size_t used, new_size;
-  int i;
-  VALUE str;
-
-  Data_Get_Struct(self, struct buf_int, b);
-
-  used = b->cur - b->top;
-  new_size = used;
-
-  for(i = 0; i < argc; i++) {
-    StringValue(argv[i]);
-
-    str = argv[i];
-
-    new_size += RSTRING_LEN(str);
-  }
-
-  if(new_size > b->size) {
-    size_t n = b->size + (b->size / 2);
-    uint8_t* top;
-    uint8_t* old;
-
-    new_size = (n > new_size ? n : new_size + BUF_TOLERANCE);
-
-    top = ALLOC_N(uint8_t, new_size);
-    old = b->top;
-    memcpy(top, old, used);
-    b->top = top;
-    b->cur = top + used;
-    b->size = new_size;
-    xfree(old);
-  }
-
-  for(i = 0; i < argc; i++) {
-    long str_len;
-    str = argv[i];
-    str_len = RSTRING_LEN(str);
-    memcpy(b->cur, RSTRING_PTR(str), str_len);
-    b->cur += str_len;
-  }
-
-  return self;
-}
-
-static VALUE buf_to_str(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  return rb_str_new((const char*)(b->top), b->cur - b->top);
-}
-
-static VALUE buf_used(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  return INT2FIX(b->cur - b->top);
-}
-
-static VALUE buf_capa(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  return INT2FIX(b->size);
-}
-
-static VALUE buf_reset(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  b->cur = b->top;
-  return self;
-}
-
-void Init_io_buffer(VALUE puma) {
-  VALUE buf = rb_define_class_under(puma, "IOBuffer", rb_cObject);
-
-  rb_define_alloc_func(buf, buf_alloc);
-  rb_define_method(buf, "<<", buf_append, 1);
-  rb_define_method(buf, "append", buf_append2, -1);
-  rb_define_method(buf, "to_str", buf_to_str, 0);
-  rb_define_method(buf, "to_s", buf_to_str, 0);
-  rb_define_method(buf, "used", buf_used, 0);
-  rb_define_method(buf, "capacity", buf_capa, 0);
-  rb_define_method(buf, "reset", buf_reset, 0);
-}

data/lib/puma/accept_nonblock.rb

@@ -1,23 +0,0 @@
-require 'openssl'
-
-module OpenSSL
-  module SSL
-    class SSLServer
-      unless public_method_defined? :accept_nonblock
-        def accept_nonblock
-          sock = @svr.accept_nonblock
-
-          begin
-            ssl = OpenSSL::SSL::SSLSocket.new(sock, @ctx)
-            ssl.sync_close = true
-            ssl.accept if @start_immediately
-            ssl
-          rescue SSLError => ex
-            sock.close
-            raise ex
-          end
-        end
-      end
-    end
-  end
-end

data/lib/puma/compat.rb

@@ -1,14 +0,0 @@
-# Provides code to work properly on 1.8 and 1.9
-
-class String
-  unless method_defined? :bytesize
-    alias_method :bytesize, :size
-  end
-
-  unless method_defined? :byteslice
-    def byteslice(*arg)
-      enc = self.encoding
-      self.dup.force_encoding(Encoding::ASCII_8BIT).slice(*arg).force_encoding(enc)
-    end
-  end
-end

data/lib/puma/convenient.rb

@@ -1,23 +0,0 @@
-require 'puma/launcher'
-require 'puma/configuration'
-
-module Puma
-  def self.run(opts={})
-    cfg = Puma::Configuration.new do |user_config|
-      if port = opts[:port]
-        user_config.port port
-      end
-
-      user_config.quiet
-
-      yield c
-    end
-
-    cfg.clamp
-
-    events = Puma::Events.null
-
-    launcher = Puma::Launcher.new cfg, :events => events
-    launcher.run
-  end
-end

data/lib/puma/daemon_ext.rb

@@ -1,31 +0,0 @@
-module Process
-
-  # This overrides the default version because it is broken if it
-  # exists.
-
-  if respond_to? :daemon
-    class << self
-      remove_method :daemon
-    end
-  end
-
-  def self.daemon(nochdir=false, noclose=false)
-    exit if fork                     # Parent exits, child continues.
-
-    Process.setsid                   # Become session leader.
-
-    exit if fork                     # Zap session leader. See [1].
-
-    Dir.chdir "/" unless nochdir     # Release old working directory.
-
-    if !noclose
-      STDIN.reopen File.open("/dev/null", "r")
-
-      null_out = File.open "/dev/null", "w"
-      STDOUT.reopen null_out
-      STDERR.reopen null_out
-    end
-
-    0
-  end
-end

data/lib/puma/delegation.rb

@@ -1,11 +0,0 @@
-module Puma
-  module Delegation
-    def forward(what, who)
-      module_eval <<-CODE
-        def #{what}(*args, &block)
-          #{who}.#{what}(*args, &block)
-        end
-      CODE
-    end
-  end
-end