Support conversion boosting on multiple fields

Rajesh Kumar
1 parent bd12de70
Showing 5 changed files with 121 additions and 30 deletions Show diff stats
README.md
lib/searchkick/index.rb
lib/searchkick/query.rb
test/boost_test.rb
test/test_helper.rb
@@ -1199,6 +1199,34 @@ class Product &lt; ActiveRecord::Base
 end
 ```
+Multiple conversion fields
+
+```ruby
+class Product < ActiveRecord::Base
+  has_many :searches, class_name: "Searchjoy::Search"
+
+  # searchkick also supports multiple "conversions" fields
+  searchkick conversions: ["unique_user_conversions", "total_conversions"]
+
+  def search_data
+    {
+      name: name,
+      unique_user_conversions: searches.group(:query).uniq.count(:user_id)
+      # {"ice cream" => 234, "chocolate" => 67, "cream" => 2}
+      total_conversions: searches.group(:query).count
+      # {"ice cream" => 412, "chocolate" => 117, "cream" => 6}
+    }
+  end
+end
+```
+and during query time:
+
+```ruby
+Product.search("banana") # boost by both fields (default)
+Product.search("banana", {conversions: "total_conversions"}) # only boost by total_conversions
+Product.search("banana", {conversions: false}) # no conversion boosting
+```
+
 Change timeout
 ```ruby
@@ -430,7 +430,7 @@ module Searchkick
         mapping = {}
         # conversions
-        if (conversions_field = options[:conversions])
+        Array(options[:conversions]).each do |conversions_field|
           mapping[conversions_field] = {
             type: "nested",
             properties: {
@@ -602,9 +602,10 @@ module Searchkick
       source = source.inject({}) { |memo, (k, v)| memo[k.to_s] = v; memo }.except("_id")
       # conversions
-      conversions_field = options[:conversions]
-      if conversions_field && source[conversions_field]
-        source[conversions_field] = source[conversions_field].map { |k, v| {query: k, count: v} }
+      Array(options[:conversions]).each do |conversions_field|
+        if source[conversions_field]
+          source[conversions_field] = source[conversions_field].map { |k, v| {query: k, count: v} }
+        end
       end
       # hack to prevent generator field doesn't exist error
@@ -162,8 +162,8 @@ module Searchkick
       # model and eagar loading
       load = options[:load].nil? ? true : options[:load]
-      conversions_field = searchkick_options[:conversions]
-      personalize_field = searchkick_options[:personalize]
+      conversions_fields = Array(options[:conversions] || searchkick_options[:conversions])
+      personalize_field  = searchkick_options[:personalize]
       all = term == "*"
@@ -275,34 +275,38 @@ module Searchkick
             }
           end
-          if conversions_field && options[:conversions] != false
-            # wrap payload in a bool query
-            script_score =
-              if below12?
-                {script_score: {script: "doc['count'].value"}}
-              else
-                {field_value_factor: {field: "#{conversions_field}.count"}}
-              end
+          if conversions_fields.present? && options[:conversions] != false
+            shoulds = []
+            conversions_fields.each do |conversions_field|
+              # wrap payload in a bool query
+              script_score =
+                if below12?
+                  {script_score: {script: "doc['count'].value"}}
+                else
+                  {field_value_factor: {field: "#{conversions_field}.count"}}
+                end
+              shoulds <<  {
+                            nested: {
+                              path: conversions_field,
+                              score_mode: "sum",
+                              query: {
+                                function_score: {
+                                  boost_mode: "replace",
+                                  query: {
+                                    match: {
+                                      "#{conversions_field}.query" => term
+                                    }
+                                  }
+                                }.merge(script_score)
+                              }
+                            }
+                          }
+            end
             payload = {
               bool: {
                 must: payload,
-                should: {
-                  nested: {
-                    path: conversions_field,
-                    score_mode: "sum",
-                    query: {
-                      function_score: {
-                        boost_mode: "replace",
-                        query: {
-                          match: {
-                            "#{conversions_field}.query" => term
-                          }
-                        }
-                      }.merge(script_score)
-                    }
-                  }
-                }
+                should: shoulds
               }
             }
           end
@@ -10,6 +10,24 @@ class BoostTest &lt; Minitest::Test
       {name: "Tomato C", conversions: {"tomato" => 3}}
     ]
     assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"]
+    assert_equal_scores "tomato", {conversions: false}
+  end
+
+  def test_multiple_conversions
+    skip if elasticsearch_below14?
+
+    store [
+      {name: "Speaker A", conversions_a: {"speaker" => 1}, conversions_b: {"speaker" => 6}},
+      {name: "Speaker B", conversions_a: {"speaker" => 2}, conversions_b: {"speaker" => 5}},
+      {name: "Speaker C", conversions_a: {"speaker" => 3}, conversions_b: {"speaker" => 4}},
+    ], Speaker
+
+    assert_equal_scores "speaker", {conversions: false}, Speaker
+    assert_equal_scores "speaker", {}, Speaker
+    assert_equal_scores "speaker", {conversions: ["conversions_a", "conversions_b"]}, Speaker
+    assert_equal_scores "speaker", {conversions: ["conversions_b", "conversions_a"]}, Speaker
+    assert_order "speaker", ["Speaker C", "Speaker B", "Speaker A"], {conversions: "conversions_a"}, Speaker
+    assert_order "speaker", ["Speaker A", "Speaker B", "Speaker C"], {conversions: "conversions_b"}, Speaker
   end
   def test_conversions_stemmed
@@ -93,6 +93,12 @@ if defined?(Mongoid)
     field :name
   end
+  class Speaker
+    include Mongoid::Document
+
+    field :name
+  end
+
   class Animal
     include Mongoid::Document
@@ -137,6 +143,13 @@ elsif defined?(NoBrainer)
     field :name, type: String
   end
+  class Speaker
+    include NoBrainer::Document
+
+    field :id,   type: Object
+    field :name, type: String
+  end
+
   class Animal
     include NoBrainer::Document
@@ -221,6 +234,10 @@ else
     t.string :name
   end
+  ActiveRecord::Migration.create_table :speakers do |t|
+    t.string :name
+  end
+
   ActiveRecord::Migration.create_table :animals do |t|
     t.string :name
     t.string :type
@@ -233,6 +250,9 @@ else
     has_many :products
   end
+  class Speaker < ActiveRecord::Base
+  end
+
   class Animal < ActiveRecord::Base
   end
@@ -310,6 +330,20 @@ class Store
   end
 end
+class Speaker
+  searchkick \
+    conversions: ["conversions_a", "conversions_b"]
+
+  attr_accessor :conversions_a, :conversions_b
+
+  def search_data
+    serializable_hash.except("id").merge(
+      conversions_a: conversions_a,
+      conversions_b: conversions_b,
+    )
+  end
+end
+
 class Animal
   searchkick \
     autocomplete: [:name],
@@ -325,12 +359,14 @@ Product.create!(name: &quot;Set mapping&quot;)
 Store.reindex
 Animal.reindex
+Speaker.reindex
 class Minitest::Test
   def setup
     Product.destroy_all
     Store.destroy_all
     Animal.destroy_all
+    Speaker.destroy_all
   end
   protected
@@ -355,6 +391,10 @@ class Minitest::Test
     assert_equal expected, klass.search(term, options).map(&:name)
   end
+  def assert_equal_scores(term, options = {}, klass = Product)
+    assert_equal 1, klass.search(term, options).hits.map { |a| a['_score'] }.uniq.size
+  end
+
   def assert_first(term, expected, options = {}, klass = Product)
     assert_equal expected, klass.search(term, options).map(&:name).first
   end
	@@ -1199,6 +1199,34 @@ class Product < ActiveRecord::Base		@@ -1199,6 +1199,34 @@ class Product < ActiveRecord::Base
1199	end	1199	end
1200	```	1200	```
1201		1201
		1202	+Multiple conversion fields
		1203	+
		1204	+```ruby
		1205	+class Product < ActiveRecord::Base
		1206	+ has_many :searches, class_name: "Searchjoy::Search"
		1207	+
		1208	+ # searchkick also supports multiple "conversions" fields
		1209	+ searchkick conversions: ["unique_user_conversions", "total_conversions"]
		1210	+
		1211	+ def search_data
		1212	+ {
		1213	+ name: name,
		1214	+ unique_user_conversions: searches.group(:query).uniq.count(:user_id)
		1215	+ # {"ice cream" => 234, "chocolate" => 67, "cream" => 2}
		1216	+ total_conversions: searches.group(:query).count
		1217	+ # {"ice cream" => 412, "chocolate" => 117, "cream" => 6}
		1218	+ }
		1219	+ end
		1220	+end
		1221	+```
		1222	+and during query time:
		1223	+
		1224	+```ruby
		1225	+Product.search("banana") # boost by both fields (default)
		1226	+Product.search("banana", {conversions: "total_conversions"}) # only boost by total_conversions
		1227	+Product.search("banana", {conversions: false}) # no conversion boosting
		1228	+```
		1229	+
1202	Change timeout	1230	Change timeout
1203		1231
1204	```ruby	1232	```ruby
	@@ -10,6 +10,24 @@ class BoostTest < Minitest::Test		@@ -10,6 +10,24 @@ class BoostTest < Minitest::Test
10	{name: "Tomato C", conversions: {"tomato" => 3}}	10	{name: "Tomato C", conversions: {"tomato" => 3}}
11	]	11	]
12	assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"]	12	assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"]
		13	+ assert_equal_scores "tomato", {conversions: false}
		14	+ end
		15	+
		16	+ def test_multiple_conversions
		17	+ skip if elasticsearch_below14?
		18	+
		19	+ store [
		20	+ {name: "Speaker A", conversions_a: {"speaker" => 1}, conversions_b: {"speaker" => 6}},
		21	+ {name: "Speaker B", conversions_a: {"speaker" => 2}, conversions_b: {"speaker" => 5}},
		22	+ {name: "Speaker C", conversions_a: {"speaker" => 3}, conversions_b: {"speaker" => 4}},
		23	+ ], Speaker
		24	+
		25	+ assert_equal_scores "speaker", {conversions: false}, Speaker
		26	+ assert_equal_scores "speaker", {}, Speaker
		27	+ assert_equal_scores "speaker", {conversions: ["conversions_a", "conversions_b"]}, Speaker
		28	+ assert_equal_scores "speaker", {conversions: ["conversions_b", "conversions_a"]}, Speaker
		29	+ assert_order "speaker", ["Speaker C", "Speaker B", "Speaker A"], {conversions: "conversions_a"}, Speaker
		30	+ assert_order "speaker", ["Speaker A", "Speaker B", "Speaker C"], {conversions: "conversions_b"}, Speaker
13	end	31	end
14		32
15	def test_conversions_stemmed	33	def test_conversions_stemmed
	@@ -93,6 +93,12 @@ if defined?(Mongoid)		@@ -93,6 +93,12 @@ if defined?(Mongoid)
93	field :name	93	field :name
94	end	94	end
95		95
		96	+ class Speaker
		97	+ include Mongoid::Document
		98	+
		99	+ field :name
		100	+ end
		101	+
96	class Animal	102	class Animal
97	include Mongoid::Document	103	include Mongoid::Document
98		104
	@@ -137,6 +143,13 @@ elsif defined?(NoBrainer)		@@ -137,6 +143,13 @@ elsif defined?(NoBrainer)
137	field :name, type: String	143	field :name, type: String
138	end	144	end
139		145
		146	+ class Speaker
		147	+ include NoBrainer::Document
		148	+
		149	+ field :id, type: Object
		150	+ field :name, type: String
		151	+ end
		152	+
140	class Animal	153	class Animal
141	include NoBrainer::Document	154	include NoBrainer::Document
142		155
	@@ -221,6 +234,10 @@ else		@@ -221,6 +234,10 @@ else
221	t.string :name	234	t.string :name
222	end	235	end
223		236
		237	+ ActiveRecord::Migration.create_table :speakers do \|t\|
		238	+ t.string :name
		239	+ end
		240	+
224	ActiveRecord::Migration.create_table :animals do \|t\|	241	ActiveRecord::Migration.create_table :animals do \|t\|
225	t.string :name	242	t.string :name
226	t.string :type	243	t.string :type
	@@ -233,6 +250,9 @@ else		@@ -233,6 +250,9 @@ else
233	has_many :products	250	has_many :products
234	end	251	end
235		252
		253	+ class Speaker < ActiveRecord::Base
		254	+ end
		255	+
236	class Animal < ActiveRecord::Base	256	class Animal < ActiveRecord::Base
237	end	257	end
238		258
	@@ -310,6 +330,20 @@ class Store		@@ -310,6 +330,20 @@ class Store
310	end	330	end
311	end	331	end
312		332
		333	+class Speaker
		334	+ searchkick \
		335	+ conversions: ["conversions_a", "conversions_b"]
		336	+
		337	+ attr_accessor :conversions_a, :conversions_b
		338	+
		339	+ def search_data
		340	+ serializable_hash.except("id").merge(
		341	+ conversions_a: conversions_a,
		342	+ conversions_b: conversions_b,
		343	+ )
		344	+ end
		345	+end
		346	+
313	class Animal	347	class Animal
314	searchkick \	348	searchkick \
315	autocomplete: [:name],	349	autocomplete: [:name],
	@@ -325,12 +359,14 @@ Product.create!(name: "Set mapping")		@@ -325,12 +359,14 @@ Product.create!(name: "Set mapping")
325		359
326	Store.reindex	360	Store.reindex
327	Animal.reindex	361	Animal.reindex
		362	+Speaker.reindex
328		363
329	class Minitest::Test	364	class Minitest::Test
330	def setup	365	def setup
331	Product.destroy_all	366	Product.destroy_all
332	Store.destroy_all	367	Store.destroy_all
333	Animal.destroy_all	368	Animal.destroy_all
		369	+ Speaker.destroy_all
334	end	370	end
335		371
336	protected	372	protected
	@@ -355,6 +391,10 @@ class Minitest::Test		@@ -355,6 +391,10 @@ class Minitest::Test
355	assert_equal expected, klass.search(term, options).map(&:name)	391	assert_equal expected, klass.search(term, options).map(&:name)
356	end	392	end
357		393
		394	+ def assert_equal_scores(term, options = {}, klass = Product)
		395	+ assert_equal 1, klass.search(term, options).hits.map { \|a\| a['_score'] }.uniq.size
		396	+ end
		397	+
358	def assert_first(term, expected, options = {}, klass = Product)	398	def assert_first(term, expected, options = {}, klass = Product)
359	assert_equal expected, klass.search(term, options).map(&:name).first	399	assert_equal expected, klass.search(term, options).map(&:name).first
360	end	400	end