couchbase 3.4.3 → 3.4.4

data/ext/couchbase/core/origin.cxx

@@ -0,0 +1,270 @@
+/* -*- 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.
+ */
+
+#include "origin.hxx"
+
+#include <fmt/chrono.h>
+#include <fmt/format.h>
+
+#include <tao/json.hpp>
+
+namespace tao::json
+{
+
+template<>
+struct traits<std::chrono::milliseconds> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const std::chrono::milliseconds& o)
+    {
+        v = fmt::format("{}", o);
+    }
+};
+
+template<>
+struct traits<std::chrono::nanoseconds> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const std::chrono::nanoseconds& o)
+    {
+        v = fmt::format("{}", o);
+    }
+};
+
+template<>
+struct traits<couchbase::core::tls_verify_mode> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::core::tls_verify_mode& o)
+    {
+        switch (o) {
+            case couchbase::core::tls_verify_mode::none:
+                v = "none";
+                break;
+            case couchbase::core::tls_verify_mode::peer:
+                v = "peer";
+                break;
+        }
+    }
+};
+
+template<>
+struct traits<couchbase::core::io::ip_protocol> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::core::io::ip_protocol& o)
+    {
+        switch (o) {
+            case couchbase::core::io::ip_protocol::any:
+                v = "any";
+                break;
+            case couchbase::core::io::ip_protocol::force_ipv4:
+                v = "force_ipv4";
+                break;
+            case couchbase::core::io::ip_protocol::force_ipv6:
+                v = "force_ipv6";
+                break;
+        }
+    }
+};
+
+template<>
+struct traits<couchbase::core::io::dns::dns_config> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::core::io::dns::dns_config& o)
+    {
+        v = {
+            { "port", o.port() },
+            { "nameserver", o.nameserver() },
+            { "timeout", o.timeout() },
+        };
+    }
+};
+
+template<>
+struct traits<couchbase::core::tracing::threshold_logging_options> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::core::tracing::threshold_logging_options& o)
+    {
+        v = {
+            { "orphaned_emit_interval", o.orphaned_emit_interval },
+            { "orphaned_sample_size", o.orphaned_sample_size },
+            { "threshold_emit_interval", o.threshold_emit_interval },
+            { "threshold_sample_size", o.threshold_sample_size },
+            { "key_value_threshold", o.key_value_threshold },
+            { "query_threshold", o.query_threshold },
+            { "view_threshold", o.view_threshold },
+            { "search_threshold", o.search_threshold },
+            { "analytics_threshold", o.analytics_threshold },
+            { "management_threshold", o.management_threshold },
+        };
+    }
+};
+
+template<>
+struct traits<couchbase::core::metrics::logging_meter_options> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::core::metrics::logging_meter_options& o)
+    {
+        v = {
+            { "emit_interval", o.emit_interval },
+        };
+    }
+};
+
+template<>
+struct traits<couchbase::durability_level> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::durability_level& o)
+    {
+        switch (o) {
+            case couchbase::durability_level::none:
+                v = "none";
+                break;
+            case couchbase::durability_level::majority:
+                v = "majority";
+                break;
+            case couchbase::durability_level::majority_and_persist_to_active:
+                v = "majority_and_persist_to_active";
+                break;
+            case couchbase::durability_level::persist_to_majority:
+                v = "persist_to_majority";
+                break;
+        }
+    }
+};
+
+template<>
+struct traits<couchbase::query_scan_consistency> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::query_scan_consistency& o)
+    {
+        switch (o) {
+            case couchbase::query_scan_consistency::not_bounded:
+                v = "not_bounded";
+                break;
+            case couchbase::query_scan_consistency::request_plus:
+                v = "request_plus";
+                break;
+        }
+    }
+};
+
+template<>
+struct traits<couchbase::transactions::transactions_config::built> {
+    template<template<typename...> class Traits>
+    static void assign(tao::json::basic_value<Traits>& v, const couchbase::transactions::transactions_config::built& o)
+    {
+        v = {
+            { "expiration_time", o.expiration_time },
+            { "durability_level", o.level },
+            {
+              "query_config",
+              {
+                { "scan_consistency", o.query_config.scan_consistency },
+              },
+            },
+            {
+              "cleanup_config",
+              {
+                { "cleanup_lost_attempts", o.cleanup_config.cleanup_lost_attempts },
+                { "cleanup_client_attempts", o.cleanup_config.cleanup_client_attempts },
+                { "cleanup_window", o.cleanup_config.cleanup_window },
+                { "collections", tao::json::empty_array },
+              },
+            },
+        };
+        if (const auto& p = o.kv_timeout; p.has_value()) {
+            v["key_value_timeout"] = p.value();
+        }
+        if (const auto& p = o.metadata_collection; p.has_value()) {
+            v["metadata_collection"] = {
+                { "bucket", p.value().bucket },
+                { "scope", p.value().scope },
+                { "collection", p.value().collection },
+            };
+        }
+        for (const auto& c : o.cleanup_config.collections) {
+            v["cleanup_config"]["collections"].emplace_back(tao::json::value{
+              { "bucket", c.bucket },
+              { "scope", c.scope },
+              { "collection", c.collection },
+            });
+        }
+    }
+};
+
+} // namespace tao::json
+
+namespace couchbase::core
+{
+auto
+origin::to_json() const -> std::string
+{
+    tao::json::value json = {
+        {
+          "options",
+          {
+            { "bootstrap_timeout", options_.bootstrap_timeout },
+            { "resolve_timeout", options_.resolve_timeout },
+            { "connect_timeout", options_.connect_timeout },
+            { "key_value_timeout", options_.key_value_timeout },
+            { "key_value_durable_timeout", options_.key_value_durable_timeout },
+            { "view_timeout", options_.view_timeout },
+            { "query_timeout", options_.query_timeout },
+            { "analytics_timeout", options_.analytics_timeout },
+            { "search_timeout", options_.search_timeout },
+            { "management_timeout", options_.management_timeout },
+            { "enable_tls", options_.enable_tls },
+            { "trust_certificate", options_.trust_certificate },
+            { "enable_mutation_tokens", options_.enable_mutation_tokens },
+            { "enable_tcp_keep_alive", options_.enable_tcp_keep_alive },
+            { "use_ip_protocol", options_.use_ip_protocol },
+            { "enable_dns_srv", options_.enable_dns_srv },
+            { "dns_config", options_.dns_config },
+            { "show_queries", options_.show_queries },
+            { "enable_unordered_execution", options_.enable_unordered_execution },
+            { "enable_clustermap_notification", options_.enable_clustermap_notification },
+            { "enable_compression", options_.enable_compression },
+            { "enable_tracing", options_.enable_tracing },
+            { "enable_metrics", options_.enable_metrics },
+            { "tcp_keep_alive_interval", options_.tcp_keep_alive_interval },
+            { "config_poll_interval", options_.config_poll_interval },
+            { "config_poll_floor", options_.config_poll_floor },
+            { "config_idle_redial_timeout", options_.config_idle_redial_timeout },
+            { "max_http_connections", options_.max_http_connections },
+            { "idle_http_connection_timeout", options_.idle_http_connection_timeout },
+            { "user_agent_extra", options_.user_agent_extra },
+            { "dump_configuration", options_.dump_configuration },
+            { "disable_mozilla_ca_certificates", options_.disable_mozilla_ca_certificates },
+            { "metrics_options", options_.metrics_options },
+            { "network", options_.network },
+            { "tls_verify", options_.tls_verify },
+            { "tracing_options", options_.tracing_options },
+            { "transactions_options", options_.transactions },
+          },
+        },
+    };
+    {
+        tao::json::value nodes = tao::json::empty_array;
+        for (const auto& [hostname, port] : nodes_) {
+            nodes.emplace_back(tao::json::value{
+              { "hostname", hostname },
+              { "port", port },
+            });
+        }
+        json["bootstrap_nodes"] = nodes;
+    }
+    return tao::json::to_string(json);
+}
+} // namespace couchbase::core

data/ext/couchbase/core/origin.hxx

@@ -184,6 +184,8 @@ struct origin {
         return credentials_;
     }
 
+    [[nodiscard]] auto to_json() const -> std::string;
+
   private:
     couchbase::core::cluster_options options_{};
     cluster_credentials credentials_{};

data/ext/couchbase/core/protocol/client_response.hxx

@@ -148,6 +148,7 @@ class client_response
         data_.resize(body_size_);
 
         memcpy(&opaque_, header_.data() + 12, sizeof(opaque_));
+        opaque_ = utils::byte_swap(opaque_);
 
         memcpy(&cas_, header_.data() + 16, sizeof(cas_));
         cas_ = utils::byte_swap(cas_);

data/ext/couchbase/core/protocol/cmd_hello.hxx

@@ -71,6 +71,7 @@ class hello_request_body
         hello_feature::collections,
         hello_feature::subdoc_create_as_deleted,
         hello_feature::preserve_ttl,
+        hello_feature::subdoc_replica_read,
     };
     std::vector<std::byte> value_;
 

data/ext/couchbase/core/protocol/cmd_lookup_in_replica.cxx

@@ -0,0 +1,107 @@
+/* -*- 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.
+ */
+
+#include "cmd_lookup_in_replica.hxx"
+
+#include "core/utils/byteswap.hxx"
+#include "core/utils/unsigned_leb128.hxx"
+
+#include <cstring>
+#include <gsl/assert>
+
+namespace couchbase::core::protocol
+{
+bool
+lookup_in_replica_response_body::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 */)
+{
+    Expects(header[1] == static_cast<std::byte>(opcode));
+    if (status == key_value_status_code::success || status == key_value_status_code::subdoc_multi_path_failure ||
+        status == key_value_status_code::subdoc_success_deleted || status == key_value_status_code::subdoc_multi_path_failure_deleted) {
+        using offset_type = std::vector<std::byte>::difference_type;
+        offset_type offset = framing_extras_size + key_size + extras_size;
+        fields_.reserve(16); /* we won't have more than 16 entries anyway */
+        while (static_cast<std::size_t>(offset) < body.size()) {
+            lookup_in_field field;
+
+            std::uint16_t entry_status = 0;
+            memcpy(&entry_status, body.data() + offset, sizeof(entry_status));
+            entry_status = utils::byte_swap(entry_status);
+            Expects(is_valid_status(entry_status));
+            field.status = static_cast<key_value_status_code>(entry_status);
+            offset += static_cast<offset_type>(sizeof(entry_status));
+
+            std::uint32_t entry_size = 0;
+            memcpy(&entry_size, body.data() + offset, sizeof(entry_size));
+            entry_size = utils::byte_swap(entry_size);
+            Expects(entry_size < 20 * 1024 * 1024);
+            offset += static_cast<offset_type>(sizeof(entry_size));
+
+            field.value.resize(entry_size);
+            memcpy(field.value.data(), body.data() + offset, entry_size);
+            offset += static_cast<offset_type>(entry_size);
+
+            fields_.emplace_back(field);
+        }
+        return true;
+    }
+    return false;
+}
+
+void
+lookup_in_replica_request_body::id(const document_id& id)
+{
+    key_ = make_protocol_key(id);
+}
+
+void
+lookup_in_replica_request_body::fill_extras()
+{
+    if (flags_ != 0) {
+        extras_.resize(sizeof(flags_));
+        extras_[0] = std::byte{ flags_ };
+    }
+}
+
+void
+lookup_in_replica_request_body::fill_value()
+{
+    size_t value_size = 0;
+    for (const auto& spec : specs_) {
+        value_size += sizeof(spec.opcode_) + sizeof(std::uint8_t) + sizeof(std::uint16_t) + spec.path_.size();
+    }
+    Expects(value_size > 0);
+    value_.resize(value_size);
+    std::vector<std::byte>::size_type offset = 0;
+    for (const auto& spec : specs_) {
+        value_[offset] = static_cast<std::byte>(spec.opcode_);
+        ++offset;
+        value_[offset] = spec.flags_;
+        ++offset;
+        std::uint16_t path_size = utils::byte_swap(gsl::narrow_cast<std::uint16_t>(spec.path_.size()));
+        std::memcpy(value_.data() + offset, &path_size, sizeof(path_size));
+        offset += sizeof(path_size);
+        std::memcpy(value_.data() + offset, spec.path_.data(), spec.path_.size());
+        offset += spec.path_.size();
+    }
+}
+} // namespace couchbase::core::protocol

data/ext/couchbase/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

data/ext/couchbase/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;

data/ext/couchbase/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);
     }

data/ext/couchbase/core/protocol/status.cxx

@@ -189,10 +189,10 @@ map_status_code(protocol::client_opcode opcode, std::uint16_t status)
         case key_value_status_code::opaque_no_match:
 
         case key_value_status_code::range_scan_cancelled:
-            return errc::key_value::range_scan_cancelled;
+            return errc::common::request_canceled;
 
         case key_value_status_code::range_scan_vb_uuid_not_equal:
-            return errc::key_value::range_scan_vb_uuid_not_equal;
+            return errc::key_value::mutation_token_outdated;
 
         case key_value_status_code::unknown:
             break;

data/ext/couchbase/core/range_scan_options.cxx

@@ -19,34 +19,10 @@
 
 namespace couchbase::core
 {
-range_scan::range_scan(scan_term start, scan_term end)
-  : start_{ std::move(start) }
-  , end_{ std::move(end) }
-{
-}
-
-range_scan::range_scan(std::string_view start, std::string_view end)
-  : start_{ utils::to_binary(start) }
-  , end_{ utils::to_binary(end) }
-{
-}
-
-range_scan::range_scan(std::string_view start, bool exclusive_start, std::string_view end, bool exclusive_end)
-  : start_{ utils::to_binary(start), exclusive_start }
-  , end_{ utils::to_binary(end), exclusive_end }
-{
-}
-
-range_scan::range_scan(std::vector<std::byte> start, std::vector<std::byte> end)
-  : start_{ std::move(start) }
-  , end_{ std::move(end) }
-{
-}
-
-range_scan::range_scan(std::vector<std::byte> start, bool exclusive_start, std::vector<std::byte> end, bool exclusive_end)
-  : start_{ std::move(start), exclusive_start }
-  , end_{ std::move(end), exclusive_end }
+auto
+prefix_scan::to_range_scan() const -> range_scan
 {
+    return { scan_term{ prefix, false }, scan_term{ prefix + "\xf4\x8f\xfb\xfb" } };
 }
 
 auto