puma 5.0.0.beta2-java → 5.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a07b62e45c13573cba434caa78d336c981104d65448bf2cba63cc7fe87ebe5
-  data.tar.gz: d05d3e5a89a5dec3f71a133024d596975bb5fb0a8b4e2a8c0342479f061132fc
+  metadata.gz: 57175cfb98319685a496220e92303e6c7827421de8569d0c1128b2f7d04d7a2a
+  data.tar.gz: 29c2a8c29628ca7732999005bad47ebcf071f1758dbf604a4bfa9ac5c063669d
 SHA512:
-  metadata.gz: 18498ab4e516ea2b386a8515c5ced3f2f5572e72f6281c87433f24f69b0ad94b55db2466a8f77df24b611c054353641ecce50b397b9cd698370bf81e3ba66369
-  data.tar.gz: 82efab2a81aebbd2eb50de04f906bb5f607f83121fe484f31feacd09cd481433d3f008278e8dcaf844a9b8ed3915e5985fa1a11fcf6d4f556eef24c87e9c6b3d
+  metadata.gz: 402feb9a877783c892bf9d1c441f7486961061c9de7182965ac50b60bc93de91ccb3e99bae102a3d0f337dd228017c69542d7812edad79515557ea2266ddb3bb
+  data.tar.gz: 2499c2971fd885aa8121076f1f4f8079add4eeed8dbb4157ac789747dc68794ef83f98222b8cc645542bfaa51379bee038bff64a514d1b1bfe1df4c7c3078e06

data/History.md

@@ -1,6 +1,7 @@
 ## 5.0.0
 
 * Features
+  * Allow compiling without OpenSSL and dynamically load files needed for SSL, add 'no ssl' CI (#2305)
   * EXPERIMENTAL: Add `fork_worker` option and `refork` command for reduced memory usage by forking from a worker process instead of the master process. (#2099)
   * EXPERIMENTAL: Added `wait_for_less_busy_worker` config. This may reduce latency on MRI through inserting a small delay before re-listening on the socket if worker is busy (#2079).
   * EXPERIMENTAL: Added `nakayoshi_fork` option. Reduce memory usage in preloaded cluster-mode apps by GCing before fork and compacting, where available. (#2093, #2256)
@@ -58,6 +59,7 @@
   * Fix recursive `prune_bundler` (#2319).
   * Ensure that TCP_CORK is usable
   * Fix corner case when request body is chunked (#2326)
+  * Fix filehandle leak in MiniSSL (#2299)
 
 * Refactor
   * Remove unused loader argument from Plugin initializer (#2095)
@@ -70,6 +72,12 @@
   * Support parallel tests in verbose progress reporting (#2223)
   * Refactor error handling in server accept loop (#2239)
 
+## 4.3.6 / 2020-09-05
+
+* Bugfixes
+  * Explicitly include ctype.h to fix compilation warning and build error on macOS with Xcode 12 (#2304)
+  * Don't require json at boot (#2269)
+
 ## 4.3.4/4.3.5 and 3.12.5/3.12.6 / 2020-05-22
 
 Each patchlevel release contains a separate security fix. We recommend simply upgrading to 4.3.5/3.12.6.

data/README.md

@@ -5,7 +5,6 @@
 # Puma: A Ruby Web Server Built For Concurrency
 
 [![Actions Build Status](https://github.com/puma/puma/workflows/CI/badge.svg?branch=master)](https://github.com/puma/puma/actions)
-
 [![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=puma&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=puma&package-manager=bundler&version-scheme=semver)
 [![StackOverflow](https://img.shields.io/badge/stackoverflow-Puma-blue.svg)]( https://stackoverflow.com/questions/tagged/puma )
@@ -30,6 +29,14 @@ $ puma
 Without arguments, puma will look for a rackup (.ru) file in
 working directory called `config.ru`.
 
+## SSL Connection Support
+
+Puma will install/compile with support for ssl sockets, assuming OpenSSL
+development files are installed on the system.
+
+If the system does not have OpenSSL development files installed, Puma will
+install/compile, but it will not allow ssl connections.
+
 ## Frameworks
 
 ### Rails

data/docs/signals.md

@@ -38,10 +38,10 @@ Puma cluster responds to these signals:
 - `TERM` send `TERM` to worker. Worker will attempt to finish then exit.
 - `USR2` restart workers. This also reloads puma configuration file, if there is one.
 - `USR1` restart workers in phases, a rolling restart. This will not reload configuration file.
-- `HUP`  reopen log files defined in stdout_redirect configuration parameter. If there is no stdout_redirect option provided it will behave like `INT`
-- `INT` equivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
+- `HUP ` reopen log files defined in stdout_redirect configuration parameter. If there is no stdout_redirect option provided it will behave like `INT`
+- `INT ` equivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
 - `CHLD`
-- `URG` refork workers in phases from worker 0, if `fork_workers` option is enabled.
+- `URG ` refork workers in phases from worker 0, if `fork_workers` option is enabled.
 
 ## Callbacks order in case of different signals
 

data/ext/puma_http11/mini_ssl.c

@@ -463,6 +463,9 @@ VALUE engine_peercert(VALUE self) {
   return rb_cert_buf;
 }
 
+/* @see Puma::MiniSSL::Socket#ssl_version_state
+ * @version 5.0.0
+ */
 static VALUE
 engine_ssl_vers_st(VALUE self) {
   ms_conn* conn;

data/ext/puma_http11/no_ssl/PumaHttp11Service.java

@@ -0,0 +1,15 @@
+package puma;
+
+import java.io.IOException;
+
+import org.jruby.Ruby;
+import org.jruby.runtime.load.BasicLibraryService;
+
+import org.jruby.puma.Http11;
+
+public class PumaHttp11Service implements BasicLibraryService {
+    public boolean basicLoad(final Ruby runtime) throws IOException {
+        Http11.createHttp11(runtime);
+        return true;
+    }
+}

data/ext/puma_http11/org/jruby/puma/MiniSSL.java

@@ -22,6 +22,7 @@ import javax.net.ssl.SSLException;
 import javax.net.ssl.SSLPeerUnverifiedException;
 import javax.net.ssl.SSLSession;
 import java.io.FileInputStream;
+import java.io.InputStream;
 import java.io.IOException;
 import java.nio.Buffer;
 import java.nio.ByteBuffer;
@@ -32,6 +33,8 @@ import java.security.NoSuchAlgorithmException;
 import java.security.UnrecoverableKeyException;
 import java.security.cert.CertificateEncodingException;
 import java.security.cert.CertificateException;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.Map;
 
 import static javax.net.ssl.SSLEngineResult.Status;
 import static javax.net.ssl.SSLEngineResult.HandshakeStatus;
@@ -130,10 +133,39 @@ public class MiniSSL extends RubyObject {
     super(runtime, klass);
   }
 
+  private static Map<String, KeyManagerFactory> keyManagerFactoryMap = new ConcurrentHashMap<String, KeyManagerFactory>();
+  private static Map<String, TrustManagerFactory> trustManagerFactoryMap = new ConcurrentHashMap<String, TrustManagerFactory>();
+
   @JRubyMethod(meta = true)
-  public static IRubyObject server(ThreadContext context, IRubyObject recv, IRubyObject miniSSLContext) {
-    RubyClass klass = (RubyClass) recv;
+  public static synchronized IRubyObject server(ThreadContext context, IRubyObject recv, IRubyObject miniSSLContext)
+      throws KeyStoreException, IOException, CertificateException, NoSuchAlgorithmException, UnrecoverableKeyException {
+    // Create the KeyManagerFactory and TrustManagerFactory for this server
+    String keystoreFile = miniSSLContext.callMethod(context, "keystore").convertToString().asJavaString();
+    char[] password = miniSSLContext.callMethod(context, "keystore_pass").convertToString().asJavaString().toCharArray();
+
+    KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());
+    InputStream is = new FileInputStream(keystoreFile);
+    try {
+      ks.load(is, password);
+    } finally {
+      is.close();
+    }
+    KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509");
+    kmf.init(ks, password);
+    keyManagerFactoryMap.put(keystoreFile, kmf);
+
+    KeyStore ts = KeyStore.getInstance(KeyStore.getDefaultType());
+    is = new FileInputStream(keystoreFile);
+    try {
+      ts.load(is, password);
+    } finally {
+      is.close();
+    }
+    TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509");
+    tmf.init(ts);
+    trustManagerFactoryMap.put(keystoreFile, tmf);
 
+    RubyClass klass = (RubyClass) recv;
     return klass.newInstance(context,
         new IRubyObject[] { miniSSLContext },
         Block.NULL_BLOCK);
@@ -141,20 +173,16 @@ public class MiniSSL extends RubyObject {
 
   @JRubyMethod
   public IRubyObject initialize(ThreadContext threadContext, IRubyObject miniSSLContext)
-      throws KeyStoreException, IOException, CertificateException, NoSuchAlgorithmException, UnrecoverableKeyException, KeyManagementException {
+      throws KeyStoreException, NoSuchAlgorithmException, KeyManagementException {
     KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());
     KeyStore ts = KeyStore.getInstance(KeyStore.getDefaultType());
 
-    char[] password = miniSSLContext.callMethod(threadContext, "keystore_pass").convertToString().asJavaString().toCharArray();
     String keystoreFile = miniSSLContext.callMethod(threadContext, "keystore").convertToString().asJavaString();
-    ks.load(new FileInputStream(keystoreFile), password);
-    ts.load(new FileInputStream(keystoreFile), password);
-
-    KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509");
-    kmf.init(ks, password);
-
-    TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509");
-    tmf.init(ts);
+    KeyManagerFactory kmf = keyManagerFactoryMap.get(keystoreFile);
+    TrustManagerFactory tmf = trustManagerFactoryMap.get(keystoreFile);
+    if(kmf == null || tmf == null) {
+      throw new KeyStoreException("Could not find KeyManagerFactory/TrustManagerFactory for keystore: " + keystoreFile);
+    }
 
     SSLContext sslCtx = SSLContext.getInstance("TLS");
 

data/ext/puma_http11/puma_http11.c

@@ -434,7 +434,9 @@ VALUE HttpParser_body(VALUE self) {
   return http->body;
 }
 
+#ifdef HAVE_OPENSSL_BIO_H
 void Init_mini_ssl(VALUE mod);
+#endif
 
 void Init_puma_http11()
 {
@@ -463,5 +465,7 @@ void Init_puma_http11()
   rb_define_method(cHttpParser, "body", HttpParser_body, 0);
   init_common_fields();
 
+#ifdef HAVE_OPENSSL_BIO_H
   Init_mini_ssl(mPuma);
+#endif
 }

data/lib/puma.rb

@@ -10,6 +10,9 @@ require 'stringio'
 
 require 'thread'
 
+require_relative 'puma/puma_http11'
+require_relative 'puma/detect'
+
 module Puma
   autoload :Const, 'puma/const'
   autoload :Server, 'puma/server'
@@ -24,6 +27,7 @@ module Puma
     @get_stats.stats.to_json
   end
 
+  # @version 5.0.0
   def self.stats_hash
     @get_stats.stats
   end
@@ -33,4 +37,12 @@ module Puma
     return unless Thread.current.respond_to?(:name=)
     Thread.current.name = "puma #{name}"
   end
+
+  unless HAS_SSL
+    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
 end

data/lib/puma/binder.rb

@@ -5,10 +5,16 @@ require 'socket'
 
 require 'puma/const'
 require 'puma/util'
-require 'puma/minissl/context_builder'
 require 'puma/configuration'
 
 module Puma
+
+  if HAS_SSL
+    require 'puma/minissl'
+    require 'puma/minissl/context_builder'
+    require 'puma/accept_nonblock'
+  end
+
   class Binder
     include Puma::Const
 
@@ -44,7 +50,12 @@ module Puma
       @ios = []
     end
 
-    attr_reader :ios, :listeners, :unix_paths, :proto_env, :envs, :activated_sockets, :inherited_fds
+    attr_reader :ios
+
+    # @version 5.0.0
+    attr_reader :activated_sockets, :envs, :inherited_fds, :listeners, :proto_env, :unix_paths
+
+    # @version 5.0.0
     attr_writer :ios, :listeners
 
     def env(sock)
@@ -55,10 +66,12 @@ module Puma
       @ios.each { |i| i.close }
     end
 
+    # @version 5.0.0
     def connected_ports
       ios.map { |io| io.addr[1] }.uniq
     end
 
+    # @version 5.0.0
     def create_inherited_fds(env_hash)
       env_hash.select {|k,v| k =~ /PUMA_INHERIT_\d+/}.each do |_k, v|
         fd, url = v.split(":", 2)
@@ -69,7 +82,9 @@ module Puma
     # systemd socket activation.
     # LISTEN_FDS = number of listening sockets. e.g. 2 means accept on 2 sockets w/descriptors 3 and 4.
     # LISTEN_PID = PID of the service process, aka us
-    # see https://www.freedesktop.org/software/systemd/man/systemd-socket-activate.html
+    # @see https://www.freedesktop.org/software/systemd/man/systemd-socket-activate.html
+    # @version 5.0.0
+    #
     def create_activated_fds(env_hash)
       return [] unless env_hash['LISTEN_FDS'] && env_hash['LISTEN_PID'].to_i == $$
       env_hash['LISTEN_FDS'].to_i.times do |index|
@@ -155,6 +170,9 @@ module Puma
 
           @listeners << [str, io]
         when "ssl"
+
+          raise "Puma compiled without SSL support" unless HAS_SSL
+
           params = Util.parse_query uri.query
           ctx = MiniSSL::ContextBuilder.new(params, @events).context
 
@@ -245,9 +263,8 @@ module Puma
 
     def add_ssl_listener(host, port, ctx,
                          optimize_for_latency=true, backlog=1024)
-      require 'puma/minissl'
 
-      MiniSSL.check
+      raise "Puma compiled without SSL support" unless HAS_SSL
 
       if host == "localhost"
         loopback_addresses.each do |addr|
@@ -264,7 +281,6 @@ module Puma
       s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
       s.listen backlog
 
-
       ssl = MiniSSL::Server.new s, ctx
       env = @proto_env.dup
       env[HTTPS_KEY] = HTTPS
@@ -275,8 +291,7 @@ module Puma
     end
 
     def inherit_ssl_listener(fd, ctx)
-      require 'puma/minissl'
-      MiniSSL.check
+      raise "Puma compiled without SSL support" unless HAS_SSL
 
       if fd.kind_of? TCPServer
         s = fd
@@ -367,6 +382,7 @@ module Puma
       redirects
     end
 
+    # @version 5.0.0
     def redirects_for_restart_env
       listeners.each_with_object({}).with_index do |(listen, memo), i|
         memo["PUMA_INHERIT_#{i}"] = "#{listen[1].to_i}:#{listen[0]}"
@@ -381,6 +397,7 @@ module Puma
       end.map { |addrinfo| addrinfo.ip_address }.uniq
     end
 
+    # @version 5.0.0
     def socket_activation_fd(int)
       int + 3 # 3 is the magic number you add to follow the SA protocol
     end

data/lib/puma/client.rb

@@ -280,6 +280,8 @@ module Puma
 
     # Returns true if the persistent connection can be closed immediately
     # without waiting for the configured idle/shutdown timeout.
+    # @version 5.0.0
+    #
     def can_close?
       # Allow connection to close if it's received at least one full request
       # and hasn't received any data for a future request.
@@ -443,6 +445,7 @@ module Puma
       end
     end
 
+    # @version 5.0.0
     def write_chunk(str)
       @chunked_content_length += @body.write(str)
     end

data/lib/puma/cluster.rb

@@ -77,6 +77,8 @@ module Puma
       end
 
       attr_reader :index, :pid, :phase, :signal, :last_checkin, :last_status, :started_at
+
+      # @version 5.0.0
       attr_writer :pid, :phase
 
       def booted?
@@ -98,6 +100,8 @@ module Puma
         @last_status = JSON.parse(status, symbolize_names: true)
       end
 
+      # @see Puma::Cluster#check_workers
+      # @version 5.0.0
       def ping_timeout
         @last_checkin +
           (booted? ?
@@ -160,6 +164,7 @@ module Puma
       end
     end
 
+    # @version 5.0.0
     def spawn_worker(idx, master)
       @launcher.config.run_hooks :before_worker_fork, idx, @launcher.events
 
@@ -419,6 +424,7 @@ module Puma
       @options[:preload_app]
     end
 
+    # @version 5.0.0
     def fork_worker!
       if (worker = @workers.find { |w| w.index == 0 })
         worker.phase += 1
@@ -640,6 +646,7 @@ module Puma
       end
     end
 
+    # @version 5.0.0
     def timeout_workers
       @workers.each do |w|
         if !w.term? && w.ping_timeout <= Time.now
@@ -649,6 +656,7 @@ module Puma
       end
     end
 
+    # @version 5.0.0
     def nakayoshi_gc
       return unless @options[:nakayoshi_fork]
       log "! Promoting existing objects to old generation..."

data/lib/puma/configuration.rb

@@ -173,6 +173,7 @@ module Puma
       self
     end
 
+    # @version 5.0.0
     def default_max_threads
       Puma.mri? ? 5 : 16
     end

data/lib/puma/const.rb

@@ -100,8 +100,9 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "5.0.0.beta2".freeze
+    PUMA_VERSION = VERSION = "5.0.0".freeze
     CODE_NAME = "Spoony Bard".freeze
+
     PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2

data/lib/puma/control_cli.rb

@@ -12,6 +12,8 @@ module Puma
   class ControlCLI
 
     COMMANDS = %w{halt restart phased-restart start stats status stop reload-worker-directory gc gc-stats thread-backtraces refork}
+
+    # @version 5.0.0
     PRINTABLE_COMMANDS = %w{gc-stats stats thread-backtraces}
 
     def initialize(argv, stdout=STDOUT, stderr=STDERR)

data/lib/puma/detect.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 module Puma
+  # at present, MiniSSL::Engine is only defined in extension code, not in minissl.rb
+  HAS_SSL = const_defined?(:MiniSSL, false) && MiniSSL.const_defined?(:Engine, false)
+
+  def self.ssl?
+    HAS_SSL
+  end
+
   IS_JRUBY = defined?(JRUBY_VERSION)
 
   def self.jruby?
@@ -13,10 +20,12 @@ module Puma
     IS_WINDOWS
   end
 
+  # @version 5.0.0
   def self.mri?
     RUBY_ENGINE == 'ruby' || RUBY_ENGINE.nil?
   end
 
+  # @version 5.0.0
   def self.forkable?
     ::Process.respond_to?(:fork)
   end

data/lib/puma/dsl.rb

@@ -14,22 +14,23 @@ module Puma
   #   end
   #   config.load
   #
-  #   puts config.options[:binds]
-  #   "tcp://127.0.0.1:3001"
+  #   puts config.options[:binds] # => "tcp://127.0.0.1:3001"
   #
   # Used to load file:
   #
   #   $ cat puma_config.rb
-  #     port 3002
+  #   port 3002
+  #
+  # Resulting configuration:
   #
   #   config = Configuration.new(config_file: "puma_config.rb")
   #   config.load
   #
-  #   puts config.options[:binds]
-  #   # => "tcp://127.0.0.1:3002"
+  #   puts config.options[:binds] # => "tcp://127.0.0.1:3002"
   #
   # You can also find many examples being used by the test suite in
   # +test/config+.
+  #
   class DSL
     include ConfigDefault
 
@@ -98,6 +99,9 @@ module Puma
     #       [body]
     #     ]
     #   end
+    #
+    # @see Puma::Configuration#app
+    #
     def app(obj=nil, &block)
       obj ||= block
 
@@ -160,12 +164,12 @@ module Puma
     #
     # You can use query parameters within the url to specify options:
     #
-    #  - Set the socket backlog depth with +backlog+, default is 1024.
-    #  - Set up an SSL certificate with +key+ & +cert+.
-    #  - Set whether to optimize for low latency instead of throughput with
-    #    +low_latency+, default is to optimize for low latency. This is done
-    #    via +Socket::TCP_NODELAY+.
-    #  - Set socket permissions with +umask+.
+    # * Set the socket backlog depth with +backlog+, default is 1024.
+    # * Set up an SSL certificate with +key+ & +cert+.
+    # * Set whether to optimize for low latency instead of throughput with
+    #   +low_latency+, default is to optimize for low latency. This is done
+    #   via +Socket::TCP_NODELAY+.
+    # * Set socket permissions with +umask+.
     #
     # @example Backlog depth
     #   bind 'unix:///var/run/puma.sock?backlog=512'
@@ -175,6 +179,9 @@ module Puma
     #   bind 'tcp://0.0.0.0:9292?low_latency=false'
     # @example Socket permissions
     #   bind 'unix:///var/run/puma.sock?umask=0111'
+    # @see Puma::Runner#load_and_bind
+    # @see Puma::Cluster#run
+    #
     def bind(url)
       @options[:binds] ||= []
       @options[:binds] << url
@@ -193,13 +200,14 @@ module Puma
       bind "tcp://#{host}:#{port}"
     end
 
-    # Define how long persistent connections can be idle before Puma closes
-    # them.
+    # Define how long persistent connections can be idle before Puma closes them.
+    # @see Puma::Server.new
     def persistent_timeout(seconds)
       @options[:persistent_timeout] = Integer(seconds)
     end
 
     # Define how long the tcp socket stays open, if no data has been received.
+    # @see Puma::Server.new
     def first_data_timeout(seconds)
       @options[:first_data_timeout] = Integer(seconds)
     end
@@ -210,10 +218,11 @@ module Puma
       @options[:clean_thread_locals] = which
     end
 
-    # When shutting down, drain the accept socket of pending
-    # connections and process them. This loops over the accept
-    # socket until there are no more read events and then stops
-    # looking and waits for the requests to finish.
+    # When shutting down, drain the accept socket of pending connections and
+    # process them. This loops over the accept socket until there are no more
+    # read events and then stops looking and waits for the requests to finish.
+    # @see Puma::Server#graceful_shutdown
+    #
     def drain_on_shutdown(which=true)
       @options[:drain_on_shutdown] = which
     end
@@ -236,6 +245,7 @@ module Puma
     #
     # Puma always waits a few seconds after killing a thread for it to try
     # to finish up it's work, even in :immediately mode.
+    # @see Puma::Server#graceful_shutdown
     def force_shutdown_after(val=:forever)
       i = case val
           when :forever
@@ -315,7 +325,7 @@ module Puma
       @options[:early_hints] = answer
     end
 
-    # Redirect STDOUT and STDERR to files specified. The +append+ parameter
+    # Redirect +STDOUT+ and +STDERR+ to files specified. The +append+ parameter
     # specifies whether the output is appended, the default is +false+.
     #
     # @example
@@ -356,8 +366,8 @@ module Puma
       @options[:max_threads] = max
     end
 
-    # Instead of "bind 'ssl://127.0.0.1:9292?key=key_path&cert=cert_path'" you
-    # can also use the "ssl_bind" option.
+    # Instead of `bind 'ssl://127.0.0.1:9292?key=key_path&cert=cert_path'` you
+    # can also use the this method.
     #
     # @example
     #   ssl_bind '127.0.0.1', '9292', {
@@ -403,6 +413,8 @@ module Puma
     #
     # @example
     #   state_permission 0600
+    # @version 5.0.0
+    #
     def state_permission(permission)
       @options[:state_permission] = permission
     end
@@ -413,6 +425,7 @@ module Puma
     # The default is 0.
     #
     # @note Cluster mode only.
+    # @see Puma::Cluster
     def workers(count)
       @options[:workers] = count.to_i
     end
@@ -516,7 +529,8 @@ module Puma
     #   on_refork do
     #     3.times {GC.start}
     #   end
-
+    # @version 5.0.0
+    #
     def on_refork(&block)
       @options[:before_refork] ||= []
       @options[:before_refork] << block
@@ -582,7 +596,7 @@ module Puma
     # new Bundler context and thus can float around as the release
     # dictates.
     #
-    # See also: extra_runtime_dependencies
+    # @see extra_runtime_dependencies
     #
     # @note This is incompatible with +preload_app!+.
     # @note This is only supported for RubyGems 2.2+
@@ -599,6 +613,9 @@ module Puma
     #
     # @example
     #   raise_exception_on_sigterm false
+    # @see Puma::Launcher#setup_signals
+    # @see Puma::Cluster#setup_signals
+    #
     def raise_exception_on_sigterm(answer=true)
       @options[:raise_exception_on_sigterm] = answer
     end
@@ -614,6 +631,8 @@ module Puma
     #   extra_runtime_dependencies ['gem_name_1', 'gem_name_2']
     # @example
     #   extra_runtime_dependencies ['puma_worker_killer', 'puma-heroku']
+    # @see Puma::Launcher#extra_runtime_deps_directories
+    #
     def extra_runtime_dependencies(answer = [])
       @options[:extra_runtime_dependencies] = Array(answer)
     end
@@ -641,6 +660,8 @@ module Puma
     # @note Cluster mode only.
     # @example
     #   worker_timeout 60
+    # @see Puma::Cluster::Worker#ping_timeout
+    #
     def worker_timeout(timeout)
       timeout = Integer(timeout)
       min = Const::WORKER_CHECK_INTERVAL
@@ -657,15 +678,20 @@ module Puma
     # If unspecified, this defaults to the value of worker_timeout.
     #
     # @note Cluster mode only.
-    # @example:
+    #
+    # @example
     #   worker_boot_timeout 60
+    # @see Puma::Cluster::Worker#ping_timeout
+    #
     def worker_boot_timeout(timeout)
       @options[:worker_boot_timeout] = Integer(timeout)
     end
 
-    # Set the timeout for worker shutdown
+    # Set the timeout for worker shutdown.
     #
     # @note Cluster mode only.
+    # @see Puma::Cluster::Worker#term
+    #
     def worker_shutdown_timeout(timeout)
       @options[:worker_shutdown_timeout] = Integer(timeout)
     end
@@ -683,6 +709,7 @@ module Puma
     # slow clients will occupy a handler thread while the request
     # is being sent. A reverse proxy, such as nginx, can handle
     # slow clients and queue requests before they reach Puma.
+    # @see Puma::Server
     def queue_requests(answer=true)
       @options[:queue_requests] = answer
     end
@@ -690,6 +717,7 @@ module Puma
     # When a shutdown is requested, the backtraces of all the
     # threads will be written to $stdout. This can help figure
     # out why shutdown is hanging.
+    #
     def shutdown_debug(val=true)
       @options[:shutdown_debug] = val
     end
@@ -700,6 +728,10 @@ module Puma
     # requests to pick up new requests first.
     #
     # Only works on MRI. For all other interpreters, this setting does nothing.
+    # @see Puma::Server#handle_servers
+    # @see Puma::ThreadPool#wait_for_less_busy_worker
+    # @version 5.0.0
+    #
     def wait_for_less_busy_worker(val=0.005)
       @options[:wait_for_less_busy_worker] = val.to_f
     end
@@ -711,18 +743,18 @@ module Puma
     #
     # There are 4 possible values:
     #
-    # * :socket (the default) - read the peername from the socket using the
-    #           syscall. This is the normal behavior.
-    # * :localhost - set the remote address to "127.0.0.1"
-    # * header: http_header - set the remote address to the value of the
-    #                          provided http header. For instance:
-    #                          `set_remote_address header: "X-Real-IP"`.
-    #                          Only the first word (as separated by spaces or comma)
-    #                          is used, allowing headers such as X-Forwarded-For
-    #                          to be used as well.
-    # * Any string - this allows you to hardcode remote address to any value
-    #                you wish. Because Puma never uses this field anyway, it's
-    #                format is entirely in your hands.
+    # 1. **:socket** (the default) - read the peername from the socket using the
+    #    syscall. This is the normal behavior.
+    # 2. **:localhost** - set the remote address to "127.0.0.1"
+    # 3. **header: <http_header>**- set the remote address to the value of the
+    #    provided http header. For instance:
+    #    `set_remote_address header: "X-Real-IP"`.
+    #    Only the first word (as separated by spaces or comma) is used, allowing
+    #    headers such as X-Forwarded-For to be used as well.
+    # 4. **\<Any string\>** - this allows you to hardcode remote address to any value
+    #    you wish. Because Puma never uses this field anyway, it's format is
+    #    entirely in your hands.
+    #
     def set_remote_address(val=:socket)
       case val
       when :socket
@@ -756,6 +788,8 @@ module Puma
     # (default 1000), or pass 0 to disable auto refork.
     #
     # @note Cluster mode only.
+    # @version 5.0.0
+    #
     def fork_worker(after_requests=1000)
       @options[:fork_worker] = Integer(after_requests)
     end
@@ -769,6 +803,10 @@ module Puma
     # also increase time to boot and fork. See your logs for details on how much
     # time this adds to your boot process. For most apps, it will be less than one
     # second.
+    #
+    # @see Puma::Cluster#nakayoshi_gc
+    # @version 5.0.0
+    #
     def nakayoshi_fork(enabled=true)
       @options[:nakayoshi_fork] = enabled
     end

data/lib/puma/error_logger.rb

@@ -4,6 +4,7 @@ require 'puma/const'
 
 module Puma
   # The implementation of a detailed error logging.
+  # @version 5.0.0
   #
   class ErrorLogger
     include Const

data/lib/puma/events.rb

@@ -91,6 +91,7 @@ module Puma
     # An HTTP connection error has occurred.
     # +error+ a connection exception, +req+ the request,
     # and +text+ additional info
+    # @version 5.0.0
     #
     def connection_error(error, req, text="HTTP connection error")
       @error_logger.info(error: error, req: req, text: text)
@@ -124,6 +125,7 @@ module Puma
     # Log occurred error debug dump.
     # +error+ an exception object, +req+ the request,
     # and +text+ additional info
+    # @version 5.0.0
     #
     def debug_error(error, req=nil, text="")
       @error_logger.debug(error: error, req: req, text: text)

data/lib/puma/launcher.rb

@@ -188,6 +188,7 @@ module Puma
     end
 
     # Return all tcp ports the launcher may be using, TCP or SSL
+    # @version 5.0.0
     def connected_ports
       @binder.connected_ports
     end
@@ -206,6 +207,7 @@ module Puma
       @binder.close_listeners
     end
 
+    # @version 5.0.0
     def thread_status
       Thread.list.each do |thread|
         name = "Thread: TID-#{thread.object_id.to_s(36)}"
@@ -478,6 +480,7 @@ module Puma
               "You must have RubyGems #{min_version}+ to use this feature."
     end
 
+    # @version 5.0.0
     def with_unbundled_env
       bundler_ver = Gem::Version.new(Bundler::VERSION)
       if bundler_ver < Gem::Version.new('2.1.0')

data/lib/puma/minissl.rb

@@ -10,9 +10,9 @@ require 'puma/puma_http11'
 
 module Puma
   module MiniSSL
-
-    # define constant at runtime, as it's easy to determine at built time,
+    # Define constant at runtime, as it's easy to determine at built time,
     # but Puma could (it shouldn't) be loaded with an older OpenSSL version
+    # @version 5.0.0
     HAS_TLS1_3 = !IS_JRUBY &&
       (OPENSSL_VERSION[/ \d+\.\d+\.\d+/].split('.').map(&:to_i) <=> [1,1,1]) != -1 &&
       (OPENSSL_LIBRARY_VERSION[/ \d+\.\d+\.\d+/].split('.').map(&:to_i) <=> [1,1,1]) !=-1
@@ -32,19 +32,21 @@ module Puma
         @socket.closed?
       end
 
-      # returns a two element array
-      # first is protocol version (SSL_get_version)
+      # Returns a two element array,
+      # first is protocol version (SSL_get_version),
       # second is 'handshake' state (SSL_state_string)
       #
-      # used for dropping tcp connections to ssl
-      # see OpenSSL ssl/ssl_stat.c SSL_state_string for info
+      # Used for dropping tcp connections to ssl.
+      # See OpenSSL ssl/ssl_stat.c SSL_state_string for info
+      # @version 5.0.0
       #
       def ssl_version_state
         IS_JRUBY ? [nil, nil] : @engine.ssl_vers_st
       end
 
-      # used to check the handshake status, in particular when a TCP connection
+      # Used to check the handshake status, in particular when a TCP connection
       # is made with TLSv1.3 as an available protocol
+      # @version 5.0.0
       def bad_tlsv1_3?
         HAS_TLS1_3 && @engine.ssl_vers_st == ['TLSv1.3', 'SSLERR']
       end
@@ -136,14 +138,18 @@ module Puma
       alias_method :<<, :write
 
       # This is a temporary fix to deal with websockets code using
-      # write_nonblock. The problem with implementing it properly
+      # write_nonblock.
+
+      # The problem with implementing it properly
       # is that it means we'd have to have the ability to rewind
       # an engine because after we write+extract, the socket
       # write_nonblock call might raise an exception and later
       # code would pass the same data in, but the engine would think
-      # it had already written the data in. So for the time being
-      # (and since write blocking is quite rare), go ahead and actually
-      # block in write_nonblock.
+      # it had already written the data in.
+      #
+      # So for the time being (and since write blocking is quite rare),
+      # go ahead and actually block in write_nonblock.
+      #
       def write_nonblock(data, *_)
         write data
       end
@@ -203,8 +209,6 @@ module Puma
       class SSLError < StandardError
         # Define this for jruby even though it isn't used.
       end
-
-      def self.check; end
     end
 
     class Context
@@ -261,13 +265,13 @@ module Puma
 
       # disables TLSv1
       def no_tlsv1=(tlsv1)
-        raise ArgumentError, "Invalid value of no_tlsv1" unless ['true', 'false', true, false].include?(tlsv1)
+        raise ArgumentError, "Invalid value of no_tlsv1=" unless ['true', 'false', true, false].include?(tlsv1)
         @no_tlsv1 = tlsv1
       end
 
       # disables TLSv1 and TLSv1.1.  Overrides `#no_tlsv1=`
       def no_tlsv1_1=(tlsv1_1)
-        raise ArgumentError, "Invalid value of no_tlsv1" unless ['true', 'false', true, false].include?(tlsv1_1)
+        raise ArgumentError, "Invalid value of no_tlsv1_1=" unless ['true', 'false', true, false].include?(tlsv1_1)
         @no_tlsv1_1 = tlsv1_1
       end
 
@@ -303,6 +307,7 @@ module Puma
         Socket.new io, engine
       end
 
+      # @version 5.0.0
       def addr
         @socket.addr
       end

data/lib/puma/minissl/context_builder.rb

@@ -2,9 +2,6 @@ module Puma
   module MiniSSL
     class ContextBuilder
       def initialize(params, events)
-        require 'puma/minissl'
-        MiniSSL.check
-
         @params = params
         @events = events
       end

data/lib/puma/reactor.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'puma/util'
-require 'puma/minissl'
+require 'puma/minissl' if ::Puma::HAS_SSL
 
 require 'nio'
 

data/lib/puma/runner.rb

@@ -2,7 +2,6 @@
 
 require 'puma/server'
 require 'puma/const'
-require 'puma/minissl/context_builder'
 
 module Puma
   # Generic class that is used by `Puma::Cluster` and `Puma::Single` to
@@ -30,6 +29,7 @@ module Puma
       @events.log str
     end
 
+    # @version 5.0.0
     def stop_control
       @control.stop(true) if @control
     end
@@ -64,6 +64,7 @@ module Puma
       @control = control
     end
 
+    # @version 5.0.0
     def close_control_listeners
       @control.binder.close_listeners if @control
     end

data/lib/puma/server.rb

@@ -9,12 +9,9 @@ require 'puma/null_io'
 require 'puma/reactor'
 require 'puma/client'
 require 'puma/binder'
-require 'puma/accept_nonblock'
 require 'puma/util'
 require 'puma/io_buffer'
 
-require 'puma/puma_http11'
-
 require 'socket'
 require 'forwardable'
 
@@ -37,7 +34,7 @@ module Puma
 
     attr_reader :thread
     attr_reader :events
-    attr_reader :requests_count
+    attr_reader :requests_count # @version 5.0.0
     attr_accessor :app
 
     attr_accessor :min_threads
@@ -100,11 +97,11 @@ module Puma
 
     class << self
       # :nodoc:
+      # @version 5.0.0
       def tcp_cork_supported?
         RbConfig::CONFIG['host_os'] =~ /linux/ &&
           Socket.const_defined?(:IPPROTO_TCP) &&
           Socket.const_defined?(:TCP_CORK) &&
-          Socket.const_defined?(:SOL_TCP) &&
           Socket.const_defined?(:TCP_INFO)
       end
       private :tcp_cork_supported?
@@ -140,7 +137,7 @@ module Puma
         return false unless @precheck_closing
 
         begin
-          tcp_info = socket.getsockopt(Socket::SOL_TCP, Socket::TCP_INFO)
+          tcp_info = socket.getsockopt(Socket::IPPROTO_TCP, Socket::TCP_INFO)
         rescue IOError, SystemCallError
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
           @precheck_closing = false
@@ -998,9 +995,11 @@ module Puma
     private :possible_header_injection?
 
     # List of methods invoked by #stats.
+    # @version 5.0.0
     STAT_METHODS = [:backlog, :running, :pool_capacity, :max_threads, :requests_count].freeze
 
     # Returns a hash of stats about the running server for reporting purposes.
+    # @version 5.0.0
     def stats
       STAT_METHODS.map {|name| [name, send(name) || 0]}.to_h
     end

data/lib/puma/thread_pool.rb

@@ -66,7 +66,7 @@ module Puma
 
     attr_reader :spawned, :trim_requested, :waiting
     attr_accessor :clean_thread_locals
-    attr_accessor :out_of_band_hook
+    attr_accessor :out_of_band_hook # @version 5.0.0
 
     def self.clean_thread_locals
       Thread.current.keys.each do |key| # rubocop: disable Performance/HashEachMethods
@@ -84,6 +84,7 @@ module Puma
       waiting + (@max - spawned)
     end
 
+    # @version 5.0.0
     def busy_threads
       with_mutex { @spawned - @waiting + @todo.size }
     end
@@ -151,6 +152,7 @@ module Puma
 
     private :spawn_thread
 
+    # @version 5.0.0
     def trigger_out_of_band_hook
       return false unless out_of_band_hook && out_of_band_hook.any?
 
@@ -166,6 +168,7 @@ module Puma
 
     private :trigger_out_of_band_hook
 
+    # @version 5.0.0
     def with_mutex(&block)
       @mutex.owned? ?
         yield :
@@ -231,6 +234,7 @@ module Puma
       end
     end
 
+    # @version 5.0.0
     def wait_for_less_busy_worker(delay_s)
       # Ruby MRI does GVL, this can result
       # in processing contention when multiple threads

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta2
+  version: 5.0.0
 platform: java
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,7 @@ files:
 - ext/puma_http11/http11_parser.rl
 - ext/puma_http11/http11_parser_common.rl
 - 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
@@ -129,9 +130,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: