caoutsearch 0.0.5 → 0.0.7

data/lib/caoutsearch/search/batch/search_after.rb

@@ -4,14 +4,24 @@ module Caoutsearch
   module Search
     module Batch
       module SearchAfter
-        def search_after(keep_alive: "1m", batch_size: 1000, &block)
-          pit_id = open_point_in_time(keep_alive: keep_alive)
+        def search_after(pit: nil, keep_alive: nil, batch_size: 1000, &block)
+          if pit
+            external_pit = true
+
+            warn(<<~MESSAGE) if keep_alive.nil?
+              A `pit` was passed to batch records without a `keep_alive` argument.
+              You may need it to extend the PIT on each request.
+            MESSAGE
+          end
+
+          keep_alive ||= "1m"
+          pit ||= open_point_in_time(keep_alive: keep_alive)
           search = per(batch_size).track_total_hits
 
           request_payload = {
             body: search.build.to_h.merge(
               pit: {
-                id: pit_id,
+                id: pit,
                 keep_alive: keep_alive
               }
             )
@@ -26,7 +36,7 @@ module Caoutsearch
           loop do
             requested_at = Time.current
 
-            results = instrument(:search_after, pit: pit_id) do |event_payload|
+            results = instrument(:search_after, pit: pit) do |event_payload|
               response = client.search(request_payload)
               last_response_time = Time.current
 
@@ -40,27 +50,37 @@ module Caoutsearch
 
               response
             rescue Elastic::Transport::Transport::Errors::NotFound => e
-              raise_enhance_message_when_pit_failed(e, keep_alive, requested_at, last_response_time)
+              if external_pit && progress.zero?
+                raise_enhance_message_on_missing_pit(e)
+              else
+                raise_enhance_message_on_pit_failure(e, keep_alive, requested_at, last_response_time)
+              end
             end
 
             hits = results["hits"]["hits"]
-            pit_id = results["pit_id"]
+            pit = results["pit_id"]
             break if hits.empty?
 
             yield hits
             break if progress >= total
 
             request_payload[:body].tap do |body|
-              body[:pit][:id] = pit_id
+              body[:pit][:id] = pit
               body[:search_after] = hits.last["sort"]
               body.delete(:track_total_hits)
             end
           end
         ensure
-          close_point_in_time(pit_id) if pit_id
+          close_point_in_time(pit) if pit && !external_pit
+        end
+
+        private
+
+        def raise_enhance_message_on_missing_pit(error)
+          raise error.exception "PIT was not found. #{error.message}"
         end
 
-        def raise_enhance_message_when_pit_failed(error, keep_alive, requested_at, last_response_time)
+        def raise_enhance_message_on_pit_failure(error, keep_alive, requested_at, last_response_time)
           elapsed = (requested_at - last_response_time).round(1).seconds
 
           raise error.exception("PIT registered for #{keep_alive}, #{elapsed.inspect} elapsed between. #{error.message}")

data/lib/caoutsearch/search/inspect.rb

@@ -5,7 +5,7 @@ module Caoutsearch
     module Inspect
       PROPERTIES_TO_INSPECT = %i[
         search_criteria
-        current_context
+        current_contexts
         current_order
         current_page
         current_limit

data/lib/caoutsearch/search/internal_dsl.rb

@@ -15,13 +15,13 @@ module Caoutsearch
         #   self.config[:filter][key] = ...
         #
         class_attribute :config, default: {
-          contexts: ActiveSupport::HashWithIndifferentAccess.new,
           filters: ActiveSupport::HashWithIndifferentAccess.new,
           defaults: ActiveSupport::HashWithIndifferentAccess.new,
           suggestions: ActiveSupport::HashWithIndifferentAccess.new,
           sorts: ActiveSupport::HashWithIndifferentAccess.new
         }
 
+        class_attribute :contexts, instance_accessor: false, default: {}
         class_attribute :aggregations, instance_accessor: false, default: {}
         class_attribute :transformations, instance_accessor: false, default: {}
       end
@@ -32,7 +32,7 @@ module Caoutsearch
           config[:match_all] = block
         end
 
-        %w[context default].each do |method|
+        %w[default].each do |method|
           config_attribute = method.pluralize.to_sym
 
           define_method method do |name = nil, &block|
@@ -68,6 +68,11 @@ module Caoutsearch
           sort(new_name) { |direction| sort_by(old_name, direction) }
         end
 
+        def has_context(name, &block)
+          self.contexts = contexts.dup
+          contexts[name.to_s] = Caoutsearch::Search::DSL::Item.new(name, &block)
+        end
+
         def has_aggregation(name, definition = {}, &block)
           raise ArgumentError, "has_aggregation accepts Hash definition or block but not both" if block && definition.any?
 

data/lib/caoutsearch/search/query_builder/contexts.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Caoutsearch
+  module Search
+    module QueryBuilder
+      module Contexts
+        private
+
+        def build_contexts
+          call_contexts(*current_contexts) if current_contexts
+        end
+
+        def call_contexts(*args)
+          args.each do |arg|
+            call_context(arg)
+          end
+        end
+
+        def call_context(name)
+          name = name.to_s
+
+          if self.class.contexts.include?(name)
+            item = self.class.contexts[name]
+            call_context_item(item)
+          end
+        end
+
+        def call_context_item(item)
+          instance_exec(&item.block)
+        end
+      end
+    end
+  end
+end

data/lib/caoutsearch/search/query_builder.rb

@@ -5,6 +5,7 @@ module Caoutsearch
     module QueryBuilder
       extend ActiveSupport::Concern
       include QueryBuilder::Aggregations
+      include QueryBuilder::Contexts
 
       def build
         reset_variable(:@elasticsearch_query)
@@ -13,7 +14,7 @@ module Caoutsearch
         run_callbacks :build do
           build_prepend_hash
           build_search_criteria
-          build_context
+          build_contexts
           build_defaults
           build_limits
           build_orders
@@ -35,13 +36,6 @@ module Caoutsearch
         search_by(search_criteria)
       end
 
-      def build_context
-        return unless current_context
-
-        item = config[:contexts][current_context.to_s]
-        instance_exec(&item.block) if item
-      end
-
       def build_defaults
         keys = search_criteria_keys.map(&:to_s)
 

data/lib/caoutsearch/search/search_methods.rb

@@ -5,7 +5,7 @@ module Caoutsearch
     module SearchMethods
       extend ActiveSupport::Concern
 
-      attr_reader :current_context, :current_order, :current_aggregations,
+      attr_reader :current_contexts, :current_order, :current_aggregations,
         :current_suggestions, :current_fields, :current_source
 
       # Public API
@@ -97,8 +97,9 @@ module Caoutsearch
         self
       end
 
-      def context!(value)
-        @current_context = value
+      def context!(*values)
+        @current_contexts ||= []
+        @current_contexts += values.flatten
         self
       end
 
@@ -173,7 +174,7 @@ module Caoutsearch
         "aggregations"    => :@current_aggregations,
         "suggest"         => :@current_suggestions,
         "suggestions"     => :@current_suggestions,
-        "context"         => :@current_context,
+        "context"         => :@current_contexts,
         "order"           => :@current_order,
         "page"            => :@current_page,
         "offset"          => :@current_offset,
@@ -189,7 +190,7 @@ module Caoutsearch
         self
       end
 
-      # Getters
+      # Getters and predicates
       # ------------------------------------------------------------------------
       def search_criteria
         @search_criteria ||= []
@@ -213,6 +214,10 @@ module Caoutsearch
         end
       end
 
+      def current_context?(name)
+        @current_contexts&.map(&:to_s)&.include?(name.to_s)
+      end
+
       # Criteria handlers
       # ------------------------------------------------------------------------
       def find_criterion(key)

data/lib/caoutsearch/testing/mock_requests.rb

@@ -7,26 +7,13 @@ module Caoutsearch
   module Testing
     module MockRequests
       def stub_elasticsearch_request(verb, pattern)
-        transport = Caoutsearch.client.transport
-        host = transport.__full_url(transport.hosts[0])
-
-        # Elasticsearch::Client is verify the connection
-        #
-        unless @subbed_verify
-          root_url = URI.join(host, "/").to_s
-          body = +MultiJson.dump({version: {number: "8.4.1"}})
-          @subbed_verify = stub_request(:get, root_url).to_return(
-            headers: {"Content-Type" => "application/json", "X-Elastic-Product" => "Elasticsearch"},
-            status: 200,
-            body: body
-          )
-        end
+        stub_elasticsearch_validation_request
 
         case pattern
         when String
-          pattern = URI.join(host, pattern).to_s
+          pattern = URI.join(elasticsearch_client_host, pattern).to_s
         when Regexp
-          pattern = URI.join(host, pattern.source).to_s
+          pattern = URI.join(elasticsearch_client_host, pattern.source).to_s
           pattern = Regexp.new(pattern)
         else
           raise TypeError, "wrong type received for URL pattern"
@@ -100,6 +87,45 @@ module Caoutsearch
 
         search_request
       end
+
+      private
+
+      def elasticsearch_client_host
+        @client_host ||= begin
+          transport = Caoutsearch.client.transport
+          transport.__full_url(transport.hosts[0])
+        end
+      end
+
+      # Elasticsearch::Client is verifying the connection to ES when calling
+      # the first request on the client.
+      #
+      # Prior to version 8.9, it sent a request to "/" before the first request
+      # and match the the "X-Elastic-Product" header and version returned.
+      #
+      # Since 8.9, it matches only the header on the first emitted request.
+      # Because we cannot we cannot edit all the responses headers configured
+      # after calling `stub_elasticsearch_request`, we better have to
+      # call the stubbed request to '/' before any request.
+      #
+      def stub_elasticsearch_validation_request
+        @stubbed_elasticsearch_validation_request ||= begin
+          root_url = URI.join(elasticsearch_client_host, "/").to_s
+          body = +MultiJson.dump({version: {number: Elasticsearch::VERSION}})
+
+          stubbed_request = stub_request(:get, root_url).to_return(
+            headers: {"Content-Type" => "application/json", "X-Elastic-Product" => "Elasticsearch"},
+            status: 200,
+            body: body
+          )
+
+          if Gem::Version.new(Elasticsearch::VERSION) >= Gem::Version.new("8.9.0")
+            Caoutsearch.client.perform_request("GET", "/")
+          end
+
+          stubbed_request
+        end
+      end
     end
   end
 end

data/lib/caoutsearch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caoutsearch
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caoutsearch
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Savater Sebastien
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,6 +81,216 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: github.60k5k@simplelogin.co
 executables: []
@@ -147,6 +357,7 @@ files:
 - lib/caoutsearch/search/query/setters.rb
 - lib/caoutsearch/search/query_builder.rb
 - lib/caoutsearch/search/query_builder/aggregations.rb
+- lib/caoutsearch/search/query_builder/contexts.rb
 - lib/caoutsearch/search/query_methods.rb
 - lib/caoutsearch/search/records.rb
 - lib/caoutsearch/search/resettable.rb
@@ -179,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: An alternative approach to index & search with Elasticsearch & Ruby on Rails