Class: Rackup::Server

Relationships & Source Files
Namespace Children
Classes: `Options`
Inherits:	Object
Defined in:	lib/rackup/server.rb

Class Method Summary

.default_middleware_by_environment
.logging_middleware
.middleware
.new(options = nil) ⇒ Server constructor

Options may include: * :app.
.start(options = nil)

Start a new rack server (like running rackup).

Instance Method Summary

#app
#default_options
#middleware
#server
#start(&block)
#build_app(app) private
#build_app_and_options_from_config private
#build_app_from_string private
#check_pid! private
#daemonize_app private
#exit_with_pid(pid) private
#handle_profiling(heapfile, profile_mode, filename) private
#make_profile_name(filename) private
#opt_parser private
#parse_options(args) private
#wrapped_app private
#write_pid private

Constructor Details

.new(options = nil) ⇒ `Server`

Server::Options may include:

:app

a rack application to run (overrides :config and :builder)

:builder

a string to evaluate a Rack::Builder from

:config

a rackup configuration file path to load (.ru)

:environment

this selects the middleware that will be wrapped around
your application. Default options available are:
  - development: CommonLogger, ShowExceptions, and Lint
  - deployment: CommonLogger
  - none: no extra middleware
note: when the server is a cgi server, CommonLogger is not included.

:server

choose a specific Rackup::Handler, e.g. cgi, fcgi, webrick

:daemonize

if truthy, the server will daemonize itself (fork, detach, etc)
if :noclose, the server will not close STDOUT/STDERR

:pid

path to write a pid file after daemonize

:Host

the host address to bind to (used by supporting Rackup::Handler)

:Port

the port to bind to (used by supporting Rackup::Handler)

:AccessLog

webrick access log options (or supporting Rackup::Handler)

:debug
```
turn on debug output ($DEBUG = true)
```
:warn
```
turn on warnings ($-w = true)
```
:include
```
add given paths to $LOAD_PATH
```
:require
```
require the given libraries
```

Additional options for profiling app initialization include:

:heapfile

location for ObjectSpace.dump_all to write the output to

:profile_file

location for CPU/Memory (StackProf) profile output (defaults to a tempfile)

:profile_mode

StackProf profile mode (cpu|wall|object)

[ GitHub ]

# File 'lib/rackup/server.rb', line 230


def initialize(options = nil)
  @ignore_options = []

  if options
    @use_default_options = false
    @options = options
    @app = options[:app] if options[:app]
  else
    @use_default_options = true
    @options = parse_options(ARGV)
  end
end

Class Method Details

.default_middleware_by_environment

[ GitHub ]

# File 'lib/rackup/server.rb', line 273


def default_middleware_by_environment
  m = Hash.new {|h, k| h[k] = []}
  m["deployment"] = [
    [Rack::ContentLength],
    logging_middleware,
    [Rack::TempfileReaper]
  ]
  m["development"] = [
    [Rack::ContentLength],
    logging_middleware,
    [Rack::ShowExceptions],
    [Rack::Lint],
    [Rack::TempfileReaper]
  ]

  m
end

.logging_middleware

[ GitHub ]

# File 'lib/rackup/server.rb', line 267


def logging_middleware
  lambda { |server|
    /CGI/.match?(server.server.name) || server.options[:quiet] ? nil : [Rack::CommonLogger, $stderr]
  }
end

.middleware

[ GitHub ]

# File 'lib/rackup/server.rb', line 291


def middleware
  default_middleware_by_environment
end

.start(options = nil)

Start a new rack server (like running rackup). This will parse ARGV and provide standard ARGV rackup options, defaulting to load ‘config.ru’.

Providing an options hash will prevent ARGV parsing and will not include any default options.

This method can be used to very easily launch a CGI application, for example:

Rack::Server.start(
  :app => lambda do |e|
    [200, {'content-type' => 'text/html'}, ['hello world']]
  end,
  :server => 'cgi'
)

Further options available here are documented on Rack::Server#initialize

[ GitHub ]

# File 'lib/rackup/server.rb', line 181


def self.start(options = nil)
  new(options).start
end

Instance Attribute Details

#options (rw)

[ GitHub ]

# File 'lib/rackup/server.rb', line 243


def options
  merged_options = @use_default_options ? default_options.merge(@options) : @options
  merged_options.reject { |k, v| @ignore_options.include?(k) }
end

#options=(value) (rw)

[ GitHub ]

# File 'lib/rackup/server.rb', line 185


attr_writer :options

Instance Method Details

#app

[ GitHub ]

# File 'lib/rackup/server.rb', line 262


def app
  @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end

#build_app(app) (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 413


def build_app(app)
  middleware[options[:environment]].reverse_each do |middleware|
    middleware = middleware.call(self) if middleware.respond_to?(:call)
    next unless middleware
    klass, *args = middleware
    app = klass.new(app, *args)
  end
  app
end

#build_app_and_options_from_config (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 349


def build_app_and_options_from_config
  if !::File.exist? options[:config]
    abort "configuration #{options[:config]} not found"
  end

  return Rack::Builder.parse_file(self.options[:config])
end

#build_app_from_string (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 395


def build_app_from_string
  Rack::Builder.new_from_string(self.options[:builder])
end

#check_pid! (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 442


def check_pid!
  return unless ::File.exist?(options[:pid])

  pid = ::File.read(options[:pid]).to_i
  raise Errno::ESRCH if pid == 0

  Process.kill(0, pid)
  exit_with_pid(pid)
rescue Errno::ESRCH
  ::File.delete(options[:pid])
rescue Errno::EPERM
  exit_with_pid(pid)
end

#daemonize_app (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 427


def daemonize_app
  # Cannot be covered as it forks
  # :nocov:
  Process.daemon(true, options[:daemonize] == :noclose)
  # :nocov:
end

#default_options

[ GitHub ]

# File 'lib/rackup/server.rb', line 248


def default_options
  environment  = ENV['RACK_ENV'] || 'development'
  default_host = environment == 'development' ? 'localhost' : '0.0.0.0'

  {
    environment: environment,
    pid: nil,
    Port: 9292,
    Host: default_host,
    AccessLog: [],
    config: "config.ru"
  }
end

#exit_with_pid(pid) (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 456


def exit_with_pid(pid)
  $stderr.puts "A server is already running (pid: #{pid}, file: #{options[:pid]})."
  exit(1)
end

#handle_profiling(heapfile, profile_mode, filename) (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 357


def handle_profiling(heapfile, profile_mode, filename)
  if heapfile
    require "objspace"
    ObjectSpace.trace_object_allocations_start
    yield
    GC.start
    ::File.open(heapfile, "w") { |f| ObjectSpace.dump_all(output: f) }
    exit
  end

  if profile_mode
    require "stackprof"
    require "tempfile"

    make_profile_name(filename) do |filename|
      ::File.open(filename, "w") do |f|
        StackProf.run(mode: profile_mode, out: f) do
          yield
        end
        puts "Profile written to: #{filename}"
      end
    end
    exit
  end

  yield
end

#make_profile_name(filename) (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 385


def make_profile_name(filename)
  if filename
    yield filename
  else
    ::Dir::Tmpname.create("profile.dump") do |tmpname, _, _|
      yield tmpname
    end
  end
end

#middleware

[ GitHub ]

# File 'lib/rackup/server.rb', line 296


def middleware
  self.class.middleware
end

#opt_parser (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 409


def opt_parser
  Options.new
end

#parse_options(args) (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 399


def parse_options(args)
  # Don't evaluate CGI ISINDEX parameters.
  args.clear if ENV.include?(Rack::REQUEST_METHOD)

  @options = opt_parser.parse!(args)
  @options[:config] = ::File.expand_path(options[:config])
  ENV["RACK_ENV"] = options[:environment]
  @options
end

#server

[ GitHub ]

# File 'lib/rackup/server.rb', line 344


def server
  @_server ||= Handler.get(options[:server]) || Handler.default
end

#start(&block)

[ GitHub ]

# File 'lib/rackup/server.rb', line 300


def start(&block)
  if options[:warn]
    $-w = true
  end

  if includes = options[:include]
    $LOAD_PATH.unshift(*includes)
  end

  Array(options[:require]).each do |library|
    require library
  end

  if options[:debug]
    $DEBUG = true
    require 'pp'
    p options[:server]
    pp wrapped_app
    pp app
  end

  check_pid! if options[:pid]

  # Touch the wrapped app, so that the config.ru is loaded before
  # daemonization (i.e. before chdir, etc).
  handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
    wrapped_app
  end

  daemonize_app if options[:daemonize]

  write_pid if options[:pid]

  trap(:INT) do
    if server.respond_to?(:shutdown)
      server.shutdown
    else
      exit
    end
  end

  server.run(wrapped_app, **options, &block)
end

#wrapped_app (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 423


def wrapped_app
  @wrapped_app ||= build_app app
end

#write_pid (private)

[ GitHub ]

# File 'lib/rackup/server.rb', line 434


def write_pid
  ::File.open(options[:pid], ::File::CREAT | ::File::EXCL | ::File::WRONLY ){ |f| f.write("#{Process.pid}") }
  at_exit { ::FileUtils.rm_f(options[:pid]) }
rescue Errno::EEXIST
  check_pid!
  retry
end

Class: Rackup::Server

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(options = nil) ⇒ Server

Class Method Details

.default_middleware_by_environment

.logging_middleware

.middleware

.start(options = nil)

Instance Attribute Details

#options (rw)

#options=(value) (rw)

Instance Method Details

#app

#build_app(app) (private)

#build_app_and_options_from_config (private)

#build_app_from_string (private)

#check_pid! (private)

#daemonize_app (private)

#default_options

#exit_with_pid(pid) (private)

#handle_profiling(heapfile, profile_mode, filename) (private)

#make_profile_name(filename) (private)

#middleware

#opt_parser (private)

#parse_options(args) (private)

#server

#start(&block)

#wrapped_app (private)

#write_pid (private)

.new(options = nil) ⇒ `Server`