searchkick 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c83a41bfb177e764c6a5862ce0c4a2c44982986c
-  data.tar.gz: 1978b3e1fe918e5654c1b3835aa327abd76931b3
+  metadata.gz: 01f20120d276745b8434ffaa0529c328f8870080
+  data.tar.gz: 18756878052ac0bd566d025e7f87569992f903aa
 SHA512:
-  metadata.gz: f8bcea422ad62e709ff1639973d2cb9f729fef6d1103de9e9f0fa7fdbfe1099c0291544aa01256e5ddff44593b05bc4241fa4f377da5289082e19fbfa1c5fa02
-  data.tar.gz: bb797236441c2119490b05a8f4ee62afe98d69be313feec80e86a58256a2a4eb5c6d680ec7f78c84e0309f6e7b465c9c097e66d92fa9bb9889c83847483a1802
+  metadata.gz: 51e077ad2d600a823fea927c02a9c76299423a923286bf483ac9d0caffd32632de2592b9116fb5e34bd7558216e171d8ce8cff78a43bf2900a394830580cbf6c
+  data.tar.gz: 106cca0902d1a59b1de01380b6da09972c626075520e54a29e879740b90ff0ecf42f69d8fe16467308ed8c013526b51295a9e1e848ac1e0cec945aa524b309c0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.1.2
+
+- Added bulk updates with `callbacks` method
+- Added `bulk_delete` method
+- Added `search_timeout` option
+- Fixed bug with new location format for `boost_by_distance`
+
 ## 1.1.1
 
 - Added support for `{lat: lat, lon: lon}` as preferred format for locations

data/README.md

@@ -406,6 +406,22 @@ There are three strategies for keeping the index synced with your database.
   end
   ```
 
+You can also do bulk updates.
+
+```ruby
+Searchkick.callbacks(:bulk) do
+  User.find_each(&:update_fields)
+end
+```
+
+Or temporarily skip updates.
+
+```ruby
+Searchkick.callbacks(false) do
+  User.find_each(&:update_fields)
+end
+```
+
 #### Associations
 
 Data is **not** automatically synced when an association is updated.  If this is desired, add a callback to reindex:
@@ -1129,19 +1145,16 @@ class Product < ActiveRecord::Base
 end
 ```
 
-Turn off callbacks temporarily
+Change timeout
 
 ```ruby
-Product.disable_search_callbacks # or use Searchkick.disable_callbacks for all models
-ExpensiveProductsTask.execute
-Product.enable_search_callbacks # or use Searchkick.enable_callbacks for all models
-Product.reindex
+Searchkick.timeout = 15 # defaults to 10
 ```
 
-Change timeout
+Set a lower timeout for searches
 
 ```ruby
-Searchkick.timeout = 5 # defaults to 10
+Searchkick.search_timeout = 3
 ```
 
 Change the search method name in `config/initializers/searchkick.rb`

data/lib/searchkick.rb

@@ -8,6 +8,7 @@ require "searchkick/query"
 require "searchkick/reindex_job"
 require "searchkick/model"
 require "searchkick/tasks"
+require "searchkick/middleware"
 require "searchkick/logging" if defined?(Rails)
 
 # background jobs
@@ -27,11 +28,8 @@ module Searchkick
   class ImportError < Error; end
 
   class << self
-    attr_accessor :search_method_name
-    attr_accessor :wordnet_path
-    attr_accessor :timeout
-    attr_accessor :models
-    attr_writer :env
+    attr_accessor :search_method_name, :wordnet_path, :timeout, :models
+    attr_writer :client, :env, :search_timeout
   end
   self.search_method_name = :search
   self.wordnet_path = "/var/lib/wn_s.pl"
@@ -43,11 +41,17 @@ module Searchkick
       Elasticsearch::Client.new(
         url: ENV["ELASTICSEARCH_URL"],
         transport_options: {request: {timeout: timeout}}
-      )
+      ) do |f|
+        f.use Searchkick::Middleware
+      end
   end
 
-  class << self
-    attr_writer :client
+  def self.env
+    @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+  end
+
+  def self.search_timeout
+    @search_timeout || timeout
   end
 
   def self.server_version
@@ -55,19 +59,74 @@ module Searchkick
   end
 
   def self.enable_callbacks
-    Thread.current[:searchkick_callbacks_enabled] = true
+    self.callbacks_value = nil
   end
 
   def self.disable_callbacks
-    Thread.current[:searchkick_callbacks_enabled] = false
+    self.callbacks_value = false
   end
 
   def self.callbacks?
     Thread.current[:searchkick_callbacks_enabled].nil? || Thread.current[:searchkick_callbacks_enabled]
   end
 
-  def self.env
-    @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+  def self.callbacks(value)
+    if block_given?
+      previous_value = callbacks_value
+      begin
+        self.callbacks_value = value
+        yield
+        perform_bulk if callbacks_value == :bulk
+      ensure
+        self.callbacks_value = previous_value
+      end
+    else
+      self.callbacks_value = value
+    end
+  end
+
+  # private
+  def self.queue_items(items)
+    queued_items.concat(items)
+    perform_bulk unless callbacks_value == :bulk
+  end
+
+  # private
+  def self.perform_bulk
+    items = queued_items
+    clear_queued_items
+    perform_items(items)
+  end
+
+  # private
+  def self.perform_items(items)
+    if items.any?
+      response = client.bulk(body: items)
+      if response["errors"]
+        first_item = response["items"].first
+        raise Searchkick::ImportError, (first_item["index"] || first_item["delete"])["error"]
+      end
+    end
+  end
+
+  # private
+  def self.queued_items
+    Thread.current[:searchkick_queued_items] ||= []
+  end
+
+  # private
+  def self.clear_queued_items
+    Thread.current[:searchkick_queued_items] = []
+  end
+
+  # private
+  def self.callbacks_value
+    Thread.current[:searchkick_callbacks_enabled]
+  end
+
+  # private
+  def self.callbacks_value=(value)
+    Thread.current[:searchkick_callbacks_enabled] = value
   end
 end
 

data/lib/searchkick/index.rb

@@ -45,38 +45,21 @@ module Searchkick
     # record based
 
     def store(record)
-      client.index(
-        index: name,
-        type: document_type(record),
-        id: search_id(record),
-        body: search_data(record)
-      )
+      bulk_index([record])
     end
 
     def remove(record)
-      id = search_id(record)
-      unless id.blank?
-        client.delete(
-          index: name,
-          type: document_type(record),
-          id: id
-        )
-      end
+      bulk_delete([record])
     end
 
-    def import(records)
-      records.group_by { |r| document_type(r) }.each do |type, batch|
-        response =
-          client.bulk(
-            index: name,
-            type: type,
-            body: batch.map { |r| {index: {_id: search_id(r), data: search_data(r)}} }
-          )
-        if response["errors"]
-          raise Searchkick::ImportError, response["items"].first["index"]["error"]
-        end
-      end
+    def bulk_delete(records)
+      Searchkick.queue_items(records.reject { |r| r.id.blank? }.map { |r| {delete: {_index: name, _type: document_type(r), _id: search_id(r)}} })
+    end
+
+    def bulk_index(records)
+      Searchkick.queue_items(records.map { |r| {index: {_index: name, _type: document_type(r), _id: search_id(r), data: search_data(r)}} })
     end
+    alias_method :import, :bulk_index
 
     def retrieve(record)
       client.get(
@@ -99,10 +82,14 @@ module Searchkick
     end
 
     def reindex_record_async(record)
-      if defined?(Searchkick::ReindexV2Job)
-        Searchkick::ReindexV2Job.perform_later(record.class.name, record.id.to_s)
+      if Searchkick.callbacks_value.nil?
+        if defined?(Searchkick::ReindexV2Job)
+          Searchkick::ReindexV2Job.perform_later(record.class.name, record.id.to_s)
+        else
+          Delayed::Job.enqueue Searchkick::ReindexJob.new(record.class.name, record.id.to_s)
+        end
       else
-        Delayed::Job.enqueue Searchkick::ReindexJob.new(record.class.name, record.id.to_s)
+        reindex_record(record)
       end
     end
 

data/lib/searchkick/middleware.rb

@@ -0,0 +1,12 @@
+require "faraday/middleware"
+
+module Searchkick
+  class Middleware < Faraday::Middleware
+    def call(env)
+      if env.method == :get && env.url.path.to_s.end_with?("/_search")
+        env.request.timeout = Searchkick.search_timeout
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/searchkick/model.rb

@@ -70,14 +70,12 @@ module Searchkick
         end
         extend Searchkick::Reindex # legacy for Searchjoy
 
-        if callbacks
-          callback_name = callbacks == :async ? :reindex_async : :reindex
-          if respond_to?(:after_commit)
-            after_commit callback_name, if: proc { self.class.search_callbacks? }
-          else
-            after_save callback_name, if: proc { self.class.search_callbacks? }
-            after_destroy callback_name, if: proc { self.class.search_callbacks? }
-          end
+        callback_name = callbacks == :async ? :reindex_async : :reindex
+        if respond_to?(:after_commit)
+          after_commit callback_name, if: proc { self.class.search_callbacks? }
+        else
+          after_save callback_name, if: proc { self.class.search_callbacks? }
+          after_destroy callback_name, if: proc { self.class.search_callbacks? }
         end
 
         def reindex

data/lib/searchkick/query.rb

@@ -335,7 +335,7 @@ module Searchkick
             raise ArgumentError, "boost_by_distance requires :field and :origin"
           end
           function_params = boost_by_distance.select { |k, _| [:origin, :scale, :offset, :decay].include?(k) }
-          function_params[:origin] = function_params[:origin].reverse
+          function_params[:origin] = location_value(function_params[:origin])
           custom_filters << {
             boost_by_distance[:function] => {
               boost_by_distance[:field] => function_params

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/test/boost_test.rb

@@ -132,4 +132,13 @@ class BoostTest < Minitest::Test
     ]
     assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: [37, -122], scale: "1000mi"}
   end
+
+  def test_boost_by_distance_hash
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
+      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
+    ]
+    assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}, scale: "1000mi"}
+  end
 end

data/test/callbacks_test.rb

@@ -0,0 +1,27 @@
+require_relative "test_helper"
+
+class CallbacksTest < Minitest::Test
+  def test_true_create
+    Searchkick.callbacks(true) do
+      store_names ["Product A", "Product B"]
+    end
+    Product.searchkick_index.refresh
+    assert_search "product", ["Product A", "Product B"]
+  end
+
+  def test_false_create
+    Searchkick.callbacks(false) do
+      store_names ["Product A", "Product B"]
+    end
+    Product.searchkick_index.refresh
+    assert_search "product", []
+  end
+
+  def test_bulk_create
+    Searchkick.callbacks(:bulk) do
+      store_names ["Product A", "Product B"]
+    end
+    Product.searchkick_index.refresh
+    assert_search "product", ["Product A", "Product B"]
+  end
+end

data/test/test_helper.rb

@@ -11,6 +11,7 @@ Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
 
 File.delete("elasticsearch.log") if File.exist?("elasticsearch.log")
 Searchkick.client.transport.logger = Logger.new("elasticsearch.log")
+Searchkick.search_timeout = 5
 
 puts "Running against Elasticsearch #{Searchkick.server_version}"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -111,6 +111,7 @@ files:
 - lib/searchkick.rb
 - lib/searchkick/index.rb
 - lib/searchkick/logging.rb
+- lib/searchkick/middleware.rb
 - lib/searchkick/model.rb
 - lib/searchkick/query.rb
 - lib/searchkick/reindex_job.rb
@@ -122,6 +123,7 @@ files:
 - test/aggs_test.rb
 - test/autocomplete_test.rb
 - test/boost_test.rb
+- test/callbacks_test.rb
 - test/ci/before_install.sh
 - test/dangerous_reindex_test.rb
 - test/facets_test.rb
@@ -184,6 +186,7 @@ test_files:
 - test/aggs_test.rb
 - test/autocomplete_test.rb
 - test/boost_test.rb
+- test/callbacks_test.rb
 - test/ci/before_install.sh
 - test/dangerous_reindex_test.rb
 - test/facets_test.rb