searchkick 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc223f746f73c44e5c6f56b5e351cb31ae5a655069d92f5bfd2a0b2e531afae8
-  data.tar.gz: 1969964f34a5adaf3ed746230fbef57673454f7304d890466e2814d27eb2cb47
+  metadata.gz: ab19b7696cc775bda54eef31aaf9fea04a13a3027335440023f58f0c3b761fa0
+  data.tar.gz: 461f230a62f440e84684e9eb42cc85d307b726830eba80999c5648aef13de92e
 SHA512:
-  metadata.gz: 17259c3e071d69c3852584aba480b523211b167f1249951f32d1bd2f761fc07322144283f0ccabac4878c0a2ff2f4c9dd8def2db2beac004c449839052e503ea
-  data.tar.gz: 1109a53d99eb30f7e76cab8df00505c82af5e898c4e3f1821773932b8f6917e68f6bfedfa952b8e4acb25387607edf10856cc994021943671086af4d751cc728
+  metadata.gz: 5382e2de584271fc9f80802f858329c613f3b9aff7877c9bb9653dab550deb6ed1ac6971cbb2bc306f4d6e67056f16ee98eea04d69f2fd9ff15fd899e37f8962
+  data.tar.gz: dd8121e4991c9aaad5cd331cdc3adef3c703ee47abf8238ea3cc6feb1b1e5dcd85cb59c9f7ce91c086644d5946c5ccba936f48d0bc27988a59cca81adf161bb3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 5.0.1 (2022-02-27)
+
+- Prefer `mode: :async` over `async: true` for full reindex
+- Fixed instance method overriding with concerns
+
 ## 5.0.0 (2022-02-21)
 
 - Searches now use lazy loading (similar to Active Record)
@@ -15,7 +20,7 @@
 - Raise error when `search` called on relations
 - Raise `ArgumentError` (instead of warning) for invalid regular expression modifiers
 - Raise `ArgumentError` instead of `RuntimeError` for unknown operators
-- Removed mapping of `id` to `_id` with `order` option
+- Removed mapping of `id` to `_id` with `order` option (not supported in Elasticsearch 8)
 - Removed `wordnet` option (no longer worked)
 - Removed dependency on `elasticsearch` gem (can use `elasticsearch` or `opensearch-ruby`)
 - Dropped support for Elasticsearch 6

data/README.md

@@ -596,7 +596,7 @@ You can also do bulk updates.
 
 ```ruby
 Searchkick.callbacks(:bulk) do
-  User.find_each(&:update_fields)
+  Product.find_each(&:update_fields)
 end
 ```
 
@@ -604,7 +604,7 @@ Or temporarily skip updates.
 
 ```ruby
 Searchkick.callbacks(false) do
-  User.find_each(&:update_fields)
+  Product.find_each(&:update_fields)
 end
 ```
 
@@ -1100,7 +1100,7 @@ Product.search_index.tokens("dieg", analyzer: "searchkick_word_search")
 # ["dieg"] - match!!
 ```
 
-See the [complete list of analyzers](https://github.com/ankane/searchkick/blob/31780ddac7a89eab1e0552a32b403f2040a37931/lib/searchkick/index_options.rb#L32).
+See the [complete list of analyzers](lib/searchkick/index_options.rb#L36).
 
 ## Testing
 
@@ -1376,13 +1376,13 @@ Bonsai, Elastic Cloud, and Amazon OpenSearch Service all support encryption at r
 
 ### Automatic Failover
 
-Create an initializer `config/initializers/elasticsearch.rb` with multiple hosts:
+Create an initializer with multiple hosts:
 
 ```ruby
 ENV["ELASTICSEARCH_URL"] = "https://user:password@host1,https://user:password@host2"
 ```
 
-See [elasticsearch-transport](https://github.com/elastic/elasticsearch-ruby/blob/master/elasticsearch-transport) for a complete list of options.
+See [elastic-transport](https://github.com/elastic/elastic-transport-ruby) or [opensearch-transport](https://github.com/opensearch-project/opensearch-ruby/tree/main/opensearch-transport) for a complete list of options.
 
 ### Lograge
 
@@ -1453,7 +1453,7 @@ end
 For large data sets, you can use background jobs to parallelize reindexing.
 
 ```ruby
-Product.reindex(async: true)
+Product.reindex(mode: :async)
 # {index_name: "products_production_20170111210018065"}
 ```
 
@@ -1478,7 +1478,7 @@ Searchkick.reindex_status(index_name)
 You can also have Searchkick wait for reindexing to complete
 
 ```ruby
-Product.reindex(async: {wait: true})
+Product.reindex(mode: :async, wait: true)
 ```
 
 You can use [ActiveJob::TrafficControl](https://github.com/nickelser/activejob-traffic_control) to control concurrency. Install the gem:
@@ -1504,7 +1504,7 @@ This will allow only 3 jobs to run at once.
 You can specify a longer refresh interval while reindexing to increase performance.
 
 ```ruby
-Product.reindex(async: true, refresh_interval: "30s")
+Product.reindex(mode: :async, refresh_interval: "30s")
 ```
 
 **Note:** This only makes a noticable difference with parallel reindexing.
@@ -1711,7 +1711,7 @@ products =
 
 ### Client
 
-Searchkick is built on top of the [elasticsearch](https://github.com/elastic/elasticsearch-ruby) gem. To access the client directly, use:
+To access the `Elasticsearch::Client` or `OpenSearch::Client` directly, use:
 
 ```ruby
 Searchkick.client
@@ -2087,9 +2087,17 @@ Product.search("milk")
 Product.search("milk").to_a
 ```
 
+You can reindex relations in the background:
+
+```ruby
+store.products.reindex(mode: :async)
+# or
+store.products.reindex(mode: :queue)
+```
+
 And there’s a [new option](#default-scopes) for models with default scopes.
 
-Check out the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md) for the full list of changes.
+Check out the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md#500-2022-02-21) for the full list of changes.
 
 ## History
 

data/lib/searchkick/index.rb

@@ -71,12 +71,12 @@ module Searchkick
           }
         )
 
-      Searchkick::Results.new(nil, response).total_count
+      Results.new(nil, response).total_count
     end
 
     def promote(new_name, update_refresh_interval: false)
       if update_refresh_interval
-        new_index = Searchkick::Index.new(new_name, @options)
+        new_index = Index.new(new_name, @options)
         settings = options[:settings] || {}
         refresh_interval = (settings[:index] && settings[:index][:refresh_interval]) || "1s"
         new_index.update_settings(index: {refresh_interval: refresh_interval})
@@ -123,7 +123,7 @@ module Searchkick
     def clean_indices
       indices = all_indices(unaliased: true)
       indices.each do |index|
-        Searchkick::Index.new(index).delete
+        Index.new(index).delete
       end
       indices
     end
@@ -204,7 +204,7 @@ module Searchkick
     # queue
 
     def reindex_queue
-      Searchkick::ReindexQueue.new(name)
+      ReindexQueue.new(name)
     end
 
     # reindex
@@ -237,13 +237,26 @@ 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
 
     def create_index(index_options: nil)
       index_options ||= self.index_options
-      index = Searchkick::Index.new("#{name}_#{Time.now.strftime('%Y%m%d%H%M%S%L')}", @options)
+      index = Index.new("#{name}_#{Time.now.strftime('%Y%m%d%H%M%S%L')}", @options)
       index.create(index_options)
       index
     end
@@ -326,7 +339,7 @@ module Searchkick
     end
 
     def reindex_records(object, mode: nil, refresh: false, **options)
-      mode ||= Searchkick.callbacks_value || @options[:callbacks] || true
+      mode ||= Searchkick.callbacks_value || @options[:callbacks] || :inline
       mode = :inline if mode == :bulk
 
       result = RecordIndexer.new(self).reindex(object, mode: mode, full: false, **options)
@@ -336,12 +349,13 @@ 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
-        index = Searchkick::Index.new(index_name, @options)
+        raise Error, "No index to resume" unless index_name
+        index = Index.new(index_name, @options)
       else
         clean_indices unless retain
 
@@ -351,7 +365,7 @@ module Searchkick
       end
 
       import_options = {
-        mode: (async ? :async : :inline),
+        mode: (mode || :inline),
         full: true,
         resume: resume,
         scope: scope
@@ -365,7 +379,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 +392,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
@@ -417,7 +431,7 @@ module Searchkick
     # https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#index-creation
     def check_uuid(old_uuid, new_uuid)
       if old_uuid != new_uuid
-        raise Searchkick::Error, "Safety check failed - only run one Model.reindex per model at a time"
+        raise Error, "Safety check failed - only run one Model.reindex per model at a time"
       end
     end
 

data/lib/searchkick/index_options.rb

@@ -513,7 +513,7 @@ module Searchkick
         else
           [:searchkick_search2, :searchkick_word_search].each do |analyzer|
             unless settings[:analysis][:analyzer][analyzer].key?(:filter)
-              raise Searchkick::Error, "Search synonyms are not supported yet for language"
+              raise Error, "Search synonyms are not supported yet for language"
             end
 
             settings[:analysis][:analyzer][analyzer][:filter].insert(2, "searchkick_synonym_graph")

data/lib/searchkick/model.rb

@@ -22,16 +22,18 @@ module Searchkick
         raise ArgumentError, "Invalid value for callbacks"
       end
 
+      base = self
+
       mod = Module.new
       include(mod)
       mod.module_eval do
         def reindex(method_name = nil, mode: nil, refresh: false)
           self.class.searchkick_index.reindex([self], method_name: method_name, mode: mode, refresh: refresh, single: true)
-        end
+        end unless base.method_defined?(:reindex)
 
         def similar(**options)
           self.class.searchkick_index.similar_record(self, **options)
-        end
+        end unless base.method_defined?(:similar)
 
         def search_data
           data = respond_to?(:to_hash) ? to_hash : serializable_hash
@@ -39,11 +41,11 @@ module Searchkick
           data.delete("_id")
           data.delete("_type")
           data
-        end
+        end unless base.method_defined?(:search_data)
 
         def should_index?
           true
-        end
+        end unless base.method_defined?(:should_index?)
       end
 
       class_eval do
@@ -64,10 +66,10 @@ module Searchkick
           alias_method Searchkick.search_method_name, :searchkick_search if Searchkick.search_method_name
 
           def searchkick_index(name: nil)
-            index = name || searchkick_index_name
-            index = index.call if index.respond_to?(:call)
+            index_name = name || searchkick_index_name
+            index_name = index_name.call if index_name.respond_to?(:call)
             index_cache = class_variable_get(:@@searchkick_index_cache)
-            index_cache.fetch(index) { Searchkick::Index.new(index, searchkick_options) }
+            index_cache.fetch(index_name) { Searchkick::Index.new(index_name, searchkick_options) }
           end
           alias_method :search_index, :searchkick_index unless method_defined?(:search_index)
 

data/lib/searchkick/query.rb

@@ -187,11 +187,11 @@ module Searchkick
       end
 
       # set execute for multi search
-      @execute = Searchkick::Results.new(searchkick_klass, response, opts)
+      @execute = Results.new(searchkick_klass, response, opts)
     end
 
     def retry_misspellings?(response)
-      @misspellings_below && Searchkick::Results.new(searchkick_klass, response).total_count < @misspellings_below
+      @misspellings_below && Results.new(searchkick_klass, response).total_count < @misspellings_below
     end
 
     private

data/lib/searchkick/record_data.rb

@@ -25,6 +25,7 @@ module Searchkick
       {delete: record_data}
     end
 
+    # custom id can be useful for load: false
     def search_id
       id = record.respond_to?(:search_document_id) ? record.search_document_id : record.id
       id.is_a?(Numeric) ? id : id.to_s

data/lib/searchkick/record_indexer.rb

@@ -14,7 +14,7 @@ module Searchkick
       case mode
       when :async
         unless defined?(ActiveJob)
-          raise Searchkick::Error, "Active Job not found"
+          raise Error, "Active Job not found"
         end
 
         # we could likely combine ReindexV2Job, BulkReindexJob, and ProcessBatchJob
@@ -45,7 +45,7 @@ module Searchkick
         end
       when :queue
         if method_name
-          raise Searchkick::Error, "Partial reindex not supported with queue option"
+          raise Error, "Partial reindex not supported with queue option"
         end
 
         index.reindex_queue.push_records(records)

data/lib/searchkick/reindex_queue.rb

@@ -5,7 +5,7 @@ module Searchkick
     def initialize(name)
       @name = name
 
-      raise Searchkick::Error, "Searchkick.redis not set" unless Searchkick.redis
+      raise Error, "Searchkick.redis not set" unless Searchkick.redis
     end
 
     # supports single and multiple ids

data/lib/searchkick/results.rb

@@ -141,7 +141,7 @@ module Searchkick
 
     def hits
       if error
-        raise Searchkick::Error, "Query error - use the error method to view it"
+        raise Error, "Query error - use the error method to view it"
       else
         @response["hits"]["hits"]
       end
@@ -178,7 +178,7 @@ module Searchkick
     end
 
     def scroll
-      raise Searchkick::Error, "Pass `scroll` option to the search method for scrolling" unless scroll_id
+      raise Error, "Pass `scroll` option to the search method for scrolling" unless scroll_id
 
       if block_given?
         records = self
@@ -191,10 +191,10 @@ module Searchkick
       else
         begin
           # TODO Active Support notifications for this scroll call
-          Searchkick::Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
+          Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
         rescue => e
           if Searchkick.not_found_error?(e) && e.message =~ /search_context_missing_exception/i
-            raise Searchkick::Error, "Scroll id has expired"
+            raise Error, "Scroll id has expired"
           else
             raise e
           end
@@ -232,7 +232,7 @@ module Searchkick
                 index_alias = index.split("_")[0..-2].join("_")
                 Array((options[:index_mapping] || {})[index_alias])
               end
-            raise Searchkick::Error, "Unknown model for index: #{index}. Pass the `models` option to the search method." unless models.any?
+            raise Error, "Unknown model for index: #{index}. Pass the `models` option to the search method." unless models.any?
             index_models[index] = models
           end
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "5.0.0"
+  VERSION = "5.0.1"
 end

data/lib/searchkick.rb

@@ -171,7 +171,7 @@ module Searchkick
     end
 
     options = options.merge(block: block) if block
-    Searchkick::Relation.new(klass, term, **options)
+    Relation.new(klass, term, **options)
   end
 
   def self.multi_search(queries)
@@ -183,7 +183,7 @@ module Searchkick
       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
-      Searchkick::MultiSearch.new(queries).perform
+      MultiSearch.new(queries).perform
     end
   end
 
@@ -241,9 +241,9 @@ module Searchkick
   end
 
   def self.reindex_status(index_name)
-    raise Searchkick::Error, "Redis not configured" unless redis
+    raise Error, "Redis not configured" unless redis
 
-    batches_left = Searchkick::Index.new(index_name).batches_left
+    batches_left = Index.new(index_name).batches_left
     {
       completed: batches_left == 0,
       batches_left: batches_left

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel