2012-09-01 17:25:58 -04:00
Rails on Rack
=============
2009-02-05 20:57:02 -05:00
2012-11-29 17:25:02 -05:00
This guide covers Rails integration with Rack and interfacing with other Rack components.
After reading this guide, you will know:
2009-02-05 20:57:02 -05:00
2012-12-07 12:50:09 -05:00
* How to use Rack Middlewares in your Rails applications.
* Action Pack's internal Middleware stack.
* How to define a custom Middleware stack.
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
--------------------------------------------------------------------------------
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
WARNING: This guide assumes a working knowledge of Rack protocol and Rack concepts such as middlewares, url maps and `Rack::Builder` .
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
Introduction to Rack
--------------------
2009-02-05 20:57:02 -05:00
2012-11-08 16:04:20 -05:00
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.
2009-02-05 20:57:02 -05:00
2012-09-02 01:08:20 -04:00
- [Rack API Documentation ](http://rack.rubyforge.org/doc/ )
2009-02-05 20:57:02 -05:00
2012-09-02 01:08:20 -04:00
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 [Resources ](#resources ) section below.
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
Rails on Rack
-------------
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
### Rails Application's Rack Object
2009-02-05 20:57:02 -05:00
2013-04-03 06:15:11 -04:00
`ApplicationName::Application` is the primary Rack application object of a Rails
application. Any Rack compliant web server should be using
`ApplicationName::Application` object to serve a Rails
application. `Rails.application` refers to the same application object.
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
### `rails server`
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
`rails server` does the basic job of creating a `Rack::Server` object and starting the webserver.
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
Here's how `rails server` creates an instance of `Rack::Server`
2009-02-05 20:57:02 -05:00
2012-09-01 17:08:06 -04:00
```ruby
2013-01-05 17:57:03 -05:00
Rails::Server.new.tap do |server|
2012-05-22 23:02:20 -04:00
require APP_PATH
Dir.chdir(Rails.application.root)
server.start
2013-01-05 17:57:03 -05:00
end
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
The `Rails::Server` inherits from `Rack::Server` and calls the `Rack::Server#start` method this way:
2012-05-22 23:02:20 -04:00
2012-09-01 17:08:06 -04:00
```ruby
2012-05-22 23:02:20 -04:00
class Server < ::Rack::Server
def start
...
super
end
end
2012-09-01 17:08:06 -04:00
```
2012-05-22 23:02:20 -04:00
Here's how it loads the middlewares:
2012-09-01 17:08:06 -04:00
```ruby
2012-05-22 23:02:20 -04:00
def middleware
middlewares = []
2012-11-16 05:54:25 -05:00
middlewares < < [Rails::Rack::Debugger] if options[:debugger]
2012-05-22 23:02:20 -04:00
middlewares < < [::Rack::ContentLength]
Hash.new(middlewares)
end
2012-09-01 17:08:06 -04:00
```
2012-05-22 23:02:20 -04:00
2012-09-01 21:37:59 -04:00
`Rails::Rack::Debugger` is primarily useful only in the development environment. The following table explains the usage of the loaded middlewares:
2009-02-05 20:57:02 -05:00
2012-09-02 13:08:06 -04:00
| Middleware | Purpose |
| ----------------------- | --------------------------------------------------------------------------------- |
| `Rails::Rack::Debugger` | Starts Debugger |
| `Rack::ContentLength` | Counts the number of bytes in the response and set the HTTP Content-Length header |
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
### `rackup`
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
To use `rackup` instead of Rails' `rails server` , you can put the following inside `config.ru` of your Rails application's root directory:
2009-02-05 20:57:02 -05:00
2012-09-01 17:08:06 -04:00
```ruby
2010-04-12 12:50:55 -04:00
# Rails.root/config.ru
2013-05-28 08:36:18 -04:00
require ::File.expand_path('../config/environment', __FILE__ )
2009-02-05 20:57:02 -05:00
2013-11-04 15:55:07 -05:00
use Rails::Rack::Debugger
2012-05-22 23:02:20 -04:00
use Rack::ContentLength
2013-04-03 06:15:11 -04:00
run Rails.application
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
And start the server:
2012-09-01 20:45:26 -04:00
```bash
2011-02-20 11:07:39 -05:00
$ rackup config.ru
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2012-09-01 21:37:59 -04:00
To find out more about different `rackup` options:
2009-02-05 20:57:02 -05:00
2012-09-01 20:45:26 -04:00
```bash
2011-02-20 11:07:39 -05:00
$ rackup --help
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
Action Dispatcher Middleware Stack
----------------------------------
2009-02-05 20:57:02 -05:00
2013-04-03 13:17:31 -04:00
Many of Action Dispatcher's internal components are implemented as Rack middlewares. `Rails::Application` uses `ActionDispatch::MiddlewareStack` to combine various internal and external middlewares to form a complete Rails Rack application.
2009-02-05 20:57:02 -05:00
2012-11-08 16:04:20 -05:00
NOTE: `ActionDispatch::MiddlewareStack` is Rails equivalent of `Rack::Builder` , but built for better flexibility and more features to meet Rails' requirements.
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
### Inspecting Middleware Stack
2009-02-05 20:57:02 -05:00
Rails has a handy rake task for inspecting the middleware stack in use:
2012-09-01 20:45:26 -04:00
```bash
2009-02-05 20:57:02 -05:00
$ rake middleware
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2009-02-24 07:29:25 -05:00
For a freshly generated Rails application, this might produce something like:
2009-02-05 20:57:02 -05:00
2012-09-01 17:08:06 -04:00
```ruby
2013-07-15 04:35:00 -04:00
use Rack::Sendfile
2011-08-10 17:32:11 -04:00
use ActionDispatch::Static
2009-02-24 07:29:25 -05:00
use Rack::Lock
2012-04-02 12:31:20 -04:00
use #< ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x000000029a0838 >
2011-08-10 17:32:11 -04:00
use Rack::Runtime
2012-04-02 12:31:20 -04:00
use Rack::MethodOverride
use ActionDispatch::RequestId
2011-08-10 17:32:11 -04:00
use Rails::Rack::Logger
use ActionDispatch::ShowExceptions
2011-12-01 22:15:11 -05:00
use ActionDispatch::DebugExceptions
2011-08-10 17:32:11 -04:00
use ActionDispatch::RemoteIp
2012-04-02 12:31:20 -04:00
use ActionDispatch::Reloader
2011-08-10 17:32:11 -04:00
use ActionDispatch::Callbacks
2013-06-08 07:53:12 -04:00
use ActiveRecord::Migration::CheckPending
2011-08-10 17:32:11 -04:00
use ActiveRecord::ConnectionAdapters::ConnectionManagement
2011-08-10 17:27:00 -04:00
use ActiveRecord::QueryCache
2011-08-10 17:32:11 -04:00
use ActionDispatch::Cookies
use ActionDispatch::Session::CookieStore
use ActionDispatch::Flash
use ActionDispatch::ParamsParser
2012-11-16 07:48:17 -05:00
use Rack::Head
2012-04-02 12:31:20 -04:00
use Rack::ConditionalGet
use Rack::ETag
2012-11-16 07:48:17 -05:00
run MyApp::Application.routes
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2013-12-04 22:16:00 -05:00
The default middlewares shown here (and some others) are each summarized in the [Internal Middlewares ](#internal-middleware-stack ) section, below.
2009-02-24 07:29:25 -05:00
2012-09-01 17:25:58 -04:00
### Configuring Middleware Stack
2009-02-24 07:29:25 -05:00
2012-09-03 21:21:24 -04:00
Rails provides a simple configuration interface `config.middleware` for adding, removing and modifying the middlewares in the middleware stack via `application.rb` or the environment specific configuration file `environments/<environment>.rb` .
2009-02-24 07:29:25 -05:00
2012-09-01 17:25:58 -04:00
#### Adding a Middleware
2009-02-24 07:29:25 -05:00
You can add a new middleware to the middleware stack using any of the following methods:
2009-02-05 20:57:02 -05:00
2012-09-01 19:34:21 -04:00
* `config.middleware.use(new_middleware, args)` - Adds the new middleware at the bottom of the middleware stack.
2009-02-24 07:29:25 -05:00
2012-09-01 19:34:21 -04:00
* `config.middleware.insert_before(existing_middleware, new_middleware, args)` - Adds the new middleware before the specified existing middleware in the middleware stack.
2009-02-24 07:29:25 -05:00
2012-09-01 19:34:21 -04:00
* `config.middleware.insert_after(existing_middleware, new_middleware, args)` - Adds the new middleware after the specified existing middleware in the middleware stack.
2009-02-24 07:29:25 -05:00
2012-09-01 17:08:06 -04:00
```ruby
2011-08-10 17:32:11 -04:00
# config/application.rb
2009-02-05 20:57:02 -05:00
2009-02-24 07:29:25 -05:00
# Push Rack::BounceFavicon at the bottom
2009-02-05 20:57:02 -05:00
config.middleware.use Rack::BounceFavicon
2009-02-24 07:29:25 -05:00
# Add Lifo::Cache after ActiveRecord::QueryCache.
2012-10-10 10:35:50 -04:00
# Pass { page_cache: false } argument to Lifo::Cache.
config.middleware.insert_after ActiveRecord::QueryCache, Lifo::Cache, page_cache: false
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
#### Swapping a Middleware
2009-02-24 07:29:25 -05:00
2012-09-01 21:37:59 -04:00
You can swap an existing middleware in the middleware stack using `config.middleware.swap` .
2009-02-24 07:29:25 -05:00
2012-09-01 17:08:06 -04:00
```ruby
2011-08-10 17:32:11 -04:00
# config/application.rb
2009-02-05 20:57:02 -05:00
2012-04-04 06:09:10 -04:00
# Replace ActionDispatch::ShowExceptions with Lifo::ShowExceptions
config.middleware.swap ActionDispatch::ShowExceptions, Lifo::ShowExceptions
2012-09-01 17:08:06 -04:00
```
2009-02-05 20:57:02 -05:00
2013-11-13 02:53:09 -05:00
#### Deleting a Middleware
2009-03-16 07:28:36 -04:00
2013-11-13 02:53:09 -05:00
Add the following lines to your application configuration:
2009-03-16 07:28:36 -04:00
2012-09-01 17:08:06 -04:00
```ruby
2012-04-04 06:09:10 -04:00
# config/application.rb
2012-04-05 12:58:47 -04:00
config.middleware.delete "Rack::Lock"
2012-09-01 17:08:06 -04:00
```
2009-03-16 07:28:36 -04:00
2013-11-13 02:53:09 -05:00
And now if you inspect the middleware stack, you'll find that `Rack::Lock` is
not a part of it.
2012-04-04 06:09:10 -04:00
2012-09-01 20:45:26 -04:00
```bash
2012-04-04 06:09:10 -04:00
$ rake middleware
(in /Users/lifo/Rails/blog)
use ActionDispatch::Static
use #< ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x00000001c304c8 >
use Rack::Runtime
2012-04-05 12:58:47 -04:00
...
2012-05-22 22:33:49 -04:00
run Blog::Application.routes
2012-09-01 17:08:06 -04:00
```
2012-04-04 06:09:10 -04:00
2012-06-14 13:44:32 -04:00
If you want to remove session related middleware, do the following:
2012-06-14 13:28:42 -04:00
2012-09-01 17:08:06 -04:00
```ruby
2012-06-14 13:28:42 -04:00
# config/application.rb
config.middleware.delete "ActionDispatch::Cookies"
config.middleware.delete "ActionDispatch::Session::CookieStore"
config.middleware.delete "ActionDispatch::Flash"
2012-09-01 17:08:06 -04:00
```
2012-06-14 13:28:42 -04:00
2012-06-14 13:44:32 -04:00
And to remove browser related middleware,
2012-06-14 13:28:42 -04:00
2012-09-01 17:08:06 -04:00
```ruby
2012-06-14 13:28:42 -04:00
# config/application.rb
config.middleware.delete "Rack::MethodOverride"
2012-09-01 17:08:06 -04:00
```
2012-06-14 13:28:42 -04:00
2012-09-01 17:25:58 -04:00
### Internal Middleware Stack
2009-02-24 07:29:25 -05:00
2012-04-02 14:31:38 -04:00
Much of Action Controller's functionality is implemented as Middlewares. The following list explains the purpose of each of them:
2009-02-24 07:29:25 -05:00
2013-10-28 13:56:32 -04:00
**`Rack::Sendfile`**
2013-10-04 04:35:33 -04:00
* Sets server specific X-Sendfile header. Configure this via `config.action_dispatch.x_sendfile_header` option.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Static`**
2012-09-03 21:21:24 -04:00
2013-10-04 04:35:33 -04:00
* Used to serve static assets. Disabled if `config.serve_static_assets` is `false` .
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`Rack::Lock`**
2012-09-03 21:21:24 -04:00
2012-12-30 23:21:20 -05:00
* Sets `env["rack.multithread"]` flag to `false` and wraps the application within a Mutex.
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`ActiveSupport::Cache::Strategy::LocalCache::Middleware`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Used for memory caching. This cache is not thread safe.
2013-10-28 13:56:32 -04:00
**`Rack::Runtime`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Sets an X-Runtime header, containing the time (in seconds) taken to execute the request.
2013-10-28 13:56:32 -04:00
**`Rack::MethodOverride`**
2012-09-03 21:21:24 -04:00
2012-09-01 19:34:21 -04:00
* Allows the method to be overridden if `params[:_method]` is set. This is the middleware which supports the PUT and DELETE HTTP method types.
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`ActionDispatch::RequestId`**
2012-09-03 21:21:24 -04:00
2012-09-01 21:37:59 -04:00
* Makes a unique `X-Request-Id` header available to the response and enables the `ActionDispatch::Request#uuid` method.
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`Rails::Rack::Logger`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Notifies the logs that the request has began. After request is complete, flushes all the logs.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::ShowExceptions`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Rescues any exception returned by the application and calls an exceptions app that will wrap it in a format for the end user.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::DebugExceptions`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Responsible for logging exceptions and showing a debugging page in case the request is local.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::RemoteIp`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Checks for IP spoofing attacks.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Reloader`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Provides prepare and cleanup callbacks, intended to assist with code reloading during development.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Callbacks`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Runs the prepare callbacks before serving the request.
2013-10-28 13:56:32 -04:00
**`ActiveRecord::Migration::CheckPending`**
2013-06-08 07:53:12 -04:00
2013-06-13 15:28:11 -04:00
* Checks pending migrations and raises `ActiveRecord::PendingMigrationError` if any migrations are pending.
2013-06-08 07:53:12 -04:00
2013-10-28 13:56:32 -04:00
**`ActiveRecord::ConnectionAdapters::ConnectionManagement`**
2012-09-03 21:21:24 -04:00
2012-09-01 21:37:59 -04:00
* Cleans active connections after each request, unless the `rack.test` key in the request environment is set to `true` .
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`ActiveRecord::QueryCache`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Enables the Active Record query cache.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Cookies`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Sets cookies for the request.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Session::CookieStore`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Responsible for storing the session in cookies.
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Flash`**
2012-09-03 21:21:24 -04:00
2012-09-01 19:34:21 -04:00
* Sets up the flash keys. Only available if `config.action_controller.session_store` is set to a value.
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`ActionDispatch::ParamsParser`**
2012-09-03 21:21:24 -04:00
2012-09-01 19:34:21 -04:00
* Parses out parameters from the request into `params` .
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`ActionDispatch::Head`**
2012-09-03 21:21:24 -04:00
2012-09-01 21:37:59 -04:00
* Converts HEAD requests to `GET` requests and serves them as so.
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`Rack::ConditionalGet`**
2012-09-03 21:21:24 -04:00
2012-09-01 21:37:59 -04:00
* Adds support for "Conditional `GET` " so that server responds with nothing if page wasn't changed.
2012-04-02 14:31:38 -04:00
2013-10-28 13:56:32 -04:00
**`Rack::ETag`**
2012-09-03 21:21:24 -04:00
2012-04-02 14:31:38 -04:00
* Adds ETag header on all String bodies. ETags are used to validate cache.
2009-02-24 07:29:25 -05:00
TIP: It's possible to use any of the above middlewares in your custom Rack stack.
2009-02-05 20:57:02 -05:00
2012-09-01 17:25:58 -04:00
Resources
---------
2009-03-16 07:28:36 -04:00
2012-09-01 17:25:58 -04:00
### Learning Rack
2009-03-16 07:28:36 -04:00
2013-04-13 11:16:59 -04:00
* [Official Rack Website ](http://rack.github.io )
2012-09-02 01:08:20 -04:00
* [Introducing Rack ](http://chneukirchen.org/blog/archive/2007/02/introducing-rack.html )
* [Ruby on Rack #1 - Hello Rack! ](http://m.onkey.org/ruby-on-rack-1-hello-rack )
* [Ruby on Rack #2 - The Builder ](http://m.onkey.org/ruby-on-rack-2-the-builder )
2009-03-16 07:28:36 -04:00
2012-09-01 17:25:58 -04:00
### Understanding Middlewares
2009-03-16 07:28:36 -04:00
2012-09-02 01:08:20 -04:00
* [Railscast on Rack Middlewares ](http://railscasts.com/episodes/151-rack-middleware )