puma 2.0.0.b4-java → 2.0.0.b7-java

data/lib/puma/server.rb

@@ -11,6 +11,7 @@ require 'puma/client'
 require 'puma/binder'
 require 'puma/delegation'
 require 'puma/accept_nonblock'
+require 'puma/util'
 
 require 'puma/puma_http11'
 
@@ -49,7 +50,7 @@ module Puma
       @app = app
       @events = events
 
-      @check, @notify = IO.pipe
+      @check, @notify = Puma::Util.pipe
 
       @status = :stop
 
@@ -61,9 +62,10 @@ module Puma
       @thread_pool = nil
 
       @persistent_timeout = PERSISTENT_TIMEOUT
-      @persistent_check, @persistent_wakeup = IO.pipe
 
       @binder = Binder.new(events)
+      @own_binder = true
+
       @first_data_timeout = FIRST_DATA_TIMEOUT
 
       ENV['RACK_ENV'] ||= "development"
@@ -75,6 +77,11 @@ module Puma
     forward :add_ssl_listener,  :@binder
     forward :add_unix_listener, :@binder
 
+    def inherit_binder(bind)
+      @binder = bind
+      @own_binder = false
+    end
+
     # On Linux, use TCP_CORK to better control how the TCP stack
     # packetizes our stream. This improves both latency and throughput.
     #
@@ -190,9 +197,14 @@ module Puma
         @reactor.clear! if @status == :restart
 
         @reactor.shutdown
+      rescue Exception => e
+        STDERR.puts "Exception handling servers: #{e.message} (#{e.class})"
+        STDERR.puts e.backtrace
       ensure
-        unless @status == :restart
-          @check.close
+        @check.close
+        @notify.close
+
+        if @status != :restart and @own_binder
           @binder.close
         end
       end
@@ -285,11 +297,11 @@ module Puma
           env[SERVER_PORT] = host[colon+1, host.bytesize]
         else
           env[SERVER_NAME] = host
-          env[SERVER_PORT] = PORT_80
+          env[SERVER_PORT] = default_server_port(env)
         end
       else
         env[SERVER_NAME] = LOCALHOST
-        env[SERVER_PORT] = PORT_80
+        env[SERVER_PORT] = default_server_port(env)
       end
 
       unless env[REQUEST_PATH]
@@ -313,6 +325,10 @@ module Puma
       env[REMOTE_ADDR] = client.peeraddr.last
     end
 
+    def default_server_port(env)
+      env['HTTP_X_FORWARDED_PROTO'] == 'https' ? PORT_443 : PORT_80
+    end
+
     # Given the request +env+ from +client+ and a partial request body
     # in +body+, finish reading the body if there is one and invoke
     # the rack app. Then construct the response and write it back to
@@ -330,6 +346,9 @@ module Puma
 
       env[PUMA_SOCKET] = client
 
+      env[HIJACK_P] = true
+      env[HIJACK] = req
+
       body = req.body
 
       env[RACK_INPUT] = body
@@ -343,6 +362,9 @@ module Puma
       begin
         begin
           status, headers, res_body = @app.call(env)
+
+          return :async if req.hijacked
+
           status = status.to_i
 
           if status == -1
@@ -404,6 +426,8 @@ module Puma
           end
         end
 
+        response_hijack = nil
+
         headers.each do |k, vs|
           case k
           when CONTENT_LENGTH2
@@ -414,6 +438,9 @@ module Puma
             content_length = nil
           when CONTENT_TYPE
             next if no_body
+          when HIJACK
+            response_hijack = vs
+            next
           end
 
           vs.split(NEWLINE).each do |v|
@@ -433,18 +460,25 @@ module Puma
           lines << CONNECTION_CLOSE
         end
 
-        if content_length
-          lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
-          chunked = false
-        elsif allow_chunked
-          lines << TRANSFER_ENCODING_CHUNKED
-          chunked = true
+        unless response_hijack
+          if content_length
+            lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
+            chunked = false
+          elsif allow_chunked
+            lines << TRANSFER_ENCODING_CHUNKED
+            chunked = true
+          end
         end
 
         lines << line_ending
 
         fast_write client, lines.to_s
 
+        if response_hijack
+          response_hijack.call client
+          return :async
+        end
+
         res_body.each do |part|
           if chunked
             client.syswrite part.bytesize.to_s(16)
@@ -545,38 +579,33 @@ module Puma
     # off the request queue before finally exiting.
     #
     def stop(sync=false)
-      @persistent_wakeup.close
       @notify << STOP_COMMAND
 
       @thread.join if @thread && sync
     end
 
     def halt(sync=false)
-      @persistent_wakeup.close
       @notify << HALT_COMMAND
 
       @thread.join if @thread && sync
     end
 
     def begin_restart
-      @persistent_wakeup.close
       @notify << RESTART_COMMAND
     end
 
     def fast_write(io, str)
-      n = io.syswrite str
-
-      # Fast path.
-      return if n == str.bytesize
-
-      pos = n
-      left = str.bytesize - n
-
-      until left == 0
-       n = io.syswrite str.byteslice(pos..-1)
+      n = 0
+      while true
+        begin
+          n = io.syswrite str
+        rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+          IO.select(nil, [io], nil, 1)
+          retry
+        end
 
-       pos += n
-       left -= n
+        return if n == str.bytesize
+        str = str.byteslice(n..-1)
       end
     end
     private :fast_write

data/lib/puma/util.rb

@@ -0,0 +1,9 @@
+module Puma
+  module Util
+    module_function
+
+    def pipe
+      IO.pipe
+    end
+  end
+end

data/puma.gemspec

@@ -2,23 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = "puma"
-  s.version = "2.0.0.b4"
+  s.version = "2.0.0.b7"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Phoenix"]
-  s.date = "2012-12-13"
+  s.date = "2013-03-19"
   s.description = "Puma is a simple, fast, and highly concurrent HTTP 1.1 server for Ruby web applications. It can be used with any application that supports Rack, and is considered the replacement for Webrick and Mongrel. It was designed to be the go-to server for [Rubinius](http://rubini.us), but also works well with JRuby and MRI. Puma is intended for use in both development and production environments.\n\nUnder the hood, Puma processes requests using a C-optimized Ragel extension (inherited from Mongrel) that provides fast, accurate HTTP 1.1 protocol parsing in a portable way. Puma then serves the request in a thread from an internal thread pool (which you can control). This allows Puma to provide real concurrency for your web application!\n\nWith Rubinius 2.0, Puma will utilize all cores on your CPU with real threads, meaning you won't have to spawn multiple processes to increase throughput. You can expect to see a similar benefit from JRuby.\n\nOn MRI, there is a Global Interpreter Lock (GIL) that ensures only one thread can be run at a time. But if you're doing a lot of blocking IO (such as HTTP calls to external APIs like Twitter), Puma still improves MRI's throughput by allowing blocking IO to be run concurrently (EventMachine-based servers such as Thin turn off this ability, requiring you to use special libraries). Your mileage may vary. In order to get the best throughput, it is highly recommended that you use a Ruby implementation with real threads like [Rubinius](http://rubini.us) or [JRuby](http://jruby.org)."
   s.email = ["evan@phx.io"]
   s.executables = ["puma", "pumactl"]
   s.extensions = ["ext/puma_http11/extconf.rb"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
-  s.files = ["COPYING", "Gemfile", "History.txt", "LICENSE", "Manifest.txt", "README.md", "Rakefile", "TODO", "bin/puma", "bin/pumactl", "docs/config.md", "docs/nginx.md", "ext/puma_http11/PumaHttp11Service.java", "ext/puma_http11/ext_help.h", "ext/puma_http11/extconf.rb", "ext/puma_http11/http11_parser.c", "ext/puma_http11/http11_parser.h", "ext/puma_http11/http11_parser.java.rl", "ext/puma_http11/http11_parser.rl", "ext/puma_http11/http11_parser_common.rl", "ext/puma_http11/io_buffer.c", "ext/puma_http11/mini_ssl.c", "ext/puma_http11/org/jruby/puma/Http11.java", "ext/puma_http11/org/jruby/puma/Http11Parser.java", "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/capistrano.rb", "lib/puma/cli.rb", "lib/puma/client.rb", "lib/puma/compat.rb", "lib/puma/configuration.rb", "lib/puma/const.rb", "lib/puma/control_cli.rb", "lib/puma/daemon_ext.rb", "lib/puma/delegation.rb", "lib/puma/detect.rb", "lib/puma/events.rb", "lib/puma/io_buffer.rb", "lib/puma/java_io_buffer.rb", "lib/puma/jruby_restart.rb", "lib/puma/minissl.rb", "lib/puma/null_io.rb", "lib/puma/rack_patch.rb", "lib/puma/reactor.rb", "lib/puma/server.rb", "lib/puma/thread_pool.rb", "lib/rack/handler/puma.rb", "puma.gemspec", "tools/jungle/README.md", "tools/jungle/puma", "tools/jungle/run-puma", "test/test_app_status.rb", "test/test_cli.rb", "test/test_config.rb", "test/test_http10.rb", "test/test_http11.rb", "test/test_integration.rb", "test/test_iobuffer.rb", "test/test_minissl.rb", "test/test_null_io.rb", "test/test_persistent.rb", "test/test_puma_server.rb", "test/test_rack_handler.rb", "test/test_rack_server.rb", "test/test_thread_pool.rb", "test/test_unix_socket.rb", "test/test_ws.rb"]
+  s.files = ["COPYING", "Gemfile", "History.txt", "LICENSE", "Manifest.txt", "README.md", "Rakefile", "TODO", "bin/puma", "bin/pumactl", "docs/config.md", "docs/nginx.md", "ext/puma_http11/PumaHttp11Service.java", "ext/puma_http11/ext_help.h", "ext/puma_http11/extconf.rb", "ext/puma_http11/http11_parser.c", "ext/puma_http11/http11_parser.h", "ext/puma_http11/http11_parser.java.rl", "ext/puma_http11/http11_parser.rl", "ext/puma_http11/http11_parser_common.rl", "ext/puma_http11/io_buffer.c", "ext/puma_http11/mini_ssl.c", "ext/puma_http11/org/jruby/puma/Http11.java", "ext/puma_http11/org/jruby/puma/Http11Parser.java", "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/capistrano.rb", "lib/puma/cli.rb", "lib/puma/client.rb", "lib/puma/compat.rb", "lib/puma/configuration.rb", "lib/puma/const.rb", "lib/puma/control_cli.rb", "lib/puma/daemon_ext.rb", "lib/puma/delegation.rb", "lib/puma/detect.rb", "lib/puma/events.rb", "lib/puma/io_buffer.rb", "lib/puma/java_io_buffer.rb", "lib/puma/jruby_restart.rb", "lib/puma/minissl.rb", "lib/puma/null_io.rb", "lib/puma/rack_default.rb", "lib/puma/rack_patch.rb", "lib/puma/reactor.rb", "lib/puma/server.rb", "lib/puma/thread_pool.rb", "lib/puma/util.rb", "lib/rack/handler/puma.rb", "puma.gemspec", "tools/jungle/init.d/README.md", "tools/jungle/init.d/puma", "tools/jungle/init.d/run-puma", "tools/jungle/upstart/README.md", "tools/jungle/upstart/puma-manager.conf", "tools/jungle/upstart/puma.conf", "test/test_app_status.rb", "test/test_cli.rb", "test/test_config.rb", "test/test_http10.rb", "test/test_http11.rb", "test/test_integration.rb", "test/test_iobuffer.rb", "test/test_minissl.rb", "test/test_null_io.rb", "test/test_persistent.rb", "test/test_puma_server.rb", "test/test_rack_handler.rb", "test/test_rack_server.rb", "test/test_thread_pool.rb", "test/test_unix_socket.rb", "test/test_ws.rb"]
   s.homepage = "http://puma.io"
   s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
   s.rubyforge_project = "puma"
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "Puma is a simple, fast, and highly concurrent HTTP 1.1 server for Ruby web applications"
   s.test_files = ["test/test_app_status.rb", "test/test_cli.rb", "test/test_config.rb", "test/test_http10.rb", "test/test_http11.rb", "test/test_integration.rb", "test/test_iobuffer.rb", "test/test_minissl.rb", "test/test_null_io.rb", "test/test_persistent.rb", "test/test_puma_server.rb", "test/test_rack_handler.rb", "test/test_rack_server.rb", "test/test_thread_pool.rb", "test/test_unix_socket.rb", "test/test_ws.rb"]
 
@@ -26,20 +26,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rack>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<rack>, ["< 2.0", ">= 1.1"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.10"])
       s.add_development_dependency(%q<rake-compiler>, ["~> 0.8.0"])
-      s.add_development_dependency(%q<hoe>, ["~> 3.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.5"])
     else
-      s.add_dependency(%q<rack>, ["~> 1.2"])
+      s.add_dependency(%q<rack>, ["< 2.0", ">= 1.1"])
       s.add_dependency(%q<rdoc>, ["~> 3.10"])
       s.add_dependency(%q<rake-compiler>, ["~> 0.8.0"])
-      s.add_dependency(%q<hoe>, ["~> 3.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.5"])
     end
   else
-    s.add_dependency(%q<rack>, ["~> 1.2"])
+    s.add_dependency(%q<rack>, ["< 2.0", ">= 1.1"])
     s.add_dependency(%q<rdoc>, ["~> 3.10"])
     s.add_dependency(%q<rake-compiler>, ["~> 0.8.0"])
-    s.add_dependency(%q<hoe>, ["~> 3.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.5"])
   end
 end

data/test/test_config.rb

@@ -11,6 +11,6 @@ class TestConfigFile < Test::Unit::TestCase
 
     app = conf.app
 
-    assert_equal [200, {}, ["embedded app"]], app.call(nil)
+    assert_equal [200, {}, ["embedded app"]], app.call({})
   end
 end

data/test/test_minissl.rb

@@ -1,5 +1,7 @@
 require 'test/unit'
 
+unless defined? JRUBY_VERSION
+
 require 'puma'
 require 'puma/minissl'
 
@@ -10,13 +12,14 @@ class TestMiniSSL < Test::Unit::TestCase
 
     exception = assert_raise(ArgumentError) { ctx.key = "/no/such/key" }
     assert_equal("No such key file '/no/such/key'", exception.message)
-  end unless defined? JRUBY_VERSION
+  end
 
   def test_raises_with_invalid_cert_file
     ctx = Puma::MiniSSL::Context.new
 
     exception = assert_raise(ArgumentError) { ctx.cert = "/no/such/cert" }
     assert_equal("No such cert file '/no/such/cert'", exception.message)
-  end unless defined? JRUBY_VERSION
+  end
+end
 
 end

data/test/test_puma_server.rb

@@ -125,4 +125,41 @@ class TestPumaServer < Test::Unit::TestCase
 
     assert_equal giant.bytesize, out.bytesize
   end
+
+  def test_respect_x_forwarded_proto
+    @server.app = proc do |env|
+      [200, {}, [env['SERVER_PORT']]]
+    end
+
+    @server.add_tcp_listener @host, @port
+    @server.run
+
+    req = Net::HTTP::Get.new("/")
+    req['HOST'] = "example.com"
+    req['X_FORWARDED_PROTO'] = "https"
+
+    res = Net::HTTP.start @host, @port do |http|
+      http.request(req)
+    end
+
+    assert_equal "443", res.body
+  end
+
+  def test_default_server_port
+    @server.app = proc do |env|
+      [200, {}, [env['SERVER_PORT']]]
+    end
+
+    @server.add_tcp_listener @host, @port
+    @server.run
+
+    req = Net::HTTP::Get.new("/")
+    req['HOST'] = "example.com"
+
+    res = Net::HTTP.start @host, @port do |http|
+      http.request(req)
+    end
+
+    assert_equal "80", res.body
+  end
 end

data/tools/jungle/upstart/README.md

@@ -0,0 +1,61 @@
+# 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/tools/jungle/upstart/puma-manager.conf

@@ -0,0 +1,31 @@
+# /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 workers" to stop all Puma instances.
+# Use "start workers" to start all instances.
+# Use "restart workers" 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/tools/jungle/upstart/puma.conf

@@ -0,0 +1,52 @@
+# /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 workers.conf for how to manage all Puma instances at once.
+#
+# Save this config as /etc/init/puma.conf then mange puma with:
+#   sudo start puma index=0
+#   sudo stop puma index=0
+#   sudo status puma index=0
+#
+# 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
+exec /bin/bash <<EOT
+  export HOME=/home/apps
+  
+  # Pick your poison :) Or none if you're using a system wide installed Ruby.
+  # rbenv
+  # source /home/apps/.bash_profile
+  # OR
+  # source /home/apps/.profile
+  #
+  # rvm
+  # source /home/apps/.rvm/scripts/rvm
+
+  logger -t puma "Starting server: $app"
+
+  cd $app
+  exec bundle exec puma -C config/puma.rb
+EOT
+end script