CXX-1712 overload to_json to handle bson arrays (#976)

Author: joshbsiegel

.mci.yml

@@ -7,12 +7,12 @@
 #######################################
 variables:
 
-    mongoc_version_default: &mongoc_version_default "98995b5d9e31768ae02be265e3debe43ec35cff8" # TODO: update to 1.24.0 once released.
+    mongoc_version_default: &mongoc_version_default "a41683b76fce42f841318d5bb8d926154f9438c8" # TODO: update to 1.24.0 once released.
 
     # If updating mongoc_version_minimum, also update:
     # - the default value of --c-driver-build-ref in etc/make_release.py
     # - LIBMONGOC_REQUIRED_VERSION in src/mongocxx/CMakeLists.txt
-    mongoc_version_minimum: &mongoc_version_minimum "98995b5d9e31768ae02be265e3debe43ec35cff8" # TODO: update to 1.24.0 once released.
+    mongoc_version_minimum: &mongoc_version_minimum "a41683b76fce42f841318d5bb8d926154f9438c8" # TODO: update to 1.24.0 once released.
 
     mongodb_version:
         version_latest: &version_latest "latest"

etc/make_release.py

@@ -84,7 +84,7 @@
               show_default=True,
               help='The remote reference which points to the mongodb/mongo-cxx-driver repo')
 @click.option('--c-driver-build-ref',
-              default='98995b5d9e31768ae02be265e3debe43ec35cff8',
+              default='a41683b76fce42f841318d5bb8d926154f9438c8',
               show_default=True,
               help='When building the C driver, build at this Git reference')
 @click.option('--with-c-driver',

src/bsoncxx/json.cpp

@@ -69,6 +69,21 @@ std::string BSONCXX_CALL to_json(document::view view, ExtendedJsonMode mode) {
     BSONCXX_UNREACHABLE;
 }
 
+std::string BSONCXX_CALL to_json(array::view view, ExtendedJsonMode mode) {
+    switch (mode) {
+        case ExtendedJsonMode::k_legacy:
+            return to_json_helper(view, bson_array_as_json);
+
+        case ExtendedJsonMode::k_relaxed:
+            return to_json_helper(view, bson_array_as_relaxed_extended_json);
+
+        case ExtendedJsonMode::k_canonical:
+            return to_json_helper(view, bson_array_as_canonical_extended_json);
+    }
+
+    BSONCXX_UNREACHABLE;
+}
+
 document::value BSONCXX_CALL from_json(stdx::string_view json) {
     bson_error_t error;
     bson_t* result = bson_new_from_json(reinterpret_cast<const uint8_t*>(json.data()),

src/bsoncxx/json.hpp

@@ -16,6 +16,7 @@
 
 #include <string>
 
+#include <bsoncxx/array/view.hpp>
 #include <bsoncxx/document/value.hpp>
 #include <bsoncxx/document/view.hpp>
 #include <bsoncxx/stdx/optional.hpp>
@@ -56,6 +57,9 @@ enum class ExtendedJsonMode : std::uint8_t {
 BSONCXX_API std::string BSONCXX_CALL to_json(document::view view,
                                              ExtendedJsonMode mode = ExtendedJsonMode::k_legacy);
 
+BSONCXX_API std::string BSONCXX_CALL to_json(array::view view,
+                                             ExtendedJsonMode mode = ExtendedJsonMode::k_legacy);
+
 ///
 /// Constructs a new document::value from the provided JSON text.
 ///

src/bsoncxx/test/json.cpp

@@ -116,6 +116,62 @@ TEST_CASE("CXX-1246: Canonical Extended JSON") {
         R"({ "number" : { "$numberInt" : "42" }, "bin" : { "$binary" : { "base64" : "ZGVhZGJlZWY=", "subType" : "04" } } })");
 }
 
+TEST_CASE("CXX-1712: Overloaded to_json Legacy (Implicit)") {
+    using namespace bsoncxx;
+    using namespace builder::basic;
+
+    types::b_binary bin_val{
+        binary_sub_type::k_uuid, 8, reinterpret_cast<const uint8_t*>("deadbeef")};
+    auto arr = make_array(make_document(kvp("foo", 42), kvp("bar", "A"), kvp("baz", bin_val)));
+    auto output = bsoncxx::to_json(arr.view());
+
+    REQUIRE(
+        output ==
+        R"([ { "foo" : 42, "bar" : "A", "baz" : { "$binary" : "ZGVhZGJlZWY=", "$type" : "04" } } ])");
+}
+
+TEST_CASE("CXX-1712: Overloaded to_json Legacy (Explicit)") {
+    using namespace bsoncxx;
+    using namespace builder::basic;
+
+    types::b_binary bin_val{
+        binary_sub_type::k_uuid, 8, reinterpret_cast<const uint8_t*>("deadbeef")};
+    auto arr = make_array(make_document(kvp("foo", 42), kvp("bar", "A"), kvp("baz", bin_val)));
+    auto output = to_json(arr.view(), ExtendedJsonMode::k_legacy);
+
+    REQUIRE(
+        output ==
+        R"([ { "foo" : 42, "bar" : "A", "baz" : { "$binary" : "ZGVhZGJlZWY=", "$type" : "04" } } ])");
+}
+
+TEST_CASE("CXX-1712: Overloaded to_json Relaxed") {
+    using namespace bsoncxx;
+    using namespace builder::basic;
+
+    types::b_binary bin_val{
+        binary_sub_type::k_uuid, 8, reinterpret_cast<const uint8_t*>("deadbeef")};
+    auto arr = make_array(make_document(kvp("foo", 42), kvp("bar", "A"), kvp("baz", bin_val)));
+    auto output = to_json(arr.view(), ExtendedJsonMode::k_relaxed);
+
+    REQUIRE(
+        output ==
+        R"([ { "foo" : 42, "bar" : "A", "baz" : { "$binary" : { "base64" : "ZGVhZGJlZWY=", "subType" : "04" } } } ])");
+}
+
+TEST_CASE("CXX-1712: Overloaded to_json Canonical") {
+    using namespace bsoncxx;
+    using namespace builder::basic;
+
+    types::b_binary bin_val{
+        binary_sub_type::k_uuid, 8, reinterpret_cast<const uint8_t*>("deadbeef")};
+    auto arr = make_array(make_document(kvp("foo", 42), kvp("bar", "A"), kvp("baz", bin_val)));
+    auto output = to_json(arr.view(), ExtendedJsonMode::k_canonical);
+
+    REQUIRE(
+        output ==
+        R"([ { "foo" : { "$numberInt" : "42" }, "bar" : "A", "baz" : { "$binary" : { "base64" : "ZGVhZGJlZWY=", "subType" : "04" } } } ])");
+}
+
 TEST_CASE("UDL _bson works like from_json()") {
     using namespace bsoncxx;