couchbase 3.4.2 → 3.4.4

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/public_fwd.hxx

@@ -0,0 +1,21 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ * Copyright 2022-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
+ *
+ *     https://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
+
+namespace couchbase::tracing
+{
+class request_span;
+} // namespace couchbase::tracing

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

data/ext/couchbase/core/range_scan_options.hxx

@@ -29,28 +29,24 @@
 namespace couchbase::core
 {
 struct scan_term {
-    static constexpr std::byte minimum_marker{ 0x00 };
-    static constexpr std::byte maximum_marker{ 0xff };
-
-    std::vector<std::byte> id;
+    std::string term;
     bool exclusive{ false };
 };
 
 struct range_scan {
-    range_scan() = default;
-    range_scan(scan_term start, scan_term end);
-    range_scan(std::string_view start, std::string_view end);
-    range_scan(std::string_view start, bool exclusive_start, std::string_view end, bool exclusive_end);
-    range_scan(std::vector<std::byte> start, std::vector<std::byte> end);
-    range_scan(std::vector<std::byte> start, bool exclusive_start, std::vector<std::byte> end, bool exclusive_end);
-
-    scan_term start_{ { scan_term::minimum_marker } };
-    scan_term end_{ { scan_term::maximum_marker } };
+    std::optional<scan_term> from{};
+    std::optional<scan_term> to{};
+};
+
+struct prefix_scan {
+    std::string prefix{};
+
+    [[nodiscard]] auto to_range_scan() const -> range_scan;
 };
 
 struct sampling_scan {
     std::size_t limit{};
-    std::optional<std::uint32_t> seed{};
+    std::optional<std::uint64_t> seed{};
 };
 
 struct range_snapshot_requirements {
@@ -62,7 +58,7 @@ struct range_snapshot_requirements {
 struct range_scan_create_options {
     std::string scope_name{};
     std::string collection_name{};
-    std::variant<std::monostate, range_scan, sampling_scan> scan_type{};
+    std::variant<std::monostate, range_scan, prefix_scan, sampling_scan> scan_type{};
     std::chrono::milliseconds timeout{};
     std::uint32_t collection_id{ 0 };
     std::optional<range_snapshot_requirements> snapshot_requirements{};
@@ -88,10 +84,10 @@ struct range_scan_continue_options {
 
     std::uint32_t batch_item_limit{ default_batch_item_limit };
     std::uint32_t batch_byte_limit{ default_batch_byte_limit };
+    std::chrono::milliseconds timeout{};
     std::chrono::milliseconds batch_time_limit{ default_batch_time_limit };
     std::shared_ptr<couchbase::retry_strategy> retry_strategy{ nullptr };
 
-    bool ids_only{ false }; // support servers before MB-54267. TODO: remove after server GA
     struct {
         std::string user{};
     } internal{};
@@ -126,7 +122,7 @@ struct range_scan_item_body {
 };
 
 struct range_scan_item {
-    std::vector<std::byte> key{};
+    std::string key{};
     std::optional<range_scan_item_body> body{};
 };