couchbase 3.7.0 → 3.8.0

data/lib/couchbase/datastructures/couchbase_list.rb

@@ -37,6 +37,7 @@ module Couchbase
         @collection = collection
         @options = options
         @cas = 0
+        @observability = @collection.instance_variable_get(:@observability)
       end
 
       # Calls the given block once for each element in the list, passing that element as a parameter.
@@ -44,38 +45,45 @@ module Couchbase
       # @yieldparam [Object] item
       #
       # @return [CouchbaseList, Enumerable]
-      def each(&)
+      def each(parent_span: nil, &)
         if block_given?
-          begin
-            result = @collection.get(@id, @options.get_options)
-            current = result.content
-            @cas = result.cas
-          rescue Error::DocumentNotFound
-            current = []
-            @cas = 0
-          end
+          current =
+            @observability.record_operation(Observability::OP_LIST_EACH, parent_span, self) do |obs_handler|
+              options = @options.get_options.clone
+              options.parent_span = obs_handler.op_span
+              result = @collection.get(@id, options)
+              @cas = result.cas
+              result.content
+            rescue Error::DocumentNotFound
+              @cas = 0
+              []
+            end
           current.each(&)
           self
         else
-          enum_for(:each)
+          enum_for(:each, parent_span: parent_span)
         end
       end
 
       # @return [Integer] returns the number of elements in the list.
-      def length
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.count(""),
-                                       ], @options.lookup_in_options)
-        result.content(0)
-      rescue Error::DocumentNotFound
-        0
+      def length(parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_LENGTH, parent_span, self) do |obs_handler|
+          options = @options.lookup_in_options.clone
+          options.parent_span = obs_handler.op_span
+          result = @collection.lookup_in(@id, [
+                                           LookupInSpec.count(""),
+                                         ], options)
+          result.content(0)
+        rescue Error::DocumentNotFound
+          0
+        end
       end
 
       alias size length
 
       # @return [Boolean] returns true if list is empty
-      def empty?
-        size.zero?
+      def empty?(parent_span: nil)
+        size(parent_span: parent_span).zero?
       end
 
       # Appends the given object(s) on to the end of this error. This expression returns the array itself, so several
@@ -83,10 +91,14 @@ module Couchbase
       #
       # @param [Object...] obj object(s) to append
       # @return [CouchbaseList]
-      def push(*obj)
-        @collection.mutate_in(@id, [
-                                MutateInSpec.array_append("", obj),
-                              ], @options.mutate_in_options)
+      def push(*obj, parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_PUSH, parent_span, self) do |obs_handler|
+          options = @options.mutate_in_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.array_append("", obj),
+                                ], options)
+        end
         self
       end
 
@@ -96,10 +108,14 @@ module Couchbase
       #
       # @param [Object...] obj object(s) to prepend
       # @return [CouchbaseList]
-      def unshift(*obj)
-        @collection.mutate_in(@id, [
-                                MutateInSpec.array_prepend("", obj),
-                              ], @options.mutate_in_options)
+      def unshift(*obj, parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_UNSHIFT, parent_span, self) do |obs_handler|
+          options = @options.mutate_in_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.array_prepend("", obj),
+                                ], options)
+        end
         self
       end
 
@@ -110,10 +126,14 @@ module Couchbase
       # @param [Integer] index
       # @param [Object...] obj object(s) to insert
       # @return [CouchbaseList]
-      def insert(index, *obj)
-        @collection.mutate_in(@id, [
-                                MutateInSpec.array_insert("[#{index.to_i}]", obj),
-                              ])
+      def insert(index, *obj, parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_INSERT, parent_span, self) do |obs_handler|
+          options = @options.mutate_in_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.array_insert("[#{index.to_i}]", obj),
+                                ])
+        end
         self
       end
 
@@ -121,13 +141,17 @@ module Couchbase
       #
       # @param [Integer] index
       # @return [Object, nil]
-      def at(index)
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.get("[#{index.to_i}]"),
-                                       ], @options.lookup_in_options)
-        result.exists?(0) ? result.content(0) : nil
-      rescue Error::DocumentNotFound
-        nil
+      def at(index, parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_AT, parent_span, self) do |obs_handler|
+          options = @options.mutate_in_options.clone
+          options.parent_span = obs_handler.op_span
+          result = @collection.lookup_in(@id, [
+                                           LookupInSpec.get("[#{index.to_i}]"),
+                                         ], options)
+          result.exists?(0) ? result.content(0) : nil
+        rescue Error::DocumentNotFound
+          nil
+        end
       end
 
       alias [] at
@@ -136,21 +160,28 @@ module Couchbase
       #
       # @param [Integer] index
       # @return [CouchbaseList]
-      def delete_at(index)
-        @collection.mutate_in(@id, [
-                                MutateInSpec.remove("[#{index.to_i}]"),
-                              ])
-        self
-      rescue Error::DocumentNotFound
-        self
+      def delete_at(index, parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_DELETE_AT, parent_span, self) do |obs_handler|
+          options = Options::MutateIn.new(parent_span: obs_handler.op_span)
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.remove("[#{index.to_i}]"),
+                                ], options)
+          self
+        rescue Error::DocumentNotFound
+          self
+        end
       end
 
       # Removes all elements from the list
-      def clear
-        @collection.remove(@id, @options.remove_options)
-        nil
-      rescue Error::DocumentNotFound
-        nil
+      def clear(parent_span: nil)
+        @observability.record_operation(Observability::OP_LIST_CLEAR, parent_span, self) do |obs_handler|
+          options = @options.remove_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.remove(@id, options)
+          nil
+        rescue Error::DocumentNotFound
+          nil
+        end
       end
     end
 

data/lib/couchbase/datastructures/couchbase_map.rb

@@ -37,6 +37,7 @@ module Couchbase
         @collection = collection
         @options = options
         @cas = 0
+        @observability = collection.instance_variable_get(:@observability)
       end
 
       # Calls the given block once for each element in the map, passing that element as a parameter.
@@ -44,46 +45,57 @@ module Couchbase
       # @yieldparam [Object] item
       #
       # @return [CouchbaseMap, Enumerable]
-      def each(&)
+      def each(parent_span: nil, &)
         if block_given?
-          begin
-            result = @collection.get(@id, @options.get_options)
-            current = result.content
-            @cas = result.cas
-          rescue Error::DocumentNotFound
-            current = []
-            @cas = 0
-          end
+          current =
+            @observability.record_operation(Observability::OP_MAP_EACH, parent_span, self) do |obs_handler|
+              options = @options.get_options.clone
+              options.parent_span = obs_handler.op_span
+              result = @collection.get(@id, options)
+              @cas = result.cas
+              result.content
+            rescue Error::DocumentNotFound
+              @cas = 0
+              []
+            end
           current.each(&)
           self
         else
-          enum_for(:each)
+          enum_for(:each, parent_span: parent_span)
         end
       end
 
       # @return [Integer] returns the number of elements in the map.
-      def length
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.count(""),
-                                       ], @options.lookup_in_options)
-        result.content(0)
-      rescue Error::DocumentNotFound
-        0
+      def length(parent_span: nil)
+        @observability.record_operation(Observability::OP_MAP_LENGTH, parent_span, self) do |obs_handler|
+          options = @options.lookup_in_options.clone
+          options.parent_span = obs_handler.op_span
+          result = @collection.lookup_in(@id, [
+                                           LookupInSpec.count(""),
+                                         ], options)
+          result.content(0)
+        rescue Error::DocumentNotFound
+          0
+        end
       end
 
       alias size length
 
       # @return [Boolean] returns true if map is empty
-      def empty?
-        size.zero?
+      def empty?(parent_span: nil)
+        size(parent_span: parent_span).zero?
       end
 
       # Removes all elements from the map
-      def clear
-        @collection.remove(@id, @options.remove_options)
-        nil
-      rescue Error::DocumentNotFound
-        nil
+      def clear(parent_span: nil)
+        @observability.record_operation(Observability::OP_MAP_CLEAR, parent_span, self) do |obs_handler|
+          options = @options.remove_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.remove(@id, options)
+          nil
+        rescue Error::DocumentNotFound
+          nil
+        end
       end
 
       # Returns a value from the map for the given key.
@@ -109,16 +121,20 @@ module Couchbase
       #   @yieldreturn [Object] the default value to return in case the key could not be found
       #
       # @return [Object]
-      def fetch(key, *rest)
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.get(key),
-                                       ], @options.lookup_in_options)
-        result.content(0)
-      rescue Error::DocumentNotFound, Error::PathNotFound
-        return yield if block_given?
-        return rest.first unless rest.empty?
-
-        raise KeyError, "key not found: #{key}"
+      def fetch(key, *rest, parent_span: nil)
+        @observability.record_operation(Observability::OP_MAP_FETCH, parent_span, self) do |obs_handler|
+          options = @options.lookup_in_options.clone
+          options.parent_span = obs_handler.op_span
+          result = @collection.lookup_in(@id, [
+                                           LookupInSpec.get(key),
+                                         ], options)
+          result.content(0)
+        rescue Error::DocumentNotFound, Error::PathNotFound
+          return yield if block_given?
+          return rest.first unless rest.empty?
+
+          raise KeyError, "key not found: #{key}"
+        end
       end
 
       # Returns a value from the map for the given key.
@@ -132,6 +148,22 @@ module Couchbase
         fetch(key, nil)
       end
 
+      # Associate the value given by +value+ with the key given by +key+.
+      #
+      # @param [String] key
+      # @param [Object] value
+      #
+      # @return [void]
+      def store(key, value, parent_span: nil)
+        @observability.record_operation(Observability::OP_MAP_STORE, parent_span, self) do |obs_handler|
+          options = @options.mutate_in_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.upsert(key, value),
+                                ], options)
+        end
+      end
+
       # Associate the value given by +value+ with the key given by +key+.
       #
       # @param [String] key
@@ -139,9 +171,7 @@ module Couchbase
       #
       # @return [void]
       def []=(key, value)
-        @collection.mutate_in(@id, [
-                                MutateInSpec.upsert(key, value),
-                              ], @options.mutate_in_options)
+        store(key, value)
       end
 
       # Deletes the key-value pair from the map.
@@ -149,25 +179,31 @@ module Couchbase
       # @param [String] key
       #
       # @return void
-      def delete(key)
-        @collection.mutate_in(@id, [
-                                MutateInSpec.remove(key),
-                              ])
-      rescue Error::DocumentNotFound, Error::PathNotFound
-        nil
+      def delete(key, parent_span: nil)
+        @observability.record_operation(Observability::OP_MAP_DELETE, parent_span, self) do |obs_handler|
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.remove(key),
+                                ], Options::MutateIn.new(parent_span: obs_handler.op_span))
+        rescue Error::DocumentNotFound, Error::PathNotFound
+          nil
+        end
       end
 
       # Returns +true+ if the given key is present
       #
       # @param [String] key
       # @return [Boolean]
-      def key?(key)
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.exists(key),
-                                       ], @options.lookup_in_options)
-        result.exists?(0)
-      rescue Error::DocumentNotFound, Error::PathNotFound
-        false
+      def key?(key, parent_span: nil)
+        @observability.record_operation(Observability::OP_MAP_KEY_EXISTS, parent_span, self) do |obs_handler|
+          options = @options.lookup_in_options.clone
+          options.parent_span = obs_handler.op_span
+          result = @collection.lookup_in(@id, [
+                                           LookupInSpec.exists(key),
+                                         ], options)
+          result.exists?(0)
+        rescue Error::DocumentNotFound, Error::PathNotFound
+          false
+        end
       end
 
       alias member? key?

data/lib/couchbase/datastructures/couchbase_queue.rb

@@ -37,6 +37,7 @@ module Couchbase
         @collection = collection
         @options = options
         @cas = 0
+        @observability = @collection.instance_variable_get(:@observability)
       end
 
       # Calls the given block once for each element in the queue, passing that element as a parameter.
@@ -44,57 +45,69 @@ module Couchbase
       # @yieldparam [Object] item
       #
       # @return [CouchbaseQueue, Enumerable]
-      def each(&)
+      def each(parent_span: nil, &)
         if block_given?
-          begin
-            result = @collection.get(@id, @options.get_options)
-            current = result.content
+          current = @observability.record_operation(Observability::OP_QUEUE_EACH, parent_span, self) do |obs_handler|
+            options = @options.get_options.clone
+            options.parent_span = obs_handler.op_span
+            result = @collection.get(@id, options)
             @cas = result.cas
+            result.content
           rescue Error::DocumentNotFound
-            current = []
             @cas = 0
+            []
           end
           current.each(&)
           self
         else
-          enum_for(:each)
+          enum_for(:each, parent_span: parent_span)
         end
       end
 
       # @return [Integer] returns the number of elements in the queue.
-      def length
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.count(""),
-                                       ], @options.lookup_in_options)
-        result.content(0)
-      rescue Error::DocumentNotFound
-        0
+      def length(parent_span: nil)
+        @observability.record_operation(Observability::OP_QUEUE_LENGTH, parent_span, self) do |obs_handler|
+          options = @options.lookup_in_options.clone
+          options.parent_span = obs_handler.op_span
+          result = @collection.lookup_in(@id, [
+                                           LookupInSpec.count(""),
+                                         ], options)
+          result.content(0)
+        rescue Error::DocumentNotFound
+          0
+        end
       end
 
       alias size length
 
       # @return [Boolean] returns true if queue is empty
-      def empty?
-        size.zero?
+      def empty?(parent_span: nil)
+        size(parent_span: parent_span).zero?
       end
 
       # Removes all elements from the queue
-      def clear
-        @collection.remove(@id, @options.remove_options)
-        nil
-      rescue Error::DocumentNotFound
-        nil
+      def clear(parent_span: nil)
+        @observability.record_operation(Observability::OP_QUEUE_CLEAR, parent_span, self) do |obs_handler|
+          options = @options.remove_options.clone
+          options.parent_span = obs_handler.op_span
+          @collection.remove(@id, options)
+          nil
+        rescue Error::DocumentNotFound
+          nil
+        end
       end
 
       # Adds the given value to the queue
       #
       # @param [Object] obj
       # @return [CouchbaseQueue]
-      def push(obj)
-        begin
+      def push(obj, parent_span: nil)
+        @observability.record_operation(Observability::OP_QUEUE_PUSH, parent_span, self) do |obs_handler|
+          options = @options.mutate_in_options.clone
+          options.parent_span = obs_handler.op_span
           @collection.mutate_in(@id, [
                                   MutateInSpec.array_prepend("", [obj]),
-                                ], @options.mutate_in_options)
+                                ], options)
         rescue Error::PathExists
           # ignore
         end
@@ -107,21 +120,34 @@ module Couchbase
       # Retrieves object from the queue
       #
       # @return [Object, nil] queue entry or nil
-      def pop
-        result = @collection.lookup_in(@id, [
-                                         LookupInSpec.get("[-1]"),
-                                       ], @options.lookup_in_options)
-        obj = result.exists?(0) ? result.content(0) : nil
-        options = Options::MutateIn.new
-        options.cas = result.cas
-        @collection.mutate_in(@id, [
-                                MutateInSpec.remove("[-1]"),
-                              ], options)
-        obj
-      rescue Error::CasMismatch
-        retry
-      rescue Error::DocumentNotFound, Error::PathNotFound
-        nil
+      def pop(parent_span: nil)
+        @observability.record_operation(Observability::OP_QUEUE_POP, parent_span, self) do |obs_handler|
+          obj, cas = begin
+            options = @options.lookup_in_options.clone
+            options.parent_span = obs_handler.op_span
+            result = @collection.lookup_in(@id, [
+                                             LookupInSpec.get("[-1]"),
+                                           ], @options.lookup_in_options)
+            [
+              result.exists?(0) ? result.content(0) : nil,
+              result.cas,
+            ]
+          end
+          begin
+            options = Options::MutateIn.new(
+              parent_span: obs_handler.op_span,
+              cas: cas,
+            )
+            @collection.mutate_in(@id, [
+                                    MutateInSpec.remove("[-1]"),
+                                  ], options)
+          end
+          obj
+        rescue Error::CasMismatch
+          retry
+        rescue Error::DocumentNotFound, Error::PathNotFound
+          nil
+        end
       end
 
       alias deq pop