mongo 2.19.1 → 2.21.0

data/spec/integration/sdam_error_handling_spec.rb

@@ -8,6 +8,8 @@ describe 'SDAM error handling' do
 
   clean_slate
 
+  retry_test
+
   after do
     # Close all clients after every test to avoid leaking expectations into
     # subsequent tests because we set global assertions on sockets.
@@ -418,7 +420,8 @@ describe 'SDAM error handling' do
         expect_server_state_change
       end
 
-      it_behaves_like 'marks server unknown and clears connection pool'
+      # https://jira.mongodb.org/browse/RUBY-2523
+      # it_behaves_like 'marks server unknown and clears connection pool'
 
       after do
         admin_client.command(configureFailPoint: 'failCommand', mode: 'off')

data/spec/integration/search_indexes_prose_spec.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class SearchIndexHelper
+  attr_reader :client, :collection_name
+
+  def initialize(client)
+    @client = client
+
+    # https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.rst#id4
+    # "...each test uses a randomly generated collection name.  Drivers may
+    # generate this collection name however they like, but a suggested
+    # implementation is a hex representation of an ObjectId..."
+    @collection_name = BSON::ObjectId.new.to_s
+  end
+
+  # `soft_create` means to create the collection object without forcing it to
+  # be created in the database.
+  def collection(soft_create: false)
+    @collection ||= client.database[collection_name].tap do |collection|
+      collection.create unless soft_create
+    end
+  end
+
+  # Wait for all of the indexes with the given names to be ready; then return
+  # the list of index definitions corresponding to those names.
+  def wait_for(*names, &condition)
+    timeboxed_wait do
+      result = collection.search_indexes
+      return filter_results(result, names) if names.all? { |name| ready?(result, name, &condition) }
+    end
+  end
+
+  # Wait until all of the indexes with the given names are absent from the
+  # search index list.
+  def wait_for_absense_of(*names)
+    names.each do |name|
+      timeboxed_wait do
+        break if collection.search_indexes(name: name).empty?
+      end
+    end
+  end
+
+  private
+
+  def timeboxed_wait(step: 5, max: 300)
+    start = Mongo::Utils.monotonic_time
+
+    loop do
+      yield
+
+      sleep step
+      raise Timeout::Error, 'wait took too long' if Mongo::Utils.monotonic_time - start > max
+    end
+  end
+
+  # Returns true if the list of search indexes includes one with the given name,
+  # which is ready to be queried.
+  def ready?(list, name, &condition)
+    condition ||= ->(index) { index['queryable'] }
+    list.any? { |index| index['name'] == name && condition[index] }
+  end
+
+  def filter_results(result, names)
+    result.select { |index| names.include?(index['name']) }
+  end
+end
+
+describe 'Mongo::Collection#search_indexes prose tests' do
+  # https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.rst#id5
+  # "These tests must run against an Atlas cluster with a 7.0+ server."
+  require_atlas
+
+  let(:client) do
+    Mongo::Client.new(
+      ENV['ATLAS_URI'],
+      database: SpecConfig.instance.test_db,
+      ssl: true,
+      ssl_verify: true
+    )
+  end
+
+  let(:helper) { SearchIndexHelper.new(client) }
+
+  let(:name) { 'test-search-index' }
+  let(:definition) { { 'mappings' => { 'dynamic' => false } } }
+  let(:create_index) { helper.collection.search_indexes.create_one(definition, name: name) }
+
+  after do
+    client.close
+  end
+
+  # Case 1: Driver can successfully create and list search indexes
+  context 'when creating and listing search indexes' do
+    let(:index) { helper.wait_for(name).first }
+
+    it 'succeeds' do
+      expect(create_index).to be == name
+      expect(index['latestDefinition']).to be == definition
+    end
+  end
+
+  # Case 2: Driver can successfully create multiple indexes in batch
+  context 'when creating multiple indexes in batch' do
+    let(:specs) do
+      [
+        { 'name' => 'test-search-index-1', 'definition' => definition },
+        { 'name' => 'test-search-index-2', 'definition' => definition }
+      ]
+    end
+
+    let(:names) { specs.map { |spec| spec['name'] } }
+    let(:create_indexes) { helper.collection.search_indexes.create_many(specs) }
+
+    let(:indexes) { helper.wait_for(*names) }
+
+    let(:index1) { indexes[0] }
+    let(:index2) { indexes[1] }
+
+    it 'succeeds' do
+      expect(create_indexes).to be == names
+      expect(index1['latestDefinition']).to be == specs[0]['definition']
+      expect(index2['latestDefinition']).to be == specs[1]['definition']
+    end
+  end
+
+  # Case 3: Driver can successfully drop search indexes
+  context 'when dropping search indexes' do
+    it 'succeeds' do
+      expect(create_index).to be == name
+      helper.wait_for(name)
+
+      helper.collection.search_indexes.drop_one(name: name)
+
+      expect { helper.wait_for_absense_of(name) }.not_to raise_error
+    end
+  end
+
+  # Case 4: Driver can update a search index
+  context 'when updating search indexes' do
+    let(:new_definition) { { 'mappings' => { 'dynamic' => true } } }
+
+    let(:index) do
+      helper
+        .wait_for(name) { |idx| idx['queryable'] && idx['status'] == 'READY' }
+        .first
+    end
+
+    # rubocop:disable RSpec/ExampleLength
+    it 'succeeds' do
+      expect(create_index).to be == name
+      helper.wait_for(name)
+
+      expect do
+        helper.collection.search_indexes.update_one(new_definition, name: name)
+      end.not_to raise_error
+
+      expect(index['latestDefinition']).to be == new_definition
+    end
+    # rubocop:enable RSpec/ExampleLength
+  end
+
+  # Case 5: dropSearchIndex suppresses namespace not found errors
+  context 'when dropping a non-existent search index' do
+    it 'ignores `namespace not found` errors' do
+      collection = helper.collection(soft_create: true)
+      expect { collection.search_indexes.drop_one(name: name) }
+        .not_to raise_error
+    end
+  end
+end

data/spec/integration/server_spec.rb

@@ -6,6 +6,7 @@ require 'spec_helper'
 describe 'Server' do
   let(:client) { authorized_client }
 
+  let(:context) { Mongo::Operation::Context.new(client: client) }
   let(:server) { client.cluster.next_primary }
 
   let(:collection) { client['collection'] }
@@ -15,7 +16,7 @@ describe 'Server' do
     context 'it performs read operations and receives the correct result type' do
       context 'normal server' do
         it 'can be used for reads' do
-          result = view.send(:send_initial_query, server)
+          result = view.send(:send_initial_query, server, context)
           expect(result).to be_a(Mongo::Operation::Find::Result)
         end
       end
@@ -35,7 +36,7 @@ describe 'Server' do
 
         it 'can be used for reads' do
           # See also RUBY-3102.
-          result = view.send(:send_initial_query, server)
+          result = view.send(:send_initial_query, server, context)
           expect(result).to be_a(Mongo::Operation::Find::Result)
         end
       end
@@ -57,7 +58,7 @@ describe 'Server' do
         it 'is unusable' do
           # See also RUBY-3102.
           lambda do
-            view.send(:send_initial_query, server)
+            view.send(:send_initial_query, server, context)
           end.should raise_error(Mongo::Error::ServerNotUsable)
         end
       end

data/spec/integration/transactions_api_examples_spec.rb

@@ -58,5 +58,7 @@ describe 'Transactions API examples' do
 
     # End Transactions withTxn API Example 1
 
+    # Do not leak clients.
+    client.close
   end
 end

data/spec/kerberos/kerberos_spec.rb

@@ -20,6 +20,10 @@ describe 'kerberos authentication' do
     end
   end
 
+  after do
+    client&.close
+  end
+
   let(:user) do
    "#{require_env_value('SASL_USER')}%40#{realm}"
   end

data/spec/lite_spec_helper.rb

@@ -22,7 +22,9 @@ CMAP_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/cmap/*.yml").sort.select
   !defined?(JRUBY_VERSION) || !f.include?('pool-checkout-minPoolSize-connection-maxConnecting.yml')
 end
 AUTH_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/auth/*.yml").sort
-CLIENT_SIDE_ENCRYPTION_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/client_side_encryption/*.yml").sort
+CLIENT_SIDE_ENCRYPTION_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/client_side_encryption/*.yml").sort.delete_if do |spec|
+  ![ 1, '1', 'yes', 'true' ].include?(ENV['CSOT_SPEC_TESTS']) && spec =~ /.*timeoutMS.yml$/
+end
 
 # Disable output buffering: https://www.rubyguides.com/2019/02/ruby-io/
 STDOUT.sync = true
@@ -106,6 +108,31 @@ Mrss.patch_mongo_for_session_registry
 
 class ExampleTimeout < StandardError; end
 
+STANDARD_TIMEOUTS = {
+  stress: 210,
+  jruby: 90,
+  default: 45,
+}.freeze
+
+def timeout_type
+  if ENV['EXAMPLE_TIMEOUT'].to_i > 0
+    :custom
+  elsif %w(1 true yes).include?(ENV['STRESS']&.downcase)
+    :stress
+  elsif BSON::Environment.jruby?
+    :jruby
+  else
+    :default
+  end
+end
+
+def example_timeout_seconds
+  STANDARD_TIMEOUTS.fetch(
+    timeout_type,
+    (ENV['EXAMPLE_TIMEOUT'] || STANDARD_TIMEOUTS[:default]).to_i
+  )
+end
+
 RSpec.configure do |config|
   config.extend(CommonShortcuts::ClassMethods)
   config.include(CommonShortcuts::InstanceMethods)
@@ -123,6 +150,12 @@ RSpec.configure do |config|
     end
   end
 
+  def require_atlas
+    before do
+      skip 'Set ATLAS_URI in environment to run atlas tests' if ENV['ATLAS_URI'].nil?
+    end
+  end
+
   if SpecConfig.instance.ci?
     SdamFormatterIntegration.subscribe
     config.add_formatter(JsonExtFormatter, File.join(File.dirname(__FILE__), '../tmp/rspec.json'))
@@ -137,25 +170,6 @@ RSpec.configure do |config|
     end
   end
 
-  if SpecConfig.instance.ci? && !%w(1 true yes).include?(ENV['INTERACTIVE']&.downcase)
-    # 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|
-      timeout = if %w(1 true yes).include?(ENV['STRESS']&.downcase)
-        210
-      else
-        if BSON::Environment.jruby?
-          90
-        else
-          45
-        end
-      end
-      TimeoutInterrupt.timeout(timeout, ExampleTimeout) do
-        example.run
-      end
-    end
-  end
-
   if SpecConfig.instance.ci?
     if defined?(Rfc::Rif)
       unless BSON::Environment.jruby?

data/spec/mongo/auth/user/view_spec.rb

@@ -526,7 +526,7 @@ describe Mongo::Auth::User::View do
       it "raises and reports the write concern error correctly" do
         begin
           view.send(method, input)
-        rescue Mongo::Error::OperationFailure => e
+        rescue Mongo::Error::OperationFailure::Family => e
           expect(e.write_concern_error?).to be true
           expect(e.write_concern_error_document).to eq(
             "code" => 64,

data/spec/mongo/caching_cursor_spec.rb

@@ -23,7 +23,7 @@ describe Mongo::CachingCursor do
   end
 
   let(:reply) do
-    view.send(:send_initial_query, server)
+    view.send(:send_initial_query, server, Mongo::Operation::Context.new(client: authorized_client))
   end
 
   let(:cursor) do

data/spec/mongo/client_encryption_spec.rb

@@ -303,6 +303,7 @@ describe Mongo::ClientEncryption do
         end
 
         it 'raises a KmsError' do
+          skip 'https://jira.mongodb.org/browse/RUBY-3375'
           expect do
             data_key_id
           end.to raise_error(Mongo::Error::KmsError, /Error while connecting to socket/)

data/spec/mongo/client_spec.rb

@@ -561,6 +561,75 @@ describe Mongo::Client do
         expect(command['comment']).to eq('comment')
       end
     end
+
+    context 'with timeout_ms' do
+      # To make it easier with failCommand
+      require_topology :single
+      min_server_version '4.4'
+
+      before do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "alwaysOn",
+          data: {
+              failCommands: ["listDatabases"],
+              blockConnection: true,
+              blockTimeMS: 100
+            }
+        })
+      end
+
+      after do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "off"
+        })
+      end
+
+      context 'when timeout_ms is set on command level' do
+        context 'when there is not enough time' do
+          it 'raises' do
+            expect do
+              monitored_client.database_names({}, timeout_ms: 50)
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          it 'does not raise' do
+            expect do
+              monitored_client.database_names({}, timeout_ms: 200)
+            end.not_to raise_error
+          end
+        end
+      end
+
+      context 'when timeout_ms is set on client level' do
+        context 'when there is not enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 50)
+          end
+
+          it 'raises' do
+            expect do
+              client.database_names({})
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 200)
+          end
+
+          it 'does not raise' do
+            expect do
+              monitored_client.database_names({})
+            end.not_to raise_error
+          end
+        end
+      end
+    end
   end
 
   describe '#list_databases' do
@@ -572,8 +641,6 @@ describe Mongo::Client do
     end
 
     context 'when filter criteria is present' do
-      min_server_fcv '3.6'
-
       include_context 'ensure test db exists'
 
       let(:result) do
@@ -591,8 +658,6 @@ describe Mongo::Client do
     end
 
     context 'when name_only is true' do
-      min_server_fcv '3.6'
-
       let(:command) do
         Utils.get_command_event(root_authorized_client, 'listDatabases') do |client|
           client.list_databases({}, true)
@@ -667,6 +732,75 @@ describe Mongo::Client do
         expect(command['comment']).to eq('comment')
       end
     end
+
+    context 'with timeout_ms' do
+      # To make it easier with failCommand
+      require_topology :single
+      min_server_version '4.4'
+
+      before do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "alwaysOn",
+          data: {
+              failCommands: ["listDatabases"],
+              blockConnection: true,
+              blockTimeMS: 100
+            }
+        })
+      end
+
+      after do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "off"
+        })
+      end
+
+      context 'when timeout_ms is set on command level' do
+        context 'when there is not enough time' do
+          it 'raises' do
+            expect do
+              monitored_client.list_databases({}, false, timeout_ms: 50)
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          it 'does not raise' do
+            expect do
+              monitored_client.list_databases({}, false, timeout_ms: 200)
+            end.not_to raise_error
+          end
+        end
+      end
+
+      context 'when timeout_ms is set on client level' do
+        context 'when there is not enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 50)
+          end
+
+          it 'raises' do
+            expect do
+              client.list_databases({})
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 200)
+          end
+
+          it 'does not raise' do
+            expect do
+              monitored_client.list_databases({})
+            end.not_to raise_error
+          end
+        end
+      end
+    end
   end
 
   describe '#list_mongo_databases' do
@@ -1156,6 +1290,26 @@ describe Mongo::Client do
         }.to raise_exception(Mongo::Error::InvalidSession)
       end
     end
+
+    context 'when CSOT is set on the client' do
+      require_topology :replica_set
+
+      let(:timeout_ms) { 10 }
+
+      let(:timeout_sec) { timeout_ms / 1_000.0 }
+
+      let(:client) do
+        authorized_client.with(timeout_ms: timeout_ms)
+      end
+
+      it 'uses CSOT timeout set on the client' do
+        expect_any_instance_of(Mongo::ServerSelector::PrimaryPreferred).to(
+          receive(:select_server).with(anything, {timeout: timeout_sec}).and_call_original
+        )
+
+        client.start_session
+      end
+    end
   end
 
   describe '#summary' do

data/spec/mongo/cluster_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'support/recording_logger'
 
 # let these existing styles stand, rather than going in for a deep refactoring
 # of these specs.
@@ -84,6 +85,41 @@ describe Mongo::Cluster do
         )
       end
     end
+
+    context 'when a non-genuine host is detected' do
+      before { described_class.new(host_names, monitoring, logger: logger, monitoring_io: false) }
+
+      let(:logger) { RecordingLogger.new }
+
+      shared_examples 'an action that logs' do
+        it 'writes a warning to the log' do
+          expect(logger.lines).to include(a_string_matching(expected_log_output))
+        end
+      end
+
+      context 'when CosmosDB is detected' do
+        let(:host_names) { %w[ xyz.cosmos.azure.com ] }
+        let(:expected_log_output) { %r{https://www.mongodb.com/supportability/cosmosdb} }
+
+        it_behaves_like 'an action that logs'
+      end
+
+      context 'when DocumentDB is detected' do
+        let(:expected_log_output) { %r{https://www.mongodb.com/supportability/documentdb} }
+
+        context 'with docdb uri' do
+          let(:host_names) { [ 'xyz.docdb.amazonaws.com' ] }
+
+          it_behaves_like 'an action that logs'
+        end
+
+        context 'with docdb-elastic uri' do
+          let(:host_names) { [ 'xyz.docdb-elastic.amazonaws.com' ] }
+
+          it_behaves_like 'an action that logs'
+        end
+      end
+    end
   end
 
   describe '#==' do

data/spec/mongo/collection/view/aggregation_spec.rb

@@ -156,8 +156,6 @@ describe Mongo::Collection::View::Aggregation do
     end
 
     context 'when the initial response has no results but an active cursor' do
-      min_server_fcv '3.2'
-
       let(:documents) do
         [
             { city: 'a'*6000000 },
@@ -166,7 +164,7 @@ describe Mongo::Collection::View::Aggregation do
       end
 
       let(:options) do
-        { :use_cursor => true }
+        {}
       end
 
       let(:pipeline) do
@@ -321,7 +319,12 @@ describe Mongo::Collection::View::Aggregation do
           min_server_fcv '4.2'
 
           let(:result) do
-            aggregation.explain['queryPlanner']['collation']['locale']
+            if aggregation.explain.key?('queryPlanner')
+              aggregation.explain['queryPlanner']['collation']['locale']
+            else
+              # 7.2+ sharded cluster
+              aggregation.explain['shards'].first.last['queryPlanner']['collation']['locale']
+            end
           end
 
           it_behaves_like 'applies the collation'
@@ -481,48 +484,25 @@ describe Mongo::Collection::View::Aggregation do
       end
     end
 
-    context 'when use_cursor is set' do
-
-      context 'when use_cursor is true' do
-
-        context 'when batch_size is set' do
-
-          let(:options) do
-            { :use_cursor => true,
-              :batch_size => 10
-            }
-          end
-
-          it 'sets a batch size document in the spec' do
-            expect(aggregation_spec[:selector][:cursor][:batchSize]).to eq(options[:batch_size])
-          end
-        end
-
-        context 'when batch_size is not set' do
-
-          let(:options) do
-            { :use_cursor => true }
-          end
-
-          it 'sets an empty document in the spec' do
-            expect(aggregation_spec[:selector][:cursor]).to eq({})
-          end
-        end
+    context 'when batch_size is set' do
 
+      let(:options) do
+        { :batch_size => 10 }
       end
 
-      context 'when use_cursor is false' do
+      it 'sets a batch size document in the spec' do
+        expect(aggregation_spec[:selector][:cursor][:batchSize]).to eq(options[:batch_size])
+      end
+    end
 
-        let(:options) do
-          { :use_cursor => false }
-        end
+    context 'when batch_size is not set' do
 
-        context 'when batch_size is set' do
+      let(:options) do
+        {}
+      end
 
-          it 'does not set the cursor option in the spec' do
-            expect(aggregation_spec[:selector][:cursor]).to be_nil
-          end
-        end
+      it 'sets an empty document in the spec' do
+        expect(aggregation_spec[:selector][:cursor]).to eq({})
       end
     end
   end