HHVM-239: Allow users to set a limit on acceptable staleness

Author: derickr

src/MongoDB/Driver/Manager.cpp

@@ -53,6 +53,7 @@ const StaticString
 	s_MongoDBDriverManager_readpreferencetags("readpreferencetags"),
 	s_MongoDBDriverManager_readPreference("readPreference"),
 	s_MongoDBDriverManager_readPreferenceTags("readPreferenceTags"),
+	s_MongoDBDriverManager_maxStalenessMS("maxStalenessMS"),
 	s_MongoDBDriverManager_readconcernlevel("readconcernlevel"),
 	s_MongoDBDriverManager_readConcernLevel("readConcernLevel"),
 	s_MongoDBDriverManager_mode("mode"),
@@ -135,7 +136,8 @@ static bool hippo_mongo_driver_manager_apply_rp(mongoc_uri_t *uri, const Array o
 		!options.exists(s_MongoDBDriverManager_readpreference) &&
 		!options.exists(s_MongoDBDriverManager_readpreferencetags) &&
 		!options.exists(s_MongoDBDriverManager_readPreference) &&
-		!options.exists(s_MongoDBDriverManager_readPreferenceTags)
+		!options.exists(s_MongoDBDriverManager_readPreferenceTags) &&
+		!options.exists(s_MongoDBDriverManager_maxStalenessMS)
 	) {
 		return true;
 	}
@@ -184,17 +186,29 @@ static bool hippo_mongo_driver_manager_apply_rp(mongoc_uri_t *uri, const Array o
 		mongoc_read_prefs_set_tags(new_rp, b_tags);
 	}
 
+	/* Validate that readPreferenceTags are not used with PRIMARY readPreference */
 	if (
 		mongoc_read_prefs_get_mode(new_rp) == MONGOC_READ_PRIMARY &&
 		!bson_empty(mongoc_read_prefs_get_tags(new_rp))
 	) {
 		throw MongoDriver::Utils::throwInvalidArgumentException("Primary read preference mode conflicts with tags");
 		mongoc_read_prefs_destroy(new_rp);
-
 		return false;
 	}
 
-	/* This may be redundant in light of the last check (primary with tags),
+	/* Handle maxStalenessMS, and make sure it is not combined with PRIMARY readPreference */
+	if (options.exists(s_MongoDBDriverManager_maxStalenessMS) && options[s_MongoDBDriverManager_maxStalenessMS].isInteger()) {
+		if (mongoc_read_prefs_get_mode(new_rp) == MONGOC_READ_PRIMARY) {
+			throw MongoDriver::Utils::throwInvalidArgumentException("Primary read preference mode conflicts with maxStalenessMS");
+			mongoc_read_prefs_destroy(new_rp);
+
+			return false;
+		}
+
+		mongoc_read_prefs_set_max_staleness_ms(new_rp, (int32_t) options[s_MongoDBDriverManager_maxStalenessMS].toInt64());
+	}
+
+	/* This may be redundant in light of the check for primary with tags,
 	 * but we'll check anyway in case additional validation is implemented. */
 	if (!mongoc_read_prefs_is_valid(new_rp)) {
 		throw MongoDriver::Utils::throwInvalidArgumentException("Read preference is not valid");
@@ -337,7 +351,8 @@ static mongoc_uri_t *hippo_mongo_driver_manager_make_uri(const char *dsn, const
 			!strcasecmp(s_key, "safe") ||
 			!strcasecmp(s_key, "slaveok") ||
 			!strcasecmp(s_key, "w") ||
-			!strcasecmp(s_key, "wtimeoutms")
+			!strcasecmp(s_key, "wtimeoutms") ||
+			!strcasecmp(s_key, "maxstalenessms")
 		) {
 			continue;
 		}

tests/MongoDBDriverManager_maxStalenessMS-001.phpt

@@ -0,0 +1,11 @@
+--TEST--
+MongoDB\Driver\Manager: maxStalenessMS
+--FILE--
+<?php
+// They both should work, and produce no output. We're not testing whether the flag actually does something
+$manager = new MongoDB\Driver\Manager("mongodb://localhost/?readPreference=SECONDARY&maxStalenessMS=1231");
+$manager = new MongoDB\Driver\Manager("mongodb://localhost/?readPreference=SECONDARY", [ 'maxStalenessMS' => 1231 ] );
+?>
+==DONE==
+--EXPECTF--
+==DONE==

tests/MongoDBDriverManager_maxStalenessMS_error-001.phpt

@@ -0,0 +1,19 @@
+--TEST--
+MongoDB\Driver\Manager: maxStalenessMS
+--FILE--
+<?php
+try {
+	$manager = new MongoDB\Driver\Manager("mongodb://localhost/?maxStalenessMS=1231");
+} catch ( MongoDB\Driver\Exception\InvalidArgumentException $e ) {
+	echo $e->getMessage(), "\n";
+}
+
+try {
+	$manager = new MongoDB\Driver\Manager("mongodb://localhost/", [ 'maxStalenessMS' => 1231 ] );
+} catch ( MongoDB\Driver\Exception\InvalidArgumentException $e ) {
+	echo $e->getMessage(), "\n";
+}
+?>
+--EXPECTF--
+Failed to parse MongoDB URI: 'mongodb://localhost/?maxStalenessMS=1231'
+Primary read preference mode conflicts with maxStalenessMS