CXX-1399 Implement session (insert_one only)

Author: ajdavis

src/mongocxx/bulk_write.cpp

@@ -1,4 +1,4 @@
-// Copyright 2014 MongoDB Inc.
+// Copyright 2014-present MongoDB Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 #include <mongocxx/private/collection.hh>
 #include <mongocxx/private/libbson.hh>
 #include <mongocxx/private/libmongoc.hh>
+#include <mongocxx/private/session.hh>
 #include <mongocxx/private/write_concern.hh>
 
 #include <mongocxx/config/private/prelude.hh>
@@ -160,7 +161,9 @@ void bulk_write::append(const model::write& operation) {
     }
 }
 
-bulk_write::bulk_write(const collection& coll, const options::bulk_write& options)
+bulk_write::bulk_write(const collection& coll,
+                       const options::bulk_write& options,
+                       const session* session)
     : _created_from_collection{true} {
     bsoncxx::builder::basic::document options_builder;
     if (!options.ordered()) {
@@ -169,6 +172,10 @@ bulk_write::bulk_write(const collection& coll, const options::bulk_write& option
     if (options.write_concern()) {
         options_builder.append(kvp("writeConcern", options.write_concern()->to_document()));
     }
+    if (session) {
+        options_builder.append(
+            bsoncxx::builder::concatenate_doc{session->_get_impl().to_document()});
+    }
 
     scoped_bson_t bson_options(options_builder.extract());
     _impl =

src/mongocxx/bulk_write.hpp

@@ -1,4 +1,4 @@
-// Copyright 2014 MongoDB Inc.
+// Copyright 2014-present MongoDB Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 
 #include <mongocxx/model/write.hpp>
 #include <mongocxx/options/bulk_write.hpp>
+#include <mongocxx/session.hpp>
 
 #include <mongocxx/config/prelude.hpp>
 
@@ -93,7 +94,9 @@ class MONGOCXX_API bulk_write {
 
     class MONGOCXX_PRIVATE impl;
 
-    MONGOCXX_PRIVATE bulk_write(const collection& coll, const options::bulk_write& options);
+    MONGOCXX_PRIVATE bulk_write(const collection& coll,
+                                const options::bulk_write& options,
+                                const session* session = nullptr);
 
     bool _created_from_collection;
     std::unique_ptr<impl> _impl;

src/mongocxx/client.hpp

@@ -1,4 +1,4 @@
-// Copyright 2014 MongoDB Inc.
+// Copyright 2014-present MongoDB Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -232,7 +232,7 @@ class MONGOCXX_API client {
     /// options is misconfigured, or if the session is configured with options that the server does
     /// not support.
     ///
-    session start_session(const options::session& options);
+    session start_session(const options::session& options = {});
 
    private:
     friend class collection;

src/mongocxx/collection.cpp

@@ -1,4 +1,4 @@
-// Copyright 2014 MongoDB Inc.
+// Copyright 2014-present MongoDB Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -54,6 +54,7 @@
 #include <mongocxx/private/pipeline.hh>
 #include <mongocxx/private/read_concern.hh>
 #include <mongocxx/private/read_preference.hh>
+#include <mongocxx/private/session.hh>
 #include <mongocxx/private/write_concern.hh>
 #include <mongocxx/result/bulk_write.hpp>
 #include <mongocxx/result/delete.hpp>
@@ -219,6 +220,15 @@ bulk_write collection::create_bulk_write(const options::bulk_write& options) {
     return writes;
 }
 
+bulk_write collection::create_bulk_write(const session& session,
+                                         const options::bulk_write& options) {
+    class bulk_write writes {
+        *this, options, &session
+    };
+
+    return writes;
+}
+
 stdx::optional<result::bulk_write> collection::bulk_write(const class bulk_write& bulk_write) {
     mongoc_bulk_operation_t* b = bulk_write._impl->operation_t;
 
@@ -440,8 +450,9 @@ cursor collection::aggregate(const pipeline& pipeline, const options::aggregate&
                                                   rp_ptr));
 }
 
-stdx::optional<result::insert_one> collection::insert_one(view_or_value document,
-                                                          const options::insert& options) {
+stdx::optional<result::insert_one> collection::_insert_one(view_or_value document,
+                                                           const options::insert& options,
+                                                           const session* session) {
     // TODO: We should consider making it possible to convert from an options::insert into
     // an options::bulk_write at the type level, removing the need to re-iterate this code
     // many times here and below.
@@ -459,10 +470,12 @@ stdx::optional<result::insert_one> collection::insert_one(view_or_value document
         bulk_opts.bypass_document_validation(*options.bypass_document_validation());
     }
 
-    auto bulk_op = create_bulk_write(bulk_opts);
+    class bulk_write bulk_op {
+        *this, bulk_opts, session
+    };
     bsoncxx::document::element oid{};
-
     bsoncxx::builder::basic::document new_document;
+
     if (!document.view()["_id"]) {
         new_document.append(kvp("_id", bsoncxx::oid()));
         new_document.append(concatenate(document));
@@ -482,6 +495,17 @@ stdx::optional<result::insert_one> collection::insert_one(view_or_value document
         result::insert_one(std::move(result.value()), std::move(oid.get_value())));
 }
 
+stdx::optional<result::insert_one> collection::insert_one(view_or_value document,
+                                                          const options::insert& options) {
+    return _insert_one(document, options);
+}
+
+stdx::optional<result::insert_one> collection::insert_one(view_or_value document,
+                                                          const session& session,
+                                                          const options::insert& options) {
+    return _insert_one(document, options, &session);
+}
+
 stdx::optional<result::replace_one> collection::replace_one(view_or_value filter,
                                                             view_or_value replacement,
                                                             const options::update& options) {

src/mongocxx/collection.hpp

@@ -1,4 +1,4 @@
-// Copyright 2014 MongoDB Inc.
+// Copyright 2014-present MongoDB Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -52,6 +52,7 @@
 #include <mongocxx/result/insert_one.hpp>
 #include <mongocxx/result/replace_one.hpp>
 #include <mongocxx/result/update.hpp>
+#include <mongocxx/session.hpp>
 #include <mongocxx/write_concern.hpp>
 
 #include <mongocxx/config/prelude.hpp>
@@ -144,6 +145,8 @@ class MONGOCXX_API collection {
     cursor aggregate(const pipeline& pipeline,
                      const options::aggregate& options = options::aggregate());
 
+    ///
+    /// @{
     ///
     /// Creates a new bulk operation to be executed against this collection.
     ///
@@ -155,6 +158,23 @@ class MONGOCXX_API collection {
     ///
     class bulk_write create_bulk_write(const options::bulk_write& options = {});
 
+    ///
+    /// Creates a new bulk operation to be executed against this collection.
+    ///
+    /// @param session
+    ///   The mongocxx::session with which to perform the bulk operation.
+    /// @param options
+    ///   Optional arguments; see mongocxx::options::bulk_write.
+    ///
+    /// @return
+    ///    The newly-created bulk write.
+    ///
+    class bulk_write create_bulk_write(const session& session,
+                                       const options::bulk_write& options = {});
+    ///
+    /// @}
+    ///
+
     ///
     /// Sends a write to the server as a bulk write operation.
     ///
@@ -167,7 +187,7 @@ class MONGOCXX_API collection {
     ///   The optional result of the bulk operation execution.
     ///   If the write concern is unacknowledged, the optional will be
     ///   disengaged.
-    //
+    ///
     /// @exception
     ///   mongocxx::bulk_write_exception when there are errors processing
     ///   the writes.
@@ -193,7 +213,7 @@ class MONGOCXX_API collection {
     /// @return The optional result of the bulk operation execution.
     /// If the write concern is unacknowledged, the optional will be
     /// disengaged.
-    //
+    ///
     /// @throws mongocxx::bulk_write_exception when there are errors processing the writes.
     ///
     /// @see mongocxx::bulk_write
@@ -471,6 +491,8 @@ class MONGOCXX_API collection {
         bsoncxx::document::view_or_value update,
         const options::find_one_and_update& options = options::find_one_and_update());
 
+    ///
+    /// @{
     ///
     /// Inserts a single document into the collection. If the document is missing an identifier
     /// (@c _id field) one will be generated for it.
@@ -485,10 +507,30 @@ class MONGOCXX_API collection {
     /// disengaged.
     ///
     /// @throws mongocxx::bulk_write_exception if the operation fails.
+    stdx::optional<result::insert_one> insert_one(bsoncxx::document::view_or_value document,
+                                                  const options::insert& options = {});
+    ///
+    /// Inserts a single document into the collection. If the document is missing an identifier
+    /// (@c _id field) one will be generated for it.
+    ///
+    /// @param document
+    ///   The document to insert.
+    /// @param session
+    ///   The mongocxx::session with which to perform the insert.
+    /// @param options
+    ///   Optional arguments, see options::insert.
+    ///
+    /// @return The optional result of attempting to perform the insert.
+    /// If the write concern is unacknowledged, the optional will be
+    /// disengaged.
+    ///
+    /// @throws mongocxx::bulk_write_exception if the operation fails.
+    stdx::optional<result::insert_one> insert_one(bsoncxx::document::view_or_value document,
+                                                  const session& session,
+                                                  const options::insert& options = {});
+    ///
+    /// @}
     ///
-    stdx::optional<result::insert_one> insert_one(
-        bsoncxx::document::view_or_value document,
-        const options::insert& options = options::insert());
 
     ///
     /// Inserts multiple documents into the collection. If any of the documents are missing
@@ -497,7 +539,7 @@ class MONGOCXX_API collection {
     /// @warning This method uses the bulk insert command to execute the insertion as opposed to
     /// the legacy OP_INSERT wire protocol message. As a result, using this method to insert many
     /// documents on MongoDB < 2.6 will be slow.
-    //
+    ///
     /// @tparam containter_type
     ///   The container type. Must meet the requirements for the container concept with a value
     ///   type of model::write.
@@ -729,6 +771,11 @@ class MONGOCXX_API collection {
 
     MONGOCXX_PRIVATE collection(const database& database, void* collection);
 
+    MONGOCXX_PRIVATE stdx::optional<result::insert_one> _insert_one(
+        bsoncxx::document::view_or_value document,
+        const options::insert& options,
+        const session* session = nullptr);
+
     class MONGOCXX_PRIVATE impl;
 
     MONGOCXX_PRIVATE impl& _get_impl();

src/mongocxx/exception/error_code.cpp

@@ -78,6 +78,10 @@ class error_category final : public std::error_category {
                 return "a GridFS file being operated on was discovered to be corrupted";
             case error_code::k_instance_destroyed:
                 return "the mongocxx instance has been destroyed";
+            case error_code::k_cannot_create_session:
+                return "failed to create a client session";
+            case error_code::k_invalid_session:
+                return "an invalid session was provided";
             default:
                 return "unknown mongocxx error";
         }

src/mongocxx/exception/error_code.hpp

@@ -81,6 +81,12 @@ enum class error_code : std::int32_t {
     /// The mongocxx::instance has been destroyed.
     k_instance_destroyed,
 
+    /// mongocxx::client.create_session failed to create a mongocxx::session.
+    k_cannot_create_session,
+
+    /// A failure attempting to pass a mongocxx::session to a method.
+    k_invalid_session,
+
     // Add new constant string message to error_code.cpp as well!
 };
 

src/mongocxx/private/libmongoc_symbols.hh

@@ -22,6 +22,7 @@ MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_remove_one_with_opts)
 MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_replace_one_with_opts)
 MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_set_bypass_document_validation)
 MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_set_client)
+MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_set_client_session)
 MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_set_collection)
 MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_set_database)
 MONGOCXX_LIBMONGOC_SYMBOL(bulk_operation_set_write_concern)
@@ -42,8 +43,13 @@ MONGOCXX_LIBMONGOC_SYMBOL(client_pool_new)
 MONGOCXX_LIBMONGOC_SYMBOL(client_pool_pop)
 MONGOCXX_LIBMONGOC_SYMBOL(client_pool_push)
 MONGOCXX_LIBMONGOC_SYMBOL(client_pool_try_pop)
+MONGOCXX_LIBMONGOC_SYMBOL(client_session_advance_cluster_time)
+MONGOCXX_LIBMONGOC_SYMBOL(client_session_append)
+MONGOCXX_LIBMONGOC_SYMBOL(client_session_advance_operation_time)
 MONGOCXX_LIBMONGOC_SYMBOL(client_session_destroy)
 MONGOCXX_LIBMONGOC_SYMBOL(client_session_get_lsid)
+MONGOCXX_LIBMONGOC_SYMBOL(client_session_get_cluster_time)
+MONGOCXX_LIBMONGOC_SYMBOL(client_session_get_operation_time)
 MONGOCXX_LIBMONGOC_SYMBOL(client_session_get_opts)
 MONGOCXX_LIBMONGOC_SYMBOL(client_set_read_concern)
 MONGOCXX_LIBMONGOC_SYMBOL(client_set_read_prefs)