mongo 2.15.0 → 2.17.0

data/lib/mongo/uri/srv_protocol.rb

@@ -80,7 +80,7 @@ module Mongo
       DOT_PARTITION = '.'.freeze
 
       # @return [ Array<String> ] VALID_TXT_OPTIONS The valid options for a TXT record to specify.
-      VALID_TXT_OPTIONS = ['replicaset', 'authsource'].freeze
+      VALID_TXT_OPTIONS = %w(replicaset authsource loadbalanced).freeze
 
       # @return [ String ] INVALID_HOST Error message format string indicating that the hostname in
       #   in the URI does not fit the expected form.
@@ -102,11 +102,6 @@ module Mongo
       #   were found.
       NO_SRV_RECORDS = "The DNS query returned no SRV records for '%s'".freeze
 
-      # @return [ String ] INVALID_TXT_RECORD_OPTION Error message format string indicating that an
-      #   unexpected TXT record option was found.
-      INVALID_TXT_RECORD_OPTION = "TXT records can only specify the options " +
-                                    "[#{VALID_TXT_OPTIONS.join(', ')}].".freeze
-
       # @return [ String ] FORMAT The expected SRV URI format.
       FORMAT = 'mongodb+srv://[username:password@]host[/[database][?options]]'.freeze
 
@@ -222,8 +217,11 @@ module Mongo
       def parse_txt_options!(string)
         string.split(INDIV_URI_OPTS_DELIM).reduce({}) do |txt_options, opt|
           raise Error::InvalidTXTRecord.new(INVALID_OPTS_VALUE_DELIM) unless opt.index(URI_OPTS_VALUE_DELIM)
-          key, value = opt.split(URI_OPTS_VALUE_DELIM)
-          raise Error::InvalidTXTRecord.new(INVALID_TXT_RECORD_OPTION) unless VALID_TXT_OPTIONS.include?(key.downcase)
+          key, value = opt.split('=')
+          unless VALID_TXT_OPTIONS.include?(key.downcase)
+            msg = "TXT records can only specify the options [#{VALID_TXT_OPTIONS.join(', ')}]: #{string}"
+            raise Error::InvalidTXTRecord.new(msg)
+          end
           options_mapper.add_uri_option(key, value, txt_options)
           txt_options
         end

data/lib/mongo/uri.rb

@@ -520,6 +520,24 @@ module Mongo
       elsif uri_options[:direct_connection] == false && uri_options[:connect].to_s == 'direct'
         raise_invalid_error_no_fmt!("directConnection=false cannot be used with connect=direct")
       end
+
+      if uri_options[:load_balanced]
+        if servers.length > 1
+          raise_invalid_error_no_fmt!("loadBalanced=true cannot be used with multiple seeds")
+        end
+
+        if uri_options[:direct_connection]
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with loadBalanced=true")
+        end
+
+        if uri_options[:connect] && uri_options[:connect].to_sym == :direct
+          raise_invalid_error_no_fmt!("connect=direct cannot be used with loadBalanced=true")
+        end
+
+        if uri_options[:replica_set]
+          raise_invalid_error_no_fmt!("loadBalanced=true cannot be used with replicaSet option")
+        end
+      end
     end
   end
 end

data/lib/mongo/utils.rb

@@ -101,18 +101,5 @@ module Mongo
     module_function def monotonic_time
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
-
-    # Hash#compact implementation for Ruby 2.3
-    module_function def compact_hash(hash)
-      Hash[hash.reject do |k, v|
-        v.nil?
-      end]
-    end
-
-    # Hash#compact implementation for Ruby 2.3/2.4
-    # Implementation based on activesupport 5.2.3
-    module_function def slice_hash(hash, *keys)
-      keys.each_with_object({}) { |k, res| res[k] = hash[k] if hash.key?(k) }
-    end
   end
 end

data/lib/mongo/version.rb

@@ -20,5 +20,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.15.0'.freeze
+  VERSION = '2.17.0'.freeze
 end

data/mongo.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.require_paths     = ['lib']
   s.bindir            = 'bin'
 
-  s.required_ruby_version = ">= 2.3"
+  s.required_ruby_version = ">= 2.5"
 
   s.add_dependency 'bson', '>=4.8.2', '<5.0.0'
 end

data/spec/integration/auth_spec.rb

@@ -14,7 +14,7 @@ describe 'Auth' do
     end
 
     let(:base_options) do
-      SpecConfig.instance.monitoring_options
+      SpecConfig.instance.monitoring_options.merge(connect: SpecConfig.instance.test_options[:connect])
     end
 
     let(:connection) do
@@ -276,4 +276,34 @@ describe 'Auth' do
       client.database.command(ping: 1)
     end
   end
+
+  context 'in lb topology' do
+    require_topology :load_balanced
+
+    context 'when authentication fails with network error' do
+      let(:server) do
+        authorized_client.cluster.next_primary
+      end
+
+      let(:base_options) do
+        SpecConfig.instance.monitoring_options.merge(connect: SpecConfig.instance.test_options[:connect])
+      end
+
+      let(:connection) do
+        Mongo::Server::Connection.new(server, base_options)
+      end
+
+      it 'includes service id in exception' do
+        expect_any_instance_of(Mongo::Server::PendingConnection).to receive(:authenticate!).and_raise(Mongo::Error::SocketError)
+
+        begin
+          connection.connect!
+        rescue Mongo::Error::SocketError => exc
+          exc.service_id.should_not be nil
+        else
+          fail 'Expected the SocketError to be raised'
+        end
+      end
+    end
+  end
 end

data/spec/integration/awaited_ismaster_spec.rb

@@ -9,7 +9,7 @@ describe 'awaited hello' do
   # If we send the consecutive hello commands to different mongoses,
   # they have different process ids, and so the awaited one would return
   # immediately.
-  require_no_multi_shard
+  require_no_multi_mongos
 
   let(:client) { authorized_client }
 

data/spec/integration/bulk_write_spec.rb

@@ -21,7 +21,7 @@ describe 'Bulk writes' do
   end
 
   context 'when bulk write needs to be split' do
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:max_bson_size) { Mongo::Server::ConnectionBase::DEFAULT_MAX_BSON_OBJECT_SIZE }
 

data/spec/integration/change_stream_spec.rb

@@ -53,7 +53,7 @@ describe 'Change stream integration', retry: 4 do
       it 'raises an exception and does not attempt to resume' do
         change_stream
 
-        subscriber = EventSubscriber.new
+        subscriber = Mrss::EventSubscriber.new
         authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
 
         expect do
@@ -523,7 +523,7 @@ describe 'Change stream integration', retry: 4 do
     let(:events) do
       start_after
 
-      subscriber = EventSubscriber.new
+      subscriber = Mrss::EventSubscriber.new
       authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
       use_stream
 
@@ -582,7 +582,7 @@ describe 'Change stream integration', retry: 4 do
     let(:stream) { authorized_collection.watch }
 
     let(:events) do
-      subscriber = EventSubscriber.new
+      subscriber = Mrss::EventSubscriber.new
       authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
       use_stream
       subscriber.succeeded_events.select { |e|

data/spec/integration/client_construction_spec.rb

@@ -236,4 +236,58 @@ describe 'Client construction' do
       expect(client.cluster.addresses).to eq([Mongo::Address.new(primary_address)])
     end
   end
+
+  context 'when deployment is not a sharded cluster' do
+    require_topology :single, :replica_set
+
+    let(:client) do
+      ClientRegistry.instance.new_local_client(
+        [SpecConfig.instance.addresses.first],
+        SpecConfig.instance.test_options.merge(options),
+      )
+    end
+
+    context 'when load-balanced topology is requested' do
+      let(:options) do
+        {connect: :load_balanced, replica_set: nil}
+      end
+
+      it 'creates the client successfully' do
+        client.should be_a(Mongo::Client)
+      end
+
+      it 'fails all operations' do
+        lambda do
+          client.command(ping: true)
+        end.should raise_error(Mongo::Error::BadLoadBalancerTarget)
+      end
+    end
+  end
+
+  context 'when in load-balanced mode' do
+    require_topology :load_balanced
+
+    let(:client) do
+      ClientRegistry.instance.new_local_client(
+        [SpecConfig.instance.addresses.first],
+        SpecConfig.instance.test_options.merge(options),
+      )
+    end
+
+    context 'when load-balanced topology is requested via the URI option' do
+      let(:options) do
+        {connect: nil, load_balanced: true}
+      end
+
+      it 'creates the client successfully' do
+        client.should be_a(Mongo::Client)
+      end
+
+      it 'fails all operations' do
+        lambda do
+          client.command(ping: true)
+        end.should raise_error(Mongo::Error::MissingServiceId)
+      end
+    end
+  end
 end

data/spec/integration/client_side_encryption/auto_encryption_bulk_writes_spec.rb

@@ -11,7 +11,7 @@ describe 'Bulk writes with auto-encryption enabled' do
   include_context 'define shared FLE helpers'
   include_context 'with local kms_providers'
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
 
   let(:client) do
     new_local_client(

data/spec/integration/client_side_encryption/auto_encryption_command_monitoring_spec.rb

@@ -15,7 +15,7 @@ describe 'Auto Encryption' do
   include_context 'define shared FLE helpers'
   include_context 'with local kms_providers'
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
   let(:db_name) { 'auto_encryption' }
 
   let(:encryption_client) do

data/spec/integration/client_side_encryption/bson_size_limit_spec.rb

@@ -11,7 +11,7 @@ describe 'Client-Side Encryption' do
 
     include_context 'define shared FLE helpers'
 
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:client) do
       authorized_client.use('db')

data/spec/integration/client_side_encryption/data_key_spec.rb

@@ -11,7 +11,7 @@ describe 'Client-Side Encryption' do
 
     include_context 'define shared FLE helpers'
 
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:client) do
       new_local_client(

data/spec/integration/client_spec.rb

@@ -21,6 +21,8 @@ describe 'Client' do
     end
 
     context 'after all servers are marked unknown' do
+      require_topology :single, :replica_set, :sharded
+
       before do
         client.cluster.servers.each do |server|
           server.unknown!

data/spec/integration/command_monitoring_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 
 describe 'Command monitoring' do
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
 
   let(:client) do
     authorized_client.with(app_name: 'command monitoring spec').tap do |client|

data/spec/integration/command_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 
 describe 'Command' do
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
 
   describe 'payload' do
     let(:server) { authorized_client.cluster.next_primary }

data/spec/integration/connection_spec.rb

@@ -50,7 +50,7 @@ describe 'Connections' do
 
       context 'with sdam event subscription' do
 
-        let(:subscriber) { EventSubscriber.new }
+        let(:subscriber) { Mrss::EventSubscriber.new }
         let(:client) do
           ClientRegistry.instance.global_client('authorized').with(app_name: 'connection_integration').tap do |client|
             client.subscribe(Mongo::Monitoring::SERVER_OPENING, subscriber)
@@ -246,43 +246,60 @@ describe 'Connections' do
 
       let(:client) { ClientRegistry.instance.global_client('authorized').with(app_name: 'wire_protocol_update') }
 
-      it 'updates on hello response from non-monitoring connections' do
-        # connect server
-        client['test'].insert_one(test: 1)
+      context 'non-lb' do
+        require_topology :single, :replica_set, :sharded
 
-        # kill background threads so that they are not interfering with
-        # our mocked hello response
-        client.cluster.servers.each do |server|
-          server.monitor.stop!
+        it 'updates on handshake response from non-monitoring connections' do
+          # connect server
+          client['test'].insert_one(test: 1)
+
+          # kill background threads so that they are not interfering with
+          # our mocked hello response
+          client.cluster.servers.each do |server|
+            server.monitor.stop!
+          end
+
+          server = client.cluster.servers.first
+          expect(server.features.server_wire_versions.max >= 4).to be true
+          max_version = server.features.server_wire_versions.max
+
+          # Depending on server version, handshake here may return a
+          # description that compares equal to the one we got from a
+          # monitoring connection (pre-4.2) or not (4.2+).
+          # Since we do run SDAM flow on handshake responses on
+          # non-monitoring connections, force descriptions to be different
+          # by setting the existing description here to unknown.
+          server.monitor.instance_variable_set('@description',
+            Mongo::Server::Description.new(server.address))
+
+          RSpec::Mocks.with_temporary_scope do
+            # now pretend a handshake returned a different range
+            features = Mongo::Server::Description::Features.new(0..3)
+            # One Features instantiation is for SDAM event publication, this
+            # one always happens. The second one happens on servers
+            # where we do not negotiate auth mechanism.
+            expect(Mongo::Server::Description::Features).to receive(:new).at_least(:once).and_return(features)
+
+            connection = Mongo::Server::Connection.new(server, server.options)
+            expect(connection.connect!).to be true
+
+            # hello response should update server description via sdam flow,
+            # which includes wire version range
+            expect(server.features.server_wire_versions.max).to eq(3)
+          end
         end
+      end
+
+      context 'lb' do
+        require_topology :load_balanced
+
+        it 'does not update on handshake response from non-monitoring connections since there are not any' do
+          # connect server
+          client['test'].insert_one(test: 1)
 
-        server = client.cluster.servers.first
-        expect(server.features.server_wire_versions.max >= 4).to be true
-        max_version = server.features.server_wire_versions.max
-
-        # Depending on server version, hello here may return a
-        # description that compares equal to the one we got from a
-        # monitoring connection (pre-4.2) or not (4.2+).
-        # Since we do run SDAM flow on hello responses on
-        # non-monitoring connections, force descriptions to be different
-        # by setting the existing description here to unknown.
-        server.monitor.instance_variable_set('@description',
-          Mongo::Server::Description.new(server.address))
-
-        RSpec::Mocks.with_temporary_scope do
-          # now pretend a hello returned a different range
-          features = Mongo::Server::Description::Features.new(0..3)
-          # One Features instantiation is for SDAM event publication, this
-          # one always happens. The second one happens on servers
-          # where we do not negotiate auth mechanism.
-          expect(Mongo::Server::Description::Features).to receive(:new).at_least(:once).and_return(features)
-
-          connection = Mongo::Server::Connection.new(server, server.options)
-          expect(connection.connect!).to be true
-
-          # hello response should update server description via sdam flow,
-          # which includes wire version range
-          expect(server.features.server_wire_versions.max).to eq(3)
+          server = client.cluster.servers.first
+          server.load_balancer?.should be true
+          server.features.server_wire_versions.max.should be 0
         end
       end
     end

data/spec/integration/crud_spec.rb

@@ -4,7 +4,8 @@
 require 'spec_helper'
 
 describe 'CRUD operations' do
-  let(:collection) { authorized_client['crud_integration'] }
+  let(:client) { authorized_client }
+  let(:collection) { client['crud_integration'] }
 
   before do
     collection.delete_many
@@ -64,6 +65,178 @@ describe 'CRUD operations' do
         end
       end
     end
+
+    context 'with read concern' do
+      # Read concern requires 3.2+ server.
+      min_server_fcv '3.2'
+
+      context 'with read concern specified on operation level' do
+
+        it 'passes the read concern' do
+          event = Utils.get_command_event(client, 'find') do |client|
+            client['foo'].find({}, read_concern: {level: :local}).to_a
+          end
+          event.command.fetch('readConcern').should == {'level' => 'local'}
+        end
+      end
+
+      context 'with read concern specified on collection level' do
+
+        it 'passes the read concern' do
+          event = Utils.get_command_event(client, 'find') do |client|
+            client['foo', read_concern: {level: :local}].find.to_a
+          end
+          event.command.fetch('readConcern').should == {'level' => 'local'}
+        end
+      end
+
+      context 'with read concern specified on client level' do
+
+        let(:client) { authorized_client.with(read_concern: {level: :local}) }
+
+        it 'passes the read concern' do
+          event = Utils.get_command_event(client, 'find') do |client|
+            client['foo'].find.to_a
+          end
+          event.command.fetch('readConcern').should == {'level' => 'local'}
+        end
+      end
+    end
+
+    context 'with oplog_replay option' do
+      let(:collection_name) { 'crud_integration_oplog_replay' }
+
+      let(:oplog_query) do
+        {ts: {'$gt' => 1}}
+      end
+
+      context 'passed to operation' do
+        it 'passes the option' do
+          event = Utils.get_command_event(client, 'find') do |client|
+            client[collection_name].find(oplog_query, oplog_replay: true).to_a
+          end
+          event.command.fetch('oplogReplay').should be true
+        end
+
+        it 'warns' do
+          client.should receive(:log_warn).with('The :oplog_replay option is deprecated and ignored by MongoDB 4.4 and later')
+          client[collection_name].find(oplog_query, oplog_replay: true).to_a
+        end
+      end
+
+      context 'set on collection' do
+        it 'passes the option' do
+          event = Utils.get_command_event(client, 'find') do |client|
+            client[collection_name, oplog_replay: true].find(oplog_query).to_a
+          end
+          event.command.fetch('oplogReplay').should be true
+        end
+
+        it 'warns' do
+          client.should receive(:log_warn).with('The :oplog_replay option is deprecated and ignored by MongoDB 4.4 and later')
+          client[collection_name, oplog_replay: true].find(oplog_query).to_a
+        end
+      end
+    end
+  end
+
+  describe 'explain' do
+    context 'with explicit session' do
+      min_server_fcv '3.6'
+
+      it 'passes the session' do
+        client.start_session do |session|
+          event = Utils.get_command_event(client, 'explain') do |client|
+            client['foo'].find({}, session: session).explain.should be_explain_output
+          end
+          event.command.fetch('lsid').should == session.session_id
+        end
+      end
+    end
+
+    context 'with read preference specified on operation level' do
+      require_topology :sharded
+
+      # RUBY-2706
+      min_server_fcv '3.6'
+
+      it 'passes the read preference' do
+        event = Utils.get_command_event(client, 'explain') do |client|
+          client['foo'].find({}, read: {mode: :secondary_preferred}).explain.should be_explain_output
+        end
+        event.command.fetch('$readPreference').should == {'mode' => 'secondaryPreferred'}
+      end
+    end
+
+    context 'with read preference specified on collection level' do
+      require_topology :sharded
+
+      # RUBY-2706
+      min_server_fcv '3.6'
+
+      it 'passes the read preference' do
+        event = Utils.get_command_event(client, 'explain') do |client|
+          client['foo', read: {mode: :secondary_preferred}].find.explain.should be_explain_output
+        end
+        event.command.fetch('$readPreference').should == {'mode' => 'secondaryPreferred'}
+      end
+    end
+
+    context 'with read preference specified on client level' do
+      require_topology :sharded
+
+      # RUBY-2706
+      min_server_fcv '3.6'
+
+      let(:client) { authorized_client.with(read: {mode: :secondary_preferred}) }
+
+      it 'passes the read preference' do
+        event = Utils.get_command_event(client, 'explain') do |client|
+          client['foo'].find.explain.should be_explain_output
+        end
+        event.command.fetch('$readPreference').should == {'mode' => 'secondaryPreferred'}
+      end
+    end
+
+    context 'with read concern' do
+      # Read concern requires 3.2+ server.
+      min_server_fcv '3.2'
+
+      context 'with read concern specifed on operation level' do
+
+        # Read concern is not allowed in explain command, driver drops it.
+        it 'drops the read concern' do
+          event = Utils.get_command_event(client, 'explain') do |client|
+            client['foo'].find({}, read_concern: {level: :local}).explain.should have_key('queryPlanner')
+          end
+          event.command.should_not have_key('readConcern')
+        end
+      end
+
+      context 'with read concern specifed on collection level' do
+
+        # Read concern is not allowed in explain command, driver drops it.
+        it 'drops the read concern' do
+          event = Utils.get_command_event(client, 'explain') do |client|
+            client['foo', read_concern: {level: :local}].find.explain.should have_key('queryPlanner')
+          end
+          event.command.should_not have_key('readConcern')
+        end
+      end
+
+      context 'with read concern specifed on client level' do
+
+        let(:client) { authorized_client.with(read_concern: {level: :local}) }
+
+        # Read concern is not allowed in explain command, driver drops it.
+        it 'drops the read concern' do
+          event = Utils.get_command_event(client, 'explain') do |client|
+            client['foo'].find.explain.should have_key('queryPlanner')
+          end
+          event.command.should_not have_key('readConcern')
+        end
+      end
+    end
   end
 
   describe 'insert' do