mongo 2.23.0 → 2.24.1

data/lib/mongo/server/push_monitor.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Server
-
     # A monitor utilizing server-pushed hello requests.
     #
     # When a Monitor handshakes with a 4.4+ server, it creates an instance
@@ -33,15 +31,10 @@ module Mongo
       include BackgroundThread
 
       def initialize(monitor, topology_version, monitoring, **options)
-        if topology_version.nil?
-          raise ArgumentError, 'Topology version must be provided but it was nil'
-        end
-        unless options[:app_metadata]
-          raise ArgumentError, 'App metadata is required'
-        end
-        unless options[:check_document]
-          raise ArgumentError, 'Check document is required'
-        end
+        raise ArgumentError, 'Topology version must be provided but it was nil' if topology_version.nil?
+        raise ArgumentError, 'App metadata is required' unless options[:app_metadata]
+        raise ArgumentError, 'Check document is required' unless options[:check_document]
+
         @app_metadata = options[:app_metadata]
         @check_document = options[:check_document]
         @monitor = monitor
@@ -78,7 +71,11 @@ module Mongo
           if @connection
             # Interrupt any in-progress exhausted hello reads by
             # disconnecting the connection.
-            @connection.send(:socket).close rescue nil
+            begin
+              @connection.send(:socket).close
+            rescue StandardError
+              nil
+            end
           end
         end
         super.tap do
@@ -107,10 +104,8 @@ module Mongo
         # https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-monitoring.md#streamable-hello-or-legacy-hello-command
         # says that topologyVersion should only be updated from successful
         # hello responses.
-        if new_description.topology_version
-          @topology_version = new_description.topology_version
-        end
-      rescue IOError, SocketError, SystemCallError, Mongo::Error => exc
+        @topology_version = new_description.topology_version if new_description.topology_version
+      rescue IOError, SocketError, SystemCallError, Mongo::Error => e
         stop_requested = @lock.synchronize { @stop_requested }
         if stop_requested
           # Ignore the exception, see RUBY-2771.
@@ -118,11 +113,10 @@ module Mongo
         end
 
         msg = "Error running awaited hello on #{server.address}"
-        Utils.warn_bg_exception(msg, exc,
-          logger: options[:logger],
-          log_prefix: options[:log_prefix],
-          bg_error_backtrace: options[:bg_error_backtrace],
-        )
+        Utils.warn_bg_exception(msg, e,
+                                logger: options[:logger],
+                                log_prefix: options[:log_prefix],
+                                bg_error_backtrace: options[:bg_error_backtrace])
 
         # If a request failed on a connection, stop push monitoring.
         # In case the server is dead we don't want to have two connections
@@ -153,9 +147,7 @@ module Mongo
         end
 
         resp_msg = begin
-          unless @server_pushing
-            write_check_command
-          end
+          write_check_command unless @server_pushing
           read_response
         rescue Mongo::Error
           @lock.synchronize do
@@ -173,10 +165,10 @@ module Mongo
       def write_check_command
         document = @check_document.merge(
           topologyVersion: topology_version.to_doc,
-          maxAwaitTimeMS: monitor.heartbeat_interval * 1000,
+          maxAwaitTimeMS: monitor.heartbeat_interval * 1000
         )
         command = Protocol::Msg.new(
-          [:exhaust_allowed], {}, document.merge({'$db' => Database::ADMIN})
+          [ :exhaust_allowed ], {}, document.merge({ '$db' => Database::ADMIN })
         )
         @lock.synchronize { @connection }.write_bytes(command.serialize.to_s)
       end
@@ -184,14 +176,15 @@ module Mongo
       def read_response
         if timeout = options[:connect_timeout]
           if timeout < 0
-            raise Mongo::SocketTimeoutError, "Requested to read with a negative timeout: #{}"
+            raise Mongo::SocketTimeoutError, 'Requested to read with a negative timeout: '
           elsif timeout > 0
             timeout += options[:heartbeat_frequency] || Monitor::DEFAULT_HEARTBEAT_INTERVAL
           end
         end
         # We set the timeout twice: once passed into read_socket which applies
         # to each individual read operation, and again around the entire read.
-        Timeout.timeout(timeout, Error::SocketTimeoutError, "Failed to read an awaited hello response in #{timeout} seconds") do
+        Timeout.timeout(timeout, Error::SocketTimeoutError,
+                        "Failed to read an awaited hello response in #{timeout} seconds") do
           @lock.synchronize { @connection }.read_response(socket_timeout: timeout)
         end
       end
@@ -199,7 +192,6 @@ module Mongo
       def to_s
         "#<#{self.class.name}:#{object_id} #{server.address}>"
       end
-
     end
   end
 end

data/lib/mongo/server/round_trip_time_calculator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 
@@ -19,10 +18,9 @@ module Mongo
   class Server
     # @api private
     class RoundTripTimeCalculator
-
       # The weighting factor (alpha) for calculating the average moving
       # round trip time.
-      RTT_WEIGHT_FACTOR = 0.2.freeze
+      RTT_WEIGHT_FACTOR = 0.2
       private_constant :RTT_WEIGHT_FACTOR
 
       RTT_SAMPLES_FOR_MINIMUM = 10
@@ -39,9 +37,7 @@ module Mongo
         @rtts = []
       end
 
-      attr_reader :last_round_trip_time
-      attr_reader :average_round_trip_time
-      attr_reader :minimum_round_trip_time
+      attr_reader :last_round_trip_time, :average_round_trip_time, :minimum_round_trip_time
 
       def measure
         start = Utils.monotonic_time
@@ -51,7 +47,7 @@ module Mongo
           # If we encountered a network error, the round-trip is not
           # complete and thus RTT for it does not make sense.
           raise
-        rescue Error, Error::AuthError => exc
+        rescue Error, Error::AuthError => e
           # For other errors, RTT is valid.
         end
         last_rtt = Utils.monotonic_time - start
@@ -59,7 +55,7 @@ module Mongo
         # If hello fails, we need to return the last round trip time
         # because it is used in the heartbeat failed SDAM event,
         # but we must not update the round trip time recorded in the server.
-        unless exc
+        unless e
           @last_round_trip_time = last_rtt
           @lock.synchronize do
             update_average_round_trip_time
@@ -67,19 +63,17 @@ module Mongo
           end
         end
 
-        if exc
-          raise exc
-        else
-          rv
-        end
+        raise e if e
+
+        rv
       end
 
       def update_average_round_trip_time
         @average_round_trip_time = if average_round_trip_time
-          RTT_WEIGHT_FACTOR * last_round_trip_time + (1 - RTT_WEIGHT_FACTOR) * average_round_trip_time
-        else
-          last_round_trip_time
-        end
+                                     (RTT_WEIGHT_FACTOR * last_round_trip_time) + ((1 - RTT_WEIGHT_FACTOR) * average_round_trip_time)
+                                   else
+                                     last_round_trip_time
+                                   end
       end
 
       def update_minimum_round_trip_time

data/lib/mongo/server.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -16,7 +15,6 @@
 # limitations under the License.
 
 module Mongo
-
   # Represents a single server on the server side that can be standalone, part of
   # a replica set, or a mongos.
   #
@@ -29,7 +27,7 @@ module Mongo
     # The default time in seconds to timeout a connection attempt.
     #
     # @since 2.4.3
-    CONNECT_TIMEOUT = 10.freeze
+    CONNECT_TIMEOUT = 10
 
     # Instantiate a new server object. Will start the background refresh and
     # subscribe to the appropriate events.
@@ -82,21 +80,18 @@ module Mongo
       @scan_semaphore = DistinguishingSemaphore.new
       @round_trip_time_calculator = RoundTripTimeCalculator.new
       @description = Description.new(address, {},
-        load_balancer: !!@options[:load_balancer],
-        force_load_balancer: force_load_balancer?,
-      )
+                                     load_balancer: !!@options[:load_balancer],
+                                     force_load_balancer: force_load_balancer?)
       @last_scan = nil
       @last_scan_monotime = nil
       unless options[:monitoring_io] == false
         @monitor = Monitor.new(self, event_listeners, monitoring,
-          options.merge(
-            app_metadata: cluster.monitor_app_metadata,
-            push_monitor_app_metadata: cluster.push_monitor_app_metadata,
-            heartbeat_interval: cluster.heartbeat_interval,
-        ))
-        unless _monitor == false
-          start_monitoring
-        end
+                               options.merge(
+                                 app_metadata: cluster.monitor_app_metadata,
+                                 push_monitor_app_metadata: cluster.push_monitor_app_metadata,
+                                 heartbeat_interval: cluster.heartbeat_interval
+                               ))
+        start_monitoring unless _monitor == false
       end
       @connected = true
       @pool_lock = Mutex.new
@@ -108,7 +103,7 @@ module Mongo
     # @return [ Cluster ] cluster The server cluster.
     attr_reader :cluster
 
-    # @return [ nil | Monitor ] monitor The server monitor. nil if the servenr
+    # @return [ nil | Monitor ] monitor The server monitor. nil if the server
     #   was created with monitoring_io: false option.
     attr_reader :monitor
 
@@ -154,14 +149,13 @@ module Mongo
       end
     end
 
-
     # @deprecated
     def heartbeat_frequency
       cluster.heartbeat_interval
     end
 
     # @deprecated
-    alias :heartbeat_frequency_seconds :heartbeat_frequency
+    alias heartbeat_frequency_seconds heartbeat_frequency
 
     # Performs an immediate, synchronous check of the server.
     #
@@ -170,8 +164,8 @@ module Mongo
 
     # The compressor negotiated by the server monitor, if any.
     #
-    # This attribute is nil if no server check has not yet completed, and if
-    # no compression was negatiated.
+    # This attribute is nil if no server check has yet completed, and if
+    # no compression was negotiated.
     #
     # @note Compression is negotiated for each connection separately.
     #
@@ -179,11 +173,9 @@ module Mongo
     #
     # @deprecated
     def compressor
-      if monitor
-        monitor.compressor
-      else
-        nil
-      end
+      return unless monitor
+
+      monitor.compressor
     end
 
     # Delegate convenience methods to the monitor description.
@@ -246,6 +238,7 @@ module Mongo
     # @since 2.0.0
     def ==(other)
       return false unless other.is_a?(Server)
+
       address == other.address
     end
 
@@ -275,9 +268,7 @@ module Mongo
     #
     # @since 2.0.0
     def disconnect!
-      if monitor
-        monitor.stop!
-      end
+      monitor.stop! if monitor
 
       @connected = false
 
@@ -294,9 +285,7 @@ module Mongo
     end
 
     def close
-      if monitor
-        monitor.stop!
-      end
+      monitor.stop! if monitor
 
       @connected = false
 
@@ -331,9 +320,9 @@ module Mongo
     # @api private
     def start_monitoring
       publish_opening_event
-      if options[:monitoring_io] != false
-        monitor.run!
-      end
+      return unless options[:monitoring_io] != false
+
+      monitor.run!
     end
 
     # Publishes the server opening event.
@@ -362,24 +351,23 @@ module Mongo
     #
     # @api private
     def status
-      case
-      when load_balancer?
+      if load_balancer?
         'LB'
-      when primary?
+      elsif primary?
         'PRIMARY'
-      when secondary?
+      elsif secondary?
         'SECONDARY'
-      when standalone?
+      elsif standalone?
         'STANDALONE'
-      when arbiter?
+      elsif arbiter?
         'ARBITER'
-      when ghost?
+      elsif ghost?
         'GHOST'
-      when other?
+      elsif other?
         'OTHER'
-      when mongos?
+      elsif mongos?
         'MONGOS'
-      when unknown?
+      elsif unknown?
         'UNKNOWN'
       else
         # Since the summary method is often used for debugging, do not raise
@@ -394,23 +382,17 @@ module Mongo
     # @since 2.7.0
     def summary
       status = self.status || ''
-      if replica_set_name
-        status += " replica_set=#{replica_set_name}"
-      end
+      status += " replica_set=#{replica_set_name}" if replica_set_name
 
-      unless monitor&.running?
-        status += " NO-MONITORING"
-      end
+      status += ' NO-MONITORING' unless monitor&.running?
 
-      if @pool
-        status += " pool=#{@pool.summary}"
-      end
+      status += " pool=#{@pool.summary}" if @pool
 
       address_bit = if address
-        "#{address.host}:#{address.port}"
-      else
-        'nil'
-      end
+                      "#{address.host}:#{address.port}"
+                    else
+                      'nil'
+                    end
 
       "#<Server address=#{address_bit} #{status}>"
     end
@@ -424,9 +406,7 @@ module Mongo
     #
     # @since 2.0.0
     def pool
-      if unknown?
-        raise Error::ServerNotUsable, address
-      end
+      raise Error::ServerNotUsable, address if unknown?
 
       @pool_lock.synchronize do
         opts = connected? ? options : options.merge(populator_io: false)
@@ -475,9 +455,7 @@ module Mongo
     #
     # @since 2.1.0
     def reconnect!
-      if options[:monitoring_io] != false
-        monitor.restart!
-      end
+      monitor.restart! if options[:monitoring_io] != false
       @connected = true
     end
 
@@ -507,11 +485,13 @@ module Mongo
     def handle_handshake_failure!
       yield
     rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError => e
-      unknown!(
-        generation: e.generation,
-        service_id: e.service_id,
-        stop_push_monitor: true,
-      )
+      unless e.label?('SystemOverloadedError')
+        unknown!(
+          generation: e.generation,
+          service_id: e.service_id,
+          stop_push_monitor: true
+        )
+      end
       raise
     end
 
@@ -538,7 +518,7 @@ module Mongo
       unknown!(
         generation: e.generation,
         service_id: e.service_id,
-        stop_push_monitor: true,
+        stop_push_monitor: true
       )
       raise
     end
@@ -547,7 +527,7 @@ module Mongo
     #
     # @api private
     def retry_reads?
-      !!(features.sessions_enabled? && logical_session_timeout)
+      !!logical_session_timeout
     end
 
     # Will writes sent to this server be retried.
@@ -557,18 +537,17 @@ module Mongo
     #
     # @return [ true, false ] If writes will be retried.
     #
-    # @note Retryable writes are only available on server versions 3.6+ and with
-    #   sharded clusters or replica sets.
+    # @note Retryable writes are only available with sharded clusters or replica sets.
     #
     # @note Some of the conditions in this method automatically return false for
-    #       for load balanced topologies. The conditions in this method should
+    #       load balanced topologies. The conditions in this method should
     #       always be true, since load-balanced topologies are only available on
     #       MongoDB 5.0+, and not for standalone topologies. Therefore, we can
     #       assume that retry writes are enabled.
     #
     # @since 2.5.0
     def retry_writes?
-      !!(features.sessions_enabled? && logical_session_timeout && !standalone?) || load_balancer?
+      !!((logical_session_timeout && !standalone?) || load_balancer?)
     end
 
     # Marks server unknown and publishes the associated SDAM event
@@ -619,42 +598,30 @@ module Mongo
 
       # NOTE: You cannot use safe navigation here because if pool is nil you end
       # up trying to evaluate Integer < nil which is invalid.
-      if options[:generation] && pool && options[:generation] < pool.generation
-        return
-      end
+      return if options[:generation] && pool && options[:generation] < pool.generation
 
       if options[:topology_version] && description.topology_version &&
-        !options[:topology_version].gt?(description.topology_version)
-      then
+         !options[:topology_version].gt?(description.topology_version)
         return
       end
 
-      if options[:stop_push_monitor]
-        monitor&.stop_push_monitor!
-      end
+      monitor&.stop_push_monitor! if options[:stop_push_monitor]
 
       # SDAM flow will update description on the server without in-place
       # mutations and invoke SDAM transitions as needed.
       config = {}
-      if options[:service_id]
-        config['serviceId'] = options[:service_id]
-      end
-      if options[:topology_version]
-        config['topologyVersion'] = options[:topology_version]
-      end
+      config['serviceId'] = options[:service_id] if options[:service_id]
+      config['topologyVersion'] = options[:topology_version] if options[:topology_version]
       new_description = Description.new(address, config,
-        load_balancer: load_balancer?,
-        force_load_balancer: options[:connect] == :load_balanced,
-      )
+                                        load_balancer: load_balancer?,
+                                        force_load_balancer: options[:connect] == :load_balanced)
       cluster.run_sdam_flow(description, new_description, options)
     end
 
     # @api private
     def update_description(description)
       pool = pool_internal
-      if pool && !description.unknown?
-        pool.ready
-      end
+      pool.ready if pool && !description.unknown?
       @description = description
     end