es-elasticity 0.11.5 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b90fa843196b6ec0a4ed99f4605d089f1127696a
-  data.tar.gz: 16e810b1114f1829e21c8e655f2fd7ad40fa1022
+  metadata.gz: affbf27c1edb733d94a8e47e2081e15e4f6a1b24
+  data.tar.gz: 6cc26c4485266ea6fcac7210cc49204eeaf804bf
 SHA512:
-  metadata.gz: 9d54bd8d914de323f3ce7d430e7477eda5b74d4b1dbd3bb9127a2a5b460ec7facbbef5fcbc5e00fe2f9f3df674834cca6641724191acb5c2b81922874c6d32a6
-  data.tar.gz: cf91125f554221f3ea89364fc8aab76395cfa9f0376fd03369bcfb02bf6235cd7b35b668ea952d7669123883c3c93c83e20cdb8024087b887fe9d95f481865e7
+  metadata.gz: fe6dc007658a6364ccacc71305f1f72156c05206c20e48f77a70314e05485de84537eb8bd9f99ecfcbaf84b4fdad916a203ac5820b094eda46a7463c70df159b
+  data.tar.gz: cdf109a324e17b044808efa20865aad86f2873c62deef66b59d5577d4ba2b3c76f9a646e41643dfa8d15110545734ff2b6551ef739ecc74b2f150e0248039cb4

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.12.0
+  - warn when configuring a index with subclasses if using ES version that does support them
+  - raise exception when creating or adding document to an index configured with subclasses if using
+     an ES version that does not support them
 v0.11.5
  - Give the option of retrying the deletion for certain exceptions during remap
 v0.11.4

data/lib/elasticity/index_config.rb

@@ -1,5 +1,13 @@
 module Elasticity
   class IndexConfig
+    class SubclassError < StandardError; end
+
+    SUBCLASSES_WARNING = "Indices created in Elasticsearch 6.0.0 or later may only contain a single mapping type. " +
+      "Therefore, doument-type based inheritance has been disabled by Elasticity"
+    SUBCLASSES_ERROR = "Mapping types have been completely removed in Elasticsearch 7.0.0. " +
+      "Therefore, doument-type based inheritance has been disabled by Elasticity"
+    VERSION_FOR_SUBCLASS_WARNING = "6.0.0".freeze
+    VERSION_FOR_SUBCLASS_ERROR = "7.0.0".freeze
     ATTRS = [
       :index_base_name, :document_type, :mapping, :strategy, :subclasses,
       :settings
@@ -14,6 +22,7 @@ module Elasticity
       end
       @elasticity_config = elasticity_config
       yield(self)
+      subclasses_warning_or_exception
       validate!
     end
 
@@ -69,5 +78,15 @@ module Elasticity
     def merge_settings
       @elasticity_config.settings.merge(settings || {})
     end
+
+    def subclasses_warning_or_exception
+      return if subclasses.nil? || subclasses.empty?
+      raise(SubclassError.new(SUBCLASSES_ERROR)) if es_version_meets_or_exceeds?(VERSION_FOR_SUBCLASS_ERROR)
+      warn(SUBCLASSES_WARNING) if es_version_meets_or_exceeds?(VERSION_FOR_SUBCLASS_WARNING)
+    end
+
+    def es_version_meets_or_exceeds?(test_version)
+      client.versions.any?{ |v| v >= test_version }
+    end
   end
 end

data/lib/elasticity/instrumented_client.rb

@@ -7,6 +7,10 @@ module Elasticity
       @client = client
     end
 
+    def versions
+      (@client.cluster.stats["nodes"] && @client.cluster.stats["nodes"]["versions"]) || []
+    end
+
     # Generate wrapper methods for @client.indices
     INDICES_METHODS.each do |method_name|
       full_name = "index_#{method_name}"

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.11.5"
+  VERSION = "0.12.0"
 end

data/spec/units/index_config_spec.rb

@@ -1,7 +1,7 @@
 require 'elasticity/index_config'
 
 RSpec.describe Elasticity::IndexConfig do
-  let(:elasticity_config) { double }
+  let(:elasticity_config) { double("config", client: double("client", versions: ["5.3.4"])) }
   subject {  }
 
     let(:defaults) do
@@ -26,4 +26,72 @@ RSpec.describe Elasticity::IndexConfig do
     expect(config.index_base_name).to eql('user_documents')
     expect(config.document_type).to eql('users')
   end
+
+  context "subclass warnings and exceptions" do
+    class Multied < Elasticity::Document
+    end
+    describe "multi_mapping exceptions" do
+      it "raises an exception for version 7 and above if subclasses are configured" do
+        stub_version("7.0.0")
+        expect do
+          Multied.configure do |c|
+            c.index_base_name = "cats_and_dogs"
+            c.strategy = Elasticity::Strategies::SingleIndex
+            c.subclasses = { cat: "Cat", dog: "Dog" }
+          end
+        end.to raise_error(
+          Elasticity::IndexConfig::SubclassError,
+          Elasticity::IndexConfig::SUBCLASSES_ERROR
+        )
+      end
+
+      it "does not raise an exception for version 7 and above if no subclasses are configured" do
+        stub_version("7.0.0")
+        expect do
+          Multied.configure do |c|
+            c.index_base_name = "cats_and_dogs"
+            c.strategy = Elasticity::Strategies::SingleIndex
+          end
+        end.to_not raise_error
+      end
+    end
+
+    describe "multi_mapping warnings" do
+      it "warns if multi_mapping is not supported by the ES version" do
+        stub_version("6.0.2")
+        expect do
+          Multied.configure do |c|
+            c.index_base_name = "cats_and_dogs"
+            c.strategy = Elasticity::Strategies::SingleIndex
+            c.subclasses = { cat: "Cat", dog: "Dog" }
+          end
+        end.to output("#{Elasticity::IndexConfig::SUBCLASSES_WARNING}\n").to_stderr
+      end
+
+      it "does not warn if multi_mapping is supported by the ES version" do
+        stub_version("5.3.1")
+        expect do
+          Multied.configure do |c|
+            c.index_base_name = "cats_and_dogs"
+            c.strategy = Elasticity::Strategies::SingleIndex
+            c.subclasses = { cat: "Cat", dog: "Dog" }
+          end
+        end.to_not output.to_stderr
+      end
+
+      it "does not warn when no subclasses are configured" do
+        stub_version("6.0.2")
+        expect do
+          Multied.configure do |c|
+            c.index_base_name = "cats_and_dogs"
+            c.strategy = Elasticity::Strategies::SingleIndex
+          end
+        end.to_not output.to_stderr
+      end
+    end
+
+    def stub_version(version)
+      allow_any_instance_of(Elasticity::InstrumentedClient).to receive(:versions).and_return([version])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.12.0
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,6 +211,7 @@ files:
 - bin/rake
 - bin/rspec
 - elasticity.gemspec
+- es-elasticity-0.12.0.pre.rc1.gem
 - lib/elasticity.rb
 - lib/elasticity/base_document.rb
 - lib/elasticity/bulk.rb