couchbase 3.0.0.alpha.5 → 3.0.3

data/lib/couchbase/datastructures/couchbase_set.rb

@@ -0,0 +1,128 @@
+#    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.
+
+require "couchbase/collection"
+require "couchbase/options"
+require "couchbase/errors"
+
+module Couchbase
+  module Datastructures
+    # A {CouchbaseSet} is implements +Enumerable+ interface and backed by {Collection} document (more specifically
+    # a JSON array).
+    #
+    # Note: sets are restricted to containing primitive types only due to server-side comparison restrictions.
+    class CouchbaseSet
+      include Enumerable
+
+      # Create a new List, backed by the document identified by +id+ in +collection+.
+      #
+      # @param [String] id the id of the document to back the set.
+      # @param [Collection] collection the collection through which to interact with the document.
+      # @param [Options::CouchbaseSet] options customization of the datastructure
+      def initialize(id, collection, options = Options::CouchbaseSet.new)
+        @id = id
+        @collection = collection
+        @options = options
+        @cas = 0
+      end
+
+      # Calls the given block once for each element in the set, passing that element as a parameter.
+      #
+      # @yieldparam [Object] item
+      #
+      # @return [CouchbaseSet, Enumerable]
+      def each
+        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.each do |entry|
+            yield entry
+          end
+          self
+        else
+          enum_for(:each)
+        end
+      end
+
+      # @return [Integer] returns the number of elements in the set.
+      def length
+        result = @collection.lookup_in(@id, [
+                                         LookupInSpec.count(""),
+                                       ], @options.lookup_in_options)
+        result.content(0)
+      rescue Error::DocumentNotFound
+        0
+      end
+
+      alias size length
+
+      # @return [Boolean] returns true if set is empty
+      def empty?
+        size.zero?
+      end
+
+      # Adds the given value to the set
+      #
+      # @param [Object] obj
+      # @return [CouchbaseSet]
+      def add(obj)
+        begin
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.array_add_unique("", obj),
+                                ], @options.mutate_in_options)
+        rescue Error::PathExists
+          # ignore
+        end
+        self
+      end
+
+      # Removes all elements from the set
+      def clear
+        @collection.remove(@id, @options.remove_options)
+        nil
+      rescue Error::DocumentNotFound
+        nil
+      end
+
+      # Deletes the given object from the set.
+      #
+      # @return [Boolean] true if the value has been removed
+      def delete(obj)
+        result = @collection.get(@id)
+        idx = result.content.index(obj)
+        return false unless idx
+
+        options = Collection::MutateInOptions.new
+        options.cas = result.cas
+        @collection.mutate_in(@id, [
+                                MutateInSpec.remove("[#{idx}]"),
+                              ], options)
+        true
+      rescue Error::CasMismatch
+        retry
+      rescue Error::DocumentNotFound
+        false
+      end
+    end
+
+    # @api private
+    CouchbaseSetOptions = ::Couchbase::Options::CouchbaseSet
+  end
+end

data/lib/couchbase/diagnostics.rb

@@ -0,0 +1,181 @@
+#    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.
+
+module Couchbase
+  class DiagnosticsResult
+    class ServiceInfo
+      # @return [String] endpoint unique identifier
+      attr_accessor :id
+
+      # Possible states are:
+      #
+      # :disconnected:: the endpoint is not reachable
+      # :connecting:: currently connecting (includes auth, handshake, etc.)
+      # :connected:: connected and ready
+      # :disconnecting:: disconnecting (after being connected)
+      #
+      # @return [Symbol] state of the endpoint
+      attr_accessor :state
+
+      # @return [String, nil] optional string with additional explanation for the state
+      attr_accessor :details
+
+      # @return [Integer] how long ago the endpoint was active (in microseconds)
+      attr_accessor :last_activity_us
+
+      # @return [String] remote address of the connection
+      attr_accessor :remote
+
+      # @return [String] local address of the connection
+      attr_accessor :local
+
+      # @yieldparam [ServiceInfo] self
+      def initialize
+        yield self if block_given?
+      end
+
+      def to_json(*args)
+        data = {
+          id: @id,
+          state: @state,
+          remote: @remote,
+          local: @local,
+        }
+        data[:details] = @details if @details
+        data[:last_activity_us] = @last_activity_us if @last_activity_us
+        data.to_json(*args)
+      end
+    end
+
+    # @return [String] report id
+    attr_accessor :id
+
+    # @return [String] SDK identifier
+    attr_accessor :sdk
+
+    # Returns information about currently service endpoints, that known to the library at the moment.
+    #
+    # :kv:: Key/Value data service
+    # :query:: N1QL query service
+    # :analytics:: Analtyics service
+    # :search:: Full text search service
+    # :views:: Views service
+    # :mgmt:: Management service
+    #
+    # @return [Hash<Symbol, ServiceInfo>] map service types to info
+    attr_accessor :services
+
+    # @yieldparam [DiagnosticsResult] self
+    def initialize
+      @services = {}
+      yield self if block_given?
+    end
+
+    # @api private
+    # @return [Integer] version
+    attr_accessor :version
+
+    def to_json(*args)
+      {
+        version: @version,
+        id: @id,
+        sdk: @sdk,
+        services: @services,
+      }.to_json(*args)
+    end
+  end
+
+  class PingResult
+    class ServiceInfo
+      # @return [String] endpoint unique identifier
+      attr_accessor :id
+
+      # Possible states are:
+      #
+      # :ok:: endpoint is healthy
+      # :timeout:: endpoint didn't respond in time
+      # :error:: request to endpoint has failed, see {#error} for additional details
+      #
+      # @return [Symbol] state of the endpoint
+      attr_accessor :state
+
+      # @return [String, nil] optional string with additional explanation for the state
+      attr_accessor :error
+
+      # @return [Integer] how long ago the endpoint was active (in microseconds)
+      attr_accessor :latency
+
+      # @return [String] remote address of the connection
+      attr_accessor :remote
+
+      # @return [String] local address of the connection
+      attr_accessor :local
+
+      # @yieldparam [ServiceInfo] self
+      def initialize
+        @error = nil
+        yield self if block_given?
+      end
+
+      def to_json(*args)
+        data = {
+          id: @id,
+          state: @state,
+          remote: @remote,
+          local: @local,
+          latency: @latency,
+        }
+        data[:error] = @error if @error
+        data.to_json(*args)
+      end
+    end
+
+    # @return [String] report id
+    attr_accessor :id
+
+    # @return [String] SDK identifier
+    attr_accessor :sdk
+
+    # Returns information about currently service endpoints, that known to the library at the moment.
+    #
+    # :kv:: Key/Value data service
+    # :query:: N1QL query service
+    # :analytics:: Analtyics service
+    # :search:: Full text search service
+    # :views:: Views service
+    # :mgmt:: Management service
+    #
+    # @return [Hash<Symbol, ServiceInfo>] map service types to info
+    attr_accessor :services
+
+    # @yieldparam [DiagnosticsResult] self
+    def initialize
+      @services = {}
+      yield self if block_given?
+    end
+
+    # @api private
+    # @return [Integer] version
+    attr_accessor :version
+
+    def to_json(*args)
+      {
+        version: @version,
+        id: @id,
+        sdk: @sdk,
+        services: @services,
+      }.to_json(*args)
+    end
+  end
+end

data/lib/couchbase/errors.rb

@@ -12,213 +12,334 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "json"
+
 module Couchbase
+  # This namespace contains all error types that the library might raise.
   module Error
-    # Common exceptions
+    class CouchbaseError < StandardError
+      # @return [Hash] attributes associated with the error
+      attr_reader :context
 
-    class RequestCanceled < StandardError
+      def to_s
+        defined?(@context) ? "#{super}, context=#{JSON.generate(@context)}" : super
+      end
     end
 
     class InvalidArgument < ArgumentError
+      # @return [Hash] attributes associated with the error
+      attr_reader :context
+
+      def to_s
+        defined?(@context) ? "#{super}, context=#{JSON.generate(@context)}" : super
+      end
+    end
+
+    # Common exceptions
+
+    class RequestCanceled < CouchbaseError
+    end
+
+    class ServiceNotAvailable < CouchbaseError
     end
 
-    class ServiceNotAvailable < StandardError
+    # Indicates an operation failed because there has been an internal error in the server.
+    class InternalServerFailure < CouchbaseError
     end
 
-    class InternalServerFailure < StandardError
+    # Every exception that has to do with authentication problems should either instantiate or subclass from this type.
+    class AuthenticationFailure < CouchbaseError
     end
 
-    class AuthenticationFailure < StandardError
+    class TemporaryFailure < CouchbaseError
     end
 
-    class TemporaryFailure < StandardError
+    # Indicates an operation failed because parsing of the input returned with an error.
+    class ParsingFailure < CouchbaseError
     end
 
-    class ParsingFailure < StandardError
+    # Indicates an optimistic locking failure.
+    #
+    # The operation failed because the specified compare and swap (CAS) value differs from the document's actual CAS
+    # value. This means the document was modified since the original CAS value was acquired.
+    #
+    # The application should usually respond by fetching a fresh version of the document and repeating the failed
+    # operation.
+    class CasMismatch < CouchbaseError
     end
 
-    class CasMismatch < StandardError
+    class BucketNotFound < CouchbaseError
     end
 
-    class BucketNotFound < StandardError
+    class CollectionNotFound < CouchbaseError
     end
 
-    class CollectionNotFound < StandardError
+    class ScopeNotFound < CouchbaseError
     end
 
-    class ScopeNotFound < StandardError
+    class IndexNotFound < CouchbaseError
     end
 
-    class IndexNotFound < StandardError
+    class IndexExists < CouchbaseError
     end
 
-    class IndexExists < StandardError
+    # Raised when provided content could not be successfully encoded.
+    class EncodingFailure < CouchbaseError
     end
 
-    class EncodingFailure < StandardError
+    # Raised when provided content could not be successfully decoded.
+    class DecodingFailure < CouchbaseError
     end
 
-    class DecodingFailure < StandardError
+    class UnsupportedOperation < CouchbaseError
     end
 
-    class UnsupportedOperation < StandardError
+    # The {Timeout} signals that an operation timed out before it could be completed.
+    #
+    # It is important to understand that the timeout itself is always just the effect an underlying cause, never the
+    # issue itself. The root cause might not even be on the application side, also the network and server need to be
+    # taken into account.
+    #
+    # Right now the SDK can throw two different implementations of this class:
+    #
+    # {AmbiguousTimeout}::
+    #   The operation might have caused a side effect on the server and should not be retried without
+    #   actions and checks.
+    #
+    # {UnambiguousTimeout}::
+    #   The operation has not caused a side effect on the server and is safe to retry. This is always the case for
+    #   idempotent operations. For non-idempotent operations it depends on the state the operation was in at the time of
+    #   cancellation.
+    class Timeout < CouchbaseError
     end
 
-    class AmbiguousTimeout < StandardError
+    # This is a special case of the timeout exception, signaling that the timeout happened with an ambiguous cause.
+    class AmbiguousTimeout < Timeout
     end
 
-    class UnambiguousTimeout < StandardError
+    # This is a special case of the timeout exception, signaling that the timeout happened with no ambiguous cause.
+    class UnambiguousTimeout < Timeout
     end
 
-    class FeatureNotAvailable < StandardError
+    # Exception which states that the feature is not available.
+    class FeatureNotAvailable < CouchbaseError
     end
 
     # KeyValue exceptions
 
-    class DocumentNotFound < StandardError
+    # Indicates an operation failed because the key does not exist.
+    class DocumentNotFound < CouchbaseError
     end
 
-    class DocumentIrretrievable < StandardError
+    # Indicates an operation completed but no successful document was retrievable.
+    class DocumentIrretrievable < CouchbaseError
     end
 
-    class DocumentLocked < StandardError
+    # Thrown when the server reports a temporary failure that is very likely to be lock-related (like an already locked
+    # key or a bad cas used for unlock).
+    #
+    # See https://issues.couchbase.com/browse/MB-13087 for an explanation of why this is only _likely_ to be
+    # lock-related.
+    class DocumentLocked < CouchbaseError
     end
 
-    class ValueTooLarge < StandardError
+    # Thrown when the request is too big for some reason.
+    class ValueTooLarge < CouchbaseError
     end
 
-    class DocumentExists < StandardError
+    # Indicates an operation failed because the key already exists.
+    class DocumentExists < CouchbaseError
     end
 
-    class DurabilityLevelNotAvailable < StandardError
+    # This exception is raised when a durability level has been requested that is not available on the server.
+    class DurabilityLevelNotAvailable < CouchbaseError
     end
 
-    class DurabilityImpossible < StandardError
+    # The given durability requirements are currently impossible to achieve, as not enough configured replicas are
+    # currently available.
+    class DurabilityImpossible < CouchbaseError
     end
 
-    class DurabilityAmbiguous < StandardError
+    # The synchronous replication durability work can return an ambiguous error (or we timeout waiting for the response,
+    # which is effectively the same).  Here we know the change is on a majority of replicas, or it's on none.
+    class DurabilityAmbiguous < CouchbaseError
     end
 
-    class DurableWriteInProgress < StandardError
+    # Returned if an attempt is made to mutate a key which already has a durable write pending.
+    class DurableWriteInProgress < CouchbaseError
     end
 
-    class DurableWriteReCommitInProgress < StandardError
+    # The requested key has a SyncWrite which is being re-committed.
+    class DurableWriteReCommitInProgress < CouchbaseError
     end
 
-    class PathNotFound < StandardError
+    # Subdocument exception thrown when a path does not exist in the document. The exact meaning of path existence
+    # depends on the operation and inputs.
+    class PathNotFound < CouchbaseError
     end
 
-    class PathMismatch < StandardError
+    # Subdocument exception thrown when the path structure conflicts with the document structure (for example, if a
+    # path mentions foo.bar[0].baz, but foo.bar is actually a JSON object).
+    class PathMismatch < CouchbaseError
     end
 
-    class PathInvalid < StandardError
+    # Subdocument exception thrown when path has a syntax error, or path syntax is incorrect for the operation (for
+    # example, if operation requires an array index).
+    class PathInvalid < CouchbaseError
     end
 
-    class PathTooDeep < StandardError
+    # Subdocument exception thrown when path is too deep to parse. Depth of a path is determined by how many components
+    # (or levels) it contains.
+    #
+    # The current limitation is there to ensure a single parse does not consume too much memory (overloading the
+    # server). This error is similar to other TooDeep errors, which all relate to various validation stages to ensure
+    # the server does not consume too much memory when parsing a single document.
+    class PathTooDeep < CouchbaseError
     end
 
-    class PathTooBig < StandardError
+    class PathTooBig < CouchbaseError
     end
 
-    class ValueTooDeep < StandardError
+    # Subdocument exception thrown when proposed value would make the document too deep to parse.
+    #
+    # The current limitation is there to ensure a single parse does not consume too much memory (overloading the
+    # server). This error is similar to other TooDeep errors, which all relate to various validation stages to ensure
+    # the server does not consume too much memory when parsing a single document.
+    class ValueTooDeep < CouchbaseError
     end
 
-    class ValueInvalid < StandardError
+    # Subdocument exception thrown when the provided value cannot be inserted at the given path.
+    #
+    # It is actually thrown when the delta in an counter operation is valid, but applying that delta would
+    # result in an out-of-range number (server interprets numbers as 64-bit integers).
+    class ValueInvalid < CouchbaseError
     end
 
-    class DocumentNotJson < StandardError
+    # Subdocument exception thrown when the targeted enclosing document itself is not JSON.
+    class DocumentNotJson < CouchbaseError
     end
 
-    class NumberTooBig < StandardError
+    # Subdocument exception thrown when existing number value in document is too big.
+    #
+    # The value is interpreted as 64 bit on the server side.
+    class NumberTooBig < CouchbaseError
     end
 
-    class DeltaInvalid < StandardError
+    # Subdocument exception thrown when the delta in an arithmetic operation (eg counter) is invalid. In this SDK, this
+    # is equivalent to saying that the delta is zero.
+    #
+    # Note that the server also returns the corresponding error code when the delta value itself is too big, or not a
+    # number, but since the SDK enforces deltas to be of type long, these cases shouldn't come up.
+    class DeltaInvalid < CouchbaseError
     end
 
-    class PathExists < StandardError
+    # Subdocument exception thrown when a path already exists and it shouldn't
+    class PathExists < CouchbaseError
     end
 
-    class XattrUnknownMacro < StandardError
+    # Subdocument exception thrown when a macro has been requested which is not recognised by the server.
+    class XattrUnknownMacro < CouchbaseError
     end
 
-    class XattrInvalidKeyCombo < StandardError
+    # Subdocument exception thrown when more than one xattr key has been requested.
+    class XattrInvalidKeyCombo < CouchbaseError
     end
 
-    class XattrUnknownVirtualAttribute < StandardError
+    # Subdocument exception thrown when a virtual attribute has been requested which is not recognised by the server.
+    class XattrUnknownVirtualAttribute < CouchbaseError
     end
 
-    class XattrCannotModifyVirtualAttribute < StandardError
+    # Subdocument exception thrown when the virtual attribute cannot be modified.
+    class XattrCannotModifyVirtualAttribute < CouchbaseError
     end
 
     # Query exceptions
 
-    class PlanningFailure < StandardError
+    # Indicates an operation failed because there has been an issue with the query planner.
+    class PlanningFailure < CouchbaseError
     end
 
-    class IndexFailure < StandardError
+    # Indicates an operation failed because there has been an issue with the query planner or similar.
+    class IndexFailure < CouchbaseError
     end
 
-    class PreparedStatementFailure < StandardError
+    # Indicates an operation failed because there has been an issue with query prepared statements.
+    class PreparedStatementFailure < CouchbaseError
     end
 
-
     # Analytics exceptions
 
-    class CompilationFailure < StandardError
+    # The analytics query failed to compile.
+    class CompilationFailure < CouchbaseError
+    end
+
+    # Indicates the analytics server job queue is full
+    class JobQueueFull < CouchbaseError
+    end
+
+    # The queried dataset is not found on the server.
+    class DatasetNotFound < CouchbaseError
     end
 
-    class JobQueueFull < StandardError
+    class DatasetExists < CouchbaseError
     end
 
-    class DatasetNotFound < StandardError
+    class DataverseExists < CouchbaseError
     end
 
-    class DatasetExists < StandardError
+    class DataverseNotFound < CouchbaseError
     end
 
-    class DataverseExists < StandardError
+    class LinkNotFound < CouchbaseError
     end
 
-    class DataverseNotFound < StandardError
+    # Search exceptions
+
+    class IndexNotReady < CouchbaseError
     end
 
-    class LinkNotFound < StandardError
+    class ConsistencyMismatch < CouchbaseError
     end
 
     # View exceptions
 
-    class DesignDocumentNotFound < StandardError
+    class DesignDocumentNotFound < CouchbaseError
     end
 
-    class ViewNotFound < StandardError
+    # The queried view is not found on the server
+    class ViewNotFound < CouchbaseError
     end
 
     # Management exceptions
 
-    class CollectionExists < StandardError
+    class CollectionExists < CouchbaseError
     end
 
-    class ScopeExists < StandardError
+    class ScopeExists < CouchbaseError
     end
 
-    class UserExists < StandardError
+    class UserExists < CouchbaseError
     end
 
-    class BucketExists < StandardError
+    class BucketExists < CouchbaseError
     end
 
-    class BucketNotFlushable < StandardError
+    class BucketNotFlushable < CouchbaseError
     end
 
-    class GroupNotFound < StandardError
+    class GroupNotFound < CouchbaseError
     end
 
-    class UserNotFound < StandardError
+    class UserNotFound < CouchbaseError
     end
 
     # Library-specific exceptions
 
-    class BackendError < StandardError
+    class BackendError < CouchbaseError
+    end
+
+    # Environment name string cannot be determined
+    class NoEnvironment < CouchbaseError
     end
   end
 end