PHPC-752: Allow users to set a limit on acceptable staleness

Author: derickr

php_phongo.c

@@ -1004,7 +1004,9 @@ static mongoc_uri_t *php_phongo_make_uri(const char *uri_string, bson_t *options
 			    !strcasecmp(key, "safe") ||
 			    !strcasecmp(key, "slaveok") ||
 			    !strcasecmp(key, "w") ||
-			    !strcasecmp(key, "wtimeoutms")) {
+			    !strcasecmp(key, "wtimeoutms") ||
+			    !strcasecmp(key, "maxstalenessms")
+			) {
 				continue;
 			}
 
@@ -1090,7 +1092,9 @@ static bool php_phongo_apply_rp_options_to_uri(mongoc_uri_t *uri, bson_t *option
 
 	if (!bson_iter_init_find_case(&iter, options, "slaveok") &&
 	    !bson_iter_init_find_case(&iter, options, "readpreference") &&
-	    !bson_iter_init_find_case(&iter, options, "readpreferencetags")) {
+	    !bson_iter_init_find_case(&iter, options, "readpreferencetags") &&
+	    !bson_iter_init_find_case(&iter, options, "maxstalenessms")
+	) {
 		return true;
 	}
 
@@ -1141,6 +1145,19 @@ static bool php_phongo_apply_rp_options_to_uri(mongoc_uri_t *uri, bson_t *option
 		return false;
 	}
 
+	/* Handle maxStalenessMS, and make sure it is not combined with primary
+	 * readPreference */
+	if (bson_iter_init_find_case(&iter, options, "maxstalenessms") && BSON_ITER_HOLDS_INT32(&iter)) {
+		if (mongoc_read_prefs_get_mode(new_rp) == MONGOC_READ_PRIMARY) {
+			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Primary read preference mode conflicts with maxStalenessMS");
+			mongoc_read_prefs_destroy(new_rp);
+
+			return false;
+		}
+
+		mongoc_read_prefs_set_max_staleness_ms(new_rp, bson_iter_int32(&iter));
+	}
+
 	/* This may be redundant in light of the last check (primary with tags), but
 	 * we'll check anyway in case additional validation is implemented. */
 	if (!mongoc_read_prefs_is_valid(new_rp)) {

tests/manager/manager-maxstalenessms-001.phpt

@@ -0,0 +1,13 @@
+--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 ] );
+$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/manager/manager-maxstalenessms_error-001.phpt

@@ -0,0 +1,33 @@
+--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";
+}
+
+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'
+Failed to parse MongoDB URI: 'mongodb://localhost/?maxStalenessMS=1231'
+Primary read preference mode conflicts with maxStalenessMS
+Primary read preference mode conflicts with maxStalenessMS