169395632 v7 2 changes

.circleci/config.yml

@@ -0,0 +1,82 @@
+version: 2
+
+workflows:
+  version: 2
+  main:
+    jobs:
+      - build_2_4
+      - build_2_5
+      - build_2_6
+jobs:
+  build_2_4:
+    resource_class: small
+    docker:
+      - image: ruby:2.4
+      - image: elastic/elasticsearch:6.8.2
+        environment:
+          - xpack.security.enabled=false
+    steps:
+      - restore_cache:
+          keys:
+            - gem-cache-2_4-v2-{{ checksum "Gemfile.lock" }}
+            - gem-cache-2_4-v2-
+      - checkout
+      - run:
+          name: Install Ruby Dependencies
+          command: bundle install
+      - run:
+          name: Run Tests
+          command: bundle exec rspec
+      - save_cache:
+          key: gem-cache-2_4-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+            - ./vendor/cache
+  build_2_5:
+    resource_class: small
+    docker:
+      - image: ruby:2.5
+      - image: elastic/elasticsearch:6.8.2
+        environment:
+          - xpack.security.enabled=false
+    steps:
+      - restore_cache:
+          keys:
+            - gem-cache-2_5-v2-{{ checksum "Gemfile.lock" }}
+            - gem-cache-2_5-v2-
+      - checkout
+      - run:
+          name: Install Ruby Dependencies
+          command: bundle install
+      - run:
+          name: Run Tests
+          command: bundle exec rspec
+      - save_cache:
+          key: gem-cache-2_5-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+            - ./vendor/cache
+  build_2_6:
+    resource_class: small
+    docker:
+      - image: ruby:2.5
+      - image: elastic/elasticsearch:6.8.2
+        environment:
+          - xpack.security.enabled=false
+    steps:
+      - restore_cache:
+          keys:
+            - gem-cache-2_6-v2-{{ checksum "Gemfile.lock" }}
+            - gem-cache-2_6-v2-
+      - checkout
+      - run:
+          name: Install Ruby Dependencies
+          command: bundle install
+      - run:
+          name: Run Tests
+          command: bundle exec rspec
+      - save_cache:
+          key: gem-cache-2_6-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+            - ./vendor/cache

CHANGELOG

@@ -1,3 +1,10 @@
+v0.13.0
+  - changes needed for use with Elasticsearch v7
+  - handle the v7 "total" as an object rather than a scalar
+  - use timestamp with no colons
+  - update elasticsearch gem version for consistency with target ES version
+  - expose refresh_index to force write (because in v7, flush no longer forces writes)
+  - allow for optional 'include_type_name_on_create' arg so that the :include_type_name can be passed
 v0.12.1
   - use Arel.sql to avoid unsafe sql and eliminate deprecation warnings when used in Rails projects
 v0.12.0

Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticity.gemspec
 gemspec
 
-gem "elasticsearch", "5.0.4"
+gem "elasticsearch", "7.2.0"

README.md

@@ -31,7 +31,7 @@ Or install it yourself as:
 ### Version Support
 This gem has [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) as a dependency.  In order to use different versions of elasticsearch you will need to match your version of elasticsearch-ruby to the version of elasticsearch you want to use ([see here](https://github.com/elastic/elasticsearch-ruby#compatibility).  Elasticity should work across all versions of elastisearch-ruby, although they have not all been tested so there are likely edge cases.
 
-Currently tests are run on travis ci against elasticsearch 5.1.1 with elasticsearch-ruby 5.0.3.
+Currently tests are run on CirlceCI against elasticsearch 6.8.2 with elasticsearch-ruby 7.2.0.
 
 ### Configuration
 

elasticity.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "redis"
+  spec.add_development_dependency "timecop"
 
   spec.add_dependency "activesupport", ">= 4.0.0", "< 6"
   spec.add_dependency "activemodel",   ">= 4.0.0", "< 6"

lib/elasticity/index_config.rb

@@ -10,7 +10,7 @@ class SubclassError < StandardError; end
     VERSION_FOR_SUBCLASS_ERROR = "7.0.0".freeze
     ATTRS = [
       :index_base_name, :document_type, :mapping, :strategy, :subclasses,
-      :settings
+      :settings, :use_new_timestamp_format, :include_type_name_on_create
     ].freeze
     VALIDATABLE_ATTRS = [:index_base_name, :document_type, :strategy].freeze
 
@@ -39,7 +39,8 @@ def client
     def definition
       return @definition if defined?(@definition)
       @definition = {
-        settings: merge_settings, mappings: { @document_type => @mapping.nil? ? {} : @mapping.deep_stringify_keys }
+        settings: merge_settings,
+        mappings: { @document_type => @mapping.nil? ? {} : @mapping.deep_stringify_keys }
       }
       subclasses.each do |doc_type, subclass|
         @definition[:mappings][doc_type] = subclass.constantize.mapping

lib/elasticity/index_mapper.rb

@@ -11,6 +11,7 @@ def self.set_delegates(obj, to)
         :index_exists?,
         :remap!,
         :flush_index,
+        :refresh_index,
         :index_document,
         :search,
         :get,
@@ -27,7 +28,7 @@ def self.set_delegates(obj, to)
     def initialize(document_klass, index_config)
       @document_klass = document_klass
       @index_config   = index_config
-      @strategy       = @index_config.strategy.new(@index_config.client, @index_config.fq_index_base_name, @index_config.document_type)
+      @strategy       = @index_config.strategy.new(@index_config.client, @index_config.fq_index_base_name, @index_config.document_type, @index_config.use_new_timestamp_format, @index_config.include_type_name_on_create)
     end
 
     delegate(
@@ -71,10 +72,16 @@ def remap!(retry_delete_on_recoverable_errors: true, retry_delay: 30, max_delay:
     end
 
     # Flushes the index, forcing any writes
+    # note that v7 no longer forces any writes on flush
     def flush_index
       @strategy.flush
     end
 
+    # Resfreshes the index, forcing any writes
+    def refresh_index
+      @strategy.refresh
+    end
+
     # Index the given document
     def index_document(id, document_hash)
       @strategy.index_document(document_type, id, document_hash)

lib/elasticity/instrumented_client.rb

@@ -1,6 +1,6 @@
 module Elasticity
   class InstrumentedClient
-    INDICES_METHODS = %w(exists create delete get_settings get_mapping flush get_alias get_aliases put_alias delete_alias exists_alias update_aliases)
+    INDICES_METHODS = %w(exists create delete get_settings get_mapping flush refresh get_alias get_aliases put_alias delete_alias exists_alias update_aliases)
     INDEX_METHODS   = %w(index delete get mget search count msearch scroll delete_by_query bulk)
 
     def initialize(client)

lib/elasticity/search.rb

@@ -87,7 +87,7 @@ def active_records(relation)
     class LazySearch
       include Enumerable
 
-      delegate :each, :size, :length, :[], :+, :-, :&, :|, :total, :per_page,
+      delegate :each, :size, :length, :[], :+, :-, :&, :|, :total, :per_page, :to_ary,
         :total_pages, :current_page, :next_page, :previous_page, :aggregations, to: :search_results
 
       attr_accessor :search_definition
@@ -147,7 +147,12 @@ def blank?
       end
 
       def total
-        search["hits"]["total"]
+        res = search["hits"]["total"]
+        if res.is_a?(::Hash)
+          res["value"]
+        else
+          res
+        end
       end
 
       def each_batch
@@ -237,7 +242,12 @@ def metadata
       end
 
       def total
-        metadata[:total]
+        res = metadata[:total]
+        if res.is_a?(::Hash)
+          res["value"]
+        else
+          res
+        end
       end
 
       def suggestions
@@ -311,7 +321,12 @@ def aggregations
       end
 
       def total
-        @response["hits"]["total"]
+        res = @response["hits"]["total"]
+        if res.is_a?(::Hash)
+          res["value"]
+        else
+          res
+        end
       end
       alias_method :total_entries, :total
 

lib/elasticity/strategies/alias_index.rb

@@ -11,11 +11,15 @@ class AliasIndex
 
       STATUSES = [:missing, :ok]
 
-      def initialize(client, index_base_name, document_type)
+      def initialize(client, index_base_name, document_type, use_new_timestamp_format = false, include_type_name_on_create = true)
         @client       = client
         @main_alias   = index_base_name
         @update_alias = "#{index_base_name}_update"
         @document_type = document_type
+
+        # included for compatibility with v7
+        @use_new_timestamp_format = use_new_timestamp_format
+        @include_type_name_on_create = include_type_name_on_create
       end
 
       def ref_index_name
@@ -186,11 +190,12 @@ def update_indexes
 
       def create(index_def)
         if missing?
-          index_name = create_index(index_def)
+          name = create_index(index_def)
+          @created_index_name = name
           @client.index_update_aliases(body: {
             actions: [
-              { add: { index: index_name, alias: @main_alias } },
-              { add: { index: index_name, alias: @update_alias } },
+              { add: { index: name, alias: @main_alias } },
+              { add: { index: name, alias: @update_alias } },
             ]
           })
         else
@@ -257,6 +262,10 @@ def flush
         @client.index_flush(index: @update_alias)
       end
 
+      def refresh
+        @client.index_refresh(index: @update_alias)
+      end
+
       def settings
         @client.index_get_settings(index: @main_alias, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
@@ -279,11 +288,20 @@ def mapping
 
       private
 
+      def build_index_name
+        ts = String.new
+        if @use_new_timestamp_format == true
+          ts = Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+        else
+          ts = Time.now.utc.strftime("%Y-%m-%d_%H:%M:%S.%6N")
+        end
+        "#{@main_alias}-#{ts}"
+      end
+
       def create_index(index_def)
-        ts = Time.now.utc.strftime("%Y-%m-%d_%H:%M:%S.%6N")
-        index_name = "#{@main_alias}-#{ts}"
-        @client.index_create(index: index_name, body: index_def)
-        index_name
+        name = build_index_name
+        @client.index_create(index: name, body: index_def, include_type_name: @include_type_name_on_create)
+        name
       end
 
       def retryable_error?(e)

lib/elasticity/strategies/single_index.rb

@@ -3,10 +3,16 @@ module Strategies
     class SingleIndex
       STATUSES = [:missing, :ok]
 
-      def initialize(client, index_name, document_type)
+      def initialize(client, index_name, document_type, use_new_timestamp_format = false, include_type_name_on_create = true)
         @client        = client
         @index_name    = index_name
         @document_type = document_type
+
+        # included for compatibility with v7
+        @include_type_name_on_create = include_type_name_on_create
+
+        # not currently used. included for argument compatiblity with AliasStrategy
+        @use_new_timestamp_format = use_new_timestamp_format
       end
 
       def ref_index_name
@@ -23,7 +29,7 @@ def missing?
 
       def create(index_def)
         if missing?
-          @client.index_create(index: @index_name, body: index_def)
+          @client.index_create(index: @index_name, body: index_def, include_type_name: @include_type_name_on_create)
         else
           raise IndexError.new(@index_name, "index already exist")
         end
@@ -101,6 +107,10 @@ def mapping
       def flush
         @client.index_flush(index: @index_name)
       end
+
+      def refresh
+        @client.index_refresh(index: @index_name)
+      end
     end
   end
 end

lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.12.1"
+  VERSION = "0.13.0"
 end