PHPC-1756: Remove oppressive terminology from source code (#1221)

alcaeus · web-flow · commit a612c370f62d · 2021-06-22T19:30:56.000+02:00
* Use latest version of libmongoc

* Remove deprecated terminology for primary

* Remove deprecated terminology for secondary

* Fix clang-format

* Remove check for legacy field

* Fix missing space in error expectation

* Harden test expectation around primary checks
diff --git a/php_phongo.c b/php_phongo.c
@@ -1164,8 +1164,8 @@ php_phongo_server_description_type_t php_phongo_server_description_type(mongoc_s
 
 bool php_phongo_server_to_zval(zval* retval, mongoc_server_description_t* sd) /* {{{ */
 {
-	mongoc_host_list_t* host      = mongoc_server_description_host(sd);
-	const bson_t*       is_master = mongoc_server_description_ismaster(sd);
+	mongoc_host_list_t* host           = mongoc_server_description_host(sd);
+	const bson_t*       hello_response = mongoc_server_description_hello_response(sd);
 	bson_iter_t         iter;
 
 	array_init(retval);
@@ -1176,10 +1176,10 @@ bool php_phongo_server_to_zval(zval* retval, mongoc_server_description_t* sd) /*
 	ADD_ASSOC_BOOL_EX(retval, "is_primary", !strcmp(mongoc_server_description_type(sd), php_phongo_server_description_type_map[PHONGO_SERVER_RS_PRIMARY].name));
 	ADD_ASSOC_BOOL_EX(retval, "is_secondary", !strcmp(mongoc_server_description_type(sd), php_phongo_server_description_type_map[PHONGO_SERVER_RS_SECONDARY].name));
 	ADD_ASSOC_BOOL_EX(retval, "is_arbiter", !strcmp(mongoc_server_description_type(sd), php_phongo_server_description_type_map[PHONGO_SERVER_RS_ARBITER].name));
-	ADD_ASSOC_BOOL_EX(retval, "is_hidden", bson_iter_init_find_case(&iter, is_master, "hidden") && bson_iter_as_bool(&iter));
-	ADD_ASSOC_BOOL_EX(retval, "is_passive", bson_iter_init_find_case(&iter, is_master, "passive") && bson_iter_as_bool(&iter));
+	ADD_ASSOC_BOOL_EX(retval, "is_hidden", bson_iter_init_find_case(&iter, hello_response, "hidden") && bson_iter_as_bool(&iter));
+	ADD_ASSOC_BOOL_EX(retval, "is_passive", bson_iter_init_find_case(&iter, hello_response, "passive") && bson_iter_as_bool(&iter));
 
-	if (bson_iter_init_find(&iter, is_master, "tags") && BSON_ITER_HOLDS_DOCUMENT(&iter)) {
+	if (bson_iter_init_find(&iter, hello_response, "tags") && BSON_ITER_HOLDS_DOCUMENT(&iter)) {
 		const uint8_t*        bytes;
 		uint32_t              len;
 		php_phongo_bson_state state;
@@ -1199,12 +1199,12 @@ bool php_phongo_server_to_zval(zval* retval, mongoc_server_description_t* sd) /*
 
 		PHONGO_BSON_INIT_DEBUG_STATE(state);
 
-		if (!php_phongo_bson_to_zval_ex(bson_get_data(is_master), is_master->len, &state)) {
+		if (!php_phongo_bson_to_zval_ex(bson_get_data(hello_response), hello_response->len, &state)) {
 			zval_ptr_dtor(&state.zchild);
 			return false;
 		}
 
-		ADD_ASSOC_ZVAL_EX(retval, "last_is_master", &state.zchild);
+		ADD_ASSOC_ZVAL_EX(retval, "last_hello_response", &state.zchild);
 	}
 	ADD_ASSOC_LONG_EX(retval, "round_trip_time", (zend_long) mongoc_server_description_round_trip_time(sd));
 
@@ -1553,7 +1553,6 @@ static bool php_phongo_apply_options_to_uri(mongoc_uri_t* uri, bson_t* options)
 			!strcasecmp(key, MONGOC_URI_READPREFERENCE) ||
 			!strcasecmp(key, MONGOC_URI_READPREFERENCETAGS) ||
 			!strcasecmp(key, MONGOC_URI_SAFE) ||
-			!strcasecmp(key, MONGOC_URI_SLAVEOK) ||
 			!strcasecmp(key, MONGOC_URI_W) ||
 			!strcasecmp(key, MONGOC_URI_WTIMEOUTMS)) {
 
@@ -1793,7 +1792,6 @@ static bool php_phongo_apply_rp_options_to_uri(mongoc_uri_t* uri, bson_t* option
 	bson_iter_t                iter;
 	mongoc_read_prefs_t*       new_rp;
 	const mongoc_read_prefs_t* old_rp;
-	bool                       ignore_slaveok = false;
 
 	if (!(old_rp = mongoc_uri_get_read_prefs_t(uri))) {
 		phongo_throw_exception(PHONGO_ERROR_MONGOC_FAILED, "mongoc_uri_t does not have a read preference");
@@ -1811,19 +1809,6 @@ static bool php_phongo_apply_rp_options_to_uri(mongoc_uri_t* uri, bson_t* option
 	while (bson_iter_next(&iter)) {
 		const char* key = bson_iter_key(&iter);
 
-		if (!ignore_slaveok && !strcasecmp(key, MONGOC_URI_SLAVEOK)) {
-			if (!BSON_ITER_HOLDS_BOOL(&iter)) {
-				PHONGO_URI_INVALID_TYPE(iter, "boolean");
-				mongoc_read_prefs_destroy(new_rp);
-
-				return false;
-			}
-
-			if (bson_iter_bool(&iter)) {
-				mongoc_read_prefs_set_mode(new_rp, MONGOC_READ_SECONDARY_PREFERRED);
-			}
-		}
-
 		if (!strcasecmp(key, MONGOC_URI_READPREFERENCE)) {
 			const char* str;
 
@@ -1852,8 +1837,6 @@ static bool php_phongo_apply_rp_options_to_uri(mongoc_uri_t* uri, bson_t* option
 
 				return false;
 			}
-
-			ignore_slaveok = true;
 		}
 
 		if (!strcasecmp(key, MONGOC_URI_READPREFERENCETAGS)) {
diff --git a/src/LIBMONGOC_VERSION_CURRENT b/src/LIBMONGOC_VERSION_CURRENT
@@ -1 +1 @@
-1.18.0-20210426+git724f1672f2
+1.18.0-20210622+gitebe90917f2
diff --git a/src/MongoDB/Server.c b/src/MongoDB/Server.c
@@ -263,10 +263,10 @@ static PHP_METHOD(Server, getTags)
 	zend_restore_error_handling(&error_handling);
 
 	if ((sd = mongoc_client_get_server_description(Z_MANAGER_OBJ_P(&intern->manager)->client, intern->server_id))) {
-		const bson_t* is_master = mongoc_server_description_ismaster(sd);
+		const bson_t* hello_response = mongoc_server_description_hello_response(sd);
 		bson_iter_t   iter;
 
-		if (bson_iter_init_find(&iter, is_master, "tags") && BSON_ITER_HOLDS_DOCUMENT(&iter)) {
+		if (bson_iter_init_find(&iter, hello_response, "tags") && BSON_ITER_HOLDS_DOCUMENT(&iter)) {
 			const uint8_t*        bytes;
 			uint32_t              len;
 			php_phongo_bson_state state;
@@ -295,7 +295,7 @@ static PHP_METHOD(Server, getTags)
 } /* }}} */
 
 /* {{{ proto array MongoDB\Driver\Server::getInfo()
-   Returns the last isMaster result document for this Server */
+   Returns the last hello response for this Server */
 static PHP_METHOD(Server, getInfo)
 {
 	zend_error_handling          error_handling;
@@ -312,12 +312,12 @@ static PHP_METHOD(Server, getInfo)
 	zend_restore_error_handling(&error_handling);
 
 	if ((sd = mongoc_client_get_server_description(Z_MANAGER_OBJ_P(&intern->manager)->client, intern->server_id))) {
-		const bson_t*         is_master = mongoc_server_description_ismaster(sd);
+		const bson_t*         hello_response = mongoc_server_description_hello_response(sd);
 		php_phongo_bson_state state;
 
 		PHONGO_BSON_INIT_DEBUG_STATE(state);
 
-		if (!php_phongo_bson_to_zval_ex(bson_get_data(is_master), is_master->len, &state)) {
+		if (!php_phongo_bson_to_zval_ex(bson_get_data(hello_response), hello_response->len, &state)) {
 			/* Exception should already have been thrown */
 			zval_ptr_dtor(&state.zchild);
 			mongoc_server_description_destroy(sd);
@@ -508,7 +508,7 @@ static PHP_METHOD(Server, isHidden)
 	if ((sd = mongoc_client_get_server_description(Z_MANAGER_OBJ_P(&intern->manager)->client, intern->server_id))) {
 		bson_iter_t iter;
 
-		RETVAL_BOOL(bson_iter_init_find_case(&iter, mongoc_server_description_ismaster(sd), "hidden") && bson_iter_as_bool(&iter));
+		RETVAL_BOOL(bson_iter_init_find_case(&iter, mongoc_server_description_hello_response(sd), "hidden") && bson_iter_as_bool(&iter));
 		mongoc_server_description_destroy(sd);
 		return;
 	}
@@ -536,7 +536,7 @@ static PHP_METHOD(Server, isPassive)
 	if ((sd = mongoc_client_get_server_description(Z_MANAGER_OBJ_P(&intern->manager)->client, intern->server_id))) {
 		bson_iter_t iter;
 
-		RETVAL_BOOL(bson_iter_init_find_case(&iter, mongoc_server_description_ismaster(sd), "passive") && bson_iter_as_bool(&iter));
+		RETVAL_BOOL(bson_iter_init_find_case(&iter, mongoc_server_description_hello_response(sd), "passive") && bson_iter_as_bool(&iter));
 		mongoc_server_description_destroy(sd);
 		return;
 	}
diff --git a/src/libmongoc b/src/libmongoc
@@ -1 +1 @@
-Subproject commit 724f1672f26018f0d23883595c212497a38b043b
+Subproject commit ebe90917f2722715ebc8b1ba1aa6e390be69a4f1
diff --git a/tests/connect/standalone-ssl-verify_cert-error-001.phpt b/tests/connect/standalone-ssl-verify_cert-error-001.phpt
@@ -28,5 +28,5 @@ Deprecated: MongoDB\Driver\Manager::__construct(): The "allow_invalid_hostname"
 
 Deprecated: MongoDB\Driver\Manager::__construct(): The "weak_cert_validation" driver option is deprecated. Please use the "tlsAllowInvalidCertificates" URI option instead.%s
 OK: Got MongoDB\Driver\Exception\ConnectionTimeoutException thrown from executeCommand
-No suitable servers found (`serverSelectionTryOnce` set): [%s calling ismaster on '%s:%d']
+No suitable servers found (`serverSelectionTryOnce` set): [%s calling %s on '%s:%d']
 ===DONE===
diff --git a/tests/connect/standalone-ssl-verify_cert-error-002.phpt b/tests/connect/standalone-ssl-verify_cert-error-002.phpt
@@ -34,5 +34,5 @@ Deprecated: MongoDB\Driver\Manager::__construct(): The "allow_invalid_hostname"
 
 Deprecated: MongoDB\Driver\Manager::__construct(): The "allow_self_signed" context driver option is deprecated. Please use the "tlsAllowInvalidCertificates" URI option instead.%s
 OK: Got MongoDB\Driver\Exception\ConnectionTimeoutException thrown from executeCommand
-No suitable servers found (`serverSelectionTryOnce` set): [%s calling ismaster on '%s:%d']
+No suitable servers found (`serverSelectionTryOnce` set): [%s calling %s on '%s:%d']
 ===DONE===
diff --git a/tests/manager/manager-ctor-read_preference-004.phpt b/tests/manager/manager-ctor-read_preference-004.phpt
diff --git a/tests/manager/manager-ctor-read_preference-error-003.phpt b/tests/manager/manager-ctor-read_preference-error-003.phpt
diff --git a/tests/manager/manager-set-uri-options-002.phpt b/tests/manager/manager-set-uri-options-002.phpt
@@ -50,7 +50,7 @@ Deprecated: MongoDB\Driver\Manager::__construct(): The "context" driver option i
 
 Deprecated: MongoDB\Driver\Manager::__construct(): The "allow_self_signed" context driver option is deprecated. Please use the "tlsAllowInvalidCertificates" URI option instead.%s
 OK: Got MongoDB\Driver\Exception\ConnectionTimeoutException
-No suitable servers found (`serverSelectionTryOnce` set): [%scalling ismaster on '%s']
+No suitable servers found (`serverSelectionTryOnce` set): [%s calling %s on '%s']
 
 Deprecated: MongoDB\Driver\Manager::__construct(): The "context" driver option is deprecated.%s
 
diff --git a/tests/manager/manager-var-dump-001.phpt b/tests/manager/manager-var-dump-001.phpt
@@ -52,7 +52,7 @@ object(MongoDB\Driver\Manager)#%d (%d) {
       bool(false)
       ["is_passive"]=>
       bool(false)
-      ["last_is_master"]=>
+      ["last_hello_response"]=>
       array(%d) {
         %a
       }
diff --git a/tests/ocsp-failure.phpt b/tests/ocsp-failure.phpt
@@ -29,5 +29,5 @@ $m->executeCommand('admin', $ping);
 <?php exit(0); ?>
 --EXPECTF--
 OK: Got MongoDB\Driver\Exception\ConnectionTimeoutException
-No suitable servers found (`serverSelectionTryOnce` set): [%s calling ismaster on '%s:%d']
+No suitable servers found (`serverSelectionTryOnce` set): [%s calling %s on '%s:%d']
 ===DONE===
diff --git a/tests/replicaset/manager-getservers-001.phpt b/tests/replicaset/manager-getservers-001.phpt
@@ -46,7 +46,7 @@ array(3) {
     bool(false)
     ["is_passive"]=>
     bool(false)%A
-    ["last_is_master"]=>
+    ["last_hello_response"]=>
     array(%d) {
       %a
     }
@@ -71,7 +71,7 @@ array(3) {
     bool(false)
     ["is_passive"]=>
     bool(false)%A
-    ["last_is_master"]=>
+    ["last_hello_response"]=>
     array(%d) {
       %a
     }
@@ -96,7 +96,7 @@ array(3) {
     bool(false)
     ["is_passive"]=>
     bool(false)
-    ["last_is_master"]=>
+    ["last_hello_response"]=>
     array(%d) {
       %a
     }
diff --git a/tests/replicaset/server-001.phpt b/tests/replicaset/server-001.phpt
@@ -40,7 +40,7 @@ var_dump(
     $server->isHidden(),
     $server->isPassive()
 );
-$info = $server->getInfo(); // isMaster output changes between mongod versions
+$info = $server->getInfo(); // hello response changes between mongod versions
 var_dump($info["setName"], $info["hosts"]);
 var_dump($info["me"] == $server->getHost() . ":" . $server->getPort());
 ?>
diff --git a/tests/replicaset/server-002.phpt b/tests/replicaset/server-002.phpt
@@ -35,7 +35,7 @@ var_dump(
     $server->isHidden(),
     $server->isPassive()
 );
-$info = $server->getInfo(); // isMaster output changes between mongod versions
+$info = $server->getInfo(); // hello response changes between mongod versions
 var_dump($info["setName"], $info["hosts"]);
 var_dump($info["me"] == $server->getHost() . ":" . $server->getPort());
 ?>
diff --git a/tests/server/server-debug.phpt b/tests/server/server-debug.phpt
@@ -34,7 +34,7 @@ object(MongoDB\Driver\Server)#%d (%d) {
   bool(false)
   ["is_passive"]=>
   bool(false)%A
-  ["last_is_master"]=>
+  ["last_hello_response"]=>
   array(%d) {
     %a
   }
diff --git a/tests/server/server-executeBulkWrite-004.phpt b/tests/server/server-executeBulkWrite-004.phpt
diff --git a/tests/server/server-executeBulkWrite-007.phpt b/tests/server/server-executeBulkWrite-007.phpt
diff --git a/tests/server/server-executeCommand-003.phpt b/tests/server/server-executeCommand-003.phpt
diff --git a/tests/server/server-executeQuery-008.phpt b/tests/server/server-executeQuery-008.phpt

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-1.18.0-20210426+git724f1672f2`
	`1`	`+1.18.0-20210622+gitebe90917f2`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ object(MongoDB\Driver\Manager)#%d (%d) {`
`52`	`52`	`bool(false)`
`53`	`53`	`["is_passive"]=>`
`54`	`54`	`bool(false)`
`55`		`- ["last_is_master"]=>`
	`55`	`+ ["last_hello_response"]=>`
`56`	`56`	`array(%d) {`
`57`	`57`	`%a`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ object(MongoDB\Driver\Server)#%d (%d) {`
`34`	`34`	`bool(false)`
`35`	`35`	`["is_passive"]=>`
`36`	`36`	`bool(false)%A`
`37`		`- ["last_is_master"]=>`
	`37`	`+ ["last_hello_response"]=>`
`38`	`38`	`array(%d) {`
`39`	`39`	`%a`
`40`	`40`	`}`