puma 4.3.5 → 6.0.1

data/lib/puma.rb

@@ -10,22 +10,71 @@ 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

@@ -11,10 +11,10 @@ module Rack
       }
 
       def self.config(app, options = {})
-        require 'puma'
-        require 'puma/configuration'
-        require 'puma/events'
-        require 'puma/launcher'
+        require_relative '../../puma'
+        require_relative '../../puma/configuration'
+        require_relative '../../puma/log_writer'
+        require_relative '../../puma/launcher'
 
         default_options = DEFAULT_OPTIONS.dup
 
@@ -30,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
 
@@ -61,12 +60,12 @@ 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
+        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)
 
         yield launcher if block_given?
         begin
@@ -94,16 +93,16 @@ module Rack
           config.bind "unix://#{host}"
         elsif host && host =~ /^ssl:\/\//
           uri = URI.parse(host)
-          uri.port ||= port || ::Puma::Configuration::DefaultTCPPort
+          uri.port ||= port || ::Puma::Configuration::DEFAULTS[:tcp_port]
           config.bind uri.to_s
         else
 
           if host
-            port ||= ::Puma::Configuration::DefaultTCPPort
+            port ||= ::Puma::Configuration::DEFAULTS[:tcp_port]
           end
 
           if port
-            host ||= ::Puma::Configuration::DefaultTCPHost
+            host ||= ::Puma::Configuration::DEFAULTS[:tcp_host]
             config.port port, host
           end
         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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 4.3.5
+  version: 6.0.1
 platform: ruby
 authors:
 - Evan Phoenix
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -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,30 +72,34 @@ 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
@@ -95,33 +109,27 @@ files:
 - 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/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
-post_install_message: 
+  homepage_uri: https://puma.io
+  source_code_uri: https://github.com/puma/puma
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,16 +137,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.0.3
-signing_key: 
+rubygems_version: 3.2.26
+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`.

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/ext/puma_http11/org/jruby/puma/IOBuffer.java

@@ -1,72 +0,0 @@
-package org.jruby.puma;
-
-import org.jruby.*;
-import org.jruby.anno.JRubyMethod;
-import org.jruby.runtime.ObjectAllocator;
-import org.jruby.runtime.ThreadContext;
-import org.jruby.runtime.builtin.IRubyObject;
-import org.jruby.util.ByteList;
-
-/**
- * @author kares
- */
-public class IOBuffer extends RubyObject {
-
-    private static final ObjectAllocator ALLOCATOR = new ObjectAllocator() {
-        public IRubyObject allocate(Ruby runtime, RubyClass klass) {
-            return new IOBuffer(runtime, klass);
-        }
-    };
-
-    public static void createIOBuffer(Ruby runtime) {
-        RubyModule mPuma = runtime.defineModule("Puma");
-        RubyClass cIOBuffer = mPuma.defineClassUnder("IOBuffer", runtime.getObject(), ALLOCATOR);
-        cIOBuffer.defineAnnotatedMethods(IOBuffer.class);
-    }
-
-    private static final int DEFAULT_SIZE = 4096;
-
-    final ByteList buffer = new ByteList(DEFAULT_SIZE);
-
-    IOBuffer(Ruby runtime, RubyClass klass) {
-        super(runtime, klass);
-    }
-
-    @JRubyMethod
-    public RubyInteger used(ThreadContext context) {
-        return context.runtime.newFixnum(buffer.getRealSize());
-    }
-
-    @JRubyMethod
-    public RubyInteger capacity(ThreadContext context) {
-        return context.runtime.newFixnum(buffer.unsafeBytes().length);
-    }
-
-    @JRubyMethod
-    public IRubyObject reset() {
-        buffer.setRealSize(0);
-        return this;
-    }
-
-    @JRubyMethod(name = { "to_s", "to_str" })
-    public RubyString to_s(ThreadContext context) {
-        return RubyString.newStringShared(context.runtime, buffer.unsafeBytes(), 0, buffer.getRealSize());
-    }
-
-    @JRubyMethod(name = "<<")
-    public IRubyObject add(IRubyObject str) {
-        addImpl(str.convertToString());
-        return this;
-    }
-
-    @JRubyMethod(rest = true)
-    public IRubyObject append(IRubyObject[] strs) {
-        for (IRubyObject str : strs) addImpl(str.convertToString());
-        return this;
-    }
-
-    private void addImpl(RubyString str) {
-        buffer.append(str.getByteList());
-    }
-
-}

data/lib/puma/accept_nonblock.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-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
-            if ssl
-              ssl.close
-            else
-              sock.close
-            end
-            raise ex
-          end
-        end
-      end
-    end
-  end
-end

data/lib/puma/tcp_logger.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Puma
-  class TCPLogger
-    def initialize(logger, app, quiet=false)
-      @logger = logger
-      @app = app
-      @quiet = quiet
-    end
-
-    FORMAT = "%s - %s"
-
-    def log(who, str)
-      now = Time.now.strftime("%d/%b/%Y %H:%M:%S")
-
-      log_str = "#{now} - #{who} - #{str}"
-
-      case @logger
-      when IO
-        @logger.puts log_str
-      when Events
-        @logger.log log_str
-      end
-    end
-
-    def call(env, socket)
-      who = env[Const::REMOTE_ADDR]
-      log who, "connected" unless @quiet
-
-      env['log'] = lambda { |str| log(who, str) }
-
-      begin
-        @app.call env, socket
-      rescue Object => e
-        log who, "exception: #{e.message} (#{e.class})"
-      else
-        log who, "disconnected" unless @quiet
-      end
-    end
-  end
-end