Prefer mode: :async over async: true for full reindex

Andrew Kane
1 parent 04974017
Showing 2 changed files with 24 additions and 5 deletions Show diff stats
CHANGELOG.md
lib/searchkick/index.rb
+## 5.0.1 (unreleased)
+
+- Prefer `mode: :async` over `async: true` for full reindex
+
 ## 5.0.0 (2022-02-21)
  
 - Searches now use lazy loading (similar to Active Record)
@@ -237,6 +237,19 @@ module Searchkick
         self.refresh if refresh
         true
       else
+        async = options.delete(:async)
+        if async
+          if async.is_a?(Hash) && async[:wait]
+            # TODO warn in 5.1
+            # Searchkick.warn "async option is deprecated - use mode: :async, wait: true instead"
+            options[:wait] = true unless options.key?(:wait)
+          else
+            # TODO warn in 5.1
+            # Searchkick.warn "async option is deprecated - use mode: :async instead"
+          end
+          options[:mode] ||= :async
+        end
+
         full_reindex(relation, **options)
       end
     end
@@ -337,7 +350,9 @@ module Searchkick
     # https://gist.github.com/jarosan/3124884
     # http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
     # TODO deprecate async in favor of mode: :async, wait: true/false
-    def full_reindex(relation, import: true, resume: false, retain: false, async: false, refresh_interval: nil, scope: nil)
+    def full_reindex(relation, import: true, resume: false, retain: false, mode: nil, refresh_interval: nil, scope: nil, wait: nil)
+      raise ArgumentError, "wait only available in :async mode" if !wait.nil? && mode != :async
+
       if resume
         index_name = all_indices.sort.last
         raise Searchkick::Error, "No index to resume" unless index_name
@@ -351,7 +366,7 @@ module Searchkick
       end
  
       import_options = {
-        mode: (async ? :async : :inline),
+        mode: mode,
         full: true,
         resume: resume,
         scope: scope
@@ -365,7 +380,7 @@ module Searchkick
         import_before_promotion(index, relation, **import_options) if import
  
         # get existing indices to remove
-        unless async
+        unless mode == :async
           check_uuid(uuid, index.uuid)
           promote(index.name, update_refresh_interval: !refresh_interval.nil?)
           clean_indices unless retain
@@ -378,8 +393,8 @@ module Searchkick
         index.import_scope(relation, **import_options) if import
       end
  
-      if async
-        if async.is_a?(Hash) && async[:wait]
+      if mode == :async
+        if wait
           puts "Created index: #{index.name}"
           puts "Jobs queued. Waiting..."
           loop do
	1	+## 5.0.1 (unreleased)
	2	+
	3	+- Prefer `mode: :async` over `async: true` for full reindex
	4	+
1	5	## 5.0.0 (2022-02-21)
2	6
3	7	- Searches now use lazy loading (similar to Active Record)
...	...
...	...	@@ -237,6 +237,19 @@ module Searchkick
237	237	self.refresh if refresh
238	238	true
239	239	else
	240	+ async = options.delete(:async)
	241	+ if async
	242	+ if async.is_a?(Hash) && async[:wait]
	243	+ # TODO warn in 5.1
	244	+ # Searchkick.warn "async option is deprecated - use mode: :async, wait: true instead"
	245	+ options[:wait] = true unless options.key?(:wait)
	246	+ else
	247	+ # TODO warn in 5.1
	248	+ # Searchkick.warn "async option is deprecated - use mode: :async instead"
	249	+ end
	250	+ options[:mode] \|\|= :async
	251	+ end
	252	+
240	253	full_reindex(relation, **options)
241	254	end
242	255	end
...	...	@@ -337,7 +350,9 @@ module Searchkick
337	350	# https://gist.github.com/jarosan/3124884
338	351	# http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
339	352	# TODO deprecate async in favor of mode: :async, wait: true/false
340		- def full_reindex(relation, import: true, resume: false, retain: false, async: false, refresh_interval: nil, scope: nil)
	353	+ def full_reindex(relation, import: true, resume: false, retain: false, mode: nil, refresh_interval: nil, scope: nil, wait: nil)
	354	+ raise ArgumentError, "wait only available in :async mode" if !wait.nil? && mode != :async
	355	+
341	356	if resume
342	357	index_name = all_indices.sort.last
343	358	raise Searchkick::Error, "No index to resume" unless index_name
...	...	@@ -351,7 +366,7 @@ module Searchkick
351	366	end
352	367
353	368	import_options = {
354		- mode: (async ? :async : :inline),
	369	+ mode: mode,
355	370	full: true,
356	371	resume: resume,
357	372	scope: scope
...	...	@@ -365,7 +380,7 @@ module Searchkick
365	380	import_before_promotion(index, relation, **import_options) if import
366	381
367	382	# get existing indices to remove
368		- unless async
	383	+ unless mode == :async
369	384	check_uuid(uuid, index.uuid)
370	385	promote(index.name, update_refresh_interval: !refresh_interval.nil?)
371	386	clean_indices unless retain
...	...	@@ -378,8 +393,8 @@ module Searchkick
378	393	index.import_scope(relation, **import_options) if import
379	394	end
380	395
381		- if async
382		- if async.is_a?(Hash) && async[:wait]
	396	+ if mode == :async
	397	+ if wait
383	398	puts "Created index: #{index.name}"
384	399	puts "Jobs queued. Waiting..."
385	400	loop do
...	...