PHPC-2005: Support 'let' option for multiple CRUD commands (#1312)

Author: jmikola

.evergreen/config.yml

@@ -1126,14 +1126,15 @@ axes:
   - id: libmongoc-version
     display_name: libmongoc version
     values:
-      - id: "lowest-supported"
-        display_name: "1.21.1"
-        variables:
-          LIBMONGOC_VERSION: "1.21.1"
-      - id: "upcoming-stable"
-        display_name: "1.21-dev"
-        variables:
-          LIBMONGOC_VERSION: "r1.21"
+      # TODO: enable lowest-supported and upcoming-stable after 1.22.0 is released and r1.22 is branched.
+      #- id: "lowest-supported"
+      #  display_name: "1.22.0"
+      #  variables:
+      #    LIBMONGOC_VERSION: "1.22.0"
+      #- id: "upcoming-stable"
+      #  display_name: "1.22-dev"
+      #  variables:
+      #    LIBMONGOC_VERSION: "r1.22"
       - id: "latest-dev"
         display_name: "1.22-dev (master)"
         variables:

config.m4

@@ -243,14 +243,14 @@ if test "$PHP_MONGODB" != "no"; then
     AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
     AC_MSG_CHECKING(for libbson)
     if test -x "$PKG_CONFIG" && $PKG_CONFIG --exists libbson-1.0; then
-      if $PKG_CONFIG libbson-1.0 --atleast-version 1.21.1; then
+      if $PKG_CONFIG libbson-1.0 --atleast-version 1.22.0; then
         PHP_MONGODB_BSON_CFLAGS=`$PKG_CONFIG libbson-1.0 --cflags`
         PHP_MONGODB_BSON_LIBS=`$PKG_CONFIG libbson-1.0 --libs`
         PHP_MONGODB_BSON_VERSION=`$PKG_CONFIG libbson-1.0 --modversion`
         PHP_MONGODB_BSON_VERSION_STRING="System ($PHP_MONGODB_BSON_VERSION)"
         AC_MSG_RESULT(version $PHP_MONGODB_BSON_VERSION found)
       else
-        AC_MSG_ERROR(system libbson must be upgraded to version >= 1.21.1)
+        AC_MSG_ERROR(system libbson must be upgraded to version >= 1.22.0)
       fi
     else
       AC_MSG_ERROR(pkgconfig and libbson must be installed)
@@ -261,14 +261,14 @@ if test "$PHP_MONGODB" != "no"; then
 
     AC_MSG_CHECKING(for libmongoc)
     if test -x "$PKG_CONFIG" && $PKG_CONFIG --exists libmongoc-1.0; then
-      if $PKG_CONFIG libmongoc-1.0 --atleast-version 1.21.1; then
+      if $PKG_CONFIG libmongoc-1.0 --atleast-version 1.22.0; then
         PHP_MONGODB_MONGOC_CFLAGS=`$PKG_CONFIG libmongoc-1.0 --cflags`
         PHP_MONGODB_MONGOC_LIBS=`$PKG_CONFIG libmongoc-1.0 --libs`
         PHP_MONGODB_MONGOC_VERSION=`$PKG_CONFIG libmongoc-1.0 --modversion`
         PHP_MONGODB_MONGOC_VERSION_STRING="System ($PHP_MONGODB_MONGOC_VERSION)"
         AC_MSG_RESULT(version $PHP_MONGODB_MONGOC_VERSION found)
       else
-        AC_MSG_ERROR(system libmongoc must be upgraded to version >= 1.21.1)
+        AC_MSG_ERROR(system libmongoc must be upgraded to version >= 1.22.0)
       fi
     else
       AC_MSG_ERROR(pkgconfig and libmongoc must be installed)

src/LIBMONGOC_VERSION_CURRENT

@@ -1 +1 @@
-1.21.1
+1.11.1-20220328+git12b697c3da

src/MongoDB/BulkWrite.c

@@ -334,6 +334,7 @@ static PHP_METHOD(BulkWrite, __construct)
 	intern->bulk     = mongoc_bulk_operation_new(ordered);
 	intern->ordered  = ordered;
 	intern->bypass   = PHONGO_BULKWRITE_BYPASS_UNSET;
+	intern->let      = NULL;
 	intern->num_ops  = 0;
 	intern->executed = false;
 
@@ -342,6 +343,24 @@ static PHP_METHOD(BulkWrite, __construct)
 		mongoc_bulk_operation_set_bypass_document_validation(intern->bulk, bypass);
 		intern->bypass = bypass;
 	}
+
+	if (options && php_array_existsc(options, "let")) {
+		zval* value = php_array_fetch(options, "let");
+
+		if (Z_TYPE_P(value) != IS_OBJECT && Z_TYPE_P(value) != IS_ARRAY) {
+			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected \"let\" option to be array or object, %s given", zend_get_type_by_const(Z_TYPE_P(value)));
+			return;
+		}
+
+		intern->let = bson_new();
+		php_phongo_zval_to_bson(value, PHONGO_BSON_NONE, intern->let, NULL);
+
+		if (EG(exception)) {
+			return;
+		}
+
+		mongoc_bulk_operation_set_let(intern->bulk, intern->let);
+	}
 } /* }}} */
 
 /* {{{ proto mixed MongoDB\Driver\BulkWrite::insert(array|object $document)
@@ -579,6 +598,10 @@ static void php_phongo_bulkwrite_free_object(zend_object* object) /* {{{ */
 		mongoc_bulk_operation_destroy(intern->bulk);
 	}
 
+	if (intern->let) {
+		bson_clear(&intern->let);
+	}
+
 	if (intern->database) {
 		efree(intern->database);
 	}
@@ -633,6 +656,17 @@ static HashTable* php_phongo_bulkwrite_get_debug_info(phongo_compat_object_handl
 		ADD_ASSOC_NULL_EX(&retval, "bypassDocumentValidation");
 	}
 
+	if (intern->let) {
+		zval zv;
+
+		if (!php_phongo_bson_to_zval(bson_get_data(intern->let), intern->let->len, &zv)) {
+			zval_ptr_dtor(&zv);
+			goto done;
+		}
+
+		ADD_ASSOC_ZVAL_EX(&retval, "let", &zv);
+	}
+
 	ADD_ASSOC_BOOL_EX(&retval, "executed", intern->executed);
 	ADD_ASSOC_LONG_EX(&retval, "server_id", mongoc_bulk_operation_get_hint(intern->bulk));
 
@@ -652,6 +686,7 @@ static HashTable* php_phongo_bulkwrite_get_debug_info(phongo_compat_object_handl
 		ADD_ASSOC_NULL_EX(&retval, "write_concern");
 	}
 
+done:
 	return Z_ARRVAL(retval);
 } /* }}} */
 /* }}} */

src/MongoDB/Query.c

@@ -299,6 +299,7 @@ static bool php_phongo_query_init(php_phongo_query_t* intern, zval* filter, zval
 	PHONGO_QUERY_OPT_STRING("comment", options, "comment")
 	else PHONGO_QUERY_OPT_STRING("comment", modifiers, "$comment");
 	PHONGO_QUERY_OPT_BOOL("exhaust", options, "exhaust");
+	PHONGO_QUERY_OPT_DOCUMENT("let", options, "let");
 	PHONGO_QUERY_OPT_DOCUMENT("max", options, "max")
 	else PHONGO_QUERY_OPT_DOCUMENT("max", modifiers, "$max");
 	PHONGO_QUERY_OPT_INT64_DEPRECATED("maxScan", options, "maxScan")

src/libmongoc

@@ -29,6 +29,7 @@ typedef struct {
 	size_t                   num_ops;
 	bool                     ordered;
 	int                      bypass;
+	bson_t*                  let;
 	char*                    database;
 	char*                    collection;
 	bool                     executed;

src/phongo_structs.h

@@ -0,0 +1,68 @@
+--TEST--
+MongoDB\Driver\BulkWrite::__construct(): let option
+--SKIPIF--
+<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '5.0'); ?>
+<?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)
+    {
+        $command = $event->getCommand();
+
+        if (!isset($command->let)) {
+            printf("%s does not include let option\n", $event->getCommandName());
+
+            return;
+        }
+
+        printf("%s included let: %s\n", $event->getCommandName(), json_encode($event->getCommand()->let));
+    }
+
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event)
+    {
+    }
+
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event)
+    {
+    }
+}
+
+$manager = create_test_manager();
+
+$bulk = new MongoDB\Driver\BulkWrite(['let' => ['id' => 1, 'x' => 'foo']]);
+$bulk->insert(['_id' => 1]);
+$bulk->insert(['_id' => 2]);
+$bulk->delete(['$expr' => ['$eq' => ['$_id', '$$id']]]);
+$bulk->update(['_id' => 2], [['$set' => ['x' => '$$x']]]);
+
+$manager->addSubscriber(new CommandLogger);
+$manager->executeBulkWrite(NS, $bulk);
+
+$cursor = $manager->executeQuery(NS, new MongoDB\Driver\Query([]));
+var_dump($cursor->toArray());
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+insert does not include let option
+delete included let: {"id":1,"x":"foo"}
+update included let: {"id":1,"x":"foo"}
+find does not include let option
+array(1) {
+  [0]=>
+  object(stdClass)#%d (%d) {
+    ["_id"]=>
+    int(2)
+    ["x"]=>
+    string(3) "foo"
+  }
+}
+===DONE===

tests/bulk/bulkwrite-ctor-let-001.phpt

@@ -0,0 +1,28 @@
+--TEST--
+MongoDB\Driver\BulkWrite::__construct(): let option
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/basic.inc';
+
+$invalidValues = [true, 1, 'string', null];
+
+foreach ($invalidValues as $invalidValue) {
+    echo throws(function() use ($invalidValue) {
+        new MongoDB\Driver\BulkWrite(['let' => $invalidValue]);
+    }, MongoDB\Driver\Exception\InvalidArgumentException::class), "\n";
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected "let" option to be array or object, %r(bool|boolean)%r given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected "let" option to be array or object, %r(int|integer)%r given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected "let" option to be array or object, string given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected "let" option to be array or object, null given
+===DONE===

tests/bulk/bulkwrite-ctor-let_error-001.phpt

@@ -9,6 +9,7 @@ $tests = [
     ['ordered' => false],
     ['bypassDocumentValidation' => true],
     ['bypassDocumentValidation' => false],
+    ['let' => ['id' => 1, 'x' => 'foo']],
 ];
 
 foreach ($tests as $options) {
@@ -109,4 +110,29 @@ object(MongoDB\Driver\BulkWrite)#%d (%d) {
   ["write_concern"]=>
   NULL
 }
+object(MongoDB\Driver\BulkWrite)#%d (%d) {
+  ["database"]=>
+  NULL
+  ["collection"]=>
+  NULL
+  ["ordered"]=>
+  bool(true)
+  ["bypassDocumentValidation"]=>
+  NULL
+  ["let"]=>
+  object(stdClass)#%d (%d) {
+    ["id"]=>
+    int(1)
+    ["x"]=>
+    string(3) "foo"
+  }
+  ["executed"]=>
+  bool(false)
+  ["server_id"]=>
+  int(0)
+  ["session"]=>
+  NULL
+  ["write_concern"]=>
+  NULL
+}
 ===DONE===