mongo 2.10.5 → 2.11.0.rc0

data/lib/mongo/server/connection_pool/populator.rb

@@ -0,0 +1,58 @@
+# Copyright (C) 2019 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
+  class Server
+    # A manager that maintains the invariant that the
+    # size of a connection pool is at least minPoolSize.
+    #
+    # @api private
+    class Populator
+      include BackgroundThread
+
+      # @param [ Server::ConnectionPool ] The connection pool.
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ Logger ] :logger A custom logger to use.
+      def initialize(pool, options = {})
+        @pool = pool
+        @thread = nil
+        @options = options
+      end
+
+      attr_reader :options
+
+      def pre_stop
+        @pool.populate_semaphore.signal
+      end
+
+      private
+
+      def do_work
+        throw(:done) if @pool.closed?
+
+        begin
+          unless @pool.populate
+            @pool.populate_semaphore.wait
+          end
+        rescue Error::AuthError, Error => e
+          # Errors encountered when trying to add connections to
+          # pool; try again later
+          log_warn("Populator failed to connect a connection for #{@pool.address}: #{e.class}: #{e}.")
+          @pool.populate_semaphore.wait(5)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/description.rb

@@ -619,6 +619,7 @@ module Mongo
       # @return [ true, false ] If the description is from the server.
       #
       # @since 2.0.6
+      # @deprecated
       def is_server?(server)
         address == server.address
       end
@@ -632,6 +633,7 @@ module Mongo
       #   of servers.
       #
       # @since 2.0.6
+      # @deprecated
       def lists_server?(server)
         servers.include?(server.address.to_s)
       end
@@ -683,9 +685,14 @@ module Mongo
         end
       end
 
-      # Time when the server was last checked.
+      # Time when this server description was created.
       #
-      # @return [ Time ] Last check time.
+      # @note This time does not indicate when a successful server check
+      # completed, because marking a server unknown updates its description
+      # and last_update_time. Use Server#last_scan to find out when the server
+      # was last successfully checked by its Monitor.
+      #
+      # @return [ Time ] Server description creation time.
       #
       # @since 2.7.0
       attr_reader :last_update_time

data/lib/mongo/server/monitor.rb

@@ -15,14 +15,18 @@
 module Mongo
   class Server
 
-    # This object is responsible for keeping server status up to date, running in
-    # a separate thread as to not disrupt other operations.
+    # Responsible for periodically polling a server via ismaster commands to
+    # keep the server's status up to date.
+    #
+    # Does all work in a background thread so as to not interfere with other
+    # operations performed by the driver.
     #
     # @since 2.0.0
     class Monitor
       include Loggable
       extend Forwardable
       include Event::Publisher
+      include BackgroundThread
 
       # The default time for a server to refresh its status is 10 seconds.
       #
@@ -48,45 +52,45 @@ module Mongo
       #
       # @note Monitor must never be directly instantiated outside of a Server.
       #
-      # @param [ Address ] address The address to monitor.
+      # @param [ Server ] server The server to monitor.
       # @param [ Event::Listeners ] event_listeners The event listeners.
       # @param [ Monitoring ] monitoring The monitoring..
       # @param [ Hash ] options The options.
-      # @option options [ Float ] :heartbeat_frequency The interval, in seconds,
-      #   between server description refreshes via ismaster.
+      #
+      # @option options [ Float ] :connect_timeout The timeout, in seconds, to
+      #   use when establishing the monitoring connection.
+      # @option options [ Logger ] :logger A custom logger to use.
+      # @option options [ Float ] :socket_timeout The timeout, in seconds, to
+      #   execute operations on the monitoring connection.
       #
       # @since 2.0.0
       # @api private
-      def initialize(address, event_listeners, monitoring, options = {})
+      def initialize(server, event_listeners, monitoring, options = {})
         unless monitoring.is_a?(Monitoring)
           raise ArgumentError, "Wrong monitoring type: #{monitoring.inspect}"
         end
-        @description = Description.new(address, {})
+        @server = server
         @event_listeners = event_listeners
         @monitoring = monitoring
         @options = options.freeze
-        @round_trip_time_averager = RoundTripTimeAverager.new
-        @scan_semaphore = Semaphore.new
         # This is a Mongo::Server::Monitor::Connection
-        @connection = Connection.new(address, options)
-        @last_scan = nil
+        @connection = Connection.new(server.address, options)
         @mutex = Mutex.new
+        @scan_started_at = nil
       end
 
+      # @return [ Server ] server The server that this monitor is monitoring.
+      # @api private
+      attr_reader :server
+
       # @return [ Mongo::Server::Monitor::Connection ] connection The connection to use.
       attr_reader :connection
 
-      # @return [ Server::Description ] description The server
-      #   description the monitor refreshes.
-      attr_reader :description
-
       # @return [ Hash ] options The server options.
       attr_reader :options
 
-      # @return [ Time ] last_scan The time when the last server scan started.
-      #
-      # @since 2.4.0
-      attr_reader :last_scan
+      # @deprecated
+      def_delegators :server, :last_scan
 
       # The compressor is determined during the handshake, so it must be an attribute
       # of the connection.
@@ -98,19 +102,14 @@ module Mongo
       # Get the refresh interval for the server. This will be defined via an
       # option or will default to 10.
       #
-      # @example Get the refresh interval.
-      #   server.heartbeat_frequency
-      #
-      # @return [ Integer ] The heartbeat frequency, in seconds.
+      # @return [ Float ] The heartbeat interval, in seconds.
       #
       # @since 2.0.0
+      # @deprecated
       def heartbeat_frequency
-        @heartbeat_frequency ||= options[:heartbeat_frequency] || HEARTBEAT_FREQUENCY
+        server.cluster.heartbeat_interval
       end
 
-      # @api private
-      attr_reader :scan_semaphore
-
       # Runs the server monitor. Refreshing happens on a separate thread per
       # server.
       #
@@ -120,12 +119,23 @@ module Mongo
       # @return [ Thread ] The thread the monitor runs on.
       #
       # @since 2.0.0
-      def run!
-        @thread = Thread.new(heartbeat_frequency) do |i|
-          loop do
-            scan!
-            @scan_semaphore.wait(i)
-          end
+      def do_work
+        scan!
+        server.scan_semaphore.wait(server.cluster.heartbeat_interval)
+      end
+
+      # Stop the background thread and wait for to terminate for a reasonable
+      # amount of time.
+      #
+      # @return [ true | false ] Whether the thread was terminated.
+      #
+      # @api public for backwards compatibility only
+      def stop!
+        # Forward super's return value
+        super.tap do
+          # Important: disconnect should happen after the background thread
+          # terminated.
+          connection.disconnect!
         end
       end
 
@@ -141,6 +151,9 @@ module Mongo
       # @note If the system clock is set to a time in the past, this method
       #   can sleep for a very long time.
       #
+      # @note The return value of this method is deprecated. In version 3.0.0
+      #   this method will not have a return value.
+      #
       # @example Run a scan.
       #   monitor.scan!
       #
@@ -150,55 +163,10 @@ module Mongo
       def scan!
         throttle_scan_frequency!
         result = ismaster
-        new_description = Description.new(description.address, result,
-          @round_trip_time_averager.average_round_trip_time)
-        publish(Event::DESCRIPTION_CHANGED, description, new_description)
-        # If this server's response has a mismatched me, or for other reasons,
-        # this server may be removed from topology. When this happens the
-        # monitor thread gets killed. As a result, any code after the publish
-        # call may not run in a particular monitor instance, hence there
-        # shouldn't be any code here.
-        @description = new_description
-        # This call can be after the publish event because if the
-        # monitoring thread gets killed the server is closed and no client
-        # should be waiting for it
-        if options[:server_selection_semaphore]
-          options[:server_selection_semaphore].broadcast
-        end
-        @description
-      end
-
-      # Stops the server monitor. Kills the thread so it doesn't continue
-      # taking memory and sending commands to the connection.
-      #
-      # @example Stop the monitor.
-      #   monitor.stop!
-      #
-      # @param [ Boolean ] wait Whether to wait for background threads to
-      #   finish running.
-      #
-      # @return [ Boolean ] Is the thread stopped?
-      #
-      # @since 2.0.0
-      def stop!(wait=false)
-        # Although disconnect! documentation implies a possibility of
-        # failure, all of our disconnects always return true
-        if connection.disconnect!
-          if @thread
-            @thread.kill
-            if wait
-              @thread.join
-              @thread = nil
-              true
-            else
-              !@thread.alive?
-            end
-          else
-            true
-          end
-        else
-          false
-        end
+        new_description = Description.new(server.address, result,
+          server.round_trip_time_averager.average_round_trip_time)
+        server.cluster.run_sdam_flow(server.description, new_description)
+        server.description
       end
 
       # Restarts the server monitor unless the current thread is alive.
@@ -217,29 +185,30 @@ module Mongo
         end
       end
 
-      # @api private
-      attr_reader :round_trip_time_averager
-
       private
 
+      def pre_stop
+        server.scan_semaphore.signal
+      end
+
       def ismaster
         @mutex.synchronize do
           if monitoring.monitoring?
             monitoring.started(
               Monitoring::SERVER_HEARTBEAT,
-              Monitoring::Event::ServerHeartbeatStarted.new(description.address)
+              Monitoring::Event::ServerHeartbeatStarted.new(server.address)
             )
           end
 
-          result, exc, rtt, average_rtt = round_trip_time_averager.measure do
+          result, exc, rtt, average_rtt = server.round_trip_time_averager.measure do
             connection.ismaster
           end
           if exc
-            log_debug("Error running ismaster on #{description.address}: #{exc.message}")
+            log_debug("Error running ismaster on #{server.address}: #{exc.message}")
             if monitoring.monitoring?
               monitoring.failed(
                 Monitoring::SERVER_HEARTBEAT,
-                Monitoring::Event::ServerHeartbeatFailed.new(description.address, rtt, exc)
+                Monitoring::Event::ServerHeartbeatFailed.new(server.address, rtt, exc)
               )
             end
             result = {}
@@ -247,7 +216,7 @@ module Mongo
             if monitoring.monitoring?
               monitoring.succeeded(
                 Monitoring::SERVER_HEARTBEAT,
-                Monitoring::Event::ServerHeartbeatSucceeded.new(description.address, rtt)
+                Monitoring::Event::ServerHeartbeatSucceeded.new(server.address, rtt)
               )
             end
           end
@@ -258,12 +227,18 @@ module Mongo
       # @note If the system clock is set to a time in the past, this method
       #   can sleep for a very long time.
       def throttle_scan_frequency!
-        if @last_scan
-          difference = (Time.now - @last_scan)
+        # Normally server.last_scan indicates when the previous scan
+        # completed, but if scan! is manually invoked repeatedly then
+        # server.last_scan won't be updated and multiple scans with no
+        # cooldown can be obtained. Guard against repeated direct scan!
+        # invocation also.
+        last_time = [server.last_scan, @scan_started_at].compact.max
+        if last_time
+          difference = (Time.now - last_time)
           throttle_time = (MIN_SCAN_FREQUENCY - difference)
           sleep(throttle_time) if throttle_time > 0
         end
-        @last_scan = Time.now
+        @scan_started_at = Time.now
       end
     end
   end

data/lib/mongo/server/monitor/connection.rb

@@ -228,6 +228,8 @@ module Mongo
             reply = Protocol::Message.deserialize(socket, Mongo::Protocol::Message::MAX_MESSAGE_SIZE).documents[0]
             set_compressor!(reply)
             reply
+          else
+            log_warn("Asked to handshake with #{address} but there was no app metadata provided")
           end
         rescue => e
           log_warn("Failed to handshake with #{address}: #{e.class}: #{e}")

data/lib/mongo/server_selector/selectable.rb

@@ -417,19 +417,23 @@ module Mongo
       def filter_stale_servers(candidates, primary = nil)
         return candidates unless @max_staleness
 
+        # last_scan is filled out by the Monitor, and can be nil if a server
+        # had its description manually set rather than being normally updated
+        # via the SDAM flow. We don't handle the possibility of a nil
+        # last_scan here.
         if primary
           candidates.select do |server|
             validate_max_staleness_support!(server)
             staleness = (server.last_scan - server.last_write_date) -
                         (primary.last_scan - primary.last_write_date)  +
-                        server.heartbeat_frequency_seconds
+                        server.cluster.heartbeat_interval
             staleness <= @max_staleness
           end
         else
           max_write_date = candidates.collect(&:last_write_date).max
           candidates.select do |server|
             validate_max_staleness_support!(server)
-            staleness = max_write_date - server.last_write_date + server.heartbeat_frequency_seconds
+            staleness = max_write_date - server.last_write_date + server.cluster.heartbeat_interval
             staleness <= @max_staleness
           end
         end
@@ -461,10 +465,10 @@ module Mongo
 
       def validate_max_staleness_value!(cluster)
         if @max_staleness
-          heartbeat_frequency_seconds = cluster.options[:heartbeat_frequency] || Server::Monitor::HEARTBEAT_FREQUENCY
+          heartbeat_interval = cluster.heartbeat_interval
           unless @max_staleness >= [
             SMALLEST_MAX_STALENESS_SECONDS,
-            min_cluster_staleness = heartbeat_frequency_seconds + Cluster::IDLE_WRITE_PERIOD_SECONDS,
+            min_cluster_staleness = heartbeat_interval + Cluster::IDLE_WRITE_PERIOD_SECONDS,
           ].max
             msg = "`max_staleness` value (#{@max_staleness}) is too small - it must be at least " +
               "`Mongo::ServerSelector::SMALLEST_MAX_STALENESS_SECONDS` (#{ServerSelector::SMALLEST_MAX_STALENESS_SECONDS}) and (the cluster's heartbeat_frequency " +
@@ -492,7 +496,11 @@ module Mongo
       # @param [ Numeric ] time_remaining Maximum time to wait, in seconds.
       def wait_for_server_selection(cluster, time_remaining)
         if cluster.server_selection_semaphore
-          cluster.server_selection_semaphore.wait(time_remaining)
+          # Since the semaphore may have been signaled between us checking
+          # the servers list earlier and the wait call below, we should not
+          # wait for the full remaining time - wait for up to 1 second, then
+          # recheck the state.
+          cluster.server_selection_semaphore.wait([time_remaining, 1].min)
         else
           if Lint.enabled?
             raise Error::LintError, 'Waiting for server selection without having a server selection semaphore'

data/lib/mongo/session.rb

@@ -729,19 +729,6 @@ module Mongo
       end
     end
 
-    # Add this session's id to a command document.
-    #
-    # @example
-    #   session.add_id!(cmd)
-    #
-    # @return [ Hash, BSON::Document ] The command document.
-    #
-    # @since 2.5.0
-    # @api private
-    def add_id!(command)
-      command.merge!(lsid: session_id)
-    end
-
     # Add the startTransaction field to a command document if applicable.
     #
     # @example

data/lib/mongo/srv.rb

@@ -0,0 +1,17 @@
+# Copyright (C) 2019 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.
+
+require 'mongo/srv/result'
+require 'mongo/srv/resolver'
+require 'mongo/srv/monitor'