rails--rails/railties/guides/source/rails_on_rack.textile

h2. Rails on Rack

This guide covers Rails integration with Rack and interfacing with other Rack components. By referring to this guide, you will be able to:

* Create Rails Metal applications
* Use Rack Middlewares in your Rails applications
* Understand Action Pack's internal Middleware stack
* Define a custom Middleware stack

endprologue.

WARNING: This guide assumes a working knowledge of Rack protocol and Rack concepts such as middlewares, url maps and Rack::Builder.

h3. Introduction to Rack

bq. Rack provides a minimal, modular and adaptable interface for developing web applications in Ruby. By wrapping HTTP requests and responses in the simplest way possible, it unifies and distills the API for web servers, web frameworks, and software in between (the so-called middleware) into a single method call.

- "Rack API Documentation":http://rack.rubyforge.org/doc

Explaining Rack is not really in the scope of this guide. In case you are not familiar with Rack's basics, you should check out the following links:

* "Official Rack Website":http://rack.github.com
* "Introducing Rack":http://chneukirchen.org/blog/archive/2007/02/introducing-rack.html
* "Ruby on Rack #1 - Hello Rack!":http://m.onkey.org/2008/11/17/ruby-on-rack-1
* "Ruby on Rack #2 - The Builder":http://m.onkey.org/2008/11/18/ruby-on-rack-2-rack-builder

h3. Rails on Rack

h4. Rails Application's Rack Object

<tt>ActionController::Dispatcher.new</tt> is the primary Rack application object of a Rails application. Any Rack compliant web server should be using +ActionController::Dispatcher.new+ object to serve a Rails application.</p>

h4. script/server

<tt>script/server</tt> does the basic job of creating a +Rack::Builder+ object and starting the webserver. This is Rails equivalent of Rack's +rackup+ script.

Here's how +script/server+ creates an instance of +Rack::Builder+

<ruby>
app = Rack::Builder.new {
  use Rails::Rack::LogTailer unless options[:detach]
  use Rails::Rack::Debugger if options[:debugger]

  map "/" do
    use Rails::Rack::Static
    run ActionController::Dispatcher.new
  end
}.to_app
</ruby>

Middlewares used in the code above are primarily useful only in the development envrionment. The following table explains their usage:

|Middleware|Purpose|
|Rails::Rack::LogTailer|Appends log file output to console|
|Rails::Rack::Static|Serves static files inside +RAILS_ROOT/public+ directory|
|Rails::Rack::Debugger|Starts Debugger|

h4. rackup

To use +rackup+ instead of Rails' +script/server+, you can put the following inside +config.ru+ of your Rails application's root directory:

<ruby>
# RAILS_ROOT/config.ru
require "config/environment"

use Rails::Rack::LogTailer
use Rails::Rack::Static
run ActionController::Dispatcher.new
</ruby>

And start the server:

<shell>
[lifo@null application]$ rackup
</shell>

To find out more about different +rackup+ options:

<shell>
[lifo@null application]$ rackup --help
</shell>

h3. Action Controller Middleware Stack

Many of Action Controller's internal components are implemented as Rack middlewares. +ActionController::Dispatcher+ uses +ActionController::MiddlewareStack+ to combine various internal and external middlewares to form a complete Rails Rack application.

NOTE: +ActionController::MiddlewareStack+ is Rails equivalent of +Rack::Builder+, but built for better flexibility and more features to meet Rails' requirements.

h4. Inspecting Middleware Stack

Rails has a handy rake task for inspecting the middleware stack in use:

<shell>
$ rake middleware
</shell>

For a freshly generated Rails application, this might produce something like:

<ruby>
use Rack::Lock
use ActionController::Failsafe
use ActionController::Session::CookieStore, , {:secret=>"<secret>", :session_key=>"_<app>_session"}
use Rails::Rack::Metal
use ActionController::RewindableInput
use ActionController::ParamsParser
use Rack::MethodOverride
use Rack::Head
use ActiveRecord::QueryCache
run ActionController::Dispatcher.new
</ruby>

Purpose of each of this middlewares is explained in "Internal Middlewares":#internal-middleware-stack section.

h4. Configuring Middleware Stack

Rails provides a simple configuration interface +config.middleware+ for adding, removing and modifying the middlewares in the middleware stack via +environment.rb+ or the environment specific configuarion file <tt>environments/&lt;environment&gt;.rb</tt>.

h5. Adding a Middleware

You can add a new middleware to the middleware stack using any of the following methods:

* +config.middleware.add(new_middleware, args)+ - Adds the new middleware at the bottom of the middleware stack.

* +config.middleware.insert(index, new_middleware, args)+ - Adds the new middleware at the position specified by +index+ in the middleware stack.

* +config.middleware.insert_before(existing_middleware, new_middleware, args)+ - Adds the new middleware before the specified existing middleware in the middleware stack.

* +config.middleware.insert_after(existing_middleware, new_middleware, args)+ - Adds the new middleware after the specified existing middleware in the middleware stack.

<strong>Example:</strong>

<ruby>
# environment.rb

# Push Rack::BounceFavicon at the bottom
config.middleware.use Rack::BounceFavicon

# Add Lifo::Cache after ActiveRecord::QueryCache.
# Pass { :page_cache => false } argument to Lifo::Cache.
config.middleware.insert_after ActiveRecord::QueryCache, Lifo::Cache, :page_cache => false
</ruby>

h5. Swapping a Middleware

You can swap an existing middleware in the middleware stack using +config.middleware.swap+.

<strong>Example:</strong>

<ruby>
# environment.rb

# Replace ActionController::Failsafe with Lifo::Failsafe
config.middleware.swap ActionController::Failsafe, Lifo::Failsafe
</ruby>

h4. Internal Middleware Stack

Much of Action Controller's functionality is implemented as Middlewares. The following table explains the purpose of each of them:

|Middleware|Purpose|
|Rack::Lock|Sets +env["rack.multithread"]+ flag to +true+ and wraps the application within a Mutex.|
|ActionController::Failsafe|Returns HTTP Status +500+ to the client if an exception gets raised while dispatching.|
|ActiveRecord::QueryCache|Enable the Active Record query cache.|
|ActionController::Session::CookieStore|Uses the cookie based session store.|
|ActionController::Session::MemCacheStore|Uses the memcached based session store.|
|ActiveRecord::SessionStore|Uses the database based session store.|
|Rack::MethodOverride|Sets HTTP method based on +_method+ parameter or +env["HTTP_X_HTTP_METHOD_OVERRIDE"]+.|
|Rack::Head|Discards the response body if the client sends a +HEAD+ request.|

TIP: It's possible to use any of the above middlewares in your custom Rack stack.

h4. Customizing Internal Middleware Stack

It's possible to replace the entire middleware stack with a custom stack using +ActionController::Dispatcher.middleware=+.

<strong>Example:</strong>

Put the following in an initializer:

<ruby>
# config/initializers/stack.rb
ActionController::Dispatcher.middleware = ActionController::MiddlewareStack.new do |m|
  m.use ActionController::Failsafe
  m.use ActiveRecord::QueryCache
  m.use Rack::Head
end
</ruby>

And now inspecting the middleware stack:

<shell>
$ rake middleware
(in /Users/lifo/Rails/blog)
use ActionController::Failsafe
use ActiveRecord::QueryCache
use Rack::Head
run ActionController::Dispatcher.new
</shell>

h3. Rails Metal Applications

Rails Metal applications are minimal Rack applications specially designed for integrating with a typical Rails application. As Rails Metal Applications skip all of the Action Controller stack, serving a request has no overhead from the Rails framework itself. This is especially useful for infrequent cases where the performance of the full stack Rails framework is an issue.

h4. Generating a Metal Application

Rails provides a generator called +metal+ for creating a new Metal application:

<shell>
$ script/generate metal poller
</shell>

This generates +poller.rb+ in the +app/metal+ directory:

<ruby>
# Allow the metal piece to run in isolation
require(File.dirname(__FILE__) + "/../../config/environment") unless defined?(Rails)

class Poller
  def self.call(env)
    if env["PATH_INFO"] =~ /^\/poller/
      [200, {"Content-Type" => "text/html"}, ["Hello, World!"]]
    else
      [404, {"Content-Type" => "text/html"}, ["Not Found"]]
    end
  end
end
</ruby>

Metal applications are an optimization. You should make sure to "understand the related performance implications":http://weblog.rubyonrails.org/2008/12/20/performance-of-rails-metal before using it.

h4. Execution Order

All Metal Applications are executed by +Rails::Rack::Metal+ middleware, which is a part of the +ActionController::MiddlewareStack+ chain.

Here's the primary method responsible for running the Metal applications:

<ruby>
def call(env)
  @metals.keys.each do |app|
    result = app.call(env)
    return result unless result[0].to_i == 404
  end
  @app.call(env)
end
</ruby>

In the code above, +@metals+ is an ordered ( alphabetical ) hash of metal applications. Due to the alphabetical ordering, +aaa.rb+ will come before +bbb.rb+ in the metal chain.

WARNING: Metal applications cannot return the HTTP Status +404+ to a client, as it is used for continuing the Metal chain execution. Please use normal Rails controllers or a custom middleware if returning +404+ is a requirement.

h3. Changelog

"Lighthouse ticket":http://rails.lighthouseapp.com/projects/16213-rails-guides/tickets/58

* February 7, 2009: Second version by "Pratik":credits.html#lifo
* January 11, 2009: First version by "Pratik":credits.html#lifo