elastomer-client 3.2.2 → 6.2.0

data/lib/{elastomer → elastomer_client}/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "addressable/template"
 require "faraday"
 require "faraday_middleware"
@@ -5,25 +7,21 @@ require "multi_json"
 require "semantic"
 require "zlib"
 
-require "elastomer/version"
-require "elastomer/version_support"
+require "elastomer_client/version"
+require "elastomer_client/version_support"
 
-module Elastomer
+module ElastomerClient
 
   class Client
     IVAR_BLACK_LIST = [:@basic_auth, :@token_auth]
-    IVAR_NOISY_LIST = [:@api_spec, :@cluster]
-
-    MAX_REQUEST_SIZE = 250 * 2**20  # 250 MB
+    IVAR_NOISY_LIST = [:@api_spec, :@cluster, :@connection]
 
-    RETRYABLE_METHODS = %i[get head].freeze
+    MAX_REQUEST_SIZE = 2**20 * 250  # 250 MB
 
     # Create a new client that can be used to make HTTP requests to the
-    # Elasticsearch server. If you use `:max_retries`, then any GET or HEAD
-    # request will be retried up to this many times with a 75ms delay between
-    # the retry attempts. Only non-fatal exceptions will retried automatically.
+    # Elasticsearch server.
     #
-    # see lib/elastomer/client/errors.rb#L92-L94
+    # see lib/elastomer_client/client/errors.rb#L92-L94
     #
     # Method params:
     #   :host - the host as a String
@@ -34,8 +32,6 @@ module Elastomer
     #   :adapter      - the Faraday adapter to use (defaults to :excon)
     #   :opaque_id    - set to `true` to use the 'X-Opaque-Id' request header
     #   :max_request_size - the maximum allowed request size in bytes (defaults to 250 MB)
-    #   :max_retries      - the maximum number of request retires (defaults to 0)
-    #   :retry_delay      - delay in seconds between retries (defaults to 0.075)
     #   :strict_params    - set to `true` to raise exceptions when invalid request params are used
     #   :es_version       - set to the Elasticsearch version (example: "5.6.6") to avoid an HTTP request to get the version.
     #   :compress_body    - set to true to enable request body compression (default: false)
@@ -44,10 +40,9 @@ module Elastomer
     #   :token_auth       - an authentication token as a String to use on connections (overrides :basic_auth)
     #
     def initialize(host: "localhost", port: 9200, url: nil,
-                   read_timeout: 5, open_timeout: 2, max_retries: 0, retry_delay: 0.075,
-                   opaque_id: false, adapter: Faraday.default_adapter, max_request_size: MAX_REQUEST_SIZE,
+                   read_timeout: 5, open_timeout: 2, opaque_id: false, adapter: Faraday.default_adapter, max_request_size: MAX_REQUEST_SIZE,
                    strict_params: false, es_version: nil, compress_body: false, compression: Zlib::DEFAULT_COMPRESSION,
-                   basic_auth: nil, token_auth: nil)
+                   basic_auth: nil, token_auth: nil, &block)
 
       @url = url || "http://#{host}:#{port}"
 
@@ -57,8 +52,6 @@ module Elastomer
 
       @read_timeout     = read_timeout
       @open_timeout     = open_timeout
-      @max_retries      = max_retries
-      @retry_delay      = retry_delay
       @adapter          = adapter
       @opaque_id        = opaque_id
       @max_request_size = max_request_size
@@ -68,11 +61,12 @@ module Elastomer
       @compression      = compression
       @basic_auth       = basic_auth
       @token_auth       = token_auth
+      @connection_block = block
     end
 
     attr_reader :host, :port, :url
     attr_reader :read_timeout, :open_timeout
-    attr_reader :max_retries, :retry_delay, :max_request_size
+    attr_reader :max_request_size
     attr_reader :strict_params
     attr_reader :es_version
     attr_reader :compress_body
@@ -83,12 +77,12 @@ module Elastomer
     # fashion.
     def dup
       self.class.new \
-          url:              url,
-          read_timeout:     read_timeout,
-          open_timeout:     open_timeout,
+          url:,
+          read_timeout:,
+          open_timeout:,
           adapter:          @adapter,
           opaque_id:        @opaque_id,
-          max_request_size: max_request_size,
+          max_request_size:,
           basic_auth:       @basic_auth,
           token_auth:       @token_auth
     end
@@ -140,9 +134,8 @@ module Elastomer
         # Request compressed responses from ES and decompress them
         conn.use(:gzip)
         conn.request(:encode_json)
-        conn.request(:opaque_id) if @opaque_id
-        conn.request(:limit_size, max_request_size: max_request_size) if max_request_size
-        conn.request(:elastomer_compress, compression: compression) if compress_body
+        conn.request(:limit_size, max_request_size:) if max_request_size
+        conn.request(:elastomer_compress, compression:) if compress_body
 
         conn.options[:timeout]      = read_timeout
         conn.options[:open_timeout] = open_timeout
@@ -153,6 +146,10 @@ module Elastomer
           conn.basic_auth(@basic_auth[:username], @basic_auth[:password])
         end
 
+        @connection_block&.call(conn)
+
+        conn.request(:opaque_id) if @opaque_id
+
         if @adapter.is_a?(Array)
           conn.adapter(*@adapter)
         else
@@ -176,7 +173,7 @@ module Elastomer
     # params - Parameters Hash
     #
     # Returns a Faraday::Response
-    def head( path, params = {} )
+    def head(path, params = {})
       request :head, path, params
     end
 
@@ -186,8 +183,8 @@ module Elastomer
     # params - Parameters Hash
     #
     # Returns a Faraday::Response
-    # Raises an Elastomer::Client::Error on 4XX and 5XX responses
-    def get( path, params = {} )
+    # Raises an ElastomerClient::Client::Error on 4XX and 5XX responses
+    def get(path, params = {})
       request :get, path, params
     end
 
@@ -197,8 +194,8 @@ module Elastomer
     # params - Parameters Hash
     #
     # Returns a Faraday::Response
-    # Raises an Elastomer::Client::Error on 4XX and 5XX responses
-    def put( path, params = {} )
+    # Raises an ElastomerClient::Client::Error on 4XX and 5XX responses
+    def put(path, params = {})
       request :put, path, params
     end
 
@@ -208,8 +205,8 @@ module Elastomer
     # params - Parameters Hash
     #
     # Returns a Faraday::Response
-    # Raises an Elastomer::Client::Error on 4XX and 5XX responses
-    def post( path, params = {} )
+    # Raises an ElastomerClient::Client::Error on 4XX and 5XX responses
+    def post(path, params = {})
       request :post, path, params
     end
 
@@ -219,8 +216,8 @@ module Elastomer
     # params - Parameters Hash
     #
     # Returns a Faraday::Response
-    # Raises an Elastomer::Client::Error on 4XX and 5XX responses
-    def delete( path, params = {} )
+    # Raises an ElastomerClient::Client::Error on 4XX and 5XX responses
+    def delete(path, params = {})
       request :delete, path, params
     end
 
@@ -233,18 +230,14 @@ module Elastomer
     # params - Parameters Hash
     #   :body         - Will be used as the request body
     #   :read_timeout - Optional read timeout (in seconds) for the request
-    #   :max_retires  - Optional retry number for the request
     #
     # Returns a Faraday::Response
-    # Raises an Elastomer::Client::Error on 4XX and 5XX responses
-    # rubocop:disable Metrics/MethodLength
-    def request( method, path, params )
+    # Raises an ElastomerClient::Client::Error on 4XX and 5XX responses
+    def request(method, path, params)
       read_timeout = params.delete(:read_timeout)
-      request_max_retries = params.delete(:max_retries) || max_retries
       body = extract_body(params)
       path = expand_path(path, params)
 
-      params[:retries] = retries = 0
       instrument(path, body, params) do
         begin
           response =
@@ -276,14 +269,9 @@ module Elastomer
 
           handle_errors response
 
-        # wrap Faraday errors with appropriate Elastomer::Client error classes
-        rescue Faraday::Error::ClientError => boom
+        # wrap Faraday errors with appropriate ElastomerClient::Client error classes
+        rescue Faraday::Error => boom
           error = wrap_faraday_error(boom, method, path)
-          if error.retry? && RETRYABLE_METHODS.include?(method) && (retries += 1) <= request_max_retries
-            params[:retries] = retries
-            sleep retry_delay
-            retry
-          end
           raise error
         rescue OpaqueIdError => boom
           reset!
@@ -293,7 +281,7 @@ module Elastomer
     end
     # rubocop:enable Metrics/MethodLength
 
-    # Internal: Returns a new Elastomer::Client error that wraps the given
+    # Internal: Returns a new ElastomerClient::Client error that wraps the given
     # Faraday error. A generic Error is returned if we cannot wrap the given
     # Faraday error.
     #
@@ -303,7 +291,7 @@ module Elastomer
     #
     def wrap_faraday_error(error, method, path)
       error_name  = error.class.name.split("::").last
-      error_class = Elastomer::Client.const_get(error_name) rescue Elastomer::Client::Error
+      error_class = ElastomerClient::Client.const_get(error_name) rescue ElastomerClient::Client::Error
       error_class.new(error, method.upcase, path)
     end
 
@@ -323,7 +311,7 @@ module Elastomer
     # params - Parameters Hash
     #
     # Returns the request body as a String or `nil` if no :body is present
-    def extract_body( params )
+    def extract_body(params)
       body = params.delete :body
       return if body.nil?
 
@@ -360,14 +348,13 @@ module Elastomer
     #   #=> '/foo/no%20bar'
     #
     # Returns an Addressable::Uri
-    def expand_path( path, params )
+    def expand_path(path, params)
       template = Addressable::Template.new path
 
       expansions = {}
       query_values = params.dup
       query_values.delete :action
       query_values.delete :context
-      query_values.delete :retries
 
       rest_api = query_values.delete :rest_api
 
@@ -379,19 +366,21 @@ module Elastomer
 
       if rest_api
         query_values = if strict_params?
-          api_spec.validate_params!(api: rest_api, params: query_values)
+                         api_spec.validate_params!(api: rest_api, params: query_values)
         else
           api_spec.select_params(api: rest_api, from: query_values)
         end
       end
 
       uri = template.expand(expansions)
-      uri.query_values = query_values unless query_values.empty?
+      query_values.transform_keys!(&:to_s)
+      uri.query_values = (uri.query_values || {}).merge(query_values) unless query_values.empty?
+
       uri.to_s
     end
 
     # Internal: A noop method that simply yields to the block. This method
-    # will be replaced when the 'elastomer/notifications' module is included.
+    # will be replaced when the 'elastomer_client/notifications' module is included.
     #
     # path   - The full request path as a String
     # body   - The request body as a String or `nil`
@@ -399,7 +388,7 @@ module Elastomer
     # block  - The block that will be instrumented
     #
     # Returns the response from the block
-    def instrument( path, body, params )
+    def instrument(path, body, params)
       yield
     end
 
@@ -414,9 +403,9 @@ module Elastomer
     # response - The Faraday::Response object.
     #
     # Returns the response.
-    # Raises an Elastomer::Client::Error on 500 responses or responses
+    # Raises an ElastomerClient::Client::Error on 500 responses or responses
     # containing and 'error' field.
-    def handle_errors( response )
+    def handle_errors(response)
       raise ServerError, response if response.status >= 500
 
       if response.body.is_a?(Hash) && (error = response.body["error"])
@@ -429,7 +418,7 @@ module Elastomer
         when "document_already_exists_exception"; raise DocumentAlreadyExistsError, response
         # Elasticsearch 5.x.x root_cause type for document already existing
         when "version_conflict_engine_exception"; raise DocumentAlreadyExistsError, response
-        when *version_support.query_parse_exception; raise QueryParsingError, response
+        when "query_shard_exception", "parsing_exception"; raise QueryParsingError, response
         end
 
         raise RequestError, response
@@ -453,7 +442,7 @@ module Elastomer
     #
     # Returns the validated param as a String.
     # Raises an ArgumentError if the param is not valid.
-    def assert_param_presence( param, name = "input value" )
+    def assert_param_presence(param, name = "input value")
       case param
       when String, Symbol, Numeric
         param = param.to_s.strip
@@ -501,7 +490,7 @@ module Elastomer
       object.respond_to?(:empty?) ? !object.empty? : !!object
     end
   end  # Client
-end  # Elastomer
+end  # ElastomerClient
 
 # require all files in the `client` sub-directory
 Dir.glob(File.expand_path("../client/*.rb", __FILE__)).each { |fn| require fn }

data/lib/{elastomer → elastomer_client}/core_ext/time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "time"
 
 class Time

data/lib/{elastomer → elastomer_client}/middleware/compress.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "stringio"
 
-module Elastomer
+module ElastomerClient
   module Middleware
     # Request middleware that compresses request bodies with GZip for supported
     # versions of Elasticsearch.
@@ -42,4 +42,4 @@ module Elastomer
   end
 end
 
-Faraday::Request.register_middleware(elastomer_compress: ::Elastomer::Middleware::Compress)
+Faraday::Request.register_middleware(elastomer_compress: ElastomerClient::Middleware::Compress)

data/lib/{elastomer → elastomer_client}/middleware/encode_json.rb

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   module Middleware
     # Request middleware that encodes the body as JSON.
     #
@@ -55,4 +57,4 @@ module Elastomer
 end
 
 Faraday::Request.register_middleware \
-  :encode_json => ::Elastomer::Middleware::EncodeJson
+  encode_json: ElastomerClient::Middleware::EncodeJson

data/lib/{elastomer → elastomer_client}/middleware/limit_size.rb

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   module Middleware
 
     # Request middleware that raises an exception if the request body exceeds a
@@ -15,7 +17,7 @@ module Elastomer
       def call(env)
         if body = env[:body]
           if body.is_a?(String) && body.bytesize > max_request_size
-            raise ::Elastomer::Client::RequestSizeError,
+            raise ::ElastomerClient::Client::RequestSizeError,
               "Request of size `#{body.bytesize}` exceeds the maximum requst size: #{max_request_size}"
           end
         end
@@ -27,4 +29,4 @@ module Elastomer
 end
 
 Faraday::Request.register_middleware \
-  :limit_size => ::Elastomer::Middleware::LimitSize
+  limit_size: ElastomerClient::Middleware::LimitSize

data/lib/{elastomer → elastomer_client}/middleware/opaque_id.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "securerandom"
 
-module Elastomer
+module ElastomerClient
   module Middleware
 
     # This Faraday middleware implements the "X-Opaque-Id" request / response
@@ -12,7 +14,7 @@ module Elastomer
     # The SecureRandom lib is used to generate a UUID string for each request.
     # This value is used as the content for the "X-Opaque-Id" header. If the
     # value is different between the request and the response, then an
-    # `Elastomer::Client::OpaqueIdError` is raised. In this case no response
+    # `ElastomerClient::Client::OpaqueIdError` is raised. In this case no response
     # will be returned.
     #
     # See [Elasticsearch "X-Opaque-Id"
@@ -27,14 +29,15 @@ module Elastomer
       # env - Faraday environment Hash
       #
       # Returns the environment Hash
-      def call( env )
+      def call(env)
         uuid = generate_uuid.freeze
         env[:request_headers][X_OPAQUE_ID] = uuid
 
         @app.call(env).on_complete do |renv|
           response_uuid = renv[:response_headers][X_OPAQUE_ID]
-          if uuid != response_uuid
-            raise ::Elastomer::Client::OpaqueIdError,
+          # Don't raise OpaqueIdError if the response is a 5xx
+          if !response_uuid.nil? && uuid != response_uuid && renv.status < 500
+            raise ::ElastomerClient::Client::OpaqueIdError,
                   "Conflicting 'X-Opaque-Id' headers: request #{uuid.inspect}, response #{response_uuid.inspect}"
           end
         end
@@ -65,7 +68,7 @@ module Elastomer
   # 'X-Opaque-Id' request header and the one received in the response header.
   Client::OpaqueIdError = Class.new Client::Error
 
-end  # Elastomer
+end  # ElastomerClient
 
 Faraday::Request.register_middleware \
-  :opaque_id => ::Elastomer::Middleware::OpaqueId
+  opaque_id: ElastomerClient::Middleware::OpaqueId

data/lib/{elastomer → elastomer_client}/middleware/parse_json.rb

@@ -1,4 +1,6 @@
-module Elastomer
+# frozen_string_literal: true
+
+module ElastomerClient
   module Middleware
 
     # Parse response bodies as JSON.
@@ -18,7 +20,7 @@ module Elastomer
       def parse(body)
         MultiJson.load(body) if body.respond_to?(:to_str) && !body.strip.empty?
       rescue StandardError, SyntaxError => e
-        raise Faraday::Error::ParsingError, e
+        raise Faraday::ParsingError, e
       end
 
       def process_response?(env)
@@ -36,4 +38,4 @@ module Elastomer
 end
 
 Faraday::Response.register_middleware \
-  :parse_json => ::Elastomer::Middleware::ParseJson
+  parse_json: ElastomerClient::Middleware::ParseJson

data/lib/{elastomer → elastomer_client}/notifications.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
+require "active_support"
 require "active_support/notifications"
 require "securerandom"
-require "elastomer/client"
+require "elastomer_client/client"
 
-module Elastomer
+module ElastomerClient
 
   # So you want to get notifications from your Elasticsearch client? Well,
   # you've come to the right place!
   #
-  #   require 'elastomer/notifications'
+  #   require 'elastomer_client/notifications'
   #
   # Requiring this module will add ActiveSupport notifications to all
   # Elasticsearch requests. To subscribe to those requests ...
@@ -27,11 +30,11 @@ module Elastomer
   # * :status - response status code
   #
   # If you want to use your own notifications service then you will need to
-  # let Elastomer know by setting the `service` here in the Notifications
+  # let ElastomerClient know by setting the `service` here in the Notifications
   # module. The service should adhere to the ActiveSupport::Notifications
   # specification.
   #
-  #   Elastomer::Notifications.service = your_own_service
+  #   ElastomerClient::Notifications.service = your_own_service
   #
   module Notifications
 
@@ -53,23 +56,22 @@ module Elastomer
     # block  - The block that will be instrumented
     #
     # Returns the response from the block
-    def instrument( path, body, params )
+    def instrument(path, body, params)
       payload = {
-        :index        => params[:index],
-        :type         => params[:type],
-        :action       => params[:action],
-        :context      => params[:context],
-        :request_body => body,
-        :body         => body   # for backwards compatibility
+        index: params[:index],
+        type: params[:type],
+        action: params[:action],
+        context: params[:context],
+        request_body: body,
+        body:   # for backwards compatibility
       }
 
-      ::Elastomer::Notifications.service.instrument(NAME, payload) do
+      ::ElastomerClient::Notifications.service.instrument(NAME, payload) do
         response = yield
         payload[:url]           = response.env[:url]
         payload[:method]        = response.env[:method]
         payload[:status]        = response.status
         payload[:response_body] = response.body
-        payload[:retries]       = params[:retries]
         response
       end
     end
@@ -81,6 +83,6 @@ module Elastomer
   # inject our instrument method into the Client class
   class Client
     remove_method :instrument
-    include ::Elastomer::Notifications
+    include ::ElastomerClient::Notifications
   end
 end

data/lib/elastomer_client/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ElastomerClient
+  VERSION = "6.2.0"
+
+  def self.version
+    VERSION
+  end
+end

data/lib/elastomer_client/version_support.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ElastomerClient
+  class VersionSupport
+
+    attr_reader :version
+
+    # version - an Elasticsearch version string e.g., 5.6.6 or 8.7.0
+    #
+    # Raises ArgumentError if version is unsupported.
+    def initialize(version)
+      if version < "5.0" || version >= "9.0"
+        raise ArgumentError, "Elasticsearch version #{version} is not supported by elastomer-client"
+      end
+
+      @version = version
+    end
+
+    # Returns true if Elasticsearch version is 8.x or higher.
+    def es_version_8_plus?
+      version >= "8.0.0"
+    end
+  end
+end

data/script/bootstrap

@@ -1,9 +1,11 @@
 #!/bin/sh
-set -e
+set -ex
 
 cd "$(dirname "$0:a")/.."
 if bundle check 1>/dev/null 2>&1; then
     echo "Gem environment up-to-date"
 else
-    exec bundle install --binstubs --path vendor/gems "$@"
+    echo "Installing gem dependencies"
+    exec bundle install "$@"
+    exec bundle binstubs --all
 fi

data/script/console

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require "irb"
 require "rubygems"
 require "bundler/setup"
 
 $LOAD_PATH.unshift "lib"
-require "elastomer/client"
+require "elastomer_client/client"
 
 IRB.start