elastomer-client 6.3.0 → 6.4.0

data/lib/elastomer_client/client.rb

@@ -414,6 +414,13 @@ module ElastomerClient
 
       if response.body.is_a?(Hash) && (error = response.body["error"])
         root_cause = Array(error["root_cause"]).first || error
+        # ES9 returns these timeouts as 429 rather than retryable 5xx ServerError responses.
+        # Retry only these timeout types so unrelated 429s retain their existing handling.
+        if response.status == 429 &&
+            %w[timeout_exception process_cluster_event_timeout_exception search_timeout_exception].include?(root_cause["type"])
+          raise TimeoutError, response
+        end
+
         case root_cause["type"]
         when "index_not_found_exception"; raise IndexNotFoundError, response
         when "illegal_argument_exception"; raise IllegalArgument, response

data/lib/elastomer_client/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ElastomerClient
-  VERSION = "6.3.0"
+  VERSION = "6.4.0"
 
   def self.version
     VERSION

data/lib/elastomer_client/version_support.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rubygems/version"
+
 module ElastomerClient
   class VersionSupport
 
@@ -9,7 +11,8 @@ module ElastomerClient
     #
     # Raises ArgumentError if version is unsupported.
     def initialize(version)
-      if version < "5.0" || version >= "9.0"
+      comparable_version = Gem::Version.new(version)
+      if comparable_version < Gem::Version.new("5.0") || comparable_version >= Gem::Version.new("10.0")
         raise ArgumentError, "Elasticsearch version #{version} is not supported by elastomer-client"
       end
 
@@ -20,5 +23,9 @@ module ElastomerClient
     def es_version_8_plus?
       version >= "8.0.0"
     end
+
+    def es_version_9_plus?
+      Gem::Version.new(version) >= Gem::Version.new("9.0")
+    end
   end
 end

data/script/generate-rest-api-spec

@@ -62,6 +62,9 @@ class RestApiSpecGenerator
       hash = MultiJson.load(File.read(filename))
       key = hash.keys.first
       value = hash.values.first
+      # ES9 exposes legacy knn_search only in ES8 compatibility mode, not native ES9.
+      next if @version_support.es_version_9_plus? && key == "knn_search"
+
       yield(key, value)
     end
   end

data/test/client/native_delete_by_query_test.rb

@@ -93,12 +93,13 @@ describe ElastomerClient::Client::NativeDeleteByQuery do
           _routing: { required: true }
         })
       })
-      wait_for_index(@index.name)
+      wait_for_index(index.name)
       docs = index.docs(type)
+      routing, other_routing = routing_values_for_distinct_shards(docs)
 
-      docs.index({ _id: 0, _routing: "cat", name: "mittens" })
-      docs.index({ _id: 1, _routing: "cat", name: "luna" })
-      docs.index({ _id: 2, _routing: "dog", name: "mittens" })
+      docs.index({ _id: 0, _routing: routing, name: "mittens" })
+      docs.index({ _id: 1, _routing: routing, name: "luna" })
+      docs.index({ _id: 2, _routing: other_routing, name: "mittens" })
 
       query = {
         query: {
@@ -109,15 +110,15 @@ describe ElastomerClient::Client::NativeDeleteByQuery do
       }
 
       index.refresh
-      response = index.native_delete_by_query(query, routing: "cat")
+      response = index.native_delete_by_query(query, routing:)
 
       assert_equal(1, response["deleted"])
 
       response = docs.multi_get({
         docs: [
-          { _id: 0, routing: "cat" },
-          { _id: 1, routing: "cat" },
-          { _id: 2, routing: "dog" },
+          { _id: 0, routing: },
+          { _id: 1, routing: },
+          { _id: 2, routing: other_routing },
         ]
       })
 

data/test/client/rest_api_spec/api_spec_test.rb

@@ -54,4 +54,36 @@ describe ElastomerClient::Client::RestApiSpec::ApiSpec do
       @api_spec.validate_params!(api: "search", params:)
     }
   end
+
+  it "selects the REST API spec for each supported Elasticsearch major version" do
+    {"8.18.0" => "8_18", "8.19.3" => "8_19", "9.5.6" => "9_5"}.each do |version, class_version|
+      client = ElastomerClient::Client.new(es_version: version)
+
+      assert_equal "ElastomerClient::Client::RestApiSpec::ApiSpecV#{class_version}", client.api_spec.class.name
+    end
+  end
+
+  it "keeps removed local parameters in ES8 but excludes them from ES9" do
+    eight = ElastomerClient::Client::RestApiSpec.api_spec("8.19.3")
+    nine = ElastomerClient::Client::RestApiSpec.api_spec("9.5.6")
+
+    %w[indices.get_alias indices.exists_alias cat.aliases indices.get_field_mapping].each do |api|
+      assert eight.valid_param?(api:, param: :local)
+      refute nine.valid_param?(api:, param: :local)
+      assert_empty(nine.select_params(api:, from: {local: true}))
+      assert_raises(ElastomerClient::Client::IllegalArgument) {
+        nine.validate_params!(api:, params: {local: true})
+      }
+    end
+  end
+
+  it "keeps removed endpoints in ES8 but excludes them from ES9" do
+    eight = ElastomerClient::Client::RestApiSpec.api_spec("8.19.3")
+    nine = ElastomerClient::Client::RestApiSpec.api_spec("9.5.6")
+
+    %w[indices.unfreeze knn_search].each do |api|
+      refute_nil eight.get(api)
+      assert_nil nine.get(api)
+    end
+  end
 end

data/test/client/update_by_query_test.rb

@@ -96,12 +96,13 @@ describe ElastomerClient::Client::UpdateByQuery do
           _routing: { required: true }
         })
       })
-      wait_for_index(@index.name)
+      wait_for_index(index.name)
       docs = index.docs(type)
+      routing, other_routing = routing_values_for_distinct_shards(docs)
 
-      docs.index({ _id: 0, _routing: "cat", name: "mittens" })
-      docs.index({ _id: 1, _routing: "cat", name: "luna" })
-      docs.index({ _id: 2, _routing: "dog", name: "mittens" })
+      docs.index({ _id: 0, _routing: routing, name: "mittens" })
+      docs.index({ _id: 1, _routing: routing, name: "luna" })
+      docs.index({ _id: 2, _routing: other_routing, name: "mittens" })
 
       query = {
         query: {
@@ -115,15 +116,15 @@ describe ElastomerClient::Client::UpdateByQuery do
       }
 
       index.refresh
-      response = index.update_by_query(query, routing: "cat")
+      response = index.update_by_query(query, routing:)
 
       assert_equal(1, response["updated"])
 
       response = docs.multi_get({
         docs: [
-          { _id: 0, routing: "cat" },
-          { _id: 1, routing: "cat" },
-          { _id: 2, routing: "dog" },
+          { _id: 0, routing: },
+          { _id: 1, routing: },
+          { _id: 2, routing: other_routing },
         ]
       })
 

data/test/client_test.rb

@@ -85,6 +85,29 @@ describe ElastomerClient::Client do
     assert_equal "it took too long :: GET /_cat/indices", wrapped.message
   end
 
+  it "keeps Elasticsearch timeout errors retryable when ES9 returns 429" do
+    %w[timeout_exception process_cluster_event_timeout_exception search_timeout_exception].each do |type|
+      error = {"type" => type}
+      [error, {"type" => "search_phase_execution_exception", "root_cause" => [error]}].each do |body|
+        response = Faraday::Response.new(status: 429, body: {"error" => body})
+        exception = assert_raises(ElastomerClient::Client::TimeoutError) { $client.handle_errors(response) }
+        assert_predicate exception, :retry?
+      end
+    end
+  end
+
+  it "does not make other 429 errors retryable" do
+    response = Faraday::Response.new(status: 429, body: {"error" => {"type" => "circuit_breaking_exception"}})
+    exception = assert_raises(ElastomerClient::Client::RequestError) { $client.handle_errors(response) }
+    refute_predicate exception, :retry?
+  end
+
+  it "preserves ES8 server timeout error handling" do
+    response = Faraday::Response.new(status: 503, body: {"error" => {"type" => "timeout_exception"}})
+    exception = assert_raises(ElastomerClient::Client::ServerError) { $client.handle_errors(response) }
+    assert_predicate exception, :retry?
+  end
+
   it "handles path expansions" do
     uri = $client.expand_path "/{foo}/{bar}", foo: "_cluster", bar: "health"
 

data/test/test_helper.rb

@@ -110,6 +110,18 @@ def default_index_settings
   {settings: {index: {number_of_shards: 1, number_of_replicas: 0}}}
 end
 
+def routing_values_for_distinct_shards(docs)
+  routing_by_shard = {}
+  100.times do
+    routing = SecureRandom.uuid
+    shard = docs.search_shards(routing:).fetch("shards").fetch(0).fetch(0).fetch("shard")
+    routing_by_shard[shard] ||= routing
+    return routing_by_shard.values if routing_by_shard.size == 2
+  end
+
+  flunk "Could not find routing values for distinct shards after 100 UUID attempts"
+end
+
 def run_snapshot_tests?
   unless defined? $run_snapshot_tests
     begin

data/test/version_support_test.rb

@@ -4,9 +4,10 @@ require_relative "test_helper"
 
 describe ElastomerClient::VersionSupport do
   describe "supported versions" do
-    it "allows 5.0.0 to 8.x" do
+    it "allows 5.0.0 to 9.x" do
       five_series = ["5.0.0", "5.0.9", "5.1.0", "5.9.0", "5.99.100"]
       eight_series = ["8.0.0", "8.0.9", "8.1.0", "8.9.0", "8.99.100"]
+      nine_series = ["9.0.0", "9.0.9", "9.1.0", "9.9.0", "9.99.100"]
 
       five_series.each do |version|
         assert ElastomerClient::VersionSupport.new(version)
@@ -14,6 +15,12 @@ describe ElastomerClient::VersionSupport do
 
       eight_series.each do |version|
         assert_predicate ElastomerClient::VersionSupport.new(version), :es_version_8_plus?
+        refute_predicate ElastomerClient::VersionSupport.new(version), :es_version_9_plus?
+      end
+
+      nine_series.each do |version|
+        assert_predicate ElastomerClient::VersionSupport.new(version), :es_version_8_plus?
+        assert_predicate ElastomerClient::VersionSupport.new(version), :es_version_9_plus?
       end
     end
   end
@@ -21,7 +28,7 @@ describe ElastomerClient::VersionSupport do
   describe "unsupported versions" do
     it "blow up" do
       too_low = ["0.90", "1.0.1", "2.0.0", "2.2.0"]
-      too_high = ["9.0.0"]
+      too_high = ["10.0.0", "11.0.0", "20.0.0"]
 
       (too_low + too_high).each do |version|
         exception = assert_raises(ArgumentError, "expected #{version} to not be supported") do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-06-25 00:00:00.000000000 Z
+date: 2026-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -151,6 +151,7 @@ files:
 - lib/elastomer_client/client/rest_api_spec/api_spec_v8_18.rb
 - lib/elastomer_client/client/rest_api_spec/api_spec_v8_19.rb
 - lib/elastomer_client/client/rest_api_spec/api_spec_v8_7.rb
+- lib/elastomer_client/client/rest_api_spec/api_spec_v9_5.rb
 - lib/elastomer_client/client/rest_api_spec/rest_api.rb
 - lib/elastomer_client/client/scroller.rb
 - lib/elastomer_client/client/snapshot.rb