mongoid 6.4.1 → 6.4.8

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 = "6.4.1"
+  VERSION = "6.4.8"
 end

data/spec/app/models/array_field.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ArrayField
+  include Mongoid::Document
+
+  field :af, type: Array
+end

data/spec/app/models/delegating_patient.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+class DelegatingPatient
+  include Mongoid::Document
+
+  embeds_one :email
+
+  # Instance level delegation
+  delegate :address, to: :email
+
+  class << self
+    # Class level delegation
+    delegate :default_client, to: ::Mongoid
+  end
+end

data/spec/integration/document_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Mongoid::Document do
+  context 'when including class uses delegate' do
+    let(:patient) do
+      DelegatingPatient.new(
+        email: Email.new(address: 'test@example.com'),
+      )
+    end
+
+    it 'works for instance level delegation' do
+      patient.address.should == 'test@example.com'
+    end
+
+    it 'works for class level delegation' do
+      DelegatingPatient.default_client.should be Mongoid.default_client
+    end
+  end
+end

data/spec/mongoid/clients/factory_spec.rb

@@ -1,7 +1,35 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Mongoid::Clients::Factory do
 
+  shared_examples_for 'includes seed address' do
+    let(:configured_address) do
+      address = SpecConfig.instance.addresses.first
+      unless address.include?(':')
+        address = "#{address}:27017"
+      end
+      address
+    end
+
+    let(:expected_addresses) do
+      [
+        configured_address,
+        configured_address.sub(/\Alocalhost:/, '127.0.0.1:'),
+        configured_address.sub(/\A127\.0\.0\.1:/, 'localhost:'),
+      ].uniq
+    end
+
+    it 'includes seed address' do
+      ok = cluster_addresses.any? do |address|
+        expected_addresses.include?(address)
+      end
+      expect(ok).to be true
+    end
+  end
+
   describe ".create" do
 
     context "when provided a name" do
@@ -12,8 +40,8 @@ describe Mongoid::Clients::Factory do
 
           let(:config) do
             {
-              default: { hosts: [ "127.0.0.1:27017" ], database: database_id },
-              secondary: { hosts: [ "127.0.0.1:27017" ], database: database_id }
+              default: { hosts: SpecConfig.instance.addresses, database: database_id },
+              secondary: { hosts: SpecConfig.instance.addresses, database: database_id }
             }
           end
 
@@ -37,10 +65,12 @@ describe Mongoid::Clients::Factory do
             expect(client).to be_a(Mongo::Client)
           end
 
-          it "sets the cluster's seeds" do
-            expect(cluster.addresses.first.to_s).to eq("127.0.0.1:27017")
+          let(:cluster_addresses) do
+            cluster.addresses.map(&:to_s)
           end
 
+          it_behaves_like 'includes seed address'
+
           it "sets the platform to Mongoid's platform constant" do
             expect(client.options[:platform]).to eq(Mongoid::PLATFORM_DETAILS)
           end
@@ -80,11 +110,11 @@ describe Mongoid::Clients::Factory do
           end
 
           it "sets the cluster's seed ports to 27017" do
-            expect(cluster.addresses.first.to_s).to eq("127.0.0.1:27017")
+            expect(%w(127.0.0.1:27017 localhost:27017)).to include(cluster.addresses.first.to_s)
           end
 
           it "sets ips with no ports to 27017" do
-            expect(default.cluster.addresses.first.to_s).to eq("127.0.0.1:27017")
+            expect(%w(127.0.0.1:27017 localhost:27017)).to include(cluster.addresses.first.to_s)
           end
         end
 
@@ -120,7 +150,7 @@ describe Mongoid::Clients::Factory do
             end
 
             it "sets the cluster's seeds" do
-              expect(cluster.addresses.first.to_s).to eq("127.0.0.1:27017")
+              expect(%w(127.0.0.1:27017 localhost:27017)).to include(cluster.addresses.first.to_s)
             end
 
             it "sets the database" do
@@ -132,8 +162,8 @@ describe Mongoid::Clients::Factory do
 
             let(:config) do
               {
-                default: { hosts: [ "127.0.0.1:27017" ], database: database_id },
-                secondary: { uri: "mongodb://127.0.0.1:27017,127.0.0.1:27018/mongoid_test" }
+                default: { hosts: [ "127.0.0.1:1234" ], database: database_id, server_selection_timeout: 1 },
+                secondary: { uri: "mongodb://127.0.0.1:1234,127.0.0.1:5678/mongoid_test?serverSelectionTimeoutMS=1000" }
               }
             end
 
@@ -162,7 +192,7 @@ describe Mongoid::Clients::Factory do
             end
 
             it "sets the cluster's seeds" do
-              expect(seeds).to eq([ "127.0.0.1:27017", "127.0.0.1:27018" ])
+              expect(seeds).to eq([ "127.0.0.1:1234", "127.0.0.1:5678" ])
             end
           end
         end
@@ -181,7 +211,7 @@ describe Mongoid::Clients::Factory do
     context "when no name is provided" do
 
       let(:config) do
-        { default: { hosts: ["127.0.0.1:27017"], database: database_id }}
+        { default: { hosts: SpecConfig.instance.addresses, database: database_id }}
       end
 
       before do
@@ -200,17 +230,15 @@ describe Mongoid::Clients::Factory do
         client.cluster
       end
 
-      let(:seeds) do
-        cluster.addresses.map{ |address| address.to_s }
+      let(:cluster_addresses) do
+        cluster.addresses.map(&:to_s)
       end
 
       it "returns the default client" do
         expect(client).to be_a(Mongo::Client)
       end
 
-      it "sets the cluster's seeds" do
-        expect(seeds).to eq([ "127.0.0.1:27017" ])
-      end
+      it_behaves_like 'includes seed address'
     end
 
     context "when nil is provided and no default config" do
@@ -230,7 +258,7 @@ describe Mongoid::Clients::Factory do
   describe ".default" do
 
     let(:config) do
-      { default: { hosts: ["127.0.0.1:27017"], database: database_id }}
+      { default: { hosts: SpecConfig.instance.addresses, database: database_id }}
     end
 
     before do
@@ -249,17 +277,15 @@ describe Mongoid::Clients::Factory do
       client.cluster
     end
 
-    let(:seeds) do
-      cluster.addresses.map{ |address| address.to_s }
+    let(:cluster_addresses) do
+      cluster.addresses.map(&:to_s)
     end
 
     it "returns the default client" do
       expect(client).to be_a(Mongo::Client)
     end
 
-    it "sets the cluster's seeds" do
-      expect(seeds).to eq([ "127.0.0.1:27017" ])
-    end
+    it_behaves_like 'includes seed address'
   end
 
   context "when options are provided with string keys" do
@@ -267,7 +293,7 @@ describe Mongoid::Clients::Factory do
     let(:config) do
       {
         default: {
-          hosts: [ "127.0.0.1:27017" ],
+          hosts: SpecConfig.instance.addresses,
           database: database_id,
           options: {
             "server_selection_timeout" => 10,
@@ -293,17 +319,15 @@ describe Mongoid::Clients::Factory do
       client.cluster
     end
 
-    let(:seeds) do
-      cluster.addresses.map{ |address| address.to_s }
+    let(:cluster_addresses) do
+      cluster.addresses.map(&:to_s)
     end
 
     it "returns the default client" do
       expect(client).to be_a(Mongo::Client)
     end
 
-    it "sets the cluster's seeds" do
-      expect(seeds).to eq([ "127.0.0.1:27017" ])
-    end
+    it_behaves_like 'includes seed address'
 
     it "sets the server selection timeout" do
       expect(cluster.options[:server_selection_timeout]).to eq(10)

data/spec/mongoid/clients/options_spec.rb

@@ -177,25 +177,40 @@ describe Mongoid::Clients::Options do
 
       context 'when returning a criteria' do
 
-        let(:context_and_criteria) do
-          collection = nil
-          cxt = Band.with(read: :secondary) do |klass|
-            collection = klass.all.collection
-            klass.persistence_context
+        shared_context 'applies secondary read preference' do
+
+          let(:context_and_criteria) do
+            collection = nil
+            cxt = Band.with(read_secondary_option) do |klass|
+              collection = klass.all.collection
+              klass.persistence_context
+            end
+            [ cxt, collection ]
           end
-          [ cxt, collection ]
-        end
 
-        let(:persistence_context) do
-          context_and_criteria[0]
+          let(:persistence_context) do
+            context_and_criteria[0]
+          end
+
+          let(:client) do
+            context_and_criteria[1].client
+          end
+
+          it 'applies the options to the criteria client' do
+            expect(client.options['read']).to eq('mode' => :secondary)
+          end
         end
 
-        let(:client) do
-          context_and_criteria[1].client
+        context 'read: :secondary shorthand' do
+          let(:read_secondary_option) { {read: :secondary} }
+
+          it_behaves_like 'applies secondary read preference'
         end
 
-        it 'applies the options to the criteria client' do
-          expect(client.options['read']).to eq(:secondary)
+        context 'read: {mode: :secondary}' do
+          let(:read_secondary_option) { {read: {mode: :secondary}} }
+
+          it_behaves_like 'applies secondary read preference'
         end
       end
 
@@ -339,7 +354,7 @@ describe Mongoid::Clients::Options do
           band.mongo_client.database.command(serverStatus: 1).first['connections']['current']
         end
 
-        let!(:connections_and_cluster_during) do
+        let(:connections_and_cluster_during) do
           connections = nil
           cluster = band.with(options) do |b|
             b.reload
@@ -381,7 +396,7 @@ describe Mongoid::Clients::Options do
           end
 
           it 'disconnects the new cluster when the block exits' do
-            expect(connections_before).to eq(connections_after)
+            expect(connections_after).to eq(connections_before)
           end
         end