unicorn 0.96.1 → 0.97.0

data/.gitignore

@@ -1,3 +1,4 @@
+*.o
 *.bundle
 *.log
 *.so

data/Documentation/unicorn_rails.1.txt

@@ -4,7 +4,7 @@
 
 # NAME
 
-unicorn_rails - a rackup-like command to launch the Unicorn HTTP server
+unicorn_rails - a script/server-like command to launch the Unicorn HTTP server
 
 # SYNOPSIS
 
@@ -16,6 +16,11 @@ A rackup(1)-like command to launch Rails applications using Unicorn.  It
 is expected to be started in your Rails application root (RAILS_ROOT),
 but the "working_directory" directive may be used in the CONFIG_FILE.
 
+It is designed to help Rails 1.x and 2.y users transition to Rack, but
+it is NOT needed for Rails 3 applications.  Rails 3 users are encouraged
+to use unicorn(1) instead of unicorn_rails(1).  Users of Rails 1.x/2.y
+may also use unicorn(1) instead of unicorn_rails(1).
+
 The outward interface resembles rackup(1), the internals and default
 middleware loading is designed like the `script/server` command
 distributed with Rails.

data/FAQ

@@ -1,5 +1,12 @@
 = Frequently Asked Questions about Unicorn
 
+===  I've installed Rack 1.1.x, why can't Unicorn load Rails?
+
+Rails 2.3.5 is not compatible with Rack 1.1.x.  Unicorn is compatible
+with both Rack 1.1.x and Rack 1.0.x, and RubyGems will load the latest
+version of Rack installed on the system.  Uninstalling the Rack 1.1.x
+gem should solve gem loading issues with Rails 2.3.x.
+
 === Why are my redirects going to "http" URLs when my site uses https?
 
 If your site is entirely behind https, then Rack applications that use

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v0.96.1.GIT
+DEF_VER=v0.97.0.GIT
 
 LF='
 '

data/GNUmakefile

@@ -1,17 +1,13 @@
 # use GNU Make to run tests in parallel, and without depending on RubyGems
 all:: test
 
-ruby = ruby
-rake = rake
-ragel = ragel
-
 GIT_URL = git://git.bogomips.org/unicorn.git
 RLFLAGS = -G2
 
 # lower-case vars are deprecated
-RUBY = $(ruby)
-RAKE = $(rake)
-RAGEL = $(ragel)
+RUBY = ruby
+RAKE = rake
+RAGEL = ragel
 
 GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
 	@./GIT-VERSION-GEN
@@ -62,6 +58,7 @@ lib/unicorn_http.$(DLEXT): $(ext)/unicorn_http.$(DLEXT)
 	install -m644 $< $@
 http: lib/unicorn_http.$(DLEXT)
 
+test-install: $(test_prefix)/.stamp
 $(test_prefix)/.stamp: $(inst_deps)
 	mkdir -p $(test_prefix)/.ccache
 	tar cf - $(inst_deps) GIT-VERSION-GEN | \
@@ -163,7 +160,7 @@ NEWS: GIT-VERSION-FILE .manifest
 	$(RAKE) -s news_rdoc > $@+
 	mv $@+ $@
 
-SINCE = 0.95.0
+SINCE = 0.96.0
 ChangeLog: LOG_VERSION = \
   $(shell git rev-parse -q "$(GIT_VERSION)" >/dev/null 2>&1 && \
           echo $(GIT_VERSION) || git describe)
@@ -286,3 +283,4 @@ gem install-gem: GIT-VERSION-FILE
 endif
 
 .PHONY: .FORCE-GIT-VERSION-FILE doc $(T) $(slow_tests) manifest man
+.PHONY: test-install

data/KNOWN_ISSUES

@@ -3,6 +3,14 @@
 Occasionally odd {issues}[link:ISSUES.html] arise without a transparent or
 acceptable solution.  Those issues are documented here.
 
+* When using "preload_app true", with apps using background threads
+  need to restart them in the after_fork hook because threads are never
+  shared with child processes.  Additionally, any synchronization
+  primitives (Mutexes, Monitors, ConditionVariables) should be
+  reinitialized in case they are held during fork time to avoid
+  deadlocks.  The core Ruby Logger class needlessly uses a MonitorMutex
+  which can be disabled with a {monkey patch}[link:examples/logger_mp_safe.rb]
+
 * Rails 2.3.2 bundles its own version of Rack.  This may cause subtle
   bugs when simultaneously loaded with the system-wide Rack Rubygem
   which Unicorn depends on.  Upgrading to Rails 2.3.4 (or later) is

data/Rakefile

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+autoload :Gem, 'rubygems'
 
 # most tasks are in the GNUmakefile which offers better parallelism
 
@@ -94,8 +95,6 @@ end
 
 desc "print release notes for Rubyforge"
 task :release_notes do
-  require 'rubygems'
-
   spec = Gem::Specification.load('unicorn.gemspec')
   puts spec.description.strip
   puts ""
@@ -110,7 +109,6 @@ end
 
 desc "post to RAA"
 task :raa_update do
-  require 'rubygems'
   require 'net/http'
   require 'net/netrc'
   rc = Net::Netrc.locate('unicorn-raa') or abort "~/.netrc not found"
@@ -177,7 +175,6 @@ end
 
 # optional rake-compiler support in case somebody needs to cross compile
 begin
-  require 'rubygems'
   spec = Gem::Specification.load('unicorn.gemspec')
   require 'rake/extensiontask'
   unless test ?r, "ext/unicorn_http/unicorn_http.c"

data/TODO

@@ -1,10 +1,5 @@
 * Documentation improvements
 
-* ensure test suite passes on non-GNU/Linux systems
-  (likely that it already does)
-
-* fix const-correctness in HTTP parser
-
 * performance validation (esp. TeeInput)
 
-* improve test suite (steal from Rainbows!, probably...)
+* improve test suite

data/bin/unicorn

@@ -108,52 +108,14 @@ opts = OptionParser.new("", 24, '  ') do |opts|
   opts.parse! ARGV
 end
 
-config = ARGV[0] || "config.ru"
-abort "configuration file #{config} not found" unless File.exist?(config)
-
-if config =~ /\.ru$/
-  # parse embedded command-line options in config.ru comments
-  if File.open(config, "rb") { |fp| fp.sysread(fp.stat.size) } =~ /^#\\(.*)/
-    opts.parse! $1.split(/\s+/)
-  end
-end
-
-require 'pp' if $DEBUG
-
-app = lambda do ||
-  # require Rack as late as possible in case $LOAD_PATH is modified
-  # in config.ru or command-line
-  inner_app = case config
-  when /\.ru$/
-    raw = File.open(config, "rb") { |fp| fp.sysread(fp.stat.size) }
-    raw.sub!(/^__END__\n.*/, '')
-    eval("Rack::Builder.new {(#{raw}\n)}.to_app", nil, config)
-  else
-    require config
-    Object.const_get(File.basename(config, '.rb').capitalize)
-  end
-  pp({ :inner_app => inner_app }) if $DEBUG
-  case ENV["RACK_ENV"]
-  when "development"
-    Rack::Builder.new do
-      use Rack::CommonLogger, $stderr
-      use Rack::ShowExceptions
-      use Rack::Lint
-      run inner_app
-    end.to_app
-  when "deployment"
-    Rack::Builder.new do
-      use Rack::CommonLogger, $stderr
-      run inner_app
-    end.to_app
-  else
-    inner_app
-  end
-end
+ru = ARGV[0] || "config.ru"
+abort "configuration file #{ru} not found" unless File.exist?(ru)
 
+app = Unicorn.builder(ru, opts)
 listeners << "#{host}:#{port}" if set_listener
 
 if $DEBUG
+  require 'pp'
   pp({
     :unicorn_options => options,
     :app => app,

data/bin/unicorn_rails

@@ -4,8 +4,6 @@ require 'unicorn/launcher'
 require 'optparse'
 require 'fileutils'
 
-rails_pid = "#{Unicorn::HttpServer::START_CTX[:cwd]}/tmp/pids/unicorn.pid"
-cmd = File.basename($0)
 daemonize = false
 listeners = []
 options = { :listeners => listeners }
@@ -14,6 +12,7 @@ set_listener = false
 ENV['RAILS_ENV'] ||= "development"
 
 opts = OptionParser.new("", 24, '  ') do |opts|
+  cmd = File.basename($0)
   opts.banner = "Usage: #{cmd} " \
                 "[ruby options] [#{cmd} options] [rackup config file]"
   opts.separator "Ruby options:"
@@ -111,83 +110,81 @@ end
 
 config = ARGV[0] || (File.exist?('config.ru') ? 'config.ru' : nil)
 
-if config && config =~ /\.ru$/
+if config && config =~ /\.ru\z/
   # parse embedded command-line options in config.ru comments
-  if File.open(config, "rb") { |fp| fp.sysread(fp.stat.size) } =~ /^#\\(.*)/
-    opts.parse! $1.split(/\s+/)
-  end
+  /^#\\(.*)/ =~ File.read(config) and opts.parse!($1.split(/\s+/))
 end
 
-require 'pp' if $DEBUG
-
-# this won't run until after forking if preload_app is false
-app = lambda do ||
-  # Load Rails and the private version of Rack it bundles.
-  begin
-    require 'config/boot'
-  rescue LoadError => err
-    abort "#$0 must be run inside RAILS_ROOT: #{err.inspect}"
-  end
-  defined?(::RAILS_ROOT) or abort "RAILS_ROOT not defined by config/boot"
-  defined?(::RAILS_ENV) or abort "RAILS_ENV not defined by config/boot"
-  defined?(::Rails::VERSION::STRING) or
-    abort "Rails::VERSION::STRING not defined by config/boot"
-
-  inner_app = case config
-  when nil
-    require 'config/environment'
-
-    # it seems Rails >=2.2 support Rack, but only >=2.3 requires it
-    old_rails = case ::Rails::VERSION::MAJOR
-    when 0, 1 then true
-    when 2 then Rails::VERSION::MINOR < 3 ? true : false
-    else
-      false
+def rails_builder(config, daemonize)
+  # this lambda won't run until after forking if preload_app is false
+  lambda do ||
+    # Load Rails and (possibly) the private version of Rack it bundles.
+    begin
+      require 'config/boot'
+    rescue LoadError => err
+      abort "#$0 must be run inside RAILS_ROOT: #{err.inspect}"
     end
 
-    if old_rails
-      require 'unicorn/app/old_rails'
-      Unicorn::App::OldRails.new
-    else
-      ActionController::Dispatcher.new
-    end
-  when /\.ru$/
-    raw = File.open(config, "rb") { |fp| fp.sysread(fp.stat.size) }
-    raw.sub!(/^__END__\n.*/, '')
-    eval("Rack::Builder.new {(#{raw}\n)}.to_app", nil, config)
-  else
-    require config
-    Object.const_get(File.basename(config, '.rb').capitalize)
-  end
-
-  Rack::Builder.new do
-    map_path = ENV['RAILS_RELATIVE_URL_ROOT'] || '/'
-    if inner_app.class.to_s == "Unicorn::App::OldRails"
-      if map_path != '/'
-        # patches + tests welcome, but I really cbf to deal with this
-        # since all apps I've ever dealt with just use "/" ...
-        $stderr.puts "relative URL roots may not work for older Rails"
+    inner_app = case config
+    when nil
+      require 'config/environment'
+
+      defined?(::Rails::VERSION::STRING) or
+        abort "Rails::VERSION::STRING not defined by config/{boot,environment}"
+      # it seems Rails >=2.2 support Rack, but only >=2.3 requires it
+      old_rails = case ::Rails::VERSION::MAJOR
+      when 0, 1 then true
+      when 2 then Rails::VERSION::MINOR < 3 ? true : false
+      else
+        false
       end
-      $stderr.puts "LogTailer not available for Rails < 2.3" unless daemonize
-      $stderr.puts "Debugger not available" if $DEBUG
-      map(map_path) do
-        use Unicorn::App::OldRails::Static
-        run inner_app
+
+      if old_rails
+        require 'unicorn/app/old_rails'
+        Unicorn::App::OldRails.new
+      else
+        ActionController::Dispatcher.new
       end
+    when /\.ru$/
+      raw = File.open(config, "rb") { |fp| fp.sysread(fp.stat.size) }
+      raw.sub!(/^__END__\n.*/, '')
+      eval("Rack::Builder.new {(#{raw}\n)}.to_app", nil, config)
     else
-      use Rails::Rack::LogTailer unless daemonize
-      use Rails::Rack::Debugger if $DEBUG
-      map(map_path) do
-        use Rails::Rack::Static
-        run inner_app
-      end
+      require config
+      Object.const_get(File.basename(config, '.rb').capitalize)
     end
-  end.to_app
+
+    Rack::Builder.new do
+      map_path = ENV['RAILS_RELATIVE_URL_ROOT'] || '/'
+      if inner_app.class.to_s == "Unicorn::App::OldRails"
+        if map_path != '/'
+          # patches + tests welcome, but I really cbf to deal with this
+          # since all apps I've ever dealt with just use "/" ...
+          $stderr.puts "relative URL roots may not work for older Rails"
+        end
+        $stderr.puts "LogTailer not available for Rails < 2.3" unless daemonize
+        $stderr.puts "Debugger not available" if $DEBUG
+        map(map_path) do
+          use Unicorn::App::OldRails::Static
+          run inner_app
+        end
+      else
+        use Rails::Rack::LogTailer unless daemonize
+        use Rails::Rack::Debugger if $DEBUG
+        map(map_path) do
+          use Rails::Rack::Static
+          run inner_app
+        end
+      end
+    end.to_app
+  end
 end
 
+app = rails_builder(config, daemonize)
 listeners << "#{host}:#{port}" if set_listener
 
 if $DEBUG
+  require 'pp'
   pp({
     :unicorn_options => options,
     :app => app,
@@ -196,12 +193,12 @@ if $DEBUG
 end
 
 # ensure Rails standard tmp paths exist
-%w(cache pids sessions sockets).each do |dir|
-  FileUtils.mkdir_p("tmp/#{dir}")
+options[:after_reload] = lambda do
+  FileUtils.mkdir_p(%w(cache pids sessions sockets).map! { |d| "tmp/#{d}" })
 end
 
 if daemonize
-  options[:pid] = rails_pid
+  options[:pid] = "tmp/pids/unicorn.pid"
   Unicorn::Launcher.daemonize!(options)
 end
 Unicorn.run(app, options)

data/examples/init.sh

@@ -8,6 +8,8 @@ APP_ROOT=/home/x/my_app/current
 PID=$APP_ROOT/tmp/pids/unicorn.pid
 CMD="/usr/bin/unicorn -D -c $APP_ROOT/config/unicorn.rb"
 INIT_CONF=$APP_ROOT/config/init.conf
+action="$1"
+set -u
 
 test -f "$INIT_CONF" && . $INIT_CONF
 
@@ -23,7 +25,7 @@ oldsig () {
 	test -s $old_pid && kill -$1 `cat $old_pid`
 }
 
-case $1 in
+case $action in
 start)
 	sig 0 && echo >&2 "Already running" && exit 0
 	$CMD
@@ -46,8 +48,11 @@ upgrade)
 	echo >&2 "Couldn't upgrade, starting '$CMD' instead"
 	$CMD
 	;;
+reopen-logs)
+	sig USR1
+	;;
 *)
-	echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop>"
+	echo >&2 "Usage: $0 <start|stop|restart|upgrade|force-stop|reopen-logs>"
 	exit 1
 	;;
 esac

data/examples/logger_mp_safe.rb

@@ -0,0 +1,25 @@
+# Multi-Processing-safe monkey patch for Logger
+#
+# This monkey patch fixes the case where "preload_app true" is used and
+# the application spawns a background thread upon being loaded.
+#
+# This removes all lock from the Logger code and solely relies on the
+# underlying filesystem to handle write(2) system calls atomically when
+# O_APPEND is used.  This is safe in the presence of both multiple
+# threads (native or green) and multiple processes when writing to
+# a filesystem with POSIX O_APPEND semantics.
+#
+# It should be noted that the original locking on Logger could _never_ be
+# considered reliable on non-POSIX filesystems with multiple processes,
+# either, so nothing is lost in that case.
+
+require 'logger'
+class Logger::LogDevice
+  def write(message)
+    @dev.syswrite(message)
+  end
+
+  def close
+    @dev.close
+  end
+end

data/ext/unicorn_http/CFLAGS

@@ -0,0 +1,13 @@
+# CFLAGS used for development (gcc-dependent)
+# source this file if you want/need them
+CFLAGS=
+CFLAGS="$CFLAGS -Wall"
+CFLAGS="$CFLAGS -Wwrite-strings"
+CFLAGS="$CFLAGS -Wdeclaration-after-statement"
+CFLAGS="$CFLAGS -Wcast-qual"
+CFLAGS="$CFLAGS -Wstrict-prototypes"
+CFLAGS="$CFLAGS -Wshadow"
+CFLAGS="$CFLAGS -Wextra"
+CFLAGS="$CFLAGS -Wno-deprecated-declarations"
+CFLAGS="$CFLAGS -Waggregate-return"
+CFLAGS="$CFLAGS -Wchar-subscripts"