mongoid 7.3.4 → 7.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bbeda0aba58b991964f1d6c687a8120cdeac497c9fbeef7b376386470519b6d
-  data.tar.gz: 4d3d62eef06a3d4502e5b846a6d38905f8bdca608598a1fb3e04945d364589d8
+  metadata.gz: efce0ba93d948e87b85aa1a6e1a0768ecb2bd17a052d5e34afb426c357391492
+  data.tar.gz: 39784e3b229e457971b79962c26e22f3f1e721c68d72268bdafafa821c245c80
 SHA512:
-  metadata.gz: f8e5502f46048cd2f726aad05b44de638e6c3af5d3de59c33625fa0c5de6b4f8099155e643273afe17f2678239c52f2ffd3412587a6c23067ce1804eb2849c89
-  data.tar.gz: c84fd0380200bcb1c13fb49e3baa6c095670657fdcf6cfbd60f422448327faf37bdc43f9ac5334fcf96a883ed70bb9be9c42430b06f357a98e393ef2cec77efc
+  metadata.gz: f690e5ca59dfdf1e658ac922c5e8c0e0de1bef099f005205cab26b4e27922ce82b64dae38e803673b32e73f9327746562548c3f9667a4d3fd275483729e6ff3d
+  data.tar.gz: b87aef76b5145507b5e48f8516f4b27b99f401d7afb2fa56441d1d47540eac6f3f7bf198fadfd995e9fc08b0563727b6a5c4f7ce5014456e0dd4a6d345cdf3bb

data/lib/mongoid/association/embedded/batchable.rb

@@ -82,7 +82,8 @@ module Mongoid
         def batch_replace(docs)
           if docs.blank?
             if _assigning? && !empty?
-              _base.delayed_atomic_sets.clear
+              _base.delayed_atomic_sets.delete(path)
+              clear_atomic_path_cache
               _base.add_atomic_unset(first)
               target_duplicate = _target.dup
               pre_process_batch_remove(target_duplicate, :delete)
@@ -94,7 +95,8 @@ module Mongoid
             _base.delayed_atomic_sets.clear unless _assigning?
             docs = normalize_docs(docs).compact
             _target.clear and _unscoped.clear
-            _base.delayed_atomic_unsets.clear
+            _base.delayed_atomic_unsets.delete(path)
+            clear_atomic_path_cache
             inserts = execute_batch_set(docs)
             add_atomic_sets(inserts)
           end
@@ -252,7 +254,22 @@ module Mongoid
         #
         # @since 3.0.0
         def path
-          @path ||= _unscoped.first.atomic_path
+          @path ||= if _unscoped.empty?
+            Mongoid::Atomic::Paths::Embedded::Many.position_without_document(_base, _association)
+          else
+            _unscoped.first.atomic_path
+          end
+        end
+
+        # Clear the cache for path and atomic_paths. This method is used when
+        # the path method is used, and the association has not been set on the
+        # document yet, which can cause path and atomic_paths to be calculated
+        # incorrectly later.
+        #
+        # @api private
+        def clear_atomic_path_cache
+          self.path = nil
+          _base.instance_variable_set("@atomic_paths", nil)
         end
 
         # Set the atomic path.

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -506,8 +506,8 @@ module Mongoid
             selector = conditions || {}
             removed = klass.send(method, selector.merge!(criteria.selector))
             _target.delete_if do |doc|
-              if doc._matches?(selector)
-                unbind_one(doc) and true
+              doc._matches?(selector).tap do |b|
+                unbind_one(doc) if b
               end
             end
             removed

data/lib/mongoid/atomic/paths/embedded/many.rb

@@ -39,6 +39,25 @@ module Mongoid
             locator = document.new_record? ? "" : ".#{document._index}"
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
           end
+
+          class << self
+
+            # Get the position of where the document would go for the given
+            # association. The use case for this function is when trying to
+            # persist an empty list for an embedded association. All of the
+            # existing functions for getting the position to store a document
+            # require passing in a document to store, which we don't have when
+            # trying to store the empty list.
+            #
+            # @param [ Document ] parent The parent document to store in.
+            # @param [ Association ] association The association.
+            #
+            # @return [ String ] The position string.
+            def position_without_document(parent, association)
+              pos = parent.atomic_position
+              "#{pos}#{"." unless pos.blank?}#{association.store_as}"
+            end
+          end
         end
       end
     end

data/lib/mongoid/criteria/queryable/storable.rb

@@ -55,7 +55,7 @@ module Mongoid
               # adding them to the existing hash.
               new_value = selector[field].merge(value)
               selector.store(field, new_value)
-            else
+            elsif selector[field] != value
               add_operator_expression('$and', [{field => value}])
             end
           else

data/lib/mongoid/persistable/upsertable.rb

@@ -23,7 +23,7 @@ module Mongoid
       # @since 3.0.0
       def upsert(options = {})
         prepare_upsert(options) do
-          collection.find(atomic_selector).update_one(
+          collection.find(atomic_selector).replace_one(
               as_attributes, upsert: true, session: _session)
         end
       end

data/lib/mongoid/version.rb

@@ -2,5 +2,5 @@
 # encoding: utf-8
 
 module Mongoid
-  VERSION = "7.3.4"
+  VERSION = "7.3.5"
 end

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -80,8 +80,13 @@ development:
         # (default: 10)
         # connect_timeout: 10
 
-        # The timeout to wait to execute operations on a socket before raising an error.
-        # (default: 5)
+        # How long to wait for a response for each operation sent to the
+        # server. This timeout should be set to a value larger than the
+        # processing time for the longest operation that will be executed
+        # by the application. Note that this is a client-side timeout;
+        # the server may continue executing an operation after the client
+        # aborts it with the SocketTimeout exception.
+        # (default: nil, meaning no timeout)
         # socket_timeout: 5
 
         # The name of the replica set to connect to. Servers provided as seeds that do

data/spec/lite_spec_helper.rb

@@ -19,7 +19,14 @@ autoload :Timecop, 'timecop'
 
 require 'support/spec_config'
 require 'mrss/lite_constraints'
-require "support/session_registry"
+
+if Gem::Version.new(Mongo::VERSION) < Gem::Version.new('2.18.0.alpha')
+  require "mrss/session_registry_legacy"
+else
+  require "mrss/session_registry"
+end
+
+Mrss.patch_mongo_for_session_registry
 
 unless SpecConfig.instance.ci?
   begin

data/spec/mongoid/association/embedded/embeds_many/proxy_spec.rb

@@ -2,6 +2,7 @@
 # encoding: utf-8
 
 require "spec_helper"
+require_relative '../embeds_many_models.rb'
 
 describe Mongoid::Association::Embedded::EmbedsMany::Proxy do
 
@@ -4400,4 +4401,24 @@ describe Mongoid::Association::Embedded::EmbedsMany::Proxy do
       end
     end
   end
+
+  context "when using assign_attributes with an already populated array" do
+    let(:post) { EmmPost.create! }
+
+    before do
+      post.assign_attributes(company_tags: [{id: BSON::ObjectId.new, title: 'a'}],
+        user_tags: [{id: BSON::ObjectId.new, title: 'b'}])
+      post.save!
+      post.reload
+      post.assign_attributes(company_tags: [{id: BSON::ObjectId.new, title: 'c'}],
+        user_tags: [])
+      post.save!
+      post.reload
+    end
+
+    it "has the correct embedded documents" do
+      expect(post.company_tags.length).to eq(1)
+      expect(post.company_tags.first.title).to eq("c")
+    end
+  end
 end

data/spec/mongoid/association/embedded/embeds_many_models.rb

@@ -52,3 +52,140 @@ class EmmProduct
 
   field :name, type: String
 end
+
+class EmmInner
+  include Mongoid::Document
+
+  embeds_many :friends, :class_name => self.name, :cyclic => true
+  embedded_in :parent, :class_name => self.name, :cyclic => true
+
+  field :level, :type => Integer
+end
+
+class EmmOuter
+  include Mongoid::Document
+  embeds_many :inners, class_name: 'EmmInner'
+
+  field :level, :type => Integer
+end
+
+class EmmCustomerAddress
+  include Mongoid::Document
+
+  embedded_in :addressable, polymorphic: true, inverse_of: :work_address
+end
+
+class EmmFriend
+  include Mongoid::Document
+
+  embedded_in :befriendable, polymorphic: true
+end
+
+class EmmCustomer
+  include Mongoid::Document
+
+  embeds_one :home_address, class_name: 'EmmCustomerAddress', as: :addressable
+  embeds_one :work_address, class_name: 'EmmCustomerAddress', as: :addressable
+
+  embeds_many :close_friends, class_name: 'EmmFriend', as: :befriendable
+  embeds_many :acquaintances, class_name: 'EmmFriend', as: :befriendable
+end
+
+class EmmUser
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  embeds_many :orders, class_name: 'EmmOrder'
+end
+
+class EmmOrder
+  include Mongoid::Document
+
+  field :amount, type: Integer
+
+  embedded_in :user, class_name: 'EmmUser'
+end
+
+module EmmSpec
+  # There is also a top-level Car class defined.
+  class Car
+    include Mongoid::Document
+
+    embeds_many :doors
+  end
+
+  class Door
+    include Mongoid::Document
+
+    embedded_in :car
+  end
+
+  class Tank
+    include Mongoid::Document
+
+    embeds_many :guns
+    embeds_many :emm_turrets
+    # This association references a model that is not in our module,
+    # and it does not define class_name hence Mongoid will not be able to
+    # figure out the inverse for this association.
+    embeds_many :emm_hatches
+
+    # class_name is intentionally unqualified, references a class in the
+    # same module. Rails permits class_name to be unqualified like this.
+    embeds_many :launchers, class_name: 'Launcher'
+  end
+
+  class Gun
+    include Mongoid::Document
+
+    embedded_in :tank
+  end
+
+  class Launcher
+    include Mongoid::Document
+
+    # class_name is intentionally unqualified.
+    embedded_in :tank, class_name: 'Tank'
+  end
+end
+
+# This is intentionally on top level.
+class EmmTurret
+  include Mongoid::Document
+
+  embedded_in :tank, class_name: 'EmmSpec::Tank'
+end
+
+# This is intentionally on top level.
+class EmmHatch
+  include Mongoid::Document
+
+  # No :class_name option on this association intentionally.
+  embedded_in :tank
+end
+
+class EmmPost
+  include Mongoid::Document
+
+  embeds_many :company_tags, class_name: "EmmCompanyTag"
+  embeds_many :user_tags, class_name: "EmmUserTag"
+end
+
+
+class EmmCompanyTag
+  include Mongoid::Document
+
+  field :title, type: String
+
+  embedded_in :post, class_name: "EmmPost"
+end
+
+
+class EmmUserTag
+  include Mongoid::Document
+
+  field :title, type: String
+
+  embedded_in :post, class_name: "EmmPost"
+end
+

data/spec/mongoid/association/referenced/has_and_belongs_to_many/proxy_spec.rb

@@ -2395,6 +2395,10 @@ describe Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy do
           it "removes the ids from the foreign key" do
             expect(person.preference_ids).to eq([ preference_two.id ])
           end
+
+          it "sets the association locally" do
+            expect(person.preferences).to eq([preference_two])
+          end
         end
 
         context "when conditions are not provided" do
@@ -2421,6 +2425,10 @@ describe Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy do
           it "returns the number of documents deleted" do
             expect(deleted).to eq(2)
           end
+
+          it "sets the association locally" do
+            expect(person.preferences).to eq([])
+          end
         end
       end
     end

data/spec/mongoid/association/referenced/has_many/proxy_spec.rb

@@ -2214,10 +2214,8 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
             Person.create(username: 'durran')
           end
 
-          before do
-            person.posts.create(title: "Testing")
-            person.posts.create(title: "Test")
-          end
+          let!(:post1) { person.posts.create!(title: "Testing") }
+          let!(:post2) { person.posts.create!(title: "Test") }
 
           it "removes the correct posts" do
             person.posts.send(method, { title: "Testing" })
@@ -2233,6 +2231,11 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
           it "returns the number of documents deleted" do
             expect(person.posts.send(method, { title: "Testing" })).to eq(1)
           end
+
+          it "sets the association locally" do
+            person.posts.send(method, { title: "Testing" })
+            expect(person.posts).to eq([post2])
+          end
         end
 
         context "when conditions are not provided" do
@@ -2259,6 +2262,11 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
           it "returns the number of documents deleted" do
             expect(person.posts.send(method)).to eq(2)
           end
+
+          it "sets the association locally" do
+            person.posts.send(method)
+            expect(person.posts).to eq([])
+          end
         end
       end
 
@@ -2270,10 +2278,8 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
             Movie.create(title: "Bladerunner")
           end
 
-          before do
-            movie.ratings.create(value: 1)
-            movie.ratings.create(value: 2)
-          end
+          let!(:rating1) { movie.ratings.create!(value: 1) }
+          let!(:rating2) { movie.ratings.create!(value: 2) }
 
           it "removes the correct ratings" do
             movie.ratings.send(method, { value: 1 })
@@ -2288,6 +2294,11 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
           it "returns the number of documents deleted" do
             expect(movie.ratings.send(method, { value: 1 })).to eq(1)
           end
+
+          it "sets the association locally" do
+            movie.ratings.send(method, { value: 1 })
+            expect(movie.ratings).to eq([rating2])
+          end
         end
 
         context "when conditions are not provided" do
@@ -2314,6 +2325,11 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
           it "returns the number of documents deleted" do
             expect(movie.ratings.send(method)).to eq(2)
           end
+
+          it "sets the association locally" do
+            movie.ratings.send(method)
+            expect(movie.ratings).to eq([])
+          end
         end
       end
     end

data/spec/mongoid/criteria_spec.rb

@@ -3490,6 +3490,38 @@ describe Mongoid::Criteria do
           'foo' => 1, '$and' => [{'foo' => 2}], 'bar' => 3)
       end
     end
+
+    context "when duplicating where conditions" do
+      let(:criteria) { Sound.where(active: true).where(active: true) }
+
+      it 'does not duplicate criteria' do
+        expect(criteria.selector).to eq('active' => true)
+      end
+    end
+
+    context "when duplicating where conditions with different values" do
+      let(:criteria) { Sound.where(active: true).where(active: false).where(active: true).where(active: false) }
+
+      it 'does not duplicate criteria' do
+        expect(criteria.selector).to eq(
+          'active' => true, '$and' => [{'active' => false}])
+      end
+    end
+
+    # Used to test MONGOID-5251 where the find command was adding unnecessary
+    # and clauses. Since the find command creates the criteria and executes it,
+    # it is difficult to analyze the criteria used. For this reason, I have
+    # extracted the crux of the issue, adding an _id to the the criteria twice, 
+    # and used that for the test case.
+    context "when searching by _id twice" do
+      let(:_id) { BSON::ObjectId.new }
+      let(:criteria) { Band.where(_id: _id) }
+      let(:dup_criteria) { criteria.where(_id: _id)}
+
+      it "does not duplicate the criteria" do
+        expect(dup_criteria.selector).to eq({ "_id" => _id })
+      end
+    end
   end
 
   describe "#for_js" do

data/spec/mongoid/query_cache_spec.rb

@@ -17,11 +17,11 @@ describe Mongoid::QueryCache do
     # occur only within the scope of these tests.
     #
     # Other session leaks will be detected and addressed as part of RUBY-2391.
-    SessionRegistry.instance.clear_registry
+    Mrss::SessionRegistry.instance.clear_registry
   end
 
   after do
-    SessionRegistry.instance.verify_sessions_ended!
+    Mrss::SessionRegistry.instance.verify_sessions_ended!
   end
 
   let(:reset_legacy_qc_warning) do

data/spec/mongoid/scopable_spec.rb

@@ -111,6 +111,17 @@ describe Mongoid::Scopable do
         expect(Band).to be_default_scoping
       end
     end
+
+    context "when parent class has default scope" do
+
+      let (:selector) do
+        AudibleSound.all.selector
+      end
+
+      it "the subclass doesn't duplicate the default scope in the selector" do
+        expect(selector).to eq({'active' => true})
+      end
+    end
   end
 
   describe ".default_scopable?" do

data/spec/shared/lib/mrss/cluster_config.rb

@@ -209,7 +209,12 @@ module Mrss
       @server_version = build_info['version']
       @enterprise = build_info['modules'] && build_info['modules'].include?('enterprise')
 
-      @server_parameters = client.use(:admin).command(getParameter: '*').first
+      @server_parameters = begin
+        client.use(:admin).command(getParameter: '*').first
+      rescue => e
+        STDERR.puts("WARNING: Failed to obtain server parameters: #{e.class}: #{e.message}")
+        {}
+      end
 
       if !sharded_ish? && short_server_version >= '3.4'
         rv = @server_parameters['featureCompatibilityVersion']

data/spec/shared/lib/mrss/session_registry.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'singleton'
+
+module Mrss
+
+  def self.patch_mongo_for_session_registry
+
+    Mongo::Client.class_eval do
+      alias :get_session_without_tracking :get_session
+
+      def get_session(options = {})
+        get_session_without_tracking(options).tap do |session|
+          SessionRegistry.instance.register(session) if session&.materialized?
+        end
+      end
+    end
+
+    Mongo::Session.class_eval do
+      alias :end_session_without_tracking :end_session
+
+      def end_session
+        SessionRegistry.instance.unregister(self)
+        end_session_without_tracking
+      end
+
+      alias :materialize_if_needed_without_tracking :materialize_if_needed
+
+      def materialize_if_needed
+        materialize_if_needed_without_tracking.tap do
+          SessionRegistry.instance.register(self)
+        end
+      end
+    end
+  end
+end
+
+module Mrss
+  class SessionRegistry
+    include Singleton
+
+    def initialize
+      @registry = {}
+    end
+
+    def register(session)
+      @registry[session.session_id] = session if session
+    end
+
+    def unregister(session)
+      return if session.ended? || !session.materialized?
+      @registry.delete(session.session_id)
+    end
+
+    def verify_sessions_ended!
+      @registry.delete_if { |_, session| session.ended? }
+
+      unless @registry.empty?
+        sessions = @registry.map { |_, session| session }
+        raise "Session registry contains live sessions: #{sessions.join(', ')}"
+      end
+    end
+
+    def clear_registry
+      @registry = {}
+    end
+  end
+end

data/spec/shared/lib/mrss/session_registry_legacy.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'singleton'
+
+module Mrss
+
+  def self.patch_mongo_for_session_registry
+
+    Mongo::Client.class_eval do
+      alias :get_session_without_tracking :get_session
+
+      def get_session(options = {})
+        get_session_without_tracking(options).tap do |session|
+          SessionRegistry.instance.register(session)
+        end
+      end
+    end
+
+    Mongo::Session.class_eval do
+      alias :end_session_without_tracking :end_session
+
+      def end_session
+        SessionRegistry.instance.unregister(self)
+        end_session_without_tracking
+      end
+    end
+  end
+end
+
+module Mrss
+  class SessionRegistry
+    include Singleton
+
+    def initialize
+      @registry = {}
+    end
+
+    def register(session)
+      @registry[session.session_id] = session if session
+    end
+
+    def unregister(session)
+      @registry.delete(session.session_id) unless session.ended?
+    end
+
+    def verify_sessions_ended!
+      @registry.delete_if { |_, session| session.ended? }
+
+      unless @registry.empty?
+        sessions = @registry.map { |_, session| session }
+        raise "Session registry contains live sessions: #{sessions.join(', ')}"
+      end
+    end
+
+    def clear_registry
+      @registry = {}
+    end
+  end
+end

data/spec/shared/share/Dockerfile.erb

@@ -233,13 +233,13 @@ CFG
   # Current virtualenv fails with
   # https://github.com/pypa/virtualenv/issues/1630
   <% if distro =~ /ubuntu2004/ %>
-    RUN python3 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]'
+    RUN python3 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]==1.5.5'
   <% else %>
-    RUN python2 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]'
+    RUN python2 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]==1.5.5'
   <% end %>
 
   RUN pip --version && \
-    pip install mtools-legacy[mlaunch]
+    pip install 'mtools-legacy[mlaunch]==1.5.5'
 
   <% if @env.fetch('MONGODB_VERSION') >= '4.4' %>
     # ubuntu1604 installs MarkupSafe 0.0.0 here instead of 2.0.0+

data/spec/shared/shlib/server.sh

@@ -71,7 +71,7 @@ install_mlaunch_virtualenv() {
     venvpath="$MONGO_ORCHESTRATION_HOME"/venv
     python2 -m virtualenv -p python2 $venvpath
     . $venvpath/bin/activate
-    pip install 'mtools-legacy[mlaunch]'
+    pip install 'mtools-legacy[mlaunch]==1.5.5'
   fi
 }
 

data/spec/support/models/audible_sound.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class AudibleSound < Sound; end