Skip to content

Commit 7e0e2e1

Browse files
tanlisutanlisu
authored
PHPC-1893: Implement TopologyOpeningEvent class (#1250)
1 parent bcd2a7f commit 7e0e2e1

16 files changed

+222
-1
lines changed

‎config.m4

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ if test "$PHP_MONGODB" != "no"; then
174174
src/MongoDB/Monitoring/SDAMSubscriber.c \
175175
src/MongoDB/Monitoring/Subscriber.c \
176176
src/MongoDB/Monitoring/TopologyChangedEvent.c \
177+
src/MongoDB/Monitoring/TopologyOpeningEvent.c \
177178
src/MongoDB/Monitoring/functions.c \
178179
"
179180

‎config.w32

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ if (PHP_MONGODB != "no") {
122122
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");
123123
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");
124124
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");
125-
MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c SDAMSubscriber.c Subscriber.c TopologyChangedEvent.c functions.c");
125+
MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c SDAMSubscriber.c Subscriber.c TopologyChangedEvent.c TopologyOpeningEvent.c functions.c");
126126
MONGODB_ADD_SOURCES("/src/libmongoc/src/common", PHP_MONGODB_COMMON_SOURCES);
127127
MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/bson", PHP_MONGODB_BSON_SOURCES);
128128
MONGODB_ADD_SOURCES("/src/libmongoc/src/libbson/src/jsonsl", PHP_MONGODB_JSONSL_SOURCES);

‎php_phongo.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3858,6 +3858,7 @@ PHP_MINIT_FUNCTION(mongodb)
38583858
php_phongo_commandsucceededevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
38593859
php_phongo_sdamsubscriber_init_ce(INIT_FUNC_ARGS_PASSTHRU);
38603860
php_phongo_topologychangedevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
3861+
php_phongo_topologyopeningevent_init_ce(INIT_FUNC_ARGS_PASSTHRU);
38613862

38623863
REGISTER_STRING_CONSTANT("MONGODB_VERSION", (char*) PHP_MONGODB_VERSION, CONST_CS | CONST_PERSISTENT);
38633864
REGISTER_STRING_CONSTANT("MONGODB_STABILITY", (char*) PHP_MONGODB_STABILITY, CONST_CS | CONST_PERSISTENT);

‎php_phongo_classes.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,10 @@ static inline php_phongo_topologychangedevent_t* php_topologychangedevent_fetch_
163163
{
164164
return (php_phongo_topologychangedevent_t*) ((char*) obj - XtOffsetOf(php_phongo_topologychangedevent_t, std));
165165
}
166+
static inline php_phongo_topologyopeningevent_t* php_topologyopeningevent_fetch_object(zend_object* obj)
167+
{
168+
return (php_phongo_topologyopeningevent_t*) ((char*) obj - XtOffsetOf(php_phongo_topologyopeningevent_t, std));
169+
}
166170

167171
#define Z_CLIENTENCRYPTION_OBJ_P(zv) (php_clientencryption_fetch_object(Z_OBJ_P(zv)))
168172
#define Z_COMMAND_OBJ_P(zv) (php_command_fetch_object(Z_OBJ_P(zv)))
@@ -199,6 +203,7 @@ static inline php_phongo_topologychangedevent_t* php_topologychangedevent_fetch_
199203
#define Z_COMMANDSTARTEDEVENT_OBJ_P(zv) (php_commandstartedevent_fetch_object(Z_OBJ_P(zv)))
200204
#define Z_COMMANDSUCCEEDEDEVENT_OBJ_P(zv) (php_commandsucceededevent_fetch_object(Z_OBJ_P(zv)))
201205
#define Z_TOPOLOGYCHANGEDEVENT_OBJ_P(zv) (php_topologychangedevent_fetch_object(Z_OBJ_P(zv)))
206+
#define Z_TOPOLOGYOPENINGEVENT_OBJ_P(zv) (php_topologyopeningevent_fetch_object(Z_OBJ_P(zv)))
202207

203208
#define Z_OBJ_CLIENTENCRYPTION(zo) (php_clientencryption_fetch_object(zo))
204209
#define Z_OBJ_COMMAND(zo) (php_command_fetch_object(zo))
@@ -235,6 +240,7 @@ static inline php_phongo_topologychangedevent_t* php_topologychangedevent_fetch_
235240
#define Z_OBJ_COMMANDSTARTEDEVENT(zo) (php_commandstartedevent_fetch_object(zo))
236241
#define Z_OBJ_COMMANDSUCCEEDEDEVENT(zo) (php_commandsucceededevent_fetch_object(zo))
237242
#define Z_OBJ_TOPOLOGYCHANGEDEVENT(zo) (php_topologychangedevent_fetch_object(zo))
243+
#define Z_OBJ_TOPOLOGYOPENINGEVENT(zo) (php_topologyopeningevent_fetch_object(zo))
238244

239245
extern zend_class_entry* php_phongo_clientencryption_ce;
240246
extern zend_class_entry* php_phongo_command_ce;
@@ -308,6 +314,7 @@ extern zend_class_entry* php_phongo_commandsucceededevent_ce;
308314
extern zend_class_entry* php_phongo_sdamsubscriber_ce;
309315
extern zend_class_entry* php_phongo_subscriber_ce;
310316
extern zend_class_entry* php_phongo_topologychangedevent_ce;
317+
extern zend_class_entry* php_phongo_topologyopeningevent_ce;
311318

312319
extern void php_phongo_binary_init_ce(INIT_FUNC_ARGS);
313320
extern void php_phongo_dbpointer_init_ce(INIT_FUNC_ARGS);
@@ -381,6 +388,7 @@ extern void php_phongo_commandsucceededevent_init_ce(INIT_FUNC_ARGS);
381388
extern void php_phongo_sdamsubscriber_init_ce(INIT_FUNC_ARGS);
382389
extern void php_phongo_subscriber_init_ce(INIT_FUNC_ARGS);
383390
extern void php_phongo_topologychangedevent_init_ce(INIT_FUNC_ARGS);
391+
extern void php_phongo_topologyopeningevent_init_ce(INIT_FUNC_ARGS);
384392

385393
/* Shared function entries for disabling constructors and unserialize() */
386394
PHP_FUNCTION(MongoDB_disabled___construct);

‎php_phongo_structs.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,11 @@ typedef struct {
291291
zend_object std;
292292
} php_phongo_topologychangedevent_t;
293293

294+
typedef struct {
295+
bson_oid_t topology_id;
296+
zend_object std;
297+
} php_phongo_topologyopeningevent_t;
298+
294299
#endif /* PHONGO_STRUCTS */
295300

296301
/*

‎src/MongoDB/Monitoring/TopologyOpeningEvent.c

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
/*
2+
* Copyright 2021-present MongoDB, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
#include <php.h>
18+
#include <Zend/zend_interfaces.h>
19+
20+
#ifdef HAVE_CONFIG_H
21+
#include "config.h"
22+
#endif
23+
24+
#include "phongo_compat.h"
25+
#include "php_phongo.h"
26+
27+
zend_class_entry* php_phongo_topologyopeningevent_ce;
28+
29+
/* {{{ proto MongoDB\BSON\ObjectId TopologyOpeningEvent::getTopologyId()
30+
Returns this event's topology id */
31+
static PHP_METHOD(TopologyOpeningEvent, getTopologyId)
32+
{
33+
php_phongo_objectid_t* topology_id;
34+
php_phongo_topologyopeningevent_t* intern = Z_TOPOLOGYOPENINGEVENT_OBJ_P(getThis());
35+
36+
PHONGO_PARSE_PARAMETERS_NONE();
37+
38+
object_init_ex(return_value, php_phongo_objectid_ce);
39+
40+
topology_id = Z_OBJECTID_OBJ_P(return_value);
41+
bson_oid_to_string(&intern->topology_id, topology_id->oid);
42+
topology_id->initialized = true;
43+
} /* }}} */
44+
45+
/* {{{ MongoDB\Driver\Monitoring\TopologyOpeningEvent function entries */
46+
ZEND_BEGIN_ARG_INFO_EX(ai_TopologyOpeningEvent_void, 0, 0, 0)
47+
ZEND_END_ARG_INFO()
48+
49+
static zend_function_entry php_phongo_topologyopeningevent_me[] = {
50+
/* clang-format off */
51+
ZEND_NAMED_ME(__construct, PHP_FN(MongoDB_disabled___construct), ai_TopologyOpeningEvent_void, ZEND_ACC_PRIVATE | ZEND_ACC_FINAL)
52+
PHP_ME(TopologyOpeningEvent, getTopologyId, ai_TopologyOpeningEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
53+
ZEND_NAMED_ME(__wakeup, PHP_FN(MongoDB_disabled___wakeup), ai_TopologyOpeningEvent_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
54+
PHP_FE_END
55+
/* clang-format on */
56+
};
57+
/* }}} */
58+
59+
/* {{{ MongoDB\Driver\Monitoring\TopologyOpeningEvent object handlers */
60+
static zend_object_handlers php_phongo_handler_topologyopeningevent;
61+
62+
static void php_phongo_topologyopeningevent_free_object(zend_object* object) /* {{{ */
63+
{
64+
php_phongo_topologyopeningevent_t* intern = Z_OBJ_TOPOLOGYOPENINGEVENT(object);
65+
66+
zend_object_std_dtor(&intern->std);
67+
} /* }}} */
68+
69+
static zend_object* php_phongo_topologyopeningevent_create_object(zend_class_entry* class_type) /* {{{ */
70+
{
71+
php_phongo_topologyopeningevent_t* intern = NULL;
72+
73+
intern = PHONGO_ALLOC_OBJECT_T(php_phongo_topologyopeningevent_t, class_type);
74+
75+
zend_object_std_init(&intern->std, class_type);
76+
object_properties_init(&intern->std, class_type);
77+
78+
intern->std.handlers = &php_phongo_handler_topologyopeningevent;
79+
80+
return &intern->std;
81+
} /* }}} */
82+
83+
static HashTable* php_phongo_topologyopeningevent_get_debug_info(phongo_compat_object_handler_type* object, int* is_temp) /* {{{ */
84+
{
85+
php_phongo_topologyopeningevent_t* intern;
86+
zval retval = ZVAL_STATIC_INIT;
87+
char topology_id[25];
88+
89+
intern = Z_OBJ_TOPOLOGYOPENINGEVENT(PHONGO_COMPAT_GET_OBJ(object));
90+
*is_temp = 1;
91+
array_init_size(&retval, 1);
92+
93+
bson_oid_to_string(&intern->topology_id, topology_id);
94+
ADD_ASSOC_STRING(&retval, "topologyId", topology_id);
95+
96+
return Z_ARRVAL(retval);
97+
} /* }}} */
98+
/* }}} */
99+
100+
void php_phongo_topologyopeningevent_init_ce(INIT_FUNC_ARGS) /* {{{ */
101+
{
102+
zend_class_entry ce;
103+
(void) type;
104+
(void) module_number;
105+
106+
INIT_NS_CLASS_ENTRY(ce, "MongoDB\\Driver\\Monitoring", "TopologyOpeningEvent", php_phongo_topologyopeningevent_me);
107+
php_phongo_topologyopeningevent_ce = zend_register_internal_class(&ce);
108+
php_phongo_topologyopeningevent_ce->create_object = php_phongo_topologyopeningevent_create_object;
109+
PHONGO_CE_FINAL(php_phongo_topologyopeningevent_ce);
110+
PHONGO_CE_DISABLE_SERIALIZATION(php_phongo_topologyopeningevent_ce);
111+
112+
memcpy(&php_phongo_handler_topologyopeningevent, phongo_get_std_object_handlers(), sizeof(zend_object_handlers));
113+
php_phongo_handler_topologyopeningevent.get_debug_info = php_phongo_topologyopeningevent_get_debug_info;
114+
php_phongo_handler_topologyopeningevent.free_obj = php_phongo_topologyopeningevent_free_object;
115+
php_phongo_handler_topologyopeningevent.offset = XtOffsetOf(php_phongo_topologyopeningevent_t, std);
116+
117+
return;
118+
} /* }}} */
119+
120+
/*
121+
* Local variables:
122+
* tab-width: 4
123+
* c-basic-offset: 4
124+
* End:
125+
* vim600: noet sw=4 ts=4 fdm=marker
126+
* vim<600: noet sw=4 ts=4
127+
*/

‎src/phongo_apm.c

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,35 @@ static void phongo_apm_topology_changed(const mongoc_apm_topology_changed_t* eve
292292
FREE_HASHTABLE(subscribers);
293293
}
294294

295+
static void phongo_apm_topology_opening(const mongoc_apm_topology_opening_t* event)
296+
{
297+
mongoc_client_t* client;
298+
HashTable* subscribers;
299+
php_phongo_topologyopeningevent_t* p_event;
300+
zval z_event;
301+
302+
client = mongoc_apm_topology_opening_get_context(event);
303+
subscribers = phongo_apm_get_subscribers_to_notify(php_phongo_sdamsubscriber_ce, client);
304+
305+
/* Return early if there are no APM subscribers to notify */
306+
if (zend_hash_num_elements(subscribers) == 0) {
307+
goto cleanup;
308+
}
309+
310+
object_init_ex(&z_event, php_phongo_topologyopeningevent_ce);
311+
p_event = Z_TOPOLOGYOPENINGEVENT_OBJ_P(&z_event);
312+
313+
mongoc_apm_topology_opening_get_topology_id(event, &p_event->topology_id);
314+
;
315+
316+
phongo_apm_dispatch_event(subscribers, "topologyOpening", &z_event);
317+
zval_ptr_dtor(&z_event);
318+
319+
cleanup:
320+
zend_hash_destroy(subscribers);
321+
FREE_HASHTABLE(subscribers);
322+
}
323+
295324
/* Assigns APM callbacks to a client, which will notify any global or per-client
296325
* subscribers. This should be called for all clients created by the driver.
297326
* Returns true on success; otherwise, throws an exception and returns false. */
@@ -305,6 +334,7 @@ bool phongo_apm_set_callbacks(mongoc_client_t* client)
305334
mongoc_apm_set_command_succeeded_cb(callbacks, phongo_apm_command_succeeded);
306335
mongoc_apm_set_command_failed_cb(callbacks, phongo_apm_command_failed);
307336
mongoc_apm_set_topology_changed_cb(callbacks, phongo_apm_topology_changed);
337+
mongoc_apm_set_topology_opening_cb(callbacks, phongo_apm_topology_opening);
308338

309339
retval = mongoc_client_set_apm_callbacks(client, callbacks, client);
310340

‎tests/apm/monitoring-topologyChanged-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ class MySubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
2424
echo "- getNewDescription() returns a TopologyDescription: ", ($event->getNewDescription() instanceof MongoDB\Driver\TopologyDescription) ? 'yes' : 'no', "\n";
2525
echo "- getPreviousDescription() returns a TopologyDescription: ", ($event->getPreviousDescription() instanceof MongoDB\Driver\TopologyDescription) ? 'yes' : 'no', "\n";
2626
}
27+
28+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
2729
}
2830

2931
$subscriber = new MySubscriber;

‎tests/apm/monitoring-topologyOpening-001.phpt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
--TEST--
2+
MongoDB\Driver\Monitoring\TopologyOpeningEvent
3+
--SKIPIF--
4+
<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
5+
<?php skip_if_not_live(); ?>
6+
--FILE--
7+
<?php
8+
require_once __DIR__ . "/../utils/basic.inc";
9+
10+
$m = create_test_manager();
11+
12+
class MySubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
13+
{
14+
public function topologyChanged(MongoDB\Driver\Monitoring\TopologyChangedEvent $event) {}
15+
16+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event)
17+
{
18+
echo "- getTopologyId() returns an ObjectId: ", ($event->getTopologyId() instanceof MongoDB\BSON\ObjectId) ? 'yes' : 'no', "\n";
19+
}
20+
}
21+
22+
$subscriber = new MySubscriber;
23+
MongoDB\Driver\Monitoring\addSubscriber($subscriber);
24+
25+
$command = new MongoDB\Driver\Command(['ping' => 1]);
26+
$m->executeCommand(DATABASE_NAME, $command);
27+
28+
?>
29+
===DONE===
30+
<?php exit(0); ?>
31+
--EXPECT--
32+
- getTopologyId() returns an ObjectId: yes
33+
===DONE===

‎tests/topologyDescription/topologyDescription-debug-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

‎tests/topologyDescription/topologyDescription-getServers-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

‎tests/topologyDescription/topologyDescription-getType-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

‎tests/topologyDescription/topologyDescription-hasReadableServer-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

‎tests/topologyDescription/topologyDescription-hasReadableServer-002.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

‎tests/topologyDescription/topologyDescription-hasReadableServer_error-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

‎tests/topologyDescription/topologyDescription-hasWritableServer-001.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ class TopologyDescriptionProvider implements MongoDB\Driver\Monitoring\SDAMSubsc
1616
$this->topologyDescription = $event->getNewDescription();
1717
}
1818

19+
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event) {}
20+
1921
public function getTopologyDescription()
2022
{
2123
$manager = create_test_manager();

0 commit comments

Comments
 (0)