elasticsearch-transport 7.11.0 → 7.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e2f0e5d372dfa4495b762d82a182fab89c57fa56b7c62649587843dea8c2faf
-  data.tar.gz: f9d02a71dec534954eb87f1a777b1410578d378b15454193295aca9dfcaf5586
+  metadata.gz: 7450e65878dd55088bede46fce476da9741626497de99f0b529c69ff31b244eb
+  data.tar.gz: a53fc0c6ca93ec006f31adce15c69e199c58d4aa70dc0925ad979958eca2560e
 SHA512:
-  metadata.gz: 625ac145cc74529c6a383309e6a2ee0729bf57f2858b2dc7d769f79025cf925256b9c5a531be52e070a419d3ed7efd525474eb8781aca87caad7b7fffa21c6e0
-  data.tar.gz: 683c674b9778ff15d2d82ac05d667e05944e897be3e0deebaf7277dbdaf837d5df2ad17ff9b4fb91b75f4b162a229e1ac8c9b6eee419c717db2a7e2e7668531f
+  metadata.gz: e77be4dc4155782e358d20fc0eed4c6d164aad4e1c7fa93aec4a4e61b54bfb3674f1c363ffd6382b88423e455b1739fe0fd67fdf79024a60fc96e7f84296bf03
+  data.tar.gz: 46efad58b4e8464ebc8fee9fe74bb1438c5f9bf32de8c3cfe70d96611b66e1b478582bd6dfea33d5868af1fdd5cb8b230bcb8f837970df362036f4a015a2f2b6

data/lib/elasticsearch/transport/client.rb

@@ -16,6 +16,7 @@
 # under the License.
 
 require 'base64'
+require 'elasticsearch/transport/meta_header'
 
 module Elasticsearch
   module Transport
@@ -25,6 +26,7 @@ module Elasticsearch
     # See {file:README.md README} for usage and code examples.
     #
     class Client
+      include MetaHeader
       DEFAULT_TRANSPORT_CLASS  = Transport::HTTP::Faraday
 
       DEFAULT_LOGGER = lambda do
@@ -143,14 +145,15 @@ module Elasticsearch
         @options[:http]                 ||= {}
 
         set_api_key if (@api_key = @arguments[:api_key])
+        set_compatibility_header if ENV['ELASTIC_CLIENT_APIVERSIONING']
 
         @seeds = extract_cloud_creds(@arguments)
         @seeds ||= __extract_hosts(@arguments[:hosts] ||
-                                     @arguments[:host] ||
-                                     @arguments[:url] ||
-                                     @arguments[:urls] ||
-                                     ENV['ELASTICSEARCH_URL'] ||
-                                     DEFAULT_HOST)
+                                   @arguments[:host] ||
+                                   @arguments[:url] ||
+                                   @arguments[:urls] ||
+                                   ENV['ELASTICSEARCH_URL'] ||
+                                   DEFAULT_HOST)
 
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
         @opaque_id_prefix = @arguments[:opaque_id_prefix] || nil
@@ -165,13 +168,13 @@ module Elasticsearch
           @transport_class = @arguments[:transport_class] || DEFAULT_TRANSPORT_CLASS
           @transport = if @transport_class == Transport::HTTP::Faraday
                          @arguments[:adapter] ||= __auto_detect_adapter
-                         set_meta_header
+                         set_meta_header # from include MetaHeader
                          @transport_class.new(hosts: @seeds, options: @arguments) do |faraday|
                            faraday.adapter(@arguments[:adapter])
                            block&.call faraday
                          end
                        else
-                         set_meta_header
+                         set_meta_header # from include MetaHeader
                          @transport_class.new(hosts: @seeds, options: @arguments)
                        end
         end
@@ -198,6 +201,17 @@ module Elasticsearch
         @arguments.delete(:password)
       end
 
+      def set_compatibility_header
+        return unless ['1', 'true'].include?(ENV['ELASTIC_CLIENT_APIVERSIONING'])
+
+        add_header(
+          {
+            'Accept' => 'application/vnd.elasticsearch+json;compatible-with=7',
+            'Content-Type' => 'application/vnd.elasticsearch+json; compatible-with=7'
+          }
+        )
+      end
+
       def add_header(header)
         headers = @arguments[:transport_options]&.[](:headers) || {}
         headers.merge!(header)
@@ -206,76 +220,6 @@ module Elasticsearch
         )
       end
 
-      def set_meta_header
-        return if @arguments[:enable_meta_header] == false
-
-        service, version = meta_header_service_version
-
-        meta_headers = {
-          service.to_sym => version,
-          rb: RUBY_VERSION,
-          t: Elasticsearch::Transport::VERSION
-        }
-        meta_headers.merge!(meta_header_engine) if meta_header_engine
-        meta_headers.merge!(meta_header_adapter) if meta_header_adapter
-
-        add_header({ 'x-elastic-client-meta' => meta_headers.map { |k, v| "#{k}=#{v}" }.join(',') })
-      end
-
-      def meta_header_service_version
-        if defined?(Elastic::META_HEADER_SERVICE_VERSION)
-          Elastic::META_HEADER_SERVICE_VERSION
-        elsif defined?(Elasticsearch::VERSION)
-          [:es, client_meta_version(Elasticsearch::VERSION)]
-        else
-          [:es, client_meta_version(Elasticsearch::Transport::VERSION)]
-        end
-      end
-
-      def client_meta_version(version)
-        regexp = /^([0-9]+\.[0-9]+\.[0-9]+)(\.?[a-z0-9.-]+)?$/
-        match = version.match(regexp)
-        return "#{match[1]}p" if (match[2])
-
-        version
-      end
-
-      def meta_header_engine
-        case RUBY_ENGINE
-        when 'ruby'
-          {}
-        when 'jruby'
-          { jv: ENV_JAVA['java.version'], jr: JRUBY_VERSION }
-        when 'rbx'
-          { rbx: RUBY_VERSION }
-        else
-          { RUBY_ENGINE.to_sym => RUBY_VERSION }
-        end
-      end
-
-      def meta_header_adapter
-        if @transport_class == Transport::HTTP::Faraday
-          {fd: Faraday::VERSION}.merge(
-            case @arguments[:adapter]
-            when :patron
-              {pt: Patron::VERSION}
-            when :net_http
-              {nh: defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}
-            when :typhoeus
-              {ty: Typhoeus::VERSION}
-            when :httpclient
-              {hc: HTTPClient::VERSION}
-            when :net_http_persistent
-              {np: Net::HTTP::Persistent::VERSION}
-            end
-          )
-        elsif defined?(Transport::HTTP::Curb) && @transport_class == Transport::HTTP::Curb
-          {cl: Curl::CURB_VERSION}
-        elsif defined?(Transport::HTTP::Manticore) && @transport_class == Transport::HTTP::Manticore
-          {mc: Manticore::VERSION}
-        end
-      end
-
       def extract_cloud_creds(arguments)
         return unless arguments[:cloud_id] && !arguments[:cloud_id].empty?
 

data/lib/elasticsearch/transport/meta_header.rb

@@ -0,0 +1,135 @@
+# 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 'base64'
+
+module Elasticsearch
+  module Transport
+    # Methods for the Elastic meta header used by Cloud.
+    # X-Elastic-Client-Meta HTTP header which is used by Elastic Cloud and can be disabled when
+    # instantiating the Client with the :enable_meta_header parameter set to `false`.
+    #
+    module MetaHeader
+      def set_meta_header
+        return if @arguments[:enable_meta_header] == false
+
+        service, version = meta_header_service_version
+
+        meta_headers = {
+          service.to_sym => version,
+          rb: RUBY_VERSION,
+          t: Elasticsearch::Transport::VERSION
+        }
+        meta_headers.merge!(meta_header_engine) if meta_header_engine
+        meta_headers.merge!(meta_header_adapter) if meta_header_adapter
+
+        add_header({ 'x-elastic-client-meta' => meta_headers.map { |k, v| "#{k}=#{v}" }.join(',') })
+      end
+
+      def meta_header_service_version
+        if enterprise_search?
+          Elastic::ENTERPRISE_SERVICE_VERSION
+        elsif elasticsearch?
+          Elastic::ELASTICSEARCH_SERVICE_VERSION
+        elsif defined?(Elasticsearch::VERSION)
+          [:es, client_meta_version(Elasticsearch::VERSION)]
+        else
+          [:es, client_meta_version(Elasticsearch::Transport::VERSION)]
+        end
+      end
+
+      def enterprise_search?
+        defined?(Elastic::ENTERPRISE_SERVICE_VERSION) &&
+          called_from?('enterprise-search-ruby')
+      end
+
+      def elasticsearch?
+        defined?(Elastic::ELASTICSEARCH_SERVICE_VERSION) &&
+          called_from?('elasticsearch')
+      end
+
+      def called_from?(service)
+        !caller.select { |c| c.match?(service) }.empty?
+      end
+
+      # We return the current version if it's a release, but if it's a pre/alpha/beta release we
+      # return <VERSION_NUMBER>p
+      #
+      def client_meta_version(version)
+        regexp = /^([0-9]+\.[0-9]+\.[0-9]+)(\.?[a-z0-9.-]+)?$/
+        match = version.match(regexp)
+        return "#{match[1]}p" if (match[2])
+
+        version
+      end
+
+      def meta_header_engine
+        case RUBY_ENGINE
+        when 'ruby'
+          {}
+        when 'jruby'
+          { jv: ENV_JAVA['java.version'], jr: JRUBY_VERSION }
+        when 'rbx'
+          { rbx: RUBY_VERSION }
+        else
+          { RUBY_ENGINE.to_sym => RUBY_VERSION }
+        end
+      end
+
+      # This function tries to define the version for the Faraday adapter. If it hasn't been loaded
+      # by the time we're calling this method, it's going to report the adapter (if we know it) but
+      # return 0 as the version. It won't report anything when using a custom adapter we don't
+      # identify.
+      #
+      # Returns a Hash<adapter_alias, version>
+      #
+      def meta_header_adapter
+        if @transport_class == Transport::HTTP::Faraday
+          version = '0'
+          adapter_version = case @arguments[:adapter]
+                   when :patron
+                     version = Patron::VERSION if defined?(::Patron::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}
+                   when :typhoeus
+                     version = Typhoeus::VERSION if defined?(::Typhoeus::VERSION)
+                     {ty: version}
+                   when :httpclient
+                     version = HTTPClient::VERSION if defined?(HTTPClient::VERSION)
+                     {hc: version}
+                   when :net_http_persistent
+                     version = Net::HTTP::Persistent::VERSION if defined?(Net::HTTP::Persistent::VERSION)
+                     {np: version}
+                   else
+                     {}
+                   end
+          {fd: Faraday::VERSION}.merge(adapter_version)
+        elsif defined?(Transport::HTTP::Curb) && @transport_class == Transport::HTTP::Curb
+          {cl: Curl::CURB_VERSION}
+        elsif defined?(Transport::HTTP::Manticore) && @transport_class == Transport::HTTP::Manticore
+          {mc: Manticore::VERSION}
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elasticsearch
   module Transport
-    VERSION = '7.11.0'.freeze
+    VERSION = '7.13.0'.freeze
   end
 end

data/spec/elasticsearch/transport/client_spec.rb

@@ -266,7 +266,7 @@ describe Elasticsearch::Transport::Client do
       it 'uses Faraday with the adapter' do
         expect(adapter).to eq Faraday::Adapter::Typhoeus
       end
-    end
+    end unless jruby?
 
     context 'when the adapter is specified as a string key' do
       let(:adapter) do
@@ -1428,6 +1428,46 @@ describe Elasticsearch::Transport::Client do
       end
     end
 
+    context 'when using the API Compatibility Header' do
+      it 'sets the API compatibility headers' do
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = 'true'
+        client = described_class.new(host: hosts)
+        headers = client.transport.connections.first.connection.headers
+
+        expect(headers['Content-Type']).to eq('application/vnd.elasticsearch+json; compatible-with=7')
+        expect(headers['Accept']).to eq('application/vnd.elasticsearch+json;compatible-with=7')
+
+        response = client.perform_request('GET', '/')
+        expect(response.headers['content-type']).to eq('application/json; charset=UTF-8')
+
+        ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
+      end
+
+      it 'does not use API compatibility headers' do
+        val = ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = val
+      end
+
+      it 'does not use API compatibility headers when it is set to unsupported values' do
+        val = ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
+
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = 'test'
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = 'false'
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = '3'
+        client = described_class.new(host: hosts)
+        expect(client.transport.connections.first.connection.headers['Content-Type']).to eq('application/json')
+        ENV['ELASTIC_CLIENT_APIVERSIONING'] = val
+      end
+    end
+
     context 'when Elasticsearch response includes a warning header' do
       let(:client) do
         Elasticsearch::Transport::Client.new(hosts: hosts)
@@ -1776,7 +1816,7 @@ describe Elasticsearch::Transport::Client do
             it 'preserves the other headers' do
               expect(client.transport.connections[0].connection.headers['User-Agent'])
             end
-          end
+          end unless jruby?
         end
       end
 

data/spec/elasticsearch/transport/meta_header_spec.rb

@@ -32,7 +32,7 @@ describe Elasticsearch::Transport::Client do
       end
     end
 
-    context 'client_meta_version_' do
+    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
@@ -108,6 +108,14 @@ describe Elasticsearch::Transport::Client do
       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
+          fork {
+            expect(headers['x-elastic-client-meta']).to match(regexp)
+            meta = "#{meta_header},np=0"
+            expect(headers).to include('x-elastic-client-meta' => meta)
+          }
+        end unless jruby?
+
         it 'sets adapter in the meta header' do
           require 'net/http/persistent'
           expect(headers['x-elastic-client-meta']).to match(regexp)
@@ -119,6 +127,14 @@ describe Elasticsearch::Transport::Client do
       context 'using httpclient' do
         let(:adapter) { :httpclient }
 
+        it 'sets adapter in the meta header version to 0 when not loaded' do
+          fork {
+            expect(headers['x-elastic-client-meta']).to match(regexp)
+            meta = "#{meta_header},hc=0"
+            expect(headers).to include('x-elastic-client-meta' => meta)
+          }
+        end unless jruby?
+
         it 'sets adapter in the meta header' do
           require 'httpclient'
           expect(headers['x-elastic-client-meta']).to match(regexp)
@@ -130,6 +146,14 @@ describe Elasticsearch::Transport::Client do
       context 'using typhoeus' do
         let(:adapter) { :typhoeus }
 
+        it 'sets adapter in the meta header version to 0 when not loaded' do
+          fork {
+            expect(headers['x-elastic-client-meta']).to match(regexp)
+            meta = "#{meta_header},ty=0"
+            expect(headers).to include('x-elastic-client-meta' => meta)
+          }
+        end unless jruby?
+
         it 'sets adapter in the meta header' do
           require 'typhoeus'
           expect(headers['x-elastic-client-meta']).to match(regexp)
@@ -138,9 +162,19 @@ describe Elasticsearch::Transport::Client do
         end
       end
 
-      unless defined?(JRUBY_VERSION)
+      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
+            fork {
+              expect(headers['x-elastic-client-meta']).to match(regexp)
+              meta = "#{meta_header},pt=0"
+              expect(headers).to include('x-elastic-client-meta' => meta)
+            }
+          end
+        end
+
         context 'using patron' do
           it 'sets adapter in the meta header' do
             require 'patron'
@@ -150,6 +184,23 @@ describe Elasticsearch::Transport::Client do
           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)
@@ -200,7 +251,7 @@ describe Elasticsearch::Transport::Client do
 
     context 'when using a different service version' do
       before do
-        stub_const("Elastic::META_HEADER_SERVICE_VERSION", [:ent, '8.0.0'])
+        stub_const('Elastic::ELASTICSEARCH_SERVICE_VERSION', [:ent, '8.0.0'])
       end
 
       let(:client) { Elasticsearch::Client.new }

data/test/integration/transport_test.rb

@@ -32,7 +32,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       begin; Object.send(:remove_const, :Patron);   rescue NameError; end
     end
 
-    should "allow to customize the Faraday adapter" do
+    should "allow to customize the Faraday adapter to Typhoeus" do
       require 'typhoeus'
       require 'typhoeus/adapters/faraday'
 
@@ -42,6 +42,19 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
           f.adapter  :typhoeus
         end
 
+      client = Elasticsearch::Transport::Client.new transport: transport
+      client.perform_request 'GET', ''
+    end unless jruby?
+
+    should "allow to customize the Faraday adapter to NetHttpPersistent" do
+      require 'net/http/persistent'
+
+      transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new \
+                                                                       :hosts => [ { host: @host, port: @port } ] do |f|
+        f.response :logger
+        f.adapter  :net_http_persistent
+      end
+
       client = Elasticsearch::Transport::Client.new transport: transport
       client.perform_request 'GET', ''
     end

data/test/unit/connection_test.rb

@@ -64,8 +64,8 @@ class Elasticsearch::Transport::Transport::Connections::ConnectionTest < Minites
 
     should "have a string representation" do
       c = Connection.new :host => 'x'
-      assert_match /host: x/, c.to_s
-      assert_match /alive/,   c.to_s
+      assert_match(/host: x/, c.to_s)
+      assert_match(/alive/,   c.to_s)
     end
 
     should "not be dead by default" do

data/test/unit/transport_base_test.rb

@@ -429,7 +429,7 @@ class Elasticsearch::Transport::Transport::BaseTest < Minitest::Test
       @transport.stubs(:get_connection).returns(fake_connection)
 
       @transport.logger.expects(:info).with do |message|
-        assert_match /http:\/\/user:\*{1,15}@localhost\:9200/, message
+        assert_match(/http:\/\/user:\*{1,15}@localhost\:9200/, message)
         true
       end
 

data/test/unit/transport_faraday_test.rb

@@ -149,7 +149,7 @@ class Elasticsearch::Transport::Transport::HTTP::FaradayTest < Minitest::Test
 
       transport.connections.first.connection.expects(:run_request).
         with do |method, url, params, body|
-          assert_match /\?format=yaml/, url
+          assert_match(/\?format=yaml/, url)
           true
         end.
         returns(stub_everything)
@@ -167,7 +167,7 @@ class Elasticsearch::Transport::Transport::HTTP::FaradayTest < Minitest::Test
 
       transport.connections.first.connection.expects(:run_request).
         with do |method, url, params, body|
-          assert_match /\?format=json/, url
+          assert_match(/\?format=json/, url)
           true
         end.
         returns(stub_everything)

data/test/unit/transport_manticore_test.rb

@@ -145,8 +145,8 @@ else
         transport = Manticore.new :hosts => [ { :host => 'foobar', :port => 1234 } ], :options => options
         transport.connections.first.connection
           .expects(:get)
-          .with do |host, options|
-            assert_equal 'myapp-0.0', options[:headers]['User-Agent']
+          .with do |host, _options|
+            assert_equal 'myapp-0.0', _options[:headers]['User-Agent']
             true
           end
           .returns(stub_everything)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 7.11.0
+  version: 7.13.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -373,6 +373,7 @@ files:
 - lib/elasticsearch-transport.rb
 - lib/elasticsearch/transport.rb
 - lib/elasticsearch/transport/client.rb
+- lib/elasticsearch/transport/meta_header.rb
 - lib/elasticsearch/transport/redacted.rb
 - lib/elasticsearch/transport/transport/base.rb
 - lib/elasticsearch/transport/transport/connections/collection.rb
@@ -428,7 +429,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Ruby client for Elasticsearch.