couchbase 4.2.6 → 4.2.7

package/deps/couchbase-cxx-client/core/protocol/cmd_lookup_in_replica.hxx

@@ -0,0 +1,137 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-2021 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 "client_opcode.hxx"
+#include "cmd_info.hxx"
+#include "core/document_id.hxx"
+#include "core/impl/subdoc/command.hxx"
+#include "core/io/mcbp_message.hxx"
+#include "status.hxx"
+
+#include <gsl/assert>
+
+namespace couchbase::core::protocol
+{
+
+class lookup_in_replica_response_body
+{
+  public:
+    static const inline client_opcode opcode = client_opcode::subdoc_multi_lookup;
+
+    struct lookup_in_field {
+        key_value_status_code status{};
+        std::string value;
+    };
+
+  private:
+    std::vector<lookup_in_field> fields_{};
+
+  public:
+    [[nodiscard]] const std::vector<lookup_in_field>& fields() const
+    {
+        return fields_;
+    }
+
+    [[nodiscard]] bool parse(key_value_status_code status,
+                             const header_buffer& header,
+                             std::uint8_t framing_extras_size,
+                             std::uint16_t key_size,
+                             std::uint8_t extras_size,
+                             const std::vector<std::byte>& body,
+                             const cmd_info& info);
+};
+
+class lookup_in_replica_request_body
+{
+  public:
+    using response_body_type = lookup_in_replica_response_body;
+    static const inline client_opcode opcode = client_opcode::subdoc_multi_lookup;
+
+    /**
+     * Tells the server to operate on replica vbucket instead of active
+     */
+    static const inline std::uint8_t doc_flag_replica_read = 0b0010'0000;
+
+  private:
+    std::vector<std::byte> key_;
+    std::vector<std::byte> extras_{};
+    std::vector<std::byte> value_{};
+
+    std::uint8_t flags_{ 0 };
+    std::vector<couchbase::core::impl::subdoc::command> specs_;
+
+  public:
+    void id(const document_id& id);
+
+    void read_replica(bool value)
+    {
+        if (value) {
+            flags_ = flags_ | doc_flag_replica_read;
+        }
+    }
+
+    void specs(const std::vector<couchbase::core::impl::subdoc::command>& specs)
+    {
+        specs_ = specs;
+    }
+
+    [[nodiscard]] const auto& key() const
+    {
+        return key_;
+    }
+
+    [[nodiscard]] const auto& framing_extras() const
+    {
+        return empty_buffer;
+    }
+
+    [[nodiscard]] const auto& extras()
+    {
+        if (extras_.empty()) {
+            fill_extras();
+        }
+        return extras_;
+    }
+
+    [[nodiscard]] const auto& value()
+    {
+        if (value_.empty()) {
+            fill_value();
+        }
+        return value_;
+    }
+
+    [[nodiscard]] std::size_t size()
+    {
+        if (extras_.empty()) {
+            fill_extras();
+        }
+        if (value_.empty()) {
+            fill_value();
+        }
+        return key_.size() + extras_.size() + value_.size();
+    }
+
+  private:
+    void fill_extras();
+
+    void fill_value();
+};
+
+} // namespace couchbase::core::protocol

package/deps/couchbase-cxx-client/core/protocol/hello_feature.hxx

@@ -155,6 +155,11 @@ enum class hello_feature : std::uint16_t {
     replace_body_with_xattr = 0x19,
 
     resource_units = 0x1a,
+
+    /**
+     * Indicates support for subdoc lookup operations on replicas
+     */
+    subdoc_replica_read = 0x1c,
 };
 
 constexpr bool
@@ -185,6 +190,7 @@ is_valid_hello_feature(std::uint16_t code)
         case hello_feature::subdoc_document_macro_support:
         case hello_feature::replace_body_with_xattr:
         case hello_feature::resource_units:
+        case hello_feature::subdoc_replica_read:
             return true;
     }
     return false;

package/deps/couchbase-cxx-client/core/protocol/hello_feature_fmt.hxx

@@ -106,6 +106,9 @@ struct fmt::formatter<couchbase::core::protocol::hello_feature> {
             case couchbase::core::protocol::hello_feature::resource_units:
                 name = "resource_units";
                 break;
+            case couchbase::core::protocol::hello_feature::subdoc_replica_read:
+                name = "subdoc_replica_read";
+                break;
         }
         return format_to(ctx.out(), "{}", name);
     }

package/deps/couchbase-cxx-client/core/topology/capabilities.hxx

@@ -32,6 +32,7 @@ enum class bucket_capability {
     durable_write,
     tombstoned_user_xattrs,
     range_scan,
+    replica_read,
 };
 
 enum class cluster_capability {

package/deps/couchbase-cxx-client/core/topology/capabilities_fmt.hxx

@@ -70,6 +70,9 @@ struct fmt::formatter<couchbase::core::bucket_capability> {
             case couchbase::core::bucket_capability::range_scan:
                 name = "range_scan";
                 break;
+            case couchbase::core::bucket_capability::replica_read:
+                name = "replica_read";
+                break;
         }
         return format_to(ctx.out(), "{}", name);
     }

package/deps/couchbase-cxx-client/core/topology/configuration.hxx

@@ -129,6 +129,11 @@ struct configuration {
         return bucket_capabilities.count(couchbase::core::bucket_capability::couchapi) == 0;
     }
 
+    [[nodiscard]] bool supports_subdoc_read_replica() const
+    {
+        return bucket_capabilities.find(bucket_capability::replica_read) != bucket_capabilities.end();
+    }
+
     [[nodiscard]] std::size_t index_for_this_node() const;
     [[nodiscard]] bool has_node(const std::string& network,
                                 service_type type,

package/deps/couchbase-cxx-client/core/topology/configuration_json.hxx

@@ -52,7 +52,6 @@ struct traits<couchbase::core::topology::configuration> {
                 }
                 if (const auto& hostname = o.find("hostname"); hostname != o.end()) {
                     n.hostname = hostname->second.get_string();
-                    n.hostname = n.hostname.substr(0, n.hostname.rfind(':'));
                 }
                 const auto& s = o.at("services");
                 n.services_plain.key_value = s.template optional<std::uint16_t>("kv");
@@ -235,6 +234,8 @@ struct traits<couchbase::core::topology::configuration> {
                     result.bucket_capabilities.insert(couchbase::core::bucket_capability::xattr);
                 } else if (name == "rangeScan") {
                     result.bucket_capabilities.insert(couchbase::core::bucket_capability::range_scan);
+                } else if (name == "subdoc.ReplicaRead") {
+                    result.bucket_capabilities.insert(couchbase::core::bucket_capability::replica_read);
                 }
             }
         }

package/deps/couchbase-cxx-client/couchbase/collection.hxx

@@ -28,6 +28,8 @@
 #include <couchbase/get_any_replica_options.hxx>
 #include <couchbase/get_options.hxx>
 #include <couchbase/insert_options.hxx>
+#include <couchbase/lookup_in_all_replicas_options.hxx>
+#include <couchbase/lookup_in_any_replica_options.hxx>
 #include <couchbase/lookup_in_options.hxx>
 #include <couchbase/lookup_in_specs.hxx>
 #include <couchbase/mutate_in_options.hxx>
@@ -856,6 +858,115 @@ class collection
         return future;
     }
 
+    /**
+     * Performs lookups to document fragments with default options from all replicas and the active node and returns the result as a vector.
+     *
+     * @tparam Handler type of the handler that implements @ref lookup_in_all_replicas_handler
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     * @param handler callable that implements @ref lookup_in_all_replicas_handler
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename Handler>
+    void lookup_in_all_replicas(std::string document_id,
+                                lookup_in_specs specs,
+                                const lookup_in_all_replicas_options& options,
+                                Handler&& handler) const
+    {
+        return core::impl::initiate_lookup_in_all_replicas_operation(
+          core_, bucket_name_, scope_name_, name_, std::move(document_id), specs.specs(), options.build(), std::forward<Handler>(handler));
+    }
+
+    /**
+     * Performs lookups to document fragments with default options from all replicas and the active node and returns the result as a vector.
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     * @return future object that carries result of the operation
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto lookup_in_all_replicas(std::string document_id,
+                                              lookup_in_specs specs,
+                                              const lookup_in_all_replicas_options& options = {}) const
+      -> std::future<std::pair<subdocument_error_context, lookup_in_all_replicas_result>>
+    {
+        auto barrier = std::make_shared<std::promise<std::pair<subdocument_error_context, lookup_in_all_replicas_result>>>();
+        auto future = barrier->get_future();
+        lookup_in_all_replicas(std::move(document_id), std::move(specs), options, [barrier](auto ctx, auto result) {
+            barrier->set_value({ std::move(ctx), std::move(result) });
+        });
+        return future;
+    }
+
+    /**
+     * Performs lookups to document fragments with default options from all replicas and returns the first found.
+     *
+     * @tparam Handler type of the handler that implements @ref lookup_in_any_replica_handler
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename Handler>
+    void lookup_in_any_replica(std::string document_id,
+                               lookup_in_specs specs,
+                               const lookup_in_any_replica_options& options,
+                               Handler&& handler) const
+    {
+        return core::impl::initiate_lookup_in_any_replica_operation(
+          core_, bucket_name_, scope_name_, name_, std::move(document_id), specs.specs(), options.build(), std::forward<Handler>(handler));
+    }
+
+    /**
+     * Performs lookups to document fragments with default options from all replicas and returns the first found.
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     * @return future object that carries result of the operation
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto lookup_in_any_replica(std::string document_id,
+                                             lookup_in_specs specs,
+                                             const lookup_in_any_replica_options& options = {}) const
+      -> std::future<std::pair<subdocument_error_context, lookup_in_replica_result>>
+    {
+        auto barrier = std::make_shared<std::promise<std::pair<subdocument_error_context, lookup_in_replica_result>>>();
+        auto future = barrier->get_future();
+        lookup_in_any_replica(std::move(document_id), std::move(specs), options, [barrier](auto ctx, auto result) {
+            barrier->set_value({ std::move(ctx), std::move(result) });
+        });
+        return future;
+    }
+
     /**
      * Gets a document for a given id and places a pessimistic lock on it for mutations
      *

package/deps/couchbase-cxx-client/couchbase/get_and_lock_options.hxx

@@ -86,8 +86,8 @@ initiate_get_and_lock_operation(std::shared_ptr<couchbase::core::cluster> core,
                                 std::string collection_name,
                                 std::string document_key,
                                 std::chrono::seconds lock_duration,
-                                get_and_lock_options::built options,
-                                get_and_lock_handler&& handler);
+                                couchbase::get_and_lock_options::built options,
+                                couchbase::get_and_lock_handler&& handler);
 #endif
 } // namespace impl
 } // namespace core

package/deps/couchbase-cxx-client/couchbase/get_and_touch_options.hxx

@@ -86,8 +86,8 @@ initiate_get_and_touch_operation(std::shared_ptr<couchbase::core::cluster> core,
                                  std::string collection_name,
                                  std::string document_key,
                                  std::uint32_t expiry,
-                                 get_and_touch_options::built options,
-                                 get_and_touch_handler&& handler);
+                                 couchbase::get_and_touch_options::built options,
+                                 couchbase::get_and_touch_handler&& handler);
 #endif
 } // namespace impl
 } // namespace core

package/deps/couchbase-cxx-client/couchbase/get_options.hxx

@@ -129,8 +129,8 @@ initiate_get_operation(std::shared_ptr<couchbase::core::cluster> core,
                        std::string scope_name,
                        std::string collection_name,
                        std::string document_key,
-                       get_options::built options,
-                       get_handler&& handler);
+                       couchbase::get_options::built options,
+                       couchbase::get_handler&& handler);
 #endif
 } // namespace impl
 } // namespace core

package/deps/couchbase-cxx-client/couchbase/insert_options.hxx

@@ -127,9 +127,9 @@ initiate_insert_operation(std::shared_ptr<couchbase::core::cluster> core,
                           std::string scope_name,
                           std::string collection_name,
                           std::string document_key,
-                          codec::encoded_value encoded,
-                          insert_options::built options,
-                          insert_handler&& handler);
+                          couchbase::codec::encoded_value encoded,
+                          couchbase::insert_options::built options,
+                          couchbase::insert_handler&& handler);
 #endif
 } // namespace impl
 } // namespace core

package/deps/couchbase-cxx-client/couchbase/lookup_in_all_replicas_options.hxx

@@ -0,0 +1,109 @@
+/* -*- 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/subdoc/fwd/command_bundle.hxx>
+
+#include <core/impl/subdoc/command.hxx>
+#include <couchbase/codec/encoded_value.hxx>
+#include <couchbase/common_options.hxx>
+#include <couchbase/expiry.hxx>
+#include <couchbase/lookup_in_replica_result.hxx>
+#include <couchbase/store_semantics.hxx>
+#include <couchbase/subdocument_error_context.hxx>
+
+#include <chrono>
+#include <functional>
+#include <memory>
+#include <optional>
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * Options for @ref collection#lookup_in_all_replicas().
+ *
+ * @since 1.0.0
+ * @committed
+ */
+struct lookup_in_all_replicas_options : common_options<lookup_in_all_replicas_options> {
+    /**
+     * Immutable value object representing consistent options.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    struct built : public common_options<lookup_in_all_replicas_options>::built {
+    };
+
+    /**
+     * Validates options and returns them as an immutable value.
+     *
+     * @return consistent options as an immutable value
+     *
+     * @exception std::system_error with code errc::common::invalid_argument if the options are not valid
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto build() const -> built
+    {
+        return { build_common_options() };
+    }
+};
+
+/**
+ * The result for the @ref collection#lookup_in_all_replicas() operation
+ *
+ * @since 1.0.0
+ * @uncommitted
+ */
+using lookup_in_all_replicas_result = std::vector<lookup_in_replica_result>;
+
+/**
+ * The signature for the handler of the @ref collection#lookup_in_all_replicas() operation
+ *
+ * @since 1.0.0
+ * @uncommitted
+ */
+using lookup_in_all_replicas_handler = std::function<void(couchbase::subdocument_error_context, lookup_in_all_replicas_result)>;
+
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+namespace core
+{
+class cluster;
+namespace impl
+{
+
+/**
+ * @since 1.0.0
+ * @internal
+ */
+void
+initiate_lookup_in_all_replicas_operation(std::shared_ptr<couchbase::core::cluster> core,
+                                          const std::string& bucket_name,
+                                          const std::string& scope_name,
+                                          const std::string& collection_name,
+                                          std::string document_key,
+                                          const std::vector<couchbase::core::impl::subdoc::command>& specs,
+                                          lookup_in_all_replicas_options::built options,
+                                          lookup_in_all_replicas_handler&& handler);
+#endif
+} // namespace impl
+} // namespace core
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/lookup_in_any_replica_options.hxx

@@ -0,0 +1,101 @@
+/* -*- 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/subdoc/fwd/command_bundle.hxx>
+
+#include <core/impl/subdoc/command.hxx>
+#include <couchbase/codec/encoded_value.hxx>
+#include <couchbase/common_options.hxx>
+#include <couchbase/expiry.hxx>
+#include <couchbase/lookup_in_replica_result.hxx>
+#include <couchbase/store_semantics.hxx>
+#include <couchbase/subdocument_error_context.hxx>
+
+#include <chrono>
+#include <functional>
+#include <memory>
+#include <optional>
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * Options for @ref collection#lookup_in_any_replica().
+ *
+ * @since 1.0.0
+ * @committed
+ */
+struct lookup_in_any_replica_options : common_options<lookup_in_any_replica_options> {
+    /**
+     * Immutable value object representing consistent options.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    struct built : public common_options<lookup_in_any_replica_options>::built {
+    };
+
+    /**
+     * Validates options and returns them as an immutable value.
+     *
+     * @return consistent options as an immutable value
+     *
+     * @exception std::system_error with code errc::common::invalid_argument if the options are not valid
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto build() const -> built
+    {
+        return { build_common_options() };
+    }
+};
+
+/**
+ * The signature for the handler of the @ref collection#lookup_in_any_replica() operation
+ *
+ * @since 1.0.0
+ * @uncommitted
+ */
+using lookup_in_any_replica_handler = std::function<void(couchbase::subdocument_error_context, lookup_in_replica_result)>;
+
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+namespace core
+{
+class cluster;
+namespace impl
+{
+
+/**
+ * @since 1.0.0
+ * @internal
+ */
+void
+initiate_lookup_in_any_replica_operation(std::shared_ptr<couchbase::core::cluster> core,
+                                         const std::string& bucket_name,
+                                         const std::string& scope_name,
+                                         const std::string& collection_name,
+                                         std::string document_key,
+                                         const std::vector<couchbase::core::impl::subdoc::command>& specs,
+                                         lookup_in_any_replica_options::built options,
+                                         lookup_in_any_replica_handler&& handler);
+#endif
+} // namespace impl
+} // namespace core
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/lookup_in_options.hxx

@@ -111,8 +111,8 @@ initiate_lookup_in_operation(std::shared_ptr<couchbase::core::cluster> core,
                              std::string collection_name,
                              std::string document_key,
                              const std::vector<couchbase::core::impl::subdoc::command>& specs,
-                             lookup_in_options::built options,
-                             lookup_in_handler&& handler);
+                             couchbase::lookup_in_options::built options,
+                             couchbase::lookup_in_handler&& handler);
 #endif
 } // namespace impl
 } // namespace core