couchbase 3.0.1 → 3.0.2

data/ext/couchbase/protocol/cmd_append.hxx

@@ -0,0 +1,145 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2020 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 <document_id.hxx>
+#include <protocol/status.hxx>
+#include <protocol/client_opcode.hxx>
+#include <protocol/frame_info_id.hxx>
+#include <protocol/unsigned_leb128.h>
+#include <protocol/durability_level.hxx>
+#include <protocol/cmd_info.hxx>
+#include <mutation_token.hxx>
+#include <utils/byteswap.hxx>
+
+namespace couchbase::protocol
+{
+
+class append_response_body
+{
+  public:
+    static const inline client_opcode opcode = client_opcode::append;
+
+  private:
+    mutation_token token_;
+
+  public:
+    mutation_token& token()
+    {
+        return token_;
+    }
+
+    bool parse(protocol::status status,
+               const header_buffer& header,
+               std::uint8_t framing_extras_size,
+               std::uint16_t,
+               std::uint8_t extras_size,
+               const std::vector<uint8_t>& body,
+               const cmd_info&)
+    {
+        Expects(header[1] == static_cast<uint8_t>(opcode));
+        if (status == protocol::status::success) {
+            std::vector<uint8_t>::difference_type offset = framing_extras_size;
+            if (extras_size == 16) {
+                memcpy(&token_.partition_uuid, body.data() + offset, sizeof(token_.partition_uuid));
+                token_.partition_uuid = utils::byte_swap_64(token_.partition_uuid);
+                offset += 8;
+
+                memcpy(&token_.sequence_number, body.data() + offset, sizeof(token_.sequence_number));
+                token_.sequence_number = utils::byte_swap_64(token_.sequence_number);
+                return true;
+            }
+        }
+        return false;
+    }
+};
+
+class append_request_body
+{
+  public:
+    using response_body_type = append_response_body;
+    static const inline client_opcode opcode = client_opcode::append;
+
+  private:
+    std::string key_{};
+    std::vector<std::uint8_t> extras_{};
+    std::vector<std::uint8_t> content_{};
+    std::vector<std::uint8_t> framing_extras_{};
+
+  public:
+    void id(const document_id& id)
+    {
+        key_ = id.key;
+        if (id.collection_uid) {
+            unsigned_leb128<uint32_t> encoded(*id.collection_uid);
+            key_.insert(0, encoded.get());
+        }
+    }
+
+    void durability(protocol::durability_level level, std::optional<std::uint16_t> timeout)
+    {
+        if (level == protocol::durability_level::none) {
+            return;
+        }
+        auto frame_id = static_cast<uint8_t>(protocol::request_frame_info_id::durability_requirement);
+        if (timeout) {
+            framing_extras_.resize(4);
+            framing_extras_[0] = static_cast<std::uint8_t>((static_cast<std::uint32_t>(frame_id) << 4U) | 3U);
+            framing_extras_[1] = static_cast<std::uint8_t>(level);
+            uint16_t val = htons(*timeout);
+            memcpy(framing_extras_.data() + 2, &val, sizeof(val));
+        } else {
+            framing_extras_.resize(2);
+            framing_extras_[0] = static_cast<std::uint8_t>(static_cast<std::uint32_t>(frame_id) << 4U | 1U);
+            framing_extras_[1] = static_cast<std::uint8_t>(level);
+        }
+    }
+
+    void content(const std::string& content)
+    {
+        content_ = { content.begin(), content.end() };
+    }
+
+    const std::string& key()
+    {
+        return key_;
+    }
+
+    const std::vector<std::uint8_t>& framing_extras()
+    {
+        return framing_extras_;
+    }
+
+    const std::vector<std::uint8_t>& extras()
+    {
+        static std::vector<std::uint8_t> empty;
+        return empty;
+    }
+
+    const std::vector<std::uint8_t>& value()
+    {
+        return content_;
+    }
+
+    std::size_t size()
+    {
+        return framing_extras_.size() + key_.size() + content_.size();
+    }
+};
+
+} // namespace couchbase::protocol

data/ext/couchbase/protocol/cmd_hello.hxx

@@ -90,6 +90,7 @@ class hello_request_body
         hello_feature::sync_replication,
         hello_feature::vattr,
         hello_feature::collections,
+        hello_feature::subdoc_create_as_deleted,
     };
     std::vector<std::uint8_t> value_;
 

data/ext/couchbase/protocol/cmd_lookup_in.hxx

@@ -53,7 +53,8 @@ class lookup_in_response_body
                const cmd_info&)
     {
         Expects(header[1] == static_cast<uint8_t>(opcode));
-        if (status == protocol::status::success || status == protocol::status::subdoc_multi_path_failure) {
+        if (status == protocol::status::success || status == protocol::status::subdoc_multi_path_failure ||
+            status == protocol::status::subdoc_success_deleted || status == protocol::status::subdoc_multi_path_failure_deleted) {
             using offset_type = std::vector<uint8_t>::difference_type;
             offset_type offset = framing_extras_size + key_size + extras_size;
             fields_.reserve(16); /* we won't have more than 16 entries anyway */
@@ -91,10 +92,17 @@ class lookup_in_request_body
     using response_body_type = lookup_in_response_body;
     static const inline client_opcode opcode = client_opcode::subdoc_multi_lookup;
 
-    static const inline uint8_t doc_flag_access_deleted = 0x04;
+    /**
+     * Allow access to XATTRs for deleted documents (instead of returning KEY_ENOENT).
+     */
+    static const inline uint8_t doc_flag_access_deleted = 0b0000'0100;
 
     struct lookup_in_specs {
-        static const inline uint8_t path_flag_xattr = 0x04;
+        /**
+         * If set, the path refers to an Extended Attribute (XATTR).
+         * If clear, the path refers to a path inside the document body.
+         */
+        static const inline uint8_t path_flag_xattr = 0b0000'0100;
 
         struct entry {
             std::uint8_t opcode;

data/ext/couchbase/protocol/cmd_mutate_in.hxx

@@ -133,14 +133,47 @@ class mutate_in_request_body
         insert,
     };
 
-    static const inline uint8_t doc_flag_access_deleted = 0b0000'0100;
+    /**
+     * Create the document if it does not exist. Implies `path_flag_create_parents`.
+     * and `upsert` mutation semantics. Not valid with `insert`.
+     */
     static const inline uint8_t doc_flag_mkdoc = 0b0000'0001;
+
+    /**
+     * Add the document only if it does not exist. Implies `path_flag_create_parents`.
+     * Not valid with `doc_flag_mkdoc`.
+     */
     static const inline uint8_t doc_flag_add = 0b0000'0010;
 
+    /**
+     * Allow access to XATTRs for deleted documents (instead of returning KEY_ENOENT).
+     */
+    static const inline uint8_t doc_flag_access_deleted = 0b0000'0100;
+
+    /**
+     * Used with `doc_flag_mkdoc` / `doc_flag_add`; if the document does not exist then creat
+     * it in the "Deleted" state, instead of the normal "Alive" state.
+     * Not valid unless `doc_flag_mkdoc` or `doc_flag_add` specified.
+     */
+    static const inline uint8_t doc_flag_create_as_deleted = 0b0000'1000;
+
     struct mutate_in_specs {
-        static const inline uint8_t path_flag_create_parents = 0x01;
-        static const inline uint8_t path_flag_xattr = 0x04;
-        static const inline uint8_t path_flag_expand_macros = 0x10;
+        /**
+         * Should non-existent intermediate paths be created
+         */
+        static const inline uint8_t path_flag_create_parents = 0b0000'0001;
+
+        /**
+         * If set, the path refers to an Extended Attribute (XATTR).
+         * If clear, the path refers to a path inside the document body.
+         */
+        static const inline uint8_t path_flag_xattr = 0b0000'0100;
+
+        /**
+         * Expand macro values inside extended attributes. The request is
+         * invalid if this flag is set without `path_flag_create_parents` being set.
+         */
+        static const inline uint8_t path_flag_expand_macros = 0b0001'0000;
 
         struct entry {
             std::uint8_t opcode;
@@ -237,6 +270,15 @@ class mutate_in_request_body
         }
     }
 
+    void create_as_deleted(bool value)
+    {
+        if (value) {
+            flags_ |= doc_flag_create_as_deleted;
+        } else {
+            flags_ &= static_cast<std::uint8_t>(~doc_flag_create_as_deleted);
+        }
+    }
+
     void store_semantics(store_semantics_type semantics)
     {
         flags_ &= 0b1111'1100; /* reset first two bits */

data/ext/couchbase/protocol/cmd_noop.hxx

@@ -0,0 +1,82 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2020 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 <protocol/unsigned_leb128.h>
+
+#include <protocol/client_opcode.hxx>
+#include <document_id.hxx>
+
+namespace couchbase::protocol
+{
+
+class mcbp_noop_response_body
+{
+  public:
+    static const inline client_opcode opcode = client_opcode::noop;
+
+    bool parse(protocol::status,
+               const header_buffer& header,
+               std::uint8_t,
+               std::uint16_t,
+               std::uint8_t,
+               const std::vector<uint8_t>&,
+               const cmd_info&)
+    {
+        Expects(header[1] == static_cast<uint8_t>(opcode));
+        return false;
+    }
+};
+
+class mcbp_noop_request_body
+{
+  public:
+    using response_body_type = mcbp_noop_response_body;
+    static const inline client_opcode opcode = client_opcode::noop;
+
+    const std::string& key()
+    {
+        static std::string empty;
+        return empty;
+    }
+
+    const std::vector<std::uint8_t>& framing_extras()
+    {
+        static std::vector<std::uint8_t> empty;
+        return empty;
+    }
+
+    const std::vector<std::uint8_t>& extras()
+    {
+        static std::vector<std::uint8_t> empty;
+        return empty;
+    }
+
+    const std::vector<std::uint8_t>& value()
+    {
+        static std::vector<std::uint8_t> empty;
+        return empty;
+    }
+
+    std::size_t size()
+    {
+        return 0;
+    }
+};
+
+} // namespace couchbase::protocol

data/ext/couchbase/protocol/cmd_prepend.hxx

@@ -0,0 +1,145 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *     Copyright 2020 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 <protocol/status.hxx>
+#include <protocol/client_opcode.hxx>
+#include <protocol/frame_info_id.hxx>
+#include <protocol/unsigned_leb128.h>
+#include <protocol/durability_level.hxx>
+#include <protocol/cmd_info.hxx>
+#include <document_id.hxx>
+#include <mutation_token.hxx>
+#include <utils/byteswap.hxx>
+
+namespace couchbase::protocol
+{
+
+class prepend_response_body
+{
+  public:
+    static const inline client_opcode opcode = client_opcode::prepend;
+
+  private:
+    mutation_token token_;
+
+  public:
+    mutation_token& token()
+    {
+        return token_;
+    }
+
+    bool parse(protocol::status status,
+               const header_buffer& header,
+               std::uint8_t framing_extras_size,
+               std::uint16_t,
+               std::uint8_t extras_size,
+               const std::vector<uint8_t>& body,
+               const cmd_info&)
+    {
+        Expects(header[1] == static_cast<uint8_t>(opcode));
+        if (status == protocol::status::success) {
+            std::vector<uint8_t>::difference_type offset = framing_extras_size;
+            if (extras_size == 16) {
+                memcpy(&token_.partition_uuid, body.data() + offset, sizeof(token_.partition_uuid));
+                token_.partition_uuid = utils::byte_swap_64(token_.partition_uuid);
+                offset += 8;
+
+                memcpy(&token_.sequence_number, body.data() + offset, sizeof(token_.sequence_number));
+                token_.sequence_number = utils::byte_swap_64(token_.sequence_number);
+                return true;
+            }
+        }
+        return false;
+    }
+};
+
+class prepend_request_body
+{
+  public:
+    using response_body_type = prepend_response_body;
+    static const inline client_opcode opcode = client_opcode::prepend;
+
+  private:
+    std::string key_{};
+    std::vector<std::uint8_t> extras_{};
+    std::vector<std::uint8_t> content_{};
+    std::vector<std::uint8_t> framing_extras_{};
+
+  public:
+    void id(const document_id& id)
+    {
+        key_ = id.key;
+        if (id.collection_uid) {
+            unsigned_leb128<uint32_t> encoded(*id.collection_uid);
+            key_.insert(0, encoded.get());
+        }
+    }
+
+    void durability(protocol::durability_level level, std::optional<std::uint16_t> timeout)
+    {
+        if (level == protocol::durability_level::none) {
+            return;
+        }
+        auto frame_id = static_cast<uint8_t>(protocol::request_frame_info_id::durability_requirement);
+        if (timeout) {
+            framing_extras_.resize(4);
+            framing_extras_[0] = static_cast<std::uint8_t>((static_cast<std::uint32_t>(frame_id) << 4U) | 3U);
+            framing_extras_[1] = static_cast<std::uint8_t>(level);
+            uint16_t val = htons(*timeout);
+            memcpy(framing_extras_.data() + 2, &val, sizeof(val));
+        } else {
+            framing_extras_.resize(2);
+            framing_extras_[0] = static_cast<std::uint8_t>(static_cast<std::uint32_t>(frame_id) << 4U | 1U);
+            framing_extras_[1] = static_cast<std::uint8_t>(level);
+        }
+    }
+
+    void content(const std::string& content)
+    {
+        content_ = { content.begin(), content.end() };
+    }
+
+    const std::string& key()
+    {
+        return key_;
+    }
+
+    const std::vector<std::uint8_t>& framing_extras()
+    {
+        return framing_extras_;
+    }
+
+    const std::vector<std::uint8_t>& extras()
+    {
+        static std::vector<std::uint8_t> empty;
+        return empty;
+    }
+
+    const std::vector<std::uint8_t>& value()
+    {
+        return content_;
+    }
+
+    std::size_t size()
+    {
+        return framing_extras_.size() + key_.size() + content_.size();
+    }
+};
+
+} // namespace couchbase::protocol