Added experimental support for opensearch gem

Andrew Kane
1 parent 70e5fd1d
Showing 8 changed files with 35 additions and 11 deletions Show diff stats
CHANGELOG.md
gemfiles/opensearch.gemfile
lib/searchkick.rb
lib/searchkick/index.rb
lib/searchkick/query.rb
lib/searchkick/record_indexer.rb
lib/searchkick/results.rb
test/test_helper.rb
+## 4.6.3 (unreleased)
+
+- Added experimental support for `opensearch` gem
+
 ## 4.6.2 (2021-11-15)
 - Added support for beginless ranges to `where` option
@@ -13,5 +13,5 @@ gem &quot;typhoeus&quot;
 gem "redis"
 gem "connection_pool"
 gem "kaminari"
-gem "elasticsearch-xpack", ">= 7.8", "< 7.14"
+gem "opensearch", github: "opensearch-project/opensearch-ruby"
 gem "parallel_tests"
@@ -34,6 +34,7 @@ module Searchkick
   class Error < StandardError; end
   class MissingIndexError < Error; end
   class UnsupportedVersionError < Error; end
+  # TODO switch to Error
   class InvalidQueryError < Elasticsearch::Transport::Transport::Errors::BadRequest; end
   class DangerousOperation < Error; end
   class ImportError < Error; end
@@ -278,6 +279,18 @@ module Searchkick
       !Mongoid::Threaded.current_scope(klass).nil?
     end
   end
+
+  # private
+  def self.not_found_error?(e)
+    (defined?(Elasticsearch) && e.is_a?(Elasticsearch::Transport::Transport::Errors::NotFound)) ||
+    (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Errors::NotFound))
+  end
+
+  # private
+  def self.transport_error?(e)
+    (defined?(Elasticsearch) && e.is_a?(Elasticsearch::Transport::Transport::Error)) ||
+    (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Error))
+  end
 end
 require "active_model/callbacks"
@@ -84,7 +84,8 @@ module Searchkick
       old_indices =
         begin
           client.indices.get_alias(name: name).keys
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+        rescue => e
+          raise e unless Searchkick.not_found_error?(e)
           {}
         end
       actions = old_indices.map { |old_name| {remove: {index: old_name, alias: name}} } + [{add: {index: new_name, alias: name}}]
@@ -109,7 +110,8 @@ module Searchkick
           else
             client.indices.get_aliases
           end
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+        rescue => e
+          raise e unless Searchkick.not_found_error?(e)
           {}
         end
       indices = indices.select { |_k, v| v.empty? || v["aliases"].empty? } if unaliased
@@ -113,7 +113,7 @@ module Searchkick
       # no easy way to tell which host the client will use
       host =
-        if Gem::Version.new(Elasticsearch::VERSION) >= Gem::Version.new("7.14.0")
+        if Searchkick.client.transport.respond_to?(:transport)
           Searchkick.client.transport.transport.hosts.first
         else
           Searchkick.client.transport.hosts.first
@@ -64,8 +64,9 @@ module Searchkick
       if record.destroyed? || !record.persisted? || !record.should_index?
         begin
           index.remove(record)
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
-          # do nothing
+        rescue => e
+          raise e unless Searchkick.not_found_error?(e)
+          # do nothing if not found
         end
       else
         if method_name
@@ -195,8 +195,8 @@ module Searchkick
         begin
           # TODO Active Support notifications for this scroll call
           Searchkick::Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
-          if e.class.to_s =~ /NotFound/ && e.message =~ /search_context_missing_exception/i
+        rescue => e
+          if Searchkick.not_found_error?(e) && e.message =~ /search_context_missing_exception/i
             raise Searchkick::Error, "Scroll id has expired"
           else
             raise e
@@ -211,8 +211,8 @@ module Searchkick
         # not required as scroll will expire
         # but there is a cost to open scrolls
         Searchkick.client.clear_scroll(scroll_id: scroll_id)
-      rescue Elasticsearch::Transport::Transport::Error
-        # do nothing
+      rescue => e
+        raise e unless Searchkick.transport_error?(e)
       end
     end
@@ -12,7 +12,11 @@ ENV[&quot;ES_PATH&quot;] ||= &quot;#{ENV[&quot;HOME&quot;]}/elasticsearch/#{ENV[&quot;ELASTICSEARCH_VERSION&quot;]}
 $logger = ActiveSupport::Logger.new(ENV["VERBOSE"] ? STDOUT : nil)
-if Gem::Version.new(Elasticsearch::VERSION) >= Gem::Version.new("7.14.0")
+if defined?(OpenSearch)
+  Searchkick.client = OpenSearch::Client.new
+end
+
+if defined?(OpenSearch) || Gem::Version.new(Elasticsearch::VERSION) >= Gem::Version.new("7.14.0")
   Searchkick.client.transport.transport.logger = $logger
 else
   Searchkick.client.transport.logger = $logger
		1	+## 4.6.3 (unreleased)
		2	+
		3	+- Added experimental support for `opensearch` gem
		4	+
1	## 4.6.2 (2021-11-15)	5	## 4.6.2 (2021-11-15)
2		6
3	- Added support for beginless ranges to `where` option	7	- Added support for beginless ranges to `where` option
	@@ -13,5 +13,5 @@ gem "typhoeus"		@@ -13,5 +13,5 @@ gem "typhoeus"
13	gem "redis"	13	gem "redis"
14	gem "connection_pool"	14	gem "connection_pool"
15	gem "kaminari"	15	gem "kaminari"
16	-gem "elasticsearch-xpack", ">= 7.8", "< 7.14"	16	+gem "opensearch", github: "opensearch-project/opensearch-ruby"
17	gem "parallel_tests"	17	gem "parallel_tests"
	@@ -34,6 +34,7 @@ module Searchkick		@@ -34,6 +34,7 @@ module Searchkick
34	class Error < StandardError; end	34	class Error < StandardError; end
35	class MissingIndexError < Error; end	35	class MissingIndexError < Error; end
36	class UnsupportedVersionError < Error; end	36	class UnsupportedVersionError < Error; end
		37	+ # TODO switch to Error
37	class InvalidQueryError < Elasticsearch::Transport::Transport::Errors::BadRequest; end	38	class InvalidQueryError < Elasticsearch::Transport::Transport::Errors::BadRequest; end
38	class DangerousOperation < Error; end	39	class DangerousOperation < Error; end
39	class ImportError < Error; end	40	class ImportError < Error; end
	@@ -278,6 +279,18 @@ module Searchkick		@@ -278,6 +279,18 @@ module Searchkick
278	!Mongoid::Threaded.current_scope(klass).nil?	279	!Mongoid::Threaded.current_scope(klass).nil?
279	end	280	end
280	end	281	end
		282	+
		283	+ # private
		284	+ def self.not_found_error?(e)
		285	+ (defined?(Elasticsearch) && e.is_a?(Elasticsearch::Transport::Transport::Errors::NotFound)) \|\|
		286	+ (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Errors::NotFound))
		287	+ end
		288	+
		289	+ # private
		290	+ def self.transport_error?(e)
		291	+ (defined?(Elasticsearch) && e.is_a?(Elasticsearch::Transport::Transport::Error)) \|\|
		292	+ (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Error))
		293	+ end
281	end	294	end
282		295
283	require "active_model/callbacks"	296	require "active_model/callbacks"
	@@ -113,7 +113,7 @@ module Searchkick		@@ -113,7 +113,7 @@ module Searchkick
113		113
114	# no easy way to tell which host the client will use	114	# no easy way to tell which host the client will use
115	host =	115	host =
116	- if Gem::Version.new(Elasticsearch::VERSION) >= Gem::Version.new("7.14.0")	116	+ if Searchkick.client.transport.respond_to?(:transport)
117	Searchkick.client.transport.transport.hosts.first	117	Searchkick.client.transport.transport.hosts.first
118	else	118	else
119	Searchkick.client.transport.hosts.first	119	Searchkick.client.transport.hosts.first