elastic-transport 8.3.1 → 8.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bb7bc2413d7967ff3ab408dc2615d71e1140a240f34f2b67c21550705c42b3d
-  data.tar.gz: 82ba1e4d3be8ddb205b6d25c10ebffed36e20b6e267251122c80e1d1c87c3950
+  metadata.gz: a4543af71a663d5f638c673407101529237507d56e7e2034f0c7e9fd5dd78c6a
+  data.tar.gz: 39a000ce02f4cf2208d0ec41f51f133e74454748f90eb6617d08bac3aad7e572
 SHA512:
-  metadata.gz: fb8b615d737254668a504439eede4e41e42327097a2160f66eee04cf84ff2bd26e89230f261870fab9aad337080a5562326a52792b8059e5f735a4e757d5ac29
-  data.tar.gz: 342e0ad9f8c38e64cce7bebd45c706d4365449627c6ef31ffced9a7822c4250b1b76a156265ae9d8775874e864fb2f061bde0d76745ad9ed362f9cdd19bf5bbb
+  metadata.gz: 747447a8e84b3f71f1b8244237809c2087e60de35426820d065de72fb57b9ab17094ee1fb95e2f228c41902098b1d2ba8fd1f248f6d2cf493785d50745c08ec0
+  data.tar.gz: 6923af2b78bf3a8ecb956038a878f1752723546dfdabd3d6d3492f545f9d51312807a8faf7a8e1adee21b34034d95569b01939172198eb572709d16e6e5ace53

data/.github/workflows/license.yml

@@ -4,7 +4,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 3

data/.github/workflows/otel.yml

@@ -17,10 +17,10 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['3.3', 'jruby-9.4']
-        es_version: ['8.12-SNAPSHOT']
+        es_version: ['8.15.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Increase system limits
         run: |
           sudo swapoff -a

data/.github/workflows/tests.yml

@@ -15,11 +15,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.0', '3.1', '3.2', '3.3', 'jruby-9.3', 'jruby-9.4' ]
-        es_version: ['8.10-SNAPSHOT', '8.11-SNAPSHOT', '8.12-SNAPSHOT']
+        ruby: ['3.0', '3.1', '3.2', '3.3', 'jruby-9.3', 'jruby-9.4']
+        es_version: ['8.14.2-SNAPSHOT', '8.15.0-SNAPSHOT', '8.16.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Increase system limits
       run: |
         sudo swapoff -a
@@ -53,11 +53,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.0', '3.1', '3.2', '3.3', 'jruby-9.3' ]
-        es_version: ['8.12-SNAPSHOT']
+        ruby: ['3.0', '3.1', '3.2', '3.3', 'jruby-9.3']
+        es_version: ['8.16.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Increase system limits
       run: |
         sudo swapoff -a
@@ -76,7 +76,6 @@ jobs:
         sudo apt-get update
         sudo apt-get install libcurl4-openssl-dev
         ruby -v
-        gem install bundler
         BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle install
     - name: faraday1 unit tests
       run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 8.3.5
+
+- Small updates in source code documentation.
+- Updates meta header for Elasticsearch Serverless.
+- Fixes issues with ES_SERVERLESS_SERVICE_VERSION for backwards compatibility
+
+## 8.3.3, 8.3.4 (yanked)
+
+- Yanked due to errors.
+
+## 8.3.2
+
+- OpenTelemetry: In v8.3.0 and v8.3.1, the environment variable `OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY` was available but is now deprecated in favor of `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY`.
+
 ## 8.3.1
 
 Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, 3.3, JRuby 9.3 and JRuby 9.4

data/Gemfile

@@ -23,16 +23,14 @@ gemspec
 group :development, :test do
   gem 'faraday-httpclient'
   gem 'faraday-net_http_persistent'
-  gem 'faraday-patron' unless defined? JRUBY_VERSION
   gem 'faraday-typhoeus'
-  gem 'rspec'
-  gem 'oj' unless defined? JRUBY_VERSION
+  gem 'opentelemetry-sdk', require: false if RUBY_VERSION >= '3.0'
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else
+    gem 'faraday-patron'
+    gem 'oj'
     gem 'pry-byebug'
   end
-  if RUBY_VERSION >= '3.0'
-    gem 'opentelemetry-sdk', require: false
-  end
+  gem 'rspec'
 end

data/Gemfile-faraday1.gemfile

@@ -23,18 +23,18 @@ source 'https://rubygems.org'
 # $ BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit
 
 gem 'faraday', '~> 1'
-gemspec path: './'
+gemspec
 
 group :development, :test do
   gem 'httpclient'
   gem 'net-http-persistent'
-  gem 'patron' unless defined? JRUBY_VERSION
   gem 'rspec'
   gem 'typhoeus'
-  gem 'oj' unless defined? JRUBY_VERSION
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else
     gem 'pry-byebug'
+    gem 'oj'
+    gem 'patron'
   end
 end

data/lib/elastic/transport/client.rb

@@ -83,7 +83,7 @@ module Elastic
       #
       # @option arguments [Integer] :sniffer_timeout   Timeout for reloading connections in seconds (1 by default)
       #
-      # @option arguments [Boolean,Number] :retry_on_failure   Retry X times when request fails before raising and
+      # @option arguments [Boolean,Number] :retry_on_failure   Retry X times when request fails before raising an
       #                                                        exception (false by default)
       # @option arguments [Number] :delay_on_retry  Delay in milliseconds between each retry (0 by default)
       #
@@ -91,7 +91,8 @@ module Elastic
       #
       # @option arguments [Boolean] :reload_on_failure Reload connections after failure (false by default)
       #
-      # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in options
+      # @option arguments [Integer] :request_timeout The request timeout to be passed to transport in options in seconds 
+      #                                              (the default value is taken from the transport)
       #
       # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
       #
@@ -110,7 +111,7 @@ module Elastic
       #
       # @option arguments [String] :send_get_body_as Specify the HTTP method to use for GET requests with a body.
       #                                              (Default: GET)
-      # @option arguments [true, false] :compression Whether to compress requests. Gzip compression will be used.
+      # @option arguments [Boolean] :compression Whether to compress requests. Gzip compression will be used.
       #   The default is false. Responses will automatically be inflated if they are compressed.
       #   If a custom transport object is used, it must handle the request compression and response inflation.
       #
@@ -172,7 +173,7 @@ module Elastic
       # Performs a request through delegation to {#transport}.
       #
       def perform_request(method, path, params = {}, body = nil, headers = nil, opts = {})
-        method = @send_get_body_as if 'GET' == method && body
+        method = @send_get_body_as if method == 'GET' && body
         validate_ca_fingerprints if @ca_fingerprint
         if @otel
           # If no endpoint is specified in the opts, use the HTTP method name

data/lib/elastic/transport/meta_header.rb

@@ -41,6 +41,12 @@ module Elastic
       def meta_header_service_version
         if enterprise_search?
           Elastic::ENTERPRISE_SERVICE_VERSION
+        elsif serverless?
+          if defined?(Elastic::ES_SERVERLESS_SERVICE_VERSION)
+            Elastic::ES_SERVERLESS_SERVICE_VERSION
+          else
+            Elastic::ELASTICSEARCH_SERVICE_VERSION
+          end
         elsif elasticsearch?
           Elastic::ELASTICSEARCH_SERVICE_VERSION
         elsif defined?(Elasticsearch::VERSION)
@@ -60,6 +66,11 @@ module Elastic
           called_from?('elasticsearch')
       end
 
+      def serverless?
+        defined?(ElasticsearchServerless::CLIENT_VERSION) &&
+          called_from?('elasticsearch-serverless')
+      end
+
       def called_from?(service)
         !caller.select { |c| c.match?(service) }.empty?
       end
@@ -70,7 +81,7 @@ module Elastic
       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])
+        return "#{match[1]}p" if match[2]
 
         version
       end

data/lib/elastic/transport/opentelemetry.rb

@@ -27,7 +27,8 @@ module Elastic
       # Describes how to handle search queries in the request body when assigned to
       # a span attribute.
       # Valid values are 'raw', 'omit', 'sanitize'. Default is 'omit'.
-      ENV_VARIABLE_BODY_STRATEGY = 'OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'
+      ENV_VARIABLE_BODY_STRATEGY = 'OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'
+      ENV_VARIABLE_DEPRECATED_BODY_STRATEGY = 'OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY'
       DEFAULT_BODY_STRATEGY = 'omit'
       # A string list of keys whose values are redacted. This is only relevant if the body strategy is
       # 'sanitize'. For example, a config 'sensitive-key,other-key' will redact the values at
@@ -53,7 +54,8 @@ module Elastic
         @tracer = (opts[:opentelemetry_tracer_provider] || ::OpenTelemetry.tracer_provider).tracer(
           OTEL_TRACER_NAME, Elastic::Transport::VERSION
         )
-        @body_strategy = ENV[ENV_VARIABLE_BODY_STRATEGY] || DEFAULT_BODY_STRATEGY
+        @body_strategy = ENV[ENV_VARIABLE_DEPRECATED_BODY_STRATEGY] || ENV[ENV_VARIABLE_BODY_STRATEGY] ||
+                           DEFAULT_BODY_STRATEGY
         @sanitize_keys = ENV[ENV_VARIABLE_BODY_SANITIZE_KEYS]&.split(',')&.collect! do |pattern|
           Regexp.new(pattern.gsub('*', '.*'))
         end

data/lib/elastic/transport/transport/serializer/multi_json.rb

@@ -24,7 +24,7 @@ module Elastic
         module Base
           # @param transport [Object] The instance of transport which uses this serializer
           #
-          def initialize(transport=nil)
+          def initialize(transport = nil)
             @transport = transport
           end
         end
@@ -36,13 +36,13 @@ module Elastic
 
           # De-serialize a Hash from JSON string
           #
-          def load(string, options={})
+          def load(string, options = {})
             ::MultiJson.load(string, options)
           end
 
           # Serialize a Hash to JSON string
           #
-          def dump(object, options={})
+          def dump(object, options = {})
             ::MultiJson.dump(object, options)
           end
         end

data/lib/elastic/transport/version.rb

@@ -17,6 +17,6 @@
 
 module Elastic
   module Transport
-    VERSION = '8.3.1'.freeze
+    VERSION = '8.3.5'.freeze
   end
 end

data/spec/elastic/transport/opentelemetry_spec.rb

@@ -131,6 +131,25 @@ if defined?(::OpenTelemetry)
           end
         end
 
+        context 'with deprecated ENV variable' do
+          let(:sanitized_body) do
+            { query: { match: { password: 'REDACTED' } } }
+          end
+
+          around(:example) do |ex|
+            body_strategy = ENV[described_class::ENV_VARIABLE_DEPRECATED_BODY_STRATEGY]
+            ENV[described_class::ENV_VARIABLE_DEPRECATED_BODY_STRATEGY]  = 'sanitize'
+            ex.run
+            ENV[described_class::ENV_VARIABLE_DEPRECATED_BODY_STRATEGY] = body_strategy
+          end
+
+          it 'sanitizes the body' do
+            client.perform_request('GET', '/_search', nil, body, nil, endpoint: 'search')
+
+            expect(span.attributes['db.statement']).to eq(sanitized_body.to_json)
+          end
+        end
+
         context 'with custom keys' do
           let(:body) do
             { query: { match: { sensitive: { query: 'secret'} } } }

data/test/unit/connection_test.rb

@@ -20,66 +20,66 @@ require 'test_helper'
 class Elastic::Transport::Transport::Connections::ConnectionTest < Minitest::Test
   include Elastic::Transport::Transport::Connections
 
-  context "Connection" do
-    should "be initialized with :host, :connection, and :options" do
+  context 'Connection' do
+    should 'be initialized with :host, :connection, and :options' do
       c = Connection.new :host => 'x', :connection => 'y', :options => {}
       assert_equal 'x', c.host
       assert_equal 'y', c.connection
       assert_instance_of Hash, c.options
     end
 
-    should "return full path" do
+    should 'return full path' do
       c = Connection.new
       assert_equal '_search', c.full_path('_search')
       assert_equal '_search', c.full_path('_search', {})
-      assert_equal '_search?foo=bar', c.full_path('_search', {:foo => 'bar'})
-      assert_equal '_search?foo=bar+bam', c.full_path('_search', {:foo => 'bar bam'})
+      assert_equal '_search?foo=bar', c.full_path('_search', {foo: 'bar'})
+      assert_equal '_search?foo=bar+bam', c.full_path('_search', {foo: 'bar bam'})
     end
 
-    should "return full url" do
-      c = Connection.new :host => { :protocol => 'http', :host => 'localhost', :port => '9200' }
-      assert_equal 'http://localhost:9200/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    should 'return full url' do
+      c = Connection.new host: { protocol: 'http', host: 'localhost', port: '9200' }
+      assert_equal 'http://localhost:9200/_search?foo=bar', c.full_url('_search', { foo: 'bar' })
     end
 
-    should "return full url with credentials" do
-      c = Connection.new :host => { :protocol => 'http', :user => 'U', :password => 'P', :host => 'localhost', :port => '9200' }
-      assert_equal 'http://U:P@localhost:9200/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    should 'return full url with credentials' do
+      c = Connection.new host: { protocol: 'http', user: 'U', password: 'P', host: 'localhost', port: '9200' }
+      assert_equal 'http://U:P@localhost:9200/_search?foo=bar', c.full_url('_search', { foo: 'bar' })
     end
 
-    should "return full url with escaped credentials" do
-      c = Connection.new :host => { :protocol => 'http', :user => 'U$$$', :password => 'P^^^', :host => 'localhost', :port => '9200' }
-      assert_equal 'http://U%24%24%24:P%5E%5E%5E@localhost:9200/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    should 'return full url with escaped credentials' do
+      c = Connection.new host: { protocol: 'http', user: 'U$$$', password: 'P^^^', host: 'localhost', port: '9200' }
+      assert_equal 'http://U%24%24%24:P%5E%5E%5E@localhost:9200/_search?foo=bar', c.full_url('_search', { foo: 'bar' })
     end
 
-    should "return full url with path" do
-      c = Connection.new :host => { :protocol => 'http', :host => 'localhost', :port => '9200', :path => '/foo' }
-      assert_equal 'http://localhost:9200/foo/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    should 'return full url with path' do
+      c = Connection.new host: { protocol: 'http', host: 'localhost', port: '9200', path: '/foo' }
+      assert_equal 'http://localhost:9200/foo/_search?foo=bar', c.full_url('_search', { foo: 'bar' })
     end
 
-    should "return right full url with path when path starts with /" do
-      c = Connection.new :host => { :protocol => 'http', :host => 'localhost', :port => '9200', :path => '/foo' }
-      assert_equal 'http://localhost:9200/foo/_search?foo=bar', c.full_url('/_search', {:foo => 'bar'})
+    should 'return right full url with path when path starts with /' do
+      c = Connection.new host: { protocol: 'http', host: 'localhost', port: '9200', path: '/foo' }
+      assert_equal 'http://localhost:9200/foo/_search?foo=bar', c.full_url('/_search', { foo: 'bar' })
     end
 
-    should "have a string representation" do
-      c = Connection.new :host => 'x'
+    should 'have a string representation' do
+      c = Connection.new(host: 'x')
       assert_match(/host: x/, c.to_s)
       assert_match(/alive/,   c.to_s)
     end
 
-    should "not be dead by default" do
+    should 'not be dead by default' do
       c = Connection.new
       assert ! c.dead?
     end
 
-    should "be dead when marked" do
+    should 'be dead when marked' do
       c = Connection.new.dead!
       assert c.dead?
       assert_equal 1, c.failures
       assert_in_delta c.dead_since, Time.now, 1
     end
 
-    should "be alive when marked" do
+    should 'be alive when marked' do
       c = Connection.new.dead!
       assert c.dead?
       assert_equal 1, c.failures
@@ -90,7 +90,7 @@ class Elastic::Transport::Transport::Connections::ConnectionTest < Minitest::Tes
       assert_equal 1, c.failures
     end
 
-    should "be healthy when marked" do
+    should 'be healthy when marked' do
       c = Connection.new.dead!
       assert c.dead?
       assert_equal 1, c.failures
@@ -101,35 +101,33 @@ class Elastic::Transport::Transport::Connections::ConnectionTest < Minitest::Tes
       assert_equal 0, c.failures
     end
 
-    should "be resurrected if timeout passed" do
+    should 'be resurrected if timeout passed' do
       c = Connection.new.dead!
 
       now = Time.now + 60
       Time.stubs(:now).returns(now)
 
-      assert   c.resurrect!, c.inspect
-      assert ! c.dead?,      c.inspect
+      assert(c.resurrect!, c.inspect)
+      assert(!c.dead?, c.inspect)
     end
 
-    should "be resurrected if timeout passed for multiple failures" do
+    should 'be resurrected if timeout passed for multiple failures' do
       c = Connection.new.dead!.dead!
 
-      now = Time.now + 60*2
+      now = Time.now + 60 * 2
       Time.stubs(:now).returns(now)
 
       assert   c.resurrect!, c.inspect
       assert ! c.dead?,      c.inspect
     end
 
-    should "implement the equality operator" do
-      c1 = Connection.new(:host => { :protocol => 'http', :host => 'foo', :port => 123 })
-      c2 = Connection.new(:host => { :protocol => 'http', :host => 'foo', :port => 123 })
-      c3 = Connection.new(:host => { :protocol => 'http', :host => 'foo', :port => 456 })
+    should 'implement the equality operator' do
+      c1 = Connection.new(host: { protocol: 'http', host: 'foo', port: 123 })
+      c2 = Connection.new(host: { protocol: 'http', host: 'foo', port: 123 })
+      c3 = Connection.new(host: { protocol: 'http', host: 'foo', port: 456 })
 
       assert c1 == c2, "Connection #{c1} should be equal to #{c2}"
       assert c2 != c3, "Connection #{c2} should NOT be equal to #{c3}"
     end
-
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-transport
 version: !ruby/object:Gem::Version
-  version: 8.3.1
+  version: 8.3.5
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -340,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Low level Ruby client for Elastic services.