elasticsearch-transport 7.4.0 → 7.17.10

data/spec/elasticsearch/transport/meta_header_spec.rb

@@ -0,0 +1,301 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you 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 'spec_helper'
+require 'elasticsearch'
+
+describe Elasticsearch::Transport::Client do
+  context 'meta-header' do
+    let(:subject) { client.transport.connections.first.connection.headers }
+    let(:client) { described_class.new }
+    let(:regexp) { /^[a-z]{1,}=[a-z0-9.\-]{1,}(?:,[a-z]{1,}=[a-z0-9._\-]+)*$/ }
+    let(:adapter) { :net_http }
+    let(:adapter_code) { "nh=#{defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}" }
+    let(:meta_header) do
+      if jruby?
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+      else
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+      end
+    end
+
+    context 'client_meta_version' do
+      let(:version) { ['7.1.0-alpha', '7.11.0.pre.1', '8.0.0-beta', '8.0.0.beta.2']}
+
+      it 'converts the version to X.X.Xp' do
+        expect(client.send(:client_meta_version, '7.0.0-alpha')).to eq('7.0.0p')
+        expect(client.send(:client_meta_version, '7.11.0.pre.1')).to eq('7.11.0p')
+        expect(client.send(:client_meta_version, '8.1.0-beta')).to eq('8.1.0p')
+        expect(client.send(:client_meta_version, '8.0.0.beta.2')).to eq('8.0.0p')
+        expect(client.send(:client_meta_version, '12.16.4.pre')).to eq('12.16.4p')
+      end
+    end
+
+    # We are testing this method in the previous block, so now using it inside the test to make the
+    # Elasticsearch version in the meta header string dynamic
+    def meta_version
+      client.send(:client_meta_version, Elasticsearch::VERSION)
+    end
+
+    context 'single use of meta header' do
+      let(:client) do
+        described_class.new(adapter: adapter).tap do |klient|
+          allow(klient).to receive(:__build_connections)
+        end
+      end
+
+      it 'x-elastic-client-header value matches regexp' do
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'when using user-agent headers' do
+      let(:client) do
+        transport_options = { headers: { user_agent: 'My Ruby App' } }
+        described_class.new(transport_options: transport_options, adapter: adapter).tap do |klient|
+          allow(klient).to receive(:__build_connections)
+        end
+      end
+
+      it 'is friendly to previously set headers' do
+        expect(subject).to include(user_agent: 'My Ruby App')
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'when using API Key' do
+      let(:client) do
+        described_class.new(api_key: 'an_api_key', adapter: adapter)
+      end
+
+      let(:authorization_header) do
+        client.transport.connections.first.connection.headers['Authorization']
+      end
+
+      it 'adds the ApiKey header to the connection' do
+        expect(authorization_header).to eq('ApiKey an_api_key')
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'adapters' do
+      let(:meta_header) do
+        if jruby?
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION}"
+        else
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},fd=#{Faraday::VERSION}"
+        end
+      end
+      let(:client) { described_class.new(adapter: adapter) }
+      let(:headers) { client.transport.connections.first.connection.headers }
+
+      context 'using net/http/persistent' do
+        let(:adapter) { :net_http_persistent }
+
+        it 'sets adapter in the meta header version to 0 when not loaded' do
+          was_required = defined?(Net::HTTP::Persistent)
+          if was_required
+            @klass = Net::HTTP::Persistent.clone
+            Net::HTTP.send(:remove_const, :Persistent)
+          end
+
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},np=0"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+
+          Net::HTTP::Persistent = @klass if was_required
+        end unless jruby?
+
+        it 'sets adapter in the meta header' do
+          require 'net/http/persistent'
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},np=#{Net::HTTP::Persistent::VERSION}"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+        end
+      end
+
+      context 'using httpclient' do
+        let(:adapter) { :httpclient }
+
+        it 'sets adapter in the meta header version to 0 when not loaded' do
+          was_required = defined?(HTTPClient)
+          if was_required
+            @klass = HTTPClient.clone
+            Object.send(:remove_const, :HTTPClient)
+          end
+
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},hc=0"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+
+          HTTPClient = @klass if was_required
+        end unless jruby?
+
+        it 'sets adapter in the meta header' do
+          require 'httpclient'
+
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},hc=#{HTTPClient::VERSION}"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+        end
+      end
+
+      context 'using typhoeus' do
+        let(:adapter) { :typhoeus }
+
+        it 'sets adapter in the meta header version to 0 when not loaded' do
+          was_required = defined?(Typhoeus)
+          if was_required
+            @klass = Typhoeus.clone
+            Object.send(:remove_const, :Typhoeus)
+          end
+
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},ty=0"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+
+          Typhoeus = @klass if was_required
+        end
+
+        it 'sets adapter in the meta header' do
+          require 'typhoeus'
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},ty=#{Typhoeus::VERSION}"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+        end
+      end unless jruby?
+
+      unless jruby?
+        let(:adapter) { :patron }
+
+        context 'using patron without requiring it' do
+          it 'sets adapter in the meta header version to 0 when not loaded' do
+            was_required = defined?(Patron)
+            if was_required
+              @klass = Patron.clone
+              Object.send(:remove_const, :Patron)
+            end
+
+            expect(headers['x-elastic-client-meta']).to match(regexp)
+            meta = "#{meta_header},pt=0"
+            expect(headers).to include('x-elastic-client-meta' => meta)
+
+            Patron = @klass if was_required
+          end
+        end
+
+        context 'using patron' do
+          it 'sets adapter in the meta header' do
+            require 'patron'
+            expect(headers['x-elastic-client-meta']).to match(regexp)
+            meta = "#{meta_header},pt=#{Patron::VERSION}"
+            expect(headers).to include('x-elastic-client-meta' => meta)
+          end
+        end
+      end
+
+      context 'using other' do
+        let(:adapter) { :some_other_adapter }
+
+        it 'sets adapter in the meta header without requiring' do
+          Faraday::Adapter.register_middleware some_other_adapter: Faraday::Adapter::NetHttpPersistent
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          expect(headers).to include('x-elastic-client-meta' => meta_header)
+        end
+
+        it 'sets adapter in the meta header' do
+          require 'net/http/persistent'
+          Faraday::Adapter.register_middleware some_other_adapter: Faraday::Adapter::NetHttpPersistent
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          expect(headers).to include('x-elastic-client-meta' => meta_header)
+        end
+      end
+    end
+
+    if defined?(JRUBY_VERSION)
+      context 'when using manticore' do
+        let(:client) do
+          described_class.new(transport_class: Elasticsearch::Transport::Transport::HTTP::Manticore).tap do |client|
+            client.instance_variable_set('@verified', true)
+          end
+        end
+        let(:subject) { client.transport.connections.first.connection.instance_variable_get("@options")[:headers]}
+
+        it 'sets manticore in the metaheader' do
+          expect(subject['x-elastic-client-meta']).to match(regexp)
+          expect(subject['x-elastic-client-meta']).to match(/mc=[0-9.]+/)
+        end
+      end
+    else
+      context 'when using curb' do
+        let(:client) do
+          described_class.new(transport_class: Elasticsearch::Transport::Transport::HTTP::Curb).tap do |client|
+            client.instance_variable_set('@verified', true)
+          end
+        end
+
+        it 'sets curb in the metaheader' do
+          expect(subject['x-elastic-client-meta']).to match(regexp)
+          expect(subject['x-elastic-client-meta']).to match(/cl=[0-9.]+/)
+        end
+      end
+    end
+
+    context 'when using custom transport implementation' do
+      let(:transport_class) do
+        Class.new do
+          def initialize(args)
+          end
+        end
+      end
+      let(:client) { Elasticsearch::Transport::Client.new(transport_class: transport_class) }
+      let(:subject) { client.instance_variable_get('@arguments')[:transport_options][:headers] }
+      let(:meta_header) do
+        if jruby?
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION}"
+        else
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION}"
+        end
+      end
+
+      it 'doesnae set any info about the implementation in the metaheader' do
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'when using a different service version' do
+      before do
+        stub_const('Elastic::ELASTICSEARCH_SERVICE_VERSION', [:ent, '8.0.0'])
+      end
+
+      let(:client) do
+        described_class.new.tap do |client|
+          client.instance_variable_set('@verified', true)
+        end
+      end
+
+      it 'sets the service version in the metaheader' do
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject['x-elastic-client-meta']).to start_with('ent=8.0.0')
+      end
+    end
+  end
+end

data/spec/elasticsearch/transport/sniffer_spec.rb

@@ -1,11 +1,23 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you 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 'spec_helper'
 
 describe Elasticsearch::Transport::Transport::Sniffer do
-
   let(:transport) do
     double('transport').tap do |t|
       allow(t).to receive(:perform_request).and_return(response)
@@ -32,7 +44,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
   end
 
   describe '#initialize' do
-
     it 'has a transport instance' do
       expect(sniffer.transport).to be(transport)
     end
@@ -43,7 +54,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
   end
 
   describe '#timeout' do
-
     let(:sniffer) do
       described_class.new(double('transport', options: {}))
     end
@@ -58,13 +68,11 @@ describe Elasticsearch::Transport::Transport::Sniffer do
   end
 
   describe '#hosts' do
-
     let(:hosts) do
       sniffer.hosts
     end
 
     context 'when the entire response is parsed' do
-
       let(:raw_response) do
         {
           "cluster_name" => "elasticsearch_test",
@@ -129,7 +137,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when the transport protocol does not match' do
-
       let(:raw_response) do
         { 'nodes' => { 'n1' => { 'foo' => { 'publish_address' => '127.0.0.1:9250' } } } }
       end
@@ -140,7 +147,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when a list of nodes is returned' do
-
       let(:raw_response) do
         { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => '127.0.0.1:9250' } },
                        'n2' => { 'http' => { 'publish_address' => '127.0.0.1:9251' } } } }
@@ -162,7 +168,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when the host and port are an ip address and port' do
-
       it 'parses the response' do
         expect(hosts.size).to eq(1)
       end
@@ -177,7 +182,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when the host and port are a hostname and port' do
-
       let(:publish_address) do
         'testhost1.com:9250'
       end
@@ -200,7 +204,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when the host and port are in the format: hostname/ip:port' do
-
       let(:publish_address) do
         'example.com/127.0.0.1:9250'
       end
@@ -218,7 +221,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
       end
 
       context 'when the address is IPv6' do
-
         let(:publish_address) do
           'example.com/[::1]:9250'
         end
@@ -238,7 +240,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when the address is IPv6' do
-
       let(:publish_address) do
         '[::1]:9250'
       end
@@ -257,7 +258,6 @@ describe Elasticsearch::Transport::Transport::Sniffer do
     end
 
     context 'when the transport has :randomize_hosts option' do
-
       let(:raw_response) do
         { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => '127.0.0.1:9250' } },
                        'n2' => { 'http' => { 'publish_address' => '127.0.0.1:9251' } } } }

data/spec/spec_helper.rb

@@ -1,12 +1,33 @@
-require 'elasticsearch'
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you 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.
+if ENV['COVERAGE'] && ENV['CI'].nil?
+  require 'simplecov'
+  SimpleCov.start { add_filter %r{^/test|spec/} }
+end
+
 require 'elasticsearch-transport'
 require 'logger'
 require 'ansi/code'
 require 'hashie/mash'
-require 'pry-nav'
 if defined?(JRUBY_VERSION)
   require 'elasticsearch/transport/transport/http/manticore'
+  require 'pry-nav'
 else
+  require 'pry-byebug'
   require 'elasticsearch/transport/transport/http/curb'
   require 'curb'
 end
@@ -14,10 +35,12 @@ end
 # The hosts to use for creating a elasticsearch client.
 #
 # @since 7.0.0
-ELASTICSEARCH_HOSTS = if hosts = ENV['TEST_ES_SERVER'] || ENV['ELASTICSEARCH_HOSTS']
+ELASTICSEARCH_HOSTS = if (hosts = ENV['TEST_ES_SERVER'] || ENV['ELASTICSEARCH_HOSTS'])
                         hosts.split(',').map do |host|
                           /(http\:\/\/)?(\S+)/.match(host)[2]
                         end
+                      else
+                        ['localhost:9200']
                       end.freeze
 
 TEST_HOST, TEST_PORT = ELASTICSEARCH_HOSTS.first.split(':') if ELASTICSEARCH_HOSTS
@@ -37,7 +60,8 @@ end
 #
 # @since 7.0.0
 def node_names
-  $node_names ||= default_client.nodes.stats['nodes'].collect do |name, stats|
+  node_stats = default_client.perform_request('GET', '_nodes/stats').body
+  $node_names ||= node_stats['nodes'].collect do |name, stats|
     stats['name']
   end
 end
@@ -51,10 +75,12 @@ def default_client
   $client ||= Elasticsearch::Client.new(hosts: ELASTICSEARCH_HOSTS)
 end
 
-module Config
+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.
     #
     # @since 7.0.0

data/test/integration/jruby_test.rb

@@ -0,0 +1,43 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you 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 'test_helper'
+
+if JRUBY
+  require 'elasticsearch/transport/transport/http/manticore'
+
+  class Elasticsearch::Transport::ClientManticoreIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+    context "Transport" do
+      setup do
+        @host, @port = ELASTICSEARCH_HOSTS.first.split(':')
+      end
+
+      shutdown do
+        begin; Object.send(:remove_const, :Manticore); rescue NameError; end
+      end
+
+      should 'allow to customize the Faraday adapter to Manticore' do
+        client = Elasticsearch::Transport::Client.new(
+          transport_class: Elasticsearch::Transport::Transport::HTTP::Manticore,
+          trace: true,
+          hosts: [ { host: @host, port: @port } ]
+        )
+        response = client.perform_request 'GET', ''
+        assert_respond_to(response.body, :to_hash)
+      end
+    end
+  end
+end