puma 2.1.1 → 2.2.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 2.2.0 / 2013-07-01
+
+* 1 major feature:
+
+  * Add ability to preload rack app
+
+* 2 minor bugfixes:
+
+  * Don't leak info when not in development. Fixes #256
+  * Load the app, then bind the ports
+
 === 2.1.1 / 2013-06-20
 
 * 2 minor bug fixes:

data/README.md

@@ -134,13 +134,13 @@ or
 
     $ puma -C /path/to/config
 
-Take the following [sample configuration](https://github.com/puma/puma/blob/master/examples/config.rb) as inspiration or check out [configuration.rb](https://github.com/puma/puma/blob/master/lib/puma/configuration.rb#L138) to see all available options.
+Take the following [sample configuration](https://github.com/puma/puma/blob/master/examples/config.rb) as inspiration or check out [configuration.rb](https://github.com/puma/puma/blob/master/lib/puma/configuration.rb) to see all available options.
 
 ## Restart
 
 Puma includes the ability to restart itself, allowing for new versions to be easily upgraded to. When available (MRI, Rubinius, JRuby), puma performs a "hot restart". This is the same functionality available in *unicorn* and *nginx* which keep the server sockets open between restarts. This makes sure that no pending requests are dropped while the restart is taking place.
 
-To perform a restart, there are 2 builtin mechanism:
+To perform a restart, there are 2 builtin mechanisms:
 
   * Send the puma process the `SIGUSR2` signal
   * Use the status server and issue `/restart`

data/Rakefile

@@ -28,6 +28,50 @@ end
 # hoe/test's .gemtest touch file thingy for now
 HOE.spec.files -= [".gemtest"]
 
+include Hoe::Git
+
+desc "Print the current changelog."
+task "changelog" do
+  tag   = ENV["FROM"] || git_tags.last
+  range = [tag, "HEAD"].compact.join ".."
+  cmd   = "git log #{range} '--format=tformat:%B|||%aN|||%aE|||'"
+  now   = Time.new.strftime "%Y-%m-%d"
+
+  changes = `#{cmd}`.split(/\|\|\|/).each_slice(3).map { |msg, author, email|
+              msg.split(/\n/).reject { |s| s.empty? }.first
+            }.flatten.compact
+
+  $changes = Hash.new { |h,k| h[k] = [] }
+
+  codes = {
+    "!" => :major,
+    "+" => :minor,
+    "*" => :minor,
+    "-" => :bug,
+    "?" => :unknown,
+  }
+
+  codes_re = Regexp.escape codes.keys.join
+
+  changes.each do |change|
+    if change =~ /^\s*([#{codes_re}])\s*(.*)/ then
+      code, line = codes[$1], $2
+    else
+      code, line = codes["?"], change.chomp
+    end
+
+    $changes[code] << line
+  end
+
+  puts "=== #{ENV['VERSION'] || 'NEXT'} / #{now}"
+  puts
+  changelog_section :major
+  changelog_section :minor
+  changelog_section :bug
+  changelog_section :unknown
+  puts
+end
+
 # puma.gemspec
 
 file "#{HOE.spec.name}.gemspec" => ['Rakefile', "lib/puma/const.rb"] do |t|

data/lib/puma/cli.rb

@@ -39,6 +39,8 @@ module Puma
       @restart = false
       @phased_state = :idle
 
+      @app = nil
+
       ENV['NEWRELIC_DISPATCHER'] ||= "puma"
 
       setup_options
@@ -302,6 +304,10 @@ module Puma
       ENV['RACK_ENV'] = env
     end
 
+    def development?
+      @options[:environment] == "development"
+    end
+
     def delete_pidfile
       if path = @options[:pidfile]
         File.unlink path
@@ -454,6 +460,23 @@ module Puma
       @status = status
     end
 
+    def load_and_bind
+      unless @config.app_configured?
+        error "No application configured, nothing to run"
+        exit 1
+      end
+
+      # Load the app before we daemonize.
+      begin
+        @app = @config.app
+      rescue Exception => e
+        log "! Unable to load application"
+        raise e
+      end
+
+      @binder.parse @options[:binds], self
+    end
+
     def run_single
       already_daemon = false
 
@@ -461,8 +484,8 @@ module Puma
         require 'puma/jruby_restart'
 
         if JRubyRestart.daemon?
-          # Bind before redirecting IO so binding errors show up on stdout/stderr
-          @binder.parse @options[:binds], self
+          # load and bind before redirecting IO so errors show up on stdout/stderr
+          load_and_bind
         end
 
         already_daemon = JRubyRestart.daemon_init
@@ -470,23 +493,6 @@ module Puma
 
       output_header
 
-      if !jruby_daemon?
-        @binder.parse @options[:binds], self
-      end
-
-      unless @config.app_configured?
-        error "No application configured, nothing to run"
-        exit 1
-      end
-
-      # Load the app before we daemonize.
-      begin
-        app = @config.app
-      rescue Exception => e
-        log "! Unable to load application"
-        raise e
-      end
-
       if jruby_daemon?
         unless already_daemon
           require 'puma/jruby_restart'
@@ -501,17 +507,22 @@ module Puma
           pid = JRubyRestart.daemon_start(@restart_dir, @restart_argv)
           sleep
         end
-      elsif daemon?
-        Process.daemon(true)
+      else
+        load_and_bind
+        Process.daemon(true) if daemon?
       end
 
       write_state
 
-      server = Puma::Server.new app, @events
+      server = Puma::Server.new @app, @events
       server.binder = @binder
       server.min_threads = @options[:min_threads]
       server.max_threads = @options[:max_threads]
 
+      unless development?
+        server.leak_stack_on_error = false
+      end
+
       @server = server
 
       if str = @options[:control_url]
@@ -592,11 +603,19 @@ module Puma
       min_t = @options[:min_threads]
       max_t = @options[:max_threads]
 
-      server = Puma::Server.new @config.app, @events
+      # If preload is used, then @app is set to the preloaded
+      # application. Otherwise load it now via the config.
+      app = @app || @config.app
+
+      server = Puma::Server.new app, @events
       server.min_threads = min_t
       server.max_threads = max_t
       server.inherit_binder @binder
 
+      unless development?
+        server.leak_stack_on_error = false
+      end
+
       Signal.trap "SIGTERM" do
         server.stop
       end
@@ -715,11 +734,18 @@ module Puma
       log "* Min threads: #{@options[:min_threads]}, max threads: #{@options[:max_threads]}"
       log "* Environment: #{ENV['RACK_ENV']}"
 
-      @binder.parse @options[:binds], self
+      if @options[:preload_app]
+        log "* Preloading application"
+        load_and_bind
+      else
+        log "* Phased restart available"
 
-      unless @config.app_configured?
-        error "No application configured, nothing to run"
-        exit 1
+        unless @config.app_configured?
+          error "No application configured, nothing to run"
+          exit 1
+        end
+
+        @binder.parse @options[:binds], self
       end
 
       read, @wakeup = Puma::Util.pipe
@@ -760,9 +786,16 @@ module Puma
       phased_restart = false
 
       begin
-        Signal.trap "SIGUSR1" do
-          phased_restart = true
-          wakeup!
+        if @options[:preload_app]
+          Signal.trap "SIGUSR1" do
+            log "App preloaded, phased restart unavailable"
+          end
+        else
+          Signal.trap "SIGUSR1" do
+            phased_restart = true
+            @wakeup << "!"
+            wakeup!
+          end
         end
       rescue Exception
       end

data/lib/puma/configuration.rb

@@ -287,6 +287,14 @@ module Puma
         @options[:directory] = dir.to_s
         @options[:worker_directory] = dir.to_s
       end
+
+      # *Cluster mode only* Preload the application before starting
+      # the workers and setting up the listen ports. This conflicts
+      # with using the phased restart feature, you can't use both.
+      #
+      def preload_app!(answer=true)
+        @options[:preload_app] = answer
+      end
     end
   end
 end

data/lib/puma/const.rb

@@ -28,7 +28,7 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.1.1".freeze
+    PUMA_VERSION = VERSION = "2.2.0".freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 

data/lib/puma/server.rb

@@ -68,10 +68,12 @@ module Puma
 
       @first_data_timeout = FIRST_DATA_TIMEOUT
 
+      @leak_stack_on_error = true
+
       ENV['RACK_ENV'] ||= "development"
     end
 
-    attr_accessor :binder
+    attr_accessor :binder, :leak_stack_on_error
 
     forward :add_tcp_listener,  :@binder
     forward :add_ssl_listener,  :@binder
@@ -379,7 +381,7 @@ module Puma
 
             return :async
           end
-        rescue => e
+        rescue StandardError => e
           @events.unknown_error self, e, "Rack app"
 
           status, headers, res_body = lowlevel_error(e)
@@ -571,7 +573,11 @@ module Puma
     # A fallback rack response if +@app+ raises as exception.
     #
     def lowlevel_error(e)
-      [500, {}, ["Puma caught this error: #{e}\n#{e.backtrace.join("\n")}"]]
+      if @leak_stack_on_error
+        [500, {}, ["Puma caught this error: #{e.message} (#{e.class})\n#{e.backtrace.join("\n")}"]]
+      else
+        [500, {}, ["A really lowlevel plumbing error occured. Please contact your local Maytag(tm) repair man.\n"]]
+      end
     end
 
     # Wait for all outstanding requests to finish.

data/puma.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "puma"
-  s.version = "2.1.1"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Phoenix"]
-  s.date = "2013-06-20"
+  s.date = "2013-07-02"
   s.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 you use a  Ruby implementation with real threads like Rubinius or JRuby."
   s.email = ["evan@phx.io"]
   s.executables = ["puma", "pumactl"]

data/test/test_puma_server.rb

@@ -204,4 +204,21 @@ class TestPumaServer < Test::Unit::TestCase
 
     assert_equal "HTTP/1.0 200 OK\r\n\r\n", data
   end
+
+  def test_doesnt_print_backtrace_in_production
+    @events = Puma::Events.strings
+    @server = Puma::Server.new @app, @events
+
+    @server.app = proc { |e| raise "don't leak me bro" }
+    @server.leak_stack_on_error = false
+    @server.add_tcp_listener @host, @port
+    @server.run
+
+    sock = TCPSocket.new @host, @port
+    sock << "GET / HTTP/1.0\r\n\r\n"
+
+    data = sock.read
+
+    assert_not_match(/don't leak me bro/, data)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack