RUST-370 Ensuring that the WriteConcernError errInfo object is propagated

Author: Utkarsh Mehta

src/error.rs

@@ -7,7 +7,7 @@ use lazy_static::lazy_static;
 use serde::Deserialize;
 use time::OutOfRangeError;
 
-use crate::options::StreamAddress;
+use crate::{bson::Document, options::StreamAddress};
 
 lazy_static! {
     static ref RECOVERING_CODES: Vec<i32> = vec![11600, 11602, 13436, 189, 91];
@@ -381,6 +381,10 @@ pub struct WriteConcernError {
     /// A description of the error that occurred.
     #[serde(rename = "errmsg")]
     pub message: String,
+
+    /// A document identifying the write concern setting related to the error.
+    #[serde(rename = "errInfo")]
+    pub details: Option<Document>,
 }
 
 /// An error that occurred during a write operation that wasn't due to being unable to satisfy a

src/operation/delete/test.rs

@@ -167,7 +167,14 @@ async fn handle_write_concern_failure() {
         "writeConcernError": {
             "code": 456,
             "codeName": "wcError",
-            "errmsg": "some message"
+            "errmsg": "some message",
+            "errInfo": {
+                "writeConcern": {
+                    "w": 2,
+                    "wtimeout": 0,
+                    "provenance": "clientSupplied"
+                }
+            }
         }
     });
 
@@ -180,6 +187,11 @@ async fn handle_write_concern_failure() {
                 code: 456,
                 code_name: "wcError".to_string(),
                 message: "some message".to_string(),
+                details: Some(doc! { "writeConcern": {
+                    "w": 2,
+                    "wtimeout": 0,
+                    "provenance": "clientSupplied"
+                } }),
             };
             assert_eq!(wc_error, &expected_wc_err);
         }

src/operation/insert/test.rs

@@ -179,7 +179,14 @@ async fn handle_write_failure() {
         "writeConcernError": {
             "code": 123,
             "codeName": "woohoo",
-            "errmsg": "error message"
+            "errmsg": "error message",
+            "errInfo": {
+                "writeConcern": {
+                    "w": 2,
+                    "wtimeout": 0,
+                    "provenance": "clientSupplied"
+                }
+            }
         }
     });
 
@@ -203,6 +210,11 @@ async fn handle_write_failure() {
                 code: 123,
                 code_name: "woohoo".to_string(),
                 message: "error message".to_string(),
+                details: Some(doc! { "writeConcern": {
+                    "w": 2,
+                    "wtimeout": 0,
+                    "provenance": "clientSupplied"
+                } }),
             };
             assert_eq!(write_concern_error, expected_wc_err);
         }

src/operation/update/test.rs

@@ -252,7 +252,14 @@ async fn handle_write_concern_failure() {
         "writeConcernError": {
             "code": 456,
             "codeName": "wcError",
-            "errmsg": "some message"
+            "errmsg": "some message",
+            "errInfo": {
+                "writeConcern": {
+                    "w": 2,
+                    "wtimeout": 0,
+                    "provenance": "clientSupplied"
+                }
+            }
         }
     });
 
@@ -265,6 +272,11 @@ async fn handle_write_concern_failure() {
                 code: 456,
                 code_name: "wcError".to_string(),
                 message: "some message".to_string(),
+                details: Some(doc! { "writeConcern": {
+                    "w": 2,
+                    "wtimeout": 0,
+                    "provenance": "clientSupplied"
+                } }),
             };
             assert_eq!(wc_error, &expected_wc_err);
         }

src/test/coll.rs

@@ -6,7 +6,7 @@ use semver::VersionReq;
 
 use crate::{
     bson::{doc, Bson, Document},
-    error::{ErrorKind, Result},
+    error::{ErrorKind, Result, WriteFailure},
     event::command::CommandStartedEvent,
     options::{
         AggregateOptions,
@@ -25,6 +25,66 @@ use crate::{
     RUNTIME,
 };
 
+#[cfg_attr(feature = "tokio-runtime", tokio::test)]
+#[cfg_attr(feature = "async-std-runtime", async_std::test)]
+#[function_name::named]
+async fn insert_err_details() {
+    let _guard = LOCK.run_exclusively().await;
+
+    let client = TestClient::new().await;
+    let coll = client
+        .init_db_and_coll(function_name!(), function_name!())
+        .await;
+    if client.server_version_lt(4, 0) || !client.is_replica_set() {
+        return;
+    }
+    client
+        .database("admin")
+        .run_command(
+            doc! {
+                "configureFailPoint": "failCommand",
+                "data": {
+                "failCommands": ["insert"],
+                "writeConcernError": {
+                    "code": 100,
+                    "codeName": "UnsatisfiableWriteConcern",
+                    "errmsg": "Not enough data-bearing nodes",
+                    "errInfo": {
+                    "writeConcern": {
+                        "w": 2,
+                        "wtimeout": 0,
+                        "provenance": "clientSupplied"
+                    }
+                    }
+                }
+                },
+                "mode": { "times": 1 }
+            },
+            None,
+        )
+        .await
+        .unwrap();
+
+    let wc_error_result = coll.insert_one(doc! { "test": 1 }, None).await;
+    match *wc_error_result.unwrap_err().kind {
+        ErrorKind::WriteError(WriteFailure::WriteConcernError(ref wc_error)) => {
+            match &wc_error.details {
+                Some(doc) => {
+                    let result = doc.get_document("writeConcern");
+                    match result {
+                        Ok(write_concern_doc) => {
+                            assert_eq!(write_concern_doc.contains_key("provenance"), true);
+                        }
+                        Err(e) => panic!("{:?}", e),
+                    }
+                }
+                None => panic!("expected details field"),
+            }
+        }
+        ref e => panic!("expected write concern error, got {:?}", e),
+    }
+}
+
 #[cfg_attr(feature = "tokio-runtime", tokio::test)]
 #[cfg_attr(feature = "async-std-runtime", async_std::test)]
 #[function_name::named]