searchkick 4.6.3 → 5.0.2

data/lib/searchkick/record_indexer.rb

@@ -1,79 +1,163 @@
 module Searchkick
   class RecordIndexer
-    attr_reader :record, :index
+    attr_reader :index
 
-    def initialize(record)
-      @record = record
-      @index = record.class.searchkick_index
+    def initialize(index)
+      @index = index
     end
 
-    def reindex(method_name = nil, refresh: false, mode: nil)
-      unless [:inline, true, nil, :async, :queue].include?(mode)
-        raise ArgumentError, "Invalid value for mode"
-      end
-
-      mode ||= Searchkick.callbacks_value || index.options[:callbacks] || true
+    def reindex(records, mode:, method_name:, full: false, single: false)
+      # prevents exists? check if records is a relation
+      records = records.to_a
+      return if records.empty?
 
       case mode
+      when :async
+        unless defined?(ActiveJob)
+          raise Error, "Active Job not found"
+        end
+
+        # we could likely combine ReindexV2Job, BulkReindexJob, and ProcessBatchJob
+        # but keep them separate for now
+        if single
+          record = records.first
+
+          # 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,
+            routing: routing,
+            index_name: index.name
+          )
+        else
+          Searchkick::BulkReindexJob.perform_later(
+            class_name: records.first.class.searchkick_options[:class_name],
+            record_ids: records.map { |r| r.id.to_s },
+            index_name: index.name,
+            method_name: method_name ? method_name.to_s : nil
+          )
+        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
 
-        # always pass routing in case record is deleted
-        # before the queue job runs
-        if record.respond_to?(:search_routing)
-          routing = record.search_routing
-        end
+        index.reindex_queue.push_records(records)
+      when true, :inline
+        index_records, other_records = records.partition { |r| index_record?(r) }
+        import_inline(index_records, !full ? other_records : [], method_name: method_name, single: single)
+      else
+        raise ArgumentError, "Invalid value for mode"
+      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
+      # return true like model and relation reindex for now
+      true
+    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
+    def reindex_items(klass, items, method_name:, single: false)
+      routing = items.to_h { |r| [r[:id], r[:routing]] }
+      record_ids = routing.keys
 
-        Searchkick::ReindexV2Job.perform_later(
-          record.class.name,
-          record.id.to_s,
-          method_name ? method_name.to_s : nil,
-          routing: routing
-        )
-      else # bulk, inline/true/nil
-        reindex_record(method_name)
+      relation = Searchkick.load_records(klass, record_ids)
+      # call search_import even for single records for nested associations
+      relation = relation.search_import if relation.respond_to?(:search_import)
+      records = relation.select(&:should_index?)
 
-        index.refresh if refresh
-      end
+      # determine which records to delete
+      delete_ids = record_ids - records.map { |r| r.id.to_s }
+      delete_records =
+        delete_ids.map do |id|
+          construct_record(klass, id, routing[id])
+        end
+
+      import_inline(records, delete_records, method_name: method_name, single: single)
     end
 
     private
 
-    def queue_escape(value)
-      value.gsub("|", "||")
+    def index_record?(record)
+      record.persisted? && !record.destroyed? && record.should_index?
     end
 
-    def reindex_record(method_name)
-      if record.destroyed? || !record.persisted? || !record.should_index?
-        begin
-          index.remove(record)
-        rescue => e
-          raise e unless Searchkick.not_found_error?(e)
-          # do nothing if not found
+    # import in single request with retries
+    def import_inline(index_records, delete_records, method_name:, single:)
+      return if index_records.empty? && delete_records.empty?
+
+      maybe_bulk(index_records, delete_records, method_name, single) do
+        if index_records.any?
+          if method_name
+            index.bulk_update(index_records, method_name)
+          else
+            index.bulk_index(index_records)
+          end
         end
+
+        if delete_records.any?
+          index.bulk_delete(delete_records)
+        end
+      end
+    end
+
+    def maybe_bulk(index_records, delete_records, method_name, single)
+      if Searchkick.callbacks_value == :bulk
+        yield
       else
-        if method_name
-          index.update_record(record, method_name)
-        else
-          index.store(record)
+        # set action and data
+        action =
+          if single && index_records.empty?
+            "Remove"
+          elsif method_name
+            "Update"
+          else
+            single ? "Store" : "Import"
+          end
+        record = index_records.first || delete_records.first
+        name = record.class.searchkick_klass.name
+        message = lambda do |event|
+          event[:name] = "#{name} #{action}"
+          if single
+            event[:id] = index.search_id(record)
+          else
+            event[:count] = index_records.size + delete_records.size
+          end
+        end
+
+        with_retries do
+          Searchkick.callbacks(:bulk, message: message) do
+            yield
+          end
+        end
+      end
+    end
+
+    def construct_record(klass, id, routing)
+      record = klass.new
+      record.id = id
+      if routing
+        record.define_singleton_method(:search_routing) do
+          routing
+        end
+      end
+      record
+    end
+
+    def with_retries
+      retries = 0
+
+      begin
+        yield
+      rescue Faraday::ClientError => e
+        if retries < 1
+          retries += 1
+          retry
         end
+        raise e
       end
     end
   end

data/lib/searchkick/reindex_queue.rb

@@ -5,11 +5,30 @@ 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
 
-    def push(record_id)
-      Searchkick.with_redis { |r| r.lpush(redis_key, record_id) }
+    # supports single and multiple ids
+    def push(record_ids)
+      Searchkick.with_redis { |r| r.lpush(redis_key, record_ids) }
+    end
+
+    def push_records(records)
+      record_ids =
+        records.map do |record|
+          # 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 = escape(record.id.to_s)
+          value = "#{value}|#{escape(routing)}" if routing
+          value
+        end
+
+      push(record_ids)
     end
 
     # TODO use reliable queuing
@@ -48,5 +67,9 @@ module Searchkick
     def redis_version
       @redis_version ||= Searchkick.with_redis { |r| Gem::Version.new(r.info["redis_version"]) }
     end
+
+    def escape(value)
+      value.gsub("|", "||")
+    end
   end
 end

data/lib/searchkick/reindex_v2_job.rb

@@ -1,41 +1,17 @@
 module Searchkick
   class ReindexV2Job < ActiveJob::Base
-    RECORD_NOT_FOUND_CLASSES = [
-      "ActiveRecord::RecordNotFound",
-      "Mongoid::Errors::DocumentNotFound",
-      "NoBrainer::Error::DocumentNotFound",
-      "Cequel::Record::RecordNotFound"
-    ]
-
     queue_as { Searchkick.queue_name }
 
-    def perform(klass, id, method_name = nil, routing: nil)
-      model = klass.constantize
-      record =
-        begin
-          if model.respond_to?(:unscoped)
-            model.unscoped.find(id)
-          else
-            model.find(id)
-          end
-        rescue => e
-          # check by name rather than rescue directly so we don't need
-          # to determine which classes are defined
-          raise e unless RECORD_NOT_FOUND_CLASSES.include?(e.class.name)
-          nil
-        end
-
-      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)
+    def perform(class_name, id, method_name = nil, routing: nil, index_name: nil)
+      model = Searchkick.load_model(class_name, allow_child: true)
+      index = model.searchkick_index(name: index_name)
+      # use should_index? to decide whether to index (not default scope)
+      # just like saving inline
+      # could use Searchkick.scope() in future
+      # but keep for now for backwards compatibility
+      model = model.unscoped if model.respond_to?(:unscoped)
+      items = [{id: id, routing: routing}]
+      RecordIndexer.new(index).reindex_items(model, items, method_name: method_name, single: true)
     end
   end
 end

data/lib/searchkick/relation.rb

@@ -0,0 +1,112 @@
+module Searchkick
+  class Relation
+    NO_DEFAULT_VALUE = Object.new
+
+    # note: modifying body directly is not supported
+    # and has no impact on query after being executed
+    # TODO freeze body object?
+    delegate :body, :params, to: :query
+    delegate_missing_to :private_execute
+
+    def initialize(model, term = "*", **options)
+      @model = model
+      @term = term
+      @options = options
+
+      # generate query to validate options
+      query
+    end
+
+    # same as Active Record
+    def inspect
+      entries = results.first(11).map!(&:inspect)
+      entries[10] = "..." if entries.size == 11
+      "#<#{self.class.name} [#{entries.join(', ')}]>"
+    end
+
+    def execute
+      Searchkick.warn("The execute method is no longer needed")
+      private_execute
+      self
+    end
+
+    def limit(value)
+      clone.limit!(value)
+    end
+
+    def limit!(value)
+      check_loaded
+      @options[:limit] = value
+      self
+    end
+
+    def offset(value = NO_DEFAULT_VALUE)
+      # TODO remove in Searchkick 6
+      if value == NO_DEFAULT_VALUE
+        private_execute.offset
+      else
+        clone.offset!(value)
+      end
+    end
+
+    def offset!(value)
+      check_loaded
+      @options[:offset] = value
+      self
+    end
+
+    def page(value)
+      clone.page!(value)
+    end
+
+    def page!(value)
+      check_loaded
+      @options[:page] = value
+      self
+    end
+
+    def per_page(value = NO_DEFAULT_VALUE)
+      # TODO remove in Searchkick 6
+      if value == NO_DEFAULT_VALUE
+        private_execute.per_page
+      else
+        clone.per_page!(value)
+      end
+    end
+
+    def per_page!(value)
+      check_loaded
+      @options[:per_page] = value
+      self
+    end
+
+    def only(*keys)
+      Relation.new(@model, @term, **@options.slice(*keys))
+    end
+
+    def except(*keys)
+      Relation.new(@model, @term, **@options.except(*keys))
+    end
+
+    def loaded?
+      !@execute.nil?
+    end
+
+    private
+
+    def private_execute
+      @execute ||= query.execute
+    end
+
+    def query
+      @query ||= Query.new(@model, @term, **@options)
+    end
+
+    def check_loaded
+      raise Error, "Relation loaded" if loaded?
+
+      # reset query since options will change
+      @query = nil
+    end
+  end
+end

data/lib/searchkick/relation_indexer.rb

@@ -0,0 +1,150 @@
+module Searchkick
+  class RelationIndexer
+    attr_reader :index
+
+    def initialize(index)
+      @index = index
+    end
+
+    def reindex(relation, mode:, method_name: nil, full: false, resume: false, scope: nil)
+      # apply scopes
+      if scope
+        relation = relation.send(scope)
+      elsif relation.respond_to?(:search_import)
+        relation = relation.search_import
+      end
+
+      # remove unneeded loading for async
+      if mode == :async
+        if relation.respond_to?(:primary_key)
+          relation = relation.select(relation.primary_key).except(:includes, :preload)
+        elsif relation.respond_to?(:only)
+          relation = relation.only(:_id)
+        end
+      end
+
+      if mode == :async && full
+        return full_reindex_async(relation)
+      end
+
+      relation = resume_relation(relation) if resume
+
+      reindex_options = {
+        mode: mode,
+        method_name: method_name,
+        full: full
+      }
+      record_indexer = RecordIndexer.new(index)
+
+      in_batches(relation) do |items|
+        record_indexer.reindex(items, **reindex_options)
+      end
+    end
+
+    def batches_left
+      Searchkick.with_redis { |r| r.scard(batches_key) }
+    end
+
+    def batch_completed(batch_id)
+      Searchkick.with_redis { |r| r.srem(batches_key, batch_id) }
+    end
+
+    private
+
+    def resume_relation(relation)
+      if relation.respond_to?(:primary_key)
+        # use total docs instead of max id since there's not a great way
+        # to get the max _id without scripting since it's a string
+        where = relation.arel_table[relation.primary_key].gt(index.total_docs)
+        relation = relation.where(where)
+      else
+        raise Error, "Resume not supported for Mongoid"
+      end
+    end
+
+    def in_batches(relation)
+      if relation.respond_to?(:find_in_batches)
+        klass = relation.klass
+        # remove order to prevent possible warnings
+        relation.except(:order).find_in_batches(batch_size: batch_size) do |batch|
+          # prevent scope from affecting search_data as well as inline jobs
+          # Active Record runs relation calls in scoping block
+          # https://github.com/rails/rails/blob/main/activerecord/lib/active_record/relation/delegation.rb
+          # note: we could probably just call klass.current_scope = nil
+          # anywhere in reindex method (after initial all call),
+          # but this is more cautious
+          previous_scope = klass.current_scope(true)
+          if previous_scope
+            begin
+              klass.current_scope = nil
+              yield batch
+            ensure
+              klass.current_scope = previous_scope
+            end
+          else
+            yield batch
+          end
+        end
+      else
+        klass = relation.klass
+        each_batch(relation, batch_size: batch_size) do |batch|
+          # prevent scope from affecting search_data as well as inline jobs
+          # note: Model.with_scope doesn't always restore scope, so use custom logic
+          previous_scope = Mongoid::Threaded.current_scope(klass)
+          if previous_scope
+            begin
+              Mongoid::Threaded.set_current_scope(nil, klass)
+              yield batch
+            ensure
+              Mongoid::Threaded.set_current_scope(previous_scope, klass)
+            end
+          else
+            yield batch
+          end
+        end
+      end
+    end
+
+    def each_batch(relation, batch_size:)
+      # https://github.com/karmi/tire/blob/master/lib/tire/model/import.rb
+      # use cursor for Mongoid
+      items = []
+      relation.all.each do |item|
+        items << item
+        if items.length == batch_size
+          yield items
+          items = []
+        end
+      end
+      yield items if items.any?
+    end
+
+    def batch_size
+      @batch_size ||= index.options[:batch_size] || 1000
+    end
+
+    def full_reindex_async(relation)
+      batch_id = 1
+      class_name = relation.searchkick_options[:class_name]
+
+      in_batches(relation) do |items|
+        batch_job(class_name, batch_id, items.map(&:id))
+        batch_id += 1
+      end
+    end
+
+    def batch_job(class_name, batch_id, record_ids)
+      Searchkick.with_redis { |r| r.sadd(batches_key, batch_id) }
+      Searchkick::BulkReindexJob.perform_later(
+        class_name: class_name,
+        index_name: index.name,
+        batch_id: batch_id,
+        record_ids: record_ids.map { |v| v.instance_of?(Integer) ? v : v.to_s }
+      )
+    end
+
+    def batches_key
+      "searchkick:reindex:#{index.name}:batches"
+    end
+  end
+end