mongoid 7.0.2 → 7.0.3

data/lib/mongoid/query_cache.rb

@@ -138,7 +138,9 @@ module Mongoid
       # @since 5.0.0
       def each
         if @cached_documents
-          @cached_documents.each{ |doc| yield doc }
+          @cached_documents.each do |doc|
+            yield doc
+          end
         else
           super
         end
@@ -163,7 +165,10 @@ module Mongoid
         @cursor_id = result.cursor_id
         @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
         documents = result.documents
-        (@cached_documents ||= []).concat(documents)
+        if @cursor_id.zero? && !@after_first_batch
+          (@cached_documents ||= []).concat(documents)
+        end
+        @after_first_batch = true
         documents
       end
     end
@@ -242,8 +247,7 @@ module Mongoid
           key = [ collection.namespace, selector, nil, skip, sort, projection, collation  ]
           cursor = QueryCache.cache_table[key]
           if cursor
-            limited_docs = cursor.to_a[0...limit.abs]
-            cursor.instance_variable_set(:@cached_documents, limited_docs)
+            cursor.to_a[0...limit.abs]
           end
         end
         cursor || QueryCache.cache_table[cache_key]

data/lib/mongoid/railtie.rb

@@ -102,6 +102,23 @@ module Rails
         puts "There is a configuration error with the current mongoid.yml."
         puts e.message
       end
+
+      # Include Controller extension that measures Mongoid runtime
+      # during request processing. The value then appears in Rails'
+      # instrumentation event `process_action.action_controller`.
+      #
+      # The measurement is made via internal Mongo monitoring subscription
+      initializer "mongoid.runtime-metric" do
+        require "mongoid/railties/controller_runtime"
+
+        ActiveSupport.on_load :action_controller do
+          include ::Mongoid::Railties::ControllerRuntime::ControllerExtension
+        end
+
+        Mongo::Monitoring::Global.subscribe Mongo::Monitoring::COMMAND,
+            ::Mongoid::Railties::ControllerRuntime::Collector.new
+      end
+
     end
   end
 end

data/lib/mongoid/railties/controller_runtime.rb

@@ -0,0 +1,86 @@
+module Mongoid
+  module Railties
+    module ControllerRuntime
+
+      # This extension mimics the Rails' internal method to
+      # measure ActiveRecord runtime during request processing.
+      # It appends MongoDB runtime value (`mongoid_runtime`) into payload
+      # of instrumentation event `process_action.action_controller`.
+      module ControllerExtension
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :mongoid_runtime
+
+        # Reset the runtime before each action.
+        def process_action(action, *args)
+          Collector.reset_runtime
+          super
+        end
+
+        # Override to collect the measurements.
+        def cleanup_view_runtime
+          mongo_rt_before_render = Collector.reset_runtime
+          runtime = super
+          mongo_rt_after_render = Collector.reset_runtime
+          self.mongoid_runtime = mongo_rt_before_render + mongo_rt_after_render
+          runtime - mongo_rt_after_render
+        end
+
+        # Add the measurement to the instrumentation event payload.
+        def append_info_to_payload(payload)
+          super
+          payload[:mongoid_runtime] = (mongoid_runtime || 0) + Collector.reset_runtime
+        end
+
+        module ClassMethods
+
+          # Append MongoDB runtime information to ActionController runtime
+          # log message.
+          def log_process_action(payload)
+            messages = super
+            mongoid_runtime = payload[:mongoid_runtime]
+            messages << ("MongoDB: %.1fms" % mongoid_runtime.to_f) if mongoid_runtime
+            messages
+          end
+
+        end
+
+      end
+
+      # The Collector of MongoDB runtime metric, that subscribes to Mongo
+      # driver command monitoring. Stores the value within a thread-local
+      # variable to provide correct accounting when an application issues
+      # MongoDB operations from background threads.
+      class Collector
+
+        VARIABLE_NAME = "Mongoid.controller_runtime".freeze
+
+        def started _; end
+
+        def _completed e
+          Collector.runtime += e.duration
+        end
+        alias :succeeded :_completed
+        alias :failed :_completed
+
+        def self.runtime
+          Thread.current[VARIABLE_NAME] ||= 0
+        end
+
+        def self.runtime= value
+          Thread.current[VARIABLE_NAME] = value
+        end
+
+        def self.reset_runtime
+          to_now = runtime
+          self.runtime = 0
+          to_now
+        end
+
+      end
+
+    end
+  end
+end

data/lib/mongoid/scopable.rb

@@ -102,7 +102,7 @@ module Mongoid
       #
       # @since 3.0.0
       def default_scopable?
-        default_scoping? && !Threaded.executing?(:without_default_scope)
+        default_scoping? && !Threaded.without_default_scope?(self)
       end
 
       # Get a queryable, either the last one on the scope stack or a fresh one.
@@ -244,10 +244,10 @@ module Mongoid
       #
       # @since 3.0.0
       def without_default_scope
-        Threaded.begin_execution("without_default_scope")
+        Threaded.begin_without_default_scope(self)
         yield
       ensure
-        Threaded.exit_execution("without_default_scope")
+        Threaded.exit_without_default_scope(self)
       end
 
       private

data/lib/mongoid/threaded.rb

@@ -163,6 +163,30 @@ module Mongoid
       validations_for(document.class).delete_one(document._id)
     end
 
+    # Begin suppressing default scopes for given model on the current thread.
+    #
+    # @example Begin without default scope stack.
+    #   Threaded.begin_without_default_scope(klass)
+    #
+    # @param [ Class ] klass The model to suppress default scoping on.
+    #
+    # @api private
+    def begin_without_default_scope(klass)
+      stack(:without_default_scope).push(klass)
+    end
+
+    # Exit suppressing default scopes for given model on the current thread.
+    #
+    # @example Exit without default scope stack.
+    #   Threaded.exit_without_default_scope(klass)
+    #
+    # @param [ Class ] klass The model to unsuppress default scoping on.
+    #
+    # @api private
+    def exit_without_default_scope(klass)
+      stack(:without_default_scope).delete(klass)
+    end
+
     # Get the global client override.
     #
     # @example Get the global client override.
@@ -247,6 +271,18 @@ module Mongoid
       end
     end
 
+    # Is the given klass' default scope suppressed on the current thread?
+    #
+    # @example Is the given klass' default scope suppressed?
+    #   Threaded.without_default_scope?(klass)
+    #
+    # @param [ Class ] klass The model to check for default scope suppression.
+    #
+    # @api private
+    def without_default_scope?(klass)
+      stack(:without_default_scope).include?(klass)
+    end
+
     # Is the document autosaved on the current thread?
     #
     # @example Is the document autosaved?

data/lib/mongoid/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Mongoid
-  VERSION = "7.0.2"
+  VERSION = "7.0.3"
 end

data/spec/app/models/minim.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Minimal model, do not add any fields
+class Minim
+  include Mongoid::Document
+  field :name
+end

data/spec/app/models/store_as_dup_test3.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class StoreAsDupTest3
+  include Mongoid::Document
+  embeds_many :store_as_dup_test4s, :store_as => :t
+  field :name
+end

data/spec/app/models/store_as_dup_test4.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class StoreAsDupTest4
+  include Mongoid::Document
+  embedded_in :store_as_dup_test3
+  field :name
+end

data/spec/config/mongoid.yml

@@ -3,7 +3,9 @@ test:
     default:
       database: mongoid_test
       hosts:
-        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
       options:
         user: "mongoid-user"
         password: "password"
@@ -13,14 +15,18 @@ test:
           tag_sets:
             - use: web
         max_pool_size: 1
+        server_selection_timeout: 3.14
     reports:
       database: reports
       hosts:
-        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
       options:
         user: "mongoid-user"
         password: "password"
         auth_source: "admin"
+        server_selection_timeout: 3.14
   options:
     include_root_in_json: false
     include_type_for_serialization: false
@@ -38,8 +44,11 @@ test_with_max_staleness:
     default:
       database: mongoid_test
       hosts:
-        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
       options:
         read:
           mode: :primary_preferred
           max_staleness: 100
+        server_selection_timeout: 3.14

data/spec/integration/associations/belongs_to_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require_relative '../../mongoid/association/referenced/has_one_models'
+
+describe 'belongs_to associations' do
+  context 'referencing top level classes when source class is namespaced' do
+    let(:college) { HomCollege.create! }
+    let(:child) { HomAccreditation::Child.new(hom_college: college) }
+
+    it 'works' do
+      expect(child).to be_valid
+    end
+  end
+end

data/spec/lite_spec_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "mongoid"
+require "rspec"
+
+# MRI 2.5 and JRuby 9.2 change visibility of Object#pp when 'pp' is required,
+# which happens when RSpec reports anything. This creates an issue for tests
+# that verify method forwarding. Work around by proactively loading 'pp'.
+# https://github.com/jruby/jruby/issues/5599
+require 'pp'
+
+require 'support/spec_config'
+
+unless SpecConfig.instance.ci?
+  begin
+    require 'byebug'
+  rescue LoadError
+    # jruby - try pry
+    begin
+      require 'pry'
+    # jruby likes to raise random error classes, in this case
+    # NameError in addition to LoadError
+    rescue Exception
+    end
+  end
+end
+
+if SpecConfig.instance.mri?
+  require 'timeout_interrupt'
+else
+  require 'timeout'
+  TimeoutInterrupt = Timeout
+end
+
+RSpec.configure do |config|
+  if SpecConfig.instance.ci?
+    config.add_formatter(RSpec::Core::Formatters::JsonFormatter, File.join(File.dirname(__FILE__), '../tmp/rspec.json'))
+  end
+
+  if SpecConfig.instance.ci?
+    # Allow a max of 30 seconds per test.
+    # Tests should take under 10 seconds ideally but it seems
+    # we have some that run for more than 10 seconds in CI.
+    config.around(:each) do |example|
+      TimeoutInterrupt.timeout(30) do
+        example.run
+      end
+    end
+  end
+end
+
+# require all shared examples
+Dir['./spec/support/shared/*.rb'].sort.each { |file| require file }

data/spec/mongoid/association/referenced/belongs_to/eager_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require_relative '../has_many_models'
 
 describe Mongoid::Association::Referenced::BelongsTo::Eager do
 
@@ -55,7 +56,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       Post.create!(person: person)
     end
 
-    it "sets the relation into the parent" do
+    it "sets the association into the parent" do
       docs.each do |doc|
         expect(doc).to receive(:set_relation).with(:person, :foo)
       end
@@ -73,7 +74,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       3.times { |i| Account.create!(person: person, name: "savings#{i}") }
     end
 
-    context "when including the belongs_to relation" do
+    context "when including the belongs_to association" do
 
       it "queries twice" do
 
@@ -85,7 +86,7 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
       end
     end
 
-    context "when the relation is not polymorphic" do
+    context "when the association is not polymorphic" do
 
       let(:eager) do
         Post.includes(:person).last
@@ -128,13 +129,13 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
           expect(eager.ivar(:person)).to be nil
         end
 
-        it "has a nil relation" do
+        it "has a nil association" do
           expect(eager.person).to be nil
         end
       end
     end
 
-    context "when the relation is polymorphic" do
+    context "when the association is polymorphic" do
 
       let!(:movie) do
         Movie.create(name: "Bladerunner")
@@ -159,5 +160,23 @@ describe Mongoid::Association::Referenced::BelongsTo::Eager do
         expect(game.person_id).to eql(id)
       end
     end
+
+    context "when all the values for the belongs_to association are nil" do
+
+      before do
+        2.times { |i| HmmTicket.create!(person: nil) }
+      end
+
+      it "only queries once for the parent documents" do
+        found_ticket = false
+        expect_query(1) do
+          HmmTicket.all.includes(:person).each do |ticket|
+            expect(ticket.person).to eq nil
+            found_ticket = true
+          end
+        end
+        expect(found_ticket).to be true
+      end
+    end
   end
 end

data/spec/mongoid/association/referenced/belongs_to_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require_relative './has_one_models'
 
 describe Mongoid::Association::Referenced::BelongsTo do
 
@@ -1627,9 +1628,19 @@ describe Mongoid::Association::Referenced::BelongsTo do
         expect(association.relation_class_name).to eq('OwnerObject')
       end
     end
+
+    context 'when the association is polymorphic' do
+      let(:association) do
+        HomPolymorphicChild.relations['p_parent']
+      end
+
+      it 'is the computed class name that does not match any existing class' do
+        expect(association.relation_class_name).to eq('PParent')
+      end
+    end
   end
 
-  describe '#klass' do
+  describe '#relation_class' do
 
     context 'when the :class_name option is specified' do
 
@@ -1643,14 +1654,26 @@ describe Mongoid::Association::Referenced::BelongsTo do
       end
 
       it 'returns the class name option' do
-        expect(association.klass).to eq(_class)
+        expect(association.relation_class).to eq(_class)
       end
     end
 
     context 'when the class_name option is not specified' do
 
       it 'uses the name of the relation to deduce the class name' do
-        expect(association.klass).to eq(OwnerObject)
+        expect(association.relation_class).to eq(OwnerObject)
+      end
+    end
+
+    context 'when the association is polymorphic' do
+      let(:association) do
+        HomPolymorphicChild.relations['p_parent']
+      end
+
+      it 'raises NameError' do
+        expect do
+          association.relation_class
+        end.to raise_error(NameError, /uninitialized constant .*PParent/)
       end
     end
   end
@@ -1660,6 +1683,16 @@ describe Mongoid::Association::Referenced::BelongsTo do
     it 'returns the name of the owner class' do
       expect(association.inverse_class_name).to eq(belonging_class.name)
     end
+
+    context 'polymorphic association' do
+      let(:association) do
+        belonging_class.belongs_to :poly_owner, polymorphic: true
+      end
+
+      it 'returns the name of the owner class' do
+        expect(association.inverse_class_name).to eq(belonging_class.name)
+      end
+    end
   end
 
   describe '#inverse_class' do
@@ -1667,6 +1700,16 @@ describe Mongoid::Association::Referenced::BelongsTo do
     it 'returns the owner class' do
       expect(association.inverse_class).to be(belonging_class)
     end
+
+    context 'polymorphic association' do
+      let(:association) do
+        belonging_class.belongs_to :poly_owner, polymorphic: true
+      end
+
+      it 'returns the owner class' do
+        expect(association.inverse_class).to be(belonging_class)
+      end
+    end
   end
 
   describe '#inverse_of' do