CDRIVER-4425 Provide access to raw result if server error occurs

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

@@ -88,6 +88,9 @@ _mongoc_error_is_state_change (bson_error_t *error);
 bool
 _mongoc_error_is_network (const bson_error_t *error);
 
+bool
+_mongoc_error_is_server (const bson_error_t *error);
+
 bool
 _mongoc_error_is_auth (const bson_error_t *error);
 

src/libmongoc/src/mongoc/mongoc-error.c

@@ -59,8 +59,8 @@ mongoc_error_has_label (const bson_t *reply, const char *label)
    return false;
 }
 
-static bool
-_mongoc_error_is_server (bson_error_t *error)
+bool
+_mongoc_error_is_server (const bson_error_t *error)
 {
    if (!error) {
       return false;

src/libmongoc/src/mongoc/mongoc-write-command-private.h

@@ -88,6 +88,9 @@ typedef struct {
     * primary, this contains the server id of the newly selected primary. Only
     * applies to OP_MSG. Is left at 0 if no retry occurs. */
    uint32_t retry_server_id;
+   /* store the raw server response if an error occured */
+   uint32_t n_errorReplies;
+   bson_t rawErrorReplies;
 } mongoc_write_result_t;
 
 

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

@@ -1147,6 +1147,7 @@ _mongoc_write_result_init (mongoc_write_result_t *result) /* IN */
    bson_init (&result->writeConcernErrors);
    bson_init (&result->writeErrors);
    bson_init (&result->errorLabels);
+   bson_init (&result->rawErrorReplies);
 
    EXIT;
 }
@@ -1163,6 +1164,7 @@ _mongoc_write_result_destroy (mongoc_write_result_t *result)
    bson_destroy (&result->writeConcernErrors);
    bson_destroy (&result->writeErrors);
    bson_destroy (&result->errorLabels);
+   bson_destroy (&result->rawErrorReplies);
 
    EXIT;
 }
@@ -1355,6 +1357,22 @@ _mongoc_write_result_merge (mongoc_write_result_t *result,   /* IN */
       result->n_writeConcernErrors++;
    }
 
+   /* If a server error ocurred, then append the raw response to the
+    * error_replies array. */
+   if (!_mongoc_cmd_check_ok (
+          reply, MONGOC_ERROR_API_VERSION_2, NULL /* error */)) {
+      char str[16];
+      const char *key;
+
+      bson_uint32_to_string (result->n_errorReplies, &key, str, sizeof str);
+
+      if (!bson_append_document (&result->rawErrorReplies, key, -1, reply)) {
+         MONGOC_ERROR ("Error adding \"%s\" to errorReplies.\n", key);
+      }
+
+      result->n_errorReplies++;
+   }
+
    /* inefficient if there are ever large numbers: for each label in each err,
     * we linear-search result->errorLabels to see if it's included yet */
    _mongoc_bson_array_copy_labels_to (reply, &result->errorLabels);
@@ -1465,6 +1483,7 @@ _mongoc_write_result_complete (
    /* produce either old fields like nModified from the deprecated Bulk API Spec
     * or new fields like modifiedCount from the CRUD Spec, which we partly obey
     */
+
    if (bson && mongoc_write_concern_is_acknowledged (wc)) {
       n_args = 0;
       va_start (args, error);
@@ -1529,6 +1548,12 @@ _mongoc_write_result_complete (
       }
    }
 
+   /* If there is a raw error response then we know a server error has occurred.
+    * We should add the raw result to the reply. */
+   if (bson && !bson_empty (&result->rawErrorReplies)) {
+      BSON_APPEND_ARRAY (bson, "errorReplies", &result->rawErrorReplies);
+   }
+
    /* set bson_error_t from first write error or write concern error */
    _set_error_from_response (
       &result->writeErrors, domain, "write", &result->error);

src/libmongoc/tests/json/collection-management/modifyCollection-errorResponse.json

@@ -0,0 +1,119 @@
+{
+    "description": "modifyCollection-errorResponse",
+    "schemaVersion": "1.12",
+    "createEntities": [
+      {
+        "client": {
+          "id": "client0",
+          "observeEvents": [
+            "commandStartedEvent"
+          ]
+        }
+      },
+      {
+        "database": {
+          "id": "database0",
+          "client": "client0",
+          "databaseName": "collMod-tests"
+        }
+      },
+      {
+        "collection": {
+          "id": "collection0",
+          "database": "database0",
+          "collectionName": "test"
+        }
+      }
+    ],
+    "initialData": [
+      {
+        "collectionName": "test",
+        "databaseName": "collMod-tests",
+        "documents": [
+          {
+            "_id": 1,
+            "x": 1
+          },
+          {
+            "_id": 2,
+            "x": 1
+          }
+        ]
+      }
+    ],
+    "tests": [
+      {
+        "description": "modifyCollection prepareUnique violations are accessible",
+        "runOnRequirements": [
+          {
+            "minServerVersion": "5.2"
+          }
+        ],
+        "operations": [
+          {
+            "name": "createIndex",
+            "object": "collection0",
+            "arguments": {
+              "keys": {
+                "x": 1
+              }
+            }
+          },
+          {
+            "name": "modifyCollection",
+            "object": "database0",
+            "arguments": {
+              "collection": "test",
+              "index": {
+                "keyPattern": {
+                  "x": 1
+                },
+                "prepareUnique": true
+              }
+            }
+          },
+          {
+            "name": "insertOne",
+            "object": "collection0",
+            "arguments": {
+              "document": {
+                "_id": 3,
+                "x": 1
+              }
+            },
+            "expectError": {
+              "errorCode": 11000
+            }
+          },
+          {
+            "name": "modifyCollection",
+            "object": "database0",
+            "arguments": {
+              "collection": "test",
+              "index": {
+                "keyPattern": {
+                  "x": 1
+                },
+                "unique": true
+              }
+            },
+            "expectError": {
+              "isClientError": false,
+              "errorCode": 359,
+              "errorResponse": {
+                "violations": [
+                  {
+                    "ids": [
+                      1,
+                      2
+                    ]
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    ]
+  }
+

src/libmongoc/tests/json/crud/unified/aggregate-merge-errorResponse.json

@@ -0,0 +1,90 @@
+{
+  "description": "aggregate-merge-errorResponse",
+  "schemaVersion": "1.12",
+  "createEntities": [
+    {
+      "client": {
+        "id": "client0"
+      }
+    },
+    {
+      "database": {
+        "id": "database0",
+        "client": "client0",
+        "databaseName": "crud-tests"
+      }
+    },
+    {
+      "collection": {
+        "id": "collection0",
+        "database": "database0",
+        "collectionName": "test"
+      }
+    }
+  ],
+  "initialData": [
+    {
+      "collectionName": "test",
+      "databaseName": "crud-tests",
+      "documents": [
+        {
+          "_id": 1,
+          "x": 1
+        },
+        {
+          "_id": 2,
+          "x": 1
+        }
+      ]
+    }
+  ],
+  "tests": [
+    {
+      "description": "aggregate $merge DuplicateKey error is accessible",
+      "runOnRequirements": [
+        {
+          "minServerVersion": "5.1",
+          "topologies": [
+            "single",
+            "replicaset"
+          ]
+        }
+      ],
+      "operations": [
+        {
+          "name": "aggregate",
+          "object": "database0",
+          "arguments": {
+            "pipeline": [
+              {
+                "$documents": [
+                  {
+                    "_id": 2,
+                    "x": 1
+                  }
+                ]
+              },
+              {
+                "$merge": {
+                  "into": "test",
+                  "whenMatched": "fail"
+                }
+              }
+            ]
+          },
+          "expectError": {
+            "errorCode": 11000,
+            "errorResponse": {
+              "keyPattern": {
+                "_id": 1
+              },
+              "keyValue": {
+                "_id": 2
+              }
+            }
+          }
+        }
+      ]
+    }
+  ]
+}

src/libmongoc/tests/json/crud/unified/bulkWrite-errorResponse.json

@@ -0,0 +1,89 @@
+{
+    "description": "bulkWrite-errorResponse",
+    "schemaVersion": "1.12",
+    "createEntities": [
+      {
+        "client": {
+          "id": "client0",
+          "useMultipleMongoses": false
+        }
+      },
+      {
+        "database": {
+          "id": "database0",
+          "client": "client0",
+          "databaseName": "crud-tests"
+        }
+      },
+      {
+        "collection": {
+          "id": "collection0",
+          "database": "database0",
+          "collectionName": "test"
+        }
+      }
+    ],
+    "tests": [
+      {
+        "description": "bulkWrite operations support errorResponse assertions",
+        "runOnRequirements": [
+          {
+            "minServerVersion": "4.0.0",
+            "topologies": [
+              "single",
+              "replicaset"
+            ]
+          },
+          {
+            "minServerVersion": "4.2.0",
+            "topologies": [
+              "sharded"
+            ]
+          }
+        ],
+        "operations": [
+          {
+            "name": "failPoint",
+            "object": "testRunner",
+            "arguments": {
+              "client": "client0",
+              "failPoint": {
+                "configureFailPoint": "failCommand",
+                "mode": {
+                  "times": 1
+                },
+                "data": {
+                  "failCommands": [
+                    "insert"
+                  ],
+                  "errorCode": 8
+                }
+              }
+            }
+          },
+          {
+            "name": "bulkWrite",
+            "object": "collection0",
+            "arguments": {
+              "requests": [
+                {
+                  "insertOne": {
+                    "document": {
+                      "_id": 1
+                    }
+                  }
+                }
+              ]
+            },
+            "expectError": {
+              "errorCode": 8,
+              "errorResponse": {
+                "code": 8
+              }
+            }
+          }
+        ]
+      }
+    ]
+  }
+