CDRIVER-629 remove MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED (#1940)

Author: kevinAlbs

NEWS

@@ -46,6 +46,7 @@ Unreleased (2.0.0)
     * The associated Windows-only option `CYRUS_PLUGIN_PATH_PREFIX` is removed.
 * Support for the deprecated `minPoolSize` URI option is removed along with associated API: `MONGOC_URI_MINPOOLSIZE` and `mongoc_client_pool_min_size`.
 * Support for LibreSSL (the CMake option `ENABLE_SSL=LIBRESSL`) is removed. Associated API is removed (`MONGOC_ENABLE_SSL_LIBRESSL` and  `mongoc_stream_tls_libressl_new`).
+* `MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED` (value -1) is removed. Use `MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED` (value 0) which is handled equivalently. If specified in a URI, replace: `mongodb://host/?w=-1` with `mongodb://host/?w=0`.
 * The deprecated CMake option `ENABLE_AUTOMATIC_INIT_AND_CLEANUP` is removed. See [Initialization and cleanup](https://mongoc.org/libmongoc/1.30.2/init-cleanup.html) for expected use of `mongoc_init()` and `mongoc_cleanup()`.
 
 ### Forwarding headers (`#include <bson.h>` and `#include <mongoc.h>`)

src/libmongoc/doc/mongoc_write_concern_get_w.rst

@@ -24,5 +24,5 @@ Fetches the ``w`` parameter of the write concern.
 Returns
 -------
 
-Returns an integer containing the w value. If wmajority is set, this would be MONGOC_WRITE_CONCERN_W_MAJORITY.
+Returns an integer containing the ``w`` value. If wmajority is set, this would be ``MONGOC_WRITE_CONCERN_W_MAJORITY``.
 

src/libmongoc/doc/mongoc_write_concern_set_w.rst

@@ -15,14 +15,14 @@ Parameters
 ----------
 
 * ``write_concern``: A :symbol:`mongoc_write_concern_t`.
-* ``w``: A positive ``int32_t`` or zero.
+* ``w``: Use ``MONGOC_WRITE_CONCERN_W_DEFAULT``, ``MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED``, ``MONGOC_WRITE_CONCERN_W_MAJORITY``, or a positive integer.
 
 Description
 -----------
 
 Sets the ``w`` value for the write concern. See :symbol:`mongoc_write_concern_t` for more information on this setting.
 
-Unacknowledged writes are not causally consistent. If you execute a write operation with a :symbol:`mongoc_write_concern_t` on which you have called :symbol:`mongoc_write_concern_set_w` with a value of 0, the write does not participate in causal consistency, even when executed with a :symbol:`mongoc_client_session_t`.
+Unacknowledged writes are not causally consistent. If you execute a write operation with a :symbol:`mongoc_write_concern_t` on which you have called :symbol:`mongoc_write_concern_set_w` with a value of ``MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED``, the write does not participate in causal consistency, even when executed with a :symbol:`mongoc_client_session_t`.
 
 Beginning in version 1.9.0, this function can now alter the write concern after
 it has been used in an operation. Previously, using the struct with an operation

src/libmongoc/doc/mongoc_write_concern_t.rst

@@ -37,8 +37,6 @@ n                                           Block until a write has been propaga
 Deprecations
 ------------
 
-The write concern ``MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED`` (value -1) is a deprecated synonym for ``MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED`` (value 0), and will be removed in the next major release.
-
 :symbol:`mongoc_write_concern_set_fsync` is deprecated.
 
 .. only:: html

src/libmongoc/src/mongoc/mongoc-uri.c

@@ -2135,8 +2135,7 @@ _mongoc_uri_build_write_concern (mongoc_uri_t *uri, bson_error_t *error)
                     storeStrRef (w_str),
                     case (
                        // Special W options:
-                       when (anyOf (eq (int32, MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED),
-                                    eq (int32, MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED)),
+                       when (eq (int32, MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED),
                              // These conflict with journalling:
                              if (eval (mongoc_write_concern_get_journal (write_concern)),
                                  then (error ("Journal conflicts with w value"))),

src/libmongoc/src/mongoc/mongoc-write-concern.c

@@ -374,9 +374,8 @@ bool
 mongoc_write_concern_is_acknowledged (const mongoc_write_concern_t *write_concern)
 {
    if (write_concern) {
-      return (((write_concern->w != MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED) &&
-               (write_concern->w != MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED)) ||
-              write_concern->fsync_ == true || mongoc_write_concern_get_journal (write_concern));
+      return (((write_concern->w != MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED)) || write_concern->fsync_ == true ||
+              mongoc_write_concern_get_journal (write_concern));
    }
    return true;
 }
@@ -400,8 +399,7 @@ mongoc_write_concern_is_valid (const mongoc_write_concern_t *write_concern)
 
    /* Journal or fsync should require acknowledgement.  */
    if ((write_concern->fsync_ == true || mongoc_write_concern_get_journal (write_concern)) &&
-       (write_concern->w == MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED ||
-        write_concern->w == MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED)) {
+       (write_concern->w == MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED)) {
       return false;
    }
 
@@ -511,7 +509,7 @@ _mongoc_write_concern_new_from_iter (const bson_iter_t *iter, bson_error_t *erro
       if (BSON_ITER_IS_KEY (&inner, "w")) {
          if (BSON_ITER_HOLDS_INT32 (&inner)) {
             w = bson_iter_int32 (&inner);
-            if (w < MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED) {
+            if (w < MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED) {
                goto fail;
             }
 

src/libmongoc/src/mongoc/mongoc-write-concern.h

@@ -27,7 +27,6 @@ BSON_BEGIN_DECLS
 
 
 #define MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED 0
-#define MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED -1 /* deprecated */
 #define MONGOC_WRITE_CONCERN_W_DEFAULT -2
 #define MONGOC_WRITE_CONCERN_W_MAJORITY -3
 #define MONGOC_WRITE_CONCERN_W_TAG -4

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

@@ -1544,11 +1544,6 @@ test_mongoc_uri_new_with_error (void)
    ASSERT_ERROR_CONTAINS (
       error, MONGOC_ERROR_COMMAND, MONGOC_ERROR_COMMAND_INVALID_ARG, "Journal conflicts with w value [w=0]");
 
-   error = BSON_ERROR_INIT;
-   ASSERT (!mongoc_uri_new_with_error ("mongodb://localhost/db?journal=true&w=-1", &error));
-   ASSERT_ERROR_CONTAINS (
-      error, MONGOC_ERROR_COMMAND, MONGOC_ERROR_COMMAND_INVALID_ARG, "Journal conflicts with w value [w=-1]");
-
    error = BSON_ERROR_INIT;
    ASSERT (!mongoc_uri_new_with_error ("mongodb://localhost/db?w=-5", &error));
    ASSERT_ERROR_CONTAINS (error, MONGOC_ERROR_COMMAND, MONGOC_ERROR_COMMAND_INVALID_ARG, "Unsupported w value [w=-5]");
@@ -2085,8 +2080,8 @@ test_mongoc_uri_write_concern (void)
       },
       {
          .uri = "mongodb://localhost/?" MONGOC_URI_W "=-1",
-         .parses = true,
-         .w = MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED,
+         .parses = false,
+         .log_msg = "Unsupported w value [w=-1]",
       },
       {
          .uri = "mongodb://localhost/?" MONGOC_URI_W "=0",
@@ -2176,12 +2171,6 @@ test_mongoc_uri_write_concern (void)
          .w = MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED,
          .log_msg = "Journal conflicts with w value [" MONGOC_URI_W "=0]",
       },
-      {
-         .uri = "mongodb://localhost/?" MONGOC_URI_W "=-1&" MONGOC_URI_JOURNAL "=true",
-         .parses = false,
-         .w = MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED,
-         .log_msg = "Journal conflicts with w value [" MONGOC_URI_W "=-1]",
-      },
       {0}};
 
    for (int i = 0; tests[i].uri; i++) {

src/libmongoc/tests/test-mongoc-write-concern.c

@@ -196,23 +196,9 @@ test_write_concern_fsync_and_journal_w1_and_validity (void)
    ASSERT (mongoc_write_concern_journal_is_set (write_concern));
    mongoc_write_concern_set_journal (write_concern, false);
 
-   /* w=-1 does not need GLE and is valid */
-   mongoc_write_concern_set_w (write_concern, MONGOC_WRITE_CONCERN_W_ERRORS_IGNORED);
-   ASSERT (!mongoc_write_concern_is_acknowledged (write_concern));
+   /* w=-1 is considered valid (server is expected to error) */
+   mongoc_write_concern_set_w (write_concern, -1);
    ASSERT (mongoc_write_concern_is_valid (write_concern));
-   ASSERT (mongoc_write_concern_journal_is_set (write_concern));
-
-   /* fsync=true needs GLE, but it conflicts with w=-1 */
-   mongoc_write_concern_set_fsync (write_concern, true);
-   ASSERT (mongoc_write_concern_is_acknowledged (write_concern));
-   ASSERT (!mongoc_write_concern_is_valid (write_concern));
-   ASSERT (mongoc_write_concern_journal_is_set (write_concern));
-
-   /* journal=true needs GLE, but it conflicts with w=-1 */
-   mongoc_write_concern_set_fsync (write_concern, false);
-   mongoc_write_concern_set_journal (write_concern, true);
-   ASSERT (mongoc_write_concern_is_acknowledged (write_concern));
-   ASSERT (mongoc_write_concern_journal_is_set (write_concern));
 
    /* fsync=true with w=default needs GLE and is valid */
    mongoc_write_concern_set_journal (write_concern, false);
@@ -311,7 +297,7 @@ test_write_concern_from_iterator (void)
    _test_write_concern_from_iterator ("{'writeConcern': {'w': 1}}", true, false);
    _test_write_concern_from_iterator ("{'writeConcern': {'j': true}}", true, false);
    _test_write_concern_from_iterator ("{'writeConcern': {'j': false}}", true, false);
-   _test_write_concern_from_iterator ("{'writeConcern': {'w': -1}}", true, false);
+   _test_write_concern_from_iterator ("{'writeConcern': {'w': -1}}", false, false);
    _test_write_concern_from_iterator ("{'writeConcern': {'w': -2}}", false, false);
    _test_write_concern_from_iterator ("{'writeConcern': {'w': -3}}", false, false);
    _test_write_concern_from_iterator ("{'writeConcern': {'w': -4}}", false, false);