Skip to content

Commit 5bcd942

Browse files
jmikolajmikola
committed
Consistent WriteError and WriteConcernError parsing for bulk write results
1 parent 32ced6e commit 5bcd942

File tree

6 files changed

+89
-65
lines changed

6 files changed

+89
-65
lines changed

‎src/MongoDB/BulkWriteCommandResult.c

Lines changed: 51 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -40,78 +40,81 @@
4040

4141
zend_class_entry* php_phongo_bulkwritecommandresult_ce;
4242

43-
static bool php_phongo_bulkwritecommandresult_get_writeconcernerrors(php_phongo_bulkwritecommandresult_t* intern, zval* return_value)
43+
/* Populates return_value with a list of WriteConcernError objects. Returns true
44+
* on success; otherwise, false is returned and an exception is thrown. */
45+
static bool phongo_bulkwritecommandresult_get_writeconcernerrors(php_phongo_bulkwritecommandresult_t* intern, zval* return_value)
4446
{
4547
bson_iter_t iter;
4648

4749
array_init(return_value);
4850

49-
if (!intern->write_concern_errors) {
50-
return true;
51-
}
51+
if (intern->write_concern_errors && bson_iter_init(&iter, intern->write_concern_errors)) {
52+
while (bson_iter_next(&iter)) {
53+
bson_t bson;
54+
uint32_t len;
55+
const uint8_t* data;
56+
zval write_concern_error;
5257

53-
for (bson_iter_init(&iter, intern->write_concern_errors); bson_iter_next(&iter);) {
54-
bson_t bson;
55-
uint32_t len;
56-
const uint8_t* data;
57-
zval write_concern_error;
58+
if (!BSON_ITER_HOLDS_DOCUMENT(&iter)) {
59+
continue;
60+
}
5861

59-
if (!BSON_ITER_HOLDS_DOCUMENT(&iter)) {
60-
continue;
61-
}
62+
bson_iter_document(&iter, &len, &data);
6263

63-
bson_iter_document(&iter, &len, &data);
64+
if (!bson_init_static(&bson, data, len)) {
65+
continue;
66+
}
6467

65-
if (!bson_init_static(&bson, data, len)) {
66-
continue;
67-
}
68+
if (!phongo_writeconcernerror_init(&write_concern_error, &bson)) {
69+
/* Exception already thrown */
70+
zval_ptr_dtor(&write_concern_error);
71+
return false;
72+
}
6873

69-
if (!phongo_writeconcernerror_init(&write_concern_error, &bson)) {
70-
zval_ptr_dtor(&write_concern_error);
71-
continue;
74+
add_next_index_zval(return_value, &write_concern_error);
7275
}
73-
74-
add_next_index_zval(return_value, &write_concern_error);
7576
}
7677

7778
return true;
7879
}
7980

80-
static bool php_phongo_bulkwritecommandresult_get_writeerrors(php_phongo_bulkwritecommandresult_t* intern, zval* return_value)
81+
/* Populates return_value with a map of WriteError objects indexed by the offset
82+
* of the corresponding operation. Returns true on success; otherwise, false is
83+
* returned and an exception is thrown. */
84+
static bool phongo_bulkwritecommandresult_get_writeerrors(php_phongo_bulkwritecommandresult_t* intern, zval* return_value)
8185
{
8286
bson_iter_t iter;
8387

8488
array_init(return_value);
8589

86-
if (!intern->write_errors) {
87-
return true;
88-
}
90+
if (intern->write_errors && bson_iter_init(&iter, intern->write_errors)) {
91+
while (bson_iter_next(&iter)) {
92+
bson_t bson;
93+
uint32_t len;
94+
const uint8_t* data;
95+
zval write_error;
96+
zend_ulong index;
8997

90-
for (bson_iter_init(&iter, intern->write_errors); bson_iter_next(&iter);) {
91-
bson_t bson;
92-
uint32_t len;
93-
const uint8_t* data;
94-
zval write_error;
95-
zend_ulong index;
98+
if (!BSON_ITER_HOLDS_DOCUMENT(&iter)) {
99+
continue;
100+
}
96101

97-
if (!BSON_ITER_HOLDS_DOCUMENT(&iter)) {
98-
continue;
99-
}
102+
bson_iter_document(&iter, &len, &data);
100103

101-
bson_iter_document(&iter, &len, &data);
104+
if (!bson_init_static(&bson, data, len)) {
105+
continue;
106+
}
102107

103-
if (!bson_init_static(&bson, data, len)) {
104-
continue;
105-
}
108+
index = (zend_ulong) ZEND_STRTOUL(bson_iter_key(&iter), NULL, 10);
106109

107-
index = (zend_ulong) ZEND_STRTOUL(bson_iter_key(&iter), NULL, 10);
110+
if (!phongo_writeerror_init_ex(&write_error, &bson, (int32_t) index)) {
111+
/* Exception already thrown */
112+
zval_ptr_dtor(&write_error);
113+
return false;
114+
}
108115

109-
if (!phongo_writeerror_init_ex(&write_error, &bson, (int32_t) index)) {
110-
zval_ptr_dtor(&write_error);
111-
continue;
116+
add_index_zval(return_value, index, &write_error);
112117
}
113-
114-
add_index_zval(return_value, index, &write_error);
115118
}
116119

117120
return true;
@@ -258,7 +261,7 @@ static PHP_METHOD(MongoDB_Driver_BulkWriteCommandResult, getWriteConcernErrors)
258261

259262
PHONGO_PARSE_PARAMETERS_NONE();
260263

261-
php_phongo_bulkwritecommandresult_get_writeconcernerrors(intern, return_value);
264+
phongo_bulkwritecommandresult_get_writeconcernerrors(intern, return_value);
262265
}
263266

264267
/* Returns any write errors that occurred */
@@ -270,7 +273,7 @@ static PHP_METHOD(MongoDB_Driver_BulkWriteCommandResult, getWriteErrors)
270273

271274
PHONGO_PARSE_PARAMETERS_NONE();
272275

273-
php_phongo_bulkwritecommandresult_get_writeerrors(intern, return_value);
276+
phongo_bulkwritecommandresult_get_writeerrors(intern, return_value);
274277
}
275278

276279
static PHP_METHOD(MongoDB_Driver_BulkWriteCommandResult, getErrorReply)
@@ -378,14 +381,14 @@ static HashTable* php_phongo_bulkwritecommandresult_get_debug_info(zend_object*
378381
{
379382
zval writeerrors;
380383

381-
php_phongo_bulkwritecommandresult_get_writeerrors(intern, &writeerrors);
384+
phongo_bulkwritecommandresult_get_writeerrors(intern, &writeerrors);
382385
ADD_ASSOC_ZVAL_EX(&retval, "writeErrors", &writeerrors);
383386
}
384387

385388
{
386389
zval writeconcernerrors;
387390

388-
php_phongo_bulkwritecommandresult_get_writeconcernerrors(intern, &writeconcernerrors);
391+
phongo_bulkwritecommandresult_get_writeconcernerrors(intern, &writeconcernerrors);
389392
ADD_ASSOC_ZVAL_EX(&retval, "writeConcernErrors", &writeconcernerrors);
390393
}
391394

‎src/MongoDB/WriteConcernError.c

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,13 @@ void php_phongo_writeconcernerror_init_ce(INIT_FUNC_ARGS)
133133
php_phongo_handler_writeconcernerror.offset = XtOffsetOf(php_phongo_writeconcernerror_t, std);
134134
}
135135

136-
zend_bool phongo_writeconcernerror_init(zval* return_value, bson_t* bson)
136+
/* Initializes a new WriteConcernError in return_value using the BSON document.
137+
* Returns true on success; otherwise, false is returned and an exception is
138+
* thrown.
139+
*
140+
* This function supports documents from both mongoc_bulk_operation_execute and
141+
* mongoc_bulkwriteexception_t (returned by mongoc_bulkwrite_execute). */
142+
bool phongo_writeconcernerror_init(zval* return_value, const bson_t* bson)
137143
{
138144
bson_iter_t iter;
139145
php_phongo_writeconcernerror_t* intern;
@@ -150,10 +156,10 @@ zend_bool phongo_writeconcernerror_init(zval* return_value, bson_t* bson)
150156
// Additionally check for field name used by mongoc_bulkwriteexception_t
151157
if ((bson_iter_init_find(&iter, bson, "errmsg") && BSON_ITER_HOLDS_UTF8(&iter)) ||
152158
(bson_iter_init_find(&iter, bson, "message") && BSON_ITER_HOLDS_UTF8(&iter))) {
153-
uint32_t errmsg_len;
154-
const char* err_msg = bson_iter_utf8(&iter, &errmsg_len);
159+
uint32_t len;
160+
const char* message = bson_iter_utf8(&iter, &len);
155161

156-
intern->message = estrndup(err_msg, errmsg_len);
162+
intern->message = estrndup(message, len);
157163
}
158164

159165
// Additionally check for field name used by mongoc_bulkwriteexception_t

‎src/MongoDB/WriteConcernError.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@
2121

2222
#include <php.h>
2323

24-
zend_bool phongo_writeconcernerror_init(zval* return_value, bson_t* bson);
24+
bool phongo_writeconcernerror_init(zval* return_value, const bson_t* bson);
2525

2626
#endif /* PHONGO_WRITECONCERNERROR_H */

‎src/MongoDB/WriteError.c

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,19 @@ void php_phongo_writeerror_init_ce(INIT_FUNC_ARGS)
143143
php_phongo_handler_writeerror.offset = XtOffsetOf(php_phongo_writeerror_t, std);
144144
}
145145

146-
zend_bool phongo_writeerror_init(zval* return_value, bson_t* bson)
146+
bool phongo_writeerror_init(zval* return_value, const bson_t* bson)
147147
{
148148
return phongo_writeerror_init_ex(return_value, bson, 0);
149149
}
150150

151-
zend_bool phongo_writeerror_init_ex(zval* return_value, bson_t* bson, int32_t index)
151+
/* Initializes a new WriteError in return_value using the BSON document. Returns
152+
* true on success; otherwise, false is returned and an exception is thrown.
153+
*
154+
* This function supports documents from both mongoc_bulk_operation_execute and
155+
* mongoc_bulkwriteexception_t (returned by mongoc_bulkwrite_execute). When
156+
* initializing from mongoc_bulkwriteexception_t, an index should be explicitly
157+
* provided since the BSON document will not have an "index" field. */
158+
bool phongo_writeerror_init_ex(zval* return_value, const bson_t* bson, int32_t index)
152159
{
153160
bson_iter_t iter;
154161
php_phongo_writeerror_t* intern;
@@ -181,6 +188,7 @@ zend_bool phongo_writeerror_init_ex(zval* return_value, bson_t* bson, int32_t in
181188
bson_iter_document(&iter, &len, &data);
182189

183190
if (!php_phongo_bson_data_to_zval(data, len, &intern->info)) {
191+
/* Exception already thrown */
184192
zval_ptr_dtor(&intern->info);
185193
ZVAL_UNDEF(&intern->info);
186194

@@ -189,7 +197,7 @@ zend_bool phongo_writeerror_init_ex(zval* return_value, bson_t* bson, int32_t in
189197
}
190198

191199
/* If the WriteError is initialized from mongoc_bulkwriteexception_t, an
192-
* index will already have been specified. */
200+
* index should already have been specified. */
193201
if (!intern->index && bson_iter_init_find(&iter, bson, "index") && BSON_ITER_HOLDS_INT32(&iter)) {
194202
intern->index = bson_iter_int32(&iter);
195203
}

‎src/MongoDB/WriteError.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
#include <php.h>
2323

24-
zend_bool phongo_writeerror_init(zval* return_value, bson_t* bson);
25-
zend_bool phongo_writeerror_init_ex(zval* return_value, bson_t* bson, int32_t index);
24+
bool phongo_writeerror_init(zval* return_value, const bson_t* bson);
25+
bool phongo_writeerror_init_ex(zval* return_value, const bson_t* bson, int32_t index);
2626

2727
#endif /* PHONGO_WRITEERROR_H */

‎src/MongoDB/WriteResult.c

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@
4444

4545
zend_class_entry* php_phongo_writeresult_ce;
4646

47-
static bool php_phongo_writeresult_get_writeconcernerror(php_phongo_writeresult_t* intern, zval* return_value)
47+
/* Populates return_value with a WriteConcernError object (if available).
48+
* Returns true on success; otherwise, false is returned and an exception is
49+
* thrown. */
50+
static bool phongo_writeresult_get_writeconcernerror(php_phongo_writeresult_t* intern, zval* return_value)
4851
{
4952
bson_iter_t iter, child;
5053
zval writeconcernerror;
@@ -68,6 +71,7 @@ static bool php_phongo_writeresult_get_writeconcernerror(php_phongo_writeresult_
6871
}
6972

7073
if (!phongo_writeconcernerror_init(&writeconcernerror, &cbson)) {
74+
/* Exception already thrown */
7175
zval_ptr_dtor(&writeconcernerror);
7276
return false;
7377
}
@@ -81,7 +85,9 @@ static bool php_phongo_writeresult_get_writeconcernerror(php_phongo_writeresult_
8185
return true;
8286
}
8387

84-
static bool php_phongo_writeresult_get_writeerrors(php_phongo_writeresult_t* intern, zval* return_value)
88+
/* Populates return_value with a list of WriteError objects. Returns true on
89+
* success; otherwise, false is returned and an exception is thrown. */
90+
static bool phongo_writeresult_get_writeerrors(php_phongo_writeresult_t* intern, zval* return_value)
8591
{
8692
bson_iter_t iter, child;
8793

@@ -105,8 +111,9 @@ static bool php_phongo_writeresult_get_writeerrors(php_phongo_writeresult_t* int
105111
}
106112

107113
if (!phongo_writeerror_init(&writeerror, &cbson)) {
114+
/* Exception already thrown */
108115
zval_ptr_dtor(&writeerror);
109-
continue;
116+
return false;
110117
}
111118

112119
add_next_index_zval(return_value, &writeerror);
@@ -282,7 +289,7 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getWriteConcernError)
282289

283290
PHONGO_PARSE_PARAMETERS_NONE();
284291

285-
php_phongo_writeresult_get_writeconcernerror(intern, return_value);
292+
phongo_writeresult_get_writeconcernerror(intern, return_value);
286293
}
287294

288295
/* Returns any write errors that occurred */
@@ -294,7 +301,7 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getWriteErrors)
294301

295302
PHONGO_PARSE_PARAMETERS_NONE();
296303

297-
php_phongo_writeresult_get_writeerrors(intern, return_value);
304+
phongo_writeresult_get_writeerrors(intern, return_value);
298305
}
299306

300307
static PHP_METHOD(MongoDB_Driver_WriteResult, getErrorReplies)
@@ -401,14 +408,14 @@ static HashTable* php_phongo_writeresult_get_debug_info(zend_object* object, int
401408
{
402409
zval writeerrors;
403410

404-
php_phongo_writeresult_get_writeerrors(intern, &writeerrors);
411+
phongo_writeresult_get_writeerrors(intern, &writeerrors);
405412
ADD_ASSOC_ZVAL_EX(&retval, "writeErrors", &writeerrors);
406413
}
407414

408415
{
409416
zval writeconcernerror;
410417

411-
php_phongo_writeresult_get_writeconcernerror(intern, &writeconcernerror);
418+
phongo_writeresult_get_writeconcernerror(intern, &writeconcernerror);
412419
ADD_ASSOC_ZVAL_EX(&retval, "writeConcernError", &writeconcernerror);
413420
}
414421

0 commit comments

Comments
 (0)