search_flip 4.0.0.beta5 → 4.0.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938e1745f8cfe0173c76f26a4f15ab7e62781fd627dcccb2c2523db7f8ca51bf
-  data.tar.gz: 2a8980bc0de4db9cb081c5186ed94bbee489a470ea30992a9e8a9c248563d3e6
+  metadata.gz: 1850108a3752d6b01de4e2c23453220ac0cf8cd1e4dd61339faeba1c66856960
+  data.tar.gz: 71b704481fa26e973929c19c9c7df25685b83b65e5ef470ed032531e7fb3fec6
 SHA512:
-  metadata.gz: 2d622f6d843b9975a66af4ee3d937f1eb60b255d6c5017479dae583543d8f4dbba9608209513da94ba95a3aa3323714a0c1a9b21e594f1f4a2be61844864da3c
-  data.tar.gz: b7835e3adfd35074111e481e3ba54272e59a764a5478c569bc516aa4a8455c939618347a194802a9d6030a91bc52430bf7fac72b00c3ebca1eb09cb13021f21a
+  metadata.gz: 0d57dc4c3aa5c7ffd9f287bf0ed2b097eb21671a32721fea1daad735c647f8d9d8d01e78c00e9c63d222d587be19246f8cbed85c2fbbc54b2f3a32bcc447b545
+  data.tar.gz: fc2b76b6f04b94a3843d3f0f8d10a131bc88ea576de7576879d9f6a5d490b2cb0e84b8ff8fee87107b1cf5f7c4a3c8ff84ade40bcadbdb4811bbf0f05088b69c

data/.github/workflows/test.yml

@@ -13,9 +13,9 @@ jobs:
         - docker.elastic.co/elasticsearch/elasticsearch:7.0.0
         - docker.elastic.co/elasticsearch/elasticsearch:7.11.2
         ruby:
-        - 2.5
         - 2.6
         - 2.7
+        - 3.0
     services:
       elasticsearch:
         image: ${{ matrix.elasticsearch }}

data/CHANGELOG.md

@@ -11,6 +11,21 @@
 * Added `SearchFlip::Connection#get_cluster_settings` and
   `#update_cluster_settings`
 
+## v3.5.0
+
+* Add `SearchFlip::Criteria#http_timeout` to allow specifying timeouts on
+  a query level
+
+## v3.4.0
+
+* Expose `Http#timeout` via `SearchFlip::HTTPClient`
+
+## v3.3.0
+
+* Update httprb
+* Changed oj default options
+* Allow to set oj json options
+
 ## v3.2.1
 
 * Fix `refresh` having a empty body breaking in elasticsearch 7.11

data/README.md

@@ -51,7 +51,7 @@ CommentIndex.search("hello world").where(available: true).sort(id: "desc").aggre
 
 ```
 
-Finally, SearchFlip comes with a minimal set of dependencies (http-rb and oj only).
+Finally, SearchFlip comes with a minimal set of dependencies.
 
 ## Reference Docs
 
@@ -698,6 +698,14 @@ Specify a timeout to limit query processing time:
 CommentIndex.timeout("3s").execute
 ```
 
+* `http_timeout`
+
+Specify a http timeout for the request which will be send to Elasticsearch:
+
+```ruby
+CommentIndex.http_timeout(3).execute
+```
+
 * `terminate_after`
 
 Activate early query termination to stop query processing after the specified
@@ -756,7 +764,7 @@ end
 This allows to use different clusters per index e.g. when migrating indices to
 new versions of Elasticsearch.
 
-You can specify basic auth, additional headers, etc via:
+You can specify basic auth, additional headers, request timeouts, etc via:
 
 ```ruby
 http_client = SearchFlip::HTTPClient.new
@@ -773,6 +781,9 @@ http_client = http_client.via("proxy.host", 8080)
 # Custom headers
 http_client = http_client.headers(key: "value")
 
+# Timeouts
+http_client = http_client.timeout(20)
+
 SearchFlip::Connection.new(base_url: "...", http_client: http_client)
 ```
 
@@ -882,6 +893,47 @@ Thus, if your ORM supports `.find_each`, `#id` and `#where` you are already
 good to go. Otherwise, simply add your custom implementation of those methods
 that work with whatever ORM you use.
 
+## JSON
+
+SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
+JSON. More concretely, SearchFlip is using:
+
+```ruby
+Oj.dump({ key: "value" }, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+```
+
+The `use_to_json` option is used for maximum compatibility, most importantly
+when using rails `ActiveSupport::TimeWithZone` timestamps, which `oj` can not
+serialize natively. However, `use_to_json` adds performance overhead. You can
+change the json options via:
+
+```ruby
+SearchFlip::Config[:json_options] = {
+  mode: :custom,
+  use_to_json: false,
+  time_format: :xmlschema,
+  bigdecimal_as_decimal: false
+}
+```
+
+However, you then have to convert timestamps manually for indexation via e.g.:
+
+```ruby
+class MyIndex
+  # ...
+
+  def self.serialize(model)
+    {
+      # ...
+
+      created_at: model.created_at.to_time
+    }
+  end
+end
+```
+
+Please check out the oj docs for more details.
+
 ## Feature Support
 
 * for Elasticsearch 2.x, the delete-by-query plugin is required to delete

data/lib/search_flip.rb

@@ -2,6 +2,7 @@ require "ruby2_keywords"
 require "forwardable"
 require "http"
 require "thread"
+require "json"
 require "oj"
 require "set"
 
@@ -31,10 +32,15 @@ require "search_flip/index"
 require "search_flip/model"
 
 module SearchFlip
-  class NotSupportedError < StandardError; end
-  class ConnectionError < StandardError; end
+  class Error < StandardError; end
 
-  class ResponseError < StandardError
+  class NotSupportedError < Error; end
+
+  class HttpError < Error; end
+  class ConnectionError < HttpError; end
+  class TimeoutError < HttpError; end
+
+  class ResponseError < Error
     attr_reader :code, :body
 
     def initialize(code:, body:)

data/lib/search_flip/config.rb

@@ -5,6 +5,12 @@ module SearchFlip
     bulk_limit: 1_000,
     bulk_max_mb: 100,
     auto_refresh: false,
-    instrumenter: NullInstrumenter.new
+    instrumenter: NullInstrumenter.new,
+    json_options: {
+      mode: :custom,
+      use_to_json: true,
+      time_format: :xmlschema,
+      bigdecimal_as_decimal: false
+    }
   }
 end

data/lib/search_flip/criteria.rb

@@ -26,7 +26,8 @@ module SearchFlip
 
     attr_accessor :target, :profile_value, :source_value, :suggest_values, :includes_values,
       :eager_load_values, :preload_values, :failsafe_value, :scroll_args, :terminate_after_value,
-      :timeout_value, :preference_value, :search_type_value, :routing_value, :track_total_hits_value
+      :timeout_value, :preference_value, :search_type_value, :routing_value, :track_total_hits_value,
+      :http_timeout_value
 
     # Creates a new criteria while merging the attributes (constraints,
     # settings, etc) of the current criteria with the attributes of another one
@@ -47,7 +48,7 @@ module SearchFlip
         [
           :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value,
           :limit_value, :scroll_args, :source_value, :preference_value, :search_type_value,
-          :routing_value, :track_total_hits_value, :explain_value
+          :routing_value, :track_total_hits_value, :explain_value, :http_timeout_value
         ].each do |name|
           criteria.send(:"#{name}=", other.send(name)) unless other.send(name).nil?
         end
@@ -148,6 +149,22 @@ module SearchFlip
       end
     end
 
+    # Specifies a http timeout, such that a SearchFlip::TimeoutError will be
+    # thrown when the request times out.
+    #
+    # @example
+    #   ProductIndex.http_timeout(3).search("hello world")
+    #
+    # @param value [Fixnum] The timeout value
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def http_timeout(value)
+      fresh.tap do |criteria|
+        criteria.http_timeout_value = value
+      end
+    end
+
     # Specifies early query termination, such that the processing will be
     # stopped after the specified number of results has been accumulated.
     #
@@ -330,10 +347,13 @@ module SearchFlip
       dupped_request.delete(:from)
       dupped_request.delete(:size)
 
+      http_request = connection.http_client
+      http_request = http_request.timeout(http_timeout_value) if http_timeout_value
+
       if connection.version.to_i >= 5
-        connection.http_client.post("#{target.type_url}/_delete_by_query", params: request_params.merge(params), json: dupped_request)
+        http_request.post("#{target.type_url}/_delete_by_query", params: request_params.merge(params), json: dupped_request)
       else
-        connection.http_client.delete("#{target.type_url}/_query", params: request_params.merge(params), json: dupped_request)
+        http_request.delete("#{target.type_url}/_query", params: request_params.merge(params), json: dupped_request)
       end
 
       target.refresh if SearchFlip::Config[:auto_refresh]
@@ -501,8 +521,8 @@ module SearchFlip
     end
 
     # Executes the search request for the current criteria, ie sends the
-    # request to Elasticsearch and returns the response. Connection and
-    # response errors will be rescued if you specify the criteria to be
+    # request to Elasticsearch and returns the response. Connection, timeout
+    # and response errors will be rescued if you specify the criteria to be
     # #failsafe, such that an empty response is returned instead.
     #
     # @example
@@ -590,6 +610,7 @@ module SearchFlip
 
     def execute!
       http_request = connection.http_client.headers(accept: "application/json")
+      http_request = http_request.timeout(http_timeout_value) if http_timeout_value
 
       http_response =
         if scroll_args && scroll_args[:id]
@@ -609,7 +630,7 @@ module SearchFlip
         end
 
       SearchFlip::Response.new(self, SearchFlip::JSON.parse(http_response.to_s))
-    rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
+    rescue SearchFlip::ConnectionError, SearchFlip::TimeoutError, SearchFlip::ResponseError => e
       raise e unless failsafe_value
 
       SearchFlip::Response.new(self, "took" => 0, "hits" => { "total" => 0, "hits" => [] })

data/lib/search_flip/http_client.rb

@@ -1,7 +1,28 @@
 module SearchFlip
-  # The SearchFlip::HTTPClient class wraps the http gem, is for internal use
-  # and responsible for the http request/response handling, ie communicating
-  # with Elasticsearch.
+  # The SearchFlip::HTTPClient class wraps the http gem and responsible for the
+  # http request/response handling, ie communicating with Elasticsearch. You
+  # only need to use it directly if you need authentication to communicate with
+  # Elasticsearch or if you want to set some custom http settings.
+  #
+  # @example
+  #   http_client = SearchFlip::HTTPClient.new
+  #
+  #   # Basic Auth
+  #   http_client = http_client.basic_auth(user: "username", pass: "password")
+  #
+  #   # Raw Auth Header
+  #   http_client = http_client.auth("Bearer VGhlIEhUVFAgR2VtLCBST0NLUw")
+  #
+  #   # Proxy Settings
+  #   http_client = http_client.via("proxy.host", 8080)
+  #
+  #   # Custom headers
+  #   http_client = http_client.headers(key: "value")
+  #
+  #   # Timeouts
+  #   http_client = http_client.timeout(20)
+  #
+  #   SearchFlip::Connection.new(base_url: "...", http_client: http_client)
 
   class HTTPClient
     attr_accessor :request, :plugins
@@ -14,11 +35,11 @@ module SearchFlip
     class << self
       extend Forwardable
 
-      def_delegators :new, :headers, :via, :basic_auth, :auth
+      def_delegators :new, :headers, :via, :basic_auth, :auth, :timeout
       def_delegators :new, :get, :post, :put, :delete, :head
     end
 
-    [:headers, :via, :basic_auth, :auth].each do |method|
+    [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
       define_method method do |*args|
         dup.tap do |client|
           client.request = request.send(method, *args)
@@ -45,6 +66,10 @@ module SearchFlip
       response
     rescue HTTP::ConnectionError => e
       raise SearchFlip::ConnectionError, e.message
+    rescue HTTP::TimeoutError => e
+      raise SearchFlip::TimeoutError, e.message
+    rescue HTTP::Error => e
+      raise SearchFlip::HttpError, e.message
     end
   end
 end

data/lib/search_flip/index.rb

@@ -254,7 +254,7 @@ module SearchFlip
         :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_results_in_batches,
         :find_each, :find_each_result, :failsafe, :total_entries, :total_count, :timeout, :terminate_after,
         :records, :results, :must, :must_not, :should, :preference, :search_type, :routing,
-        :track_total_hits, :explain
+        :track_total_hits, :explain, :http_timeout
 
       # Override to specify the type name used within Elasticsearch. Recap,
       # this gem uses an individual index for each index class, because

data/lib/search_flip/json.rb

@@ -1,22 +1,11 @@
 module SearchFlip
   class JSON
-    @default_options = {
-      mode: :custom,
-      use_to_json: true,
-      time_format: :xmlschema,
-      bigdecimal_as_decimal: false
-    }
-
-    def self.default_options
-      @default_options
-    end
-
     def self.generate(obj)
-      Oj.dump(obj, default_options)
+      Oj.dump(obj, SearchFlip::Config[:json_options])
     end
 
     def self.parse(json)
-      Oj.load(json, default_options)
+      ::JSON.parse(json)
     end
   end
 end

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "4.0.0.beta5"
+  VERSION = "4.0.0.beta9"
 end

data/search_flip.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "http"
+  spec.add_dependency "json"
   spec.add_dependency "oj"
   spec.add_dependency "ruby2_keywords"
 end

data/spec/search_flip/criteria_spec.rb

@@ -97,7 +97,8 @@ RSpec.describe SearchFlip::Criteria do
       methods = [
         :profile_value, :failsafe_value, :terminate_after_value, :timeout_value,
         :offset_value, :limit_value, :scroll_args, :source_value, :preference_value,
-        :search_type_value, :routing_value, :track_total_hits_value, :explain_value
+        :search_type_value, :routing_value, :track_total_hits_value, :explain_value,
+        :http_timeout_value
       ]
 
       methods.each do |method|
@@ -191,6 +192,22 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#http_timeout" do
+    it "sets the query timeout" do
+      http_client = double("client").as_null_object
+      allow(http_client).to receive(:timeout).and_return(http_client)
+      allow(http_client).to receive(:post).and_raise(SearchFlip::TimeoutError)
+      allow(ProductIndex.connection).to receive(:http_client).and_return(http_client)
+
+      expect { ProductIndex.http_timeout(1).execute }.to raise_error(SearchFlip::TimeoutError)
+      expect(http_client).to have_received(:timeout).with(1)
+    end
+
+    it "executes without errors" do
+      expect { ProductIndex.http_timeout(1).execute }.not_to raise_error
+    end
+  end
+
   describe "#terminate_after" do
     it "sets the terminate after value" do
       query = ProductIndex.terminate_after(1)
@@ -1204,13 +1221,19 @@ RSpec.describe SearchFlip::Criteria do
   end
 
   describe "#failsafe" do
-    it "prevents query syntax exceptions" do
-      expect { ProductIndex.search("syntax/error").records }.to raise_error(SearchFlip::ResponseError)
+    [SearchFlip::ConnectionError, SearchFlip::TimeoutError, SearchFlip::ResponseError.new(code: "code", body: "body")].each do |error|
+      it "prevents #{error}" do
+        http_client = double("client").as_null_object
+        allow(http_client).to receive(:post).and_raise(error)
+        allow(ProductIndex.connection).to receive(:http_client).and_return(http_client)
+
+        expect { ProductIndex.all.execute }.to raise_error(error)
 
-      query = ProductIndex.failsafe(true).search("syntax/error")
+        query = ProductIndex.failsafe(true)
 
-      expect(query.records).to eq([])
-      expect(query.total_entries).to eq(0)
+        expect(query.records).to eq([])
+        expect(query.total_entries).to eq(0)
+      end
     end
   end
 

data/spec/search_flip/http_client_spec.rb

@@ -7,7 +7,7 @@ class HttpTestRequest
     self.calls = []
   end
 
-  [:via, :basic_auth, :auth].each do |method|
+  [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
     define_method method do |*args|
       dup.tap do |request|
         request.calls = calls + [[method, args]]
@@ -20,7 +20,7 @@ RSpec.describe SearchFlip::HTTPClient do
   describe "delegation" do
     subject { SearchFlip::HTTPClient }
 
-    [:headers, :via, :basic_auth, :auth].each do |method|
+    [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
       it { should delegate(method).to(:new) }
     end
 
@@ -56,8 +56,12 @@ RSpec.describe SearchFlip::HTTPClient do
     end
   end
 
-  [:via, :basic_auth, :auth].each do |method|
+  [:headers, :via, :basic_auth, :auth, :timeout].each do |method|
     describe "##{method}" do
+      it "is understood by HTTP" do
+        expect(HTTP.respond_to?(method)).to eq(true)
+      end
+
       it "creates a dupped instance" do
         client = SearchFlip::HTTPClient.new
         client.request = HttpTestRequest.new

data/spec/search_flip/index_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe SearchFlip::Index do
       :total_entries, :total_count, :terminate_after, :timeout, :records, :results,
       :must, :must_not, :should, :find_each_result,
       :find_results_in_batches, :preference, :search_type, :routing,
-      :track_total_hits, :explain
+      :track_total_hits, :explain, :http_timeout
     ]
 
     methods.each do |method|

data/spec/search_flip/json_spec.rb

@@ -32,14 +32,14 @@ RSpec.describe SearchFlip::JSON do
       expect(described_class.parse('{"key":"value"}')).to eq("key" => "value")
     end
 
-    it "delegates to Oj" do
-      allow(Oj).to receive(:load)
+    it "delegates to JSON" do
+      allow(JSON).to receive(:parse)
 
       payload = '{"key":"value"}'
 
       described_class.parse(payload)
 
-      expect(Oj).to have_received(:load).with(payload, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+      expect(JSON).to have_received(:parse).with(payload)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta5
+  version: 4.0.0.beta9
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement