Removed elasticsearch dependency [skip ci]

Andrew Kane
1 parent 025caf83
Showing 6 changed files with 37 additions and 11 deletions Show diff stats
CHANGELOG.md
Gemfile
gemfiles/opensearch.gemfile
lib/searchkick.rb
lib/searchkick/middleware.rb
searchkick.gemspec
@@ -6,6 +6,7 @@
 - Raise `ArgumentError` instead of `RuntimeError` for unknown operators
 - Removed mapping of `id` to `_id` with `order` option
 - Removed `wordnet` option
+- Removed `elasticsearch` dependency
 - Dropped support for Ruby < 2.6 and Active Record < 5.2
 - Dropped support for NoBrainer and Cequel
 - Dropped support for `faraday_middleware-aws-signers-v4` (use `faraday_middleware-aws-sigv4` instead)
@@ -7,6 +7,7 @@ gem &quot;minitest&quot;, &quot;&gt;= 5&quot;
 gem "activerecord", "~> 7.0.0"
 gem "activejob", "~> 7.0.0", require: "active_job"
 gem "actionpack", "~> 7.0.0"
+gem "elasticsearch"
 gem "sqlite3"
 gem "gemoji-parser"
 gem "typhoeus"
@@ -13,5 +13,5 @@ gem &quot;typhoeus&quot;
 gem "redis"
 gem "connection_pool"
 gem "kaminari"
-gem "opensearch-ruby", github: "opensearch-project/opensearch-ruby"
+gem "opensearch-ruby"
 gem "parallel_tests"
 # dependencies
 require "active_support"
 require "active_support/core_ext/hash/deep_merge"
-require "elasticsearch"
 require "hashie"
  
 # modules
@@ -41,6 +40,7 @@ module Searchkick
   class InvalidQueryError < Error; end
   class DangerousOperation < Error; end
   class ImportError < Error; end
+  class ClientNotFound < Error; end
  
   class << self
     attr_accessor :search_method_name, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name, :model_options
@@ -58,13 +58,38 @@ module Searchkick
     @client ||= begin
       require "typhoeus/adapters/faraday" if defined?(Typhoeus) && Gem::Version.new(Faraday::VERSION) < Gem::Version.new("0.14.0")
  
-      Elasticsearch::Client.new({
-        url: ENV["ELASTICSEARCH_URL"] || ENV["OPENSEARCH_URL"],
-        transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
-        retry_on_failure: 2
-      }.deep_merge(client_options)) do |f|
-        f.use Searchkick::Middleware
-        f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
+      client_type =
+        if ENV["OPENSEARCH_URL"]
+          :opensearch
+        elsif ENV["ELASTICSEARCH_URL"]
+          :elasticsearch
+        elsif defined?(OpenSearch::Client)
+          :opensearch
+        elsif defined?(Elasticsearch::Client)
+          :elasticsearch
+        else
+          raise ClientNotFound, "Install the `opensearch-ruby` or `elasticsearch` gem"
+        end
+
+      if client_type == :opensearch
+        OpenSearch::Client.new({
+          url: ENV["OPENSEARCH_URL"],
+          transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
+          retry_on_failure: 2
+        }.deep_merge(client_options)) do |f|
+          f.use Searchkick::Middleware
+          f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
+        end
+      else
+        # TODO check version >= 7
+        Elasticsearch::Client.new({
+          url: ENV["ELASTICSEARCH_URL"],
+          transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
+          retry_on_failure: 2
+        }.deep_merge(client_options)) do |f|
+          f.use Searchkick::Middleware
+          f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
+        end
       end
     end
   end
-require "faraday/middleware"
+require "faraday"
  
 module Searchkick
   class Middleware < Faraday::Middleware
@@ -16,6 +16,5 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6"
  
   spec.add_dependency "activemodel", ">= 5.2"
-  spec.add_dependency "elasticsearch", ">= 6", "< 7.14"
   spec.add_dependency "hashie"
 end
...	...	@@ -6,6 +6,7 @@
6	6	- Raise `ArgumentError` instead of `RuntimeError` for unknown operators
7	7	- Removed mapping of `id` to `_id` with `order` option
8	8	- Removed `wordnet` option
	9	+- Removed `elasticsearch` dependency
9	10	- Dropped support for Ruby < 2.6 and Active Record < 5.2
10	11	- Dropped support for NoBrainer and Cequel
11	12	- Dropped support for `faraday_middleware-aws-signers-v4` (use `faraday_middleware-aws-sigv4` instead)
...	...
...	...	@@ -7,6 +7,7 @@ gem "minitest", ">= 5"
7	7	gem "activerecord", "~> 7.0.0"
8	8	gem "activejob", "~> 7.0.0", require: "active_job"
9	9	gem "actionpack", "~> 7.0.0"
	10	+gem "elasticsearch"
10	11	gem "sqlite3"
11	12	gem "gemoji-parser"
12	13	gem "typhoeus"
...	...
...	...	@@ -13,5 +13,5 @@ gem "typhoeus"
13	13	gem "redis"
14	14	gem "connection_pool"
15	15	gem "kaminari"
16		-gem "opensearch-ruby", github: "opensearch-project/opensearch-ruby"
	16	+gem "opensearch-ruby"
17	17	gem "parallel_tests"
...	...
1	1	# dependencies
2	2	require "active_support"
3	3	require "active_support/core_ext/hash/deep_merge"
4		-require "elasticsearch"
5	4	require "hashie"
6	5
7	6	# modules
...	...	@@ -41,6 +40,7 @@ module Searchkick
41	40	class InvalidQueryError < Error; end
42	41	class DangerousOperation < Error; end
43	42	class ImportError < Error; end
	43	+ class ClientNotFound < Error; end
44	44
45	45	class << self
46	46	attr_accessor :search_method_name, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name, :model_options
...	...	@@ -58,13 +58,38 @@ module Searchkick
58	58	@client \|\|= begin
59	59	require "typhoeus/adapters/faraday" if defined?(Typhoeus) && Gem::Version.new(Faraday::VERSION) < Gem::Version.new("0.14.0")
60	60
61		- Elasticsearch::Client.new({
62		- url: ENV["ELASTICSEARCH_URL"] \|\| ENV["OPENSEARCH_URL"],
63		- transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
64		- retry_on_failure: 2
65		- }.deep_merge(client_options)) do \|f\|
66		- f.use Searchkick::Middleware
67		- f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
	61	+ client_type =
	62	+ if ENV["OPENSEARCH_URL"]
	63	+ :opensearch
	64	+ elsif ENV["ELASTICSEARCH_URL"]
	65	+ :elasticsearch
	66	+ elsif defined?(OpenSearch::Client)
	67	+ :opensearch
	68	+ elsif defined?(Elasticsearch::Client)
	69	+ :elasticsearch
	70	+ else
	71	+ raise ClientNotFound, "Install the `opensearch-ruby` or `elasticsearch` gem"
	72	+ end
	73	+
	74	+ if client_type == :opensearch
	75	+ OpenSearch::Client.new({
	76	+ url: ENV["OPENSEARCH_URL"],
	77	+ transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
	78	+ retry_on_failure: 2
	79	+ }.deep_merge(client_options)) do \|f\|
	80	+ f.use Searchkick::Middleware
	81	+ f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
	82	+ end
	83	+ else
	84	+ # TODO check version >= 7
	85	+ Elasticsearch::Client.new({
	86	+ url: ENV["ELASTICSEARCH_URL"],
	87	+ transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
	88	+ retry_on_failure: 2
	89	+ }.deep_merge(client_options)) do \|f\|
	90	+ f.use Searchkick::Middleware
	91	+ f.request signer_middleware_key, signer_middleware_aws_params if aws_credentials
	92	+ end
68	93	end
69	94	end
70	95	end
...	...
1		-require "faraday/middleware"
	1	+require "faraday"
2	2
3	3	module Searchkick
4	4	class Middleware < Faraday::Middleware
...	...
...	...	@@ -16,6 +16,5 @@ Gem::Specification.new do \|spec\|
16	16	spec.required_ruby_version = ">= 2.6"
17	17
18	18	spec.add_dependency "activemodel", ">= 5.2"
19		- spec.add_dependency "elasticsearch", ">= 6", "< 7.14"
20	19	spec.add_dependency "hashie"
21	20	end
...	...