mongo 2.13.0.beta1 → 2.13.0.rc1

data/lib/mongo/server_selector/nearest.rb

@@ -20,7 +20,6 @@ module Mongo
     #
     # @since 2.0.0
     class Nearest < Base
-      include Selectable
 
       # Name of the this read preference in the server's format.
       #
@@ -92,14 +91,10 @@ module Mongo
       # Select the near servers taking into account any defined tag sets and
       #   local threshold between the nearest server and other servers.
       #
-      # @example Select nearest servers given a list of candidates.
-      #   preference = Mongo::ServerSelector::Nearest.new
-      #   preference.select_server(cluster)
-      #
       # @return [ Array ] The nearest servers from the list of candidates.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         matching_servers = filter_stale_servers(candidates, primary(candidates).first)
         matching_servers = match_tag_sets(matching_servers) unless tag_sets.empty?
         near_servers(matching_servers)

data/lib/mongo/server_selector/primary.rb

@@ -21,7 +21,6 @@ module Mongo
     #
     # @since 2.0.0
     class Primary < Base
-      include Selectable
 
       # Name of the this read preference in the server's format.
       #
@@ -94,14 +93,10 @@ module Mongo
 
       # Select the primary server from a list of candidates.
       #
-      # @example Select the primary server given a list of candidates.
-      #   preference = Mongo::ServerSelector::Primary.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] The primary server from the list of candidates.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         primary(candidates)
       end
 

data/lib/mongo/server_selector/primary_preferred.rb

@@ -21,7 +21,6 @@ module Mongo
     #
     # @since 2.0.0
     class PrimaryPreferred < Base
-      include Selectable
 
       # Name of the this read preference in the server's format.
       #
@@ -93,19 +92,17 @@ module Mongo
       # Select servers taking into account any defined tag sets and
       #   local threshold, with the primary preferred.
       #
-      # @example Select servers given a list of candidates,
-      #   with the primary preferred.
-      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] A list of servers matching tag sets and acceptable
       #   latency with the primary preferred.
       #
       # @since 2.0.0
-      def select(candidates)
-        primary = primary(candidates)
-        secondaries = near_servers(secondaries(candidates))
-        primary.first ? primary : secondaries
+      def select_in_replica_set(candidates)
+        primaries = primary(candidates)
+        if primaries.first
+          primaries
+        else
+          near_servers(secondaries(candidates))
+        end
       end
 
       def max_staleness_allowed?

data/lib/mongo/server_selector/secondary.rb

@@ -21,7 +21,6 @@ module Mongo
     #
     # @since 2.0.0
     class Secondary < Base
-      include Selectable
 
       # Name of the this read preference in the server's format.
       #
@@ -93,14 +92,10 @@ module Mongo
       # Select the secondary servers taking into account any defined tag sets and
       #   local threshold between the nearest secondary and other secondaries.
       #
-      # @example Select secondary servers given a list of candidates.
-      #   preference = Mongo::ServerSelector::Secondary.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] The secondary servers from the list of candidates.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         near_servers(secondaries(candidates))
       end
 

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -21,7 +21,6 @@ module Mongo
     #
     # @since 2.0.0
     class SecondaryPreferred < Base
-      include Selectable
 
       # Name of the this read preference in the server's format.
       #
@@ -101,16 +100,11 @@ module Mongo
       # Select servers taking into account any defined tag sets and
       #   local threshold, with secondaries.
       #
-      # @example Select servers given a list of candidates,
-      #   with secondaries preferred.
-      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] A list of servers matching tag sets and acceptable
       #   latency with secondaries preferred.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         near_servers(secondaries(candidates)) + primary(candidates)
       end
 

data/lib/mongo/session.rb

@@ -227,7 +227,9 @@ module Mongo
     # Error message describing that sessions are not supported by the server version.
     #
     # @since 2.5.0
+    # @deprecated
     SESSIONS_NOT_SUPPORTED = 'Sessions are not supported by the connected servers.'.freeze
+    # Note: SESSIONS_NOT_SUPPORTED is used by Mongoid - do not remove from driver.
 
     # The state of a session in which the last operation was not related to
     # any transaction or no operations have yet occurred.

data/lib/mongo/socket.rb

@@ -21,6 +21,7 @@ module Mongo
   # Provides additional data around sockets for the driver's use.
   #
   # @since 2.0.0
+  # @api private
   class Socket
     include ::Socket::Constants
 
@@ -105,9 +106,14 @@ module Mongo
     def summary
       fileno = @socket&.fileno rescue '<no socket>' || '<no socket>'
       if monitor?
-        "#{connection_address}:m #{fileno}"
+        indicator = if options[:push]
+          'pm'
+        else
+          'm'
+        end
+        "#{connection_address};#{indicator};fd=#{fileno}"
       else
-        "#{connection_address}:c:#{connection_generation} #{fileno}"
+        "#{connection_address};c:#{connection_generation};fd=#{fileno}"
       end
     end
 
@@ -173,20 +179,21 @@ module Mongo
     #   socket.read(4096)
     #
     # @param [ Integer ] length The number of bytes to read.
+    # @param [ Numeric ] timeout The timeout to use for each chunk read.
     #
     # @raise [ Mongo::SocketError ] If not all data is returned.
     #
     # @return [ Object ] The data from the socket.
     #
     # @since 2.0.0
-    def read(length)
+    def read(length, timeout: nil)
       map_exceptions do
-        data = read_from_socket(length)
+        data = read_from_socket(length, timeout: timeout)
         unless (data.length > 0 || length == 0)
           raise IOError, "Expected to read > 0 bytes but read 0 bytes"
         end
         while data.length < length
-          chunk = read_from_socket(length - data.length)
+          chunk = read_from_socket(length - data.length, timeout: timeout)
           unless (chunk.length > 0 || length == 0)
             raise IOError, "Expected to read > 0 bytes but read 0 bytes"
           end
@@ -243,14 +250,19 @@ module Mongo
 
     private
 
-    def read_from_socket(length)
+    def read_from_socket(length, timeout: nil)
       # Just in case
       if length == 0
         return ''.force_encoding('BINARY')
       end
 
-      if _timeout = self.timeout
-        deadline = Time.now + _timeout
+      _timeout = timeout || self.timeout
+      if _timeout
+        if _timeout > 0
+          deadline = Time.now + _timeout
+        elsif _timeout < 0
+          raise Errno::ETIMEDOUT, "Negative timeout #{_timeout} given to socket"
+        end
       end
 
       # We want to have a fixed and reasonably small size buffer for reads

data/lib/mongo/socket/ssl.rb

@@ -137,7 +137,7 @@ module Mongo
       #
       # @since 2.0.0
       def connect!
-        Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError) do
+        Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError, "The socket took over #{options[:connect_timeout]} seconds to connect") do
           map_exceptions do
             @tcp_socket.connect(::Socket.pack_sockaddr_in(port, host))
           end

data/lib/mongo/socket/tcp.rb

@@ -74,7 +74,7 @@ module Mongo
       #
       # @since 2.0.0
       def connect!
-        Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError) do
+        Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError, "The socket took over #{options[:connect_timeout]} seconds to connect") do
           socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
           map_exceptions do
             socket.connect(::Socket.pack_sockaddr_in(port, host))

data/lib/mongo/topology_version.rb

@@ -76,5 +76,14 @@ module Mongo
         counter >= other.counter
       end
     end
+
+    # Converts the object to a document suitable for being sent to the server.
+    #
+    # @return [ BSON::Document ] The document.
+    #
+    # @api private
+    def to_doc
+      BSON::Document.new(self).merge(counter: BSON::Int64.new(counter))
+    end
   end
 end

data/lib/mongo/utils.rb

@@ -0,0 +1,62 @@
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  # @api private
+  module Utils
+
+    class LocalLogger
+      include Loggable
+
+      def initialize(**opts)
+        @options = opts
+      end
+
+      attr_reader :options
+    end
+
+    # @option opts [ true | false | nil | Integer ] :bg_error_backtrace
+    #   Experimental. Set to true to log complete backtraces for errors in
+    #   background threads. Set to false or nil to not log backtraces. Provide
+    #   a positive integer to log up to that many backtrace lines.
+    # @option opts [ Logger ] :logger A custom logger to use.
+    # @option opts [ String ] :log_prefix A custom log prefix to use when
+    #   logging.
+    module_function def warn_monitor_exception(msg, exc, **opts)
+      bt_excerpt = excerpt_backtrace(exc, **opts)
+      logger = LocalLogger.new(**opts)
+      logger.log_warn("#{msg}: #{exc.class}: #{exc}#{bt_excerpt}")
+    end
+
+    # @option opts [ true | false | nil | Integer ] :bg_error_backtrace
+    #   Experimental. Set to true to log complete backtraces for errors in
+    #   background threads. Set to false or nil to not log backtraces. Provide
+    #   a positive integer to log up to that many backtrace lines.
+    module_function def excerpt_backtrace(exc, **opts)
+      case lines = opts[:bg_error_backtrace]
+      when Integer
+        ":\n#{exc.backtrace[0..lines].join("\n")}"
+      when false, nil
+        nil
+      else
+        ":\n#{exc.backtrace.join("\n")}"
+      end
+    end
+
+    module_function def shallow_symbolize_keys(hash)
+      Hash[hash.map { |k, v| [k.to_sym, v] }]
+    end
+  end
+end

data/lib/mongo/version.rb

@@ -17,5 +17,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.13.0.beta1'
+  VERSION = '2.13.0.rc1'.freeze
 end

data/spec/README.aws-auth.md

@@ -233,7 +233,7 @@ To provision the instance for running the driver's test suite via Docker, run:
 To run the AWS auth tests using the EC2 instance role credentials, run:
 
     ./.evergreen/test-docker-remote ubuntu@$ip \
-      MONGODB_VERSION=4.3 AUTH=aws-ec2 \
+      MONGODB_VERSION=4.4 AUTH=aws-ec2 \
       -s .evergreen/run-tests-aws-auth.sh \
       -a .env.private
 
@@ -299,7 +299,7 @@ If the public IP address is in the `IP` shell variable, provision the task:
 
 To run the credentials retrieval test on the ECS task, execute:
 
-    ./.evergreen/test-remote root@$IP env AUTH=aws-ecs RVM_RUBY=ruby-2.7 MONGODB_VERSION=4.3 TEST_CMD='rspec spec/integration/aws*spec.rb' .evergreen/run-tests.sh
+    ./.evergreen/test-remote root@$IP env AUTH=aws-ecs RVM_RUBY=ruby-2.7 MONGODB_VERSION=4.4 TEST_CMD='rspec spec/integration/aws*spec.rb' .evergreen/run-tests.sh
 
 To run the test again without rebuilding the remote environment, execute:
 

data/spec/integration/awaited_ismaster_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'awaited ismaster' do
+  min_server_fcv '4.4'
+
+  # If we send the consecutive ismasters to different mongoses,
+  # they have different process ids, and so the awaited one would return
+  # immediately.
+  require_no_multi_shard
+
+  let(:client) { authorized_client }
+
+  it 'waits' do
+    # Perform a regular ismaster to get topology version
+    resp = client.database.command(ismaster: 1)
+    doc = resp.replies.first.documents.first
+    tv = Mongo::TopologyVersion.new(doc['topologyVersion'])
+    tv.should be_a(BSON::Document)
+
+    elapsed_time = Benchmark.realtime do
+      resp = client.database.command(ismaster: 1,
+        topologyVersion: tv.to_doc, maxAwaitTimeMS: 500)
+    end
+    doc = resp.replies.first.documents.first
+
+    elapsed_time.should > 0.5
+  end
+end

data/spec/integration/change_stream_examples_spec.rb

@@ -174,8 +174,10 @@ describe 'change streams examples in Ruby' do
 
         # Start Changestream Example 4
 
-        pipeline = [ {'$match' => { '$or' => [{ 'fullDocument.username' => 'alice' },
-                                              { 'operationType' => 'delete' }] } }]
+        pipeline = [
+          { "$match" => { 'fullDocument.username' => 'alice' } },
+          { "$addFields" => { 'newField' => 'this is an added field!' } }
+        ];
         cursor = inventory.watch(pipeline).to_enum
         cursor.next
 
@@ -191,6 +193,8 @@ describe 'change streams examples in Ruby' do
       expect(change['fullDocument']).not_to be_nil
       expect(change['fullDocument']['_id']).not_to be_nil
       expect(change['fullDocument']['username']).to eq('alice')
+      expect(change['newField']).not_to be_nil
+      expect(change['newField']).to eq('this is an added field!')
       expect(change['ns']).not_to be_nil
       expect(change['ns']['db']).to eq(SpecConfig.instance.test_db)
       expect(change['ns']['coll']).to eq(inventory.name)

data/spec/integration/check_clean_slate_spec.rb

@@ -0,0 +1,16 @@
+require 'lite_spec_helper'
+
+# This test can be used to manually verify that there are no leaked
+# background threads - execute it after executing another test (in the same
+# rspec run) that is suspected to leak background threads, such as by
+# running:
+#
+# rspec your_spec.rb spec/integration/check_clean_slate_spec.rb
+
+describe 'Check clean slate' do
+  clean_slate_for_all_if_possible
+
+  it 'checks' do
+    # Nothing
+  end
+end

data/spec/integration/client_construction_spec.rb

@@ -10,6 +10,7 @@ describe 'Client construction' do
     ).merge(SpecConfig.instance.credentials_or_external_user(
       user: SpecConfig.instance.test_user.name,
       password: SpecConfig.instance.test_user.password,
+      auth_source: 'admin',
     ))
   end
 

data/spec/integration/connect_single_rs_name_spec.rb

@@ -18,7 +18,9 @@ describe 'Direct connection with RS name' do
     new_local_client(
       [SpecConfig.instance.addresses.first],
       SpecConfig.instance.test_options.merge(
-        replica_set: replica_set_name, connect: :direct))
+        replica_set: replica_set_name, connect: :direct,
+        server_selection_timeout: 3.32,
+      ))
   end
 
   context 'in replica set' do
@@ -31,7 +33,8 @@ describe 'Direct connection with RS name' do
 
       it 'creates a working client' do
         expect do
-          client.database.command(ismaster: 1)
+          res = client.database.command(ismaster: 1)
+          p res
         end.not_to raise_error
       end
     end

data/spec/integration/connection_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'runners/sdam_monitoring'
 
 describe 'Connections' do
   clean_slate
@@ -26,6 +25,9 @@ describe 'Connections' do
       # RSpec::Expectations::ExpectationNotMetError: expected Mongo::Error::SocketError, got #<NameError: undefined method `write' for class `Mongo::Socket'>
       fails_on_jruby
 
+      # 4.4 has two monitors and thus our socket mocks get hit twice
+      max_server_version '4.2'
+
       let(:exception) { Mongo::Error::SocketError }
 
       let(:error) do
@@ -44,7 +46,8 @@ describe 'Connections' do
       end
 
       context 'with sdam event subscription' do
-        let(:subscriber) { Mongo::SDAMMonitoring::TestSubscriber.new }
+
+        let(:subscriber) { 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)
@@ -56,12 +59,12 @@ describe 'Connections' do
         end
 
         it 'publishes server description changed event' do
-          expect(subscriber.events).to be_empty
+          expect(subscriber.succeeded_events).to be_empty
 
           wait_for_all_servers(client.cluster)
 
           connection
-          subscriber.events.clear
+          subscriber.succeeded_events.clear
           error
 
           event = subscriber.first_event('server_description_changed_event')