puma 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1906e2cec23c83e7ed5a2e8fb54885809c8bfa1
-  data.tar.gz: 8cd1fb3dc9caeb4fe4aa4be995e746beebdaa4d0
+  metadata.gz: ac9ff84e4c17a8e7e00a82e37d94da488e96f640
+  data.tar.gz: e743d6fc5e07c6013facbd4d9b7ec917eb0e3fa4
 SHA512:
-  metadata.gz: 74e867dea23de7b4743d810a29925eba7fbb2d4f674e7c9035985699dc35712d80591ea0b3b25a48b72d550f2550c42303719438c65b341e7b4d649af82b07ca
-  data.tar.gz: aa8af24acdcda63f9a8ebfe2ebc573dd048f6e408954125144cf424abfc990baa451b8f6c7197ed015ff30ed2b6d110d96b9c34f67312d8076726b0c278d1c5b
+  metadata.gz: d6b09c19aea4d08df086befeef93a43836838e7375ff644756865e90c4d8a3b641be83209a942bd188d6e7d12ab4ffbd9d6ef02a04e954fcfdc7612d93ef1c8d
+  data.tar.gz: 7a39fbf08255d2379b59b8fece81374f8ce8026e5263863a523eb7a9a9d9caf6e10d667e818fab9705f1b271d99e7befcd63cca4f3788709388b4459b9da613f

data/DEPLOYMENT.md

@@ -1,7 +1,7 @@
 # Deployment engineering for puma
 
 Puma is software that is expected to be run in a deployed environment eventually.
-You can centainly use it as your dev server only, but most people look to use
+You can certainly use it as your dev server only, but most people look to use
 it in their production deployments as well.
 
 To that end, this is meant to serve as a foundation of wisdom how to do that
@@ -17,7 +17,7 @@ Welcome back!
 
 ## Single vs Cluster mode
 
-Puma was originally concieved as a thread-only webserver, but grew the ability to
+Puma was originally conceived as a thread-only webserver, but grew the ability to
 also use processes in version 2.
 
 Here are some rules of thumb:
@@ -27,7 +27,7 @@ Here are some rules of thumb:
 * Use cluster mode and set the number of workers to 1.5x the number of cpu cores
   in the machine, minimum 2.
 * Set the number of threads to desired concurrent requests / number of workers.
-  Puma defaults to 8 and thats a decent number.
+  Puma defaults to 8 and that's a decent number.
 
 #### Migrating from Unicorn
 

data/History.txt

@@ -1,3 +1,52 @@
+=== 2.15.0 / 2015-11-06
+
+* 6 minor features:
+  * Allow setting ca without setting a verify mode
+  * Make jungle for init.d support rbenv
+  * Use SSL_CTX_use_certificate_chain_file for full chain
+  * cluster: add worker_boot_timeout option
+  * configuration: allow empty tags to mean no tag desired
+  * puma/cli: support specifying STD{OUT,ERR} redirections and append mode
+
+* 5 bug fixes:
+  * Disable SSL Compression
+  * Fix bug setting worker_directory when using a symlink directory
+  * Fix error message in DSL that was slightly inaccurate
+  * Pumactl: set correct process name. Fixes #563
+  * thread_pool: fix race condition when shutting down workers
+
+* 10 doc fixes:
+  * Add before_fork explanation in Readme.md
+  * Correct spelling in DEPLOYMENT.md
+  * Correct spelling in docs/nginx.md
+  * Fix spelling errors.
+  * Fix typo in deployment description
+  * Fix typos (it's -> its) in events.rb and server.rb
+  * fixing for typo mentioned in #803
+  * Spelling correction for README
+  * thread_pool: fix typos in comment
+  * More explicit docs for worker_timeout
+
+* 18 PRs merged:
+  * Merge pull request #768 from nathansamson/patch-1
+  * Merge pull request #773 from rossta/spelling_corrections
+  * Merge pull request #774 from snow/master
+  * Merge pull request #781 from sunsations/fix-typo
+  * Merge pull request #791 from unleashed/allow_empty_tags
+  * Merge pull request #793 from robdimarco/fix-working-directory-symlink-bug
+  * Merge pull request #794 from peterkeen/patch-1
+  * Merge pull request #795 from unleashed/redirects-from-cmdline
+  * Merge pull request #796 from cschneid/fix_dsl_message
+  * Merge pull request #799 from annafw/master
+  * Merge pull request #800 from liamseanbrady/fix_typo
+  * Merge pull request #801 from scottjg/ssl-chain-file
+  * Merge pull request #802 from scottjg/ssl-crimes
+  * Merge pull request #804 from burningTyger/patch-2
+  * Merge pull request #809 from unleashed/threadpool-fix-race-in-shutdown
+  * Merge pull request #810 from vlmonk/fix-pumactl-restart-bug
+  * Merge pull request #814 from schneems/schneems/worker_timeout-docs
+  * Merge pull request #817 from unleashed/worker-boot-timeout
+
 === 2.14.0 / 2015-09-18
 
 * 1 minor feature:

data/README.md

@@ -117,6 +117,25 @@ If you're preloading your application and using ActiveRecord, it's recommend you
       end
     end
 
+On top of that, you can specify a block in your configuration file that will be run before workers are forked
+
+    # config/puma.rb
+    before_fork do
+      # configuration here
+    end
+
+This code can be used to clean up before forking to clients, allowing
+you to do some Puma-specific things that you don't want to embed in your application.
+
+If you're preloading your application and using ActiveRecord, it's recommend you close any connections to the database here to prevent connection leakage:
+
+    # config/puma.rb
+    before_fork do
+      ActiveRecord::Base.connection_pool.disconnect!
+    end
+
+This rule applies to any connections to external services (Redis, databases, memcache, ...) that might be started automatically by the framework.
+
 When you use preload_app, your new code goes all in the master process, and is then copied in the workers (meaning it’s only compatible with cluster mode). General rule is to use preload_app when your workers die often and need fast starts. If you don’t have many workers, you probably should not use preload_app.
 
 Note that preload_app can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preload_app is all about copying the code of master into the workers.
@@ -167,7 +186,7 @@ You can also provide a configuration file which Puma will use with the `-C` (or
 
     $ puma -C /path/to/config
 
-By default, if no configuration file is specifed, Puma will look for a configuration file at config/puma.rb. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` environment variable, the default file location will be config/puma/environment_name.rb.
+By default, if no configuration file is specified, Puma will look for a configuration file at config/puma.rb. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` environment variable, the default file location will be config/puma/environment_name.rb.
 
 If you want to prevent Puma from looking for a configuration file in those locations, provide a dash as the argument to the `-C` (or `--config`) flag:
 

data/docs/nginx.md

@@ -40,7 +40,7 @@ server {
     }
 
     # check for index.html for directory index
-    # if its there on the filesystem then rewite
+    # if it's there on the filesystem then rewrite
     # the url to add /index.html to the end of it
     # and then break to send it to the next config rules.
     if (-f $request_filename/index.html) {

data/ext/puma_http11/mini_ssl.c

@@ -136,14 +136,14 @@ VALUE engine_init_server(VALUE self, VALUE mini_ssl_ctx) {
   ctx = SSL_CTX_new(SSLv23_server_method());
   conn->ctx = ctx;
 
-  SSL_CTX_use_certificate_file(ctx, RSTRING_PTR(cert), SSL_FILETYPE_PEM);
+  SSL_CTX_use_certificate_chain_file(ctx, RSTRING_PTR(cert));
   SSL_CTX_use_PrivateKey_file(ctx, RSTRING_PTR(key), SSL_FILETYPE_PEM);
 
   if (!NIL_P(ca)) {
     SSL_CTX_load_verify_locations(ctx, RSTRING_PTR(ca), NULL);
   }
   
-  SSL_CTX_set_options(ctx, SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_SINGLE_DH_USE | SSL_OP_SINGLE_ECDH_USE);
+  SSL_CTX_set_options(ctx, SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_SINGLE_DH_USE | SSL_OP_SINGLE_ECDH_USE | SSL_OP_NO_COMPRESSION);
   SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
 
   SSL_CTX_set_cipher_list(ctx, "HIGH:!aNULL@STRENGTH");

data/lib/puma/binder.rb

@@ -164,8 +164,9 @@ module Puma
               unless params['ca']
                 @events.error "Please specify the SSL ca via 'ca='"
               end
-              ctx.ca = params['ca']
             end
+            
+            ctx.ca = params['ca']
 
             if  params['verify_mode']
               ctx.verify_mode = case params['verify_mode']

data/lib/puma/cli.rb

@@ -266,7 +266,7 @@ module Puma
   private
     def title
       buffer = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
-      buffer << " [#{@options[:tag]}]" if @options[:tag]
+      buffer << " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
       buffer
     end
 
@@ -410,6 +410,18 @@ module Puma
           @cli_options[:tag] = arg
         end
 
+        o.on "--redirect-stdout FILE", "Redirect STDOUT to a specific file" do |arg|
+          @cli_options[:redirect_stdout] = arg
+        end
+
+        o.on "--redirect-stderr FILE", "Redirect STDERR to a specific file" do |arg|
+          @cli_options[:redirect_stderr] = arg
+        end
+
+        o.on "--[no-]redirect-append", "Append to redirected files" do |val|
+          @cli_options[:redirect_append] = val
+        end
+
         o.banner = "puma <options> <rackup file>"
 
         o.on_tail "-h", "--help", "Show help" do
@@ -429,7 +441,7 @@ module Puma
 
         if s_env.ino == s_pwd.ino and (jruby? or s_env.dev == s_pwd.dev)
           @restart_dir = dir
-          @cli_options[:worker_directory] = dir
+          @options[:worker_directory] = dir
         end
       end
 

data/lib/puma/cluster.rb

@@ -136,6 +136,7 @@ module Puma
       any = false
 
       @workers.each do |w|
+        next if !w.booted? && !w.ping_timeout?(@options[:worker_boot_timeout])
         if w.ping_timeout?(@options[:worker_timeout])
           log "! Terminating timed out worker: #{w.pid}"
           w.kill
@@ -186,7 +187,7 @@ module Puma
 
     def worker(index, master)
       title = "puma: cluster worker #{index}: #{master}"
-      title << " [#{@options[:tag]}]" if @options[:tag]
+      title << " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
       $0 = title
 
       Signal.trap "SIGINT", "IGNORE"
@@ -221,7 +222,7 @@ module Puma
       begin
         @worker_write << "b#{Process.pid}\n"
       rescue SystemCallError, IOError
-        STDERR.puts "Master seems to have exitted, exitting."
+        STDERR.puts "Master seems to have exited, exiting."
         return
       end
 

data/lib/puma/configuration.rb

@@ -27,6 +27,7 @@ module Puma
       @conf[:before_worker_fork] ||= []
       @conf[:after_worker_boot] ||= []
       @conf[:worker_timeout] ||= DefaultWorkerTimeout
+      @conf[:worker_boot_timeout] ||= @conf[:worker_timeout]
       @conf[:worker_shutdown_timeout] ||= DefaultWorkerShutdownTimeout
 
       @options = {}

data/lib/puma/const.rb

@@ -99,8 +99,8 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.14.0".freeze
-    CODE_NAME = "Fuchsia Friday".freeze
+    PUMA_VERSION = VERSION = "2.15.0".freeze
+    CODE_NAME = "Autumn Arbor Airbrush".freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 

data/lib/puma/control_cli.rb

@@ -262,6 +262,10 @@ module Puma
 
       events = Puma::Events.new @stdout, @stderr
 
+      # replace $0 because puma use it to generate restart command
+      puma_cmd = $0.gsub(/pumactl$/, 'puma')
+      $0 = puma_cmd if File.exist?(puma_cmd)
+
       cli = Puma::CLI.new run_args, events
       cli.run
     end

data/lib/puma/dsl.rb

@@ -132,7 +132,7 @@ module Puma
       min = Integer(min)
       max = Integer(max)
       if min > max
-        raise "The minimum (#{min}) number of threads must be less than the max (#{max})"
+        raise "The minimum (#{min}) number of threads must be less than or equal to the max (#{max})"
       end
 
       @options[:min_threads] = min
@@ -256,11 +256,19 @@ module Puma
       @options[:tag] = string
     end
 
-    # *Cluster mode only* Set the timeout for workers
+    # *Cluster mode only* Set the timeout for workers in seconds
+    # When set the master process will terminate any workers
+    # that have not checked in within the given +timeout+.
+    # This mitigates hung processes. Default value is 60 seconds.
     def worker_timeout(timeout)
       @options[:worker_timeout] = timeout
     end
 
+    # *Cluster mode only* Set the timeout for workers to boot
+    def worker_boot_timeout(timeout)
+      @options[:worker_boot_timeout] = timeout
+    end
+
     # *Cluster mode only* Set the timeout for worker shutdown
     def worker_shutdown_timeout(timeout)
       @options[:worker_shutdown_timeout] = timeout

data/lib/puma/events.rb

@@ -128,7 +128,7 @@ module Puma
 
     DEFAULT = new(STDOUT, STDERR)
 
-    # Returns an Events object which writes it's status to 2 StringIO
+    # Returns an Events object which writes its status to 2 StringIO
     # objects.
     #
     def self.strings

data/lib/puma/server.rb

@@ -45,7 +45,7 @@ module Puma
     # to be handled. See Puma::Events for the list of current methods to implement.
     #
     # Server#run returns a thread that you can join on to wait for the server
-    # to do it's work.
+    # to do its work.
     #
     def initialize(app, events=Events.stdio, options={})
       @app = app

data/lib/puma/single.rb

@@ -62,7 +62,7 @@ module Puma
           end
 
           Signal.trap "SIGCHLD" do
-            log "! Error starting new process as daemon, exitting"
+            log "! Error starting new process as daemon, exiting"
             exit 1
           end
 

data/lib/puma/thread_pool.rb

@@ -160,7 +160,7 @@ module Puma
     end
 
     # If there are dead threads in the pool make them go away while decreasing
-    # spwaned counter so that new healty threads could be created again.
+    # spawned counter so that new healthy threads could be created again.
     def reap
       @mutex.synchronize do
         dead_workers = @workers.reject(&:alive?)
@@ -235,20 +235,18 @@ module Puma
     # Tell all threads in the pool to exit and wait for them to finish.
     #
     def shutdown
-      @mutex.synchronize do
+      threads = @mutex.synchronize do
         @shutdown = true
         @not_empty.broadcast
         @not_full.broadcast
 
         @auto_trim.stop if @auto_trim
         @reaper.stop if @reaper
+        # dup workers so that we join them all safely
+        @workers.dup
       end
 
-      # Use this instead of #each so that we don't stop in the middle
-      # of each and see a mutated object mid #each
-      if !@workers.empty?
-          @workers.first.join until @workers.empty?
-      end
+      threads.each(&:join)
 
       @spawned = 0
       @workers = []

data/lib/rack/handler/puma.rb

@@ -50,7 +50,7 @@ module Rack
           "Host=HOST"       => "Hostname to listen on (default: localhost)",
           "Port=PORT"       => "Port to listen on (default: 8080)",
           "Threads=MIN:MAX" => "min:max threads to use (default 0:16)",
-          "Quiet"           => "Don't report each request"
+          "Verbose"         => "Don't report each request (default: false)"
         }
       end
     end

data/tools/jungle/init.d/puma

@@ -23,6 +23,7 @@ SCRIPTNAME=/etc/init.d/$NAME
 CONFIG=/etc/puma.conf
 JUNGLE=`cat $CONFIG`
 RUNPUMA=/usr/local/bin/run-puma
+USE_LOCAL_BUNDLE=0
 
 # Load the VERBOSE setting and other rcS variables
 . /lib/init/vars.sh
@@ -105,7 +106,11 @@ do_stop_one() {
       log_daemon_msg "---> Puma $1 isn't running."
     else
       log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
-      pumactl --state $STATEFILE stop
+      if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+        cd $1 && bundle exec pumactl --state $STATEFILE stop
+      else
+        pumactl --state $STATEFILE stop
+      fi
       # Many daemons don't delete their pidfiles when they exit.
       rm -f $PIDFILE $STATEFILE
     fi
@@ -135,7 +140,11 @@ do_restart_one() {
   
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to restart puma $1"
-    pumactl --state $dir/tmp/puma/state restart
+    if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+      cd $1 && bundle exec pumactl --state $dir/tmp/puma/state restart
+    else
+      pumactl --state $dir/tmp/puma/state restart
+    fi
     # kill -s USR2 `cat $PIDFILE`
     # TODO Check if process exist
   else
@@ -175,7 +184,11 @@ do_status_one() {
   
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to status puma $1"
-    pumactl --state $dir/tmp/puma/state stats
+    if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+      cd $1 && bundle exec pumactl --state $dir/tmp/puma/state stats
+    else
+      pumactl --state $dir/tmp/puma/state stats
+    fi
     # kill -s USR2 `cat $PIDFILE`
     # TODO Check if process exist
   else
@@ -241,6 +254,40 @@ do_remove() {
   fi
 }
 
+config_bundler() {
+  HOME="$(eval echo ~$(id -un))"
+  if [ -d "/usr/local/rbenv/bin" ]; then
+    PATH="/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH"
+    eval "$(rbenv init -)"
+    USE_LOCAL_BUNDLE=1
+    return 0
+  elif [ -d "$HOME/.rbenv/bin" ]; then
+    PATH="$HOME/.rbenv/bin:$HOME/.rbenv/shims:$PATH"
+    eval "$(rbenv init -)"
+    USE_LOCAL_BUNDLE=1
+    return 0
+  # TODO: test rvm
+  # 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"
+  # TODO: don't know what to do with chruby
+  # 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
+
+  return 1
+}
+
+config_bundler
+
 case "$1" in
   start)
     [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc