Warn when incompatible options used with body option - for #984

Andrew Kane
1 parent cb63edde
Showing 4 changed files with 19 additions and 8 deletions Show diff stats
CHANGELOG.md
lib/searchkick/index.rb
lib/searchkick/query.rb
test/index_test.rb
@@ -5,6 +5,7 @@
 - Added `wait` option to async reindex
 - Added `model_includes` option
 - Raise error for `reindex_status` when Redis not configured
+- Warn when incompatible options used with `body` option
 ## 2.3.1
@@ -298,8 +298,8 @@ module Searchkick
         scope = scope.select("id").except(:includes, :preload) if async
-        scope.find_in_batches batch_size: batch_size do |batch|
-          import_or_update batch, method_name, async
+        scope.find_in_batches batch_size: batch_size do |items|
+          import_or_update items, method_name, async
         end
       else
         each_batch(scope) do |items|
@@ -223,6 +223,11 @@ module Searchkick
       @json = options[:body]
       if @json
+        ignored_options = options.keys & [:aggs, :boost,
+          :boost_by, :boost_by_distance, :boost_where, :conversions, :conversions_term, :exclude, :explain,
+          :fields, :highlight, :indices_boost, :limit, :match, :misspellings, :offset, :operator, :order,
+          :padding, :page, :per_page, :select, :smart_aggs, :suggest, :where]
+        warn "The body option replaces the entire body, so the following options are ignored: #{ignored_options.join(", ")}" if ignored_options.any?
         payload = @json
       else
         if options[:similar]
@@ -473,15 +478,16 @@ module Searchkick
         elsif load
           payload[:_source] = false
         end
+      end
-        if options[:type] || (klass != searchkick_klass && searchkick_index)
-          @type = [options[:type] || klass].flatten.map { |v| searchkick_index.klass_document_type(v) }
-        end
-
-        # routing
-        @routing = options[:routing] if options[:routing]
+      # type
+      if options[:type] || (klass != searchkick_klass && searchkick_index)
+        @type = [options[:type] || klass].flatten.map { |v| searchkick_index.klass_document_type(v) }
       end
+      # routing
+      @routing = options[:routing] if options[:routing]
+
       # merge more body options
       payload = payload.deep_merge(options[:body_options]) if options[:body_options]
@@ -59,6 +59,10 @@ class IndexTest &lt; Minitest::Test
     assert_equal ["Dollar Tree"], Store.search(body: {query: {match: {name: "Dollar Tree"}}}, load: false).map(&:name)
   end
+  def test_body_warning
+    assert_output(nil, "The body option replaces the entire body, so the following options are ignored: where\n") { Store.search(body: {query: {match: {name: "dollar"}}}, where: {id: 1}) }
+  end
+
   def test_block
     store_names ["Dollar Tree"]
     products =
	@@ -5,6 +5,7 @@		@@ -5,6 +5,7 @@
5	- Added `wait` option to async reindex	5	- Added `wait` option to async reindex
6	- Added `model_includes` option	6	- Added `model_includes` option
7	- Raise error for `reindex_status` when Redis not configured	7	- Raise error for `reindex_status` when Redis not configured
		8	+- Warn when incompatible options used with `body` option
8		9
9	## 2.3.1	10	## 2.3.1
10		11