PHPC-1893: Implement ServerChangedEvent class

Author: tanlisu

config.m4

@@ -173,6 +173,7 @@ if test "$PHP_MONGODB" != "no"; then
     src/MongoDB/Monitoring/CommandSucceededEvent.c \
     src/MongoDB/Monitoring/SDAMSubscriber.c \
     src/MongoDB/Monitoring/Subscriber.c \
+    src/MongoDB/Monitoring/ServerChangedEvent.c \
     src/MongoDB/Monitoring/ServerOpeningEvent.c \
     src/MongoDB/Monitoring/TopologyChangedEvent.c \
     src/MongoDB/Monitoring/TopologyOpeningEvent.c \

config.w32

@@ -122,7 +122,7 @@ if (PHP_MONGODB != "no") {
   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 ServerDescription.c Session.c TopologyDescription.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 SDAMSubscriber.c Subscriber.c ServerOpeningEvent.c TopologyChangedEvent.c TopologyOpeningEvent.c functions.c");
+  MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c SDAMSubscriber.c Subscriber.c ServerChangedEvent.c ServerOpeningEvent.c TopologyChangedEvent.c TopologyOpeningEvent.c functions.c");
   MONGODB_ADD_SOURCES("/src/libmongoc/src/common", PHP_MONGODB_COMMON_SOURCES);
   MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/bson", PHP_MONGODB_BSON_SOURCES);
   MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/jsonsl", PHP_MONGODB_JSONSL_SOURCES);

php_phongo.c

@@ -3857,6 +3857,7 @@ PHP_MINIT_FUNCTION(mongodb)
 	php_phongo_commandstartedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_commandsucceededevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_sdamsubscriber_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_serverchangedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_serveropeningevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_topologychangedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_topologyopeningevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);

php_phongo_classes.h

@@ -159,6 +159,10 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 {
 	return (php_phongo_commandsucceededevent_t*) ((char*) obj - XtOffsetOf(php_phongo_commandsucceededevent_t, std));
 }
+static inline php_phongo_serverchangedevent_t* php_serverchangedevent_fetch_object(zend_object* obj)
+{
+	return (php_phongo_serverchangedevent_t*) ((char*) obj - XtOffsetOf(php_phongo_serverchangedevent_t, std));
+}
 static inline php_phongo_serveropeningevent_t* php_serveropeningevent_fetch_object(zend_object* obj)
 {
 	return (php_phongo_serveropeningevent_t*) ((char*) obj - XtOffsetOf(php_phongo_serveropeningevent_t, std));
@@ -206,6 +210,7 @@ static inline php_phongo_topologyopeningevent_t* php_topologyopeningevent_fetch_
 #define Z_COMMANDFAILEDEVENT_OBJ_P(zv) (php_commandfailedevent_fetch_object(Z_OBJ_P(zv)))
 #define Z_COMMANDSTARTEDEVENT_OBJ_P(zv) (php_commandstartedevent_fetch_object(Z_OBJ_P(zv)))
 #define Z_COMMANDSUCCEEDEDEVENT_OBJ_P(zv) (php_commandsucceededevent_fetch_object(Z_OBJ_P(zv)))
+#define Z_SERVERCHANGEDEVENT_OBJ_P(zv) (php_serverchangedevent_fetch_object(Z_OBJ_P(zv)))
 #define Z_SERVEROPENINGEVENT_OBJ_P(zv) (php_serveropeningevent_fetch_object(Z_OBJ_P(zv)))
 #define Z_TOPOLOGYCHANGEDEVENT_OBJ_P(zv) (php_topologychangedevent_fetch_object(Z_OBJ_P(zv)))
 #define Z_TOPOLOGYOPENINGEVENT_OBJ_P(zv) (php_topologyopeningevent_fetch_object(Z_OBJ_P(zv)))
@@ -244,6 +249,7 @@ static inline php_phongo_topologyopeningevent_t* php_topologyopeningevent_fetch_
 #define Z_OBJ_COMMANDFAILEDEVENT(zo) (php_commandfailedevent_fetch_object(zo))
 #define Z_OBJ_COMMANDSTARTEDEVENT(zo) (php_commandstartedevent_fetch_object(zo))
 #define Z_OBJ_COMMANDSUCCEEDEDEVENT(zo) (php_commandsucceededevent_fetch_object(zo))
+#define Z_OBJ_SERVERCHANGEDEVENT(zo) (php_serverchangedevent_fetch_object(zo))
 #define Z_OBJ_SERVEROPENINGEVENT(zo) (php_serveropeningevent_fetch_object(zo))
 #define Z_OBJ_TOPOLOGYCHANGEDEVENT(zo) (php_topologychangedevent_fetch_object(zo))
 #define Z_OBJ_TOPOLOGYOPENINGEVENT(zo) (php_topologyopeningevent_fetch_object(zo))
@@ -319,6 +325,7 @@ extern zend_class_entry* php_phongo_commandsubscriber_ce;
 extern zend_class_entry* php_phongo_commandsucceededevent_ce;
 extern zend_class_entry* php_phongo_sdamsubscriber_ce;
 extern zend_class_entry* php_phongo_subscriber_ce;
+extern zend_class_entry* php_phongo_serverchangedevent_ce;
 extern zend_class_entry* php_phongo_serveropeningevent_ce;
 extern zend_class_entry* php_phongo_topologychangedevent_ce;
 extern zend_class_entry* php_phongo_topologyopeningevent_ce;
@@ -394,6 +401,7 @@ extern void php_phongo_commandsubscriber_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_commandsucceededevent_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_sdamsubscriber_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_subscriber_init_ce(INIT_FUNC_ARGS);
+extern void php_phongo_serverchangedevent_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_serveropeningevent_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_topologychangedevent_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_topologyopeningevent_init_ce(INIT_FUNC_ARGS);

php_phongo_structs.h

@@ -284,6 +284,15 @@ typedef struct {
 	zend_object std;
 } php_phongo_commandsucceededevent_t;
 
+typedef struct {
+	bson_oid_t                   topology_id;
+	char                         host[BSON_HOST_NAME_MAX + 1];
+	uint16_t                     port;
+	mongoc_server_description_t* new_server_description;
+	mongoc_server_description_t* old_server_description;
+	zend_object                  std;
+} php_phongo_serverchangedevent_t;
+
 typedef struct {
 	bson_oid_t  topology_id;
 	char        host[BSON_HOST_NAME_MAX + 1];

src/MongoDB/Monitoring/ServerChangedEvent.c

@@ -0,0 +1,204 @@
+/*
+ * Copyright 2021-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <php.h>
+#include <Zend/zend_interfaces.h>
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "phongo_compat.h"
+#include "php_phongo.h"
+
+zend_class_entry* php_phongo_serverchangedevent_ce;
+
+/* {{{ proto string ServerChangedEvent::getHost()
+   Returns this event's host */
+static PHP_METHOD(ServerChangedEvent, getHost)
+{
+	php_phongo_serverchangedevent_t* intern = Z_SERVERCHANGEDEVENT_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	RETVAL_STRING(intern->host);
+} /* }}} */
+
+/* {{{ proto integer ServerChangedEvent::getPort()
+   Returns this event's port */
+static PHP_METHOD(ServerChangedEvent, getPort)
+{
+	php_phongo_serverchangedevent_t* intern = Z_SERVERCHANGEDEVENT_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	RETVAL_LONG(intern->port);
+} /* }}} */
+
+/* {{{ proto MongoDB\Driver\ServerDescription ServerChangedEvent::getNewDescription()
+   Returns this event's new description */
+static PHP_METHOD(ServerChangedEvent, getNewDescription)
+{
+	mongoc_server_description_t*     server_description;
+	php_phongo_serverchangedevent_t* intern = Z_SERVERCHANGEDEVENT_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	server_description = mongoc_server_description_new_copy(intern->new_server_description);
+
+	phongo_serverdescription_init(return_value, server_description);
+} /* }}} */
+
+/* {{{ proto MongoDB\Driver\ServerDescription ServerChangedEvent::getPreviousDescription()
+   Returns this event's previous description */
+static PHP_METHOD(ServerChangedEvent, getPreviousDescription)
+{
+	mongoc_server_description_t*     server_description;
+	php_phongo_serverchangedevent_t* intern = Z_SERVERCHANGEDEVENT_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	server_description = mongoc_server_description_new_copy(intern->old_server_description);
+
+	phongo_serverdescription_init(return_value, server_description);
+} /* }}} */
+
+/* {{{ proto MongoDB\BSON\ObjectId ServerChangedEvent::getTopologyId()
+   Returns this event's topology id */
+static PHP_METHOD(ServerChangedEvent, getTopologyId)
+{
+	php_phongo_objectid_t*           topology_id;
+	php_phongo_serverchangedevent_t* intern = Z_SERVERCHANGEDEVENT_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	object_init_ex(return_value, php_phongo_objectid_ce);
+
+	topology_id = Z_OBJECTID_OBJ_P(return_value);
+	bson_oid_to_string(&intern->topology_id, topology_id->oid);
+	topology_id->initialized = true;
+} /* }}} */
+
+/* {{{ MongoDB\Driver\Monitoring\ServerChangedEvent function entries */
+ZEND_BEGIN_ARG_INFO_EX(ai_ServerChangedEvent_void, 0, 0, 0)
+ZEND_END_ARG_INFO()
+
+static zend_function_entry php_phongo_serverchangedevent_me[] = {
+	/* clang-format off */
+	ZEND_NAMED_ME(__construct, PHP_FN(MongoDB_disabled___construct), ai_ServerChangedEvent_void, ZEND_ACC_PRIVATE | ZEND_ACC_FINAL)
+	PHP_ME(ServerChangedEvent, getHost, ai_ServerChangedEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(ServerChangedEvent, getPort, ai_ServerChangedEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(ServerChangedEvent, getNewDescription, ai_ServerChangedEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(ServerChangedEvent, getPreviousDescription, ai_ServerChangedEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(ServerChangedEvent, getTopologyId, ai_ServerChangedEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	ZEND_NAMED_ME(__wakeup, PHP_FN(MongoDB_disabled___wakeup), ai_ServerChangedEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_FE_END
+	/* clang-format on */
+};
+/* }}} */
+
+/* {{{ MongoDB\Driver\Monitoring\ServerChangedEvent object handlers */
+static zend_object_handlers php_phongo_handler_serverchangedevent;
+
+static void php_phongo_serverchangedevent_free_object(zend_object* object) /* {{{ */
+{
+	php_phongo_serverchangedevent_t* intern = Z_OBJ_SERVERCHANGEDEVENT(object);
+
+	zend_object_std_dtor(&intern->std);
+
+	if (intern->new_server_description) {
+		mongoc_server_description_destroy(intern->new_server_description);
+	}
+
+	if (intern->old_server_description) {
+		mongoc_server_description_destroy(intern->old_server_description);
+	}
+} /* }}} */
+
+static zend_object* php_phongo_serverchangedevent_create_object(zend_class_entry* class_type) /* {{{ */
+{
+	php_phongo_serverchangedevent_t* intern = NULL;
+
+	intern = PHONGO_ALLOC_OBJECT_T(php_phongo_serverchangedevent_t, class_type);
+
+	zend_object_std_init(&intern->std, class_type);
+	object_properties_init(&intern->std, class_type);
+
+	intern->std.handlers = &php_phongo_handler_serverchangedevent;
+
+	return &intern->std;
+} /* }}} */
+
+static HashTable* php_phongo_serverchangedevent_get_debug_info(phongo_compat_object_handler_type* object, int* is_temp) /* {{{ */
+{
+	php_phongo_serverchangedevent_t* intern;
+	zval                             retval = ZVAL_STATIC_INIT;
+	char                             topology_id[25];
+
+	intern   = Z_OBJ_SERVERCHANGEDEVENT(PHONGO_COMPAT_GET_OBJ(object));
+	*is_temp = 1;
+	array_init_size(&retval, 4);
+
+	ADD_ASSOC_STRING(&retval, "host", intern->host);
+	ADD_ASSOC_LONG_EX(&retval, "port", intern->port);
+
+	bson_oid_to_string(&intern->topology_id, topology_id);
+	ADD_ASSOC_STRING(&retval, "topologyId", topology_id);
+
+	{
+		zval new_server_description;
+		php_phongo_server_description_to_zval(&new_server_description, intern->new_server_description);
+		ADD_ASSOC_ZVAL_EX(&retval, "newServerDescription", &new_server_description);
+	}
+
+	{
+		zval old_server_description;
+		php_phongo_server_description_to_zval(&old_server_description, intern->old_server_description);
+		ADD_ASSOC_ZVAL_EX(&retval, "oldServerDescription", &old_server_description);
+	}
+
+	return Z_ARRVAL(retval);
+} /* }}} */
+/* }}} */
+
+void php_phongo_serverchangedevent_init_ce(INIT_FUNC_ARGS) /* {{{ */
+{
+	zend_class_entry ce;
+	(void) type;
+	(void) module_number;
+
+	INIT_NS_CLASS_ENTRY(ce, "MongoDB\\Driver\\Monitoring", "ServerChangedEvent", php_phongo_serverchangedevent_me);
+	php_phongo_serverchangedevent_ce                = zend_register_internal_class(&ce);
+	php_phongo_serverchangedevent_ce->create_object = php_phongo_serverchangedevent_create_object;
+	PHONGO_CE_FINAL(php_phongo_serverchangedevent_ce);
+	PHONGO_CE_DISABLE_SERIALIZATION(php_phongo_serverchangedevent_ce);
+
+	memcpy(&php_phongo_handler_serverchangedevent, phongo_get_std_object_handlers(), sizeof(zend_object_handlers));
+	php_phongo_handler_serverchangedevent.get_debug_info = php_phongo_serverchangedevent_get_debug_info;
+	php_phongo_handler_serverchangedevent.free_obj       = php_phongo_serverchangedevent_free_object;
+	php_phongo_handler_serverchangedevent.offset         = XtOffsetOf(php_phongo_serverchangedevent_t, std);
+
+	return;
+} /* }}} */
+
+/*
+ * Local variables:
+ * tab-width: 4
+ * c-basic-offset: 4
+ * End:
+ * vim600: noet sw=4 ts=4 fdm=marker
+ * vim<600: noet sw=4 ts=4
+ */

src/phongo_apm.c

@@ -262,6 +262,41 @@ static void phongo_apm_command_failed(const mongoc_apm_command_failed_t* event)
 	FREE_HASHTABLE(subscribers);
 }
 
+static void phongo_apm_server_changed(const mongoc_apm_server_changed_t* event)
+{
+	mongoc_client_t*                 client;
+	HashTable*                       subscribers;
+	php_phongo_serverchangedevent_t* p_event;
+	zval                             z_event;
+	const mongoc_host_list_t*        host_list;
+
+	client      = mongoc_apm_server_changed_get_context(event);
+	subscribers = phongo_apm_get_subscribers_to_notify(php_phongo_sdamsubscriber_ce, client);
+
+	/* Return early if there are no APM subscribers to notify */
+	if (zend_hash_num_elements(subscribers) == 0) {
+		goto cleanup;
+	}
+
+	object_init_ex(&z_event, php_phongo_serverchangedevent_ce);
+	p_event = Z_SERVERCHANGEDEVENT_OBJ_P(&z_event);
+
+	host_list = mongoc_apm_server_changed_get_host(event);
+	memcpy(&p_event->host, &host_list->host, BSON_HOST_NAME_MAX + 1);
+	p_event->port = host_list->port;
+
+	mongoc_apm_server_changed_get_topology_id(event, &p_event->topology_id);
+	p_event->new_server_description = mongoc_server_description_new_copy(mongoc_apm_server_changed_get_new_description(event));
+	p_event->old_server_description = mongoc_server_description_new_copy(mongoc_apm_server_changed_get_previous_description(event));
+
+	phongo_apm_dispatch_event(subscribers, "serverChanged", &z_event);
+	zval_ptr_dtor(&z_event);
+
+cleanup:
+	zend_hash_destroy(subscribers);
+	FREE_HASHTABLE(subscribers);
+}
+
 static void phongo_apm_server_opening(const mongoc_apm_server_opening_t* event)
 {
 	mongoc_client_t*                 client;
@@ -365,6 +400,7 @@ bool phongo_apm_set_callbacks(mongoc_client_t* client)
 	mongoc_apm_set_command_started_cb(callbacks, phongo_apm_command_started);
 	mongoc_apm_set_command_succeeded_cb(callbacks, phongo_apm_command_succeeded);
 	mongoc_apm_set_command_failed_cb(callbacks, phongo_apm_command_failed);
+	mongoc_apm_set_server_changed_cb(callbacks, phongo_apm_server_changed);
 	mongoc_apm_set_server_opening_cb(callbacks, phongo_apm_server_opening);
 	mongoc_apm_set_topology_changed_cb(callbacks, phongo_apm_topology_changed);
 	mongoc_apm_set_topology_opening_cb(callbacks, phongo_apm_topology_opening);

tests/apm/monitoring-serverChanged-001.phpt

@@ -0,0 +1,52 @@
+--TEST--
+MongoDB\Driver\Monitoring\ServerChangedEvent
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$m = create_test_manager();
+
+class MySubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
+{
+    private $serverDescription;
+
+    public function serverChanged(MongoDB\Driver\Monitoring\ServerChangedEvent $event)
+    {
+        if (isset($this->serverDescription)) {
+            return;
+        }
+
+        $this->serverDescription = $event->getNewDescription();
+        echo "- getHost() returns a string: ", is_string($event->getHost()) ? 'yes' : 'no', "\n";
+        echo "- getPort() returns an integer: ", is_integer($event->getPort()) ? 'yes' : 'no', "\n";
+        echo "- getTopologyId() returns an ObjectId: ", ($event->getTopologyId() instanceof MongoDB\BSON\ObjectId) ? 'yes' : 'no', "\n";
+        echo "- getNewDescription() returns a ServerDescription: ", ($event->getNewDescription() instanceof MongoDB\Driver\ServerDescription) ? 'yes' : 'no', "\n";
+        echo "- getPreviousDescription() returns a ServerDescription: ", ($event->getPreviousDescription() instanceof MongoDB\Driver\ServerDescription) ? 'yes' : 'no', "\n";
+    }
+
+    public function serverOpening(MongoDB\Driver\Monitoring\ServerOpeningEvent $event) {}
+
+    public function topologyChanged(MongoDB\Driver\Monitoring\TopologyChangedEvent $event) {}
+
+    public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
+}
+
+$subscriber = new MySubscriber;
+MongoDB\Driver\Monitoring\addSubscriber($subscriber);
+
+$command = new MongoDB\Driver\Command(['ping' => 1]);
+$m->executeCommand(DATABASE_NAME, $command);
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+- getHost() returns a string: yes
+- getPort() returns an integer: yes
+- getTopologyId() returns an ObjectId: yes
+- getNewDescription() returns a ServerDescription: yes
+- getPreviousDescription() returns a ServerDescription: yes
+===DONE===