elastic-transport 8.0.0 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbf4a3586e25fe9a9bacee53636589bd2635970266f6938c3588547569b5c406
-  data.tar.gz: 8d2d465485ecc3efd421089feb5f5fd8a81d036c2b77d8d3811e0c0ac8a13c0c
+  metadata.gz: 88698d9c25a84a6242bfb875623c2bca0bd9a0e5c40244272e88fe291b06a9e0
+  data.tar.gz: 90aff86e0a0f301908c888877d97a72ac926e9b5f7f48b23ad447813a729824d
 SHA512:
-  metadata.gz: 392a3e7e09c0e59b424e0181eea6115fd4781928e51b1efde6450e56ac9099634071cbc8db95959b0adb6c48e961d2c76af3c8a434628012f22984922e05f025
-  data.tar.gz: 8dafbedfbf736513077414861a494bd43bd21410b9c236c8f3b5e2cc8771dfcd9005ffdbf79ec574d819429ddc65fc1f11461194fc2c100d534185c6f4cebd30
+  metadata.gz: 3a235c8813516864b3b661790c56c9eeb6c8ee8b44a208d70a3309faca0075e9b45f25890be47d56ed29b845a70c5d3f6cd45c617592543993a0c6d788eb7211
+  data.tar.gz: 9cd571ba906d3e841f63f8bf3ea018820d0d9e2eddb9171f01785b6787df5ed19fecbeb0b05e494428af8853d2040c78c32f25a370c612d55a4a69ed77798682

data/.github/workflows/license.yml

@@ -4,10 +4,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3
+        ruby-version: '3.4'
     - name: Check license headers
       run: |
         ruby ./.github/check_license_headers.rb

data/.github/workflows/otel.yml

@@ -0,0 +1,48 @@
+name: opentelemetry
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test-otel:
+    name: 'Test Open Telemetry'
+    env:
+      TEST_ES_SERVER: http://localhost:9250
+      PORT: 9250
+      TEST_WITH_OTEL: true
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.4', 'jruby-9.4']
+        es_version: ['8.17.0-SNAPSHOT']
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Increase system limits
+        run: |
+          sudo swapoff -a
+          sudo sysctl -w vm.swappiness=1
+          sudo sysctl -w fs.file-max=262144
+          sudo sysctl -w vm.max_map_count=262144
+      - uses: elastic/elastic-github-actions/elasticsearch@master
+        with:
+          stack-version: ${{ matrix.es_version }}
+          security-enabled: false
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          sudo apt-get update
+          sudo apt-get install libcurl4-openssl-dev
+          ruby -v
+          bundle install
+      - name: unit tests
+        run: bundle exec rake test:unit
+      - name: specs
+        run: bundle exec rake test:spec
+      - name: integration tests
+        run: bundle exec rake test:integration

data/.github/workflows/tests.yml

@@ -7,17 +7,19 @@ on:
     branches:
       - main
 jobs:
-  test-ruby:
+  test:
+    name: 'Main tests'
     env:
       TEST_ES_SERVER: http://localhost:9250
       PORT: 9250
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0', '3.1', 'jruby-9.3' ]
+        ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby-9.3', 'jruby-9.4']
+        es_version: ['8.16.0-SNAPSHOT', '8.17.0-SNAPSHOT', '8.18.0-SNAPSHOT']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Increase system limits
       run: |
         sudo swapoff -a
@@ -26,7 +28,8 @@ jobs:
         sudo sysctl -w vm.max_map_count=262144
     - uses: elastic/elastic-github-actions/elasticsearch@master
       with:
-        stack-version: 8.0.0-SNAPSHOT
+        stack-version: ${{ matrix.es_version }}
+        security-enabled: false
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -42,4 +45,41 @@ jobs:
       run: bundle exec rake test:spec
     - name: integration tests
       run: bundle exec rake test:integration
-
+  test-faraday1:
+    name: 'Test Faraday 1'
+    env:
+      TEST_ES_SERVER: http://localhost:9250
+      PORT: 9250
+    strategy:
+      fail-fast: false
+      matrix:
+        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@v4
+    - name: Increase system limits
+      run: |
+        sudo swapoff -a
+        sudo sysctl -w vm.swappiness=1
+        sudo sysctl -w fs.file-max=262144
+        sudo sysctl -w vm.max_map_count=262144
+    - uses: elastic/elastic-github-actions/elasticsearch@master
+      with:
+        stack-version: ${{ matrix.es_version }}
+        security-enabled: false
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      run: |
+        sudo apt-get update
+        sudo apt-get install libcurl4-openssl-dev
+        ruby -v
+        BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle install
+    - name: faraday1 unit tests
+      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit
+    - name: specs
+      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:spec
+    - name: integration tests
+      run: BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:integration

data/.gitignore

@@ -5,7 +5,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+Gemfile*.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,18 +1,141 @@
-## 8.0.0.pre3
+## 8.4.0
 
-- Tested in Ruby 3.1, JRuby 9.3, drops Ruby 2.5 in test Matrix. Version 8.0.0.pre3 is being tested for Ruby (MRI) 2.6, 2.7, 3.0 and 3.1 and JRuby 9.3.
-- Updates Manticore implementation headers setup. When using the Manticore HTTP implementation, adding a custom `User-Agent` value in the headers on initialization would get overwritten. [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/22) - [Issue reported in elastic/elasticsearch-ruby#1684](https://github.com/elastic/elasticsearch-ruby/issues/1684).
+- Adds support for **[Excon](https://github.com/excon/excon)** Faraday adapter. You can use the Excon adapter by setting it in when initializing an Elasticsearch client:
+
+```ruby
+require 'faraday/excon'
+
+Elasticsearch::Client.new(
+  host: host,
+  transport_options: transport_options,
+  adapter: :excon
+)
+```
+
+Excon may need some specific configuration for HTTPS/SSL. You may see certificate verification errors when trying to connect to Elastic. Excon has certificates bundled, but these can be customized:
+
+```ruby
+Excon.defaults[:ssl_ca_path] = path_to_certs
+ENV['SSL_CERT_DIR'] = path_to_certs
+Excon.defaults[:ssl_ca_file] = path_to_file
+ENV['SSL_CERT_FILE'] = path_to_file
+Excon.defaults[:ssl_verify_callback] = callback
+# (see OpenSSL::SSL::SSLContext#verify_callback)
+Excon.defaults[:ssl_verify_peer] = false` # (less secure).
+```
+
+- Adds support for **[Async::HTTP::Faraday](https://github.com/socketry/async-http-faraday)**. You can use the adapter by setting it when initializing an Elasticsearch client:
+```ruby
+require 'async-http-faraday'
+
+Elasticsearch::Client.new(
+  host: host,
+  adapter: :async_http
+)
+```
+- Minor refactors, styling fixes.
+
+## 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
+
+- Removes unneccessary `require 'base64'` found thanks to warning in Ruby 3.3. So this removes the warning too if you were using Ruby 3.3.
+
+## 8.3.0
+
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+This release adds native support for OpenTelemetry. Documentation will be added to [the official Transport documentation](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html). Pull Request: [#54](https://github.com/elastic/elastic-transport-ruby/pull/54).
+
+## 8.2.4
+
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+- Fixes [#66](https://github.com/elastic/elastic-transport-ruby/issues/66) - Manticore transport unable to send custom headers with perform_request [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/69)
+- Fixes [#67](https://github.com/elastic/elastic-transport-ruby/issues/67) - Float with many digits automatically becomes BigDecimal when using Oj. [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/68), thank you @kyoshidajp!
+
+## 8.2.3
+
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+- Fixes enforcing UTF-8 in Response body, causing an error when the string is frozen, particularly when using webmock. [issue #63](https://github.com/elastic/elastic-transport-ruby/issues/63)
 
-## 8.0.0.pre2
+## 8.2.2
 
+Tested versions of Ruby: (MRI) 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4
+
+- Refactors `apply_headers` in base and manticore implementation: When passing in an object to the initializer, `apply_headers` would mutate this object and in certain conditions, this would raise `RuntimeError` in JRuby 9.3 and `ConcurrencyError` in JRuby 9.4. This update clones the options object instead.
+
+## 8.2.1
+
+Tested versions of Ruby: (MRI) 2.7, 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4. Ruby 2.7's end of life is coming in a few days, so this'll probably be the last release to test for Ruby 2.7.
+
+- Fixes parsing ipv4 addresses like `inet[/127.0.0.1:9200]` in sniffer, [issue #48](https://github.com/elastic/elastic-transport-ruby/issues/48). [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/49) by [@robbat2](https://github.com/robbat2), thank you!
+
+## 8.2.0
+
+Tested versions of Ruby: (MRI) 2.7, 3.0, 3.1, 3.2, JRuby 9.3 and JRuby 9.4.
+
+- Fixes [issue #44](https://github.com/elastic/elastic-transport-ruby/issues/44), raising `Elastic::Transport::Transport::Error` instead of `Faraday::ConnectionFailed` (or any other Faraday error class) when a host is unreachable.
+- Removes development dependency on `ansi`, it hasn't been updated for years.
+- Adds `rake console` task to run IRB with the Elastic transport client libraries loaded.
+- General refactors, cleanup and updates in code for `base.rb` (The base class used by HTTP implementations Faraday, Manticore, Curb), `errors.rb`, `faraday.rb`, and more.
+
+## 8.1.0
+
+Adds support for Faraday version 2. From [Faraday's Upgrading guide](https://github.com/lostisland/faraday/blob/main/UPGRADING.md#faraday-20), the main change is the adapters have moved:
+
+> With this release, we've officially moved all adapters, except for the net_http one, out of Faraday. What that means, is that they won't be available out-of-the-box anymore, and you'll instead need to add them to your Gemfile.
+> If you just use the default net_http adapter, then you don't need to do anything!
+> Otherwise, add the corresponding adapter gem to your Gemfile (e.g. faraday-net_http_persistent). Then, simply require them after you require faraday.
+
+We're now supporting Faraday v2 and Faraday v1. The adapters were removed as development dependency in the gemspec and added to the Gemfile. A new file `Gemfile-faraday1.gemfile` was added to run tests with version `1.x` of Faraday too.
+
+These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based:
+```
+# HTTPCLient
+'faraday-httpclient'
+
+# NetHTTPPersistent
+'faraday-net_http_persistent'
+
+# Patron
+'faraday-patron'
+
+# Typhoeus
+'faraday-typhoeus'
+```
+
+If you're using Faraday 1, you shouldn't have to change anything, but please [submit an issue](https://github.com/elastic/elastic-transport-ruby/issues) if you encounter any issues.
+
+## 8.0.1
+
+- Minor code cleanup
+- Adds Elastic Transport service token, updates specs for meta header.
+
+## 8.0.0
+
+- Library renamed from [`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport) to `elastic-transport` and promoted to its own repository.
 - Fixes tracing for Manticore [commit](https://github.com/elastic/elastic-transport-ruby/commit/98c81d19de4fee394f9c1a5079a1892ec951e0f9).
 - Implements CA Fingerprinting [pull request](https://github.com/elastic/elastic-transport-ruby/pull/13)
 - Adds `delay_on_retry` to wait between each failed connection, thanks @DinoPullerUqido! [commit](https://github.com/elastic/elastic-transport-ruby/commit/c2f8311409ca63a293588cb7eea5a0c672dbd436)
 - Fixes compression, thanks @johnnyshields! [commit](https://github.com/elastic/elastic-transport-ruby/commit/8b326d643f76f037075500e19bbe096b2c298099)
-
-## 8.0.0.pre1
-
-- Library renamed from [`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport) to `elastic-transport` and promoted to its own repository.
+- Tested in Ruby 3.1, JRuby 9.3, drops Ruby 2.5 in test Matrix. Version 8.0.0 tested for Ruby (MRI) 2.6, 2.7, 3.0 and 3.1 and JRuby 9.3.
+- Updates Manticore implementation headers setup. When using the Manticore HTTP implementation, adding a custom `User-Agent` value in the headers on initialization would get overwritten. [Pull Request](https://github.com/elastic/elastic-transport-ruby/pull/22) - [Issue reported in elastic/elasticsearch-ruby#1684](https://github.com/elastic/elasticsearch-ruby/issues/1684).
 
 # Changes from elasticsearch-transport:
 

data/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to Elasticsearch Transport Ruby
+
+
+This guide assumes Ruby is already installed. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). So we can't guarantee the code works for versions of Ruby that have reached their end of life.
+
+To work on the code, clone the project first:
+
+```
+$ git clone git@github.com:elastic/elastic-transport-ruby.git
+```
+
+And run `bundle install` to install dependencies.
+
+# Tests
+
+There are several test tasks in the Rakefile, you can check them with `rake -T` from the project's root directory.
+
+```bash
+rake test:unit
+rake test:spec
+rake test:integration
+```
+
+Use `COVERAGE=true` before running a test task to check coverage with Simplecov.
+
+Github's pull requests and issues are used to communicate, send bug reports and code contributions. Bug fixes and features must be covered by unit tests.
+
+You need an Elasticsearch cluster running for integration tests. The tests will use the default host `localhost:9200`, but you can change this value by setting the environment variables `TEST_ES_SERVER` or `ELASTICSEARCH_HOSTS`:
+
+```
+$ TEST_ES_SERVER=host:port rake test:integration
+```
+
+A rake task is included to launch an Elasticsearch cluster with Docker. You need to install docker on your system and then run:
+```bash
+$ rake docker:start[VERSION]
+```
+
+E.g.:
+```bash
+$ rake docker:start[8.0.0-alpha1]
+```
+
+You can find the available version in [Docker @ Elastic](https://www.docker.elastic.co/r/elasticsearch). You can also run Elasticsearch and Kibana locally with Docker with `start-local`:
+
+```bash
+curl -fsSL https://elastic.co/start-local | sh
+```
+
+This will run Elasticsearch in http://localhost:9200 and Kibana in http://localhost:5601. More information is available [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/run-elasticsearch-locally.html).
+
+# Contributing
+
+The process for contributing is:
+
+1. It is best to do your work in a separate Git branch. This makes it easier to synchronise your changes with [`rebase`](http://mislav.uniqpath.com/2013/02/merge-vs-rebase/).
+
+2. Make sure your changes don't break any existing tests, and that you add tests for both bugfixes and new functionality.
+
+3. **Sign the contributor license agreement.**
+Please make sure you have signed the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.
+
+4. Submit a pull request.
+Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, describe what your changes do and mention the number of the issue where discussion has taken place, eg “Closes #123″.

data/Gemfile

@@ -20,19 +20,20 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-transport.gemspec
 gemspec
 
-if File.exist? File.expand_path('../elasticsearch-api/elasticsearch-api.gemspec', __dir__)
-  gem 'elasticsearch-api', path: File.expand_path('../elasticsearch-api', __dir__), require: false
-end
-
-if File.exist? File.expand_path('../elasticsearch/elasticsearch.gemspec', __dir__)
-  gem 'elasticsearch', path: File.expand_path('../elasticsearch', __dir__), require: false
-end
-
 group :development, :test do
-  gem 'rspec'
+  gem 'faraday-excon'
+  gem 'faraday-httpclient'
+  gem 'faraday-net_http_persistent'
+  gem 'faraday-typhoeus'
+  gem 'mutex_m' if RUBY_VERSION >= '3.4'
+  gem 'opentelemetry-sdk', require: false if RUBY_VERSION >= '3.0'
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else
+    gem 'async-http-faraday'
+    gem 'faraday-patron'
+    gem 'oj'
     gem 'pry-byebug'
   end
+  gem 'rspec'
 end

data/Gemfile-faraday1.gemfile

@@ -0,0 +1,40 @@
+# 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.
+
+source 'https://rubygems.org'
+
+# Usage:
+#
+# $ BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle install
+# $ BUNDLE_GEMFILE=./Gemfile-faraday1.gemfile bundle exec rake test:faraday1:unit
+
+gem 'faraday', '~> 1'
+gemspec
+
+group :development, :test do
+  gem 'httpclient'
+  gem 'net-http-persistent'
+  gem 'rspec'
+  gem 'typhoeus'
+  if defined?(JRUBY_VERSION)
+    gem 'pry-nav'
+  else
+    gem 'pry-byebug'
+    gem 'oj'
+    gem 'patron'
+  end
+end