searchkick 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c81923ad42ba7a15c923bf2b2320ed03894b6a14
-  data.tar.gz: 5655aa933464e320c0473b41b9b6a7d644c46dbb
+  metadata.gz: 9b2be48320f7dd756e116946199f07a52642b3e7
+  data.tar.gz: dc9c8e1fc6c82afa143f55556157786f95fb1aeb
 SHA512:
-  metadata.gz: fb8db1d17809462eb65aacb6662b9157637b68cc99ac417e2b570a3ff589a547b0bd72d66d50cb1b1b1e3a7d469d5787e653976916b9438ec887c44a3a975373
-  data.tar.gz: ce0f005d8c74c490007d39a9c65d07455a81ab8d2a5ca0377b9f93d3cf6b7d799f45ce6324ebc5bee3060dea1f6d75a8762105dd9e308289e2c130eb5f1400e8
+  metadata.gz: 8d88370f0e37d4da8c5c9bb57cdfda98b242b830cf156b099e7d69b5be338b0924b52a37b5a1c38a57cdd7e75b8984c00f83504bbda6870df4fe8e68cf75b295
+  data.tar.gz: 134b2bd7d3fd80cd5f2ff18288304edd543f0250e344303baf14bff18b1674e97468de3c5d7e93d99e5e531d2d2440658e51d75983295c43ed8a2fbd2a718aed

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.2
+
+- Added logging
+- Fixed index_name option
+- Added ability to use proc as the index name
+
 ## 0.6.1
 
 - Fixed huge issue w/ zero-downtime reindexing on 0.90 and elasticsearch-ruby 1.0

data/README.md

@@ -744,6 +744,10 @@ rake searchkick:reindex:all
 
 4. Once it finishes, replace search calls w/ searchkick calls
 
+## Note about 0.6.0
+
+If running Searchkick `0.6.0` and Elasticsearch `0.90`, we recommend upgrading to Searchkick `0.6.1` to fix an issue that causes downtime when reindexing.
+
 ## Elasticsearch Gotchas
 
 ### Inconsistent Scores

data/lib/searchkick.rb

@@ -11,8 +11,7 @@ require "searchkick/search"
 require "searchkick/similar"
 require "searchkick/model"
 require "searchkick/tasks"
-# TODO add logger
-# require "searchkick/logger" if defined?(Rails)
+require "searchkick/logging" if defined?(Rails)
 
 module Searchkick
 

data/lib/searchkick/index.rb

@@ -25,16 +25,16 @@ module Searchkick
     def store(record)
       client.index(
         index: name,
-        type: record.document_type,
+        type: document_type(record),
         id: record.id,
-        body: record.as_indexed_json
+        body: search_data(record)
       )
     end
 
     def remove(record)
       client.delete(
         index: name,
-        type: record.document_type,
+        type: document_type(record),
         id: record.id
       )
     end
@@ -43,25 +43,95 @@ module Searchkick
       if records.any?
         client.bulk(
           index: name,
-          type: records.first.document_type,
-          body: records.map{|r| data = r.as_indexed_json; {index: {_id: data["_id"] || data["id"] || r.id, data: data}} }
+          type: document_type(records.first),
+          body: records.map{|r| data = search_data(r); {index: {_id: data["_id"] || data["id"] || r.id, data: data}} }
         )
       end
     end
 
-    def retrieve(document_type, id)
+    def retrieve(record)
       client.get(
         index: name,
-        type: document_type,
-        id: id
+        type: document_type(record),
+        id: record.id
       )["_source"]
     end
 
+    def klass_document_type(klass)
+      klass.model_name.to_s.underscore
+    end
+
     protected
 
     def client
       Searchkick.client
     end
 
+    def document_type(record)
+      klass_document_type(record.class)
+    end
+
+    def search_data(record)
+      source = record.search_data
+
+      # stringify fields
+      source = source.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}
+
+      # Mongoid 4 hack
+      if defined?(BSON::ObjectId) and source["_id"].is_a?(BSON::ObjectId)
+        source["_id"] = source["_id"].to_s
+      end
+
+      options = record.class.searchkick_options
+
+      # conversions
+      conversions_field = options[:conversions]
+      if conversions_field and source[conversions_field]
+        source[conversions_field] = source[conversions_field].map{|k, v| {query: k, count: v} }
+      end
+
+      # hack to prevent generator field doesn't exist error
+      (options[:suggest] || []).map(&:to_s).each do |field|
+        source[field] = nil if !source[field]
+      end
+
+      # locations
+      (options[:locations] || []).map(&:to_s).each do |field|
+        if source[field]
+          if source[field].first.is_a?(Array) # array of arrays
+            source[field] = source[field].map{|a| a.map(&:to_f).reverse }
+          else
+            source[field] = source[field].map(&:to_f).reverse
+          end
+        end
+      end
+
+      cast_big_decimal(source)
+
+      # p search_data
+
+      source.as_json
+    end
+
+    # change all BigDecimal values to floats due to
+    # https://github.com/rails/rails/issues/6033
+    # possible loss of precision :/
+    def cast_big_decimal(obj)
+      case obj
+      when BigDecimal
+        obj.to_f
+      when Hash
+        obj.each do |k, v|
+          obj[k] = cast_big_decimal(v)
+        end
+      when Enumerable
+        obj.map do |v|
+          cast_big_decimal(v)
+        end
+      else
+        obj
+      end
+    end
+
   end
 end

data/lib/searchkick/logging.rb

@@ -0,0 +1,89 @@
+# based on https://gist.github.com/mnutt/566725
+
+module Searchkick
+  class Query
+    def execute_with_instrumentation
+      event = {
+        name: "#{searchkick_klass.name} Search",
+        query: params
+      }
+      ActiveSupport::Notifications.instrument("search.searchkick", event) do
+        execute_without_instrumentation
+      end
+    end
+
+    alias_method_chain :execute, :instrumentation
+  end
+
+  # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/log_subscriber.rb
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def self.runtime=(value)
+      Thread.current[:searchkick_runtime] = value
+    end
+
+    def self.runtime
+      Thread.current[:searchkick_runtime] ||= 0
+    end
+
+    def self.reset_runtime
+      rt, self.runtime = runtime, 0
+      rt
+    end
+
+    def search(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      payload = event.payload
+      name = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+      type = payload[:query][:type]
+
+      # no easy way to tell which host the client will use
+      host = Searchkick.client.transport.hosts.first
+      debug "  #{color(name, YELLOW, true)}  curl #{host[:protocol]}://#{host[:host]}:#{host[:port]}/#{CGI.escape(payload[:query][:index])}#{type ? "/#{type.map{|t| CGI.escape(t) }.join(",")}" : ""}/_search?pretty -d '#{payload[:query][:body].to_json}'"
+    end
+  end
+
+  # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/railties/controller_runtime.rb
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+    protected
+
+    attr_internal :searchkick_runtime
+
+    def process_action(action, *args)
+      # We also need to reset the runtime before each action
+      # because of queries in middleware or in cases we are streaming
+      # and it won't be cleaned up by the method below.
+      Searchkick::LogSubscriber.reset_runtime
+      super
+    end
+
+    def cleanup_view_runtime
+      searchkick_rt_before_render = Searchkick::LogSubscriber.reset_runtime
+      runtime = super
+      searchkick_rt_after_render = Searchkick::LogSubscriber.reset_runtime
+      self.searchkick_runtime = searchkick_rt_before_render + searchkick_rt_after_render
+      runtime - searchkick_rt_after_render
+    end
+
+    def append_info_to_payload(payload)
+      super
+      payload[:searchkick_runtime] = (searchkick_runtime || 0) + Searchkick::LogSubscriber.reset_runtime
+    end
+
+    module ClassMethods
+      def log_process_action(payload)
+        messages, runtime = super, payload[:searchkick_runtime]
+        messages << ("Searchkick: %.1fms" % runtime.to_f) if runtime.to_f > 0
+        messages
+      end
+    end
+  end
+end
+
+Searchkick::LogSubscriber.attach_to :searchkick
+ActiveSupport.on_load(:action_controller) do
+  include Searchkick::ControllerRuntime
+end

data/lib/searchkick/model.rb

@@ -3,17 +3,19 @@ module Searchkick
 
     def searchkick(options = {})
       class_eval do
-        cattr_reader :searchkick_options, :searchkick_env, :searchkick_klass, :searchkick_index
+        cattr_reader :searchkick_options, :searchkick_env, :searchkick_klass
 
         class_variable_set :@@searchkick_options, options.dup
         class_variable_set :@@searchkick_env, ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
         class_variable_set :@@searchkick_klass, self
         class_variable_set :@@searchkick_callbacks, options[:callbacks] != false
+        class_variable_set :@@searchkick_index, options[:index_name] || [options[:index_prefix], model_name.plural, searchkick_env].compact.join("_")
 
-        # set index name
-        # TODO support proc
-        index_name = options[:index_name] || [options[:index_prefix], model_name.plural, searchkick_env].compact.join("_")
-        class_variable_set :@@searchkick_index, Searchkick::Index.new(index_name)
+        def self.searchkick_index
+          index = class_variable_get :@@searchkick_index
+          index = index.call if index.respond_to? :call
+          Searchkick::Index.new(index)
+        end
 
         extend Searchkick::Search
         extend Searchkick::Reindex
@@ -59,79 +61,6 @@ module Searchkick
           respond_to?(:to_hash) ? to_hash : serializable_hash
         end
 
-        def as_indexed_json
-          source = search_data
-
-          # stringify fields
-          source = source.inject({}){|memo,(k,v)| memo[k.to_s] = v; memo}
-
-          # Mongoid 4 hack
-          if defined?(BSON::ObjectId) and source["_id"].is_a?(BSON::ObjectId)
-            source["_id"] = source["_id"].to_s
-          end
-
-          options = self.class.searchkick_options
-
-          # conversions
-          conversions_field = options[:conversions]
-          if conversions_field and source[conversions_field]
-            source[conversions_field] = source[conversions_field].map{|k, v| {query: k, count: v} }
-          end
-
-          # hack to prevent generator field doesn't exist error
-          (options[:suggest] || []).map(&:to_s).each do |field|
-            source[field] = nil if !source[field]
-          end
-
-          # locations
-          (options[:locations] || []).map(&:to_s).each do |field|
-            if source[field]
-              if source[field].first.is_a?(Array) # array of arrays
-                source[field] = source[field].map{|a| a.map(&:to_f).reverse }
-              else
-                source[field] = source[field].map(&:to_f).reverse
-              end
-            end
-          end
-
-          # change all BigDecimal values to floats due to
-          # https://github.com/rails/rails/issues/6033
-          # possible loss of precision :/
-          cast_big_decimal =
-            proc do |obj|
-              case obj
-              when BigDecimal
-                obj.to_f
-              when Hash
-                obj.each do |k, v|
-                  obj[k] = cast_big_decimal.call(v)
-                end
-              when Enumerable
-                obj.map! do |v|
-                  cast_big_decimal.call(v)
-                end
-              else
-                obj
-              end
-            end
-
-          cast_big_decimal.call(source)
-
-          # p search_data
-
-          source.as_json
-        end
-
-        # TODO remove
-
-        def self.document_type
-          model_name.to_s.underscore
-        end
-
-        def document_type
-          self.class.document_type
-        end
-
       end
     end
 

data/lib/searchkick/query.rb

@@ -39,7 +39,6 @@ module Searchkick
       page = [options[:page].to_i, 1].max
       per_page = (options[:limit] || options[:per_page] || 100000).to_i
       offset = options[:offset] || (page - 1) * per_page
-      index_name = options[:index_name] || searchkick_index.name
 
       conversions_field = searchkick_options[:conversions]
       personalize_field = searchkick_options[:personalize]
@@ -282,7 +281,7 @@ module Searchkick
       payload[:fields] = [] if load
 
       if options[:type] or klass != searchkick_klass
-        @type = [options[:type] || klass].flatten.map(&:document_type)
+        @type = [options[:type] || klass].flatten.map{|v| searchkick_index.klass_document_type(v) }
       end
 
       @body = payload
@@ -304,16 +303,16 @@ module Searchkick
       klass.searchkick_klass
     end
 
-    def document_type
-      klass.document_type
-    end
-
-    def execute
+    def params
       params = {
-        index: searchkick_index.name,
+        index: options[:index_name] || searchkick_index.name,
         body: body
       }
       params.merge!(type: @type) if @type
+      params
+    end
+
+    def execute
       begin
         response = Searchkick.client.search(params)
       rescue => e # TODO rescue type

data/lib/searchkick/similar.rb

@@ -2,7 +2,7 @@ module Searchkick
   module Similar
 
     def similar(options = {})
-      like_text = self.class.searchkick_index.retrieve(document_type, id).to_hash
+      like_text = self.class.searchkick_index.retrieve(self).to_hash
         .keep_if{|k,v| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
         .values.compact.join(" ")
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/test/inheritance_test.rb

@@ -10,7 +10,7 @@ class TestInheritance < Minitest::Unit::TestCase
   end
 
   def test_child_index_name
-    assert_equal "animals_test", Dog.searchkick_index.name
+    assert_equal "animals-#{Date.today.year}", Dog.searchkick_index.name
   end
 
   def test_child_search

data/test/test_helper.rb

@@ -143,7 +143,7 @@ class Store
 end
 
 class Animal
-  searchkick autocomplete: [:name], suggest: [:name]
+  searchkick autocomplete: [:name], suggest: [:name], index_name: -> { "#{self.name.tableize}-#{Date.today.year}" }
 end
 
 Product.searchkick_index.delete if Product.searchkick_index.exists?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -126,6 +126,7 @@ files:
 - gemfiles/mongoid4.gemfile
 - lib/searchkick.rb
 - lib/searchkick/index.rb
+- lib/searchkick/logging.rb
 - lib/searchkick/model.rb
 - lib/searchkick/query.rb
 - lib/searchkick/reindex.rb