couchbase 3.0.0.alpha.5-x86_64-linux → 3.5.0-x86_64-linux

data/lib/couchbase/protostellar/retry/strategies/best_effort.rb

@@ -0,0 +1,49 @@
+#  Copyright 2023. 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.
+
+# frozen_string_literal: true
+
+module Couchbase
+  module Protostellar
+    module Retry
+      module Strategies
+        class BestEffort
+          attr_reader :backoff_calculator
+
+          def initialize(backoff_calculator = nil)
+            # The default backoff calculator starts with a 1 millisecond backoff and doubles it after each retry
+            # attempt, up to a maximum of 500 milliseconds
+            @backoff_calculator =
+              if backoff_calculator.nil?
+                lambda { |retry_attempt_count| [2**retry_attempt_count, 500].min }
+              else
+                backoff_calculator
+              end
+          end
+
+          def retry_after(request, reason)
+            if request.idempotent || reason.allows_non_idempotent_retry
+              backoff = @backoff_calculator.call(request.retry_attempts)
+              Retry::Action.with_duration(backoff)
+            else
+              Retry::Action.no_retry
+            end
+          end
+
+          DEFAULT = BestEffort.new.freeze
+        end
+      end
+    end
+  end
+end

data/lib/couchbase/protostellar/retry/strategies.rb

@@ -0,0 +1,26 @@
+#  Copyright 2023. 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.
+
+# frozen_string_literal: true
+
+require_relative "strategies/best_effort"
+
+module Couchbase
+  module Protostellar
+    module Retry
+      module Strategies
+      end
+    end
+  end
+end

data/lib/couchbase/protostellar/retry.rb

@@ -0,0 +1,28 @@
+#  Copyright 2023. 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.
+
+# frozen_string_literal: true
+
+require_relative "retry/strategies"
+require_relative "retry/orchestrator"
+require_relative "retry/reason"
+require_relative "retry/action"
+
+module Couchbase
+  module Protostellar
+    # @api private
+    module Retry
+    end
+  end
+end

data/lib/couchbase/protostellar/scope.rb

@@ -0,0 +1,57 @@
+#  Copyright 2023. 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.
+
+# frozen_string_literal: true
+
+require "couchbase/errors"
+require "couchbase/options"
+
+require_relative "request_generator/query"
+require_relative "response_converter/query"
+require_relative "collection"
+
+module Couchbase
+  module Protostellar
+    class Scope
+      attr_reader :bucket_name
+      attr_reader :name
+
+      def initialize(client, bucket_name, name)
+        @client = client
+        @bucket_name = bucket_name
+        @name = name
+
+        @query_request_generator = RequestGenerator::Query.new(bucket_name: @bucket_name, scope_name: @name)
+      end
+
+      def collection(name)
+        Collection.new(@client, @bucket_name, @name, name)
+      end
+
+      def query(statement, options = Couchbase::Options::Query::DEFAULT)
+        req = @query_request_generator.query_request(statement, options)
+        resps = @client.send_request(req)
+        ResponseConverter::Query.to_query_result(resps)
+      end
+
+      def search_query(...)
+        raise Error::FeatureNotAvailable, "scope search not supported in #{Protostellar::NAME} mode"
+      end
+
+      def search(...)
+        raise Error::FeatureNotAvailable, "scope search not supported in #{Protostellar::NAME} mode"
+      end
+    end
+  end
+end

data/lib/couchbase/protostellar/timeout_defaults.rb

@@ -0,0 +1,30 @@
+#  Copyright 2023. 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.
+
+# frozen_string_literal: true
+
+module Couchbase
+  module Protostellar
+    # @api private
+    module TimeoutDefaults
+      KEY_VALUE = 2_500
+      KEY_VALUE_DURABLE = 10_000
+      VIEW = 75_000
+      QUERY = 75_000
+      ANALYTICS = 75_000
+      SEARCH = 75_000
+      MANAGEMENT = 75_000
+    end
+  end
+end

data/lib/couchbase/protostellar/timeouts.rb

@@ -0,0 +1,83 @@
+#  Copyright 2023. 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.
+
+# frozen_string_literal: true
+
+require_relative "timeout_defaults"
+
+module Couchbase
+  module Protostellar
+    # @api private
+    class Timeouts
+      attr_reader :key_value_timeout
+      attr_reader :view_timeout
+      attr_reader :query_timeout
+      attr_reader :analytics_timeout
+      attr_reader :search_timeout
+      attr_reader :management_timeout
+
+      def initialize(
+        key_value_timeout: nil,
+        key_value_durable_timeout: nil,
+        view_timeout: nil,
+        query_timeout: nil,
+        analytics_timeout: nil,
+        search_timeout: nil,
+        management_timeout: nil
+      )
+        @key_value_durable_timeout = key_value_durable_timeout || TimeoutDefaults::KEY_VALUE_DURABLE
+        @key_value_timeout = key_value_timeout || TimeoutDefaults::KEY_VALUE
+        @view_timeout = view_timeout || TimeoutDefaults::VIEW
+        @query_timeout = query_timeout || TimeoutDefaults::QUERY
+        @analytics_timeout = analytics_timeout || TimeoutDefaults::ANALYTICS
+        @search_timeout = search_timeout || TimeoutDefaults::SEARCH
+        @management_timeout = management_timeout || TimeoutDefaults::MANAGEMENT
+      end
+
+      def timeout_for_request(request)
+        case request.service
+        when :analytics
+          @analytics_timeout
+        when :kv
+          if request.proto_request.respond_to?(:durability_level) && request.proto_request.has_durability_level?
+            @key_value_durable_timeout
+          else
+            @key_value_timeout
+          end
+        when :query
+          @query_timeout
+        when :search
+          @search_timeout
+        when :view
+          @view_timeout
+        when :bucket_admin, :collection_admin, :query_admin, :search_admin
+          @management_timeout
+        else
+          raise Couchbase::Error::CouchbaseError, "Service #{service} not recognised"
+        end
+      end
+
+      def self.from_cluster_options(options)
+        Timeouts.new(
+          key_value_timeout: options.key_value_timeout,
+          view_timeout: options.view_timeout,
+          query_timeout: options.query_timeout,
+          analytics_timeout: options.analytics_timeout,
+          search_timeout: options.search_timeout,
+          management_timeout: options.management_timeout
+        )
+      end
+    end
+  end
+end

data/lib/couchbase/{common_options.rb → protostellar.rb}

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  Copyright 2023. Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -12,18 +12,18 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-module Couchbase
-  class CommonOptions
-    # @return [Integer] the time in milliseconds allowed for the operation to complete
-    attr_accessor :timeout
+# frozen_string_literal: true
 
-    # @return [Proc] the custom retry strategy, if set
-    attr_accessor :retry_strategy
+require_relative "protostellar/cluster"
 
-    # @return [Hash] the client context data, if set
-    attr_accessor :client_context
+module Couchbase
+  # @api private
+  module Protostellar
+    NAME = "couchbase2"
+    SCHEMES = %w[couchbase2 protostellar].freeze
 
-    # @return [Span] If set holds the parent span, that should be used for this request
-    attr_accessor :parent_span
+    SCHEMES.each do |s|
+      Couchbase::ClusterRegistry.instance.register_connection_handler(/^#{s}:\/\/.*$/i, Protostellar::Cluster)
+    end
   end
-end
+end

data/lib/couchbase/query_options.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  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.
@@ -12,111 +12,10 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require 'json'
+require "json"
 
 module Couchbase
   class Cluster
-
-    class QueryOptions
-      # @return [Integer] Timeout in milliseconds
-      attr_accessor :timeout
-
-      # @return [Boolean] Allows turning this request into a prepared statement query
-      attr_accessor :adhoc
-
-      # @return [String] Provides a custom client context ID for this query
-      attr_accessor :client_context_id
-
-      # @return [Integer] Allows overriding the default maximum parallelism for the query execution on the server side.
-      attr_accessor :max_parallelism
-
-      # @return [Boolean] Allows explicitly marking a query as being readonly and not mutating and documents on the server side.
-      attr_accessor :readonly
-
-      # Allows customizing how long (in milliseconds) the query engine is willing to wait until the index catches up to whatever scan consistency is asked for in this query.
-      #
-      # @note that if +:not_bounded+ consistency level is used, this method doesn't do anything
-      # at all. If no value is provided to this method, the server default is used.
-      #
-      # @return [Integer] The maximum duration (in milliseconds) the query engine is willing to wait before failing.
-      attr_accessor :scan_wait
-
-      # @return [Integer] Supports customizing the maximum buffered channel size between the indexer and the query service
-      attr_accessor :scan_cap
-
-      # @return [Integer] Supports customizing the number of items execution operators can batch for fetch from the KV layer on the server.
-      attr_accessor :pipeline_batch
-
-      # @return [Integer] Allows customizing the maximum number of items each execution operator can buffer between various operators on the server.
-      attr_accessor :pipeline_cap
-
-      # @return [Boolean] Enables per-request metrics in the trailing section of the query
-      attr_accessor :metrics
-
-      # @return [:off, :phases, :timings] Customize server profile level for this query
-      attr_accessor :profile
-
-      # @yieldparam [QueryOptions] self
-      def initialize
-        @timeout = 75_000 # ms
-        @adhoc = true
-        @raw_parameters = {}
-        @positional_parameters = nil
-        @named_parameters = nil
-        @scan_consistency = nil
-        @mutation_state = nil
-        yield self if block_given?
-      end
-
-      # Allows providing custom JSON key/value pairs for advanced usage
-      #
-      # @param [String] key the parameter name (key of the JSON property)
-      # @param [Object] value the parameter value (value of the JSON property)
-      def raw(key, value)
-        @raw_parameters[key] = JSON.generate(value)
-      end
-
-      # Customizes the consistency guarantees for this query
-      #
-      # @note overrides consistency level set by {#consistent_with}
-      #
-      # [+:not_bounded+] The indexer will return whatever state it has to the query engine at the time of query. This is the default (for single-statement requests).
-      #
-      # [+:request_plus+] The indexer will wait until all mutations have been processed at the time of request before returning to the query engine.
-      #
-      # @param [:not_bounded, :request_plus] level the index scan consistency to be used for this query
-      def scan_consistency=(level)
-        @mutation_state = nil if @mutation_state
-        @scan_consistency = level
-      end
-
-      # Sets the mutation tokens this query should be consistent with
-      #
-      # @note overrides consistency level set by {#scan_consistency=}
-      #
-      # @param [MutationState] mutation_state the mutation state containing the mutation tokens
-      def consistent_with(mutation_state)
-        @scan_consistency = nil if @scan_consistency
-        @mutation_state = mutation_state
-      end
-
-      # Sets positional parameters for the query
-      #
-      # @param [Array] positional the list of parameters that have to be substituted in the statement
-      def positional_parameters(positional)
-        @positional_parameters = positional
-        @named_parameters = nil
-      end
-
-      # Sets named parameters for the query
-      #
-      # @param [Hash] named the key/value map of the parameters to substitute in the statement
-      def named_parameters(named)
-        @named_parameters = named
-        @positional_parameters = nil
-      end
-    end
-
     class QueryResult
       # @return [QueryMetaData] returns object representing additional metadata associated with this query
       attr_accessor :meta_data
@@ -162,7 +61,7 @@ module Couchbase
       # @return [QueryMetrics] metrics as returned by the query engine, if enabled
       attr_accessor :metrics
 
-      # @return [List<QueryWarning>] list of warnings returned by the query engine
+      # @return [Array<QueryWarning>] list of warnings returned by the query engine
       attr_accessor :warnings
 
       # @yieldparam [QueryMetaData] self
@@ -172,10 +71,12 @@ module Couchbase
     end
 
     class QueryMetrics
-      # @return [Integer] The total time taken for the request, that is the time from when the request was received until the results were returned
+      # @return [Integer] The total time taken for the request (in nanoseconds), that is the time from when the request
+      #   was received until the results were returned.
       attr_accessor :elapsed_time
 
-      # @return [Integer] The time taken for the execution of the request, that is the time from when query execution started until the results were returned
+      # @return [Integer] The time taken for the execution of the request (in nanoseconds), that is the time from when
+      #   query execution started until the results were returned
       attr_accessor :execution_time
 
       # @return [Integer] the total number of results selected by the engine before restriction through LIMIT clause.

data/lib/couchbase/railtie.rb

@@ -0,0 +1,45 @@
+#  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.
+
+require "rails"
+
+require "couchbase/configuration"
+
+module Rails
+  module Couchbase
+    class Railtie < ::Rails::Railtie
+      def self.rescue_responses
+        {
+          "Couchbase::Error::DocumentNotFound" => :not_found,
+        }
+      end
+
+      config.action_dispatch.rescue_responses&.merge!(rescue_responses)
+
+      config.couchbase = ::Couchbase::Configuration.new
+
+      initializer "couchbase.load-config" do
+        config_path = Rails.root.join("config", "couchbase.yml")
+        if config_path.file?
+          begin
+            config.couchbase.load!(config_path)
+          rescue ::Couchbase::Error::CouchbaseError => e
+            puts "There is a configuration error with the current couchbase.yml"
+            puts e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/couchbase/raw_binary_transcoder.rb

@@ -0,0 +1,37 @@
+#  Copyright 2023. 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/transcoder_flags"
+
+module Couchbase
+  class RawBinaryTranscoder
+    # @param [String] document
+    # @return [Array<String, Integer>] pair of encoded document and flags
+    def encode(document)
+      raise Error::EncodingFailure, "Only binary data supported by RawBinaryTranscoder" unless document.is_a?(String)
+
+      [document, TranscoderFlags.new(format: :binary).encode]
+    end
+
+    # @param [String] blob string of bytes, containing encoded representation of the document
+    # @param [Integer] flags bit field, describing how the data encoded
+    # @return [String] decoded document
+    def decode(blob, flags)
+      format = TranscoderFlags.decode(flags).format
+      raise Error::DecodingFailure, "Unable to decode #{format} with the RawBinaryTranscoder" unless format == :binary || format.nil?
+
+      blob
+    end
+  end
+end

data/lib/couchbase/raw_json_transcoder.rb

@@ -0,0 +1,38 @@
+#  Copyright 2023. 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/transcoder_flags"
+require "couchbase/errors"
+
+module Couchbase
+  class RawJsonTranscoder
+    # @param [String] document
+    # @return [Array<String, Integer>] pair of encoded document and flags
+    def encode(document)
+      raise Error::EncodingFailure, "Only String and binary data supported by RawJsonTranscoder" unless document.is_a?(String)
+
+      [document, TranscoderFlags.new(format: :json).encode]
+    end
+
+    # @param [String] blob string of bytes, containing encoded representation of the document
+    # @param [Integer] flags bit field, describing how the data encoded
+    # @return [String] decoded document
+    def decode(blob, flags)
+      format = TranscoderFlags.decode(flags).format
+      raise Error::DecodingFailure, "Unable to decode #{format} with the RawJsonTranscoder" unless format == :json || format.nil?
+
+      blob
+    end
+  end
+end

data/lib/couchbase/raw_string_transcoder.rb

@@ -0,0 +1,40 @@
+#  Copyright 2023. 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/transcoder_flags"
+require "couchbase/errors"
+
+module Couchbase
+  class RawStringTranscoder
+    # @param [String] document
+    # @return [Array<String, Integer>] pair of encoded document and flags
+    def encode(document)
+      unless document.is_a?(String) && document.valid_encoding?
+        raise Error::EncodingFailure, "Only String data supported by RawStringTranscoder"
+      end
+
+      [document, TranscoderFlags.new(format: :string).encode]
+    end
+
+    # @param [String] blob string of bytes, containing encoded representation of the document
+    # @param [Integer] flags bit field, describing how the data encoded
+    # @return [String] decoded document
+    def decode(blob, flags)
+      format = TranscoderFlags.decode(flags).format
+      raise Error::DecodingFailure, "Unable to decode #{format} with the RawStringTranscoder" unless format == :string || format.nil?
+
+      blob
+    end
+  end
+end