mongo 2.12.1 → 2.13.0

data/lib/mongo/client_encryption.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-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.

data/lib/mongo/cluster.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -76,6 +76,16 @@ module Mongo
     # @param [ Hash ] options Options. Client constructor forwards its
     #   options to Cluster constructor, although Cluster recognizes
     #   only a subset of the options recognized by Client.
+    #
+    # @option options [ true | false ] :direct_connection Whether to connect
+    #   directly to the specified seed, bypassing topology discovery. Exactly
+    #   one seed must be provided.
+    # @option options [ Symbol ] :connect Deprecated - use :direct_connection
+    #   option instead of this option. The connection method to use. This
+    #   forces the cluster to behave in the specified way instead of
+    #   auto-discovering. One of :direct, :replica_set, :sharded
+    # @option options [ Symbol ] :replica_set The name of the replica set to
+    #   connect to. Servers not in this replica set will be ignored.
     # @option options [ true | false ] :scan Whether to scan all seeds
     #   in constructor. The default in driver version 2.x is to do so;
     #   driver version 3.x will not scan seeds in constructor. Opt in to the
@@ -104,25 +114,39 @@ module Mongo
         raise ArgumentError, 'Seeds cannot be nil'
       end
 
+      options = options.dup
       if options[:monitoring_io] == false && !options.key?(:cleanup)
-        options = options.dup
         options[:cleanup] = false
       end
+      @options = options.freeze
 
-      seeds = seeds.uniq
-
+      # @update_lock covers @servers, @connecting, @connected, @topology and
+      # @sessions_supported. Generally instance variables that do not have a
+      # designated for them lock should only be modified under the update lock.
+      # Note that topology change is locked by @update_lock and not by
+      # @sdam_flow_lock.
+      @update_lock = Mutex.new
       @servers = []
       @monitoring = monitoring
       @event_listeners = Event::Listeners.new
-      @options = options.freeze
       @app_metadata = Server::AppMetadata.new(@options)
-      @update_lock = Mutex.new
-      @sdam_flow_lock = Mutex.new
-      @cluster_time = nil
       @cluster_time_lock = Mutex.new
+      @cluster_time = nil
       @srv_monitor_lock = Mutex.new
+      @srv_monitor = nil
       @server_selection_semaphore = Semaphore.new
       @topology = Topology.initial(self, monitoring, options)
+      # State change lock is similar to the sdam flow lock, but is designed
+      # to serialize state changes initated by consumers of Cluster
+      # (e.g. application connecting or disconnecting the cluster), so that
+      # e.g. an application calling disconnect-connect-disconnect rapidly
+      # does not put the cluster into an inconsistent state.
+      # Monitoring updates performed internally by the driver do not take
+      # the state change lock.
+      @state_change_lock = Mutex.new
+      # @sdam_flow_lock covers just the sdam flow. Note it does not apply
+      # to @topology replacements which are done under @update_lock.
+      @sdam_flow_lock = Mutex.new
       Session::SessionPool.create(self)
 
       # The opening topology is always unknown with no servers.
@@ -134,7 +158,7 @@ module Mongo
         Monitoring::Event::TopologyOpening.new(opening_topology)
       )
 
-      @seeds = seeds
+      @seeds = seeds = seeds.uniq
       servers = seeds.map do |seed|
         # Server opening events must be sent after topology change events.
         # Therefore separate server addition, done here before topoolgy change
@@ -335,7 +359,18 @@ module Mongo
     # @since 2.10.0
     # @api private
     def heartbeat_interval
-      options[:heartbeat_frequency] || Server::Monitor::HEARTBEAT_FREQUENCY
+      options[:heartbeat_frequency] || Server::Monitor::DEFAULT_HEARTBEAT_INTERVAL
+    end
+
+    # Whether the cluster object is in the process of connecting to its cluster.
+    #
+    # @return [ true|false ] Whether the cluster is connecting.
+    #
+    # @api private
+    def connecting?
+      @update_lock.synchronize do
+        !!@connecting
+      end
     end
 
     # Whether the cluster object is connected to its cluster.
@@ -345,7 +380,9 @@ module Mongo
     # @api private
     # @since 2.7.0
     def connected?
-      !!@connected
+      @update_lock.synchronize do
+        !!@connected
+      end
     end
 
     # Get a list of server candidates from the cluster that can have operations
@@ -358,7 +395,7 @@ module Mongo
     #
     # @since 2.0.0
     def servers
-      topology.servers(servers_list.compact).compact
+      topology.servers(servers_list)
     end
 
     # The addresses in the cluster.
@@ -370,7 +407,7 @@ module Mongo
     #
     # @since 2.0.6
     def addresses
-      servers_list.map(&:address).dup
+      servers_list.map(&:address)
     end
 
     # The logical session timeout value in minutes.
@@ -441,32 +478,36 @@ module Mongo
     #
     # @since 2.1.0
     def disconnect!
-      unless @connecting || @connected
-        return true
-      end
-      if options[:cleanup] != false
-        session_pool.end_sessions
-        @periodic_executor.stop!
-      end
-      @srv_monitor_lock.synchronize do
-        if @srv_monitor
-          @srv_monitor.stop!
+      @state_change_lock.synchronize do
+        unless connecting? || connected?
+          return true
         end
-      end
-      @servers.each do |server|
-        if server.connected?
-          server.disconnect!
-          publish_sdam_event(
-            Monitoring::SERVER_CLOSED,
-            Monitoring::Event::ServerClosed.new(server.address, topology)
-          )
+        if options[:cleanup] != false
+          session_pool.end_sessions
+          @periodic_executor.stop!
+        end
+        @srv_monitor_lock.synchronize do
+          if @srv_monitor
+            @srv_monitor.stop!
+          end
+        end
+        @servers.each do |server|
+          if server.connected?
+            server.disconnect!
+            publish_sdam_event(
+              Monitoring::SERVER_CLOSED,
+              Monitoring::Event::ServerClosed.new(server.address, topology)
+            )
+          end
+        end
+        publish_sdam_event(
+          Monitoring::TOPOLOGY_CLOSED,
+          Monitoring::Event::TopologyClosed.new(topology)
+        )
+        @update_lock.synchronize do
+          @connecting = @connected = false
         end
       end
-      publish_sdam_event(
-        Monitoring::TOPOLOGY_CLOSED,
-        Monitoring::Event::TopologyClosed.new(topology)
-      )
-      @connecting = @connected = false
       true
     end
 
@@ -481,19 +522,25 @@ module Mongo
     # @deprecated Use Client#reconnect to reconnect to the cluster instead of
     #   calling this method. This method does not send SDAM events.
     def reconnect!
-      @connecting = true
-      scan!
-      servers.each do |server|
-        server.reconnect!
-      end
-      @periodic_executor.restart!
-      @srv_monitor_lock.synchronize do
-        if @srv_monitor
-          @srv_monitor.run!
+      @state_change_lock.synchronize do
+        @update_lock.synchronize do
+          @connecting = true
+        end
+        scan!
+        servers.each do |server|
+          server.reconnect!
+        end
+        @periodic_executor.restart!
+        @srv_monitor_lock.synchronize do
+          if @srv_monitor
+            @srv_monitor.run!
+          end
+        end
+        @update_lock.synchronize do
+          @connecting = false
+          @connected = true
         end
       end
-      @connecting = false
-      @connected = true
     end
 
     # Force a scan of all known servers in the cluster.
@@ -552,11 +599,14 @@ module Mongo
     #   respective server is cleared. Set this option to true to keep the
     #   existing connection pool (required when handling not master errors
     #   on 4.2+ servers).
+    # @option aptions [ true | false ] :awaited Whether the updated description
+    #   was a result of processing an awaited ismaster.
     #
     # @api private
     def run_sdam_flow(previous_desc, updated_desc, options = {})
       @sdam_flow_lock.synchronize do
-        flow = SdamFlow.new(self, previous_desc, updated_desc)
+        flow = SdamFlow.new(self, previous_desc, updated_desc,
+          awaited: options[:awaited])
         flow.server_description_changed
 
         # SDAM flow may alter the updated description - grab the final
@@ -736,7 +786,14 @@ module Mongo
       if !addresses.include?(address)
         server = Server.new(address, self, @monitoring, event_listeners, options.merge(
           monitor: false))
-        @update_lock.synchronize { @servers.push(server) }
+        @update_lock.synchronize do
+          # Need to recheck whether server is present in @servers, because
+          # the previous check was not under a lock.
+          # Since we are under the update lock here, we cannot call servers_list.
+          return if @servers.map(&:address).include?(address)
+
+          @servers.push(server)
+        end
         if add_options.nil? || add_options[:monitor] != false
           server.start_monitoring
         end
@@ -765,8 +822,16 @@ module Mongo
     # @since 2.0.0
     def remove(host, disconnect: true)
       address = Address.new(host)
-      removed_servers = @servers.select { |s| s.address == address }
-      @update_lock.synchronize { @servers = @servers - removed_servers }
+      removed_servers = []
+      @update_lock.synchronize do
+        @servers.delete_if do |server|
+          (server.address == address).tap do |delete|
+            if delete
+              removed_servers << server
+            end
+          end
+        end
+      end
       if disconnect != false
         removed_servers.each do |server|
           disconnect_server_if_connected(server)
@@ -781,8 +846,11 @@ module Mongo
 
     # @api private
     def update_topology(new_topology)
-      old_topology = topology
-      @topology = new_topology
+      old_topology = nil
+      @update_lock.synchronize do
+        old_topology = topology
+        @topology = new_topology
+      end
 
       # If new topology has data bearing servers, we know for sure whether
       # sessions are supported - update our cached value.
@@ -791,7 +859,10 @@ module Mongo
       # to try to determine session support accurately, falling back to the
       # last known value.
       if topology.data_bearing_servers?
-        @sessions_supported = !!topology.logical_session_timeout
+        sessions_supported = !!topology.logical_session_timeout
+        @update_lock.synchronize do
+          @sessions_supported = sessions_supported
+        end
       end
 
       publish_sdam_event(
@@ -802,7 +873,9 @@ module Mongo
 
     # @api private
     def servers_list
-      @update_lock.synchronize { @servers.dup }
+      @update_lock.synchronize do
+        @servers.dup
+      end
     end
 
     # @api private
@@ -816,21 +889,26 @@ module Mongo
       end
     end
 
-    # Returns whether the deployment that the driver is connected to supports
-    # sessions.
+    # Raises Error::SessionsNotAvailable if the deployment that the driver
+    # is connected to does not support sessions.
     #
     # Session support may change over time, for example due to servers in the
-    # deployment being upgraded or downgraded. This method returns the
-    # current information if the client is connected to at least one data
-    # bearing server. If the client is currently not connected to any data
-    # bearing servers, this method returns the last known value for whether
-    # the deployment supports sessions.
+    # deployment being upgraded or downgraded. If the client is currently not
+    # connected to any data bearing servers, this method considers the state
+    # of session support as of when the client was last connected to at
+    # least one server. If the client has never connected to any servers,
+    # the deployment is considered to not support sessions.
     #
-    # @return [ true | false ] Whether deployment supports sessions.
     # @api private
-    def sessions_supported?
-      if topology.data_bearing_servers?
-        return !!topology.logical_session_timeout
+    def validate_session_support!
+      @state_change_lock.synchronize do
+        @sdam_flow_lock.synchronize do
+          if topology.data_bearing_servers?
+            unless topology.logical_session_timeout
+              raise_sessions_not_supported
+            end
+          end
+        end
       end
 
       # No data bearing servers known - perform server selection to try to
@@ -838,11 +916,25 @@ module Mongo
       # assessment of whether sessions are currently supported.
       begin
         ServerSelector.get(mode: :primary_preferred).select_server(self)
-        !!topology.logical_session_timeout
+        @state_change_lock.synchronize do
+          @sdam_flow_lock.synchronize do
+            unless topology.logical_session_timeout
+              raise_sessions_not_supported
+            end
+          end
+        end
       rescue Error::NoServerAvailable
         # We haven't been able to contact any servers - use last known
-        # value for esssion support.
-        @sessions_supported || false
+        # value for session support.
+        @state_change_lock.synchronize do
+          @sdam_flow_lock.synchronize do
+            @update_lock.synchronize do
+              unless @sessions_supported
+                raise_sessions_not_supported
+              end
+            end
+          end
+        end
       end
     end
 
@@ -880,6 +972,22 @@ module Mongo
         end
       end
     end
+
+    def raise_sessions_not_supported
+      # Intentionally using @servers instead of +servers+ here because we
+      # are supposed to be already holding the @update_lock and we cannot
+      # recursively acquire it again.
+      offending_servers = @servers.select do |server|
+        server.description.data_bearing? && server.logical_session_timeout.nil?
+      end
+      reason = if offending_servers.empty?
+        "There are no known data bearing servers (current seeds: #{@servers.map(&:address).map(&:seed).join(', ')})"
+      else
+        "The following servers have null logical session timeout: #{offending_servers.map(&:address).map(&:seed).join(', ')}"
+      end
+      msg = "The deployment that the driver is connected to does not support sessions: #{reason}"
+      raise Error::SessionsNotSupported, msg
+    end
   end
 end
 

data/lib/mongo/cluster/periodic_executor.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/cluster/reapers/socket_reaper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/cluster/sdam_flow.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.
@@ -25,12 +25,13 @@ class Mongo::Cluster
   class SdamFlow
     extend Forwardable
 
-    def initialize(cluster, previous_desc, updated_desc)
+    def initialize(cluster, previous_desc, updated_desc, awaited: false)
       @cluster = cluster
       @topology = cluster.topology
       @original_desc = @previous_desc = previous_desc
       @updated_desc = updated_desc
       @servers_to_disconnect = []
+      @awaited = !!awaited
     end
 
     attr_reader :cluster
@@ -51,6 +52,10 @@ class Mongo::Cluster
     attr_reader :updated_desc
     attr_reader :original_desc
 
+    def awaited?
+      @awaited
+    end
+
     def_delegators :topology, :replica_set_name
 
     # Updates descriptions on all servers whose address matches
@@ -58,6 +63,13 @@ class Mongo::Cluster
     def update_server_descriptions
       servers_list.each do |server|
         if server.address == updated_desc.address
+          # SDAM flow must be run when topology version in the new description
+          # is equal to the current topology version, per the example in
+          # https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#what-is-the-purpose-of-topologyversion
+          unless updated_desc.topology_version_gte?(server.description)
+            return false
+          end
+
           @server_description_changed = server.description != updated_desc
 
           # Always update server description, so that fields that do not
@@ -91,7 +103,16 @@ class Mongo::Cluster
 
       case topology
       when Topology::Single
-        # no changes ever
+        if topology.replica_set_name
+          if updated_desc.replica_set_name != topology.replica_set_name
+            log_warn(
+              "Server #{updated_desc.address.to_s} has an incorrect replica set name '#{updated_desc.replica_set_name}'; expected '#{topology.replica_set_name}'"
+            )
+            @updated_desc = ::Mongo::Server::Description.new(updated_desc.address,
+              {}, updated_desc.average_round_trip_time)
+            update_server_descriptions
+          end
+        end
       when Topology::Unknown
         if updated_desc.standalone?
           update_unknown_with_standalone
@@ -111,14 +132,14 @@ class Mongo::Cluster
       when Topology::Sharded
         unless updated_desc.unknown? || updated_desc.mongos?
           log_warn(
-            "Removing server #{updated_desc.address.to_s} because it is a #{updated_desc.server_type.to_s.upcase} and not a MONGOS"
+            "Removing server #{updated_desc.address.to_s} because it is of the wrong type (#{updated_desc.server_type.to_s.upcase}) - expected SHARDED"
           )
           remove
         end
       when Topology::ReplicaSetWithPrimary
         if updated_desc.standalone? || updated_desc.mongos?
           log_warn(
-            "Removing server #{updated_desc.address.to_s} because it is a #{updated_desc.server_type.to_s.upcase} and not a replica set member"
+            "Removing server #{updated_desc.address.to_s} because it is of the wrong type (#{updated_desc.server_type.to_s.upcase}) - expected a replica set member"
           )
           remove
           check_if_has_primary
@@ -132,7 +153,7 @@ class Mongo::Cluster
       when Topology::ReplicaSetNoPrimary
         if updated_desc.standalone? || updated_desc.mongos?
           log_warn(
-            "Removing server #{updated_desc.address.to_s} because it is a #{updated_desc.server_type.to_s.upcase} and not a replica set member"
+            "Removing server #{updated_desc.address.to_s} because it is of the wrong type (#{updated_desc.server_type.to_s.upcase}) - expected a replica set member"
           )
           remove
         elsif updated_desc.primary?
@@ -194,8 +215,8 @@ class Mongo::Cluster
       if topology.replica_set_name != updated_desc.replica_set_name
         log_warn(
           "Removing server #{updated_desc.address.to_s} because it has an " +
-          "incorrect replica set name (#{updated_desc.replica_set_name}); " +
-          "current set name is #{topology.replica_set_name}"
+          "incorrect replica set name '#{updated_desc.replica_set_name}'; " +
+          "expected '#{topology.replica_set_name}'"
         )
         remove
         check_if_has_primary
@@ -415,15 +436,12 @@ class Mongo::Cluster
       # the server - in case of a stale primary, the server reported itself
       # as being a primary but updated_desc here will be unknown.
 
-      # We do not notify on unknown -> unknown changes.
-      # This can also be important for tests which have real i/o
-      # happening against bogus addresses which yield unknown responses
-      # and that also mock responses with the resulting race condition,
-      # though tests should avoid performing real i/o with monitoring_io: false
-      # option.
-      if updated_desc.unknown? && previous_desc.unknown?
-        return
-      end
+      # We used to not notify on Unknown -> Unknown server changes.
+      # Technically these are valid state changes (or at least as valid as
+      # other server description changes when the description has not
+      # changed meaningfully but the events are still published).
+      # The current version of the driver notifies on Unknown -> Unknown
+      # transitions.
 
       # Avoid dispatching events when updated description is the same as
       # previous description. This allows this method to be called multiple
@@ -440,6 +458,7 @@ class Mongo::Cluster
           topology,
           previous_desc,
           updated_desc,
+          awaited: awaited?,
         )
       )
       @previous_desc = updated_desc