searchkick 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b778411135d61db33ef8f82eb06990b41502d53cd5b2f4a21579f8c79b2f7aff
-  data.tar.gz: ba732ab1e72db7a9c5600bf99c3ae4b99d91cb47c97ad3ada0147888cb5e084f
+  metadata.gz: bfa26cdc7332a0b73376d46fbd9b66cc093e919d605bbd80ceec04cfbffed914
+  data.tar.gz: 541e111f81bec56c621b147e5aea2b8017a91eaa3f40d074d1a5aa619da14f14
 SHA512:
-  metadata.gz: e4bb9b36b02989e29ed8adf179f45abf597ff91a63e23f442ab285f05523f15d8e00ff7a6fc634fca5553d6d91a05be467e589f8cf6e1b0de155b6db81c623fb
-  data.tar.gz: 417adb5009b35512b45c11024e4c9a413d713361a2bb0897b17e8c9128a788bcbb3b8df7801ef50a0fbae8269741e8a5f3c2405b4ddcdd0dab9f1ef914ef28bd
+  metadata.gz: ea250f38b93967d245168ab5b0cbb41a86fb0d471df8f5844e2f3e59337630b8a545df059b5fe08fb7582046749e0ffebc2b8d9152e7eee225e04ad7aedb5a54
+  data.tar.gz: 07f98bb46fd861dc9957ff81931965c3032dccada46e098c9723bcba68fe9365b9927c6d1283ae564aa96f83eaccdd547356de6cf3ccec7fde699a9b9d3ef18e

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.1.2
+
+- Improved performance of indices boost
+- Fixed deletes with routing and `async` callbacks
+- Fixed deletes with routing and `queue` callbacks
+- Fixed deprecation warnings
+- Fixed field misspellings for older partial match format
+
 ## 3.1.1
 
 - Added per-field misspellings

data/README.md

@@ -30,7 +30,7 @@ Plus:
 
 ---
 
-Does your startup use Searchkick? Want a free hour of advising? Fill out [this application](https://goo.gl/forms/Or1HQTRb2rgQCNtd2). I’ll reach out to a few companies.
+Does your company use Searchkick? Want free advising? Fill out [this application](https://goo.gl/forms/Or1HQTRb2rgQCNtd2)
 
 ---
 
@@ -46,10 +46,6 @@ Does your startup use Searchkick? Want a free hour of advising? Fill out [this a
 - [Elasticsearch DSL](#advanced)
 - [Reference](#reference)
 
-**Searchkick 3.0 was recently released!** See [how to upgrade](docs/Searchkick-3-Upgrade.md)
-
-Thinking of upgrading from Elasticsearch 5 to 6? [Read this first](#elasticsearch-5-to-6-upgrade)
-
 ## Getting Started
 
 [Install Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
@@ -439,6 +435,12 @@ exclude_queries = {
 Product.search query, exclude: exclude_queries[query]
 ```
 
+You can demote results by boosting by a factor less than one:
+
+```ruby
+Product.search("butter", boost_where: {category: {value: "pantry", factor: 0.5}})
+```
+
 ### Emoji
 
 Search :ice_cream::cake: and get `ice cream cake`!
@@ -776,9 +778,11 @@ Product.search "apples", aggs: {store_id: {limit: 10}}
 Order
 
 ```ruby
-Product.search "wingtips", aggs: {color: {order: {"_term" => "asc"}}} # alphabetically
+Product.search "wingtips", aggs: {color: {order: {"_key" => "asc"}}} # alphabetically
 ```
 
+**Note:** Use `_term` instead of `_key` in Elasticsearch 5
+
 [All of these options are supported](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-order)
 
 Ranges
@@ -800,6 +804,8 @@ Script support
 Product.search "*", aggs: {color: {script: {source: "'Color: ' + _value"}}}
 ```
 
+**Note:** Use `inline` instead of `source` before Elasticsearch 5.6
+
 Date histogram
 
 ```ruby
@@ -999,11 +1005,14 @@ Dog.search "*"                      # just dogs
 Animal.search "*", type: [Dog, Cat] # just cats and dogs
 ```
 
-**Note:** The `suggest` option retrieves suggestions from the parent at the moment.
+**Notes:**
 
-```ruby
-Dog.search "airbudd", suggest: true # suggestions for all animals
-```
+1. The `suggest` option retrieves suggestions from the parent at the moment.
+
+    ```ruby
+    Dog.search "airbudd", suggest: true # suggestions for all animals
+    ```
+2. This relies on a `type` field that is automatically added to the indexed document. Be wary of defining your own `type` field in `search_data`, as it will take precedence.
 
 ## Debugging Queries
 
@@ -1732,6 +1741,16 @@ Create index without importing
 Product.reindex(import: false)
 ```
 
+Use a different id
+
+```ruby
+class Product < ApplicationRecord
+  def search_document_id
+    custom_id
+  end
+end
+```
+
 Lazy searching
 
 ```ruby
@@ -1887,6 +1906,10 @@ Searchkick.index_suffix = ENV["TEST_ENV_NUMBER"]
 
 Check out [this great post](https://www.tiagoamaro.com.br/2014/12/11/multi-tenancy-with-searchkick/) on the [Apartment](https://github.com/influitive/apartment) gem. Follow a similar pattern if you use another gem.
 
+## Upgrading
+
+See [how to upgrade to Searchkick 3](docs/Searchkick-3-Upgrade.md)
+
 ## Elasticsearch 5 to 6 Upgrade
 
 Elasticsearch 6 removes the ability to reindex with the `_all` field. Before you upgrade, we recommend disabling this field manually and specifying default fields on your models.

data/lib/searchkick/process_batch_job.rb

@@ -3,6 +3,10 @@ module Searchkick
     queue_as { Searchkick.queue_name }
 
     def perform(class_name:, record_ids:)
+      # separate routing from id
+      routing = Hash[record_ids.map { |r| r.split(/(?<!\|)\|(?!\|)/, 2).map { |v| v.gsub("||", "|") } }]
+      record_ids = routing.keys
+
       klass = class_name.constantize
       scope = Searchkick.load_records(klass, record_ids)
       scope = scope.search_import if scope.respond_to?(:search_import)
@@ -10,7 +14,16 @@ module Searchkick
 
       # determine which records to delete
       delete_ids = record_ids - records.map { |r| r.id.to_s }
-      delete_records = delete_ids.map { |id| m = klass.new; m.id = id; m }
+      delete_records = delete_ids.map do |id|
+        m = klass.new
+        m.id = id
+        if routing[id]
+          m.define_singleton_method(:search_routing) do
+            routing[id]
+          end
+        end
+        m
+      end
 
       # bulk reindex
       index = klass.searchkick_index

data/lib/searchkick/query.rb

@@ -281,10 +281,10 @@ module Searchkick
             prefix_length = (misspellings.is_a?(Hash) && misspellings[:prefix_length]) || 0
             default_max_expansions = @misspellings_below ? 20 : 3
             max_expansions = (misspellings.is_a?(Hash) && misspellings[:max_expansions]) || default_max_expansions
-            misspellings_fields = misspellings.is_a?(Hash) && misspellings.key?(:fields) && misspellings[:fields].map { |f| "#{f}.#{@match_suffix}" }
+            misspellings_fields = misspellings.is_a?(Hash) && misspellings.key?(:fields) && misspellings[:fields].map(&:to_s)
 
             if misspellings_fields
-              missing_fields = misspellings_fields - fields
+              missing_fields = misspellings_fields - fields.map { |f| base_field(f) }
               if missing_fields.any?
                 raise ArgumentError, "All fields in per-field misspellings must also be specified in fields option"
               end
@@ -324,7 +324,7 @@ module Searchkick
             exclude_analyzer = nil
             exclude_field = field
 
-            field_misspellings = misspellings && (!misspellings_fields || misspellings_fields.include?(field))
+            field_misspellings = misspellings && (!misspellings_fields || misspellings_fields.include?(base_field(field)))
 
             if field == "_all" || field.end_with?(".analyzed")
               shared_options[:cutoff_frequency] = 0.001 unless operator.to_s == "and" || field_misspellings == false
@@ -660,11 +660,20 @@ module Searchkick
     def set_boost_by_indices(payload)
       return unless options[:indices_boost]
 
-      indices_boost = options[:indices_boost].each_with_object({}) do |(key, boost), memo|
-        index = key.respond_to?(:searchkick_index) ? key.searchkick_index.name : key
-        # try to use index explicitly instead of alias: https://github.com/elasticsearch/elasticsearch/issues/4756
-        index_by_alias = Searchkick.client.indices.get_alias(index: index).keys.first
-        memo[index_by_alias || index] = boost
+      if below52?
+        indices_boost = options[:indices_boost].each_with_object({}) do |(key, boost), memo|
+          index = key.respond_to?(:searchkick_index) ? key.searchkick_index.name : key
+          # try to use index explicitly instead of alias: https://github.com/elasticsearch/elasticsearch/issues/4756
+          index_by_alias = Searchkick.client.indices.get_alias(index: index).keys.first
+          memo[index_by_alias || index] = boost
+        end
+      else
+        # array format supports alias resolution
+        # https://github.com/elastic/elasticsearch/pull/21393
+        indices_boost = options[:indices_boost].map do |key, boost|
+          index = key.respond_to?(:searchkick_index) ? key.searchkick_index.name : key
+          {index => boost}
+        end
       end
 
       payload[:indices_boost] = indices_boost
@@ -812,7 +821,7 @@ module Searchkick
     # TODO id transformation for arrays
     def set_order(payload)
       order = options[:order].is_a?(Enumerable) ? options[:order] : {options[:order] => :asc}
-      id_field = :_uid
+      id_field = below60? ? :_uid : :_id
       payload[:sort] = order.is_a?(Array) ? order : Hash[order.map { |k, v| [k.to_s == "id" ? id_field : k, v] }]
     end
 
@@ -998,6 +1007,14 @@ module Searchkick
       end
     end
 
+    def base_field(k)
+      k.sub(/\.(analyzed|word_start|word_middle|word_end|text_start|text_middle|text_end|exact)\z/, "")
+    end
+
+    def below52?
+      Searchkick.server_below?("5.2.0")
+    end
+
     def below60?
       Searchkick.server_below?("6.0.0")
     end

data/lib/searchkick/record_data.rb

@@ -34,6 +34,11 @@ module Searchkick
       index.klass_document_type(record.class, ignore_type)
     end
 
+    # memoize
+    def self.routing_key
+      @routing_key ||= Searchkick.server_below?("6.0.0") ? :_routing : :routing
+    end
+
     private
 
     def record_data
@@ -42,7 +47,7 @@ module Searchkick
         _id: search_id,
         _type: document_type
       }
-      data[:_routing] = record.search_routing if record.respond_to?(:search_routing)
+      data[self.class.routing_key] = record.search_routing if record.respond_to?(:search_routing)
       data
     end
 

data/lib/searchkick/record_indexer.rb

@@ -20,16 +20,32 @@ module Searchkick
           raise Searchkick::Error, "Partial reindex not supported with queue option"
         end
 
-        index.reindex_queue.push(record.id.to_s)
+        # always pass routing in case record is deleted
+        # before the queue job runs
+        if record.respond_to?(:search_routing)
+          routing = record.search_routing
+        end
+
+        # escape pipe with double pipe
+        value = queue_escape(record.id.to_s)
+        value = "#{value}|#{queue_escape(routing)}" if routing
+        index.reindex_queue.push(value)
       when :async
         unless defined?(ActiveJob)
           raise Searchkick::Error, "Active Job not found"
         end
 
+        # always pass routing in case record is deleted
+        # before the async job runs
+        if record.respond_to?(:search_routing)
+          routing = record.search_routing
+        end
+
         Searchkick::ReindexV2Job.perform_later(
           record.class.name,
           record.id.to_s,
-          method_name ? method_name.to_s : nil
+          method_name ? method_name.to_s : nil,
+          routing: routing
         )
       else # bulk, inline/true/nil
         reindex_record(method_name)
@@ -40,6 +56,10 @@ module Searchkick
 
     private
 
+    def queue_escape(value)
+      value.gsub("|", "||")
+    end
+
     def reindex_record(method_name)
       if record.destroyed? || !record.persisted? || !record.should_index?
         begin

data/lib/searchkick/reindex_v2_job.rb

@@ -9,7 +9,7 @@ module Searchkick
 
     queue_as { Searchkick.queue_name }
 
-    def perform(klass, id, method_name = nil)
+    def perform(klass, id, method_name = nil, routing: nil)
       model = klass.constantize
       record =
         begin
@@ -28,6 +28,11 @@ module Searchkick
       unless record
         record = model.new
         record.id = id
+        if routing
+          record.define_singleton_method(:search_routing) do
+            routing
+          end
+        end
       end
 
       RecordIndexer.new(record).reindex(method_name, mode: :inline)

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "3.1.1"
+  VERSION = "3.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel