PHPC-2141: Emit deprecation notice for WriteResult getters with unacknowledged writes (#1367)

Author: alcaeus

src/MongoDB/WriteResult.c

@@ -31,10 +31,17 @@
 #include "MongoDB/WriteError.h"
 #include "WriteResult_arginfo.h"
 
+#define PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED(method)                                                                                                                                        \
+	if (!mongoc_write_concern_is_acknowledged(intern->write_concern)) {                                                                                                                      \
+		php_error_docref(NULL, E_DEPRECATED, "Calling MongoDB\\Driver\\WriteResult::" method "() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0"); \
+		RETURN_NULL();                                                                                                                                                                       \
+	}
+
 #define PHONGO_WRITERESULT_RETURN_LONG_FROM_BSON_INT32(iter, bson, key)                \
 	if (bson_iter_init_find((iter), (bson), (key)) && BSON_ITER_HOLDS_INT32((iter))) { \
 		RETURN_LONG(bson_iter_int32((iter)));                                          \
-	}
+	}                                                                                  \
+	RETURN_LONG(0);
 
 zend_class_entry* php_phongo_writeresult_ce;
 
@@ -123,6 +130,8 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getInsertedCount)
 
 	PHONGO_PARSE_PARAMETERS_NONE();
 
+	PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED("getInsertedCount");
+
 	PHONGO_WRITERESULT_RETURN_LONG_FROM_BSON_INT32(&iter, intern->reply, "nInserted");
 }
 
@@ -136,6 +145,8 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getMatchedCount)
 
 	PHONGO_PARSE_PARAMETERS_NONE();
 
+	PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED("getMatchedCount");
+
 	PHONGO_WRITERESULT_RETURN_LONG_FROM_BSON_INT32(&iter, intern->reply, "nMatched");
 }
 
@@ -149,6 +160,8 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getModifiedCount)
 
 	PHONGO_PARSE_PARAMETERS_NONE();
 
+	PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED("getModifiedCount");
+
 	PHONGO_WRITERESULT_RETURN_LONG_FROM_BSON_INT32(&iter, intern->reply, "nModified");
 }
 
@@ -162,6 +175,8 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getDeletedCount)
 
 	PHONGO_PARSE_PARAMETERS_NONE();
 
+	PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED("getDeletedCount");
+
 	PHONGO_WRITERESULT_RETURN_LONG_FROM_BSON_INT32(&iter, intern->reply, "nRemoved");
 }
 
@@ -175,6 +190,8 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getUpsertedCount)
 
 	PHONGO_PARSE_PARAMETERS_NONE();
 
+	PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED("getUpsertedCount");
+
 	PHONGO_WRITERESULT_RETURN_LONG_FROM_BSON_INT32(&iter, intern->reply, "nUpserted");
 }
 
@@ -200,6 +217,8 @@ static PHP_METHOD(MongoDB_Driver_WriteResult, getUpsertedIds)
 
 	PHONGO_PARSE_PARAMETERS_NONE();
 
+	PHONGO_WRITERESULT_CHECK_ACKNOWLEDGED("getUpsertedIds");
+
 	array_init(return_value);
 
 	if (bson_iter_init_find(&iter, intern->reply, "upserted") && BSON_ITER_HOLDS_ARRAY(&iter) && bson_iter_recurse(&iter, &child)) {

tests/manager/manager-executeBulkWrite-012.phpt

@@ -29,8 +29,10 @@ foreach ($writeConcerns as $wc) {
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
 bool(false)
+
+Deprecated: MongoDB\Driver\WriteResult::getInsertedCount(): Calling MongoDB\Driver\WriteResult::getInsertedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 bool(true)
 int(1)

tests/server/server-executeBulkWrite-002.phpt

@@ -25,8 +25,10 @@ foreach ($writeConcerns as $writeConcern) {
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
 bool(false)
+
+Deprecated: MongoDB\Driver\WriteResult::getInsertedCount(): Calling MongoDB\Driver\WriteResult::getInsertedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 bool(true)
 int(1)

tests/server/server-executeBulkWrite-003.phpt

@@ -26,8 +26,10 @@ foreach ($writeConcerns as $wc) {
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
 bool(false)
+
+Deprecated: MongoDB\Driver\WriteResult::getInsertedCount(): Calling MongoDB\Driver\WriteResult::getInsertedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 bool(true)
 int(1)

tests/server/server-executeBulkWrite-005.phpt

@@ -35,8 +35,10 @@ $server->executeBulkWrite('local.' . COLLECTION_NAME, $bulk);
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
 bool(false)
+
+Deprecated: MongoDB\Driver\WriteResult::getInsertedCount(): Calling MongoDB\Driver\WriteResult::getInsertedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 bool(true)
 int(1)

tests/server/server-executeBulkWrite-006.phpt

@@ -30,8 +30,10 @@ foreach ($writeConcerns as $wc) {
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
 bool(false)
+
+Deprecated: MongoDB\Driver\WriteResult::getInsertedCount(): Calling MongoDB\Driver\WriteResult::getInsertedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 bool(true)
 int(1)

tests/writeResult/writeresult-getdeletedcount-002.phpt

@@ -24,6 +24,7 @@ var_dump($result->getDeletedCount());
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
+Deprecated: MongoDB\Driver\WriteResult::getDeletedCount(): Calling MongoDB\Driver\WriteResult::getDeletedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 ===DONE===

tests/writeResult/writeresult-getinsertedcount-002.phpt

@@ -24,6 +24,7 @@ var_dump($result->getInsertedCount());
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
+Deprecated: MongoDB\Driver\WriteResult::getInsertedCount(): Calling MongoDB\Driver\WriteResult::getInsertedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 ===DONE===

tests/writeResult/writeresult-getmatchedcount-002.phpt

@@ -24,6 +24,7 @@ var_dump($result->getMatchedCount());
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
+Deprecated: MongoDB\Driver\WriteResult::getMatchedCount(): Calling MongoDB\Driver\WriteResult::getMatchedCount() for an unacknowledged write is deprecated and will throw an exception in %s
 NULL
 ===DONE===

tests/writeResult/writeresult-getmodifiedcount-002.phpt

@@ -24,6 +24,7 @@ var_dump($result->getModifiedCount());
 ?>
 ===DONE===
 <?php exit(0); ?>
---EXPECT--
+--EXPECTF--
+Deprecated: MongoDB\Driver\WriteResult::getModifiedCount(): Calling MongoDB\Driver\WriteResult::getModifiedCount() for an unacknowledged write is deprecated and will throw an exception in ext-mongodb 2.0 in %s
 NULL
 ===DONE===