searchkick.rb
10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# dependencies
require "active_support"
require "active_support/core_ext/hash/deep_merge"
require "active_support/core_ext/module/attr_internal"
require "active_support/core_ext/module/delegation"
require "active_support/notifications"
require "hashie"
# stdlib
require "forwardable"
# modules
require "searchkick/controller_runtime"
require "searchkick/index"
require "searchkick/index_cache"
require "searchkick/index_options"
require "searchkick/indexer"
require "searchkick/hash_wrapper"
require "searchkick/log_subscriber"
require "searchkick/model"
require "searchkick/multi_search"
require "searchkick/query"
require "searchkick/reindex_queue"
require "searchkick/record_data"
require "searchkick/record_indexer"
require "searchkick/relation"
require "searchkick/relation_indexer"
require "searchkick/results"
require "searchkick/version"
# integrations
require "searchkick/railtie" if defined?(Rails)
module Searchkick
# requires faraday
autoload :Middleware, "searchkick/middleware"
# background jobs
autoload :BulkReindexJob, "searchkick/bulk_reindex_job"
autoload :ProcessBatchJob, "searchkick/process_batch_job"
autoload :ProcessQueueJob, "searchkick/process_queue_job"
autoload :ReindexV2Job, "searchkick/reindex_v2_job"
# errors
class Error < StandardError; end
class MissingIndexError < Error; end
class UnsupportedVersionError < Error
def message
"This version of Searchkick requires Elasticsearch 7+ or OpenSearch 1+"
end
end
class InvalidQueryError < Error; end
class DangerousOperation < Error; end
class ImportError < Error; end
class << self
attr_accessor :search_method_name, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name, :model_options, :client_type
attr_writer :client, :env, :search_timeout
attr_reader :aws_credentials
end
self.search_method_name = :search
self.timeout = 10
self.models = []
self.client_options = {}
self.queue_name = :searchkick
self.model_options = {}
def self.client
@client ||= begin
client_type =
if self.client_type
self.client_type
elsif defined?(OpenSearch::Client) && defined?(Elasticsearch::Client)
raise Error, "Multiple clients found - set Searchkick.client_type = :elasticsearch or :opensearch"
elsif defined?(OpenSearch::Client)
:opensearch
elsif defined?(Elasticsearch::Client)
:elasticsearch
else
raise Error, "No client found - install the `elasticsearch` or `opensearch-ruby` gem"
end
# check after client to ensure faraday is installed
# TODO remove in Searchkick 6
if defined?(Typhoeus) && Gem::Version.new(Faraday::VERSION) < Gem::Version.new("0.14.0")
require "typhoeus/adapters/faraday"
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 :aws_sigv4, signer_middleware_aws_params if aws_credentials
end
else
raise Error, "The `elasticsearch` gem must be 7+" if Elasticsearch::VERSION.to_i < 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 :aws_sigv4, signer_middleware_aws_params if aws_credentials
end
end
end
end
def self.env
@env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
end
def self.search_timeout
(defined?(@search_timeout) && @search_timeout) || timeout
end
# private
def self.server_info
@server_info ||= client.info
end
def self.server_version
@server_version ||= server_info["version"]["number"]
end
def self.opensearch?
unless defined?(@opensearch)
@opensearch = server_info["version"]["distribution"] == "opensearch"
end
@opensearch
end
def self.server_below?(version)
server_version = opensearch? ? "7.10.2" : self.server_version
Gem::Version.new(server_version.split("-")[0]) < Gem::Version.new(version.split("-")[0])
end
def self.search(term = "*", model: nil, **options, &block)
options = options.dup
klass = model
# convert index_name into models if possible
# this should allow for easier upgrade
if options[:index_name] && !options[:models] && Array(options[:index_name]).all? { |v| v.respond_to?(:searchkick_index) }
options[:models] = options.delete(:index_name)
end
# make Searchkick.search(models: [Product]) and Product.search equivalent
unless klass
models = Array(options[:models])
if models.size == 1
klass = models.first
options.delete(:models)
end
end
if klass
if (options[:models] && Array(options[:models]) != [klass]) || Array(options[:index_name]).any? { |v| v.respond_to?(:searchkick_index) && v != klass }
raise ArgumentError, "Use Searchkick.search to search multiple models"
end
end
# TODO remove in Searchkick 6
if options[:execute] == false
Searchkick.warn("The execute option is no longer needed")
options.delete(:execute)
end
options = options.merge(block: block) if block
Relation.new(klass, term, **options)
end
def self.multi_search(queries)
return if queries.empty?
queries = queries.map { |q| q.send(:query) }
event = {
name: "Multi Search",
body: queries.flat_map { |q| [q.params.except(:body).to_json, q.body.to_json] }.map { |v| "#{v}\n" }.join,
}
ActiveSupport::Notifications.instrument("multi_search.searchkick", event) do
MultiSearch.new(queries).perform
end
end
# callbacks
def self.enable_callbacks
self.callbacks_value = nil
end
def self.disable_callbacks
self.callbacks_value = false
end
def self.callbacks?(default: true)
if callbacks_value.nil?
default
else
callbacks_value != false
end
end
# message is private
def self.callbacks(value = nil, message: nil)
if block_given?
previous_value = callbacks_value
begin
self.callbacks_value = value
result = yield
if callbacks_value == :bulk && indexer.queued_items.any?
event = {}
if message
message.call(event)
else
event[:name] = "Bulk"
event[:count] = indexer.queued_items.size
end
ActiveSupport::Notifications.instrument("request.searchkick", event) do
indexer.perform
end
end
result
ensure
self.callbacks_value = previous_value
end
else
self.callbacks_value = value
end
end
def self.aws_credentials=(creds)
require "faraday_middleware/aws_sigv4"
@aws_credentials = creds
@client = nil # reset client
end
def self.reindex_status(index_name)
raise Error, "Redis not configured" unless redis
batches_left = Index.new(index_name).batches_left
{
completed: batches_left == 0,
batches_left: batches_left
}
end
def self.with_redis
if redis
if redis.respond_to?(:with)
redis.with do |r|
yield r
end
else
yield redis
end
end
end
def self.warn(message)
super("[searchkick] WARNING: #{message}")
end
# private
def self.load_records(relation, ids)
relation =
if relation.respond_to?(:primary_key)
primary_key = relation.primary_key
raise Error, "Need primary key to load records" if !primary_key
relation.where(primary_key => ids)
elsif relation.respond_to?(:queryable)
relation.queryable.for_ids(ids)
end
raise Error, "Not sure how to load records" if !relation
relation
end
# private
def self.load_model(class_name, allow_child: false)
model = class_name.safe_constantize
raise Error, "Could not find class: #{class_name}" unless model
if allow_child
unless model.respond_to?(:searchkick_klass)
raise Error, "#{class_name} is not a searchkick model"
end
else
unless Searchkick.models.include?(model)
raise Error, "#{class_name} is not a searchkick model"
end
end
model
end
# private
def self.indexer
Thread.current[:searchkick_indexer] ||= Indexer.new
end
# private
def self.callbacks_value
Thread.current[:searchkick_callbacks_enabled]
end
# private
def self.callbacks_value=(value)
Thread.current[:searchkick_callbacks_enabled] = value
end
# private
def self.signer_middleware_aws_params
{service: "es", region: "us-east-1"}.merge(aws_credentials)
end
# private
# methods are forwarded to base class
# this check to see if scope exists on that class
# it's a bit tricky, but this seems to work
def self.relation?(klass)
if klass.respond_to?(:current_scope)
!klass.current_scope.nil?
else
klass.is_a?(Mongoid::Criteria) || !Mongoid::Threaded.current_scope(klass).nil?
end
end
# private
def self.scope(model)
# safety check to make sure used properly in code
raise Error, "Cannot scope relation" if relation?(model)
if model.searchkick_options[:unscope]
model.unscoped
else
model
end
end
# private
def self.not_found_error?(e)
(defined?(Elastic::Transport) && e.is_a?(Elastic::Transport::Transport::Errors::NotFound)) ||
(defined?(Elasticsearch::Transport) && 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?(Elastic::Transport) && e.is_a?(Elastic::Transport::Transport::Error)) ||
(defined?(Elasticsearch::Transport) && e.is_a?(Elasticsearch::Transport::Transport::Error)) ||
(defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Error))
end
# private
def self.not_allowed_error?(e)
(defined?(Elastic::Transport) && e.is_a?(Elastic::Transport::Transport::Errors::MethodNotAllowed)) ||
(defined?(Elasticsearch::Transport) && e.is_a?(Elasticsearch::Transport::Transport::Errors::MethodNotAllowed)) ||
(defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Errors::MethodNotAllowed))
end
end
ActiveSupport.on_load(:active_record) do
extend Searchkick::Model
end
ActiveSupport.on_load(:mongoid) do
Mongoid::Document::ClassMethods.include Searchkick::Model
end
ActiveSupport.on_load(:action_controller) do
include Searchkick::ControllerRuntime
end
Searchkick::LogSubscriber.attach_to :searchkick