Class | PhusionPassenger::Railz::ApplicationSpawner |
In: |
lib/phusion_passenger/railz/application_spawner.rb
|
Parent: | AbstractServer |
This class is capable of spawning instances of a single Ruby on Rails application. It does so by preloading as much of the application‘s code as possible, then creating instances of the application using what is already preloaded. This makes it spawning application instances very fast, except for the first spawn.
Use multiple instances of ApplicationSpawner if you need to spawn multiple different Ruby on Rails applications.
Note: ApplicationSpawner may only be started asynchronously with AbstractServer#start. Starting it synchronously with AbstractServer#start_synchronously has not been tested.
ROOT_UID | = | 0 | The user ID of the root user. | |
ROOT_GID | = | 0 | The group ID of the root user. |
app_root | [R] | The application root of this spawner. |
app_root is the root directory of this application, i.e. the directory that contains ‘app/’, ‘public/’, etc. If given an invalid directory, or a directory that doesn‘t appear to be a Rails application root directory, then an InvalidPath will be raised.
Additional options are:
If that user doesn‘t exist on the system, or if that user is root, then ApplicationSpawner will attempt to switch to the username given by lowest_user (and to the default group of that user). If lowest_user doesn‘t exist either, or if switching user failed (because the current process does not have the privilege to do so), then ApplicationSpawner will continue without reporting an error.
All other options will be passed on to RequestHandler.
# File lib/phusion_passenger/railz/application_spawner.rb, line 102 102: def initialize(app_root, options = {}) 103: super() 104: @app_root = app_root 105: @canonicalized_app_root = canonicalize_path(app_root) 106: @options = sanitize_spawn_options(options) 107: @lower_privilege = @options["lower_privilege"] 108: @lowest_user = @options["lowest_user"] 109: @environment = @options["environment"] 110: @encoded_environment_variables = @options["environment_variables"] 111: @base_uri = @options["base_uri"] if @options["base_uri"] && @options["base_uri"] != "/" 112: @print_exceptions = @options["print_exceptions"] 113: self.max_idle_time = DEFAULT_APP_SPAWNER_MAX_IDLE_TIME 114: assert_valid_app_root(@app_root) 115: define_message_handler(:spawn_application, :handle_spawn_application) 116: end
Spawn an instance of the RoR application. When successful, an Application object will be returned, which represents the spawned RoR application.
Raises:
# File lib/phusion_passenger/railz/application_spawner.rb, line 124 124: def spawn_application 125: server.write("spawn_application") 126: pid, socket_name, socket_type = server.read 127: if pid.nil? 128: raise IOError, "Connection closed" 129: end 130: owner_pipe = server.recv_io 131: return Application.new(@app_root, pid, socket_name, 132: socket_type, owner_pipe) 133: rescue SystemCallError, IOError, SocketError => e 134: raise Error, "The application spawner server exited unexpectedly: #{e}" 135: end
Spawn an instance of the RoR application. When successful, an Application object will be returned, which represents the spawned RoR application.
Unlike spawn_application, this method may be called even when the ApplicationSpawner server isn‘t started. This allows one to spawn a RoR application without preloading any source files.
This method may only be called if no Rails framework has been loaded in the current Ruby VM.
Raises:
# File lib/phusion_passenger/railz/application_spawner.rb, line 151 151: def spawn_application! 152: a, b = UNIXSocket.pair 153: pid = safe_fork('application', true) do 154: begin 155: a.close 156: 157: file_descriptors_to_leave_open = [0, 1, 2, b.fileno] 158: NativeSupport.close_all_file_descriptors(file_descriptors_to_leave_open) 159: close_all_io_objects_for_fds(file_descriptors_to_leave_open) 160: 161: channel = MessageChannel.new(b) 162: success = report_app_init_status(channel) do 163: ENV['RAILS_ENV'] = @environment 164: ENV['RACK_ENV'] = @environment 165: ENV['RAILS_RELATIVE_URL_ROOT'] = @base_uri 166: Dir.chdir(@app_root) 167: if @encoded_environment_variables 168: set_passed_environment_variables 169: end 170: if @lower_privilege 171: lower_privilege('config/environment.rb', @lowest_user) 172: end 173: # Make sure RubyGems uses any new environment variable values 174: # that have been set now (e.g. $HOME, $GEM_HOME, etc) and that 175: # it is able to detect newly installed gems. 176: Gem.clear_paths 177: setup_bundler_support 178: 179: require File.expand_path('config/environment') 180: begin 181: require 'dispatcher' 182: rescue LoadError 183: # Early versions of Rails 3 still had the dispatcher, but 184: # later versions disposed of it, in which case we'll need 185: # to use the application object. 186: raise if Rails::VERSION::MAJOR < 3 187: end 188: end 189: if success 190: start_request_handler(channel, false) 191: end 192: rescue SignalException => e 193: if e.message != AbstractRequestHandler::HARD_TERMINATION_SIGNAL && 194: e.message != AbstractRequestHandler::SOFT_TERMINATION_SIGNAL 195: raise 196: end 197: end 198: end 199: b.close 200: Process.waitpid(pid) rescue nil 201: 202: channel = MessageChannel.new(a) 203: unmarshal_and_raise_errors(channel, @print_exceptions) 204: 205: # No exception was raised, so spawning succeeded. 206: pid, socket_name, socket_type = channel.read 207: if pid.nil? 208: raise IOError, "Connection closed" 209: end 210: owner_pipe = channel.recv_io 211: return Application.new(@app_root, pid, socket_name, 212: socket_type, owner_pipe) 213: end
Overrided from AbstractServer#start.
May raise these additional exceptions:
# File lib/phusion_passenger/railz/application_spawner.rb, line 221 221: def start 222: super 223: begin 224: unmarshal_and_raise_errors(server, @print_exceptions) 225: rescue IOError, SystemCallError, SocketError => e 226: stop 227: raise Error, "The application spawner server exited unexpectedly: #{e}" 228: rescue 229: stop 230: raise 231: end 232: end