PHPC-1805 and PHPC-1910: Implement ServerDescription class and Server::getServerDescription() (#1239)

Co-authored-by: Andreas Braun <[email protected]>
Co-authored-by: Jeremy Mikola <[email protected]>

Author: 3 people

config.m4

@@ -146,6 +146,7 @@ if test "$PHP_MONGODB" != "no"; then
     src/MongoDB/ReadPreference.c \
     src/MongoDB/Server.c \
     src/MongoDB/ServerApi.c \
+    src/MongoDB/ServerDescription.c \
     src/MongoDB/Session.c \
     src/MongoDB/WriteConcern.c \
     src/MongoDB/WriteConcernError.c \

config.w32

@@ -120,7 +120,7 @@ if (PHP_MONGODB != "no") {
   EXTENSION("mongodb", "php_phongo.c phongo_compat.c", null, PHP_MONGODB_CFLAGS);
   MONGODB_ADD_SOURCES("/src", "bson.c bson-encode.c phongo_apm.c phongo_ini.c");
   MONGODB_ADD_SOURCES("/src/BSON", "Binary.c BinaryInterface.c DBPointer.c Decimal128.c Decimal128Interface.c Int64.c Javascript.c JavascriptInterface.c MaxKey.c MaxKeyInterface.c MinKey.c MinKeyInterface.c ObjectId.c ObjectIdInterface.c Persistable.c Regex.c RegexInterface.c Serializable.c Symbol.c Timestamp.c TimestampInterface.c Type.c Undefined.c Unserializable.c UTCDateTime.c UTCDateTimeInterface.c functions.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorId.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c Session.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
+  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorId.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c CommandException.c ConnectionException.c ConnectionTimeoutException.c EncryptionException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c ServerException.c SSLConnectionException.c UnexpectedValueException.c WriteException.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c Subscriber.c functions.c");
   MONGODB_ADD_SOURCES("/src/libmongoc/src/common", PHP_MONGODB_COMMON_SOURCES);

php_phongo.c

@@ -358,6 +358,17 @@ void phongo_server_init(zval* return_value, zval* manager, uint32_t server_id) /
 }
 /* }}} */
 
+void phongo_serverdescription_init(zval* return_value, mongoc_server_description_t* server_description) /* {{{ */
+{
+	php_phongo_serverdescription_t* intern;
+
+	object_init_ex(return_value, php_phongo_serverdescription_ce);
+
+	intern                     = Z_SERVERDESCRIPTION_OBJ_P(return_value);
+	intern->server_description = server_description;
+}
+/* }}} */
+
 void phongo_session_init(zval* return_value, zval* manager, mongoc_client_session_t* client_session) /* {{{ */
 {
 	php_phongo_session_t* session;
@@ -3735,6 +3746,7 @@ PHP_MINIT_FUNCTION(mongodb)
 	php_phongo_readpreference_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_server_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_serverapi_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_serverdescription_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_session_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_writeconcern_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_writeconcernerror_init_ce(INIT_FUNC_ARGS_PASSTHRU);

php_phongo.h

@@ -117,6 +117,7 @@ zend_object_handlers* phongo_get_std_object_handlers(void);
 
 void phongo_clientencryption_init(php_phongo_clientencryption_t* ce_obj, zval* manager, zval* options);
 void phongo_server_init(zval* return_value, zval* manager, uint32_t server_id);
+void phongo_serverdescription_init(zval* return_value, mongoc_server_description_t* serverDescription);
 void phongo_session_init(zval* return_value, zval* manager, mongoc_client_session_t* client_session);
 void phongo_objectid_init(zval* return_value, const bson_oid_t* oid);
 void phongo_readconcern_init(zval* return_value, const mongoc_read_concern_t* read_concern);
@@ -144,6 +145,7 @@ void php_phongo_read_preference_prep_tagsets(zval* tagSets);
 bool php_phongo_read_preference_tags_are_valid(const bson_t* tags);
 
 bool php_phongo_server_to_zval(zval* retval, mongoc_client_t* client, mongoc_server_description_t* sd);
+bool php_phongo_server_description_to_zval(zval* retval, mongoc_server_description_t* sd);
 void php_phongo_read_concern_to_zval(zval* retval, const mongoc_read_concern_t* read_concern);
 void php_phongo_write_concern_to_zval(zval* retval, const mongoc_write_concern_t* write_concern);
 

php_phongo_classes.h

@@ -63,6 +63,10 @@ static inline php_phongo_server_t* php_server_fetch_object(zend_object* obj)
 {
 	return (php_phongo_server_t*) ((char*) obj - XtOffsetOf(php_phongo_server_t, std));
 }
+static inline php_phongo_serverdescription_t* php_serverdescription_fetch_object(zend_object* obj)
+{
+	return (php_phongo_serverdescription_t*) ((char*) obj - XtOffsetOf(php_phongo_serverdescription_t, std));
+}
 static inline php_phongo_serverapi_t* php_serverapi_fetch_object(zend_object* obj)
 {
 	return (php_phongo_serverapi_t*) ((char*) obj - XtOffsetOf(php_phongo_serverapi_t, std));
@@ -162,6 +166,7 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 #define Z_READPREFERENCE_OBJ_P(zv) (php_readpreference_fetch_object(Z_OBJ_P(zv)))
 #define Z_SERVER_OBJ_P(zv) (php_server_fetch_object(Z_OBJ_P(zv)))
 #define Z_SERVERAPI_OBJ_P(zv) (php_serverapi_fetch_object(Z_OBJ_P(zv)))
+#define Z_SERVERDESCRIPTION_OBJ_P(zv) (php_serverdescription_fetch_object(Z_OBJ_P(zv)))
 #define Z_SESSION_OBJ_P(zv) (php_session_fetch_object(Z_OBJ_P(zv)))
 #define Z_BULKWRITE_OBJ_P(zv) (php_bulkwrite_fetch_object(Z_OBJ_P(zv)))
 #define Z_WRITECONCERN_OBJ_P(zv) (php_writeconcern_fetch_object(Z_OBJ_P(zv)))
@@ -195,6 +200,7 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 #define Z_OBJ_READPREFERENCE(zo) (php_readpreference_fetch_object(zo))
 #define Z_OBJ_SERVER(zo) (php_server_fetch_object(zo))
 #define Z_OBJ_SERVERAPI(zo) (php_serverapi_fetch_object(zo))
+#define Z_OBJ_SERVERDESCRIPTION(zo) (php_serverdescription_fetch_object(zo))
 #define Z_OBJ_SESSION(zo) (php_session_fetch_object(zo))
 #define Z_OBJ_BULKWRITE(zo) (php_bulkwrite_fetch_object(zo))
 #define Z_OBJ_WRITECONCERN(zo) (php_writeconcern_fetch_object(zo))
@@ -228,6 +234,7 @@ extern zend_class_entry* php_phongo_readconcern_ce;
 extern zend_class_entry* php_phongo_readpreference_ce;
 extern zend_class_entry* php_phongo_server_ce;
 extern zend_class_entry* php_phongo_serverapi_ce;
+extern zend_class_entry* php_phongo_serverdescription_ce;
 extern zend_class_entry* php_phongo_session_ce;
 extern zend_class_entry* php_phongo_bulkwrite_ce;
 extern zend_class_entry* php_phongo_writeconcern_ce;
@@ -326,6 +333,7 @@ extern void php_phongo_readconcern_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_readpreference_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_server_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_serverapi_init_ce(INIT_FUNC_ARGS);
+extern void php_phongo_serverdescription_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_session_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_writeconcern_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_writeconcernerror_init_ce(INIT_FUNC_ARGS);

php_phongo_structs.h

@@ -114,6 +114,12 @@ typedef struct {
 	zend_object          std;
 } php_phongo_serverapi_t;
 
+typedef struct {
+	mongoc_server_description_t* server_description;
+	HashTable*                   properties;
+	zend_object                  std;
+} php_phongo_serverdescription_t;
+
 typedef struct {
 	mongoc_client_session_t* client_session;
 	zval                     manager;

src/MongoDB/Server.c

@@ -403,6 +403,20 @@ static PHP_METHOD(Server, getPort)
 	phongo_throw_exception(PHONGO_ERROR_RUNTIME, "Failed to get server description");
 } /* }}} */
 
+/* {{{ proto MongoDB\Driver\ServerDescription MongoDB\Driver\Server::getServerDescription()
+   Returns the server description for this Server */
+static PHP_METHOD(Server, getServerDescription)
+{
+	mongoc_server_description_t* server_description;
+	php_phongo_server_t*         intern = Z_SERVER_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	server_description = mongoc_client_get_server_description(Z_MANAGER_OBJ_P(&intern->manager)->client, intern->server_id);
+
+	phongo_serverdescription_init(return_value, server_description);
+} /* }}} */
+
 /* {{{ proto integer MongoDB\Driver\Server::getType()
    Returns the node type of this Server */
 static PHP_METHOD(Server, getType)
@@ -604,6 +618,7 @@ static zend_function_entry php_phongo_server_me[] = {
 	PHP_ME(Server, getInfo, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Server, getLatency, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Server, getPort, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(Server, getServerDescription, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Server, getType, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Server, isPrimary, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Server, isSecondary, ai_Server_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)