passenger 5.1.4 → 5.1.5

data/src/agent/Core/ResponseCache.h

@@ -492,12 +492,12 @@ public:
 		}
 
 		LString *varyCookieName = req->secureHeaders.lookup(PASSENGER_VARY_TURBOCACHE_BY_COOKIE);
-		if (varyCookieName == NULL && !controller->defaultVaryTurbocacheByCookie.empty()) {
+		if (varyCookieName == NULL && !req->configCache->defaultVaryTurbocacheByCookie.empty()) {
 			varyCookieName = (LString *) psg_palloc(req->pool, sizeof(LString));
 			psg_lstr_init(varyCookieName);
 			psg_lstr_append(varyCookieName, req->pool,
-				controller->defaultVaryTurbocacheByCookie.data(),
-				controller->defaultVaryTurbocacheByCookie.size());
+				req->configCache->defaultVaryTurbocacheByCookie.data(),
+				req->configCache->defaultVaryTurbocacheByCookie.size());
 		}
 		if (varyCookieName != NULL) {
 			LString *cookieHeader = req->headers.lookup(COOKIE);

data/src/agent/Core/SpawningKit/SmartSpawner.h

@@ -428,7 +428,9 @@ private:
 					details);
 			} catch (const TimeoutException &) {
 				throwPreloaderSpawnException("An error occurred while starting up "
-					"the preloader: it did not write a startup response in time.",
+					"the preloader: it did not write a startup response in time. "
+					"If your app needs more time to start you can increase the "
+					"Passenger start timeout config option.",
 					SpawnException::PRELOADER_STARTUP_TIMEOUT,
 					details);
 			}
@@ -500,7 +502,9 @@ private:
 					details);
 			} catch (const TimeoutException &) {
 				throwPreloaderSpawnException("An error occurred while starting up "
-					"the preloader: it did not write a startup response in time.",
+					"the preloader: it did not write a startup response in time. "
+					"If your app needs more time to start you can increase the "
+					"Passenger start timeout config option.",
 					SpawnException::PRELOADER_STARTUP_TIMEOUT,
 					details);
 			}
@@ -607,7 +611,9 @@ private:
 					details);
 			} catch (const TimeoutException &) {
 				throwPreloaderSpawnException("An error occurred while starting up "
-					"the preloader: it did not write a startup response in time.",
+					"the preloader: it did not write a startup response in time. "
+					"If your app needs more time to start you can increase the "
+					"Passenger start timeout config option.",
 					SpawnException::PRELOADER_STARTUP_TIMEOUT,
 					details);
 			}

data/src/agent/Core/SpawningKit/Spawner.h

@@ -331,14 +331,16 @@ private:
 					details);
 			} catch (const TimeoutException &) {
 				throwAppSpawnException("An error occurred while starting the "
-					"web application: it did not write a startup response in time.",
+					"web application: it did not write a startup response in time. "
+					"If your app needs more time to start you can increase the "
+					"Passenger start timeout config option.",
 					SpawnException::APP_STARTUP_TIMEOUT,
 					details);
 			}
 
 			if (line.empty()) {
 				throwAppSpawnException("An error occurred while starting the "
-					"web application. It unexpected closed the connection while "
+					"web application. It unexpectedly closed the connection while "
 					"sending its startup response.",
 					SpawnException::APP_STARTUP_PROTOCOL_ERROR,
 					details);
@@ -1133,7 +1135,9 @@ protected:
 					details);
 			} catch (const TimeoutException &) {
 				throwAppSpawnException("An error occurred while starting the "
-					"web application: it did not write a startup response in time.",
+					"web application: it did not write a startup response in time. "
+					"If your app needs more time to start you can increase the "
+					"Passenger start timeout config option.",
 					SpawnException::APP_STARTUP_TIMEOUT,
 					details);
 			}

data/src/agent/UstRouter/ApiServer.h

@@ -271,8 +271,9 @@ public:
 	string fdPassingPassword;
 	EventFd *exitEvent;
 
-	ApiServer(ServerKit::Context *context)
-		: ParentClass(context),
+	ApiServer(ServerKit::Context *context, const ServerKit::HttpServerSchema &schema,
+		const Json::Value &initialConfig = Json::Value())
+		: ParentClass(context, schema, initialConfig),
 		  controller(NULL),
 		  apiAccountDatabase(NULL),
 		  exitEvent(NULL)

data/src/agent/UstRouter/Controller.h

@@ -35,6 +35,7 @@
 #include <oxt/backtrace.hpp>
 #include <ev++.h>
 #include <SmallVector.h>
+#include <ConfigKit/ConfigKit.h>
 #include <ServerKit/Server.h>
 #include <StaticString.h>
 #include <Constants.h>
@@ -49,7 +50,6 @@
 #include <Utils/StrIntUtils.h>
 #include <Utils/StringMap.h>
 #include <Utils/SystemTime.h>
-#include <Utils/VariantMap.h>
 
 
 namespace Passenger {
@@ -77,12 +77,6 @@ private:
 	typedef StringMap<TransactionPtr> TransactionMap;
 	typedef StringMap<LogSinkPtr> LogSinkCache;
 
-	string username;
-	string password;
-	string dumpDir;
-	string defaultNodeName;
-	bool devMode;
-
 	RandomGenerator randomGenerator;
 	TransactionMap transactions;
 	LogSinkCache logSinkCache;
@@ -91,6 +85,7 @@ private:
 
 	ev::timer gcTimer;
 	ev::timer flushTimer;
+	bool devMode;
 	int sinkFlushInterval;
 
 
@@ -130,7 +125,7 @@ private:
 		}
 
 		StaticString username = client->scalarReader.value();
-		if (!constantTimeCompare(username, this->username)) {
+		if (!constantTimeCompare(username, config["ust_router_username"].asString())) {
 			sendErrorToClient(client, "Invalid username or password");
 			if (client->connected()) {
 				disconnectWithError(&client, "Client sent invalid username");
@@ -167,7 +162,7 @@ private:
 		}
 
 		StaticString password = client->scalarReader.value();
-		if (!constantTimeCompare(password, this->password)) {
+		if (!constantTimeCompare(password, config["ust_router_password"].asString())) {
 			sendErrorToClient(client, "Invalid username or password");
 			if (client->connected()) {
 				disconnectWithError(&client, "Client sent invalid password");
@@ -602,7 +597,7 @@ private:
 
 		nodeName = getStaticString(args, 1);
 		if (nodeName.empty()) {
-			client->nodeName = defaultNodeName;
+			client->nodeName = config["ust_router_default_node_name"].asString();
 		} else {
 			client->nodeName.assign(nodeName.data(), nodeName.size());
 		}
@@ -902,7 +897,7 @@ private:
 
 		LogSinkPtr sink = logSinkCache.get(StaticString(cacheKey, cacheKeySize));
 		if (sink == NULL) {
-			string dumpFile = dumpDir + "/" + category;
+			string dumpFile = config["ust_router_dump_dir"].asString() + "/" + category;
 			SKC_DEBUG(client, "Creating dump file: " << dumpFile);
 			sink = boost::make_shared<FileSink>(this, dumpFile);
 			sink->opened = 1;
@@ -1059,6 +1054,16 @@ private:
 		return *filter;
 	}
 
+	void applyConfigUpdates() {
+		devMode = config["ust_router_dev_mode"].asBool();
+
+		unsigned int sinkFlushTimerInterval =
+			config["analytics_sink_flush_timer_interval"].asUInt();
+		sinkFlushInterval = config["analytics_sink_flush_interval"].asUInt();
+		flushTimer.stop();
+		flushTimer.start(sinkFlushTimerInterval, sinkFlushTimerInterval);
+	}
+
 protected:
 	virtual void reinitializeClient(Client *client, int fd) {
 		ParentClass::reinitializeClient(client, fd);
@@ -1130,6 +1135,11 @@ protected:
 		}
 	}
 
+	virtual void onConfigChange(const ConfigKit::Store *oldConfig) {
+		ParentClass::onConfigChange(oldConfig);
+		applyConfigUpdates();
+	}
+
 	virtual void onShutdown(bool forceDisconnect) {
 		gcTimer.stop();
 		flushTimer.stop();
@@ -1137,32 +1147,56 @@ protected:
 	}
 
 public:
-	Controller(ServerKit::Context *context, const VariantMap &options = VariantMap())
-		: ServerKit::BaseServer<Controller, Client>(context),
-		  username(options.get("ust_router_username", false, "")),
-		  password(options.get("ust_router_password", false, "")),
-		  dumpDir(options.get("ust_router_dump_dir", false, "/tmp")),
-		  defaultNodeName(options.get("ust_router_default_node_name", false, "")),
-		  devMode(options.getBool("ust_router_dev_mode", false, false)),
+	class Schema: public ServerKit::BaseServerSchema {
+	private:
+		static Json::Value getDefaultValueForDefaultNodeName(const ConfigKit::Store &store) {
+			return getHostName();
+		}
+
+	public:
+		Schema()
+			: ServerKit::BaseServerSchema(false)
+		{
+			using namespace ConfigKit;
+
+			add("ust_router_username", STRING_TYPE, OPTIONAL);
+			add("ust_router_password", STRING_TYPE, OPTIONAL);
+			add("ust_router_dump_dir", STRING_TYPE, OPTIONAL, "/tmp");
+			addWithDynamicDefault(
+				"ust_router_default_node_name",
+				STRING_TYPE, OPTIONAL | CACHE_DEFAULT_VALUE,
+				getDefaultValueForDefaultNodeName);
+			add("ust_router_dev_mode", BOOL_TYPE, OPTIONAL, false);
+			add("union_station_gateway_address", STRING_TYPE, OPTIONAL | READ_ONLY, DEFAULT_UNION_STATION_GATEWAY_ADDRESS);
+			add("union_station_gateway_port", UINT_TYPE, OPTIONAL | READ_ONLY, DEFAULT_UNION_STATION_GATEWAY_PORT);
+			add("union_station_gateway_cert", STRING_TYPE, OPTIONAL | READ_ONLY);
+			add("union_station_proxy_address", STRING_TYPE, OPTIONAL | READ_ONLY);
+			add("analytics_sink_flush_timer_interval", UINT_TYPE, OPTIONAL, 5);
+			add("analytics_sink_flush_interval", UINT_TYPE, OPTIONAL, 0);
+
+			finalize();
+		}
+	};
+
+	Controller(ServerKit::Context *context, const Schema &schema,
+		const Json::Value &initialConfig)
+		: ServerKit::BaseServer<Controller, Client>(context, schema, initialConfig),
 		  remoteSender(
-		      options.get("union_station_gateway_address", false, DEFAULT_UNION_STATION_GATEWAY_ADDRESS),
-		      options.getInt("union_station_gateway_port", false, DEFAULT_UNION_STATION_GATEWAY_PORT),
-		      options.get("union_station_gateway_cert", false, ""),
-		      options.get("union_station_proxy_address", false, "")),
+		      config["union_station_gateway_address"].asString(),
+		      config["union_station_gateway_port"].asUInt(),
+		      config["union_station_gateway_cert"].asString(),
+		      config["union_station_proxy_address"].asString()),
 		  gcTimer(getLoop()),
-		  flushTimer(getLoop())
+		  flushTimer(getLoop()),
+		  devMode(false),
+		  sinkFlushInterval(0)
 	{
-		if (defaultNodeName.empty()) {
-			defaultNodeName = getHostName();
-		}
-
 		gcTimer.set<Controller, &Controller::garbageCollect>(this);
 		gcTimer.start(GARBAGE_COLLECTION_TIMEOUT, GARBAGE_COLLECTION_TIMEOUT);
 
-		int sinkFlushTimerInterval = options.getInt("analytics_sink_flush_timer_interval", false, 5);
-		sinkFlushInterval = options.getInt("analytics_sink_flush_interval", false, 0);
 		flushTimer.set<Controller, &Controller::flushSomeSinks>(this);
-		flushTimer.start(sinkFlushTimerInterval, sinkFlushTimerInterval);
+
+		applyConfigUpdates();
 	}
 
 	virtual StaticString getServerName() const {
@@ -1184,11 +1218,11 @@ public:
 		doc["log_sink_cache"] = inspectLogSinkCacheStateAsJson();
 		doc["transactions"] = inspectTransactionsStateAsJson();
 		if (devMode) {
-			doc["dump_dir"] = dumpDir;
+			doc["dump_dir"] = config["ust_router_dump_dir"];
 		} else {
 			doc["remote_sender"] = remoteSender.inspectStateAsJson();
 		}
-		doc["default_node_name"] = defaultNodeName;
+		doc["default_node_name"] = config["ust_router_default_node_name"];
 		return doc;
 	}
 

data/src/agent/UstRouter/UstRouterMain.cpp

@@ -55,6 +55,7 @@
 #include <BackgroundEventLoop.h>
 #include <ResourceLocator.h>
 #include <Constants.h>
+#include <ConfigKit/VariantMapUtils.h>
 #include <Utils.h>
 #include <Utils/IOUtils.h>
 #include <Utils/StrIntUtils.h>
@@ -77,10 +78,12 @@ namespace UstRouter {
 
 		BackgroundEventLoop *bgloop;
 		ServerKit::Context *serverKitContext;
+		Controller::Schema controllerSchema;
 		Controller *controller;
 
 		BackgroundEventLoop *apiBgloop;
 		ServerKit::Context *apiServerKitContext;
+		ServerKit::HttpServerSchema apiServerSchema;
 		UstRouter::ApiServer *apiServer;
 		EventFd exitEvent;
 		EventFd allClientsDisconnectedEvent;
@@ -306,7 +309,10 @@ initializeUnprivilegedWorkingObjects() {
 	wo->bgloop = new BackgroundEventLoop(true, true);
 	wo->serverKitContext = new ServerKit::Context(wo->bgloop->safe,
 		wo->bgloop->libuv_loop);
-	wo->controller = new Controller(wo->serverKitContext, options);
+	wo->controller = new Controller(wo->serverKitContext,
+		wo->controllerSchema,
+		ConfigKit::variantMapToJson(wo->controllerSchema, options));
+	wo->controller->initialize();
 	wo->controller->listen(wo->serverSocketFd);
 
 	UPDATE_TRACE_POINT();
@@ -314,13 +320,15 @@ initializeUnprivilegedWorkingObjects() {
 		wo->apiBgloop = new BackgroundEventLoop(true, true);
 		wo->apiServerKitContext = new ServerKit::Context(wo->apiBgloop->safe,
 			wo->apiBgloop->libuv_loop);
-		wo->apiServer = new UstRouter::ApiServer(wo->apiServerKitContext);
+		wo->apiServer = new UstRouter::ApiServer(wo->apiServerKitContext,
+			wo->apiServerSchema);
 		wo->apiServer->controller = wo->controller;
 		wo->apiServer->apiAccountDatabase = &wo->apiAccountDatabase;
 		wo->apiServer->instanceDir = options.get("instance_dir", false);
 		wo->apiServer->fdPassingPassword = options.get("watchdog_fd_passing_password", false);
 		wo->apiServer->exitEvent = &wo->exitEvent;
 		wo->apiServer->shutdownFinishCallback = apiServerShutdownFinished;
+		wo->apiServer->initialize();
 		foreach (fd, wo->apiSockets) {
 			wo->apiServer->listen(fd);
 		}

data/src/agent/Watchdog/ApiServer.h

@@ -285,8 +285,9 @@ public:
 	EventFd *exitEvent;
 	string fdPassingPassword;
 
-	ApiServer(ServerKit::Context *context)
-		: ParentClass(context),
+	ApiServer(ServerKit::Context *context, const ServerKit::HttpServerSchema &schema,
+		const Json::Value &initialConfig = Json::Value())
+		: ParentClass(context, schema, initialConfig),
 		  apiAccountDatabase(NULL),
 		  exitEvent(NULL)
 		{ }

data/src/agent/Watchdog/WatchdogMain.cpp

@@ -125,6 +125,7 @@ namespace WatchdogAgent {
 		int apiServerFds[SERVER_KIT_MAX_SERVER_ENDPOINTS];
 		BackgroundEventLoop *bgloop;
 		ServerKit::Context *serverKitContext;
+		ServerKit::HttpServerSchema apiServerSchema;
 		ApiServer *apiServer;
 
 		WorkingObjects()
@@ -1155,10 +1156,11 @@ initializeApiServer(const WorkingObjectsPtr &wo) {
 		absolutizePath(options.get("data_buffer_dir"));
 
 	UPDATE_TRACE_POINT();
-	wo->apiServer = new ApiServer(wo->serverKitContext);
+	wo->apiServer = new ApiServer(wo->serverKitContext, wo->apiServerSchema);
 	wo->apiServer->apiAccountDatabase = &wo->apiAccountDatabase;
 	wo->apiServer->exitEvent = &wo->exitEvent;
 	wo->apiServer->fdPassingPassword = options.get("watchdog_fd_passing_password");
+	wo->apiServer->initialize();
 	for (unsigned int i = 0; i < apiAddresses.size(); i++) {
 		wo->apiServer->listen(wo->apiServerFds[i]);
 	}

data/src/apache2_module/ConfigurationCommands.cpp

@@ -170,7 +170,7 @@ AP_INIT_TAKE1("PassengerRestartDir",
 AP_INIT_TAKE1("PassengerAppGroupName",
 	(Take1Func) cmd_passenger_app_group_name,
 	NULL,
-	OR_OPTIONS | ACCESS_CONF | RSRC_CONF,
+	ACCESS_CONF | RSRC_CONF,
 	"Application process group name."),
 AP_INIT_TAKE1("PassengerForceMaxConcurrentRequestsPerProcess",
 	(Take1Func) cmd_passenger_force_max_concurrent_requests_per_process,

data/src/cxx_supportlib/ConfigKit/Common.h

@@ -0,0 +1,125 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2017 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  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_CONFIG_KIT_COMMON_H_
+#define _PASSENGER_CONFIG_KIT_COMMON_H_
+
+#include <boost/function.hpp>
+#include <string>
+#include <vector>
+
+#include <jsoncpp/json.h>
+
+#include <StaticString.h>
+
+namespace Passenger {
+namespace ConfigKit {
+
+using namespace std;
+
+
+class Store;
+
+enum Type {
+	STRING_TYPE,
+	INT_TYPE,
+	UINT_TYPE,
+	FLOAT_TYPE,
+	BOOL_TYPE,
+	UNKNOWN_TYPE
+};
+
+enum Flags {
+	OPTIONAL = 0,
+	REQUIRED = 1 << 0,
+	CACHE_DEFAULT_VALUE = 1 << 1,
+	READ_ONLY = 1 << 2,
+
+	_DYNAMIC_DEFAULT_VALUE = 1 << 30,
+	_FROM_SUBSCHEMA = 1 << 31
+};
+
+/** Represents a validation error. */
+class Error {
+private:
+	static string dummyKeyProcessor(const StaticString &key) {
+		return key.toString();
+	}
+
+	string rawMessage;
+
+public:
+	typedef boost::function<string (const StaticString &key)> KeyProcessor;
+
+	Error() { }
+
+	Error(const string &_rawMessage)
+		: rawMessage(_rawMessage)
+		{ }
+
+	string getMessage() const {
+		return getMessage(dummyKeyProcessor);
+	}
+
+	string getMessage(const KeyProcessor &processor) const {
+		string result = rawMessage;
+		string::size_type searchBegin = 0;
+		bool done = false;
+
+		while (!done) {
+			string::size_type pos = result.find("{{", searchBegin);
+			if (pos == string::npos) {
+				done = true;
+				break;
+			}
+
+			string::size_type endPos = result.find("}}", pos + 2);
+			if (endPos == string::npos) {
+				done = true;
+				break;
+			}
+
+			string key = result.substr(pos + 2, endPos - pos - 2);
+			string replacement = processor(key);
+			result.replace(pos, endPos - pos + 2, replacement);
+			searchBegin = pos + replacement.size();
+		}
+		return result;
+	}
+
+	bool operator<(const Error &other) const {
+		return rawMessage < other.rawMessage;
+	}
+};
+
+typedef boost::function<Json::Value (const Store &store)> ValueGetter;
+typedef boost::function<void (const Json::Value &config, const vector<Error> &errors)> ConfigCallback;
+typedef boost::function<void (const Json::Value &config)> InspectCallback;
+
+
+} // namespace ConfigKit
+} // namespace Passenger
+
+#endif /* _PASSENGER_CONFIG_KIT_COMMON_H_ */