puma 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae407cb3f846ef2c3da83f997e42b4b0da3e6b9e
-  data.tar.gz: 2e74ecbc15ed0a1363ad70d71605c69004b184ee
+  metadata.gz: 7069953b7e057c1aa73536b3aefccae709151c92
+  data.tar.gz: 50635cce883fd9a576b9db23a29c7a6a2d3a3526
 SHA512:
-  metadata.gz: b66e244414a78a68ab0e841f10f531797098a19d054757b9e0d7cb2bceebe1e850a2e50aa73d9b096379a99e73b8a9d242afb5c477ecd2de2dddf7950d630404
-  data.tar.gz: 52c7ac2681b0a73e58e2e1a2cf13d2e448248703dbcd630823c221423a4ae1564a71f28e10a4896ce9be2ab3e1c64a0ee2e0fab735c93bd9619e33dc08ef7f3d
+  metadata.gz: 347ecd7db9802483c8c8caf9dfd75acad3bd5d86b32fb47371a377764d685d9bfe2a36ae060643935b19007f5ba93b4cfbe0d531c3536de65dd7d2bfa72973ed
+  data.tar.gz: 8d33efdeeb7b842d79c4cb35228757910bdebca22928d282fb97c56d128ff5567bf7caefda0692ceca0e1669096918aa5993c11efc3e4caae7fd73654bb06101

data/History.txt

@@ -1,3 +1,18 @@
+=== 3.3.0 / 2016-04-05
+
+* 2 minor features:
+  * Allow overriding options of Configuration object
+  * Rename to inherit_ssl_listener like inherit_tcp|unix
+
+* 2 doc fixes:
+  * Add docs/systemd.md (with socket activation sub-section)
+  * Document UNIX signals with cluster on README.md
+
+* 3 PRs merged:
+  * Merge pull request #936 from prathamesh-sonpatki/allow-overriding-config-options
+  * Merge pull request #940 from kyledrake/signalsdoc
+  * Merge pull request #942 from dekellum/socket-activate-improve
+
 === 3.2.0 / 2016-03-20
 
 * 1 deprecation removal:

data/Manifest.txt

@@ -11,6 +11,7 @@ bin/pumactl
 docs/config.md
 docs/nginx.md
 docs/signals.md
+docs/systemd.md
 ext/puma_http11/PumaHttp11Service.java
 ext/puma_http11/ext_help.h
 ext/puma_http11/extconf.rb

data/README.md

@@ -252,6 +252,21 @@ But again beware, upgrading an application sometimes involves upgrading the data
 
 If you perform a lot of database migrations, you probably should not use phased restart and use a normal/hot restart instead (pumactl restart). That way, no code is shared while deploying (in that case, preload_app might help for quicker deployment, see below).
 
+### Puma Signals
+
+Puma cluster responds to these signals:
+
+- `TTIN` increment the worker count by 1
+- `TTOU` decrement the worker count by 1
+- `TERM` send `TERM` to worker. Worker will attempt to finish then exit.
+- `USR2` restart workers
+- `USR1` restart workers in phases, a rolling restart.
+- `HUP`  reopen log files defined in stdout_redirect configuration parameter
+- `INT` equivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
+- `CHLD`
+
+A detailed guide to using UNIX signals with Puma can be found in the [signals documentation](https://github.com/puma/puma/blob/master/docs/signals.md).
+
 ### Release Directory
 
 If you symlink releases into a common working directory (i.e., `/current` from Capistrano), Puma won't pick up your new changes when running phased restarts without additional configuration. You should set your working directory within Puma's config to specify the directory it should use. This is a change from earlier versions of Puma (< 2.15) that would infer the directory for you.

data/docs/systemd.md

@@ -0,0 +1,78 @@
+# systemd
+
+[systemd](https://www.freedesktop.org/wiki/Software/systemd/) is a
+commonly available init system (PID 1) on many Linux distributions. It
+offers process monitoring (including automatic restarts) and other
+useful features for running Puma in production. Below is a sample
+puma.service configuration file for systemd:
+
+~~~~
+[Unit]
+Description=Puma HTTP Server
+After=network.target
+
+[Service]
+# Foreground process (do not use --daemon in ExecStart or config.rb)
+Type=simple
+
+# Preferably configure a non-privileged user
+# User=
+
+# Specify the path to your puma application root
+# WorkingDirectory=
+
+# Helpful for debugging socket activation, etc.
+# Environment=PUMA_DEBUG=1
+
+# The command to start Puma
+# Here we are using a binstub generated via:
+# `bundle binstubs puma --path ./sbin`
+# in the WorkingDirectory (replace <WD> below)
+# You can alternatively use `bundle exec --keep-file-descriptors puma`
+# ExecStart=<WD>/sbin/puma -b tcp://0.0.0.0:9292 -b ssl://0.0.0.0:9293?key=key.pem&cert=cert.pem
+
+# Alternatively with a config file (in WorkingDirectory) and
+# comparable `bind` directives
+# ExecStart=<WorkingDirectory>/sbin/puma -C config.rb
+
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+~~~~
+
+See [systemd.exec](https://www.freedesktop.org/software/systemd/man/systemd.exec.html)
+for additional details.
+
+## Socket Activation
+
+systemd and puma also support socket activation, where systemd opens
+the listening socket(s) in advance and provides them to the puma master
+process on startup. Among other advantages, this keeps listening
+sockets open across puma restarts and achieves graceful restarts. To
+use socket activation, configure one or more `ListenStream`
+sockets in a companion `*.socket` systemd config file. Here is a sample
+puma.socket, matching the ports used in the above puma.service:
+
+~~~~
+[Unit]
+Description=Puma HTTP Server Accept Sockets
+
+[Socket]
+ListenStream=0.0.0.0:9292
+ListenStream=0.0.0.0:9293
+
+# AF_UNIX domain socket
+# SocketUser, SocketGroup, etc. may be needed for Unix domain sockets
+# ListenStream=/run/puma.sock
+
+# Socket options matching what Puma wants
+NoDelay=true
+ReusePort=true
+
+[Install]
+WantedBy=sockets.target
+~~~~
+
+See [systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
+for additional details.

data/lib/puma/binder.rb

@@ -11,6 +11,7 @@ module Puma
       @events = events
       @listeners = []
       @inherited_fds = {}
+      @activated_sockets = {}
       @unix_paths = []
 
       @proto_env = {
@@ -55,24 +56,23 @@ module Puma
           fd, url = v.split(":", 2)
           @inherited_fds[url] = fd.to_i
           remove << k
-        end
-        if k =~ /LISTEN_FDS/ && ENV['LISTEN_PID'].to_i == $$
+        elsif k == 'LISTEN_FDS' && ENV['LISTEN_PID'].to_i == $$
           v.to_i.times do |num|
             fd = num + 3
             sock = TCPServer.for_fd(fd)
             begin
-              url = "unix://" + Socket.unpack_sockaddr_un(sock.getsockname)
+              key = [ :unix, Socket.unpack_sockaddr_un(sock.getsockname) ]
             rescue ArgumentError
               port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
               if addr =~ /\:/
                 addr = "[#{addr}]"
               end
-              url = "tcp://#{addr}:#{port}"
+              key = [ :tcp, addr, port ]
             end
-            @inherited_fds[url] = sock
+            @activated_sockets[key] = sock
+            @events.debug "Registered #{key.join ':'} for activation from LISTEN_FDS"
           end
-          ENV.delete k
-          ENV.delete 'LISTEN_PID'
+          remove << k << 'LISTEN_PID'
         end
       end
 
@@ -89,6 +89,9 @@ module Puma
           if fd = @inherited_fds.delete(str)
             logger.log "* Inherited #{str}"
             io = inherit_tcp_listener uri.host, uri.port, fd
+          elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
+            logger.log "* Activated #{str}"
+            io = inherit_tcp_listener uri.host, uri.port, sock
           else
             params = Util.parse_query uri.query
 
@@ -106,6 +109,9 @@ module Puma
           if fd = @inherited_fds.delete(str)
             logger.log "* Inherited #{str}"
             io = inherit_unix_listener path, fd
+          elsif sock = @activated_sockets.delete([ :unix, path ])
+            logger.log "* Activated #{str}"
+            io = inherit_unix_listener path, sock
           else
             logger.log "* Listening on #{str}"
 
@@ -191,7 +197,10 @@ module Puma
 
           if fd = @inherited_fds.delete(str)
             logger.log "* Inherited #{str}"
-            io = inherited_ssl_listener fd, ctx
+            io = inherit_ssl_listener fd, ctx
+          elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
+            logger.log "* Activated #{str}"
+            io = inherit_ssl_listener sock, ctx
           else
             logger.log "* Listening on #{str}"
             io = add_ssl_listener uri.host, uri.port, ctx
@@ -209,12 +218,7 @@ module Puma
         logger.log "* Closing unused inherited connection: #{str}"
 
         begin
-          if fd.kind_of? TCPServer
-            fd.close
-          else
-            IO.for_fd(fd).close
-          end
-
+          IO.for_fd(fd).close
         rescue SystemCallError
         end
 
@@ -226,6 +230,17 @@ module Puma
         end
       end
 
+      # Also close any unsued activated sockets
+      @activated_sockets.each do |key, sock|
+        logger.log "* Closing unused activated socket: #{key.join ':'}"
+        begin
+          sock.close
+        rescue SystemCallError
+        end
+        # We have to unlink a unix socket path that's not being used
+        File.unlink key[1] if key[0] == :unix
+      end
+
     end
 
     # Tell the server to listen on host +host+, port +port+.
@@ -285,11 +300,15 @@ module Puma
       s
     end
 
-    def inherited_ssl_listener(fd, ctx)
+    def inherit_ssl_listener(fd, ctx)
       require 'puma/minissl'
       MiniSSL.check
 
-      s = TCPServer.for_fd(fd)
+      if fd.kind_of? TCPServer
+        s = fd
+      else
+        s = TCPServer.for_fd(fd)
+      end
       ssl = MiniSSL::Server.new(s, ctx)
 
       env = @proto_env.dup

data/lib/puma/configuration.rb

@@ -13,10 +13,10 @@ module Puma
   end
 
   class LeveledOptions
-    def initialize(default={})
-      @cur = {}
+    def initialize(default_options, user_options)
+      @cur = user_options
       @set = [@cur]
-      @defaults = default.dup
+      @defaults = default_options.dup
     end
 
     def initialize_copy(other)
@@ -133,12 +133,9 @@ module Puma
     end
 
     def initialize(options={}, &blk)
-      @options = LeveledOptions.new(default_options)
-      @plugins = PluginLoader.new
+      @options = LeveledOptions.new(default_options, options)
 
-      # options.each do |k,v|
-        # @options[k] = v
-      # end
+      @plugins = PluginLoader.new
 
       if blk
         configure(&blk)

data/lib/puma/const.rb

@@ -100,8 +100,8 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "3.2.0".freeze
-    CODE_NAME = "Spring Is A Heliocentric Viewpoint".freeze
+    PUMA_VERSION = VERSION = "3.3.0".freeze
+    CODE_NAME = "Jovial Platypus".freeze
     PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
     
     FAST_TRACK_KA_TIMEOUT = 0.2

data/lib/rack/handler/puma.rb

@@ -12,7 +12,7 @@ module Rack
       def self.run(app, options = {})
         options  = DEFAULT_OPTIONS.merge(options)
 
-        conf = ::Puma::Configuration.new do |c|
+        conf = ::Puma::Configuration.new(options) do |c|
           c.quiet
 
           if options.delete(:Verbose)
@@ -69,4 +69,3 @@ module Rack
     register :puma, Puma
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-20 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.15'
 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. In order to get the best throughput, it is highly recommended that
@@ -91,6 +91,7 @@ extra_rdoc_files:
 - docs/config.md
 - docs/nginx.md
 - docs/signals.md
+- docs/systemd.md
 - tools/jungle/README.md
 - tools/jungle/init.d/README.md
 - tools/jungle/upstart/README.md
@@ -108,6 +109,7 @@ files:
 - docs/config.md
 - docs/nginx.md
 - docs/signals.md
+- docs/systemd.md
 - ext/puma_http11/PumaHttp11Service.java
 - ext/puma_http11/ext_help.h
 - ext/puma_http11/extconf.rb