Comment option for findAndModify, aggregate, and change streams

Author: jmikola

build/generate-opts.py

@@ -287,6 +287,7 @@ def __init__(self, items, **defaults):
         ('startAtOperationTime', {'type': 'timestamp', 'help': 'A ``Timestamp``. The change stream only provides changes that occurred at or after the specified timestamp. Any command run against the server will return an operation time that can be used here. This option is mutually exclusive with ``resumeAfter`` and ``startAfter``.'}),
         ('maxAwaitTimeMS', {'type': 'int64_t', 'convert': '_mongoc_convert_int64_positive', 'help': 'An ``int64`` representing the maximum amount of time a call to :symbol:`mongoc_change_stream_next` will block waiting for data'}),
         ('fullDocument', {'type': 'utf8', 'help': 'A UTF-8 string. Set this option to "updateLookup" to direct the change stream cursor to lookup the most current majority-committed version of the document associated to an update change stream event.'}),
+        comment_option,
     ], fullDocument="default")),
 
     ('mongoc_create_index_opts_t', Struct([
@@ -338,13 +339,15 @@ def __init__(self, items, **defaults):
         server_option,
         ('batchSize', {'type': 'int32_t', 'help': 'An ``int32`` representing number of documents requested to be returned on each call to :symbol:`mongoc_cursor_next`', 'check_set': True}),
         let_option,
+        comment_option,
     ])),
 
     ('mongoc_find_and_modify_appended_opts_t', Struct([
         write_concern_option,
         session_option,
         hint_option,
         let_option,
+        comment_option,
     ], opts_name='extra'))
 ])
 

src/libmongoc/doc/includes/aggregate-opts.txt

@@ -13,3 +13,4 @@
 * ``serverId``: To target a specific server, include an int32 "serverId" field. Obtain the id by calling :symbol:`mongoc_client_select_server`, then :symbol:`mongoc_server_description_id` on its return value.
 * ``batchSize``: An ``int32`` representing number of documents requested to be returned on each call to :symbol:`mongoc_cursor_next`
 * ``let``: A BSON document consisting of any number of parameter names, each followed by definitions of constants in the MQL Aggregate Expression language.
+* ``comment``: Comment to attach to this command, which will appear in log messages, profiler output, and currentOp output.

src/libmongoc/doc/includes/change-stream-opts.txt

@@ -11,3 +11,4 @@
 * ``startAtOperationTime``: A ``Timestamp``. The change stream only provides changes that occurred at or after the specified timestamp. Any command run against the server will return an operation time that can be used here. This option is mutually exclusive with ``resumeAfter`` and ``startAfter``.
 * ``maxAwaitTimeMS``: An ``int64`` representing the maximum amount of time a call to :symbol:`mongoc_change_stream_next` will block waiting for data
 * ``fullDocument``: A UTF-8 string. Set this option to "updateLookup" to direct the change stream cursor to lookup the most current majority-committed version of the document associated to an update change stream event.
+* ``comment``: Comment to attach to this command, which will appear in log messages, profiler output, and currentOp output.

src/libmongoc/doc/includes/find-and-modify-appended-opts.txt

@@ -9,3 +9,4 @@
 * ``sessionId``: First, construct a :symbol:`mongoc_client_session_t` with :symbol:`mongoc_client_start_session`. You can begin a transaction with :symbol:`mongoc_client_session_start_transaction`, optionally with a :symbol:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :symbol:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :symbol:`mongoc_client_session_t`.
 * ``hint``: A document or string that specifies the index to use to support the query predicate.
 * ``let``: A BSON document consisting of any number of parameter names, each followed by definitions of constants in the MQL Aggregate Expression language.
+* ``comment``: Comment to attach to this command, which will appear in log messages, profiler output, and currentOp output.

src/libmongoc/src/mongoc/mongoc-change-stream.c

@@ -243,6 +243,10 @@ _make_cursor (mongoc_change_stream_t *stream)
    bson_init (&command);
    bson_copy_to (&(stream->opts.extra), &command_opts);
 
+   if (stream->opts.comment.value_type != BSON_TYPE_EOD) {
+      bson_append_value (&command_opts, "comment", 7, &stream->opts.comment);
+   }
+
    if (bson_iter_init_find (&iter, &command_opts, "sessionId")) {
       if (!_mongoc_client_session_from_iter (
              stream->client, &iter, &cs, &stream->err)) {

src/libmongoc/src/mongoc/mongoc-collection.c

@@ -3451,6 +3451,10 @@ mongoc_collection_find_and_modify_with_opts (
       bson_append_document (&parts.extra, "let", 3, &appended_opts.let);
    }
 
+   if (&appended_opts.comment.value_type != BSON_TYPE_EOD) {
+      bson_append_value (&parts.extra, "comment", 7, &appended_opts.comment);
+   }
+
    /* Append any remaining unparsed options set via
     * mongoc_find_and_modify_opts_append to the command part. */
    if (bson_iter_init (&iter, &appended_opts.extra)) {

src/libmongoc/src/mongoc/mongoc-opts-private.h

@@ -145,6 +145,7 @@ typedef struct _mongoc_change_stream_opts_t {
    mongoc_timestamp_t startAtOperationTime;
    int64_t maxAwaitTimeMS;
    const char *fullDocument;
+   bson_value_t comment;
    bson_t extra;
 } mongoc_change_stream_opts_t;
 
@@ -191,6 +192,7 @@ typedef struct _mongoc_aggregate_opts_t {
    int32_t batchSize;
    bool batchSize_is_set;
    bson_t let;
+   bson_value_t comment;
    bson_t extra;
 } mongoc_aggregate_opts_t;
 
@@ -200,6 +202,7 @@ typedef struct _mongoc_find_and_modify_appended_opts_t {
    mongoc_client_session_t *client_session;
    bson_value_t hint;
    bson_t let;
+   bson_value_t comment;
    bson_t extra;
 } mongoc_find_and_modify_appended_opts_t;
 

src/libmongoc/src/mongoc/mongoc-opts.c

@@ -1582,6 +1582,7 @@ _mongoc_change_stream_opts_parse (
    memset (&mongoc_change_stream_opts->startAtOperationTime, 0, sizeof (mongoc_timestamp_t));
    mongoc_change_stream_opts->maxAwaitTimeMS = 0;
    mongoc_change_stream_opts->fullDocument = "default";
+   memset (&mongoc_change_stream_opts->comment, 0, sizeof (bson_value_t));
    bson_init (&mongoc_change_stream_opts->extra);
 
    if (!opts) {
@@ -1651,6 +1652,15 @@ _mongoc_change_stream_opts_parse (
             return false;
          }
       }
+      else if (!strcmp (bson_iter_key (&iter), "comment")) {
+         if (!_mongoc_convert_bson_value_t (
+               client,
+               &iter,
+               &mongoc_change_stream_opts->comment,
+               error)) {
+            return false;
+         }
+      }
       else {
          /* unrecognized values are copied to "extra" */
          if (!BSON_APPEND_VALUE (
@@ -1674,6 +1684,7 @@ _mongoc_change_stream_opts_cleanup (mongoc_change_stream_opts_t *mongoc_change_s
 {
    bson_destroy (&mongoc_change_stream_opts->resumeAfter);
    bson_destroy (&mongoc_change_stream_opts->startAfter);
+   bson_value_destroy (&mongoc_change_stream_opts->comment);
    bson_destroy (&mongoc_change_stream_opts->extra);
 }
 
@@ -2040,6 +2051,7 @@ _mongoc_aggregate_opts_parse (
    mongoc_aggregate_opts->batchSize = 0;
    mongoc_aggregate_opts->batchSize_is_set = false;
    bson_init (&mongoc_aggregate_opts->let);
+   memset (&mongoc_aggregate_opts->comment, 0, sizeof (bson_value_t));
    bson_init (&mongoc_aggregate_opts->extra);
 
    if (!opts) {
@@ -2131,6 +2143,15 @@ _mongoc_aggregate_opts_parse (
             return false;
          }
       }
+      else if (!strcmp (bson_iter_key (&iter), "comment")) {
+         if (!_mongoc_convert_bson_value_t (
+               client,
+               &iter,
+               &mongoc_aggregate_opts->comment,
+               error)) {
+            return false;
+         }
+      }
       else {
          /* unrecognized values are copied to "extra" */
          if (!BSON_APPEND_VALUE (
@@ -2158,6 +2179,7 @@ _mongoc_aggregate_opts_cleanup (mongoc_aggregate_opts_t *mongoc_aggregate_opts)
    }
    bson_destroy (&mongoc_aggregate_opts->collation);
    bson_destroy (&mongoc_aggregate_opts->let);
+   bson_value_destroy (&mongoc_aggregate_opts->comment);
    bson_destroy (&mongoc_aggregate_opts->extra);
 }
 
@@ -2175,6 +2197,7 @@ _mongoc_find_and_modify_appended_opts_parse (
    mongoc_find_and_modify_appended_opts->client_session = NULL;
    memset (&mongoc_find_and_modify_appended_opts->hint, 0, sizeof (bson_value_t));
    bson_init (&mongoc_find_and_modify_appended_opts->let);
+   memset (&mongoc_find_and_modify_appended_opts->comment, 0, sizeof (bson_value_t));
    bson_init (&mongoc_find_and_modify_appended_opts->extra);
 
    if (!opts) {
@@ -2228,6 +2251,15 @@ _mongoc_find_and_modify_appended_opts_parse (
             return false;
          }
       }
+      else if (!strcmp (bson_iter_key (&iter), "comment")) {
+         if (!_mongoc_convert_bson_value_t (
+               client,
+               &iter,
+               &mongoc_find_and_modify_appended_opts->comment,
+               error)) {
+            return false;
+         }
+      }
       else {
          /* unrecognized values are copied to "extra" */
          if (!BSON_APPEND_VALUE (
@@ -2254,5 +2286,6 @@ _mongoc_find_and_modify_appended_opts_cleanup (mongoc_find_and_modify_appended_o
    }
    bson_value_destroy (&mongoc_find_and_modify_appended_opts->hint);
    bson_destroy (&mongoc_find_and_modify_appended_opts->let);
+   bson_value_destroy (&mongoc_find_and_modify_appended_opts->comment);
    bson_destroy (&mongoc_find_and_modify_appended_opts->extra);
 }