passenger 4.0.45 → 4.0.46

data/doc/users_guide_snippets/installation.txt

@@ -141,6 +141,9 @@ sudo apt-get install nginx-extras passenger
 --------------------------------------------------------------
 +
 3. Edit `/etc/nginx/nginx.conf` and uncomment `passenger_root` and `passenger_ruby`.
++
+Especially <<PassengerRoot,passenger_root>> is important: Phusion Passenger won't work without it! If you don't see a commented version of `passenger_root` inside nginx.conf, then you need to <<inserting_passenger_root_for_apt,insert it yourself>>.
++
 4. Restart Nginx:
 +
 --------------------------------------------------------------
@@ -180,6 +183,9 @@ ifdef::nginx[]
 sudo apt-get install nginx-extras passenger-enterprise
 --------------------------------------------------------------
 4. Edit `/etc/nginx/nginx.conf` and uncomment `passenger_root` and `passenger_ruby`.
++
+Especially <<PassengerRoot,passenger_root>> is important: Phusion Passenger won't work without it! If you don't see a commented version of `passenger_root` inside nginx.conf, then you need to <<inserting_passenger_root_for_apt,insert it yourself>>.
++
 5. Restart Nginx:
 +
 --------------------------------------------------------------
@@ -204,6 +210,38 @@ sudo apt-get install passenger-enterprise
 --------------------------------------------------------------
 endif::[]
 
+ifdef::nginx[]
+[[inserting_passenger_root_for_apt]]
+==== Inserting `passenger_root` into nginx.conf
+
+During step 3 of the 'Installing packages' subsection, you were instructed to uncomment the <<PassengerRoot,passenger_root>> directive in `/etc/nginx/nginx.conf`. If there is no commented version in there, then you need to insert it yourself.
+
+First, run the following command and take note of its output:
+
+-----------------------------------
+/usr/bin/passenger-config --root
+-----------------------------------
+
+Next, insert the following snippet into `/etc/nginx/nginx.conf`, under the `http` block:
+
+-------------------------------------------------------------
+passenger_root whatever_value_you_got_from_previous_command;
+-------------------------------------------------------------
+
+Here is an example:
+
+-------------------------------------------------------------
+...
+http {
+   # path-to-locations.ini is given to you by `passenger-config --root`.
+   passenger_root /path-to-locations.ini;
+   ...
+}
+-------------------------------------------------------------
+
+Once you're done editing nginx.conf, continue with step 4.
+endif::nginx[]
+
 
 === Installing or upgrading on Red Hat, Fedora, CentOS or ScientificLinux
 

data/ext/common/AgentsStarter.h

@@ -535,10 +535,13 @@ public:
 				guard.clear();
 				if (e == ENOENT) {
 					string passengerRootConfig;
+					string docURL;
 					if (type == AS_APACHE) {
 						passengerRootConfig = "PassengerRoot";
+						docURL = APACHE2_DOC_URL "#PassengerRoot";
 					} else {
 						passengerRootConfig = "passenger_root";
+						docURL = NGINX_DOC_URL "#PassengerRoot";
 					}
 					throw RuntimeException("Unable to start the Phusion Passenger watchdog "
 						"because its executable (" + watchdogFilename + ") does "
@@ -546,7 +549,9 @@ public:
 						"installation is broken or incomplete, or that your '" +
 						passengerRootConfig + "' directive is set to the wrong value. "
 						"Please reinstall Phusion Passenger or fix your '" +
-						passengerRootConfig + "' directive, whichever is applicable.");
+						passengerRootConfig + "' directive, whichever is applicable. "
+						"To learn how to fix '" + passengerRootConfig + "', please read " +
+						docURL);
 				} else {
 					throw SystemException("Unable to start the Phusion Passenger watchdog (" +
 						watchdogFilename + ")", e);

data/ext/common/ApplicationPool2/Common.h

@@ -29,7 +29,10 @@
 #include <boost/shared_ptr.hpp>
 #include <boost/function.hpp>
 #include <oxt/tracable_exception.hpp>
+#include <ResourceLocator.h>
 #include <RandomGenerator.h>
+#include <UnionStation/Core.h>
+#include <UnionStation/Transaction.h>
 #include <ApplicationPool2/Options.h>
 #include <Utils/StringMap.h>
 
@@ -183,6 +186,12 @@ struct Ticket {
 };
 
 struct SpawnerConfig {
+	// Used by error pages.
+	ResourceLocator resourceLocator;
+
+	// Used for Union Station logging.
+	UnionStation::CorePtr unionStationCore;
+
 	// Used by SmartSpawner and DirectSpawner.
 	/** A random generator to use. */
 	RandomGeneratorPtr randomGenerator;
@@ -192,8 +201,12 @@ struct SpawnerConfig {
 	unsigned int spawnerCreationSleepTime;
 	unsigned int spawnTime;
 
-	SpawnerConfig(const RandomGeneratorPtr &randomGenerator = RandomGeneratorPtr())
-		: concurrency(1),
+	SpawnerConfig(const ResourceLocator &_resourceLocator,
+		const UnionStation::CorePtr &_unionStationCore = UnionStation::CorePtr(),
+		const RandomGeneratorPtr &randomGenerator = RandomGeneratorPtr())
+		: resourceLocator(_resourceLocator),
+		  unionStationCore(_unionStationCore),
+		  concurrency(1),
 		  spawnerCreationSleepTime(0),
 		  spawnTime(0)
 	{
@@ -209,6 +222,8 @@ typedef boost::shared_ptr<SpawnerConfig> SpawnerConfigPtr;
 
 ExceptionPtr copyException(const tracable_exception &e);
 void rethrowException(const ExceptionPtr &e);
+void processAndLogNewSpawnException(SpawnException &e, const Options &options,
+	const SpawnerConfigPtr &config);
 
 } // namespace ApplicationPool2
 } // namespace Passenger

data/ext/common/ApplicationPool2/DirectSpawner.h

@@ -111,10 +111,10 @@ private:
 		shared_array<const char *> &args) const
 	{
 		vector<string> startCommandArgs;
-		string agentsDir = resourceLocator.getAgentsDir();
+		string agentsDir = config->resourceLocator.getAgentsDir();
 		vector<string> command;
 		
-		split(options.getStartCommand(resourceLocator), '\t', startCommandArgs);
+		split(options.getStartCommand(config->resourceLocator), '\t', startCommandArgs);
 		if (startCommandArgs.empty()) {
 			throw RuntimeException("No startCommand given");
 		}
@@ -144,17 +144,11 @@ private:
 	}
 	
 public:
-	DirectSpawner(const ResourceLocator &_resourceLocator,
-		const ServerInstanceDir::GenerationPtr &_generation,
-		const SpawnerConfigPtr &_config = SpawnerConfigPtr())
-		: Spawner(_resourceLocator)
+	DirectSpawner(const ServerInstanceDir::GenerationPtr &_generation,
+		const SpawnerConfigPtr &_config)
+		: Spawner(_config)
 	{
 		generation = _generation;
-		if (_config == NULL) {
-			config = boost::make_shared<SpawnerConfig>();
-		} else {
-			config = _config;
-		}
 	}
 	
 	virtual ProcessPtr spawn(const Options &options) {

data/ext/common/ApplicationPool2/DummySpawner.h

@@ -37,16 +37,14 @@ using namespace oxt;
 
 class DummySpawner: public Spawner {
 private:
-	SpawnerConfigPtr config;
 	boost::mutex lock;
 	unsigned int count;
 	
 public:
 	unsigned int cleanCount;
 	
-	DummySpawner(const ResourceLocator &resourceLocator, const SpawnerConfigPtr &_config)
-		: Spawner(resourceLocator),
-		  config(_config)
+	DummySpawner(const SpawnerConfigPtr &_config)
+		: Spawner(_config)
 	{
 		count = 0;
 		cleanCount = 0;

data/ext/common/ApplicationPool2/ErrorRenderer.h

@@ -0,0 +1,119 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2014 Phusion
+ *
+ *  "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+#ifndef _PASSENGER_APPLICATION_POOL2_ERROR_RENDERER_H_
+#define _PASSENGER_APPLICATION_POOL2_ERROR_RENDERER_H_
+
+#include <string>
+#include <map>
+#include <cctype>
+
+#include <ApplicationPool2/Options.h>
+#include <Constants.h>
+#include <ResourceLocator.h>
+#include <StaticString.h>
+#include <Exceptions.h>
+#include <Utils/StringMap.h>
+#include <Utils/Template.h>
+#include <Utils/IOUtils.h>
+
+namespace Passenger {
+namespace ApplicationPool2 {
+
+using namespace std;
+using namespace boost;
+using namespace oxt;
+
+
+class ErrorRenderer {
+private:
+	string templatesDir, cssFile, errorLayoutFile;
+
+public:
+	ErrorRenderer(const ResourceLocator &resourceLocator) {
+		templatesDir = resourceLocator.getResourcesDir() + "/templates";
+		cssFile = templatesDir + "/error_layout.css";
+		errorLayoutFile = templatesDir + "/error_layout.html.template";
+	}
+
+	string renderWithDetails(const StaticString &message,
+		const Options &options,
+		const SpawnException *e = NULL) const
+	{
+		string generalErrorFile =
+			(e != NULL && e->isHTML())
+			? templatesDir + "/general_error_with_html.html.template"
+			: templatesDir + "/general_error.html.template";
+		string css = readAll(cssFile);
+		StringMap<StaticString> params;
+
+		params.set("CSS", css);
+		params.set("APP_ROOT", options.appRoot);
+		params.set("RUBY", options.ruby);
+		params.set("ENVIRONMENT", options.environment);
+		params.set("MESSAGE", message);
+		params.set("IS_RUBY_APP",
+			(options.appType == "classic-rails" || options.appType == "rack")
+			? "true" : "false");
+		if (e != NULL) {
+			params.set("TITLE", "Web application could not be started");
+			// Store all SpawnException annotations into 'params',
+			// but convert its name to uppercase.
+			const map<string, string> &annotations = e->getAnnotations();
+			map<string, string>::const_iterator it, end = annotations.end();
+			for (it = annotations.begin(); it != end; it++) {
+				string name = it->first;
+				for (string::size_type i = 0; i < name.size(); i++) {
+					name[i] = toupper(name[i]);
+				}
+				params.set(name, it->second);
+			}
+		} else {
+			params.set("TITLE", "Internal server error");
+		}
+
+		string content = Template::apply(readAll(generalErrorFile), params);
+		params.set("CONTENT", content);
+
+		return Template::apply(readAll(errorLayoutFile), params);
+	}
+
+	string renderWithoutDetails() const {
+		string templateFile = templatesDir + "/undisclosed_error.html.template";
+		StringMap<StaticString> params;
+
+		params.set("PROGRAM_NAME", PROGRAM_NAME);
+		params.set("NGINX_DOC_URL", NGINX_DOC_URL);
+		params.set("APACHE2_DOC_URL", APACHE2_DOC_URL);
+		params.set("STANDALONE_DOC_URL", STANDALONE_DOC_URL);
+
+		return Template::apply(readAll(templateFile), params);
+	}
+};
+
+
+} // namespace ApplicationPool2
+} // namespace Passenger
+
+#endif /* _PASSENGER_APPLICATION_POOL2_ERROR_RENDERER_H_ */

data/ext/common/ApplicationPool2/Implementation.cpp

@@ -25,6 +25,8 @@
 #include <typeinfo>
 #include <algorithm>
 #include <utility>
+#include <sstream>
+#include <limits.h>
 #include <boost/make_shared.hpp>
 #include <boost/date_time/posix_time/posix_time_types.hpp>
 #include <oxt/backtrace.hpp>
@@ -32,10 +34,13 @@
 #include <ApplicationPool2/SuperGroup.h>
 #include <ApplicationPool2/Group.h>
 #include <ApplicationPool2/PipeWatcher.h>
+#include <ApplicationPool2/ErrorRenderer.h>
 #include <Exceptions.h>
 #include <MessageReadersWriters.h>
+#include <Utils.h>
 #include <Utils/ScopeGuard.h>
 #include <Utils/MessageIO.h>
+#include <Utils/JsonUtils.h>
 
 namespace Passenger {
 namespace ApplicationPool2 {
@@ -136,6 +141,146 @@ rethrowException(const ExceptionPtr &e) {
 	throw tracable_exception(*e);
 }
 
+void processAndLogNewSpawnException(SpawnException &e, const Options &options,
+	const SpawnerConfigPtr &config)
+{
+	TRACE_POINT();
+	UnionStation::TransactionPtr transaction;
+	ErrorRenderer renderer(config->resourceLocator);
+	string appMessage = e.getErrorPage();
+	string errorId;
+	char filename[PATH_MAX];
+	stringstream stream;
+
+	if (options.analytics && config->unionStationCore != NULL) {
+		try {
+			UPDATE_TRACE_POINT();
+			transaction = config->unionStationCore->newTransaction(
+				options.getAppGroupName(),
+				"exceptions",
+				options.unionStationKey);
+			errorId = transaction->getTxnId();
+		} catch (const tracable_exception &e2) {
+			transaction.reset();
+			P_WARN("Cannot log to Union Station: " << e2.what() <<
+				"\n  Backtrace:\n" << e2.backtrace());
+		}
+	}
+
+	UPDATE_TRACE_POINT();
+	if (appMessage.empty()) {
+		appMessage = "none";
+	}
+	if (errorId.empty()) {
+		errorId = config->randomGenerator->generateHexString(4);
+	}
+	e.set("error_id", errorId);
+
+	try {
+		int fd = -1;
+		FdGuard guard(fd, true);
+		string errorPage;
+
+		UPDATE_TRACE_POINT();
+		errorPage = renderer.renderWithDetails(appMessage, options, &e);
+
+		#if defined(__linux__) || defined(__APPLE__) || defined(__FreeBSD__)
+			snprintf(filename, PATH_MAX, "%s/passenger-error-XXXXXX.html",
+				getSystemTempDir());
+			fd = mkstemps(filename, sizeof(".html") - 1);
+		#else
+			snprintf(filename, PATH_MAX, "%s/passenger-error.XXXXXX",
+				getSystemTempDir());
+			fd = mkstemp(filename);
+		#endif
+		if (fd == -1) {
+			int e = errno;
+			throw SystemException("Cannot generate a temporary filename",
+				e);
+		}
+
+		UPDATE_TRACE_POINT();
+		writeExact(fd, errorPage);
+	} catch (const SystemException &e2) {
+		filename[0] = '\0';
+		P_ERROR("Cannot render an error page: " << e2.what() << "\n" <<
+			e2.backtrace());
+	}
+
+	if (transaction != NULL) {
+		try {
+			UPDATE_TRACE_POINT();
+			transaction->message("Context: spawning");
+			transaction->message("Message: " +
+				jsonString(e.what()));
+			transaction->message("App message: " +
+				jsonString(appMessage));
+
+			const char *kind;
+			switch (e.getErrorKind()) {
+			case SpawnException::PRELOADER_STARTUP_ERROR:
+				kind = "PRELOADER_STARTUP_ERROR";
+				break;
+			case SpawnException::PRELOADER_STARTUP_PROTOCOL_ERROR:
+				kind = "PRELOADER_STARTUP_PROTOCOL_ERROR";
+				break;
+			case SpawnException::PRELOADER_STARTUP_TIMEOUT:
+				kind = "PRELOADER_STARTUP_TIMEOUT";
+				break;
+			case SpawnException::PRELOADER_STARTUP_EXPLAINABLE_ERROR:
+				kind = "PRELOADER_STARTUP_EXPLAINABLE_ERROR";
+				break;
+			case SpawnException::APP_STARTUP_ERROR:
+				kind = "APP_STARTUP_ERROR";
+				break;
+			case SpawnException::APP_STARTUP_PROTOCOL_ERROR:
+				kind = "APP_STARTUP_PROTOCOL_ERROR";
+				break;
+			case SpawnException::APP_STARTUP_TIMEOUT:
+				kind = "APP_STARTUP_TIMEOUT";
+				break;
+			case SpawnException::APP_STARTUP_EXPLAINABLE_ERROR:
+				kind = "APP_STARTUP_EXPLAINABLE_ERROR";
+				break;
+			default:
+				kind = "UNDEFINED_ERROR";
+				break;
+			}
+			transaction->message(string("Kind: ") + kind);
+
+			Json::Value details;
+			const map<string, string> &annotations = e.getAnnotations();
+			map<string, string>::const_iterator it, end = annotations.end();
+
+			for (it = annotations.begin(); it != end; it++) {
+				details[it->first] = it->second;
+			}
+
+			// This information is not very useful. Union Station
+			// already collects system metrics.
+			details.removeMember("system_metrics");
+			// Don't include environment variables because they may
+			// contain sensitive information.
+			details.removeMember("envvars");
+
+			transaction->message("Details: " + stringifyJson(details));
+		} catch (const tracable_exception &e2) {
+			P_WARN("Cannot log to Union Station: " << e2.what() <<
+				"\n  Backtrace:\n" << e2.backtrace());
+		}
+	}
+
+	UPDATE_TRACE_POINT();
+	stream << "Could not spawn process for application " << options.appRoot <<
+		": " << e.what() << "\n" <<
+		"  Error ID: " << errorId << "\n";
+	if (filename[0] != '\0') {
+		stream << "  Error details saved to: " << filename << "\n";
+	}
+	stream << "  Message from application: " << appMessage << "\n";
+	P_ERROR(stream.str());
+}
+
 
 const SuperGroupPtr
 Pool::getSuperGroup(const char *name) {
@@ -155,7 +300,7 @@ SuperGroup::runAllActions(const vector<Callback> &actions) {
 
 string
 SuperGroup::generateSecret() const {
-	return getPool()->randomGenerator->generateAsciiString(43);
+	return getPool()->getRandomGenerator()->generateAsciiString(43);
 }
 
 void
@@ -187,6 +332,8 @@ SuperGroup::realDoInitialize(const Options &options, unsigned int generation) {
 	vector<ComponentInfo> componentInfos;
 	vector<ComponentInfo>::const_iterator it;
 	ExceptionPtr exception;
+
+	PoolPtr pool = getPool();
 	
 	P_TRACE(2, "Initializing SuperGroup " << inspect() << " in the background...");
 	try {
@@ -198,13 +345,15 @@ SuperGroup::realDoInitialize(const Options &options, unsigned int generation) {
 		string message = "The directory " +
 			options.appRoot +
 			" does not seem to contain a web application.";
-		exception = boost::make_shared<SpawnException>(
-			message, message, false);
+		boost::shared_ptr<SpawnException> spawnException =
+			boost::make_shared<SpawnException>(
+				message, message, false);
+		exception = spawnException;
+		processAndLogNewSpawnException(*spawnException, options,
+			pool->getSpawnerConfig());
 	}
 	
-	PoolPtr pool = getPool();
 	Pool::DebugSupportPtr debug = pool->debugSupport;
-	
 	vector<Callback> actions;
 	{
 		if (debug != NULL && debug->superGroup) {
@@ -805,7 +954,9 @@ Group::spawnThreadRealMain(const SpawnerPtr &spawner, const Options &options, un
 			this_thread::restore_interruption ri(di);
 			this_thread::restore_syscall_interruption rsi(dsi);
 			if (shouldFail) {
-				throw SpawnException("Simulated failure");
+				SpawnException e("Simulated failure");
+				processAndLogNewSpawnException(e, options, pool->getSpawnerConfig());
+				throw e;
 			} else {
 				process = spawner->spawn(options);
 				process->setGroup(shared_from_this());
@@ -878,9 +1029,6 @@ Group::spawnThreadRealMain(const SpawnerPtr &spawner, const Options &options, un
 		} else {
 			// TODO: sure this is the best thing? if there are
 			// processes currently alive we should just use them.
-			P_ERROR("Could not spawn process for group " << name <<
-				": " << exception->what() << "\n" <<
-				exception->backtrace());
 			if (enabledCount == 0) {
 				enableAllDisablingProcesses(actions);
 			}
@@ -1197,7 +1345,7 @@ Group::testOverflowRequestQueue() const {
 
 const ResourceLocator &
 Group::getResourceLocator() const {
-	return getPool()->spawnerFactory->getResourceLocator();
+	return getPool()->getSpawnerConfig()->resourceLocator;
 }
 
 // 'process' is not a reference so that bind(runAttachHooks, ...) causes the shared
@@ -1222,7 +1370,7 @@ Group::setupAttachOrDetachHook(const ProcessPtr process, HookScriptOptions &opti
 
 string
 Group::generateSecret(const SuperGroupPtr &superGroup) {
-	return superGroup->getPool()->randomGenerator->generateAsciiString(43);
+	return superGroup->getPool()->getRandomGenerator()->generateAsciiString(43);
 }