puma 3.6.2 → 3.7.0

data/Manifest.txt

@@ -1,6 +1,6 @@
 DEPLOYMENT.md
 Gemfile
-History.txt
+History.md
 LICENSE
 Manifest.txt
 README.md
@@ -51,8 +51,6 @@ 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_18.rb
-lib/puma/rack/backports/uri/common_192.rb
 lib/puma/rack/backports/uri/common_193.rb
 lib/puma/rack/builder.rb
 lib/puma/rack/urlmap.rb

data/README.md

@@ -213,6 +213,12 @@ Puma comes with a builtin status/control app that can be used to query and contr
 
 This directs Puma to start the control server on localhost port 9293. Additionally, all requests to the control server will need to include `token=foo` as a query parameter. This allows for simple authentication. Check out [status.rb](https://github.com/puma/puma/blob/master/lib/puma/app/status.rb) to see what the app has available.
 
+Keep in mind that the status/control server accepts `pumactl` commands. To demonstrate, you can run the following command with the foo `--control-token` as such to restart: 
+
+    $ pumactl restart --control-token foo
+
+To see a list of `pumactl` options, please see `pumactl --help` as stated in the [`pumactl`](https://github.com/puma/puma#pumactl) section.
+
 ### Configuration file
 
 You can also provide a configuration file which Puma will use with the `-C` (or `--config`) flag:
@@ -269,7 +275,7 @@ A detailed guide to using UNIX signals with Puma can be found in the [signals do
 
 ### 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.
+If your 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.
 
 ```ruby
 # config/puma.rb

data/Rakefile

@@ -1,3 +1,4 @@
+require "bundler/setup"
 require "hoe"
 require "rake/extensiontask"
 require "rake/javaextensiontask"
@@ -18,9 +19,9 @@ HOE = Hoe.spec "puma" do
   spec_extras[:executables] = ['puma', 'pumactl']
   spec_extras[:homepage] = self.urls.first
 
-  require_ruby_version ">= 1.8.7"
+  require_ruby_version ">= 1.9.3"
 
-  dependency "rack", [">= 1.1", "< 2.0"], :development
+  dependency "rack", [">= 1.1", "< 3.0"], :development
 
   extra_dev_deps << ["rake-compiler", "~> 0.8"]
 end
@@ -66,7 +67,7 @@ task "changelog" do
     $changes[code] << line
   end
 
-  puts "=== #{ENV['VERSION'] || 'NEXT'} / #{now}"
+  puts "## #{ENV['VERSION'] || 'NEXT'} / #{now}"
   puts
   changelog_section :major
   changelog_section :minor
@@ -155,4 +156,3 @@ namespace :test do
     task :all => [:test, "test:integration"]
   end
 end
-

data/docs/systemd.md

@@ -168,3 +168,30 @@ Apr 07 08:40:19 hx puma[28320]: * Activated tcp://0.0.0.0:9233
 Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=cert.pem
 Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
 ~~~~
+
+## Alternative background process configuration
+
+If Capistrano and [capistrano3-puma](https://github.com/seuros/capistrano-puma) tasks are used you can use the following configuration. In this case, you would skip systemd Socket Activation, since Puma handles the socket by itself:
+
+~~~~
+[Service]
+# Background process configuration (use with --daemon in ExecStart)
+Type=forking
+
+# To learn which exact command is to be used to execute at "ExecStart" of this
+# Service, ask Capistrano: `cap <stage> puma:start --dry-run`. Your result
+# may differ from this example, for example if you use a Ruby version
+# manager. `<WD>` is short for "your working directory". Replace it with your
+# path.
+ExecStart=bundle exec puma -C <WD>/shared/puma.rb --daemon
+
+# To learn which exact command is to be used to execute at "ExecStop" of this
+# Service, ask Capistrano: `cap <stage> puma:stop --dry-run`. Your result
+# may differ from this example, for example if you use a Ruby version
+# manager. `<WD>` is short for "your working directory". Replace it with your
+# path.
+ExecStop=bundle exec pumactl -S <WD>/shared/tmp/pids/puma.state stop
+
+# PIDFile setting is required in order to work properly
+PIDFile=<WD>/shared/tmp/pids/puma.pid
+~~~~

data/ext/puma_http11/http11_parser.c

@@ -3,6 +3,7 @@
 /**
  * Copyright (c) 2005 Zed A. Shaw
  * You can redistribute it and/or modify it under the same terms as Ruby.
+ * License 3-clause BSD
  */
 #include "http11_parser.h"
 #include <stdio.h>

data/ext/puma_http11/http11_parser.h

@@ -1,6 +1,7 @@
 /**
  * Copyright (c) 2005 Zed A. Shaw
  * You can redistribute it and/or modify it under the same terms as Ruby.
+ * License 3-clause BSD
  */
 
 #ifndef http11_parser_h

data/ext/puma_http11/http11_parser.rl

@@ -1,6 +1,7 @@
 /**
  * Copyright (c) 2005 Zed A. Shaw
  * You can redistribute it and/or modify it under the same terms as Ruby.
+ * License 3-clause BSD
  */
 #include "http11_parser.h"
 #include <stdio.h>

data/ext/puma_http11/io_buffer.c

@@ -14,8 +14,8 @@ struct buf_int {
 #define BUF_TOLERANCE 32
 
 static void buf_free(struct buf_int* internal) {
-  free(internal->top);
-  free(internal);
+  xfree(internal->top);
+  xfree(internal);
 }
 
 static VALUE buf_alloc(VALUE self) {
@@ -25,7 +25,7 @@ static VALUE buf_alloc(VALUE self) {
   buf = Data_Make_Struct(self, struct buf_int, 0, buf_free, internal);
 
   internal->size = BUF_DEFAULT_SIZE;
-  internal->top = malloc(BUF_DEFAULT_SIZE);
+  internal->top = ALLOC_N(uint8_t, BUF_DEFAULT_SIZE);
   internal->cur = internal->top;
 
   return buf;
@@ -51,13 +51,13 @@ static VALUE buf_append(VALUE self, VALUE str) {
 
     new_size = (n > new_size ? n : new_size + BUF_TOLERANCE);
 
-    top = malloc(new_size);
+    top = ALLOC_N(uint8_t, new_size);
     old = b->top;
     memcpy(top, old, used);
     b->top = top;
     b->cur = top + used;
     b->size = new_size;
-    free(old);
+    xfree(old);
   }
 
   memcpy(b->cur, RSTRING_PTR(str), str_len);
@@ -92,13 +92,13 @@ static VALUE buf_append2(int argc, VALUE* argv, VALUE self) {
 
     new_size = (n > new_size ? n : new_size + BUF_TOLERANCE);
 
-    top = malloc(new_size);
+    top = ALLOC_N(uint8_t, new_size);
     old = b->top;
     memcpy(top, old, used);
     b->top = top;
     b->cur = top + used;
     b->size = new_size;
-    free(old);
+    xfree(old);
   }
 
   for(i = 0; i < argc; i++) {

data/ext/puma_http11/mini_ssl.c

@@ -87,6 +87,8 @@ DH *get_dh1024() {
 
   DH *dh;
   dh = DH_new();
+
+#if OPENSSL_VERSION_NUMBER < 0x10100005L
   dh->p = BN_bin2bn(dh1024_p, sizeof(dh1024_p), NULL);
   dh->g = BN_bin2bn(dh1024_g, sizeof(dh1024_g), NULL);
 
@@ -94,6 +96,18 @@ DH *get_dh1024() {
     DH_free(dh);
     return NULL;
   }
+#else
+  BIGNUM *p, *g;
+  p = BN_bin2bn(dh1024_p, sizeof(dh1024_p), NULL);
+  g = BN_bin2bn(dh1024_g, sizeof(dh1024_g), NULL);
+
+  if (p == NULL || g == NULL || !DH_set0_pqg(dh, p, NULL, g)) {
+    DH_free(dh);
+    BN_free(p);
+    BN_free(g);
+    return NULL;
+  }
+#endif
 
   return dh;
 }
@@ -157,7 +171,7 @@ VALUE engine_init_server(VALUE self, VALUE mini_ssl_ctx) {
     StringValue(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_OP_NO_COMPRESSION);
   SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
 
@@ -329,8 +343,7 @@ VALUE engine_extract(VALUE self) {
 
 VALUE engine_shutdown(VALUE self) {
   ms_conn* conn;
-  int ok, err;
-  char buf[512];
+  int ok;
 
   Data_Get_Struct(self, ms_conn, conn);
 
@@ -346,8 +359,6 @@ VALUE engine_shutdown(VALUE self) {
 
 VALUE engine_init(VALUE self) {
   ms_conn* conn;
-  int ok, err;
-  char buf[512];
 
   Data_Get_Struct(self, ms_conn, conn);
 
@@ -404,7 +415,7 @@ void Init_mini_ssl(VALUE puma) {
   OpenSSL_add_ssl_algorithms();
   SSL_load_error_strings();
   ERR_load_crypto_strings();
-  
+
   mod = rb_define_module_under(puma, "MiniSSL");
   eng = rb_define_class_under(mod, "Engine", rb_cObject);
 

data/ext/puma_http11/puma_http11.c

@@ -1,6 +1,7 @@
 /**
  * Copyright (c) 2005 Zed A. Shaw
  * You can redistribute it and/or modify it under the same terms as Ruby.
+ * License 3-clause BSD
  */
 
 #define RSTRING_NOT_MODIFIED 1

data/lib/puma.rb

@@ -1,7 +1,6 @@
 # Standard libraries
 require 'socket'
 require 'tempfile'
-require 'yaml'
 require 'time'
 require 'etc'
 require 'uri'
@@ -9,7 +8,8 @@ require 'stringio'
 
 require 'thread'
 
-# Ruby Puma
-require 'puma/const'
-require 'puma/server'
-require 'puma/launcher'
+module Puma
+  autoload :Const, 'puma/const'
+  autoload :Server, 'puma/server'
+  autoload :Launcher, 'puma/launcher'
+end

data/lib/puma/binder.rb

@@ -1,5 +1,8 @@
-require 'puma/const'
 require 'uri'
+require 'socket'
+
+require 'puma/const'
+require 'puma/util'
 
 module Puma
   class Binder
@@ -140,11 +143,11 @@ module Puma
 
           @listeners << [str, io]
         when "ssl"
-          MiniSSL.check
-
           params = Util.parse_query uri.query
           require 'puma/minissl'
 
+          MiniSSL.check
+
           ctx = MiniSSL::Context.new
 
           if defined?(JRUBY_VERSION)

data/lib/puma/cli.rb

@@ -1,7 +1,10 @@
 require 'optparse'
 require 'uri'
 
+require 'puma/configuration'
 require 'puma/launcher'
+require 'puma/const'
+require 'puma/events'
 
 module Puma
   class << self

data/lib/puma/client.rb

@@ -155,7 +155,8 @@ module Puma
           len = line.strip.to_i(16)
           if len == 0
             @body.rewind
-            @buffer = nil
+            rest = io.read
+            @buffer = rest.empty? ? nil : rest
             @requests_served += 1
             @ready = true
             return true
@@ -215,14 +216,13 @@ module Puma
     end
 
     def setup_body
-      @in_data_phase = true
       @read_header = false
 
       body = @parser.body
 
       te = @env[TRANSFER_ENCODING2]
 
-      if te == CHUNKED
+      if te && CHUNKED.casecmp(te) == 0
         return setup_chunked_body(body)
       end
 
@@ -290,7 +290,7 @@ module Puma
         raise HttpParserError,
           "HEADER is longer than allowed, aborting client early."
       end
-      
+
       false
     end
 

data/lib/puma/cluster.rb

@@ -1,8 +1,13 @@
 require 'puma/runner'
+require 'puma/util'
+require 'puma/plugin'
+
 require 'time'
 
 module Puma
   class Cluster < Runner
+    WORKER_CHECK_INTERVAL = 5
+
     def initialize(cli, events)
       super cli, events
 
@@ -110,6 +115,7 @@ module Puma
 
     def spawn_workers
       diff = @options[:workers] - @workers.size
+      return if diff < 1
 
       master = Process.pid
 
@@ -135,6 +141,21 @@ module Puma
       end
     end
 
+    def cull_workers
+      diff = @workers.size - @options[:workers]
+      return if diff < 1
+
+      debug "Culling #{diff.inspect} workers"
+
+      workers_to_cull = @workers[-diff,diff]
+      debug "Workers to cull: #{workers_to_cull.inspect}"
+
+      workers_to_cull.each do |worker|
+        log "- Worker #{worker.index} (pid: #{worker.pid}) terminating"
+        worker.term
+      end
+    end
+
     def next_worker_index
       all_positions =  0...@options[:workers]
       occupied_positions = @workers.map { |w| w.index }
@@ -149,7 +170,7 @@ module Puma
     def check_workers(force=false)
       return if !force && @next_check && @next_check >= Time.now
 
-      @next_check = Time.now + 5
+      @next_check = Time.now + WORKER_CHECK_INTERVAL
 
       any = false
 
@@ -175,6 +196,7 @@ module Puma
 
       @workers.delete_if(&:dead?)
 
+      cull_workers
       spawn_workers
 
       if all_workers_booted?
@@ -253,7 +275,7 @@ module Puma
         base_payload = "p#{Process.pid}"
 
         while true
-          sleep 5
+          sleep WORKER_CHECK_INTERVAL
           begin
             b = server.backlog
             r = server.running
@@ -337,7 +359,6 @@ module Puma
 
       Signal.trap "TTOU" do
         @options[:workers] -= 1 if @options[:workers] >= 2
-        @workers.last.term
         wakeup!
       end
 
@@ -445,7 +466,7 @@ module Puma
 
             force_check = false
 
-            res = IO.select([read], nil, nil, 5)
+            res = IO.select([read], nil, nil, WORKER_CHECK_INTERVAL)
 
             if res
               req = read.read_nonblock(1)

data/lib/puma/commonlogger.rb

@@ -21,6 +21,13 @@ module Puma
     #   %{%s - %s [%s] "%s %s%s %s" %d %s\n} %
     FORMAT = %{%s - %s [%s] "%s %s%s %s" %d %s %0.4f\n}
 
+    HIJACK_FORMAT = %{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
+
+    CONTENT_LENGTH = 'Content-Length'.freeze
+    PATH_INFO      = 'PATH_INFO'.freeze
+    QUERY_STRING   = 'QUERY_STRING'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
     def initialize(app, logger=nil)
       @app = app
       @logger = logger
@@ -42,36 +49,23 @@ module Puma
       [status, header, body]
     end
 
-    HIJACK_FORMAT = %{%s - %s [%s] "%s %s%s %s" HIJACKED -1 %0.4f\n}
-
     private
 
     def log_hijacking(env, status, header, began_at)
       now = Time.now
 
-      logger = @logger || env['rack.errors']
-      logger.write HIJACK_FORMAT % [
+      msg = HIJACK_FORMAT % [
         env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
         env["REMOTE_USER"] || "-",
         now.strftime("%d/%b/%Y %H:%M:%S"),
-        env["REQUEST_METHOD"],
-        env["PATH_INFO"],
-        env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
+        env[REQUEST_METHOD],
+        env[PATH_INFO],
+        env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
         env["HTTP_VERSION"],
         now - began_at ]
-    end
 
-    PATH_INFO      = 'PATH_INFO'.freeze
-    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-    SCRIPT_NAME    = 'SCRIPT_NAME'.freeze
-    QUERY_STRING   = 'QUERY_STRING'.freeze
-    CACHE_CONTROL  = 'Cache-Control'.freeze
-    CONTENT_LENGTH = 'Content-Length'.freeze
-    CONTENT_TYPE   = 'Content-Type'.freeze
-
-    GET  = 'GET'.freeze
-    HEAD = 'HEAD'.freeze
-    
+      write(msg)
+    end
 
     def log(env, status, header, began_at)
       now = Time.now
@@ -83,13 +77,18 @@ module Puma
         now.strftime("%d/%b/%Y:%H:%M:%S %z"),
         env[REQUEST_METHOD],
         env[PATH_INFO],
-        env[QUERY_STRING].empty? ? "" : "?"+env[QUERY_STRING],
+        env[QUERY_STRING].empty? ? "" : "?#{env[QUERY_STRING]}",
         env["HTTP_VERSION"],
         status.to_s[0..3],
         length,
         now - began_at ]
 
+      write(msg)
+    end
+
+    def write(msg)
       logger = @logger || env['rack.errors']
+
       # Standard library logger doesn't support write but it supports << which actually
       # calls to write on the log device without formatting
       if logger.respond_to?(:write)