elastic-transport 8.1.0.pre2 → 8.1.1

data/Rakefile

@@ -18,22 +18,13 @@
 require 'bundler/gem_tasks'
 require 'mkmf'
 
-desc 'Run unit tests'
+desc "Run unit tests"
 task default: 'test:unit'
 task test: 'test:unit'
 
 # ----- Test tasks ------------------------------------------------------------
 require 'rake/testtask'
 require 'rspec/core/rake_task'
-FARADAY1_GEMFILE = 'Gemfile-faraday1.gemfile'.freeze
-GEMFILES = ['Gemfile', FARADAY1_GEMFILE].freeze
-
-task :install do
-  GEMFILES.each do |gemfile|
-    gemfile = File.expand_path("../#{gemfile}", __FILE__)
-    sh "bundle install --gemfile #{gemfile}"
-  end
-end
 
 namespace :test do
   RSpec::Core::RakeTask.new(:spec)
@@ -55,7 +46,6 @@ namespace :test do
   desc 'Run all tests'
   task :all do
     Rake::Task['test:unit'].invoke
-    Rake::Task['test:spec'].invoke
     Rake::Task['test:integration'].invoke
   end
 
@@ -63,34 +53,6 @@ namespace :test do
     test.libs << 'lib' << 'test'
     test.test_files = FileList['test/profile/**/*_test.rb']
   end
-
-  namespace :faraday1 do
-    desc 'Faraday 1: Run RSpec with dependency on Faraday 1'
-    task :spec do
-      sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} bundle exec rspec"
-    end
-
-    desc 'Faraday 1: Run unit tests with dependency on Faraday 1'
-    task :unit do
-      Dir.glob('./test/unit/**/**.rb').each do |test|
-        sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} ruby -Ilib:test #{test}"
-      end
-    end
-
-    desc 'Faraday 1: Run integration tests with dependency on Faraday 1'
-    task :integration do
-      Dir.glob('./test/integration/**/**.rb').each do |test|
-        sh "BUNDLE_GEMFILE=#{FARADAY1_GEMFILE} ruby -Ilib:test #{test}"
-      end
-    end
-
-    desc 'Faraday 1: Run all tests'
-    task :all do
-      Rake::Task['test:faraday1:unit'].invoke
-      Rake::Task['test:faraday1:spec'].invoke
-      Rake::Task['test:faraday1:integration'].invoke
-    end
-  end
 end
 
 namespace :docker do

data/elastic-transport.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.name          = "elastic-transport"
   s.version       = Elastic::Transport::VERSION
   s.authors       = ['Karel Minarik', 'Emily Stolfo', 'Fernando Briano']
-  s.email         = ['support@elastic.co']
+  s.email         = ['clients-team@elastic.co']
   s.summary       = 'Low level Ruby client for Elastic services.'
   s.homepage      = 'https://github.com/elastic/elastic-transport-ruby'
   s.license       = 'Apache-2.0'
@@ -44,18 +44,20 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency 'faraday'
   s.add_dependency 'multi_json'
+  s.add_dependency 'faraday', '~> 1'
 
-  # Faraday Adapters
-  s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
-  s.add_development_dependency 'curb' unless defined? JRUBY_VERSION
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'cane'
+  s.add_development_dependency 'curb'   unless defined? JRUBY_VERSION
   s.add_development_dependency 'hashie'
+  s.add_development_dependency 'httpclient'
+  s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'minitest-reporters'
   s.add_development_dependency 'mocha'
+  s.add_development_dependency 'net-http-persistent'
+  s.add_development_dependency 'patron' unless defined? JRUBY_VERSION
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake', '~> 13'
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
@@ -63,6 +65,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'shoulda-context'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'test-unit', '~> 2'
+  s.add_development_dependency 'typhoeus', '~> 1.4'
   s.add_development_dependency 'yard'
 
   s.description = <<-DESC.gsub(/^    /, '')

data/lib/elastic/transport/client.rb

@@ -283,26 +283,24 @@ module Elastic
       # Auto-detect the best adapter (HTTP "driver") available, based on libraries
       # loaded by the user, preferring those with persistent connections
       # ("keep-alive") by default
-      # Check adapters based on the usage of Faraday 1 or 2. Faraday should be defined here
-      # since this is only called when transport class is Transport::HTTP::Faraday
       #
       # @return [Symbol]
       #
       # @api private
       #
       def __auto_detect_adapter
-        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new(2)
-          return :patron if defined?(Faraday::Adapter::Patron)
-          return :typhoeus if defined?(Faraday::Adapter::Typhoeus)
-          return :httpclient if defined?(Faraday::Adapter::HTTPClient)
-          return :net_http_persistent if defined?(Faraday::Adapter::NetHttpPersistent)
+        case
+        when defined?(::Patron)
+          :patron
+        when defined?(::Typhoeus)
+          :typhoeus
+        when defined?(::HTTPClient)
+          :httpclient
+        when defined?(::Net::HTTP::Persistent)
+          :net_http_persistent
         else
-          return :patron if defined?(::Patron)
-          return :typhoeus if defined?(::Typhoeus)
-          return :httpclient if defined?(::HTTPClient)
-          return :net_http_persistent if defined?(::Net::HTTP::Persistent)
+          ::Faraday.default_adapter
         end
-        ::Faraday.default_adapter
       end
     end
   end

data/lib/elastic/transport/meta_header.rb

@@ -103,31 +103,31 @@ module Elastic
           adapter_version = case @arguments[:adapter]
                    when :patron
                      version = Patron::VERSION if defined?(::Patron::VERSION)
-                     { pt: version }
+                     {pt: version}
                    when :net_http
                      version = if defined?(Net::HTTP::VERSION)
                                  Net::HTTP::VERSION
                                elsif defined?(Net::HTTP::HTTPVersion)
                                  Net::HTTP::HTTPVersion
                                end
-                     { nh: version }
+                     {nh: version}
                    when :typhoeus
                      version = Typhoeus::VERSION if defined?(::Typhoeus::VERSION)
-                     { ty: version }
+                     {ty: version}
                    when :httpclient
                      version = HTTPClient::VERSION if defined?(HTTPClient::VERSION)
-                     { hc: version }
+                     {hc: version}
                    when :net_http_persistent
                      version = Net::HTTP::Persistent::VERSION if defined?(Net::HTTP::Persistent::VERSION)
-                     { np: version }
+                     {np: version}
                    else
                      {}
                    end
-          { fd: Faraday::VERSION }.merge(adapter_version)
+          {fd: Faraday::VERSION}.merge(adapter_version)
         elsif defined?(Transport::HTTP::Curb) && @transport_class == Transport::HTTP::Curb
-          { cl: Curl::CURB_VERSION }
+          {cl: Curl::CURB_VERSION}
         elsif defined?(Transport::HTTP::Manticore) && @transport_class == Transport::HTTP::Manticore
-          { mc: Manticore::VERSION }
+          {mc: Manticore::VERSION}
         end
       end
     end

data/lib/elastic/transport/transport/base.rb

@@ -322,16 +322,18 @@ module Elastic
               reload_connections! and retry
             end
 
+            exception = Elastic::Transport::Transport::Error.new(e.message)
+
             if max_retries
               log_warn "[#{e.class}] Attempt #{tries} connecting to #{connection.host.inspect}"
               if tries <= max_retries
                 retry
               else
                 log_fatal "[#{e.class}] Cannot connect to #{connection.host.inspect} after #{tries} tries"
-                raise e
+                raise exception
               end
             else
-              raise e
+              raise exception
             end
           rescue Exception => e
             log_fatal "[#{e.class}] #{e.message} (#{connection.host.inspect if connection})"
@@ -427,7 +429,7 @@ module Elastic
         end
 
         def apply_headers(client, options)
-          headers = options[:headers] || {}
+          headers = options[:headers].clone || {}
           headers[CONTENT_TYPE_STR] = find_value(headers, CONTENT_TYPE_REGEX) || DEFAULT_CONTENT_TYPE
           headers[USER_AGENT_STR] = find_value(headers, USER_AGENT_REGEX) || user_agent_header(client)
           client.headers[ACCEPT_ENCODING] = GZIP if use_compression?

data/lib/elastic/transport/transport/http/curb.rb

@@ -37,34 +37,31 @@ module Elastic
               body, headers = compress_request(body, headers)
 
               case method
-              when 'HEAD'
-                connection.connection.set :nobody, true
-              when 'GET', 'POST', 'PUT', 'DELETE'
-                connection.connection.set :nobody, false
-                connection.connection.put_data = body if body
+                when 'HEAD'
+                  connection.connection.set :nobody, true
+                when 'GET', 'POST', 'PUT', 'DELETE'
+                  connection.connection.set :nobody, false
+                  connection.connection.put_data = body if body
 
-                if headers
-                  if connection.connection.headers
-                    connection.connection.headers.merge!(headers)
-                  else
-                    connection.connection.headers = headers
+                  if headers
+                    if connection.connection.headers
+                      connection.connection.headers.merge!(headers)
+                    else
+                      connection.connection.headers = headers
+                    end
                   end
-                end
 
-              else raise ArgumentError, "Unsupported HTTP method: #{method}"
+                else raise ArgumentError, "Unsupported HTTP method: #{method}"
               end
 
               connection.connection.http(method.to_sym)
-              header_string = connection.connection.header_str.to_s
 
-              _response_status, *response_headers = header_string.split(/[\r\n]+/).map(&:strip)
-              response_headers = Hash[response_headers.flat_map { |s| s.scan(/^(\S+): (.+)/) }].transform_keys(&:downcase)
+              response_headers = {}
+              response_headers['content-type'] = 'application/json' if connection.connection.header_str =~ /\/json/
 
-              Response.new(
-                connection.connection.response_code,
-                decompress_response(connection.connection.body_str),
-                response_headers
-              )
+              Response.new connection.connection.response_code,
+                           decompress_response(connection.connection.body_str),
+                           response_headers
             end
           end
 
@@ -76,7 +73,7 @@ module Elastic
             client = ::Curl::Easy.new
 
             apply_headers(client, options)
-            client.url = __full_url(host)
+            client.url     = __full_url(host)
 
             if host[:user]
               client.http_auth_types = host[:auth_type] || :basic
@@ -108,13 +105,13 @@ module Elastic
 
           def user_agent_header(client)
             @user_agent ||= begin
-                              meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
-                              if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
-                                meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
-                              end
-                              meta << "Curb #{Curl::CURB_VERSION}"
-                              "elastic-transport-ruby/#{VERSION} (#{meta.join('; ')})"
-                            end
+              meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
+              if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
+                meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
+              end
+              meta << "Curb #{Curl::CURB_VERSION}"
+              "elastic-transport-ruby/#{VERSION} (#{meta.join('; ')})"
+            end
           end
         end
       end

data/lib/elastic/transport/transport/http/manticore.rb

@@ -162,7 +162,7 @@ module Elastic
           private
 
           def apply_headers(options)
-            headers = options[:headers] || options.dig(:transport_options, :headers) || {}
+            headers = options[:headers].clone || options.dig(:transport_options, :headers).clone || {}
             headers[CONTENT_TYPE_STR] = find_value(headers, CONTENT_TYPE_REGEX) || DEFAULT_CONTENT_TYPE
             headers[USER_AGENT_STR] = find_value(headers, USER_AGENT_REGEX) || find_value(@request_options[:headers], USER_AGENT_REGEX) || user_agent_header
             headers[ACCEPT_ENCODING] = GZIP if use_compression?

data/lib/elastic/transport/transport/response.rb

@@ -19,14 +19,15 @@ module Elastic
   module Transport
     module Transport
       # Wraps the response from Elasticsearch.
-      #
+      # It provides `body`, `status` and `headers` methods, but you can treat is as a hash and
+      # access the keys directly.
       class Response
         attr_reader :status, :body, :headers
 
         # @param status  [Integer] Response status code
         # @param body    [String]  Response body
         # @param headers [Hash]    Response headers
-        def initialize(status, body, headers={})
+        def initialize(status, body, headers = {})
           @status, @body, @headers = status, body, headers
           @body = body.force_encoding('UTF-8') if body.respond_to?(:force_encoding)
         end

data/lib/elastic/transport/transport/sniffer.rb

@@ -76,7 +76,9 @@ module Elastic
         end
 
         def parse_publish_address(publish_address)
-          # publish_address is in the format hostname/ip:port
+          # When publish_address is in the format 'inet[hostname/ip:port]'
+          return parse_address_port(publish_address[6..-2]) if publish_address =~ /^inet\[.*\]$/
+
           if publish_address =~ /\//
             parts = publish_address.partition('/')
             [ parts[0], parse_address_port(parts[2])[1] ]

data/lib/elastic/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elastic
   module Transport
-    VERSION = '8.1.0.pre2'.freeze
+    VERSION = '8.1.1'.freeze
   end
 end

data/spec/elastic/transport/base_spec.rb

@@ -30,16 +30,16 @@ describe Elastic::Transport::Transport::Base do
 
       it 'does not include the password in the logged string' do
         expect(logger).not_to receive(:error).with(/secret_password/)
-        expect {
+        expect do
           client.perform_request('GET', '/_cluster/stats')
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
 
       it 'replaces the password with the string \'REDACTED\'' do
         expect(logger).to receive(:error).with(/REDACTED/)
-        expect {
+        expect do
           client.perform_request('GET', '/_cluster/stats')
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
 
@@ -93,7 +93,7 @@ describe Elastic::Transport::Transport::Base do
     end
 
     it 'raises an exception' do
-      expect { client.perform_request('GET', '/info') }.to raise_exception(Faraday::ConnectionFailed)
+      expect { client.perform_request('GET', '/info') }.to raise_exception(Elastic::Transport::Transport::Error)
     end
   end
 
@@ -105,8 +105,7 @@ describe Elastic::Transport::Transport::Base do
     let(:arguments) do
       {
         hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
-        retry_on_failure: 2,
-        adapter: :net_http
+        retry_on_failure: 2
       }
     end
 
@@ -116,9 +115,9 @@ describe Elastic::Transport::Transport::Base do
       end
 
       it 'uses the client `retry_on_failure` value' do
-        expect {
+        expect do
           client.transport.perform_request('GET', '/info')
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
 
@@ -130,8 +129,7 @@ describe Elastic::Transport::Transport::Base do
       let(:arguments) do
         {
           hosts: ELASTICSEARCH_HOSTS,
-          retry_on_status: ['404'],
-          adapter: :net_http
+          retry_on_status: ['404']
         }
       end
 
@@ -150,7 +148,7 @@ describe Elastic::Transport::Transport::Base do
       it 'uses the option `retry_on_failure` value' do
         expect do
           client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
-        end.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
   end
@@ -162,8 +160,8 @@ describe Elastic::Transport::Transport::Base do
 
     let(:arguments) do
       {
-          hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
-          retry_on_failure: true
+        hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
+        retry_on_failure: true
       }
     end
 
@@ -173,9 +171,9 @@ describe Elastic::Transport::Transport::Base do
       end
 
       it 'uses the default `MAX_RETRIES` value' do
-        expect {
+        expect do
           client.transport.perform_request('GET', '/info')
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
 
@@ -185,9 +183,9 @@ describe Elastic::Transport::Transport::Base do
       end
 
       it 'uses the option `retry_on_failure` value' do
-        expect {
+        expect do
           client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
   end
@@ -199,8 +197,8 @@ describe Elastic::Transport::Transport::Base do
 
     let(:arguments) do
       {
-          hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
-          retry_on_failure: false
+        hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
+        retry_on_failure: false
       }
     end
 
@@ -210,22 +208,21 @@ describe Elastic::Transport::Transport::Base do
       end
 
       it 'does not retry' do
-        expect {
+        expect do
           client.transport.perform_request('GET', '/info')
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
 
     context 'when `perform_request` is called with a `retry_on_failure` option value' do
-
       before do
         expect(client.transport).to receive(:get_connection).exactly(6).times.and_call_original
       end
 
       it 'uses the option `retry_on_failure` value' do
-        expect {
+        expect do
           client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
-        }.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
   end
@@ -247,7 +244,7 @@ describe Elastic::Transport::Transport::Base do
       it 'does not retry' do
         expect do
           client.transport.perform_request('GET', '/info')
-        end.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
 
@@ -259,7 +256,7 @@ describe Elastic::Transport::Transport::Base do
       it 'uses the option `retry_on_failure` value' do
         expect do
           client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
-        end.to raise_exception(Faraday::ConnectionFailed)
+        end.to raise_exception(Elastic::Transport::Transport::Error)
       end
     end
   end

data/spec/elastic/transport/client_spec.rb

@@ -191,8 +191,8 @@ describe Elastic::Transport::Client do
         it 'uses Faraday NetHttp' do
           expect(adapter).to eq Faraday::Adapter::NetHttp
         end
-      end
-    end unless jruby?
+      end unless jruby?
+    end
 
     context 'when the adapter is patron' do
       let(:adapter) do
@@ -204,10 +204,9 @@ describe Elastic::Transport::Client do
       end
 
       it 'uses Faraday with the adapter' do
-        require 'faraday/patron'
         expect(adapter).to eq Faraday::Adapter::Patron
       end
-    end unless jruby?
+    end
 
     context 'when the adapter is typhoeus' do
       let(:adapter) do
@@ -215,8 +214,6 @@ describe Elastic::Transport::Client do
       end
 
       let(:client) do
-        require 'faraday/typhoeus' if is_faraday_v2?
-
         described_class.new(adapter: :typhoeus, enable_meta_header: false)
       end
 
@@ -237,7 +234,7 @@ describe Elastic::Transport::Client do
       it 'uses Faraday with the adapter' do
         expect(adapter).to eq Faraday::Adapter::Patron
       end
-    end unless jruby?
+    end
 
     context 'when the adapter can be detected', unless: jruby? do
       around do |example|
@@ -277,7 +274,7 @@ describe Elastic::Transport::Client do
       it 'sets the logger' do
         expect(handlers).to include(Faraday::Response::Logger)
       end
-    end unless jruby?
+    end
   end
 
   shared_examples_for 'a client that extracts hosts' do
@@ -1266,8 +1263,6 @@ describe Elastic::Transport::Client do
         end
 
         context 'when the Faraday adapter is set in the block' do
-          require 'faraday/net_http_persistent' if is_faraday_v2?
-
           let(:client) do
             Elastic::Transport::Client.new(host: ELASTICSEARCH_HOSTS.first, logger: logger) do |client|
               client.adapter(:net_http_persistent)
@@ -1327,9 +1322,9 @@ describe Elastic::Transport::Client do
 
         it 'retries only the specified number of times' do
           expect(client.perform_request('GET', '_nodes/_local'))
-          expect {
+          expect do
             client.perform_request('GET', '_nodes/_local')
-          }.to raise_exception(Faraday::ConnectionFailed)
+          end.to raise_exception(Elastic::Transport::Transport::Error)
         end
       end
 
@@ -1419,8 +1414,6 @@ describe Elastic::Transport::Client do
           end
 
           context 'when using the HTTPClient adapter' do
-            require 'faraday/httpclient'
-
             let(:client) do
               described_class.new(hosts: ELASTICSEARCH_HOSTS, compression: true, adapter: :httpclient, enable_meta_header: false)
             end

data/spec/elastic/transport/meta_header_spec.rb

@@ -155,7 +155,7 @@ describe Elastic::Transport::Client do
           expect(headers).to include('x-elastic-client-meta' => meta)
 
           Typhoeus = @klass if was_required
-        end
+        end unless jruby?
 
         it 'sets adapter in the meta header' do
           require 'typhoeus'
@@ -163,7 +163,7 @@ describe Elastic::Transport::Client do
           meta = "#{meta_header},ty=#{Typhoeus::VERSION}"
           expect(headers).to include('x-elastic-client-meta' => meta)
         end
-      end unless jruby?
+      end
 
       unless jruby?
         let(:adapter) { :patron }

data/spec/elastic/transport/sniffer_spec.rb

@@ -257,6 +257,24 @@ describe Elastic::Transport::Transport::Sniffer do
       end
     end
 
+    context 'when the address is IPv4' do
+      let(:publish_address) do
+        'inet[/127.0.0.1:9200]'
+      end
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(1)
+      end
+
+      it 'correctly parses the host' do
+        expect(hosts[0][:host]).to eq('127.0.0.1')
+      end
+
+      it 'correctly parses the port' do
+        expect(hosts[0][:port]).to eq('9200')
+      end
+    end
+
     context 'when the transport has :randomize_hosts option' do
       let(:raw_response) do
         { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => '127.0.0.1:9250' } },

data/spec/spec_helper.rb

@@ -74,10 +74,6 @@ def default_client
   $client ||= Elastic::Transport::Client.new(hosts: ELASTICSEARCH_HOSTS)
 end
 
-def is_faraday_v2?
-  Gem::Version.new(Faraday::VERSION) >= Gem::Version.new(2)
-end
-
 module Config
   def self.included(context)
     # Get the hosts to use to connect an elasticsearch client.

data/test/integration/jruby_test.rb

@@ -21,7 +21,7 @@ if JRUBY
   require 'elastic/transport/transport/http/manticore'
 
   class Elastic::Transport::ClientManticoreIntegrationTest < Minitest::Test
-    context 'Transport' do
+    context "Transport" do
       setup do
         uri = URI(HOST)
         @host = {