Class: PhusionPassenger::SpawnManager

Inherits:
AbstractServer show all
Includes:
Utils
Defined in:
lib/phusion_passenger/spawn_manager.rb

Overview

The spawn manager is capable of spawning Ruby on Rails or Rack application instances. It acts like a simple fascade for the rest of the spawn manager system.

Note: SpawnManager may only be started synchronously with AbstractServer#start_synchronously. Starting asynchronously has not been tested. Don’t forget to call cleanup after the server’s main loop has finished.

Ruby on Rails optimizations

Spawning a Ruby on Rails application is usually slow. But SpawnManager will preload and cache Ruby on Rails frameworks, as well as application code, so subsequent spawns will be very fast.

Internally, SpawnManager uses Railz::FrameworkSpawner to preload and cache Ruby on Rails frameworks. Railz::FrameworkSpawner, in turn, uses Railz::ApplicationSpawner to preload and cache application code.

In case you’re wondering why the namespace is “Railz” and not “Rails”: it’s to work around an obscure bug in ActiveSupport’s Dispatcher.

Constant Summary

Constants inherited from AbstractServer

AbstractServer::SERVER_TERMINATION_SIGNAL

Instance Attribute Summary

Attributes inherited from AbstractServer

#last_activity_time, #max_idle_time, #next_cleaning_time

Instance Method Summary collapse

Methods inherited from AbstractServer

#server_pid, #start, #start_synchronously, #started?, #stop

Constructor Details

#initialize ⇒ SpawnManager

Returns a new instance of SpawnManager.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/phusion_passenger/spawn_manager.rb', line 61

def initialize
	super()
	@spawners = AbstractServerCollection.new
	define_message_handler(:spawn_application, :handle_spawn_application)
	define_message_handler(:reload, :handle_reload)
	define_signal_handler('SIGHUP', :reload)
	
	# Start garbage collector in order to free up some existing
	# heap slots. This prevents the heap from growing unnecessarily
	# during the startup phase.
	GC.start
	if GC.copy_on_write_friendly?
		# Preload libraries for copy-on-write semantics.
		require 'base64'
		require 'phusion_passenger/application'
		require 'phusion_passenger/railz/framework_spawner'
		require 'phusion_passenger/railz/application_spawner'
		require 'phusion_passenger/rack/application_spawner'
		require 'phusion_passenger/html_template'
		require 'phusion_passenger/platform_info'
		require 'phusion_passenger/exceptions'
		
		# Commonly used libraries.
		['mysql', 'sqlite3'].each do |lib|
			begin
				require lib
			rescue LoadError
				# Do nothing; ignore if not present.
			end
		end
	end
end

Instance Method Details

#cleanup ⇒ Object

Cleanup resources. Should be called when this SpawnManager is no longer needed.



215
216
217
 
# File 'lib/phusion_passenger/spawn_manager.rb', line 215

def cleanup
	@spawners.cleanup
end

#reload(app_root = nil) ⇒ Object

Remove the cached application instances at the given application root. If nil is specified as application root, then all cached application instances will be removed, no matter the application root.

Long description: Application code might be cached in memory. But once it a while, it will be necessary to reload the code for an application, such as after deploying a new version of the application. This method makes sure that any cached application code is removed, so that the next time an application instance is spawned, the application code will be freshly loaded into memory.

Raises AbstractServer::SpawnError if something went wrong.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/phusion_passenger/spawn_manager.rb', line 188

def reload(app_root = nil)
	@spawners.synchronize do
		if app_root
			# Delete associated ApplicationSpawner.
			@spawners.delete("app:#{app_root}")
		else
			# Delete all ApplicationSpawners.
			keys_to_delete = []
			@spawners.each_pair do |key, spawner|
				if spawner.is_a?(Railz::ApplicationSpawner)
					keys_to_delete << key
				end
			end
			keys_to_delete.each do |key|
				@spawners.delete(key)
			end
		end
		@spawners.each do |spawner|
			# Reload all FrameworkSpawners.
			if spawner.respond_to?(:reload)
				spawner.reload(app_root)
			end
		end
	end
end

#spawn_application(options) ⇒ Object

Spawn an application with the given spawn options. When successful, an Application object will be returned, which represents the spawned application. At least one option must be given: app_root. This is the application’s root folder.

Other options are:

‘lower_privilege’, ‘lowest_user’, ‘environment’, ‘environment_variables’, ‘base_uri’ and ‘print_exceptions’

See Railz::ApplicationSpawner.new for an explanation of these options.

‘app_type’

What kind of application is being spawned. Either “rails” (default), “rack” or “wsgi”.

‘spawn_method’

May be one of “smart”, “smart-lv2” or “conservative”. When “smart” is specified, SpawnManager will internally cache the code of Rails applications, in order to speed up future spawning attempts. This implies that, if you’ve changed the application’s code, you must do one of these things:

  • Restart this SpawnManager by calling AbstractServer#stop, then AbstractServer#start.

  • Reload the application by calling reload with the correct app_root argument.

“smart” caches the Rails framework code in a framework spawner server, and application code in an application spawner server. Sometimes it is desirable to skip the framework spawning and going directly for the application spawner instead. The “smart-lv2” method allows you to do that.

Caching however can be incompatible with some applications. The “conservative” spawning method does not involve any caching at all. Spawning will be slower, but is guaranteed to be compatible with all applications.

The default spawn method is “smart-lv2”.

‘framework_spawner_timeout’ and ‘app_spawner_timeout’

These options allow you to specify the maximum idle timeout, in seconds, of the framework spawner servers and application spawner servers that will be started under the hood. These options are only used if app_type equals “rails”.

A timeout of 0 means that the spawner server should never idle timeout. A timeout of -1 means that the default timeout value should be used. The default value is -1.

Exceptions:

  • InvalidPath: app_root doesn’t appear to be a valid Ruby on Rails application root.

  • VersionNotFound: The Ruby on Rails framework version that the given application requires is not installed.

  • AbstractServer::ServerError: One of the server processes exited unexpectedly.

  • FrameworkInitError: The Ruby on Rails framework that the application requires could not be loaded.

  • AppInitError: The application raised an exception or called exit() during startup.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/phusion_passenger/spawn_manager.rb', line 142

def spawn_application(options)
	if !options["app_root"]
		raise ArgumentError, "The 'app_root' option must be given."
	end
	options = sanitize_spawn_options(options)
	
	if options["app_type"] == "rails"
		if !defined?(Railz::FrameworkSpawner)
			require 'phusion_passenger/application'
			require 'phusion_passenger/railz/framework_spawner'
			require 'phusion_passenger/railz/application_spawner'
		end
		return spawn_rails_application(options)
	elsif options["app_type"] == "rack"
		if !defined?(Rack::ApplicationSpawner)
			require 'phusion_passenger/rack/application_spawner'
		end
		return Rack::ApplicationSpawner.spawn_application(
			options["app_root"], options
		)
	elsif options["app_type"] == "wsgi"
		require 'phusion_passenger/wsgi/application_spawner'
		return WSGI::ApplicationSpawner.spawn_application(
			options["app_root"],
			options["lower_privilege"],
			options["lowest_user"],
			options["environment"]
		)
	else
		raise ArgumentError, "Unknown 'app_type' value '#{options["app_type"]}'."
	end
end