puma 5.0.0-java → 5.1.0-java

data/lib/puma/single.rb

@@ -13,6 +13,7 @@ module Puma
   # gets created via the `start_server` method from the `Puma::Runner` class
   # that this inherits from.
   class Single < Runner
+    # @!attribute [r] stats
     def stats
       {
         started_at: @started_at.utc.iso8601
@@ -49,7 +50,7 @@ module Puma
       start_control
 
       @server = server = start_server
-
+      server_thread = server.run
 
       log "Use Ctrl-C to stop"
       redirect_io
@@ -57,7 +58,7 @@ module Puma
       @launcher.events.fire_on_booted!
 
       begin
-        server.run.join
+        server_thread.join
       rescue Interrupt
         # Swallow it
       end

data/lib/puma/state_file.rb

@@ -9,9 +9,11 @@ module Puma
     end
 
     def save(path, permission = nil)
-      File.open(path, "w") do |file|
-        file.chmod(permission) if permission
-        file.write(YAML.dump(@options))
+      contents =YAML.dump @options
+      if permission
+        File.write path, contents, mode: 'wb:UTF-8'
+      else
+        File.write path, contents, mode: 'wb:UTF-8', perm: permission
       end
     end
 

data/lib/puma/systemd.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'sd_notify'
+
+module Puma
+  class Systemd
+    def initialize(events)
+      @events = events
+    end
+
+    def hook_events
+      @events.on_booted { SdNotify.ready }
+      @events.on_stopped { SdNotify.stopping }
+      @events.on_restart { SdNotify.reloading }
+    end
+
+    def start_watchdog
+      return unless SdNotify.watchdog?
+
+      ping_f = watchdog_sleep_time
+
+      log "Pinging systemd watchdog every #{ping_f.round(1)} sec"
+      Thread.new do
+        loop do
+          sleep ping_f
+          SdNotify.watchdog
+        end
+      end
+    end
+
+    private
+
+    def watchdog_sleep_time
+      usec = Integer(ENV["WATCHDOG_USEC"])
+
+      sec_f = usec / 1_000_000.0
+      # "It is recommended that a daemon sends a keep-alive notification message
+      # to the service manager every half of the time returned here."
+      sec_f / 2
+    end
+
+    def log(str)
+      @events.log str
+    end
+  end
+end

data/lib/puma/thread_pool.rb

@@ -62,6 +62,8 @@ module Puma
       end
 
       @clean_thread_locals = false
+      @force_shutdown = false
+      @shutdown_mutex = Mutex.new
     end
 
     attr_reader :spawned, :trim_requested, :waiting
@@ -80,10 +82,12 @@ module Puma
       with_mutex { @todo.size }
     end
 
+    # @!attribute [r] pool_capacity
     def pool_capacity
       waiting + (@max - spawned)
     end
 
+    # @!attribute [r] busy_threads
     # @version 5.0.0
     def busy_threads
       with_mutex { @spawned - @waiting + @todo.size }
@@ -322,6 +326,19 @@ module Puma
       @reaper.start!
     end
 
+    # Allows ThreadPool::ForceShutdown to be raised within the
+    # provided block if the thread is forced to shutdown during execution.
+    def with_force_shutdown
+      t = Thread.current
+      @shutdown_mutex.synchronize do
+        raise ForceShutdown if @force_shutdown
+        t[:with_force_shutdown] = true
+      end
+      yield
+    ensure
+      t[:with_force_shutdown] = false
+    end
+
     # Tell all threads in the pool to exit and wait for them to finish.
     # Wait +timeout+ seconds then raise +ForceShutdown+ in remaining threads.
     # Next, wait an extra +grace+ seconds then force-kill remaining threads.
@@ -356,8 +373,11 @@ module Puma
         join.call(timeout)
 
         # If threads are still running, raise ForceShutdown and wait to finish.
-        threads.each do |t|
-          t.raise ForceShutdown
+        @shutdown_mutex.synchronize do
+          @force_shutdown = true
+          threads.each do |t|
+            t.raise ForceShutdown if t[:with_force_shutdown]
+          end
         end
         join.call(SHUTDOWN_GRACE_TIME)
 

data/lib/puma/util.rb

@@ -23,6 +23,17 @@ module Puma
     end
     module_function :unescape
 
+    # @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
 
     # Stolen from Mongrel, with some small modifications:
@@ -72,6 +83,7 @@ module Puma
         end
       end
 
+      # @!attribute [r] to_hash
       def to_hash
         hash = {}
         each { |k,v| hash[k] = v }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: java
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +43,7 @@ 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
@@ -52,9 +53,6 @@ files:
 - docs/jungle/rc.d/README.md
 - docs/jungle/rc.d/puma
 - docs/jungle/rc.d/puma.conf
-- docs/jungle/upstart/README.md
-- docs/jungle/upstart/puma-manager.conf
-- docs/jungle/upstart/puma.conf
 - docs/nginx.md
 - docs/plugins.md
 - docs/restart.md
@@ -75,12 +73,13 @@ files:
 - 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
@@ -91,6 +90,7 @@ files:
 - lib/puma/events.rb
 - lib/puma/io_buffer.rb
 - lib/puma/jruby_restart.rb
+- lib/puma/json.rb
 - lib/puma/launcher.rb
 - lib/puma/minissl.rb
 - lib/puma/minissl/context_builder.rb
@@ -98,14 +98,17 @@ files:
 - lib/puma/plugin.rb
 - lib/puma/plugin/tmp_restart.rb
 - lib/puma/puma_http11.jar
+- 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/systemd.rb
 - lib/puma/thread_pool.rb
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb

data/docs/jungle/upstart/README.md

@@ -1,61 +0,0 @@
-# Puma as a service using Upstart
-
-Manage multiple Puma servers as services on the same box using Ubuntu upstart.
-
-## Installation 
-
-    # Copy the scripts to services directory 
-    sudo cp puma.conf puma-manager.conf /etc/init
-    
-    # Create an empty configuration file
-    sudo touch /etc/puma.conf
-
-## Managing the jungle 
-
-Puma apps are referenced in /etc/puma.conf by default. Add each app's path as a new line, e.g.:
-
-```
-/home/apps/my-cool-ruby-app
-/home/apps/another-app/current
-```
-
-Start the jungle running:
-
-`sudo start puma-manager`
-
-This script will run at boot time.
-
-Start a single puma like this:
-
-`sudo start puma app=/path/to/app`
-
-## Logs
-
-Everything is logged by upstart, defaulting to `/var/log/upstart`.
-
-Each puma instance is named after its directory, so for an app called `/home/apps/my-app` the log file would be `/var/log/upstart/puma-_home_apps_my-app.log`.
-
-## 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`.
-  * a temporary folder to put the PID, socket and state files to exist called `tmp/puma`. E.g.: `/home/apps/my-app/tmp/puma`. Puma will take care of the files for you.
-
-You can always change those defaults by editing the scripts.
-
-## Here's what a minimal app's config file should have
-
-```
-pidfile "/path/to/app/tmp/puma/pid"
-state_path "/path/to/app/tmp/puma/state"
-activate_control_app
-```
-
-## 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!
-  * Look for `setuid apps` and `setgid apps`, uncomment those lines and replace `apps` to whatever your deployment user is.
-  * Replace `apps` on the paths (or set the right paths to your user's home) everywhere else.
-* Uncomment the source lines for `rbenv` or `rvm` support unless you use a system wide installation of Ruby.

data/docs/jungle/upstart/puma-manager.conf

@@ -1,31 +0,0 @@
-# /etc/init/puma-manager.conf - manage a set of Pumas
-
-# This example config should work with Ubuntu 12.04+.  It
-# allows you to manage multiple Puma instances with
-# Upstart, Ubuntu's native service management tool.
-#
-# See puma.conf for how to manage a single Puma instance.
-#
-# Use "stop puma-manager" to stop all Puma instances.
-# Use "start puma-manager" to start all instances.
-# Use "restart puma-manager" to restart all instances.
-# Crazy, right?
-#
-
-description "Manages the set of puma processes"
-
-# This starts upon bootup and stops on shutdown
-start on runlevel [2345]
-stop on runlevel [06]
-
-# Set this to the number of Puma processes you want
-# to run on this machine
-env PUMA_CONF="/etc/puma.conf"
-
-pre-start script
-  for i in `cat $PUMA_CONF`; do
-    app=`echo $i | cut -d , -f 1`
-    logger -t "puma-manager" "Starting $app"
-    start puma app=$app
-  done
-end script

data/docs/jungle/upstart/puma.conf

@@ -1,69 +0,0 @@
-# /etc/init/puma.conf - Puma config
-
-# This example config should work with Ubuntu 12.04+.  It
-# allows you to manage multiple Puma instances with
-# Upstart, Ubuntu's native service management tool.
-#
-# See puma-manager.conf for how to manage all Puma instances at once.
-#
-# Save this config as /etc/init/puma.conf then manage puma with:
-#   sudo start puma app=PATH_TO_APP
-#   sudo stop puma app=PATH_TO_APP
-#   sudo status puma app=PATH_TO_APP
-#
-# or use the service command:
-#   sudo service puma {start,stop,restart,status}
-#
-
-description "Puma Background Worker"
-
-# no "start on", we don't want to automatically start
-stop on (stopping puma-manager or runlevel [06])
-
-# change apps to match your deployment user if you want to use this as a less privileged user (recommended!)
-setuid apps
-setgid apps
-
-respawn
-respawn limit 3 30
-
-instance ${app}
-
-script
-# this script runs in /bin/sh by default
-# respawn as bash so we can source in rbenv/rvm
-# quoted heredoc to tell /bin/sh not to interpret
-# variables
-
-# source ENV variables manually as Upstart doesn't, eg:
-#. /etc/environment
-
-exec /bin/bash <<'EOT'
-  # set HOME to the setuid user's home, there doesn't seem to be a better, portable way
-  export HOME="$(eval echo ~$(id -un))"
-
-  if [ -d "/usr/local/rbenv/bin" ]; then
-    export PATH="/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH"
-  elif [ -d "$HOME/.rbenv/bin" ]; then
-    export PATH="$HOME/.rbenv/bin:$HOME/.rbenv/shims:$PATH"
-  elif [ -f  /etc/profile.d/rvm.sh ]; then
-    source /etc/profile.d/rvm.sh
-  elif [ -f /usr/local/rvm/scripts/rvm ]; then
-    source /etc/profile.d/rvm.sh
-  elif [ -f "$HOME/.rvm/scripts/rvm" ]; then
-    source "$HOME/.rvm/scripts/rvm"
-  elif [ -f /usr/local/share/chruby/chruby.sh ]; then
-    source /usr/local/share/chruby/chruby.sh
-    if [ -f /usr/local/share/chruby/auto.sh ]; then
-      source /usr/local/share/chruby/auto.sh
-    fi
-    # if you aren't using auto, set your version here
-    # chruby 2.0.0
-  fi
-
-  cd $app
-  logger -t puma "Starting server: $app"
-
-  exec bundle exec puma -C config/puma.rb
-EOT
-end script

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