PHPC-444: Support options array in BulkWrite and executeInsert()

jmikola · jmikola · commit 52dfd6b2d29f · 2015-10-15T15:44:17.000-04:00
diff --git a/scripts/convert-mo-tests.php b/scripts/convert-mo-tests.php
@@ -242,7 +242,7 @@ function clientOperation($phase, &$output) {
         $retval = <<< CODE
 try {
     \$wc = new MongoDB\\Driver\\WriteConcern($wc);
-    \$result = \$manager->executeInsert("databaseName.collectionName", $doc, \$wc);
+    \$result = \$manager->executeInsert("databaseName.collectionName", $doc, [], \$wc);
     if (\$result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/src/MongoDB/BulkWrite.c b/src/MongoDB/BulkWrite.c
@@ -51,25 +51,29 @@ PHONGO_API zend_class_entry *php_phongo_bulkwrite_ce;
 
 zend_object_handlers php_phongo_handler_bulkwrite;
 
-/* {{{ proto MongoDB\Driver\BulkWrite BulkWrite::__construct(boolean $ordered)
+/* {{{ proto MongoDB\Driver\BulkWrite BulkWrite::__construct([array $options = array()])
    Constructs a new BulkWrite */
 PHP_METHOD(BulkWrite, __construct)
 {
 	php_phongo_bulkwrite_t  *intern;
 	zend_error_handling      error_handling;
+	zval                    *options = NULL;
 	zend_bool                ordered = 1;
 	(void)return_value_ptr; (void)return_value; (void)return_value_used;
 
 
 	zend_replace_error_handling(EH_THROW, phongo_exception_from_phongo_domain(PHONGO_ERROR_INVALID_ARGUMENT), &error_handling TSRMLS_CC);
 	intern = (php_phongo_bulkwrite_t *)zend_object_store_get_object(getThis() TSRMLS_CC);
 
-	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &ordered) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|a!", &options) == FAILURE) {
 		zend_restore_error_handling(&error_handling TSRMLS_CC);
 		return;
 	}
 	zend_restore_error_handling(&error_handling TSRMLS_CC);
 
+	if (options && php_array_exists(options, "ordered")) {
+		ordered = php_array_fetch_bool(options, "ordered");
+	}
 
 	intern->bulk = phongo_bulkwrite_init(ordered);
 }
@@ -225,7 +229,7 @@ PHP_METHOD(BulkWrite, count)
 /* {{{ MongoDB\Driver\BulkWrite */
 
 ZEND_BEGIN_ARG_INFO_EX(ai_BulkWrite___construct, 0, 0, 0)
-	ZEND_ARG_INFO(0, ordered)
+	ZEND_ARG_ARRAY_INFO(0, options, 1)
 ZEND_END_ARG_INFO();
 
 ZEND_BEGIN_ARG_INFO_EX(ai_BulkWrite_insert, 0, 0, 1)
diff --git a/src/MongoDB/Manager.c b/src/MongoDB/Manager.c
@@ -180,28 +180,33 @@ PHP_METHOD(Manager, executeBulkWrite)
 	phongo_execute_write(intern->client, namespace, bulk->bulk, phongo_write_concern_from_zval(zwrite_concern TSRMLS_CC), -1, return_value, return_value_used TSRMLS_CC);
 }
 /* }}} */
-/* {{{ proto MongoDB\Driver\WriteResult Manager::executeInsert(string $namespace, array|object $document[, MongoDB\Driver\WriteConcern $writeConcern = null])
+/* {{{ proto MongoDB\Driver\WriteResult Manager::executeInsert(string $namespace, array|object $document[, array $insertOptions = array()[, MongoDB\Driver\WriteConcern $writeConcern = null]])
    Convenience method for single insert operation. */
 PHP_METHOD(Manager, executeInsert)
 {
 	php_phongo_manager_t     *intern;
 	char                     *namespace;
 	int                       namespace_len;
 	zval                     *document;
+	zval                     *insertOptions = NULL;
 	zval                     *zwrite_concern = NULL;
 	bson_t                   *bson;
 	(void)return_value_ptr;
 
 
 	intern = (php_phongo_manager_t *)zend_object_store_get_object(getThis() TSRMLS_CC);
 
-	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sA|O!", &namespace, &namespace_len, &document, &zwrite_concern, php_phongo_writeconcern_ce) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sA|a!O!", &namespace, &namespace_len, &document, &insertOptions, &zwrite_concern, php_phongo_writeconcern_ce) == FAILURE) {
 		return;
 	}
 
 
 	bson = bson_new();
 	zval_to_bson(document, PHONGO_BSON_ADD_ODS|PHONGO_BSON_ADD_CHILD_ODS, bson, NULL TSRMLS_CC);
+
+	/* When PHPC-443 is implemented, insertOptions will be parsed for the
+	 * bypassDocumentValidation option; however, there's nothing to do now. */
+
 	phongo_execute_single_insert(intern->client, namespace, bson, phongo_write_concern_from_zval(zwrite_concern TSRMLS_CC), -1, return_value, return_value_used TSRMLS_CC);
 	bson_clear(&bson);
 }
@@ -422,6 +427,7 @@ ZEND_END_ARG_INFO();
 ZEND_BEGIN_ARG_INFO_EX(ai_Manager_executeInsert, 0, 0, 2)
 	ZEND_ARG_INFO(0, namespace)
 	ZEND_ARG_INFO(0, document)
+	ZEND_ARG_ARRAY_INFO(0, insertOptions, 1)
 	ZEND_ARG_OBJ_INFO(0, writeConcern, MongoDB\\Driver\\WriteConcern, 1)
 ZEND_END_ARG_INFO();
 
diff --git a/tests/bulk/write-0002.phpt b/tests/bulk/write-0002.phpt
@@ -10,9 +10,8 @@ $manager = new MongoDB\Driver\Manager(STANDALONE);
 
 $hannes = array("name" => "Hannes", "country" => "USA", "gender" => "male");
 $hayley = array("name" => "Hayley", "country" => "USA", "gender" => "female");
-$ordered = true;
 
-$insertBulk = new \MongoDB\Driver\BulkWrite($ordered);
+$insertBulk = new \MongoDB\Driver\BulkWrite(['ordered' => true]);
 $hannes_id = $insertBulk->insert($hannes);
 $hayley_id = $insertBulk->insert($hayley);
 
diff --git a/tests/cluster/rs/connection/read/primary-available.phpt b/tests/cluster/rs/connection/read/primary-available.phpt
@@ -91,7 +91,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/rs/connection/read/primary-not-available.phpt b/tests/cluster/rs/connection/read/primary-not-available.phpt
@@ -91,7 +91,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/rs/connection/write/primary-available.phpt b/tests/cluster/rs/connection/write/primary-available.phpt
@@ -91,7 +91,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/rs/connection/write/primary-not-available.phpt b/tests/cluster/rs/connection/write/primary-not-available.phpt
@@ -95,7 +95,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/rs/connection/write/primary-restarted.phpt b/tests/cluster/rs/connection/write/primary-restarted.phpt
@@ -95,7 +95,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
@@ -113,7 +113,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 2,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/rs/discovery/remove-all-add-members.phpt b/tests/cluster/rs/discovery/remove-all-add-members.phpt
@@ -109,7 +109,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/rs/discovery/stepped-down-primary-triggers-refresh.phpt b/tests/cluster/rs/discovery/stepped-down-primary-triggers-refresh.phpt
@@ -109,7 +109,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/sharded/connection/all-mongos-available.phpt b/tests/cluster/sharded/connection/all-mongos-available.phpt
@@ -82,7 +82,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/sharded/connection/no-mongos-available.phpt b/tests/cluster/sharded/connection/no-mongos-available.phpt
@@ -82,7 +82,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/single/connection/read/standalone-available.phpt b/tests/cluster/single/connection/read/standalone-available.phpt
@@ -64,7 +64,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/single/connection/read/standalone-not-available.phpt b/tests/cluster/single/connection/read/standalone-not-available.phpt
@@ -64,7 +64,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/single/connection/read/standalone-restarted.phpt b/tests/cluster/single/connection/read/standalone-restarted.phpt
@@ -64,7 +64,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/single/connection/write/standalone-available.phpt b/tests/cluster/single/connection/write/standalone-available.phpt
@@ -64,7 +64,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/single/connection/write/standalone-not-available.phpt b/tests/cluster/single/connection/write/standalone-not-available.phpt
@@ -68,7 +68,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/cluster/single/connection/write/standalone-restarted.phpt b/tests/cluster/single/connection/write/standalone-restarted.phpt
@@ -64,7 +64,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 1,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
@@ -82,7 +82,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 2,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
@@ -100,7 +100,7 @@ try {
     $wc = new MongoDB\Driver\WriteConcern(1);
     $result = $manager->executeInsert("databaseName.collectionName", array (
       'x' => 3,
-    ), $wc);
+    ), [], $wc);
     if ($result->getInsertedCount() == 1) {
         var_dump(array("ok" => 1));
     } else {
diff --git a/tests/manager/manager-executeBulkWrite-002.phpt b/tests/manager/manager-executeBulkWrite-002.phpt
@@ -8,7 +8,7 @@ require_once __DIR__ . "/../utils/basic.inc";
 
 $manager = new MongoDB\Driver\Manager(STANDALONE);
 
-$bulk = new MongoDB\Driver\BulkWrite(true);
+$bulk = new MongoDB\Driver\BulkWrite(['ordered' => true]);
 $bulk->insert(array('_id' => 1));
 $bulk->insert(array('_id' => 1));
 $bulk->insert(array('_id' => 2));
diff --git a/tests/manager/manager-executeBulkWrite-003.phpt b/tests/manager/manager-executeBulkWrite-003.phpt
@@ -8,7 +8,7 @@ require_once __DIR__ . "/../utils/basic.inc";
 
 $manager = new MongoDB\Driver\Manager(STANDALONE);
 
-$bulk = new MongoDB\Driver\BulkWrite(false);
+$bulk = new MongoDB\Driver\BulkWrite(['ordered' => false]);
 $bulk->insert(array('_id' => 1));
 $bulk->insert(array('_id' => 1));
 $bulk->insert(array('_id' => 2));
diff --git a/tests/manager/manager-executeBulkWrite-004.phpt b/tests/manager/manager-executeBulkWrite-004.phpt
@@ -8,7 +8,7 @@ require_once __DIR__ . "/../utils/basic.inc";
 
 $manager = new MongoDB\Driver\Manager(STANDALONE);
 
-$bulk = new MongoDB\Driver\BulkWrite(false);
+$bulk = new MongoDB\Driver\BulkWrite(['ordered' => false]);
 $bulk->update(array('x' => 'foo'), array('$set' => array('y' => 'foo')), array('upsert' => true));
 $bulk->update(array('x' => 'bar'), array('$set' => array('y' => 'bar')), array('upsert' => true));
 $bulk->update(array('x' => 'foo'), array('$set' => array('y' => 'bar')));
diff --git a/tests/manager/manager-executeInsert_error-002.phpt b/tests/manager/manager-executeInsert_error-002.phpt
@@ -10,7 +10,7 @@ require_once __DIR__ . "/../utils/basic.inc";
 $manager = new MongoDB\Driver\Manager(REPLICASET);
 
 echo throws(function() use ($manager) {
-    $manager->executeInsert(NS, ['x' => 1], new MongoDB\Driver\WriteConcern(30));
+    $manager->executeInsert(NS, ['x' => 1], [], new MongoDB\Driver\WriteConcern(30));
 }, 'MongoDB\Driver\Exception\WriteConcernException'), "\n";
 
 ?>
diff --git a/tests/replicaset/bug0155.phpt b/tests/replicaset/bug0155.phpt
@@ -13,7 +13,7 @@ $wc = new MongoDB\Driver\WriteConcern("MultipleDC", 500);
 
 $doc = array("example" => "document");
 try {
-    $result = $manager->executeInsert("databaseName.collectionName", $doc, $wc);
+    $result = $manager->executeInsert("databaseName.collectionName", $doc, [], $wc);
 } catch(MongoDB\Driver\Exception\WriteConcernException $e) {
     var_dump($e->getWriteResult()->getWriteConcernError());
 }
diff --git a/tests/standalone/write-error-001.phpt b/tests/standalone/write-error-001.phpt
@@ -9,9 +9,8 @@ require_once __DIR__ . "/../utils/basic.inc";
 $manager = new MongoDB\Driver\Manager(STANDALONE);
 
 $hannes = array("name" => "Hannes", "country" => "USA", "gender" => "male");
-$ordered = true;
 
-$bulk = new \MongoDB\Driver\BulkWrite($ordered);
+$bulk = new \MongoDB\Driver\BulkWrite(['ordered' => true]);
 $hannes_id = $bulk->insert($hannes);
 
 $w = 2;
diff --git a/tests/standalone/writeresult-isacknowledged-003.phpt b/tests/standalone/writeresult-isacknowledged-003.phpt
@@ -8,7 +8,7 @@ require_once __DIR__ . "/../utils/basic.inc";
 
 $manager = new MongoDB\Driver\Manager(STANDALONE);
 
-$result = $manager->executeInsert(NS, array('x' => 2), new MongoDB\Driver\WriteConcern(0));
+$result = $manager->executeInsert(NS, array('x' => 2), [], new MongoDB\Driver\WriteConcern(0));
 
 printf("WriteResult::isAcknowledged(): %s\n", $result->isAcknowledged() ? 'true' : 'false');
 var_dump($result);
diff --git a/tests/utils/tools.php b/tests/utils/tools.php
@@ -101,7 +101,7 @@ function LOAD($uri, $dbname = DATABASE_NAME, $collname = COLLECTION_NAME, $filen
     }
 
     $manager = new MongoDB\Driver\Manager($uri);
-    $bulk = new MongoDB\Driver\BulkWrite(false);
+    $bulk = new MongoDB\Driver\BulkWrite(['ordered' => false]);
 
     $server = $manager->selectServer(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY));
 
