puma 3.11.4 → 4.2.0

data/lib/puma/single.rb

@@ -1,13 +1,24 @@
+# frozen_string_literal: true
+
 require 'puma/runner'
 require 'puma/detect'
 require 'puma/plugin'
 
 module Puma
+  # This class is instantiated by the `Puma::Launcher` and used
+  # to boot and serve a Ruby application when no puma "workers" are needed
+  # i.e. only using "threaded" mode. For example `$ puma -t 1:5`
+  #
+  # At the core of this class is running an instance of `Puma::Server` which
+  # gets created via the `start_server` method from the `Puma::Runner` class
+  # that this inherits from.
   class Single < Runner
     def stats
       b = @server.backlog || 0
       r = @server.running || 0
-      %Q!{ "backlog": #{b}, "running": #{r} }!
+      t = @server.pool_capacity || 0
+      m = @server.max_threads || 0
+      %Q!{ "started_at": "#{@started_at.utc.iso8601}", "backlog": #{b}, "running": #{r}, "pool_capacity": #{t}, "max_threads": #{m} }!
     end
 
     def restart
@@ -15,7 +26,7 @@ module Puma
     end
 
     def stop
-      @server.stop false
+      @server.stop(false) if @server
     end
 
     def halt
@@ -25,7 +36,7 @@ module Puma
     def stop_blocked
       log "- Gracefully stopping, waiting for requests to finish"
       @control.stop(true) if @control
-      @server.stop(true)
+      @server.stop(true) if @server
     end
 
     def jruby_daemon?
@@ -107,6 +118,7 @@ module Puma
       rescue Interrupt
         # Swallow it
       end
+      @launcher.close_binder_unix_paths
     end
   end
 end

data/lib/puma/state_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Puma

data/lib/puma/tcp_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puma
   class TCPLogger
     def initialize(logger, app, quiet=false)

data/lib/puma/thread_pool.rb

@@ -1,8 +1,19 @@
+# frozen_string_literal: true
+
 require 'thread'
 
 module Puma
-  # A simple thread pool management object.
+  # Internal Docs for A simple thread pool management object.
+  #
+  # Each Puma "worker" has a thread pool to process requests.
   #
+  # First a connection to a client is made in `Puma::Server`. It is wrapped in a
+  # `Puma::Client` instance and then passed to the `Puma::Reactor` to ensure
+  # the whole request is buffered into memory. Once the request is ready, it is passed into
+  # a thread pool via the `Puma::ThreadPool#<<` operator where it is stored in a `@todo` array.
+  #
+  # Each thread in the pool has an internal loop where it pulls a request from the `@todo` array
+  # and proceses it.
   class ThreadPool
     class ForceShutdown < RuntimeError
     end
@@ -49,7 +60,7 @@ module Puma
       @clean_thread_locals = false
     end
 
-    attr_reader :spawned, :trim_requested
+    attr_reader :spawned, :trim_requested, :waiting
     attr_accessor :clean_thread_locals
 
     def self.clean_thread_locals
@@ -64,6 +75,10 @@ module Puma
       @mutex.synchronize { @todo.size }
     end
 
+    def pool_capacity
+      waiting + (@max - spawned)
+    end
+
     # :nodoc:
     #
     # Must be called with @mutex held!
@@ -72,8 +87,7 @@ module Puma
       @spawned += 1
 
       th = Thread.new(@spawned) do |spawned|
-        # Thread name is new in Ruby 2.3
-        Thread.current.name = 'puma %03i' % spawned if Thread.current.respond_to?(:name=)
+        Puma.set_thread_name 'threadpool %03i' % spawned
         todo  = @todo
         block = @block
         mutex = @mutex
@@ -153,16 +167,46 @@ module Puma
       end
     end
 
+    # This method is used by `Puma::Server` to let the server know when
+    # the thread pool can pull more requests from the socket and
+    # pass to the reactor.
+    #
+    # The general idea is that the thread pool can only work on a fixed
+    # number of requests at the same time. If it is already processing that
+    # number of requests then it is at capacity. If another Puma process has
+    # spare capacity, then the request can be left on the socket so the other
+    # worker can pick it up and process it.
+    #
+    # For example: if there are 5 threads, but only 4 working on
+    # requests, this method will not wait and the `Puma::Server`
+    # can pull a request right away.
+    #
+    # If there are 5 threads and all 5 of them are busy, then it will
+    # pause here, and wait until the `not_full` condition variable is
+    # signaled, usually this indicates that a request has been processed.
+    #
+    # It's important to note that even though the server might accept another
+    # request, it might not be added to the `@todo` array right away.
+    # For example if a slow client has only sent a header, but not a body
+    # then the `@todo` array would stay the same size as the reactor works
+    # to try to buffer the request. In tha scenario the next call to this
+    # method would not block and another request would be added into the reactor
+    # by the server. This would continue until a fully bufferend request
+    # makes it through the reactor and can then be processed by the thread pool.
+    #
+    # Returns the current number of busy threads, or +nil+ if shutting down.
+    #
     def wait_until_not_full
       @mutex.synchronize do
         while true
           return if @shutdown
-          return if @waiting > 0
 
           # If we can still spin up new threads and there
-          # is work queued, then accept more work until we would
+          # is work queued that cannot be handled by waiting
+          # threads, then accept more work until we would
           # spin up the max number of threads.
-          return if @todo.size < @max - @spawned
+          busy_threads = @spawned - @waiting + @todo.size
+          return busy_threads if @max > busy_threads
 
           @not_full.wait @mutex
         end
@@ -199,10 +243,12 @@ module Puma
       end
     end
 
-    class AutoTrim
-      def initialize(pool, timeout)
+    class Automaton
+      def initialize(pool, timeout, thread_name, message)
         @pool = pool
         @timeout = timeout
+        @thread_name = thread_name
+        @message = message
         @running = false
       end
 
@@ -210,8 +256,9 @@ module Puma
         @running = true
 
         @thread = Thread.new do
+          Puma.set_thread_name @thread_name
           while @running
-            @pool.trim
+            @pool.public_send(@message)
             sleep @timeout
           end
         end
@@ -224,36 +271,12 @@ module Puma
     end
 
     def auto_trim!(timeout=30)
-      @auto_trim = AutoTrim.new(self, timeout)
+      @auto_trim = Automaton.new(self, timeout, "threadpool trimmer", :trim)
       @auto_trim.start!
     end
 
-    class Reaper
-      def initialize(pool, timeout)
-        @pool = pool
-        @timeout = timeout
-        @running = false
-      end
-
-      def start!
-        @running = true
-
-        @thread = Thread.new do
-          while @running
-            @pool.reap
-            sleep @timeout
-          end
-        end
-      end
-
-      def stop
-        @running = false
-        @thread.wakeup
-      end
-    end
-
     def auto_reap!(timeout=5)
-      @reaper = Reaper.new(self, timeout)
+      @reaper = Automaton.new(self, timeout, "threadpool reaper", :reap)
       @reaper.start!
     end
 

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

data/lib/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Standard libraries
 require 'socket'
 require 'tempfile'
@@ -20,4 +22,10 @@ module Puma
   def self.stats
     @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
@@ -49,6 +51,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,8 +61,6 @@ module Rack
         conf
       end
 
-
-
       def self.run(app, options = {})
         conf   = self.config(app, options)
 
@@ -83,7 +86,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/tools/docker/Dockerfile

@@ -0,0 +1,16 @@
+# Use this Dockerfile to create minimal reproductions of issues
+
+FROM ruby:2.6
+
+# 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/jungle/init.d/puma

@@ -47,11 +47,11 @@ do_start_one() {
   PIDFILE=$1/tmp/puma/pid
   if [ -e $PIDFILE ]; then
     PID=`cat $PIDFILE`
-    # If the puma isn't running, run it, otherwise restart it.
+    # If the puma is running, restart it, otherwise run it.
     if ps -p $PID > /dev/null; then
-      do_start_one_do $1
-    else
       do_restart_one $1
+    else
+      do_start_one_do $1
     fi
   else
     do_start_one_do $1
@@ -106,8 +106,6 @@ do_stop_one() {
   if [ -e $PIDFILE ]; then
     PID=`cat $PIDFILE`
     if ps -p $PID > /dev/null; then
-      log_daemon_msg "---> Puma $1 isn't running."
-    else
       log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
       if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
         cd $1 && bundle exec pumactl --state $STATEFILE stop
@@ -116,6 +114,8 @@ do_stop_one() {
       fi
       # Many daemons don't delete their pidfiles when they exit.
       rm -f $PIDFILE $STATEFILE
+    else
+      log_daemon_msg "---> Puma $1 isn't running."
     fi
   else
     log_daemon_msg "---> No puma here..."
@@ -398,7 +398,7 @@ case "$1" in
   ;;
   remove)
     if [ "$#" -lt 2 ]; then
-      echo "Please, specifiy the app's directory to remove."
+      echo "Please, specify the app's directory to remove."
       exit 1
     else
       do_remove $2

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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 3.11.4
+  version: 4.2.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
-dependencies: []
+date: 2019-09-23 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 concurrent 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
@@ -51,6 +65,7 @@ files:
 - ext/puma_http11/mini_ssl.c
 - 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
@@ -61,25 +76,21 @@ files:
 - lib/puma/client.rb
 - lib/puma/cluster.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/events.rb
 - lib/puma/io_buffer.rb
-- lib/puma/java_io_buffer.rb
 - lib/puma/jruby_restart.rb
 - lib/puma/launcher.rb
 - lib/puma/minissl.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/rack/builder.rb
 - lib/puma/rack/urlmap.rb
 - lib/puma/rack_default.rb
@@ -92,6 +103,7 @@ files:
 - 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
@@ -108,6 +120,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   msys2_mingw_dependencies: openssl
+  changelog_uri: https://github.com/puma/puma/blob/master/History.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -116,15 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for

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/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/java_io_buffer.rb

@@ -1,45 +0,0 @@
-require 'java'
-
-# Conservative native JRuby/Java implementation of IOBuffer
-# backed by a ByteArrayOutputStream and conversion between
-# Ruby String and Java bytes
-module Puma
-  class JavaIOBuffer < java.io.ByteArrayOutputStream
-    field_reader :buf
-  end
-
-  class IOBuffer
-    BUF_DEFAULT_SIZE = 4096
-
-    def initialize
-      @buf = JavaIOBuffer.new(BUF_DEFAULT_SIZE)
-    end
-
-    def reset
-      @buf.reset
-    end
-
-    def <<(str)
-      bytes = str.to_java_bytes
-      @buf.write(bytes, 0, bytes.length)
-    end
-
-    def append(*strs)
-      strs.each { |s| self << s; }
-    end
-
-    def to_s
-      String.from_java_bytes @buf.to_byte_array
-    end
-
-    alias_method :to_str, :to_s
-
-    def used
-      @buf.size
-    end
-
-    def capacity
-      @buf.buf.length
-    end
-  end
-end

data/lib/puma/rack/backports/uri/common_193.rb

@@ -1,33 +0,0 @@
-# :stopdoc:
-
-require 'uri/common'
-
-# Issue:
-# http://bugs.ruby-lang.org/issues/5925
-#
-# Relevant commit:
-# https://github.com/ruby/ruby/commit/edb7cdf1eabaff78dfa5ffedfbc2e91b29fa9ca1
-
-
-module URI
-  begin
-    256.times do |i|
-      TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
-    end
-    TBLENCWWWCOMP_[' '] = '+'
-    TBLENCWWWCOMP_.freeze
-
-    256.times do |i|
-      h, l = i>>4, i&15
-      TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
-      TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
-      TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
-      TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
-    end
-    TBLDECWWWCOMP_['+'] = ' '
-    TBLDECWWWCOMP_.freeze
-  rescue Exception
-  end
-end
-
-# :startdoc: