puma 2.0.0.b5 → 2.0.0.b6

data/History.txt

@@ -1,3 +1,14 @@
+=== 2.0.0.b6 / 2013-02-06
+
+* 2 minor enhancements:
+
+  * Add hook for running when a worker boots
+  * Advertise the Configuration object for apps to use.
+
+* 1 bug fix:
+
+  * Change directory in working during upgrade. Fixes #185
+
 === 2.0.0.b5 / 2013-02-05
 
 * 2 major features:

data/lib/puma/cli.rb

@@ -63,6 +63,7 @@ module Puma
 
         if s_env.ino == s_pwd.ino and s_env.dev == s_pwd.dev
           @restart_dir = dir
+          @options[:worker_directory] = dir
         end
       end
 
@@ -171,6 +172,7 @@ module Puma
         :binds => [],
         :workers => 0,
         :daemon => false,
+        :worker_boot => [],
         :environment => "development"
       }
 
@@ -208,6 +210,7 @@ module Puma
 
         o.on "--dir DIR", "Change to DIR before starting" do |d|
           @options[:directory] = d.to_s
+          @options[:worker_directory] = d.to_s
         end
 
         o.on "-e", "--environment ENVIRONMENT",
@@ -325,6 +328,10 @@ module Puma
       end
 
       @config = Puma::Configuration.new @options
+
+      # Advertise the Configuration
+      Puma.cli_config = @config
+
       @config.load
     end
 
@@ -481,7 +488,7 @@ module Puma
       end
     end
 
-    def worker
+    def worker(upgrade)
       $0 = "puma: cluster worker: #{@master_pid}"
       Signal.trap "SIGINT", "IGNORE"
 
@@ -490,10 +497,24 @@ module Puma
 
       Thread.new do
         IO.select [@check_pipe]
-        log "! Detected parent died, dieing"
+        log "! Detected parent died, dying"
         exit! 1
       end
 
+      # Be sure to change the directory again before loading
+      # the app. This way we can pick up new code.
+      if upgrade
+        if dir = @options[:worker_directory]
+          log "+ Changing to #{dir}"
+          Dir.chdir dir
+        end
+      end
+
+      # Invoke any worker boot hooks so they can get
+      # things in shape before booting the app.
+      hooks = @options[:worker_boot]
+      hooks.each { |h| h.call }
+
       min_t = @options[:min_threads]
       max_t = @options[:max_threads]
 
@@ -560,8 +581,10 @@ module Puma
     def spawn_workers
       diff = @options[:workers] - @workers.size
 
+      upgrade = (@phased_state == :waiting)
+
       diff.times do
-        pid = fork { worker }
+        pid = fork { worker(upgrade) }
         debug "Spawned worker: #{pid}"
         @workers << Worker.new(pid, @phase)
       end
@@ -680,7 +703,7 @@ module Puma
 
               if req == "b"
                 pid = read.gets.to_i
-                w = @workers.find { |w| w.pid == pid }
+                w = @workers.find { |x| x.pid == pid }
                 if w
                   w.boot!
                   log "- Worker #{pid} booted, phase: #{w.phase}"

data/lib/puma/configuration.rb

@@ -1,4 +1,14 @@
 module Puma
+
+  # The CLI exports it's Configuration object here to allow
+  # apps to pick it up. An app needs to use it conditionally though
+  # since it is not set if the app is launched via another
+  # mechanism than the CLI class.
+
+  class << self
+    attr_accessor :cli_config
+  end
+
   class Configuration
     DefaultRackup = "config.ru"
 
@@ -44,26 +54,39 @@ module Puma
       end
     end
 
+    # Injects the Configuration object into the env
+    class ConfigMiddleware
+      def initialize(config, app)
+        @config = config
+        @app = app
+      end
+
+      def call(env)
+        env[Const::PUMA_CONFIG] = @config
+        @app.call(env)
+      end
+    end
+
     # Load the specified rackup file, pull an options from
     # the rackup file, and set @app.
     #
     def app
-      if app = @options[:app]
-        return app
-      end
+      app = @options[:app]
 
-      path = @options[:rackup] || DefaultRackup
+      unless app
+        path = @options[:rackup] || DefaultRackup
 
-      unless File.exists?(path)
-        raise "Missing rackup file '#{path}'"
-      end
+        unless File.exists?(path)
+          raise "Missing rackup file '#{path}'"
+        end
 
-      app, options = Rack::Builder.parse_file path
-      @options.merge! options
+        app, options = Rack::Builder.parse_file path
+        @options.merge! options
 
-      options.each do |key,val|
-        if key.to_s[0,4] == "bind"
-          @options[:binds] << val
+        options.each do |key,val|
+          if key.to_s[0,4] == "bind"
+            @options[:binds] << val
+          end
         end
       end
 
@@ -72,7 +95,7 @@ module Puma
         app = Rack::CommonLogger.new(app, logger)
       end
 
-      return app
+      return ConfigMiddleware.new(self, app)
     end
 
     def setup_random_token
@@ -242,6 +265,15 @@ module Puma
         @options[:workers] = count.to_i
       end
 
+      # *Cluster mode only* Code to run when a worker boots to setup
+      # the process before booting the app.
+      #
+      # This can be called multiple times to add hooks.
+      #
+      def on_worker_boot(&block)
+        @options[:worker_boot] << block
+      end
+
       # The directory to operate out of.
       def directory(dir)
         @options[:directory] = dir.to_s

data/lib/puma/const.rb

@@ -28,7 +28,7 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.0.0.b5".freeze
+    PUMA_VERSION = VERSION = "2.0.0.b6".freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 
@@ -119,6 +119,7 @@ module Puma
     RACK_URL_SCHEME = "rack.url_scheme".freeze
     RACK_AFTER_REPLY = "rack.after_reply".freeze
     PUMA_SOCKET = "puma.socket".freeze
+    PUMA_CONFIG = "puma.config".freeze
 
     HTTP = "http".freeze
     HTTPS = "https".freeze

data/puma.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "puma"
-  s.version = "2.0.0.b5"
+  s.version = "2.0.0.b6"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Phoenix"]
-  s.date = "2013-02-06"
+  s.date = "2013-02-07"
   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"]

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

metadata

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