couchbase 3.4.3 → 3.4.5

data/ext/couchbase/core/impl/lookup_in.cxx

@@ -60,6 +60,7 @@ initiate_lookup_in_operation(std::shared_ptr<couchbase::core::cluster> core,
                 std::move(entry.value),
                 entry.original_index,
                 entry.exists,
+                entry.ec,
               });
           }
           return handler(std::move(resp.ctx), lookup_in_result{ resp.cas, std::move(entries), resp.deleted });

data/ext/couchbase/core/impl/lookup_in_all_replicas.cxx

@@ -0,0 +1,178 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-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 "lookup_in_all_replicas.hxx"
+#include "lookup_in_replica.hxx"
+
+#include "core/cluster.hxx"
+#include "core/error_context/key_value.hxx"
+#include "core/operations/document_lookup_in.hxx"
+#include "core/topology/configuration.hxx"
+
+namespace couchbase::core::impl
+{
+
+void
+initiate_lookup_in_all_replicas_operation(std::shared_ptr<cluster> core,
+                                          const std::string& bucket_name,
+                                          const std::string& scope_name,
+                                          const std::string& collection_name,
+                                          std::string document_key,
+                                          const std::vector<subdoc::command>& specs,
+                                          lookup_in_all_replicas_options::built options,
+                                          lookup_in_all_replicas_handler&& handler)
+{
+    return initiate_lookup_in_all_replicas_operation(std::move(core),
+                                                     bucket_name,
+                                                     scope_name,
+                                                     collection_name,
+                                                     std::move(document_key),
+                                                     specs,
+                                                     options.timeout,
+                                                     movable_lookup_in_all_replicas_handler{ std::move(handler) });
+}
+
+void
+initiate_lookup_in_all_replicas_operation(std::shared_ptr<cluster> core,
+                                          const std::string& bucket_name,
+                                          const std::string& scope_name,
+                                          const std::string& collection_name,
+                                          std::string document_key,
+                                          const std::vector<subdoc::command>& specs,
+                                          std::optional<std::chrono::milliseconds> timeout,
+                                          movable_lookup_in_all_replicas_handler&& handler)
+{
+    auto request = std::make_shared<couchbase::core::impl::lookup_in_all_replicas_request>(
+      bucket_name, scope_name, collection_name, std::move(document_key), specs, timeout);
+    core->with_bucket_configuration(
+      bucket_name,
+      [core, r = std::move(request), h = std::move(handler)](std::error_code ec, const core::topology::configuration& config) mutable {
+          if (!config.supports_subdoc_read_replica()) {
+              ec = errc::common::feature_not_available;
+          }
+
+          if (ec) {
+              std::optional<std::string> first_error_path{};
+              std::optional<std::size_t> first_error_index{};
+              return h(
+                make_subdocument_error_context(make_key_value_error_context(ec, r->id()), ec, first_error_path, first_error_index, false),
+                lookup_in_all_replicas_result{});
+          }
+          struct replica_context {
+              replica_context(movable_lookup_in_all_replicas_handler handler, std::uint32_t expected_responses)
+                : handler_(std::move(handler))
+                , expected_responses_(expected_responses)
+              {
+              }
+
+              movable_lookup_in_all_replicas_handler handler_;
+              std::uint32_t expected_responses_;
+              bool done_{ false };
+              std::mutex mutex_{};
+              lookup_in_all_replicas_result result_{};
+          };
+          auto ctx = std::make_shared<replica_context>(std::move(h), config.num_replicas.value_or(0U) + 1U);
+
+          for (std::size_t idx = 1U; idx <= config.num_replicas.value_or(0U); ++idx) {
+              document_id replica_id{ r->id() };
+              replica_id.node_index(idx);
+              core->execute(
+                impl::lookup_in_replica_request{ std::move(replica_id), r->specs(), r->timeout() },
+                [ctx](impl::lookup_in_replica_response&& resp) {
+                    movable_lookup_in_all_replicas_handler local_handler{};
+                    {
+                        std::scoped_lock lock(ctx->mutex_);
+                        if (ctx->done_) {
+                            return;
+                        }
+                        --ctx->expected_responses_;
+                        if (resp.ctx.ec()) {
+                            if (ctx->expected_responses_ > 0) {
+                                // just ignore the response
+                                return;
+                            }
+                        } else {
+                            std::vector<lookup_in_replica_result::entry> entries{};
+                            for (auto& field : resp.fields) {
+                                lookup_in_replica_result::entry lookup_in_entry{};
+                                lookup_in_entry.path = field.path;
+                                lookup_in_entry.value = field.value;
+                                lookup_in_entry.exists = field.exists;
+                                lookup_in_entry.original_index = field.original_index;
+                                lookup_in_entry.ec = field.ec;
+                                entries.emplace_back(lookup_in_entry);
+                            }
+                            ctx->result_.emplace_back(lookup_in_replica_result{ resp.cas, entries, resp.deleted, true /* replica */ });
+                        }
+                        if (ctx->expected_responses_ == 0) {
+                            ctx->done_ = true;
+                            std::swap(local_handler, ctx->handler_);
+                        }
+                    }
+                    if (local_handler) {
+                        if (!ctx->result_.empty()) {
+                            resp.ctx.override_ec({});
+                        }
+                        return local_handler(std::move(resp.ctx), std::move(ctx->result_));
+                    }
+                });
+          }
+
+          core::operations::lookup_in_request active{ document_id{ r->id() } };
+          active.specs = r->specs();
+          active.timeout = r->timeout();
+          core->execute(active, [ctx](core::operations::lookup_in_response&& resp) {
+              movable_lookup_in_all_replicas_handler local_handler{};
+              {
+                  std::scoped_lock lock(ctx->mutex_);
+                  if (ctx->done_) {
+                      return;
+                  }
+                  --ctx->expected_responses_;
+                  if (resp.ctx.ec()) {
+                      if (ctx->expected_responses_ > 0) {
+                          // just ignore the response
+                          return;
+                      }
+                  } else {
+                      std::vector<lookup_in_replica_result::entry> entries{};
+                      for (auto& field : resp.fields) {
+                          lookup_in_replica_result::entry lookup_in_entry{};
+                          lookup_in_entry.path = field.path;
+                          lookup_in_entry.value = field.value;
+                          lookup_in_entry.exists = field.exists;
+                          lookup_in_entry.original_index = field.original_index;
+                          lookup_in_entry.ec = field.ec;
+                          entries.emplace_back(lookup_in_entry);
+                      }
+                      ctx->result_.emplace_back(lookup_in_replica_result{ resp.cas, entries, resp.deleted, false /* active */ });
+                  }
+                  if (ctx->expected_responses_ == 0) {
+                      ctx->done_ = true;
+                      std::swap(local_handler, ctx->handler_);
+                  }
+              }
+              if (local_handler) {
+                  if (!ctx->result_.empty()) {
+                      resp.ctx.override_ec({});
+                  }
+                  return local_handler(std::move(resp.ctx), std::move(ctx->result_));
+              }
+          });
+      });
+}
+} // namespace couchbase::core::impl

data/ext/couchbase/core/impl/lookup_in_all_replicas.hxx

@@ -0,0 +1,80 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-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.
+ */
+
+#pragma once
+
+#include <couchbase/lookup_in_all_replicas_options.hxx>
+#include <couchbase/lookup_in_replica_result.hxx>
+
+#include "core/document_id.hxx"
+#include "core/error_context/key_value.hxx"
+#include "core/utils/movable_function.hxx"
+
+#include <vector>
+
+namespace couchbase::core::impl
+{
+
+class lookup_in_all_replicas_request
+{
+  public:
+    explicit lookup_in_all_replicas_request(std::string bucket_name,
+                                            std::string scope_name,
+                                            std::string collection_name,
+                                            std::string document_key,
+                                            std::vector<couchbase::core::impl::subdoc::command> specs,
+                                            std::optional<std::chrono::milliseconds> timeout)
+      : id_{ std::move(bucket_name), std::move(scope_name), std::move(collection_name), std::move(document_key) }
+      , specs_{ std::move(specs) }
+      , timeout_{ timeout }
+    {
+    }
+
+    [[nodiscard]] const auto& id() const
+    {
+        return id_;
+    }
+
+    [[nodiscard]] const auto& specs() const
+    {
+        return specs_;
+    }
+
+    [[nodiscard]] const auto& timeout() const
+    {
+        return timeout_;
+    }
+
+  private:
+    core::document_id id_;
+    std::vector<couchbase::core::impl::subdoc::command> specs_;
+    std::optional<std::chrono::milliseconds> timeout_{};
+};
+
+using movable_lookup_in_all_replicas_handler =
+  utils::movable_function<void(couchbase::subdocument_error_context, lookup_in_all_replicas_result)>;
+
+void
+initiate_lookup_in_all_replicas_operation(std::shared_ptr<cluster> core,
+                                          const std::string& bucket_name,
+                                          const std::string& scope_name,
+                                          const std::string& collection_name,
+                                          std::string document_key,
+                                          const std::vector<subdoc::command>& specs,
+                                          std::optional<std::chrono::milliseconds> timeout,
+                                          movable_lookup_in_all_replicas_handler&& handler);
+} // namespace couchbase::core::impl

data/ext/couchbase/core/impl/lookup_in_any_replica.cxx

@@ -0,0 +1,169 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-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 "lookup_in_any_replica.hxx"
+#include "lookup_in_replica.hxx"
+
+#include "core/cluster.hxx"
+#include "core/error_context/key_value.hxx"
+#include "core/operations/document_lookup_in.hxx"
+#include "core/topology/configuration.hxx"
+
+namespace couchbase::core::impl
+{
+void
+initiate_lookup_in_any_replica_operation(std::shared_ptr<cluster> core,
+                                         const std::string& bucket_name,
+                                         const std::string& scope_name,
+                                         const std::string& collection_name,
+                                         std::string document_key,
+                                         const std::vector<subdoc::command>& specs,
+                                         lookup_in_any_replica_options::built options,
+                                         lookup_in_any_replica_handler&& handler)
+{
+    return initiate_lookup_in_any_replica_operation(std::move(core),
+                                                    bucket_name,
+                                                    scope_name,
+                                                    collection_name,
+                                                    std::move(document_key),
+                                                    specs,
+                                                    options.timeout,
+                                                    movable_lookup_in_any_replica_handler{ std::move(handler) });
+}
+
+void
+initiate_lookup_in_any_replica_operation(std::shared_ptr<cluster> core,
+                                         const std::string& bucket_name,
+                                         const std::string& scope_name,
+                                         const std::string& collection_name,
+                                         std::string document_key,
+                                         const std::vector<subdoc::command>& specs,
+                                         std::optional<std::chrono::milliseconds> timeout,
+                                         movable_lookup_in_any_replica_handler&& handler)
+{
+    auto request = std::make_shared<couchbase::core::impl::lookup_in_any_replica_request>(
+      bucket_name, scope_name, collection_name, std::move(document_key), specs, timeout);
+    core->with_bucket_configuration(
+      bucket_name,
+      [core, r = std::move(request), h = std::move(handler)](std::error_code ec, const core::topology::configuration& config) mutable {
+          if (!config.supports_subdoc_read_replica()) {
+              ec = errc::common::feature_not_available;
+          }
+          if (r->specs().size() > 16) {
+              ec = errc::common::invalid_argument;
+          }
+          if (ec) {
+              std::optional<std::string> first_error_path{};
+              std::optional<std::size_t> first_error_index{};
+              return h(
+                make_subdocument_error_context(make_key_value_error_context(ec, r->id()), ec, first_error_path, first_error_index, false),
+                lookup_in_replica_result{});
+          }
+          struct replica_context {
+              replica_context(movable_lookup_in_any_replica_handler handler, std::uint32_t expected_responses)
+                : handler_(std::move(handler))
+                , expected_responses_(expected_responses)
+              {
+              }
+
+              movable_lookup_in_any_replica_handler handler_;
+              std::uint32_t expected_responses_;
+              bool done_{ false };
+              std::mutex mutex_{};
+          };
+          auto ctx = std::make_shared<replica_context>(std::move(h), config.num_replicas.value_or(0U) + 1U);
+
+          for (std::size_t idx = 1U; idx <= config.num_replicas.value_or(0U); ++idx) {
+              document_id replica_id{ r->id() };
+              replica_id.node_index(idx);
+              core->execute(impl::lookup_in_replica_request{ std::move(replica_id), r->specs(), r->timeout() },
+                            [ctx](impl::lookup_in_replica_response&& resp) {
+                                movable_lookup_in_any_replica_handler local_handler;
+                                {
+                                    std::scoped_lock lock(ctx->mutex_);
+                                    if (ctx->done_) {
+                                        return;
+                                    }
+                                    --ctx->expected_responses_;
+                                    if (resp.ctx.ec()) {
+                                        if (ctx->expected_responses_ > 0) {
+                                            // just ignore the response
+                                            return;
+                                        }
+                                        // consider document irretrievable and give up
+                                        resp.ctx.override_ec(errc::key_value::document_irretrievable);
+                                    }
+                                    ctx->done_ = true;
+                                    std::swap(local_handler, ctx->handler_);
+                                }
+                                if (local_handler) {
+                                    std::vector<lookup_in_replica_result::entry> entries;
+                                    for (auto& field : resp.fields) {
+                                        lookup_in_replica_result::entry entry{};
+                                        entry.path = field.path;
+                                        entry.original_index = field.original_index;
+                                        entry.exists = field.exists;
+                                        entry.value = field.value;
+                                        entry.ec = field.ec;
+                                        entries.emplace_back(entry);
+                                    }
+                                    return local_handler(std::move(resp.ctx),
+                                                         lookup_in_replica_result{ resp.cas, entries, resp.deleted, true /* replica */ });
+                                }
+                            });
+          }
+
+          core::operations::lookup_in_request active{ document_id{ r->id() } };
+          active.specs = r->specs();
+          active.timeout = r->timeout();
+          core->execute(active, [ctx](core::operations::lookup_in_response&& resp) {
+              movable_lookup_in_any_replica_handler local_handler{};
+              {
+                  std::scoped_lock lock(ctx->mutex_);
+                  if (ctx->done_) {
+                      return;
+                  }
+                  --ctx->expected_responses_;
+                  if (resp.ctx.ec()) {
+                      if (ctx->expected_responses_ > 0) {
+                          // just ignore the response
+                          return;
+                      }
+                      // consider document irretrievable and give up
+                      resp.ctx.override_ec(errc::key_value::document_irretrievable);
+                  }
+                  ctx->done_ = true;
+                  std::swap(local_handler, ctx->handler_);
+              }
+              if (local_handler) {
+                  std::vector<lookup_in_replica_result::entry> entries;
+                  for (auto& field : resp.fields) {
+                      lookup_in_replica_result::entry entry{};
+                      entry.path = field.path;
+                      entry.original_index = field.original_index;
+                      entry.exists = field.exists;
+                      entry.value = field.value;
+                      entry.ec = field.ec;
+                      entries.emplace_back(entry);
+                  }
+                  return local_handler(std::move(resp.ctx),
+                                       lookup_in_replica_result{ resp.cas, entries, resp.deleted, false /* active */ });
+              }
+          });
+      });
+}
+} // namespace couchbase::core::impl

data/ext/couchbase/core/impl/lookup_in_any_replica.hxx

@@ -0,0 +1,75 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-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.
+ */
+
+#pragma once
+
+#include <couchbase/lookup_in_any_replica_options.hxx>
+#include <couchbase/lookup_in_replica_result.hxx>
+
+#include "core/document_id.hxx"
+#include "core/utils/movable_function.hxx"
+
+namespace couchbase::core::impl
+{
+class lookup_in_any_replica_request
+{
+  public:
+    explicit lookup_in_any_replica_request(std::string bucket_name,
+                                           std::string scope_name,
+                                           std::string collection_name,
+                                           std::string document_key,
+                                           std::vector<couchbase::core::impl::subdoc::command> specs,
+                                           std::optional<std::chrono::milliseconds> timeout)
+      : id_{ std::move(bucket_name), std::move(scope_name), std::move(collection_name), std::move(document_key) }
+      , specs_{ std::move(specs) }
+      , timeout_{ timeout }
+    {
+    }
+
+    [[nodiscard]] const auto& id() const
+    {
+        return id_;
+    }
+
+    [[nodiscard]] const auto& specs() const
+    {
+        return specs_;
+    }
+
+    [[nodiscard]] const auto& timeout() const
+    {
+        return timeout_;
+    }
+
+  private:
+    core::document_id id_;
+    std::vector<couchbase::core::impl::subdoc::command> specs_;
+    std::optional<std::chrono::milliseconds> timeout_{};
+};
+
+using movable_lookup_in_any_replica_handler = utils::movable_function<void(couchbase::subdocument_error_context, lookup_in_replica_result)>;
+
+void
+initiate_lookup_in_any_replica_operation(std::shared_ptr<cluster> core,
+                                         const std::string& bucket_name,
+                                         const std::string& scope_name,
+                                         const std::string& collection_name,
+                                         std::string document_key,
+                                         const std::vector<subdoc::command>& specs,
+                                         std::optional<std::chrono::milliseconds> timeout,
+                                         movable_lookup_in_any_replica_handler&& handler);
+} // namespace couchbase::core::impl

data/ext/couchbase/core/impl/lookup_in_replica.cxx

@@ -0,0 +1,104 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-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 "lookup_in_replica.hxx"
+#include "core/impl/subdoc/path_flags.hxx"
+
+#include <couchbase/error_codes.hxx>
+
+namespace couchbase::core::impl
+{
+std::error_code
+lookup_in_replica_request::encode_to(lookup_in_replica_request::encoded_request_type& encoded, mcbp_context&& /* context */)
+{
+    for (std::size_t i = 0; i < specs.size(); ++i) {
+        specs[i].original_index_ = i;
+    }
+    std::stable_sort(specs.begin(), specs.end(), [](const auto& lhs, const auto& rhs) {
+        /* move XATTRs to the beginning of the vector */
+        return core::impl::subdoc::has_xattr_path_flag(lhs.flags_) && !core::impl::subdoc::has_xattr_path_flag(rhs.flags_);
+    });
+
+    encoded.opaque(opaque);
+    encoded.partition(partition);
+    encoded.body().id(id);
+    encoded.body().read_replica(true);
+    encoded.body().specs(specs);
+    return {};
+}
+
+lookup_in_replica_response
+lookup_in_replica_request::make_response(key_value_error_context&& ctx, const encoded_response_type& encoded) const
+{
+
+    bool deleted = false;
+    couchbase::cas cas{};
+    std::vector<lookup_in_replica_response::entry> fields{};
+    std::error_code ec = ctx.ec();
+    std::optional<std::size_t> first_error_index{};
+    std::optional<std::string> first_error_path{};
+
+    if (encoded.status() == key_value_status_code::subdoc_success_deleted ||
+        encoded.status() == key_value_status_code::subdoc_multi_path_failure_deleted) {
+        deleted = true;
+    }
+    if (!ctx.ec()) {
+        fields.resize(specs.size());
+        for (size_t i = 0; i < specs.size(); ++i) {
+            const auto& req_entry = specs[i];
+            fields[i].original_index = req_entry.original_index_;
+            fields[i].path = req_entry.path_;
+            fields[i].opcode = static_cast<protocol::subdoc_opcode>(req_entry.opcode_);
+            fields[i].status = key_value_status_code::success;
+        }
+        for (size_t i = 0; i < encoded.body().fields().size(); ++i) {
+            const auto& res_entry = encoded.body().fields()[i];
+            fields[i].status = res_entry.status;
+            fields[i].ec =
+              protocol::map_status_code(protocol::client_opcode::subdoc_multi_mutation, static_cast<std::uint16_t>(res_entry.status));
+            if (fields[i].opcode == protocol::subdoc_opcode::exists && fields[i].ec == errc::key_value::path_not_found) {
+                fields[i].ec.clear();
+            }
+            if (!fields[i].ec && !ctx.ec()) {
+                ec = fields[i].ec;
+            }
+            if (!first_error_index && !fields[i].ec) {
+                first_error_index = i;
+                first_error_path = fields[i].path;
+            }
+            fields[i].exists =
+              res_entry.status == key_value_status_code::success || res_entry.status == key_value_status_code::subdoc_success_deleted;
+            if (fields[i].opcode == protocol::subdoc_opcode::exists && !fields[i].ec) {
+                fields[i].value = utils::json::generate_binary(fields[i].exists);
+            } else {
+                fields[i].value = utils::to_binary(res_entry.value);
+            }
+        }
+        if (!ec) {
+            cas = encoded.cas();
+        }
+        std::sort(fields.begin(), fields.end(), [](const auto& lhs, const auto& rhs) { return lhs.original_index < rhs.original_index; });
+    }
+
+    return lookup_in_replica_response{
+        make_subdocument_error_context(ctx, ec, first_error_path, first_error_index, deleted),
+        cas,
+        std::move(fields),
+        deleted,
+    };
+}
+} // namespace couchbase::core::impl