PHPC-2094: Relay command comment when constructing a cursor (#1322)

Author: jmikola

src/phongo_execute.c

@@ -498,7 +498,8 @@ bool phongo_execute_command(zval* manager, php_phongo_command_type_t type, const
 	if (bson_iter_init_find(&iter, &reply, "cursor") && BSON_ITER_HOLDS_DOCUMENT(&iter)) {
 		bson_t       initial_reply = BSON_INITIALIZER;
 		bson_t       cursor_opts   = BSON_INITIALIZER;
-		bson_error_t error         = { 0 };
+		bson_iter_t  iter;
+		bson_error_t error = { 0 };
 
 		bson_copy_to(&reply, &initial_reply);
 
@@ -514,6 +515,10 @@ bool phongo_execute_command(zval* manager, php_phongo_command_type_t type, const
 			bson_append_int64(&cursor_opts, "batchSize", -1, command->batch_size);
 		}
 
+		if (bson_iter_init(&iter, command->bson) && bson_iter_find(&iter, "comment")) {
+			bson_append_value(&cursor_opts, "comment", -1, bson_iter_value(&iter));
+		}
+
 		if (zsession && !mongoc_client_session_append(Z_SESSION_OBJ_P(zsession)->client_session, &cursor_opts, &error)) {
 			phongo_throw_exception_from_bson_error_t(&error);
 			bson_destroy(&initial_reply);

tests/command/cursor-comment-001.phpt

@@ -0,0 +1,70 @@
+--TEST--
+MongoDB\Driver\Command comment applies to getMore
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '4.4'); ?>
+<?php skip_if_not_clean(); ?>
+--FILE--
+<?php
+require_once __DIR__ . "/../utils/basic.inc";
+
+class Test implements MongoDB\Driver\Monitoring\CommandSubscriber
+{
+    public function executeCommand()
+    {
+        MongoDB\Driver\Monitoring\addSubscriber($this);
+
+        $manager = create_test_manager();
+
+        $bulkWrite = new MongoDB\Driver\BulkWrite;
+
+        for ($i = 0; $i < 5; $i++) {
+            $bulkWrite->insert(['_id' => $i]);
+        }
+
+        $writeResult = $manager->executeBulkWrite(NS, $bulkWrite);
+        printf("Inserted: %d\n", $writeResult->getInsertedCount());
+
+        $command = new MongoDB\Driver\Command([
+            'aggregate' => COLLECTION_NAME,
+            'pipeline' => [['$match' => new stdClass]],
+            'comment' => ['foo' => 1],
+            'cursor' => ['batchSize' => 2]
+        ]);
+        $cursor = $manager->executeCommand(DATABASE_NAME, $command);
+
+        $cursor->toArray();
+
+        MongoDB\Driver\Monitoring\removeSubscriber($this);
+    }
+
+    public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event)
+    {
+        $command = $event->getCommand();
+
+        if ($event->getCommandName() === 'aggregate' || $event->getCommandName() === 'getMore') {
+            printf("%s command includes comment: %s\n", $event->getCommandName(), json_encode($command->comment));
+        }
+    }
+
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event)
+    {
+    }
+
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event)
+    {
+    }
+}
+
+(new Test)->executeCommand();
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECT--
+Inserted: 5
+aggregate command includes comment: {"foo":1}
+getMore command includes comment: {"foo":1}
+getMore command includes comment: {"foo":1}
+===DONE===