CDRIVER-2206 mongoc_read/write_concern_is_default

ajdavis · ajdavis · commit 8fed50154d5d · 2017-07-11T08:55:31.000-04:00
New function mongoc_write_concern_is_default determines if any write
concern options have been set, and mongoc_read_concern_is_default checks
if read concern options are set.
diff --git a/NEWS b/NEWS
@@ -38,6 +38,9 @@ mongo-c-driver 1.7.0
     * Case is now preserved in Unix domain paths.
   * New function mongoc_cursor_error_document provides access to server's error
     reply if a query or command fails.
+  * New function mongoc_write_concern_is_default determines whether any write
+    concern options have been set, and mongoc_read_concern_is_default checks if
+    read concern options are set.
   * mongoc_gridfs_find_one_with_opts optimized to use limit 1.
 
 mongo-c-driver 1.6.0
diff --git a/doc/mongoc_read_concern_is_default.rst b/doc/mongoc_read_concern_is_default.rst
@@ -0,0 +1,22 @@
+:man_page: mongoc_read_concern_is_default
+
+mongoc_read_concern_is_default()
+================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_read_concern_is_default (mongoc_read_concern_t *read_concern);
+
+Parameters
+----------
+
+* ``read_concern``: A pointer to a :symbol:`mongoc_read_concern_t`.
+
+Description
+-----------
+
+Returns true if ``read_concern`` has not been modified from the default. For example, if no "readConcern" option is set in the MongoDB URI and you have not called :symbol:`mongoc_client_set_read_concern()`, then :symbol:`mongoc_read_concern_is_default()` is true for the read concern returned by :symbol:`mongoc_client_get_read_concern()`.
diff --git a/doc/mongoc_read_concern_t.rst b/doc/mongoc_read_concern_t.rst
@@ -48,6 +48,7 @@ See `Read Concern Levels <https://docs.mongodb.com/master/reference/read-concern
     mongoc_read_concern_copy
     mongoc_read_concern_destroy
     mongoc_read_concern_get_level
+    mongoc_read_concern_is_default
     mongoc_read_concern_new
     mongoc_read_concern_set_level
 
diff --git a/doc/mongoc_write_concern_is_default.rst b/doc/mongoc_write_concern_is_default.rst
@@ -0,0 +1,23 @@
+:man_page: mongoc_write_concern_is_default
+
+mongoc_write_concern_is_default()
+=================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  bool
+  mongoc_write_concern_is_default (mongoc_write_concern_t *write_concern);
+
+Parameters
+----------
+
+* ``write_concern``: A pointer to a :symbol:`mongoc_write_concern_t`.
+
+Description
+-----------
+
+Returns true if ``write_concern`` has not been modified from the default. For example, if no "w" option is set in the MongoDB URI and you have not called :symbol:`mongoc_client_set_write_concern()`, then
+:symbol:`mongoc_write_concern_is_default()` is true for the write concern returned by :symbol:`mongoc_client_get_write_concern()`.
diff --git a/doc/mongoc_write_concern_t.rst b/doc/mongoc_write_concern_t.rst
@@ -63,6 +63,7 @@ The write concern ``MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED`` (value -1) is a depr
     mongoc_write_concern_get_wtag
     mongoc_write_concern_get_wtimeout
     mongoc_write_concern_is_acknowledged
+    mongoc_write_concern_is_default
     mongoc_write_concern_is_valid
     mongoc_write_concern_journal_is_set
     mongoc_write_concern_new
diff --git a/src/mongoc/mongoc-client.c b/src/mongoc/mongoc-client.c
@@ -1452,7 +1452,7 @@ _mongoc_client_command_with_opts (mongoc_client_t *client,
       if ((mode & MONGOC_CMD_WRITE) &&
           server_stream->sd->max_wire_version >=
              WIRE_VERSION_CMD_WRITE_CONCERN &&
-          !_mongoc_write_concern_is_default (default_wc) &&
+          !mongoc_write_concern_is_default (default_wc) &&
           (!command_with_opts ||
            !bson_has_field (command_with_opts, "writeConcern"))) {
          _ensure_copied (&command_with_opts, command);
@@ -1465,7 +1465,7 @@ _mongoc_client_command_with_opts (mongoc_client_t *client,
       /* use read prefs and read concern for read commands, unless in opts */
       if ((mode & MONGOC_CMD_READ) &&
           server_stream->sd->max_wire_version >= WIRE_VERSION_READ_CONCERN &&
-          !_mongoc_read_concern_is_default (default_rc) &&
+          !mongoc_read_concern_is_default (default_rc) &&
           (!command_with_opts ||
            !bson_has_field (command_with_opts, "readConcern"))) {
          _ensure_copied (&command_with_opts, command);
diff --git a/src/mongoc/mongoc-cursor.c b/src/mongoc/mongoc-cursor.c
@@ -1304,7 +1304,7 @@ _mongoc_cursor_run_command (mongoc_cursor_t *cursor,
       cursor->read_prefs, server_stream, command, flags, &read_prefs_result);
 
    if (cursor->write_concern &&
-       !_mongoc_write_concern_is_default (cursor->write_concern) &&
+       !mongoc_write_concern_is_default (cursor->write_concern) &&
        server_stream->sd->max_wire_version >= WIRE_VERSION_CMD_WRITE_CONCERN) {
       mongoc_write_concern_append (cursor->write_concern,
                                    read_prefs_result.query_with_read_prefs);
diff --git a/src/mongoc/mongoc-read-concern-private.h b/src/mongoc/mongoc-read-concern-private.h
@@ -35,8 +35,6 @@ struct _mongoc_read_concern_t {
 };
 
 
-bool
-_mongoc_read_concern_is_default (const mongoc_read_concern_t *read_concern);
 const bson_t *
 _mongoc_read_concern_get_bson (mongoc_read_concern_t *read_concern);
 
diff --git a/src/mongoc/mongoc-read-concern.c b/src/mongoc/mongoc-read-concern.c
@@ -152,15 +152,13 @@ mongoc_read_concern_append (mongoc_read_concern_t *read_concern,
 
 
 /**
- * _mongoc_read_concern_is_default:
+ * mongoc_read_concern_is_default:
  * @read_concern: A const mongoc_read_concern_t.
  *
- * This is an internal function.
- *
  * Returns true when read_concern has not been modified.
  */
 bool
-_mongoc_read_concern_is_default (const mongoc_read_concern_t *read_concern)
+mongoc_read_concern_is_default (const mongoc_read_concern_t *read_concern)
 {
    return !read_concern || !read_concern->level;
 }
diff --git a/src/mongoc/mongoc-read-concern.h b/src/mongoc/mongoc-read-concern.h
@@ -48,7 +48,8 @@ mongoc_read_concern_set_level (mongoc_read_concern_t *read_concern,
                                const char *level);
 MONGOC_EXPORT (bool)
 mongoc_read_concern_append (mongoc_read_concern_t *read_concern, bson_t *doc);
-
+MONGOC_EXPORT (bool)
+mongoc_read_concern_is_default (const mongoc_read_concern_t *read_concern);
 
 BSON_END_DECLS
 
diff --git a/src/mongoc/mongoc-uri.c b/src/mongoc/mongoc-uri.c
@@ -747,7 +747,7 @@ mongoc_uri_parse_option (mongoc_uri_t *uri, const char *str)
       }
       mongoc_uri_bson_append_or_replace_key (&uri->credentials, lkey, value);
    } else if (!strcmp (lkey, MONGOC_URI_READCONCERNLEVEL)) {
-      if (!_mongoc_read_concern_is_default (uri->read_concern)) {
+      if (!mongoc_read_concern_is_default (uri->read_concern)) {
          MONGOC_WARNING ("Overwriting previously provided value for '%s'", key);
       }
       mongoc_read_concern_set_level (uri->read_concern, value);
diff --git a/src/mongoc/mongoc-write-concern-private.h b/src/mongoc/mongoc-write-concern-private.h
@@ -53,8 +53,6 @@ _mongoc_write_concern_get_gle (mongoc_write_concern_t *write_concern);
 const bson_t *
 _mongoc_write_concern_get_bson (mongoc_write_concern_t *write_concern);
 bool
-_mongoc_write_concern_is_default (const mongoc_write_concern_t *write_concern);
-bool
 _mongoc_write_concern_validate (const mongoc_write_concern_t *write_concern,
                                 bson_error_t *error);
 bool
diff --git a/src/mongoc/mongoc-write-concern.c b/src/mongoc/mongoc-write-concern.c
@@ -351,16 +351,14 @@ _mongoc_write_concern_get_gle (mongoc_write_concern_t *write_concern)
 
 
 /**
- * _mongoc_write_concern_is_default:
+ * mongoc_write_concern_is_default:
  * @write_concern: A mongoc_write_concern_t.
  *
- * This is an internal function.
- *
  * Returns is_default, which is true when write_concern has not been modified.
  *
  */
 bool
-_mongoc_write_concern_is_default (const mongoc_write_concern_t *write_concern)
+mongoc_write_concern_is_default (const mongoc_write_concern_t *write_concern)
 {
    return !write_concern || write_concern->is_default;
 }
diff --git a/src/mongoc/mongoc-write-concern.h b/src/mongoc/mongoc-write-concern.h
@@ -86,6 +86,8 @@ mongoc_write_concern_is_valid (const mongoc_write_concern_t *write_concern);
 MONGOC_EXPORT (bool)
 mongoc_write_concern_append (mongoc_write_concern_t *write_concern,
                              bson_t *doc);
+MONGOC_EXPORT (bool)
+mongoc_write_concern_is_default (const mongoc_write_concern_t *write_concern);
 
 BSON_END_DECLS
 
diff --git a/tests/test-mongoc-connection-uri.c b/tests/test-mongoc-connection-uri.c
@@ -90,7 +90,7 @@ run_uri_test (const char *uri_string,
       bson_concat (&all, mongoc_uri_get_options (uri));
       bson_concat (&all, mongoc_uri_get_credentials (uri));
       rc = mongoc_uri_get_read_concern (uri);
-      if (!_mongoc_read_concern_is_default (rc)) {
+      if (!mongoc_read_concern_is_default (rc)) {
          BSON_APPEND_UTF8 (
             &all, "readconcernlevel", mongoc_read_concern_get_level (rc));
       }

Original file line number	Diff line number	Diff line change
`@@ -152,15 +152,13 @@ mongoc_read_concern_append (mongoc_read_concern_t *read_concern,`
`152`	`152`
`153`	`153`
`154`	`154`	`/**`
`155`		`- * _mongoc_read_concern_is_default:`
	`155`	`+ * mongoc_read_concern_is_default:`
`156`	`156`	`* @read_concern: A const mongoc_read_concern_t.`
`157`	`157`	`*`
`158`		`- * This is an internal function.`
`159`		`- *`
`160`	`158`	`* Returns true when read_concern has not been modified.`
`161`	`159`	`*/`
`162`	`160`	`bool`
`163`		`-_mongoc_read_concern_is_default (const mongoc_read_concern_t *read_concern)`
	`161`	`+mongoc_read_concern_is_default (const mongoc_read_concern_t *read_concern)`
`164`	`162`	`{`
`165`	`163`	`return !read_concern \|\| !read_concern->level;`
`166`	`164`	`}`