searchkick 5.5.2 → 6.0.0

data/lib/searchkick/relation_indexer.rb

@@ -6,7 +6,7 @@ module Searchkick
       @index = index
     end
 
-    def reindex(relation, mode:, method_name: nil, full: false, resume: false, scope: nil)
+    def reindex(relation, mode:, method_name: nil, ignore_missing: nil, full: false, resume: false, scope: nil, job_options: nil)
       # apply scopes
       if scope
         relation = relation.send(scope)
@@ -29,7 +29,7 @@ module Searchkick
       end
 
       if mode == :async && full
-        return full_reindex_async(relation)
+        return full_reindex_async(relation, job_options: job_options)
       end
 
       relation = resume_relation(relation) if resume
@@ -37,7 +37,9 @@ module Searchkick
       reindex_options = {
         mode: mode,
         method_name: method_name,
-        full: full
+        full: full,
+        ignore_missing: ignore_missing,
+        job_options: job_options
       }
       record_indexer = RecordIndexer.new(index)
 
@@ -128,23 +130,50 @@ module Searchkick
       @batch_size ||= index.options[:batch_size] || 1000
     end
 
-    def full_reindex_async(relation)
+    def full_reindex_async(relation, job_options: nil)
       batch_id = 1
       class_name = relation.searchkick_options[:class_name]
+      starting_id = false
 
-      in_batches(relation) do |items|
-        batch_job(class_name, batch_id, items.map(&:id))
-        batch_id += 1
+      if relation.respond_to?(:primary_key)
+        primary_key = relation.primary_key
+
+        starting_id =
+          begin
+            relation.minimum(primary_key)
+          rescue ActiveRecord::StatementInvalid
+            false
+          end
+      end
+
+      if starting_id.nil?
+        # no records, do nothing
+      elsif starting_id.is_a?(Numeric)
+        max_id = relation.maximum(primary_key)
+        batches_count = ((max_id - starting_id + 1) / batch_size.to_f).ceil
+
+        batches_count.times do |i|
+          min_id = starting_id + (i * batch_size)
+          batch_job(class_name, batch_id, job_options, min_id: min_id, max_id: min_id + batch_size - 1)
+          batch_id += 1
+        end
+      else
+        in_batches(relation) do |items|
+          batch_job(class_name, batch_id, job_options, record_ids: items.map(&:id).map { |v| v.instance_of?(Integer) ? v : v.to_s })
+          batch_id += 1
+        end
       end
     end
 
-    def batch_job(class_name, batch_id, record_ids)
+    def batch_job(class_name, batch_id, job_options, **options)
+      job_options ||= {}
+      # TODO expire Redis key
       Searchkick.with_redis { |r| r.call("SADD", batches_key, [batch_id]) }
-      Searchkick::BulkReindexJob.perform_later(
+      Searchkick::BulkReindexJob.set(**job_options).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 }
+        **options
       )
     end
 

data/lib/searchkick/results.rb

@@ -3,8 +3,7 @@ module Searchkick
     include Enumerable
     extend Forwardable
 
-    # TODO remove klass and options in 6.0
-    attr_reader :klass, :response, :options
+    attr_reader :response
 
     def_delegators :results, :each, :any?, :empty?, :size, :length, :slice, :[], :to_ary
 
@@ -14,11 +13,6 @@ module Searchkick
       @options = options
     end
 
-    # TODO make private in 6.0
-    def results
-      @results ||= with_hit.map(&:first)
-    end
-
     def with_hit
       return enum_for(:with_hit) unless block_given?
 
@@ -34,7 +28,7 @@ module Searchkick
     def suggestions
       if response["suggest"]
         response["suggest"].values.flat_map { |v| v.first["options"] }.sort_by { |o| -o["score"] }.map { |o| o["text"] }.uniq
-      elsif options[:suggest] || options[:term] == "*" # TODO remove 2nd term
+      elsif options[:suggest]
         []
       else
         raise "Pass `suggest: true` to the search method for suggestions"
@@ -193,7 +187,12 @@ module Searchkick
       else
         begin
           # TODO Active Support notifications for this scroll call
-          Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
+          params = {
+            scroll: options[:scroll],
+            body: {scroll_id: scroll_id}
+          }
+          params[:opaque_id] = options[:opaque_id] if options[:opaque_id]
+          Results.new(@klass, Searchkick.client.scroll(params), @options)
         rescue => e
           if Searchkick.not_found_error?(e) && e.message =~ /search_context_missing_exception/i
             raise Error, "Scroll id has expired"
@@ -217,6 +216,12 @@ module Searchkick
 
     private
 
+    attr_reader :klass, :options
+
+    def results
+      @results ||= with_hit.map(&:first)
+    end
+
     def with_hit_and_missing_records
       @with_hit_and_missing_records ||= begin
         missing_records = []

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "5.5.2"
+  VERSION = "6.0.0"
 end

data/lib/searchkick.rb

@@ -3,8 +3,9 @@ require "active_support"
 require "active_support/core_ext/hash/deep_merge"
 require "active_support/core_ext/module/attr_internal"
 require "active_support/core_ext/module/delegation"
+require "active_support/deprecation"
+require "active_support/log_subscriber"
 require "active_support/notifications"
-require "hashie"
 
 # stdlib
 require "forwardable"
@@ -49,7 +50,7 @@ module Searchkick
   class MissingIndexError < Error; end
   class UnsupportedVersionError < Error
     def message
-      "This version of Searchkick requires Elasticsearch 7+ or OpenSearch 1+"
+      "This version of Searchkick requires Elasticsearch 8+ or OpenSearch 2+"
     end
   end
   class InvalidQueryError < Error; end
@@ -57,7 +58,7 @@ module Searchkick
   class ImportError < Error; end
 
   class << self
-    attr_accessor :search_method_name, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name, :model_options, :client_type
+    attr_accessor :search_method_name, :timeout, :models, :client_options, :redis, :index_prefix, :index_suffix, :queue_name, :model_options, :client_type, :parent_job
     attr_writer :client, :env, :search_timeout
     attr_reader :aws_credentials
   end
@@ -67,6 +68,7 @@ module Searchkick
   self.client_options = {}
   self.queue_name = :searchkick
   self.model_options = {}
+  self.parent_job = "ActiveJob::Base"
 
   def self.client
     @client ||= begin
@@ -83,34 +85,21 @@ module Searchkick
           raise Error, "No client found - install the `elasticsearch` or `opensearch-ruby` gem"
         end
 
-      # check after client to ensure faraday is installed
-      # TODO remove in Searchkick 6
-      if defined?(Typhoeus) && Gem::Version.new(Faraday::VERSION) < Gem::Version.new("0.14.0")
-        require "typhoeus/adapters/faraday"
-      end
-
       if client_type == :opensearch
         OpenSearch::Client.new({
           url: ENV["OPENSEARCH_URL"],
-          # TODO remove headers in Searchkick 6
-          transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
+          transport_options: {request: {timeout: timeout}},
           retry_on_failure: 2
         }.deep_merge(client_options)) do |f|
           f.use Searchkick::Middleware
           f.request :aws_sigv4, signer_middleware_aws_params if aws_credentials
         end
       else
-        raise Error, "The `elasticsearch` gem must be 7+" if Elasticsearch::VERSION.to_i < 7
-
-        transport_options = {request: {timeout: timeout}}
-        # TODO remove headers in Searchkick 6
-        if Elasticsearch::VERSION.to_i < 9
-          transport_options[:headers] = {content_type: "application/json"}
-        end
+        raise Error, "The `elasticsearch` gem must be 8+" if Elasticsearch::VERSION.to_i < 8
 
         Elasticsearch::Client.new({
           url: ENV["ELASTICSEARCH_URL"],
-          transport_options: transport_options,
+          transport_options: {request: {timeout: timeout}},
           retry_on_failure: 2
         }.deep_merge(client_options)) do |f|
           f.use Searchkick::Middleware
@@ -144,16 +133,14 @@ module Searchkick
     @opensearch
   end
 
-  # TODO always check true version in Searchkick 6
-  def self.server_below?(version, true_version = false)
-    server_version = !true_version && opensearch? ? "7.10.2" : self.server_version
+  def self.server_below?(version)
     Gem::Version.new(server_version.split("-")[0]) < Gem::Version.new(version.split("-")[0])
   end
 
   # private
   def self.knn_support?
     if opensearch?
-      !server_below?("2.4.0", true)
+      !server_below?("2.4.0")
     else
       !server_below?("8.6.0")
     end
@@ -184,17 +171,11 @@ module Searchkick
       end
     end
 
-    # TODO remove in Searchkick 6
-    if options[:execute] == false
-      Searchkick.warn("The execute option is no longer needed")
-      options.delete(:execute)
-    end
-
     options = options.merge(block: block) if block
     Relation.new(klass, term, **options)
   end
 
-  def self.multi_search(queries)
+  def self.multi_search(queries, opaque_id: nil)
     return if queries.empty?
 
     queries = queries.map { |q| q.send(:query) }
@@ -203,7 +184,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
-      MultiSearch.new(queries).perform
+      MultiSearch.new(queries, opaque_id: opaque_id).perform
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 5.5.2
+  version: 6.0.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -15,28 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.2'
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -91,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Intelligent search made easy with Rails and Elasticsearch or OpenSearch
 test_files: []