mongoid 8.0.10 → 8.1.0

data/spec/mongoid/config/defaults_spec.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Mongoid::Config::Defaults do
+
+  let(:config) do
+    Mongoid::Config
+  end
+
+  describe ".load_defaults" do
+
+    shared_examples "uses settings for 7.3" do
+      it "uses settings for 7.3" do
+        expect(Mongoid.broken_aggregables).to be true
+        expect(Mongoid.broken_alias_handling).to be true
+        expect(Mongoid.broken_and).to be true
+        expect(Mongoid.broken_scoping).to be true
+        expect(Mongoid.broken_updates).to be true
+        expect(Mongoid.compare_time_by_ms).to be false
+        expect(Mongoid.legacy_pluck_distinct).to be true
+        expect(Mongoid.legacy_triple_equals).to be true
+        expect(Mongoid.object_id_as_json_oid).to be true
+      end
+    end
+
+    shared_examples "does not use settings for 7.3" do
+      it "does not use settings for 7.3" do
+        expect(Mongoid.broken_aggregables).to be false
+        expect(Mongoid.broken_alias_handling).to be false
+        expect(Mongoid.broken_and).to be false
+        expect(Mongoid.broken_scoping).to be false
+        expect(Mongoid.broken_updates).to be false
+        expect(Mongoid.compare_time_by_ms).to be true
+        expect(Mongoid.legacy_pluck_distinct).to be false
+        expect(Mongoid.legacy_triple_equals).to be false
+      end
+    end
+
+    shared_examples "uses settings for 7.4" do
+      it "uses settings for 7.4" do
+        expect(Mongoid.legacy_attributes).to be true
+        expect(Mongoid.overwrite_chained_operators).to be true
+      end
+    end
+
+    shared_examples "does not use settings for 7.4" do
+      it "does not use settings for 7.4" do
+        expect(Mongoid.legacy_attributes).to be false
+        expect(Mongoid.overwrite_chained_operators).to be false
+      end
+    end
+
+    shared_examples "uses settings for 7.5" do
+      it "uses settings for 7.5" do
+        expect(Mongoid.map_big_decimal_to_decimal128).to be false
+      end
+    end
+
+    shared_examples "does not use settings for 7.5" do
+      it "does not use settings for 7.5" do
+        expect(Mongoid.map_big_decimal_to_decimal128).to be true
+      end
+    end
+
+    shared_examples "uses settings for 8.0" do
+      it "uses settings for 8.0" do
+        expect(Mongoid.legacy_readonly).to be true
+      end
+    end
+
+    shared_examples "does not use settings for 8.0" do
+      it "does not use settings for 8.0" do
+        expect(Mongoid.legacy_readonly).to be false
+      end
+    end
+
+    shared_examples "uses settings for 8.1" do
+      it "uses settings for 8.1" do
+        expect(Mongoid.immutable_ids).to be false
+      end
+    end
+
+    context "when giving a valid version" do
+
+      before do
+        config.load_defaults(version)
+      end
+
+      after do
+        Mongoid::Config.reset
+      end
+
+      context "when the given version is 7.3" do
+
+        let(:version) { 7.3 }
+
+        it_behaves_like "uses settings for 7.3"
+        it_behaves_like "uses settings for 7.4"
+        it_behaves_like "uses settings for 7.5"
+        it_behaves_like "uses settings for 8.0"
+        it_behaves_like "uses settings for 8.1"
+      end
+
+      context "when the given version is 7.4" do
+
+        let(:version) { 7.4 }
+
+        it_behaves_like "does not use settings for 7.3"
+        it_behaves_like "uses settings for 7.4"
+        it_behaves_like "uses settings for 7.5"
+        it_behaves_like "uses settings for 8.0"
+        it_behaves_like "uses settings for 8.1"
+      end
+
+      context "when the given version is 7.5" do
+
+        let(:version) { 7.5 }
+
+        it_behaves_like "does not use settings for 7.3"
+        it_behaves_like "does not use settings for 7.4"
+        it_behaves_like "uses settings for 7.5"
+        it_behaves_like "uses settings for 8.0"
+        it_behaves_like "uses settings for 8.1"
+      end
+
+      context "when the given version is 8.0" do
+
+        let(:version) { 8.0 }
+
+        it_behaves_like "does not use settings for 7.3"
+        it_behaves_like "does not use settings for 7.4"
+        it_behaves_like "does not use settings for 7.5"
+        it_behaves_like "uses settings for 8.0"
+        it_behaves_like "uses settings for 8.1"
+      end
+
+      context "when the given version is 8.1" do
+
+        let(:version) { 8.1 }
+
+        it_behaves_like "does not use settings for 7.3"
+        it_behaves_like "does not use settings for 7.4"
+        it_behaves_like "does not use settings for 7.5"
+        it_behaves_like "does not use settings for 8.0"
+        it_behaves_like "uses settings for 8.1"
+      end
+    end
+
+    context "when given version an invalid version" do
+      let(:version) { 4.2 }
+
+      it "raises an error" do
+        expect do
+          config.load_defaults(version)
+        end.to raise_error(ArgumentError, /Unknown version: 4.2/)
+      end
+    end
+  end
+end

data/spec/mongoid/config_spec.rb

@@ -224,6 +224,79 @@ describe Mongoid::Config do
     end
   end
 
+  context 'async_query_executor option' do
+    let(:option) { :async_query_executor }
+
+    before do
+      Mongoid::Config.reset
+      Mongoid.configure do |config|
+        config.load_configuration(conf)
+      end
+    end
+
+    context "when it is not set in the config" do
+
+      let(:conf) { CONFIG }
+
+      it "it is set to its default" do
+        expect(Mongoid.send(option)).to eq(:immediate)
+      end
+    end
+
+    context 'when the value is :immediate' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => :immediate })
+      end
+
+      it "is set to false" do
+        expect(Mongoid.send(option)).to be(:immediate)
+      end
+    end
+
+    context 'when the value is :global_thread_pool' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => :global_thread_pool })
+      end
+
+      it "is set to false" do
+        expect(Mongoid.send(option)).to be(:global_thread_pool)
+      end
+    end
+  end
+
+  context 'global_executor_concurrency option' do
+    let(:option) { :global_executor_concurrency }
+
+    before do
+      Mongoid::Config.reset
+      Mongoid.configure do |config|
+        config.load_configuration(conf)
+      end
+    end
+
+    context "when it is not set in the config" do
+
+      let(:conf) { CONFIG }
+
+      it "it is set to its default" do
+        expect(Mongoid.send(option)).to eq(nil)
+      end
+    end
+
+    context 'when the value is set to a number' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => 5 })
+      end
+
+      it "is set to the number" do
+        expect(Mongoid.send(option)).to be(5)
+      end
+    end
+  end
+
   shared_examples "a config option" do
 
     before do
@@ -272,15 +345,6 @@ describe Mongoid::Config do
     it_behaves_like "a config option"
   end
 
-  context 'when setting the allow_bson5_decimal128 option in the config' do
-    min_bson_version '5.0'
-
-    let(:option) { :allow_bson5_decimal128 }
-    let(:default) { false }
-
-    it_behaves_like "a config option"
-  end
-
   context 'when setting the broken_updates option in the config' do
     let(:option) { :broken_updates }
     let(:default) { false }
@@ -358,6 +422,13 @@ describe Mongoid::Config do
     it_behaves_like "a config option"
   end
 
+  context 'when setting the legacy_readonly option in the config' do
+    let(:option) { :legacy_readonly }
+    let(:default) { true }
+
+    it_behaves_like "a config option"
+  end
+
   describe "#load!" do
 
     before(:all) do
@@ -608,24 +679,26 @@ describe Mongoid::Config do
 
       it 'passes uuid to driver' do
         Mongo::Client.should receive(:new).with(SpecConfig.instance.addresses,
-          { auto_encryption_options: {
-            'key_vault_namespace' => 'admin.datakeys',
-            'kms_providers' => {'local' => {'key' => 'z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U'}},
-            'schema_map' => {'blog_development.comments' => {
-              'bsonType' => 'object',
-              'properties' => {
-                'message' => {'encrypt' => {
-                  'algorithm' => 'AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic',
-                  'bsonType' => 'string',
-                  'keyId' => [BSON::Binary.new("G\xF0 5\xCC@HX\xA2%b\x97\xA9a\xA8\xE7", :uuid)],
-                }},
-              },
-            }}},
-          database: 'mongoid_test',
-          platform: "mongoid-#{Mongoid::VERSION}",
-          wrapping_libraries: [
-            {'name' => 'Mongoid', 'version' => Mongoid::VERSION},
-          ]},
+          {
+            auto_encryption_options: {
+              'key_vault_namespace' => 'admin.datakeys',
+              'kms_providers' => { 'local' => { 'key' => 'z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U' } },
+              'schema_map' => { 'blog_development.comments' => {
+                'bsonType' => 'object',
+                'properties' => {
+                  'message' => { 'encrypt' => {
+                    'algorithm' => 'AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic',
+                    'bsonType' => 'string',
+                    'keyId' => [BSON::Binary.new("G\xF0 5\xCC@HX\xA2%b\x97\xA9a\xA8\xE7", :uuid)],
+                  } },
+                },
+              } } },
+            database: 'mongoid_test',
+            platform: "mongoid-#{Mongoid::VERSION}",
+            wrapping_libraries: [
+              { 'name' => 'Mongoid', 'version' => Mongoid::VERSION },
+            ],
+          }
         )
 
         client
@@ -654,6 +727,17 @@ describe Mongoid::Config do
         }.to raise_error(Mongoid::Errors::InvalidConfigOption)
       end
     end
+
+    context 'when invalid global_executor_concurrency option provided' do
+      it "raises an error" do
+        expect do
+          described_class.options = {
+            async_query_executor: :immediate,
+            global_executor_concurrency: 5
+          }
+        end.to raise_error(Mongoid::Errors::InvalidGlobalExecutorConcurrency)
+      end
+    end
   end
 
   describe "#clients=" do
@@ -854,4 +938,47 @@ describe Mongoid::Config do
       end
     end
   end
+
+  describe 'deprecations' do
+    { use_activesupport_time_zone: true,
+      broken_aggregables: false,
+      broken_alias_handling: false,
+      broken_and: false,
+      broken_scoping: false,
+      broken_updates: false,
+      compare_time_by_ms: true,
+      legacy_attributes: false,
+      legacy_pluck_distinct: false,
+      legacy_triple_equals: false,
+      object_id_as_json_oid: false,
+      overwrite_chained_operators: false }.each do |option, default|
+
+      context ":#{option} option" do
+
+        before do
+          Mongoid::Warnings.class_eval do
+            instance_variable_set(:"@#{option}_deprecated", false)
+          end
+        end
+
+        let(:matcher) do
+          /Config option :#{option}.+\. It will always be #{default} beginning in Mongoid 9\.0\./
+        end
+
+        context 'when set to true' do
+          it 'gives a deprecation warning' do
+            expect(Mongoid.logger).to receive(:warn).with(matcher)
+            described_class.send(:"#{option}=", true)
+          end
+        end
+
+        context 'when set to false' do
+          it 'gives a deprecation warning' do
+            expect(Mongoid.logger).to receive(:warn).with(matcher)
+            described_class.send(:"#{option}=", false)
+          end
+        end
+      end
+    end
+  end
 end