CXX-477 include error information in exceptions

Author: amidvidy

src/mongocxx/CMakeLists.txt

@@ -24,6 +24,7 @@ set(mongocxx_sources
     collection.cpp
     cursor.cpp
     database.cpp
+    exception/base.cpp
     instance.cpp
     model/delete_many.cpp
     model/delete_one.cpp

src/mongocxx/collection.cpp

@@ -12,38 +12,40 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#include <mongocxx/collection.hpp>
+
 #include <cstdint>
+#include <utility>
+#include <tuple>
 
 #include <bsoncxx/builder/stream/document.hpp>
 #include <bsoncxx/builder/stream/helpers.hpp>
+#include <bsoncxx/stdx/make_unique.hpp>
+#include <bsoncxx/stdx/optional.hpp>
 #include <bsoncxx/types.hpp>
 
-#include <mongocxx/private/client.hpp>
-#include <mongocxx/private/collection.hpp>
-#include <mongocxx/private/database.hpp>
-#include <mongocxx/private/pipeline.hpp>
-#include <mongocxx/private/bulk_write.hpp>
-#include <mongocxx/private/read_preference.hpp>
-#include <mongocxx/private/write_concern.hpp>
-#include <mongocxx/write_concern.hpp>
-#include <mongocxx/collection.hpp>
 #include <mongocxx/client.hpp>
 #include <mongocxx/exception/bulk_write.hpp>
 #include <mongocxx/exception/operation.hpp>
+#include <mongocxx/exception/query.hpp>
 #include <mongocxx/exception/write.hpp>
 #include <mongocxx/model/write.hpp>
+#include <mongocxx/private/bulk_write.hpp>
+#include <mongocxx/private/client.hpp>
+#include <mongocxx/private/collection.hpp>
+#include <mongocxx/private/database.hpp>
 #include <mongocxx/private/libbson.hpp>
 #include <mongocxx/private/libmongoc.hpp>
+#include <mongocxx/private/pipeline.hpp>
+#include <mongocxx/private/read_preference.hpp>
+#include <mongocxx/private/write_concern.hpp>
 #include <mongocxx/result/bulk_write.hpp>
 #include <mongocxx/result/delete.hpp>
 #include <mongocxx/result/insert_many.hpp>
 #include <mongocxx/result/insert_one.hpp>
 #include <mongocxx/result/replace_one.hpp>
 #include <mongocxx/result/update.hpp>
-
-#include <bsoncxx/stdx/optional.hpp>
-#include <bsoncxx/stdx/make_unique.hpp>
-
+#include <mongocxx/write_concern.hpp>
 
 namespace {
 enum class cursor_flag : uint32_t {
@@ -89,7 +91,7 @@ bsoncxx::stdx::optional<result::bulk_write> collection::bulk_write(
     bson_error_t error;
 
     if (!libmongoc::bulk_operation_execute(b, reply.bson(), &error)) {
-        throw exception::bulk_write();
+        throw exception::bulk_write(reply.steal(), std::make_tuple(error.message, error.code));
     }
 
     result::bulk_write result(reply.steal());
@@ -326,7 +328,7 @@ bsoncxx::stdx::optional<bsoncxx::document::value> collection::find_one_and_repla
         rd == options::return_document::k_after, reply.bson(), &error);
 
     if (!r) {
-        throw exception::operation();
+        throw exception::write(std::move(_impl->gle()), std::make_tuple(error.message, error.code));
     }
 
     bsoncxx::document::view result = reply.view();
@@ -361,7 +363,7 @@ bsoncxx::stdx::optional<bsoncxx::document::value> collection::find_one_and_updat
         rd == options::return_document::k_after, reply.bson(), &error);
 
     if (!r) {
-        throw exception::operation();
+        throw exception::write(std::move(_impl->gle()), std::make_tuple(error.message, error.code));
     }
 
     bsoncxx::document::view result = reply.view();
@@ -390,7 +392,7 @@ bsoncxx::stdx::optional<bsoncxx::document::value> collection::find_one_and_delet
         true, false, false, reply.bson(), &error);
 
     if (!r) {
-        throw exception::operation();
+        throw exception::write(std::move(_impl->gle()), std::make_tuple(error.message, error.code));
     }
 
     bsoncxx::document::view result = reply.view();
@@ -418,7 +420,7 @@ std::int64_t collection::count(bsoncxx::document::view filter, const options::co
         options.skip().value_or(0), options.limit().value_or(0), rp_ptr, &error);
 
     if (result < 0) {
-        throw exception::operation();
+        throw exception::query(std::make_tuple(error.message, error.code));
     }
 
     return result;
@@ -433,7 +435,7 @@ bsoncxx::document::value collection::create_index(bsoncxx::document::view keys,
         libmongoc::collection_create_index(_impl->collection_t, bson_keys.bson(), nullptr, &error);
 
     if (!result) {
-        throw exception::operation();
+        throw exception::operation(std::make_tuple(error.message, error.code));
     }
 
     // TODO: return the response from the server, this is not possible now due to the way
@@ -474,7 +476,7 @@ void collection::drop() {
     auto result = libmongoc::collection_drop(_impl->collection_t, &error);
 
     if (!result) {
-        throw exception::operation();
+        throw exception::operation(std::make_tuple(error.message, error.code));
     }
 }
 

src/mongocxx/collection.hpp

@@ -99,7 +99,9 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see mongocxx::options::aggregate.
     ///
     /// @return A mongocxx::cursor with the results.
-    /// @throws exception::operation if the aggregation fails.
+    /// @throws
+    ///   If the operation failed, the returned cursor will throw an exception::query
+    ///   when it is iterated.
     ///
     /// @see http://docs.mongodb.org/manual/reference/command/aggregate/
     ///
@@ -184,7 +186,7 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see mongocxx::options::count.
     ///
     /// @return The count of the documents that matched the filter.
-    /// @throws exception::operation if the count operation fails.
+    /// @throws exception::query if the count operation fails.
     ///
     /// @see http://docs.mongodb.org/manual/reference/command/count/
     ///
@@ -258,7 +260,9 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see options::distinct.
     ///
     /// @return Cursor having the distinct values for the specified field, a driver::cursor.
-    /// @throws operation_exception if the distinct operation fails.
+    /// @throws
+    ///   If the operation failed, the returned cursor will throw exception::query
+    ///   when it is iterated.
     ///
     /// @see http://docs.mongodb.org/manual/reference/command/distinct/
     ///
@@ -286,7 +290,9 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see options::find
     ///
     /// @return Cursor with the matching documents from the collection, a driver::cursor.
-    /// @throws exception::operation when the operation fails.
+    /// @throws
+    ///   If the find failed, the returned cursor will throw exception::query when it
+    ///   is iterated.
     ///
     /// @see http://docs.mongodb.org/manual/core/read-operations-introduction/
     ///
@@ -305,7 +311,7 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see options::find
     ///
     /// @return An optional document that matched the filter.
-    /// @throws exception::operation if the operation fails.
+    /// @throws exception::query if the operation fails.
     ///
     /// @see http://docs.mongodb.org/manual/core/read-operations-introduction/
     ///
@@ -323,7 +329,7 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see options::find_one_and_delete
     ///
     /// @return The document that was deleted.
-    /// @throws exception::operation if the operation fails.
+    /// @throws exception::write if the operation fails.
     ///
     bsoncxx::stdx::optional<bsoncxx::document::value> find_one_and_delete(
         bsoncxx::document::view filter,
@@ -342,7 +348,7 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see options::find_one_and_replace.
     ///
     /// @return The original or replaced document.
-    /// @throws exception::operation if the operation fails.
+    /// @throws exception::write if the operation fails.
     ///
     bsoncxx::stdx::optional<bsoncxx::document::value> find_one_and_replace(
         bsoncxx::document::view filter,
@@ -362,7 +368,7 @@ class MONGOCXX_API collection {
     ///   Optional arguments, see options::find_one_and_update.
     ///
     /// @return The original or updated document.
-    /// @throws exception::operation when the operation fails.
+    /// @throws exception::write when the operation fails.
     ///
     bsoncxx::stdx::optional<bsoncxx::document::value> find_one_and_update(
         bsoncxx::document::view filter,

src/mongocxx/cursor.cpp

@@ -14,12 +14,14 @@
 
 #include <cstdint>
 #include <memory>
+#include <string>
+#include <tuple>
 
 #include <bson.h>
 
 #include <mongocxx/cursor.hpp>
 
-#include <mongocxx/exception/operation.hpp>
+#include <mongocxx/exception/query.hpp>
 #include <mongocxx/private/cursor.hpp>
 #include <mongocxx/private/libmongoc.hpp>
 
@@ -47,8 +49,7 @@ cursor::iterator& cursor::iterator::operator++() {
     if (libmongoc::cursor_next(_cursor->_impl->cursor_t, &out)) {
         _doc = bsoncxx::document::view(bson_get_data(out), out->len);
     } else if (libmongoc::cursor_error(_cursor->_impl->cursor_t, &error)) {
-        // TODO: put cursor error message in here.
-        throw exception::operation();
+        throw exception::query(std::make_tuple(error.message, error.code));
     } else {
         _cursor = nullptr;
     };

src/mongocxx/database.cpp

@@ -14,6 +14,10 @@
 
 #include <mongocxx/database.hpp>
 
+#include <utility>
+
+#include <bsoncxx/stdx/make_unique.hpp>
+
 #include <mongocxx/client.hpp>
 #include <mongocxx/exception/operation.hpp>
 #include <mongocxx/private/database.hpp>
@@ -22,8 +26,6 @@
 #include <mongocxx/private/libbson.hpp>
 #include <mongocxx/private/libmongoc.hpp>
 
-#include <bsoncxx/stdx/make_unique.hpp>
-
 namespace mongocxx {
 MONGOCXX_INLINE_NAMESPACE_BEGIN
 
@@ -60,7 +62,7 @@ bsoncxx::document::value database::command(bsoncxx::document::view command) {
     );
 
     if (!result)
-        throw exception::operation();
+        throw exception::operation(std::move(reply_bson.steal()));
 
     return reply_bson.steal();
 }

src/mongocxx/exception/authentication.hpp

@@ -22,7 +22,10 @@ namespace mongocxx {
 MONGOCXX_INLINE_NAMESPACE_BEGIN
 namespace exception {
 
-class MONGOCXX_API authentication : public operation {};
+class MONGOCXX_API authentication : public base {
+   public:
+    using base::base;
+};
 
 }  // namespace exception
 MONGOCXX_INLINE_NAMESPACE_END

src/mongocxx/exception/base.cpp

@@ -0,0 +1,55 @@
+// Copyright 2015 MongoDB Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <mongocxx/exception/base.hpp>
+
+#include <utility>
+
+namespace mongocxx {
+MONGOCXX_INLINE_NAMESPACE_BEGIN
+namespace exception {
+
+base::base(bsoncxx::document::value raw_server_error)
+    : _raw_server_error(std::move(raw_server_error))
+{}
+
+base::base(error_and_code_type error_and_code)
+    : _error_and_code(std::move(error_and_code))
+{}
+
+base::base(bsoncxx::document::value raw_server_error,
+           error_and_code_type error_and_code)
+    : _raw_server_error(std::move(raw_server_error))
+    , _error_and_code(std::move(error_and_code))
+{}
+
+const stdx::optional<bsoncxx::document::value>& base::raw_server_error() const {
+    return _raw_server_error;
+}
+
+stdx::optional<bsoncxx::document::value>& base::raw_server_error() {
+    return _raw_server_error;
+}
+
+const stdx::optional<error_and_code_type>& base::error_and_code() const {
+    return _error_and_code;
+}
+
+stdx::optional<error_and_code_type>& base::error_and_code() {
+    return _error_and_code;
+}
+
+}  // namespace exception
+MONGOCXX_INLINE_NAMESPACE_END
+}  // namespace mongocxx

src/mongocxx/exception/base.hpp

@@ -16,13 +16,48 @@
 
 #include <mongocxx/config/prelude.hpp>
 
+#include <cstdint>
 #include <exception>
+#include <tuple>
+
+#include <bsoncxx/document/value.hpp>
+#include <bsoncxx/document/view.hpp>
+#include <bsoncxx/stdx/optional.hpp>
+
+#include <mongocxx/stdx.hpp>
 
 namespace mongocxx {
 MONGOCXX_INLINE_NAMESPACE_BEGIN
 namespace exception {
 
-class MONGOCXX_API base : public std::exception {};
+using error_and_code_type = std::tuple<std::string, std::int32_t>;
+
+class MONGOCXX_API base : virtual public std::exception {
+   public:
+    base(bsoncxx::document::value raw_server_error);
+    base(error_and_code_type error_and_code);
+
+    base(
+      bsoncxx::document::value raw_server_error,
+      error_and_code_type error_and_code
+    );
+
+    ///
+    /// @returns The raw server error, if it is available.
+    ///
+    const stdx::optional<bsoncxx::document::value>& raw_server_error() const;
+    stdx::optional<bsoncxx::document::value>& raw_server_error();
+
+    ///
+    /// @returns The error message and code, if it is available.
+    ///
+    const stdx::optional<error_and_code_type>& error_and_code() const;
+    stdx::optional<error_and_code_type>& error_and_code();
+
+   private:
+    stdx::optional<bsoncxx::document::value> _raw_server_error{};
+    stdx::optional<error_and_code_type> _error_and_code{};
+};
 
 }  // namespace exception
 MONGOCXX_INLINE_NAMESPACE_END

src/mongocxx/exception/bulk_write.hpp

@@ -16,13 +16,18 @@
 
 #include <mongocxx/config/prelude.hpp>
 
-#include <mongocxx/exception/write.hpp>
+#include <bsoncxx/document/value.hpp>
+
+#include <mongocxx/exception/operation.hpp>
 
 namespace mongocxx {
 MONGOCXX_INLINE_NAMESPACE_BEGIN
 namespace exception {
 
-class MONGOCXX_API bulk_write : public write {};
+class MONGOCXX_API bulk_write : public operation {
+   public:
+    using operation::operation;
+};
 
 }  // namespace exception
 MONGOCXX_INLINE_NAMESPACE_END