mongoid 6.3.0 → 6.4.5

data/spec/mongoid/scopable_spec.rb

@@ -1130,6 +1130,19 @@ describe Mongoid::Scopable do
     it "sets the threading options" do
       Band.without_default_scope do
         expect(Mongoid::Threaded).to be_executing(:without_default_scope)
+        expect(Mongoid::Threaded.without_default_scope?(Band)).to be(true)
+      end
+    end
+
+    it "suppresses default scope on the given model within the given block" do
+      Appointment.without_default_scope do
+        expect(Appointment.all.selector).to be_empty
+      end
+    end
+
+    it "does not affect other models' default scopes within the given block" do
+      Appointment.without_default_scope do
+        expect(Audio.all.selector).not_to be_empty
       end
     end
   end

data/spec/mongoid/threaded_spec.rb

@@ -233,4 +233,72 @@ describe Mongoid::Threaded do
       end
     end
   end
+
+  describe "#begin_without_default_scope" do
+
+    let(:klass) do
+      Appointment
+    end
+
+    after do
+      described_class.exit_without_default_scope(klass)
+    end
+
+    it "adds the given class to the without_default_scope stack" do
+      described_class.begin_without_default_scope(klass)
+
+      expect(described_class.stack(:without_default_scope)).to include(klass)
+    end
+  end
+
+  describe "#exit_without_default_scope" do
+
+    let(:klass) do
+      Appointment
+    end
+
+    before do
+      described_class.begin_without_default_scope(klass)
+    end
+
+    it "removes the given class from the without_default_scope stack" do
+      described_class.exit_without_default_scope(klass)
+
+      expect(described_class.stack(:without_default_scope)).not_to include(klass)
+    end
+  end
+
+  describe "#without_default_scope?" do
+
+    let(:klass) do
+      Appointment
+    end
+
+    context "when klass has begun without_default_scope" do
+
+      before do
+        described_class.begin_without_default_scope(klass)
+      end
+
+      after do
+        described_class.exit_without_default_scope(klass)
+      end
+
+      it "returns true" do
+        expect(described_class.without_default_scope?(klass)).to be(true)
+      end
+    end
+
+    context "when klass has exited without_default_scope" do
+
+      before do
+        described_class.begin_without_default_scope(klass)
+        described_class.exit_without_default_scope(klass)
+      end
+
+      it "returns false" do
+        expect(described_class.without_default_scope?(klass)).to be(false)
+      end
+    end
+  end
 end

data/spec/rails/controller_extension/controller_runtime_spec.rb

@@ -0,0 +1,110 @@
+require "spec_helper"
+require "mongoid/railties/controller_runtime"
+
+describe "Mongoid::Railties::ControllerRuntime" do
+  controller_runtime = Mongoid::Railties::ControllerRuntime
+  collector = controller_runtime::Collector
+
+  def set_metric value
+    Thread.current["Mongoid.controller_runtime"] = value
+  end
+
+  def clear_metric!
+    set_metric 0
+  end
+
+  describe "Collector" do
+
+    it "stores the metric in thread-safe manner" do
+      clear_metric!
+      expect(collector.runtime).to eq(0)
+      set_metric 42
+      expect(collector.runtime).to eq(42)
+    end
+
+    it "sets metric on both succeeded and failed" do
+      instance = collector.new
+      event_payload = OpenStruct.new duration: 42
+
+      clear_metric!
+      instance.succeeded event_payload
+      expect(collector.runtime).to eq(42)
+
+      clear_metric!
+      instance.failed event_payload
+      expect(collector.runtime).to eq(42)
+    end
+
+    it "resets the metric and returns the value" do
+      clear_metric!
+      expect(collector.reset_runtime).to eq(0)
+      set_metric 42
+      expect(collector.reset_runtime).to eq(42)
+      expect(collector.runtime).to eq(0)
+    end
+
+  end
+
+  reference_controller_class = Class.new do
+    def process_action *_
+      @process_action = true
+    end
+
+    def cleanup_view_runtime *_
+      @cleanup_view_runtime.call
+    end
+
+    def append_info_to_payload *_
+      @append_info_to_payload = true
+    end
+
+    def self.log_process_action *_
+      @log_process_action.call
+    end
+  end
+
+  controller_class = Class.new reference_controller_class do
+    include controller_runtime::ControllerExtension
+  end
+
+  let(:controller){ controller_class.new }
+
+  it "resets the metric before each action" do
+    set_metric 42
+    controller.send(:process_action, 'foo')
+    expect(collector.runtime).to be(0)
+    expect(controller.instance_variable_get "@process_action").to be(true)
+  end
+
+  it "strips the metric of other sources of the runtime" do
+    set_metric 1
+    controller.instance_variable_set "@cleanup_view_runtime", ->{
+      controller.instance_variable_set "@cleanup_view_runtime", true
+      set_metric 13
+      42
+    }
+    returned = controller.send :cleanup_view_runtime
+    expect(controller.instance_variable_get "@cleanup_view_runtime").to be(true)
+    expect(controller.mongoid_runtime).to eq(14)
+    expect(returned).to be(29)
+  end
+
+  it "appends the metric to payload" do
+    payload = {}
+    set_metric 42
+    controller.send :append_info_to_payload, payload
+    expect(controller.instance_variable_get "@append_info_to_payload").to be(true)
+    expect(payload[:mongoid_runtime]).to eq(42)
+  end
+
+  it "adds metric to log message" do
+    controller_class.instance_variable_set "@log_process_action", ->{
+      controller_class.instance_variable_set "@log_process_action", true
+      []
+    }
+    messages = controller_class.log_process_action mongoid_runtime: 42.101
+    expect(controller_class.instance_variable_get "@log_process_action").to be(true)
+    expect(messages).to eq(["MongoDB: 42.1ms"])
+  end
+
+end

data/spec/spec_helper.rb

@@ -34,6 +34,10 @@ end
 
 require 'support/authorization'
 require 'support/expectations'
+require 'support/macros'
+require 'support/spec_config'
+require 'support/cluster_config'
+require 'support/constraints'
 
 # Give MongoDB time to start up on the travis ci environment.
 if (ENV['CI'] == 'travis' || ENV['CI'] == 'evergreen')
@@ -90,6 +94,7 @@ end
 def array_filters_supported?
   Mongoid::Clients.default.cluster.next_primary.features.array_filters_enabled?
 end
+alias :sessions_supported? :array_filters_supported?
 
 # Set the database that the spec suite connects to.
 Mongoid.configure do |config|
@@ -126,8 +131,13 @@ end
 I18n.config.enforce_available_locales = false
 
 RSpec.configure do |config|
+  config.expect_with(:rspec) do |c|
+    c.syntax = [:should, :expect]
+  end
+
   config.raise_errors_for_deprecations!
   config.include(Mongoid::Expectations)
+  config.extend(Constraints)
 
   config.before(:suite) do
     client = Mongo::Client.new(["#{HOST}:#{PORT}"])
@@ -145,3 +155,72 @@ RSpec.configure do |config|
     Mongoid.purge!
   end
 end
+
+# A subscriber to be used with the Ruby driver for testing.
+#
+# @since 6.4.0
+class EventSubscriber
+
+  # The started events.
+  #
+  # @since 6.4.0
+  attr_reader :started_events
+
+  # The succeeded events.
+  #
+  # @since 6.4.0
+  attr_reader :succeeded_events
+
+  # The failed events.
+  #
+  # @since 6.4.0
+  attr_reader :failed_events
+
+  # Create the test event subscriber.
+  #
+  # @example Create the subscriber
+  #   EventSubscriber.new
+  #
+  # @since 6.4.0
+  def initialize
+    @started_events = []
+    @succeeded_events = []
+    @failed_events = []
+  end
+
+  # Cache the succeeded event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 6.4.0
+  def succeeded(event)
+    @succeeded_events.push(event)
+  end
+
+  # Cache the started event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 6.4.0
+  def started(event)
+    @started_events.push(event)
+  end
+
+  # Cache the failed event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 6.4.0
+  def failed(event)
+    @failed_events.push(event)
+  end
+
+  # Clear all cached events.
+  #
+  # @since 6.4.0
+  def clear_events!
+    @started_events = []
+    @succeeded_events = []
+    @failed_events = []
+  end
+end

data/spec/support/cluster_config.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'singleton'
+
+class ClusterConfig
+  include Singleton
+
+  def single_server?
+    determine_cluster_config
+    @single_server
+  end
+
+  def replica_set_name
+    determine_cluster_config
+    @replica_set_name
+  end
+
+  def server_version
+    determine_cluster_config
+    @server_version
+  end
+
+  def short_server_version
+    server_version.split('.')[0..1].join('.')
+  end
+
+  def fcv
+    determine_cluster_config
+    @fcv
+  end
+
+  # Per https://jira.mongodb.org/browse/SERVER-39052, working with FCV
+  # in sharded topologies is annoying. Also, FCV doesn't exist in servers
+  # less than 3.4. This method returns FCV on 3.4+ servers when in single
+  # or RS topologies, and otherwise returns the major.minor server version.
+  def fcv_ish
+    if server_version >= '3.4' && topology != :sharded
+      fcv
+    else
+      if short_server_version == '4.1'
+        '4.2'
+      else
+        short_server_version
+      end
+    end
+  end
+
+  def primary_address
+    determine_cluster_config
+    @primary_address
+  end
+
+  def primary_address_str
+    determine_cluster_config
+    @primary_address.seed
+  end
+
+  def primary_address_host
+    both = primary_address_str
+    both.split(':').first
+  end
+
+  def primary_address_port
+    both = primary_address_str
+    both.split(':')[1] || 27017
+  end
+
+  def primary_description
+    determine_cluster_config
+    @primary_description
+  end
+
+  # Try running a command on the admin database to see if the mongod was
+  # started with auth.
+  def auth_enabled?
+    if @auth_enabled.nil?
+      @auth_enabled = begin
+        basic_client.use(:admin).command(getCmdLineOpts: 1).first["argv"].include?("--auth")
+      rescue => e
+        e.message =~ /(not authorized)|(unauthorized)|(no users authenticated)|(requires authentication)/
+      end
+    end
+    @auth_enabled
+  end
+
+  def topology
+    determine_cluster_config
+    @topology
+  end
+
+  def storage_engine
+    @storage_engine ||= begin
+      # 2.6 does not have wired tiger
+      if short_server_version == '2.6'
+        :mmapv1
+      else
+        client = ClientRegistry.instance.global_client('root_authorized')
+        if topology == :sharded
+          shards = client.use(:admin).command(listShards: 1).first
+          shard = shards['shards'].first
+          address_str = shard['host'].sub(/^.*\//, '').sub(/,.*/, '')
+          client = ClusterTools.instance.direct_client(address_str,
+            SpecConfig.instance.test_options.merge(SpecConfig.instance.auth_options).merge(connect: :direct))
+        end
+        rv = client.use(:admin).command(serverStatus: 1).first
+        rv = rv['storageEngine']['name']
+        rv_map = {
+          'wiredTiger' => :wired_tiger,
+          'mmapv1' => :mmapv1,
+        }
+        rv_map[rv] || rv
+      end
+    end
+  end
+
+  private
+
+  def determine_cluster_config
+    return if @primary_address
+
+    # Run all commands to figure out the cluster configuration from the same
+    # client. This is somewhat wasteful when running a single test, but reduces
+    # test runtime for the suite overall because all commands are sent on the
+    # same connection rather than each command connecting to the cluster by
+    # itself.
+    client = Mongoid::Clients.default
+
+    primary = client.cluster.next_primary
+    @primary_address = primary.address
+    @primary_description = primary.description
+    @replica_set_name = client.cluster.topology.replica_set_name
+
+    @topology ||= begin
+      topology = client.cluster.topology.class.name.sub(/.*::/, '')
+      topology = topology.gsub(/([A-Z])/) { |match| '_' + match.downcase }.sub(/^_/, '')
+      if topology =~ /^replica_set/
+        topology = 'replica_set'
+      end
+      topology.to_sym
+    end
+
+    @single_server = client.cluster.send(:servers_list).length == 1
+
+    @server_version = client.database.command(buildInfo: 1).first['version']
+
+    if @topology != :sharded && short_server_version >= '3.4'
+      rv = client.use(:admin).command(getParameter: 1, featureCompatibilityVersion: 1).first['featureCompatibilityVersion']
+      @fcv = rv['version'] || rv
+    end
+  end
+
+  def basic_client
+    # Do not cache the result here so that if the client gets closed,
+    # client registry reconnects it in subsequent tests
+    ClientRegistry.instance.global_client('basic')
+  end
+end