couchbase 3.0.0.alpha.4 → 3.0.0.alpha.5

data/ext/couchbase/operations/document_touch.hxx

@@ -25,6 +25,7 @@ namespace couchbase::operations
 
 struct touch_response {
     document_id id;
+    std::uint32_t opaque;
     std::error_code ec{};
     std::uint64_t cas{};
 };
@@ -51,7 +52,7 @@ struct touch_request {
 touch_response
 make_response(std::error_code ec, touch_request& request, touch_request::encoded_response_type encoded)
 {
-    touch_response response{ request.id, ec };
+    touch_response response{ request.id, encoded.opaque(), ec };
     if (!ec) {
         response.cas = encoded.cas();
     }

data/ext/couchbase/operations/document_unlock.hxx

@@ -25,6 +25,7 @@ namespace couchbase::operations
 
 struct unlock_response {
     document_id id;
+    std::uint32_t opaque;
     std::error_code ec{};
     std::uint64_t cas{};
 };
@@ -51,7 +52,7 @@ struct unlock_request {
 unlock_response
 make_response(std::error_code ec, unlock_request& request, unlock_request::encoded_response_type encoded)
 {
-    unlock_response response{ request.id, ec };
+    unlock_response response{ request.id, encoded.opaque(), ec };
     if (!ec) {
         response.cas = encoded.cas();
     }

data/ext/couchbase/operations/document_upsert.hxx

@@ -26,6 +26,7 @@ namespace couchbase::operations
 
 struct upsert_response {
     document_id id;
+    std::uint32_t opaque;
     std::error_code ec{};
     std::uint64_t cas{};
     mutation_token token{};
@@ -62,7 +63,7 @@ struct upsert_request {
 upsert_response
 make_response(std::error_code ec, upsert_request& request, upsert_request::encoded_response_type encoded)
 {
-    upsert_response response{ request.id, ec };
+    upsert_response response{ request.id, encoded.opaque(), ec };
     if (!ec) {
         response.cas = encoded.cas();
         response.token = encoded.body().token();

data/ext/couchbase/operations/document_view.hxx

@@ -162,6 +162,7 @@ struct document_view_request {
             body["keys"] = keys_array;
         }
 
+        encoded.type = type;
         encoded.method = "POST";
         encoded.headers["content-type"] = "application/json";
         encoded.path = fmt::format("/{}/_design/{}{}/_view/{}?{}",
@@ -193,7 +194,7 @@ make_response(std::error_code ec, document_view_request& request, document_view_
             if (rows != nullptr && rows->is_array()) {
                 for (const auto& entry : rows->get_array()) {
                     document_view_response::row row{};
-                    const auto *id = entry.find("id");
+                    const auto* id = entry.find("id");
                     if (id != nullptr && id->is_string()) {
                         row.id = id->get_string();
                     }

data/ext/couchbase/operations/view_index_get_all.hxx

@@ -87,7 +87,7 @@ make_response(std::error_code ec, view_index_get_all_request& request, view_inde
                         continue;
                     }
 
-                    const auto *json = dd->find("json");
+                    const auto* json = dd->find("json");
                     if (json == nullptr || !json->is_object()) {
                         continue;
                     }

data/ext/couchbase/protocol/client_opcode.hxx

@@ -17,11 +17,10 @@
 
 #pragma once
 
+#include <io/mcbp_message.hxx>
+
 namespace couchbase::protocol
 {
-static const size_t header_size = 24;
-using header_buffer = std::array<std::uint8_t, header_size>;
-
 enum class client_opcode : uint8_t {
     get = 0x00,
     upsert = 0x01,
@@ -54,6 +53,7 @@ enum class client_opcode : uint8_t {
  */
 enum class subdoc_opcode : uint8_t {
     get_doc = 0x00,
+    set_doc = 0x01,
     get = 0xc5,
     exists = 0xc6,
     dict_add = 0xc7,
@@ -118,6 +118,7 @@ is_valid_subdoc_opcode(uint8_t code)
         case subdoc_opcode::counter:
         case subdoc_opcode::get_count:
         case subdoc_opcode::get_doc:
+        case subdoc_opcode::set_doc:
             return true;
     }
     return false;
@@ -254,6 +255,9 @@ struct fmt::formatter : formatter
             case couchbase::protocol::subdoc_opcode::get_doc:
                 name = "get_doc";
                 break;
+            case couchbase::protocol::subdoc_opcode::set_doc:
+                name = "set_doc";
+                break;
         }
         return formatter<string_view>::format(name, ctx);
     }

data/ext/couchbase/protocol/client_response.hxx

@@ -60,7 +60,7 @@ class client_response
     client_response() = default;
     explicit client_response(io::mcbp_message& msg)
     {
-        std::memcpy(header_.data(), &msg.header, sizeof(msg.header));
+        header_ = msg.header_data();
         data_ = std::move(msg.body);
         verify_header();
         parse_body();

data/ext/couchbase/protocol/cmd_hello.hxx

@@ -99,6 +99,16 @@ class hello_request_body
         key_ = std::move(val);
     }
 
+    [[nodiscard]] const std::string& user_agent() const
+    {
+        return key_;
+    }
+
+    [[nodiscard]] const std::vector<hello_feature>& features() const
+    {
+        return features_;
+    }
+
     const std::string& key()
     {
         return key_;

data/ext/couchbase/protocol/cmd_lookup_in.hxx

@@ -100,6 +100,7 @@ class lookup_in_request_body
             std::uint8_t opcode;
             std::uint8_t flags;
             std::string path;
+            std::size_t original_index{};
         };
         std::vector<entry> entries;
 

data/ext/couchbase/protocol/cmd_mutate_in.hxx

@@ -116,7 +116,26 @@ class mutate_in_request_body
     using response_body_type = mutate_in_response_body;
     static const inline client_opcode opcode = client_opcode::subdoc_multi_mutation;
 
-    static const inline uint8_t doc_flag_access_deleted = 0x04;
+    enum class store_semantics_type {
+        /**
+         * Replace the document, fail if it does not exist. This is the default.
+         */
+        replace,
+
+        /**
+         * Replace the document or create it if it does not exist.
+         */
+        upsert,
+
+        /**
+         * Replace the document or create it if it does not exist.
+         */
+        insert,
+    };
+
+    static const inline uint8_t doc_flag_access_deleted = 0b0000'0100;
+    static const inline uint8_t doc_flag_mkdoc = 0b0000'0001;
+    static const inline uint8_t doc_flag_add = 0b0000'0010;
 
     struct mutate_in_specs {
         static const inline uint8_t path_flag_create_parents = 0x01;
@@ -128,6 +147,7 @@ class mutate_in_request_body
             std::uint8_t flags;
             std::string path;
             std::string param;
+            std::size_t original_index{};
         };
         std::vector<entry> entries;
 
@@ -188,6 +208,7 @@ class mutate_in_request_body
     std::vector<std::uint8_t> extras_{};
     std::vector<std::uint8_t> value_{};
 
+    std::uint32_t expiration_{ 0 };
     std::uint8_t flags_{ 0 };
     mutate_in_specs specs_;
     std::vector<std::uint8_t> framing_extras_{};
@@ -202,12 +223,33 @@ class mutate_in_request_body
         }
     }
 
+    void expiration(uint32_t value)
+    {
+        expiration_ = value;
+    }
+
     void access_deleted(bool value)
     {
         if (value) {
-            flags_ = doc_flag_access_deleted;
+            flags_ |= doc_flag_access_deleted;
         } else {
-            flags_ = 0;
+            flags_ &= static_cast<std::uint8_t>(~doc_flag_access_deleted);
+        }
+    }
+
+    void store_semantics(store_semantics_type semantics)
+    {
+        flags_ &= 0b1111'1100; /* reset first two bits */
+        switch (semantics) {
+            case store_semantics_type::replace:
+                /* leave bits as zeros */
+                break;
+            case store_semantics_type::upsert:
+                flags_ |= doc_flag_mkdoc;
+                break;
+            case store_semantics_type::insert:
+                flags_ |= doc_flag_add;
+                break;
         }
     }
 
@@ -275,9 +317,15 @@ class mutate_in_request_body
   private:
     void fill_extention()
     {
+        if (expiration_ != 0) {
+            extras_.resize(sizeof(expiration_));
+            std::uint32_t field = htonl(expiration_);
+            memcpy(extras_.data(), &field, sizeof(field));
+        }
         if (flags_ != 0) {
-            extras_.resize(sizeof(flags_));
-            extras_[0] = flags_;
+            std::size_t offset = extras_.size();
+            extras_.resize(offset + sizeof(flags_));
+            extras_[offset] = flags_;
         }
     }
 

data/ext/couchbase/version.hxx

@@ -18,7 +18,7 @@
 #pragma once
 
 #define BACKEND_VERSION_MAJOR 0
-#define BACKEND_VERSION_MINOR 4
+#define BACKEND_VERSION_MINOR 5
 #define BACKEND_VERSION_PATCH 0
 
 #include <build_version.hxx>

data/ext/extconf.rb

@@ -29,7 +29,7 @@ unless openssl_root.empty?
 end
 
 project_path = File.expand_path(File.join(__dir__))
-build_dir = File.join(Dir.tmpdir, "couchbase-rubygem-#{build_type}-#{RUBY_VERSION}-#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}")
+build_dir = ENV['EXT_BUILD_DIR'] || File.join(Dir.tmpdir, "couchbase-rubygem-#{build_type}-#{RUBY_VERSION}-#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}")
 FileUtils.mkdir_p(build_dir)
 Dir.chdir(build_dir) do
   sys("cmake", *cmake_flags, project_path)

data/lib/couchbase/bucket.rb

@@ -19,6 +19,9 @@ require "couchbase/view_options"
 
 module Couchbase
   class Bucket
+    # @return [String] name of the bucket
+    attr_reader :name
+
     alias_method :inspect, :to_s
 
     # @param [Couchbase::Backend] backend

data/lib/couchbase/cluster.rb

@@ -39,6 +39,11 @@ module Couchbase
       Cluster.new(connection_string, options)
     end
 
+    # Returns an instance of the {Bucket}
+    #
+    # @param [String] name name of the bucket
+    #
+    # @return [Bucket]
     def bucket(name)
       Bucket.new(@backend, name)
     end

data/lib/couchbase/collection.rb

@@ -255,10 +255,12 @@ module Couchbase
         res.encoded = resp[:fields].map do |field|
           SubDocumentField.new do |f|
             f.exists = field[:exists]
+            f.index = field[:index]
             f.path = field[:path]
             f.status = field[:status]
+            f.error = field[:error]
             f.value = field[:value]
-            f.type = field[:opcode]
+            f.type = field[:type]
           end
         end
       end
@@ -273,7 +275,7 @@ module Couchbase
     # @return [MutateInResult]
     def mutate_in(id, specs, options = MutateInOptions.new)
       resp = @backend.document_mutate_in(
-          bucket_name, "#{@scope_name}.#{@name}", id, options.timeout, options.access_deleted,
+          bucket_name, "#{@scope_name}.#{@name}", id, options.timeout,
           specs.map { |s|
             {
                 opcode: s.type,
@@ -281,14 +283,18 @@ module Couchbase
                 param: s.param,
                 xattr: s.xattr?,
                 expand_macros: s.expand_macros?,
-                create_parents: s.create_parents?
+                create_path: s.create_path?
             }
           },
           {
-              durability_level: options.durability_level
+              durability_level: options.durability_level,
+              store_semantics: options.store_semantics,
+              access_deleted: options.access_deleted,
+              cas: options.cas,
+              expiration: options.expiration,
           }
       )
-      MutateInResult.new do |res|
+      res = MutateInResult.new do |res|
         res.transcoder = options.transcoder
         res.cas = resp[:cas]
         res.mutation_token = extract_mutation_token(resp)
@@ -298,11 +304,17 @@ module Couchbase
             f.exists = field[:exists]
             f.path = field[:path]
             f.status = field[:status]
+            f.error = field[:error]
             f.value = field[:value]
-            f.type = field[:opcode]
+            f.type = field[:type]
           end
         end
       end
+      if res.success?
+        res
+      else
+        raise res.first_error
+      end
     end
 
     private

data/lib/couchbase/collection_options.rb

@@ -292,7 +292,7 @@ module Couchbase
       #
       # @return [Object] the decoded
       def content(index, transcoder = self.transcoder)
-        transcoder.decode(encoded[index].value, :json)
+        transcoder.decode(get_field_at_index(index).value, :json)
       end
 
       # Allows to check if a value at the given index exists
@@ -301,7 +301,7 @@ module Couchbase
       #
       # @return [Boolean] true if a value is present at the index, false otherwise
       def exists?(index)
-        encoded[index].exists
+        encoded[index]&.exists
       end
 
       # @return [Array<SubDocumentField>] holds the encoded subdocument responses
@@ -314,6 +314,18 @@ module Couchbase
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
+
+      private
+
+      def get_field_at_index(index)
+        if index >= 0 && index < encoded.size
+          field = encoded[index]
+          raise field.error unless field.success?
+          field
+        else
+          raise Error::PathInvalid, "Index is out of bounds: #{index}"
+        end
+      end
     end
 
     class MutateInOptions < CommonOptions
@@ -359,7 +371,12 @@ module Couchbase
       #
       # @return [Object] the decoded
       def content(index, transcoder = self.transcoder)
-        transcoder.decode(encoded[index].value, :json)
+        field = get_field_at_index(index)
+        if field.type == :counter
+          field.value
+        else
+          transcoder.decode(field.value, :json)
+        end
       end
 
       # @yieldparam [MutateInResult] self
@@ -368,7 +385,11 @@ module Couchbase
       end
 
       def success?
-        !!first_error_index
+        first_error_index.nil?
+      end
+
+      def first_error
+        encoded[first_error_index].error
       end
 
       # @return [Array<SubDocumentField>] holds the encoded subdocument responses
@@ -379,18 +400,31 @@ module Couchbase
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
+
+      private
+
+      def get_field_at_index(index)
+        if index >= 0 && index < encoded.size
+          field = encoded[index]
+          raise field.error unless field.success?
+          field
+        else
+          raise Error::PathInvalid, "Index is out of bounds: #{index}"
+        end
+      end
     end
 
-# @api private
+    # @api private
     class SubDocumentField
-      attr_accessor :error
-
       # @return [Boolean] true if the path exists in the document
       attr_accessor :exists
 
       # @return [String] value
       attr_accessor :value
 
+      # @return [Integer] index
+      attr_accessor :index
+
       # @return [String] path
       attr_accessor :path
 
@@ -438,10 +472,19 @@ module Couchbase
       # @return [Symbol]
       attr_accessor :status
 
+      # @return [nil, Exception]
+      attr_accessor :error
+
       # @yieldparam [SubDocumentField] self
       def initialize
+        @status = :unknown
         yield self if block_given?
       end
+
+      # @return [Boolean] true if the path does not have associated error
+      def success?
+        status == :success
+      end
     end
   end
 end