PHPC-1561: Allow hinting for delete

Author: alcaeus

src/MongoDB/BulkWrite.c

@@ -297,6 +297,10 @@ static bool php_phongo_bulkwrite_delete_apply_options(bson_t* boptions, zval* zo
 	PHONGO_BULKWRITE_APPEND_INT32("limit", limit);
 	PHONGO_BULKWRITE_OPT_DOCUMENT("collation");
 
+	if (!php_phongo_bulkwrite_opt_hint(boptions, zoptions)) {
+		return false;
+	}
+
 	return true;
 } /* }}} */
 

tests/bulk/bulkwrite-delete-002.phpt

@@ -0,0 +1,55 @@
+--TEST--
+MongoDB\Driver\BulkWrite::delete() with hint option
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '4.3.4'); ?>
+<?php skip_if_not_clean(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+class CommandLogger implements MongoDB\Driver\Monitoring\CommandSubscriber
+{
+    public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event)
+    {
+        if ($event->getCommandName() !== 'delete') {
+            return;
+        }
+
+        printf("delete included hint: %s\n", json_encode($event->getCommand()->deletes[0]->hint));
+    }
+
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event)
+    {
+    }
+
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event)
+    {
+    }
+}
+
+$manager = new MongoDB\Driver\Manager(URI);
+
+$bulk = new MongoDB\Driver\BulkWrite();
+$bulk->insert(['x' => 1]);
+$bulk->insert(['x' => 2]);
+$manager->executeBulkWrite(NS, $bulk);
+
+MongoDB\Driver\Monitoring\addSubscriber(new CommandLogger);
+
+$bulk = new MongoDB\Driver\BulkWrite;
+$bulk->delete(['_id' => 1], ['hint' => '_id_']);
+$manager->executeBulkWrite(NS, $bulk);
+
+$bulk = new MongoDB\Driver\BulkWrite;
+$bulk->delete(['_id' => 2], ['hint' => ['_id' => 1]]);
+$manager->executeBulkWrite(NS, $bulk);
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+delete included hint: "_id_"
+delete included hint: {"_id":1}
+===DONE===

tests/bulk/bulkwrite-delete_error-001.phpt

@@ -9,6 +9,10 @@ $bulk = new MongoDB\Driver\BulkWrite;
 
 echo throws(function() use ($bulk) {
     $bulk->delete(['x' => 1], ['collation' => 1]);
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n\n";
+
+echo throws(function() use ($bulk) {
+    $bulk->delete(['x' => 1], ['hint' => 1]);
 }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
 
 ?>
@@ -17,4 +21,7 @@ echo throws(function() use ($bulk) {
 --EXPECTF--
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
 Expected "collation" option to be array or object, int%S given
+
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected "hint" option to be string, array, or object, int%S given
 ===DONE===

tests/bulk/bulkwrite-delete_error-005.phpt

@@ -0,0 +1,27 @@
+--TEST--
+MongoDB\Driver\BulkWrite::delete() hint option requires MongoDB 4.4 (server-side error)
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('>=', '4.3.4'); ?>
+<?php skip_if_server_version('<=', '3.6.0'); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+$manager = new MongoDB\Driver\Manager(URI);
+
+$bulk = new MongoDB\Driver\BulkWrite;
+$bulk->delete(['_id' => 1], ['hint' => '_id_']);
+
+echo throws(function() use ($manager, $bulk) {
+    $manager->executeBulkWrite(NS, $bulk);
+}, 'MongoDB\Driver\Exception\BulkWriteException'), "\n";
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+OK: Got MongoDB\Driver\Exception\BulkWriteException
+BSON field 'delete.deletes.hint' is an unknown field.
+===DONE===