CDRIVER-5953 remove deprecated write concern API (#1964)

kevinAlbs · web-flow · commit 845e1de22590 · 2025-03-31T11:19:09.000-04:00
* remove `mongoc_write_concern_get_fsync`
* remove `mongoc_write_concern_set_fsync`
diff --git a/NEWS b/NEWS
@@ -108,6 +108,9 @@ Unreleased (2.0.0)
   * `mongoc_uri_get_service` is removed. Use `mongoc_uri_get_srv_hostname` instead.
   * `mongoc_uri_get_read_prefs` is removed. Use `mongoc_uri_get_read_prefs_t` instead.
   * `mongoc_uri_get_ssl` is removed. Use `mongoc_uri_get_tls` instead.
+* Deprecated write concern API is removed:
+  * `mongoc_write_concern_get_fsync` is removed. Use `mongoc_write_concern_get_journal` instead.
+  * `mongoc_write_concern_set_fsync` is removed. Use `mongoc_write_concern_set_journal` instead.
 
 ### Forwarding headers (`#include <bson.h>` and `#include <mongoc.h>`)
 
diff --git a/src/libmongoc/doc/mongoc_write_concern_get_fsync.rst b/src/libmongoc/doc/mongoc_write_concern_get_fsync.rst
diff --git a/src/libmongoc/doc/mongoc_write_concern_set_fsync.rst b/src/libmongoc/doc/mongoc_write_concern_set_fsync.rst
diff --git a/src/libmongoc/doc/mongoc_write_concern_t.rst b/src/libmongoc/doc/mongoc_write_concern_t.rst
@@ -34,11 +34,6 @@ MONGOC_WRITE_CONCERN_W_MAJORITY (majority)  Block until a write has been propaga
 n                                           Block until a write has been propagated to at least ``n`` nodes in the replica set.
 ==========================================  ===============================================================================================================================================================================================================
 
-Deprecations
-------------
-
-:symbol:`mongoc_write_concern_set_fsync` is deprecated.
-
 .. only:: html
 
   Functions
@@ -51,7 +46,6 @@ Deprecations
     mongoc_write_concern_append
     mongoc_write_concern_copy
     mongoc_write_concern_destroy
-    mongoc_write_concern_get_fsync
     mongoc_write_concern_get_journal
     mongoc_write_concern_get_w
     mongoc_write_concern_get_wmajority
@@ -63,7 +57,6 @@ Deprecations
     mongoc_write_concern_is_valid
     mongoc_write_concern_journal_is_set
     mongoc_write_concern_new
-    mongoc_write_concern_set_fsync
     mongoc_write_concern_set_journal
     mongoc_write_concern_set_w
     mongoc_write_concern_set_wmajority
diff --git a/src/libmongoc/src/mongoc/mongoc-write-concern-private.h b/src/libmongoc/src/mongoc/mongoc-write-concern-private.h
@@ -25,12 +25,10 @@
 BSON_BEGIN_DECLS
 
 
-#define MONGOC_WRITE_CONCERN_FSYNC_DEFAULT -1
 #define MONGOC_WRITE_CONCERN_JOURNAL_DEFAULT -1
 
 
 struct _mongoc_write_concern_t {
-   int8_t fsync_; /* deprecated */
    int8_t journal;
    int32_t w;
    int64_t wtimeout;
diff --git a/src/libmongoc/src/mongoc/mongoc-write-concern.c b/src/libmongoc/src/mongoc/mongoc-write-concern.c
@@ -42,7 +42,6 @@ mongoc_write_concern_new (void)
 
    write_concern = BSON_ALIGNED_ALLOC0 (mongoc_write_concern_t);
    write_concern->w = MONGOC_WRITE_CONCERN_W_DEFAULT;
-   write_concern->fsync_ = MONGOC_WRITE_CONCERN_FSYNC_DEFAULT;
    write_concern->journal = MONGOC_WRITE_CONCERN_JOURNAL_DEFAULT;
    write_concern->is_default = true;
 
@@ -59,7 +58,6 @@ mongoc_write_concern_copy (const mongoc_write_concern_t *write_concern)
 
    if (write_concern) {
       ret = mongoc_write_concern_new ();
-      ret->fsync_ = write_concern->fsync_;
       ret->journal = write_concern->journal;
       ret->w = write_concern->w;
       ret->wtimeout = write_concern->wtimeout;
@@ -89,33 +87,6 @@ mongoc_write_concern_destroy (mongoc_write_concern_t *write_concern)
 }
 
 
-bool
-mongoc_write_concern_get_fsync (const mongoc_write_concern_t *write_concern)
-{
-   BSON_ASSERT (write_concern);
-   return (write_concern->fsync_ == true);
-}
-
-
-/**
- * mongoc_write_concern_set_fsync:
- * @write_concern: A mongoc_write_concern_t.
- * @fsync_: If the write concern requires fsync() by the server.
- *
- * Set if fsync() should be called on the server before acknowledging a
- * write request.
- */
-void
-mongoc_write_concern_set_fsync (mongoc_write_concern_t *write_concern, bool fsync_)
-{
-   BSON_ASSERT (write_concern);
-
-   write_concern->fsync_ = !!fsync_;
-   write_concern->is_default = false;
-   write_concern->frozen = false;
-}
-
-
 bool
 mongoc_write_concern_get_journal (const mongoc_write_concern_t *write_concern)
 {
@@ -347,10 +318,6 @@ _mongoc_write_concern_freeze (mongoc_write_concern_t *write_concern)
       BSON_APPEND_INT32 (compiled, "w", write_concern->w);
    }
 
-   if (write_concern->fsync_ != MONGOC_WRITE_CONCERN_FSYNC_DEFAULT) {
-      bson_append_bool (compiled, "fsync", 5, !!write_concern->fsync_);
-   }
-
    if (write_concern->journal != MONGOC_WRITE_CONCERN_JOURNAL_DEFAULT) {
       bson_append_bool (compiled, "j", 1, !!write_concern->journal);
    }
@@ -374,7 +341,7 @@ 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->fsync_ == true ||
+      return (((write_concern->w != MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED)) ||
               mongoc_write_concern_get_journal (write_concern));
    }
    return true;
@@ -397,8 +364,8 @@ mongoc_write_concern_is_valid (const mongoc_write_concern_t *write_concern)
       return false;
    }
 
-   /* Journal or fsync should require acknowledgement.  */
-   if ((write_concern->fsync_ == true || mongoc_write_concern_get_journal (write_concern)) &&
+   /* Journal should require acknowledgement.  */
+   if ((mongoc_write_concern_get_journal (write_concern)) &&
        (write_concern->w == MONGOC_WRITE_CONCERN_W_UNACKNOWLEDGED)) {
       return false;
    }
@@ -527,12 +494,8 @@ _mongoc_write_concern_new_from_iter (const bson_iter_t *iter, bson_error_t *erro
             goto fail;
          }
       } else if (BSON_ITER_IS_KEY (&inner, "fsync")) {
-         if (!BSON_ITER_HOLDS_BOOL (&inner)) {
-            goto fail;
-         }
-         BEGIN_IGNORE_DEPRECATIONS
-         mongoc_write_concern_set_fsync (write_concern, bson_iter_bool (&inner));
-         END_IGNORE_DEPRECATIONS
+         // fsync removed in C driver 2.0.
+         goto fail;
       } else if (BSON_ITER_IS_KEY (&inner, "j")) {
          if (!BSON_ITER_HOLDS_BOOL (&inner)) {
             goto fail;
diff --git a/src/libmongoc/src/mongoc/mongoc-write-concern.h b/src/libmongoc/src/mongoc/mongoc-write-concern.h
@@ -44,12 +44,6 @@ mongoc_write_concern_copy (const mongoc_write_concern_t *write_concern) BSON_GNU
 MONGOC_EXPORT (void)
 mongoc_write_concern_destroy (mongoc_write_concern_t *write_concern);
 
-BSON_DEPRECATED ("The fsync parameter is deprecated")
-MONGOC_EXPORT (bool) mongoc_write_concern_get_fsync (const mongoc_write_concern_t *write_concern);
-
-BSON_DEPRECATED ("The fsync parameter is deprecated")
-MONGOC_EXPORT (void) mongoc_write_concern_set_fsync (mongoc_write_concern_t *write_concern, bool fsync_);
-
 MONGOC_EXPORT (bool)
 mongoc_write_concern_get_journal (const mongoc_write_concern_t *write_concern);
 
diff --git a/src/libmongoc/tests/test-mongoc-cursor.c b/src/libmongoc/tests/test-mongoc-cursor.c
@@ -136,7 +136,6 @@ _test_common_clone_w_concerns (void *ctx)
    mongoc_read_concern_set_level (read_concern, MONGOC_READ_CONCERN_LEVEL_LOCAL);
    write_concern = mongoc_write_concern_new ();
    ASSERT (write_concern);
-   mongoc_write_concern_set_fsync (write_concern, true);
    mongoc_write_concern_set_journal (write_concern, true);
    mongoc_write_concern_set_wmajority (write_concern, 1000);
    cursor->write_concern = write_concern;
@@ -157,7 +156,7 @@ _test_common_clone_w_concerns (void *ctx)
    ASSERT_MATCH (_mongoc_read_concern_get_bson (cloned->read_concern), "{'level': 'local'}");
    bson = _mongoc_write_concern_get_bson (cloned->write_concern);
    ASSERT (bson);
-   ASSERT (bson_iter_init_find (&iter, bson, "fsync") && BSON_ITER_HOLDS_BOOL (&iter) && bson_iter_bool (&iter));
+   ASSERT (!bson_iter_init_find (&iter, bson, "fsync")); // Deprecated "fsync" removed in C driver 2.0.
    ASSERT (bson_iter_init_find (&iter, bson, "j") && BSON_ITER_HOLDS_BOOL (&iter) && bson_iter_bool (&iter));
    ASSERT (bson_iter_init_find (&iter, bson, "w") && BSON_ITER_HOLDS_UTF8 (&iter));
    ASSERT_CMPSTR (bson_iter_utf8 (&iter, NULL), "majority");
diff --git a/src/libmongoc/tests/test-mongoc-write-concern.c b/src/libmongoc/tests/test-mongoc-write-concern.c
