elasticsearch-transport 7.11.1 → 7.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a61db52575ad4a8669cbef5e60e6f90607f82155206c85e9e473835dfa35e0e5
-  data.tar.gz: e8d2f1899f4ebf17cfafdfee98174f86ba52633f04d8fadd30ec9b4d31457546
+  metadata.gz: fc7f64d6af1a163b0f6a2fb2f95aaab42e8f797b998e4a3d34fed1bc21ea3ccb
+  data.tar.gz: 1b00c2e0cdd62483465ca14d093475a7ec2f9d976e2e50565c8e27b44b06634d
 SHA512:
-  metadata.gz: 0ca54a9d0f096d1f8675ea7ef4d84da517f34ffeea31c9ce72f3c4a9257cfab33d6548582490ff7f87708a0ff3bc25a29c907274870d2ea22df34d7585c6d59e
-  data.tar.gz: 854a17c7995ceede84fa87f73ccb7fafd8d57a8ff400429e8877258bd00e7cadbc69562400af8d682cb195b51599867bfce2fc84db151d3bff45c846844b188b
+  metadata.gz: '0899b3da62ed4fd0fd7d6d02defa75354d85fd05ed83c9ac3fa40e6ea597011620f84ad38c30273e7fb11deb4e34f2dd3a469407a6848f56ecdcdaf35fb53a8e'
+  data.tar.gz: 41e7690ac6a1d40f7632ae91a16bf707040bda14783074caceaa7f91ab1f66d4c3d58b6c5ec6b2a581c4f7d69e6db94f4e849c15f5d3b8db3bed584f943c655c

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
@@ -165,13 +167,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
@@ -206,78 +208,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}
-            else
-              {}
-            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,120 @@
+# 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 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
+
+      # 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.1'.freeze
+    VERSION = '7.12.0'.freeze
   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'
@@ -154,6 +188,12 @@ describe Elasticsearch::Transport::Client do
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-transport
 version: !ruby/object:Gem::Version
-  version: 7.11.1
+  version: 7.12.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-03-23 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