CXXCBC-645: get_multi_* API for transactions (#761)

Author: avsej

CMakeLists.txt

@@ -217,6 +217,8 @@ set(couchbase_cxx_client_FILES
     core/impl/term_query.cxx
     core/impl/term_range_query.cxx
     core/impl/transaction_error_category.cxx
+    core/impl/transaction_get_multi_replicas_from_preferred_server_group_spec.cxx
+    core/impl/transaction_get_multi_spec.cxx
     core/impl/transaction_get_result.cxx
     core/impl/transaction_op_error_category.cxx
     core/impl/vector_query.cxx
@@ -417,6 +419,7 @@ set(couchbase_cxx_client_FILES
     core/transactions/cleanup_testing_hooks.cxx
     core/transactions/exceptions.cxx
     core/transactions/forward_compat.cxx
+    core/transactions/get_multi_orchestrator.cxx
     core/transactions/internal/doc_record.cxx
     core/transactions/result.cxx
     core/transactions/staged_mutation.cxx

bin/run-unit-tests

@@ -115,7 +115,13 @@ if [ "x${STATUS}" != "x0" ]
 then
     if [ -e /usr/bin/coredumpctl ]
     then
-        /usr/bin/coredumpctl list --no-pager
+        /usr/bin/coredumpctl list --no-pager --json=pretty
+        executable="$(coredumpctl --json=pretty list | jq -r .[-1].exe)"
+        if [ -f "${executable}" ]
+        then
+            file "${executable}"
+            ldd "${executable}"
+        fi
         /usr/bin/coredumpctl -1 info
     elif [ -e /usr/bin/apport-unpack ]
     then
@@ -126,6 +132,11 @@ then
              echo $crash
              /usr/bin/apport-unpack $crash /tmp/the_crash/
              executable=$(cat /tmp/the_crash/ExecutablePath)
+             if [ -f "${executable}" ]
+             then
+                 file "${executable}"
+                 ldd "${executable}"
+             fi
              gdb $executable /tmp/the_crash/CoreDump --batch -ex "thread apply all bt"
              rm -rf $crash /tmp/the_crash
            fi
@@ -138,6 +149,11 @@ then
             echo $core
             executable=$(file $core | ruby -e "print ARGF.read[/execfn: '([^']+)'/, 1]")
             echo $executable
+             if [ -f "${executable}" ]
+             then
+                 file "${executable}"
+                 ldd "${executable}"
+             fi
             gdb $executable $core --batch -ex "thread apply all bt"
             rm -f $core
         fi

core/impl/error.cxx

@@ -35,6 +35,7 @@
 #include "core/error_context/transaction_op_error_context.hxx"
 #include "core/impl/internal_error_context.hxx"
 #include "core/transactions/exceptions.hxx"
+#include "core/transactions/exceptions_fmt.hxx"
 #include "core/transactions/internal/exceptions_internal.hxx"
 
 #include <couchbase/error.hxx>

core/impl/replica_utils.cxx

@@ -29,7 +29,7 @@ effective_nodes(const document_id& id,
                 const read_preference& preference,
                 const std::string& preferred_server_group) -> std::vector<readable_node>
 {
-  if (preference != read_preference::no_preference && preferred_server_group.empty()) {
+  if (preference == read_preference::selected_server_group && preferred_server_group.empty()) {
     CB_LOG_WARNING("Preferred server group is required for zone-aware replica reads");
     return {};
   }

core/impl/transaction_get_multi_replicas_from_preferred_server_group_spec.cxx

@@ -0,0 +1,32 @@
+/*
+ *     Copyright 2021-Present Couchbase, 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 <couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_spec.hxx>
+
+#include <couchbase/collection.hxx>
+
+namespace couchbase::transactions
+{
+transaction_get_multi_replicas_from_preferred_server_group_spec::
+  transaction_get_multi_replicas_from_preferred_server_group_spec(const collection& collection,
+                                                                  std::string id)
+  : bucket_{ collection.bucket_name() }
+  , scope_{ collection.scope_name() }
+  , collection_{ collection.name() }
+  , id_{ std::move(id) }
+{
+}
+} // namespace couchbase::transactions

core/impl/transaction_get_multi_spec.cxx

@@ -0,0 +1,30 @@
+/*
+ *     Copyright 2021-Present Couchbase, 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 <couchbase/transactions/transaction_get_multi_spec.hxx>
+
+#include <couchbase/collection.hxx>
+
+namespace couchbase::transactions
+{
+transaction_get_multi_spec::transaction_get_multi_spec(const collection& collection, std::string id)
+  : bucket_{ collection.bucket_name() }
+  , scope_{ collection.scope_name() }
+  , collection_{ collection.name() }
+  , id_{ std::move(id) }
+{
+}
+} // namespace couchbase::transactions

core/impl/transaction_op_error_category.cxx

@@ -70,6 +70,8 @@ struct transaction_op_error_category : std::error_category {
         return "transaction_already_aborted (1318)";
       case errc::transaction_op::transaction_already_committed:
         return "transaction_already_committed (1319)";
+      case errc::transaction_op::document_unretrievable:
+        return "document_unretrievable (1320)";
       case errc::transaction_op::transaction_op_failed:
         return "transaction_op_failed (1399)";
     }

core/meta/features.hxx

@@ -238,3 +238,8 @@
  * parameters.
  */
 #define COUCHBASE_CXX_CLIENT_QUERY_SUPPORTS_BOTH_POSITIONAL_NAMED_PARAMETERS 1
+
+/**
+ * get_multi API is implemented for transactions
+ */
+#define COUCHBASE_CXX_CLIENT_HAS_TRANSACTIONS_GET_MULTI 1

core/transactions/async_attempt_context.hxx

@@ -15,11 +15,14 @@
  */
 #pragma once
 
-#include "core/error_context/subdocument_error_context.hxx"
 #include "core/operations/document_query.hxx"
-#include "exceptions.hxx"
+#include "transaction_get_multi_mode.hxx"
+#include "transaction_get_multi_replicas_from_preferred_server_group_mode.hxx"
+#include "transaction_get_multi_replicas_from_preferred_server_group_result.hxx"
+#include "transaction_get_multi_result.hxx"
 #include "transaction_get_result.hxx"
 
+// FIXME(SA): remove public API from the core
 #include <couchbase/transactions/transaction_query_options.hxx>
 
 #include <optional>
@@ -42,6 +45,11 @@ public:
   using QueryCallback =
     std::function<void(std::exception_ptr, std::optional<core::operations::query_response>)>;
 
+  async_attempt_context() = default;
+  async_attempt_context(async_attempt_context&&) = default;
+  async_attempt_context(const async_attempt_context&) noexcept = default;
+  auto operator=(async_attempt_context&&) -> async_attempt_context& = default;
+  auto operator=(const async_attempt_context&) noexcept -> async_attempt_context& = default;
   virtual ~async_attempt_context() = default;
 
   /**
@@ -78,6 +86,18 @@ public:
     const core::document_id& id,
     std::function<void(std::exception_ptr, std::optional<transaction_get_result>)>&& cb) = 0;
 
+  virtual void get_multi(
+    const std::vector<core::document_id>& ids,
+    transaction_get_multi_mode mode,
+    std::function<void(std::exception_ptr, std::optional<transaction_get_multi_result>)>&& cb) = 0;
+
+  virtual void get_multi_replicas_from_preferred_server_group(
+    const std::vector<core::document_id>& ids,
+    transaction_get_multi_replicas_from_preferred_server_group_mode mode,
+    std::function<void(
+      std::exception_ptr,
+      std::optional<transaction_get_multi_replicas_from_preferred_server_group_result>)>&& cb) = 0;
+
   /**
    * Mutates the specified document with new content, using the document's last
    * TransactionDocument#cas().

core/transactions/attempt_context.hxx

@@ -15,10 +15,14 @@
  */
 #pragma once
 
+#include "core/operations/document_query.hxx"
+#include "transaction_get_multi_mode.hxx"
+#include "transaction_get_multi_replicas_from_preferred_server_group_mode.hxx"
+#include "transaction_get_multi_replicas_from_preferred_server_group_result.hxx"
+#include "transaction_get_multi_result.hxx"
 #include "transaction_get_result.hxx"
 
-#include "internal/exceptions_internal.hxx"
-
+// TODO(SA): remove public API from core interfaces
 #include <couchbase/transactions/transaction_query_options.hxx>
 
 #include <optional>
@@ -37,7 +41,13 @@ namespace couchbase::core::transactions
 class attempt_context
 {
 public:
+  attempt_context() = default;
+  attempt_context(attempt_context&&) noexcept = default;
+  attempt_context(const attempt_context&) = default;
+  auto operator=(attempt_context&&) noexcept -> attempt_context& = default;
+  auto operator=(const attempt_context&) -> attempt_context& = default;
   virtual ~attempt_context() = default;
+
   /**
    * Gets a document from the specified Couchbase collection matching the
    * specified id.
@@ -80,6 +90,14 @@ public:
   virtual auto get_replica_from_preferred_server_group(const core::document_id& id)
     -> std::optional<transaction_get_result> = 0;
 
+  virtual auto get_multi(const std::vector<core::document_id>& ids, transaction_get_multi_mode mode)
+    -> transaction_get_multi_result = 0;
+
+  virtual auto get_multi_replicas_from_preferred_server_group(
+    const std::vector<core::document_id>& ids,
+    transaction_get_multi_replicas_from_preferred_server_group_mode mode)
+    -> transaction_get_multi_replicas_from_preferred_server_group_result = 0;
+
   /**
    * Mutates the specified document with new content, using the document's last
    * TransactionDocument#cas().
@@ -101,8 +119,8 @@ public:
    * @throws transaction_operation_failed which either should not be caught by
    * the lambda, or rethrown if it is caught.
    */
-  virtual auto replace(const transaction_get_result& document,
-                       codec::encoded_value content) -> transaction_get_result = 0;
+  virtual auto replace(const transaction_get_result& document, codec::encoded_value content)
+    -> transaction_get_result = 0;
 
   /**
    * Inserts a new document into the specified Couchbase collection.
@@ -124,8 +142,8 @@ public:
    * @throws transaction_operation_failed which either should not be caught by
    * the lambda, or rethrown if it is caught.
    */
-  virtual auto insert(const core::document_id& id,
-                      codec::encoded_value content) -> transaction_get_result = 0;
+  virtual auto insert(const core::document_id& id, codec::encoded_value content)
+    -> transaction_get_result = 0;
 
   /**
    * Removes the specified document, using the document's last
@@ -157,7 +175,7 @@ public:
              const couchbase::transactions::transaction_query_options& opts,
              std::optional<std::string> query_context = {}) -> core::operations::query_response
   {
-    return do_core_query(statement, opts, query_context);
+    return do_core_query(statement, opts, std::move(query_context));
   };
 
   /**