puma 3.7.1 → 4.1.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
-      r = @server.running
-      %Q!{ "backlog": #{b}, "running": #{r} }!
+      b = @server.backlog || 0
+      r = @server.running || 0
+      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?

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,11 +60,11 @@ 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
-      Thread.current.keys.each do |key|
+      Thread.current.keys.each do |key| # rubocop: disable Performance/HashEachMethods
         Thread.current[key] = nil unless key == :__recursive_key__
       end
     end
@@ -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!
@@ -71,9 +86,9 @@ module Puma
     def spawn_thread
       @spawned += 1
 
-      th = Thread.new do
+      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=)
+        Thread.current.name = 'puma %03i' % spawned if Thread.current.respond_to?(:name=)
         todo  = @todo
         block = @block
         mutex = @mutex
@@ -153,9 +168,47 @@ 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
-        until @todo.size - @waiting < @max - @spawned or @shutdown
+        while true
+          return if @shutdown
+
+          # If we can still spin up new threads and there
+          # is work queued that cannot be handled by waiting
+          # threads, then accept more work until we would
+          # spin up the max number of threads.
+          busy_threads = @spawned - @waiting + @todo.size
+          return busy_threads if @max > busy_threads
+
           @not_full.wait @mutex
         end
       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/rack/handler/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/handler'
 
 module Rack
@@ -8,46 +10,61 @@ module Rack
         :Silent  => false
       }
 
-      def self.run(app, options = {})
+      def self.config(app, options = {})
+        require 'puma'
         require 'puma/configuration'
         require 'puma/events'
         require 'puma/launcher'
 
-        options = DEFAULT_OPTIONS.merge(options)
+        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) do |c|
-          c.quiet
+        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
 
           if options[:environment]
-            c.environment options[:environment]
+            user_config.environment options[:environment]
           end
 
           if options[:Threads]
             min, max = options.delete(:Threads).split(':', 2)
-            c.threads min, max
+            user_config.threads min, max
           end
 
-          host = options[:Host]
-
-          if host && (host[0,1] == '.' || host[0,1] == '/')
-            c.bind "unix://#{host}"
-          elsif host && host =~ /^ssl:\/\//
-            uri = URI.parse(host)
-            uri.port ||= options[:Port] || ::Puma::Configuration::DefaultTCPPort
-            c.bind uri.to_s
-          else
-            host ||= ::Puma::Configuration::DefaultTCPHost
-            port = options[:Port] || ::Puma::Configuration::DefaultTCPPort
+          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
 
-            c.port port, host
+          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)
 
-          c.app app
+          user_config.app app
         end
+        conf
+      end
+
+
+
+      def self.run(app, options = {})
+        conf   = self.config(app, options)
 
         events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio
 
@@ -71,6 +88,28 @@ module Rack
           "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
+
+        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
+            port ||= ::Puma::Configuration::DefaultTCPPort
+          end
+
+          if port
+            host ||= ::Puma::Configuration::DefaultTCPHost
+            config.port port, host
+          end
+        end
+      end
     end
 
     register :puma, Puma

data/tools/jungle/README.md

@@ -1,9 +1,19 @@
 # Puma as a service
 
+## Upstart
+
+See `/tools/jungle/upstart` for Ubuntu's upstart scripts.
+
+## Systemd
+
+See [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md).
+
 ## Init.d
 
+Deprecatation Warning : `init.d` was replaced by `systemd` since Debian 8 and Ubuntu 16.04, you should look into [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md) unless you are on an older OS.
+
 See `/tools/jungle/init.d` for tools to use with init.d and start-stop-daemon.
 
-## Upstart
+## rc.d
 
-See `/tools/jungle/upstart` for Ubuntu's upstart scripts.
+See `/tools/jungle/rc.d` for FreeBSD's rc.d scripts

data/tools/jungle/init.d/README.md

@@ -1,5 +1,7 @@
 # Puma daemon service
 
+Deprecatation Warning : `init.d` was replaced by `systemd` since Debian 8 and Ubuntu 16.04, you should look into [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md) unless you are on an older OS. 
+
 Init script to manage multiple Puma servers on the same box using start-stop-daemon.
 
 ## Installation 

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 [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
-      do_start_one_do $1
-    else
+    # If the puma is running, restart it, otherwise run it.
+    if ps -p $PID > /dev/null; then
       do_restart_one $1
+    else
+      do_start_one_do $1
     fi
   else
     do_start_one_do $1
@@ -105,9 +105,7 @@ do_stop_one() {
   STATEFILE=$1/tmp/puma/state
   if [ -e $PIDFILE ]; then
     PID=`cat $PIDFILE`
-    if [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
-      log_daemon_msg "---> Puma $1 isn't running."
-    else
+    if ps -p $PID > /dev/null; then
       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/jungle/init.d/run-puma

@@ -15,4 +15,4 @@ elif [ -f "$HOME/.rvm/scripts/rvm" ]; then
 fi
 
 app=$1; config=$2; log=$3;
-cd $app && exec bundle exec puma -C $config 2>&1 >> $log
+cd $app && exec bundle exec puma -C $config >> $log 2>&1

data/tools/jungle/rc.d/README.md

@@ -0,0 +1,74 @@
+# Puma as a service using rc.d
+
+Manage multilpe Puma servers as services on one box using FreeBSD's rc.d service.
+
+## Dependencies
+
+* `jq` - a command-line json parser is needed to parse the json in the config file
+
+## Installation
+
+    # Copy the puma script to the rc.d directory (make sure everyone has read/execute perms)
+    sudo cp puma /usr/local/etc/rc.d/
+
+    # Create an empty configuration file
+    sudo touch /usr/local/etc/puma.conf
+
+    # Enable the puma service
+    sudo echo 'puma_enable="YES"' >> /etc/rc.conf
+
+## Managing the jungle
+
+Puma apps are referenced in /usr/local/etc/puma.conf by default.
+
+Start the jungle running:
+
+`service puma start`
+
+This script will run at boot time.
+
+
+You can also stop the jungle (stops ALL puma instances) by running:
+
+`service puma stop`
+
+
+To restart the jungle:
+
+`service puma restart`
+
+## Conventions
+
+* The script expects:
+  * a config file to exist under `config/puma.rb` in your app. E.g.: `/home/apps/my-app/config/puma.rb`.
+
+You can always change those defaults by editing the scripts.
+
+## Here's what a minimal app's config file should have
+
+```
+{
+	"servers" : [
+		{
+			"dir": "/path/to/rails/project",
+			"user": "deploy-user",
+			"ruby_version": "ruby.version",
+			"ruby_env": "rbenv"
+		}
+	]
+}
+```
+
+## Before starting...
+
+You need to customise `puma.conf` to:
+
+* Set the right user your app should be running on unless you want root to execute it!
+* Set the directory of the app
+* Set the ruby version to execute
+* Set the ruby environment (currently set to rbenv, since that is the only ruby environment currently supported)
+* Add additional server instances following the scheme in the example
+
+## Notes:
+
+Only rbenv is currently supported.