CDRIVER-5816 allow constructing mongoc_bulkwrite_t without a client

Author: jmikola

src/libmongoc/doc/mongoc_bulkwrite_new.rst

@@ -0,0 +1,19 @@
+:man_page: mongoc_bulkwrite_new
+
+mongoc_bulkwrite_new()
+======================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+   mongoc_bulkwrite_t *
+   mongoc_bulkwrite_new (void);
+
+Description
+-----------
+
+Returns a new :symbol:`mongoc_bulkwrite_t`. Free with :symbol:`mongoc_bulkwrite_destroy()`.
+
+A client must be assigned with :symbol:`mongoc_bulkwrite_set_client()` prior to execution.

src/libmongoc/doc/mongoc_bulkwrite_set_client.rst

@@ -0,0 +1,17 @@
+:man_page: mongoc_bulkwrite_set_client
+
+mongoc_bulkwrite_set_client()
+=============================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+   void
+   mongoc_bulkwrite_set_client (mongoc_bulkwrite_t *self, mongoc_client_t *client);
+
+Description
+-----------
+
+Sets the client that will be used to execute the :symbol:`mongoc_bulkwrite_t`.

src/libmongoc/doc/mongoc_bulkwrite_t.rst

@@ -50,6 +50,8 @@ to execute the operation.
     mongoc_bulkwrite_deletemanyopts_t
     mongoc_bulkwrite_append_deletemany
     mongoc_bulkwritereturn_t
+    mongoc_bulkwrite_new
+    mongoc_bulkwrite_set_client
     mongoc_bulkwrite_set_session
     mongoc_bulkwrite_execute
     mongoc_bulkwrite_destroy

src/libmongoc/src/mongoc/mongoc-bulkwrite.c

@@ -169,11 +169,18 @@ mongoc_bulkwrite_t *
 mongoc_client_bulkwrite_new (mongoc_client_t *self)
 {
    BSON_ASSERT_PARAM (self);
-   mongoc_bulkwrite_t *bw = bson_malloc0 (sizeof (mongoc_bulkwrite_t));
+   mongoc_bulkwrite_t *bw = mongoc_bulkwrite_new ();
    bw->client = self;
+   bw->operation_id = ++self->cluster.operation_id;
+   return bw;
+}
+
+mongoc_bulkwrite_t *
+mongoc_bulkwrite_new (void)
+{
+   mongoc_bulkwrite_t *bw = bson_malloc0 (sizeof (mongoc_bulkwrite_t));
    _mongoc_buffer_init (&bw->ops, NULL, 0, NULL, NULL);
    _mongoc_array_init (&bw->arrayof_modeldata, sizeof (modeldata_t));
-   bw->operation_id = ++self->cluster.operation_id;
    return bw;
 }
 
@@ -1438,6 +1445,26 @@ _bulkwritereturn_apply_result (mongoc_bulkwritereturn_t *self,
    return true;
 }
 
+MONGOC_EXPORT (void)
+mongoc_bulkwrite_set_client (mongoc_bulkwrite_t *self, mongoc_client_t *client)
+{
+   BSON_ASSERT_PARAM (self);
+   BSON_ASSERT_PARAM (client);
+
+   if (self->session) {
+      BSON_ASSERT (self->session->client == client);
+   }
+
+   /* NOP if the client is not changing; otherwise, assign it and increment and
+    * fetch its operation_id. */
+   if (self->client == client) {
+      return;
+   }
+
+   self->client = client;
+   self->operation_id = ++client->cluster.operation_id;
+}
+
 BSON_EXPORT (void)
 mongoc_bulkwrite_set_session (mongoc_bulkwrite_t *self, mongoc_client_session_t *session)
 {
@@ -1471,6 +1498,15 @@ mongoc_bulkwrite_execute (mongoc_bulkwrite_t *self, const mongoc_bulkwriteopts_t
    ret.res = _bulkwriteresult_new ();
    ret.exc = _bulkwriteexception_new ();
 
+   if (!self->client) {
+      bson_set_error (&error,
+                      MONGOC_ERROR_COMMAND,
+                      MONGOC_ERROR_COMMAND_INVALID_ARG,
+                      "bulk write requires a client and one has not been set");
+      _bulkwriteexception_set_error (ret.exc, &error);
+      goto fail;
+   }
+
    if (self->executed) {
       bson_set_error (&error, MONGOC_ERROR_COMMAND, MONGOC_ERROR_COMMAND_INVALID_ARG, "bulk write already executed");
       _bulkwriteexception_set_error (ret.exc, &error);

src/libmongoc/src/mongoc/mongoc-bulkwrite.h

@@ -127,6 +127,7 @@ mongoc_bulkwriteexception_destroy (mongoc_bulkwriteexception_t *self);
 typedef struct _mongoc_bulkwrite_t mongoc_bulkwrite_t;
 MONGOC_EXPORT (mongoc_bulkwrite_t *)
 mongoc_client_bulkwrite_new (mongoc_client_t *self);
+
 typedef struct _mongoc_bulkwrite_insertoneopts_t mongoc_bulkwrite_insertoneopts_t;
 MONGOC_EXPORT (mongoc_bulkwrite_insertoneopts_t *)
 mongoc_bulkwrite_insertoneopts_new (void);
@@ -239,6 +240,13 @@ typedef struct {
    mongoc_bulkwriteexception_t *exc; // NULL if no error.
 } mongoc_bulkwritereturn_t;
 
+// `mongoc_bulkwrite_new` and `mongoc_bulkwrite_set_client` may be used by
+// language bindings that want to assemble a `mongoc_bulkwrite_t` and defer
+// `mongoc_client_t` assignment to execution time.
+MONGOC_EXPORT (mongoc_bulkwrite_t *)
+mongoc_bulkwrite_new (void);
+MONGOC_EXPORT (void)
+mongoc_bulkwrite_set_client (mongoc_bulkwrite_t *self, mongoc_client_t *client);
 // `mongoc_bulkwrite_set_session` sets an optional explicit session.
 // `*session` may be modified when `mongoc_bulkwrite_execute` is called.
 MONGOC_EXPORT (void)

src/libmongoc/tests/test-mongoc-bulkwrite.c

@@ -591,6 +591,43 @@ test_bulkwrite_many_namespaces (void *ctx)
    mongoc_client_destroy (client);
 }
 
+static void
+test_bulkwrite_execute_requires_client (void *ctx)
+{
+   BSON_UNUSED (ctx);
+   bool ok;
+   bson_error_t error;
+
+   mongoc_client_t *client = test_framework_new_default_client ();
+   mongoc_bulkwrite_t *bw = mongoc_bulkwrite_new ();
+   ok = mongoc_bulkwrite_append_insertone (bw, "db.coll", tmp_bson ("{}"), NULL, &error);
+   ASSERT_OR_PRINT (ok, error);
+
+   // Attempt execution without assigning a client
+   {
+      mongoc_bulkwritereturn_t bwr = mongoc_bulkwrite_execute (bw, NULL);
+      ASSERT (bwr.exc);
+      ASSERT (mongoc_bulkwriteexception_error (bwr.exc, &error));
+      ASSERT_ERROR_CONTAINS (error,
+                             MONGOC_ERROR_COMMAND,
+                             MONGOC_ERROR_COMMAND_INVALID_ARG,
+                             "bulk write requires a client and one has not been set");
+      mongoc_bulkwriteexception_destroy (bwr.exc);
+      mongoc_bulkwriteresult_destroy (bwr.res);
+   }
+
+   // Assign a client and execute successfully
+   {
+      mongoc_bulkwrite_set_client (bw, client);
+      mongoc_bulkwritereturn_t bwr = mongoc_bulkwrite_execute (bw, NULL);
+      ASSERT_NO_BULKWRITEEXCEPTION (bwr);
+      mongoc_bulkwriteresult_destroy (bwr.res);
+      mongoc_bulkwriteexception_destroy (bwr.exc);
+   }
+
+   mongoc_bulkwrite_destroy (bw);
+   mongoc_client_destroy (client);
+}
 
 void
 test_bulkwrite_install (TestSuite *suite)
@@ -677,4 +714,12 @@ test_bulkwrite_install (TestSuite *suite)
                       test_framework_skip_if_max_wire_version_less_than_25, // require server 8.0
                       test_framework_skip_if_mongos // Creating 100k collections is very slow (~5 minutes) on mongos.
    );
+
+   TestSuite_AddFull (suite,
+                      "/bulkwrite/execute_requires_client",
+                      test_bulkwrite_execute_requires_client,
+                      NULL /* dtor */,
+                      NULL /* ctx */,
+                      test_framework_skip_if_max_wire_version_less_than_25 // require server 8.0
+   );
 }