mongo 2.23.0 → 2.24.1

data/lib/mongo/server/description.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Server
-
     # Represents a description of the server, populated by the result of the
     # hello command.
     #
@@ -30,173 +28,192 @@ module Mongo
     #
     # @since 2.0.0
     class Description
-
       # Constant for reading arbiter info from config.
       #
       # @since 2.0.0
       # @deprecated
-      ARBITER = 'arbiterOnly'.freeze
+      ARBITER = 'arbiterOnly'
 
       # Constant for reading arbiters info from config.
       #
       # @since 2.0.0
-      ARBITERS = 'arbiters'.freeze
+      ARBITERS = 'arbiters'
 
       # Constant for reading hidden info from config.
       #
       # @since 2.0.0
-      HIDDEN = 'hidden'.freeze
+      HIDDEN = 'hidden'
 
       # Constant for reading hosts info from config.
       #
       # @since 2.0.0
-      HOSTS = 'hosts'.freeze
+      HOSTS = 'hosts'
 
       # Constant for the key for the message value.
       #
       # @since 2.0.0
       # @deprecated
-      MESSAGE = 'msg'.freeze
+      MESSAGE = 'msg'
 
       # Constant for the message that indicates a sharded cluster.
       #
       # @since 2.0.0
       # @deprecated
-      MONGOS_MESSAGE = 'isdbgrid'.freeze
+      MONGOS_MESSAGE = 'isdbgrid'
 
       # Constant for determining ghost servers.
       #
       # @since 2.0.0
       # @deprecated
-      REPLICA_SET = 'isreplicaset'.freeze
+      REPLICA_SET = 'isreplicaset'
 
       # Constant for reading max bson size info from config.
       #
       # @since 2.0.0
-      MAX_BSON_OBJECT_SIZE = 'maxBsonObjectSize'.freeze
+      MAX_BSON_OBJECT_SIZE = 'maxBsonObjectSize'
 
       # Constant for reading max message size info from config.
       #
       # @since 2.0.0
-      MAX_MESSAGE_BYTES = 'maxMessageSizeBytes'.freeze
+      MAX_MESSAGE_BYTES = 'maxMessageSizeBytes'
 
       # Constant for the max wire version.
       #
       # @since 2.0.0
-      MAX_WIRE_VERSION = 'maxWireVersion'.freeze
+      MAX_WIRE_VERSION = 'maxWireVersion'
 
       # Constant for min wire version.
       #
       # @since 2.0.0
-      MIN_WIRE_VERSION = 'minWireVersion'.freeze
+      MIN_WIRE_VERSION = 'minWireVersion'
 
       # Constant for reading max write batch size.
       #
       # @since 2.0.0
-      MAX_WRITE_BATCH_SIZE = 'maxWriteBatchSize'.freeze
+      MAX_WRITE_BATCH_SIZE = 'maxWriteBatchSize'
 
       # Constant for the lastWrite subdocument.
       #
       # @since 2.4.0
-      LAST_WRITE = 'lastWrite'.freeze
+      LAST_WRITE = 'lastWrite'
 
       # Constant for the lastWriteDate field in the lastWrite subdocument.
       #
       # @since 2.4.0
-      LAST_WRITE_DATE = 'lastWriteDate'.freeze
+      LAST_WRITE_DATE = 'lastWriteDate'
 
       # Constant for reading the me field.
       #
       # @since 2.1.0
-      ME = 'me'.freeze
+      ME = 'me'
 
       # Default max write batch size.
       #
       # @since 2.0.0
-      DEFAULT_MAX_WRITE_BATCH_SIZE = 1000.freeze
+      DEFAULT_MAX_WRITE_BATCH_SIZE = 1000
 
       # The legacy wire protocol version.
       #
       # @since 2.0.0
       # @deprecated Will be removed in 3.0.
-      LEGACY_WIRE_VERSION = 0.freeze
+      LEGACY_WIRE_VERSION = 0
 
       # Constant for reading passive info from config.
       #
       # @since 2.0.0
-      PASSIVE = 'passive'.freeze
+      PASSIVE = 'passive'
 
       # Constant for reading the passive server list.
       #
       # @since 2.0.0
-      PASSIVES = 'passives'.freeze
+      PASSIVES = 'passives'
 
       # Constant for reading primary info from config.
       #
       # @since 2.0.0
       # @deprecated
-      PRIMARY = 'ismaster'.freeze
+      PRIMARY = 'ismaster'
 
       # Constant for reading primary host field from config.
       #
       # @since 2.5.0
-      PRIMARY_HOST = 'primary'.freeze
+      PRIMARY_HOST = 'primary'
 
       # Constant for reading secondary info from config.
       #
       # @since 2.0.0
       # @deprecated
-      SECONDARY = 'secondary'.freeze
+      SECONDARY = 'secondary'
 
       # Constant for reading replica set name info from config.
       #
       # @since 2.0.0
-      SET_NAME = 'setName'.freeze
+      SET_NAME = 'setName'
 
       # Constant for reading tags info from config.
       #
       # @since 2.0.0
-      TAGS = 'tags'.freeze
+      TAGS = 'tags'
 
       # Constant for reading electionId info from config.
       #
       # @since 2.1.0
-      ELECTION_ID = 'electionId'.freeze
+      ELECTION_ID = 'electionId'
 
       # Constant for reading setVersion info from config.
       #
       # @since 2.2.2
-      SET_VERSION = 'setVersion'.freeze
+      SET_VERSION = 'setVersion'
 
       # Constant for reading localTime info from config.
       #
       # @since 2.1.0
-      LOCAL_TIME = 'localTime'.freeze
+      LOCAL_TIME = 'localTime'
 
       # Constant for reading operationTime info from config.
       #
       # @since 2.5.0
-      OPERATION_TIME = 'operationTime'.freeze
+      OPERATION_TIME = 'operationTime'
 
       # Constant for reading logicalSessionTimeoutMinutes info from config.
       #
       # @since 2.5.0
-      LOGICAL_SESSION_TIMEOUT_MINUTES = 'logicalSessionTimeoutMinutes'.freeze
+      LOGICAL_SESSION_TIMEOUT_MINUTES = 'logicalSessionTimeoutMinutes'
 
       # Constant for reading connectionId info from config.
       #
       # @api private
-      CONNECTION_ID = 'connectionId'.freeze
+      CONNECTION_ID = 'connectionId'
+
+      # Constant for reading the modern primary flag from config.
+      #
+      # @api private
+      IS_WRITABLE_PRIMARY = 'isWritablePrimary'
+
+      # Constant for reading the helloOk capability flag from config.
+      #
+      # @api private
+      HELLO_OK = 'helloOk'
 
       # Fields to exclude when comparing two descriptions.
       #
+      # The PRIMARY (legacy `ismaster`), IS_WRITABLE_PRIMARY (modern `hello`),
+      # and HELLO_OK keys are excluded because the driver does a one-time
+      # legacy-`isMaster` to modern-`hello` protocol switch on the initial
+      # handshake (per the SDAM Server Monitoring spec). Two responses for the
+      # same logical role differ only in which of these keys is populated.
+      # The role itself is still differentiated by the SECONDARY flag and the
+      # remaining replica-set metadata.
+      #
       # @since 2.0.6
       EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME,
                                  LAST_WRITE,
                                  OPERATION_TIME,
                                  Operation::CLUSTER_TIME,
                                  CONNECTION_ID,
-                               ].freeze
+                                 PRIMARY,
+                                 IS_WRITABLE_PRIMARY,
+                                 HELLO_OK, ].freeze
 
       # Instantiate the new server description from the result of the hello
       # command or fabricate a placeholder description for Unknown and
@@ -218,9 +235,8 @@ module Mongo
       #
       # @api private
       def initialize(address, config = {}, average_round_trip_time: nil,
-        minimum_round_trip_time: 0, load_balancer: false,
-        force_load_balancer: false
-      )
+                     minimum_round_trip_time: 0, load_balancer: false,
+                     force_load_balancer: false)
         @address = address
         @config = config
         @load_balancer = !!load_balancer
@@ -231,56 +247,55 @@ module Mongo
         @last_update_time = Time.now.freeze
         @last_update_monotime = Utils.monotonic_time
 
-        if load_balancer
-          # When loadBalanced=true URI option is set, the driver will refuse
-          # to work if the server it communicates with does not set serviceId
-          # in ismaster/hello response.
-          #
-          # At the moment we cannot run a proper load balancer setup on evergreen
-          #
-          # Therefore, when connect=:load_balanced Ruby option is used instead
-          # of the loadBalanced=true URI option, if serviceId is not set in
-          # ismaster/hello response, the driver fabricates a serviceId and
-          # proceeds to treat a server that does not report itself as being
-          # behind a load balancer as a server that is behind a load balancer.
-          #
-          # 5.0+ servers should provide topologyVersion.processId which
-          # is specific to the particular process instance. We can use that
-          # field as a proxy for serviceId.
-          #
-          # If the topologyVersion isn't provided for whatever reason, we
-          # fabricate a serviceId locally.
-          #
-          # In either case, a serviceId provided by an actual server behind
-          # a load balancer is supposed to be a BSON::ObjectId. The fabricated
-          # service ids are strings, to distinguish them from the real ones.
-          # In particular processId is also a BSON::ObjectId, but will be
-          # mapped to a string for clarity that this is a fake service id.
-          #
-          # TODO: Remove this when https://jira.mongodb.org/browse/RUBY-2881 is done.
-          if ok? && !service_id
-            unless force_load_balancer
-              raise Error::MissingServiceId, "The server at #{address.seed} did not provide a service id in handshake response"
-            end
-
-            fake_service_id = if process_id = topology_version && topology_version['processId']
-              "process:#{process_id}"
-            else
-              "fake:#{rand(2**32-1)+1}"
-            end
-            @config = @config.merge('serviceId' => fake_service_id)
+        # When loadBalanced=true URI option is set, the driver will refuse
+        # to work if the server it communicates with does not set serviceId
+        # in ismaster/hello response.
+        #
+        # At the moment we cannot run a proper load balancer setup on evergreen
+        #
+        # Therefore, when connect=:load_balanced Ruby option is used instead
+        # of the loadBalanced=true URI option, if serviceId is not set in
+        # ismaster/hello response, the driver fabricates a serviceId and
+        # proceeds to treat a server that does not report itself as being
+        # behind a load balancer as a server that is behind a load balancer.
+        #
+        # 5.0+ servers should provide topologyVersion.processId which
+        # is specific to the particular process instance. We can use that
+        # field as a proxy for serviceId.
+        #
+        # If the topologyVersion isn't provided for whatever reason, we
+        # fabricate a serviceId locally.
+        #
+        # In either case, a serviceId provided by an actual server behind
+        # a load balancer is supposed to be a BSON::ObjectId. The fabricated
+        # service ids are strings, to distinguish them from the real ones.
+        # In particular processId is also a BSON::ObjectId, but will be
+        # mapped to a string for clarity that this is a fake service id.
+        #
+        # TODO: Remove this when https://jira.mongodb.org/browse/RUBY-2881 is done.
+        if load_balancer && ok? && !service_id
+          unless force_load_balancer
+            raise Error::MissingServiceId,
+                  "The server at #{address.seed} did not provide a service id in handshake response"
           end
+
+          fake_service_id = if process_id = topology_version && topology_version['processId']
+                              "process:#{process_id}"
+                            else
+                              "fake:#{rand((2**32) - 1) + 1}"
+                            end
+          @config = @config.merge('serviceId' => fake_service_id)
         end
 
-        if Mongo::Lint.enabled?
-          # prepopulate cache instance variables
-          hosts
-          arbiters
-          passives
-          topology_version
+        return unless Mongo::Lint.enabled?
 
-          freeze
-        end
+        # prepopulate cache instance variables
+        hosts
+        arbiters
+        passives
+        topology_version
+
+        freeze
       end
 
       # @return [ Address ] address The server's address.
@@ -297,14 +312,12 @@ module Mongo
       end
 
       # @return [ Features ] features The features for the server.
-      def features
-        @features
-      end
+      attr_reader :features
 
       # @return [ Float ] The moving average time the hello call took to complete.
       attr_reader :average_round_trip_time
 
-      # @return [ Float ] The minimum time from the ten last hello calls took
+      # @return [ Float ] The minimum time that the ten last hello calls took
       #   to complete.
       attr_reader :minimum_round_trip_time
 
@@ -318,8 +331,8 @@ module Mongo
       # @since 2.0.0
       def arbiter?
         ok? &&
-        config['arbiterOnly'] == true &&
-        !!config['setName']
+          config['arbiterOnly'] == true &&
+          !!config['setName']
       end
 
       # Get a list of all arbiters in the replica set.
@@ -344,7 +357,7 @@ module Mongo
       # @since 2.0.0
       def ghost?
         ok? &&
-        config['isreplicaset'] == true
+          config['isreplicaset'] == true
       end
 
       # Will return true if the server is hidden.
@@ -498,7 +511,7 @@ module Mongo
       def topology_version
         unless defined?(@topology_version)
           @topology_version = config['topologyVersion'] &&
-            TopologyVersion.new(config['topologyVersion'])
+                              TopologyVersion.new(config['topologyVersion'])
         end
         @topology_version
       end
@@ -584,9 +597,9 @@ module Mongo
         # but it's referred to it as "RSOther" which means a non-RS member
         # cannot be "other".
         ok? &&
-        !!config['setName'] && (
+          !!config['setName'] && (
           config['hidden'] == true ||
-          !primary? && !secondary? && !arbiter?
+          (!primary? && !secondary? && !arbiter?)
         )
       end
 
@@ -636,8 +649,8 @@ module Mongo
       # @since 2.0.0
       def primary?
         ok? &&
-          (config['ismaster'] == true || config['isWritablePrimary'] == true ) &&
-        !!config['setName']
+          (config['ismaster'] == true || config['isWritablePrimary'] == true) &&
+          !!config['setName']
       end
 
       # Get the name of the replica set the server belongs to, returns nil if
@@ -675,8 +688,8 @@ module Mongo
       # @since 2.0.0
       def secondary?
         ok? &&
-        config['secondary'] == true &&
-        !!config['setName']
+          config['secondary'] == true &&
+          !!config['setName']
       end
 
       # Returns the server type as a symbol.
@@ -696,6 +709,7 @@ module Mongo
         return :secondary if secondary?
         return :standalone if standalone?
         return :other if other?
+
         :unknown
       end
 
@@ -709,9 +723,9 @@ module Mongo
       # @since 2.0.0
       def standalone?
         ok? &&
-        config['msg'] != 'isdbgrid' &&
-        config['setName'].nil? &&
-        config['isreplicaset'] != true
+          config['msg'] != 'isdbgrid' &&
+          config['setName'].nil? &&
+          config['isreplicaset'] != true
       end
 
       # Returns whether this server is an unknown, per the SDAM spec.
@@ -724,7 +738,8 @@ module Mongo
       # @since 2.0.0
       def unknown?
         return false if load_balancer?
-        config.empty? || config.keys == %w(topologyVersion) || !ok?
+
+        config.empty? || config.keys == %w[topologyVersion] || !ok?
       end
 
       # @api private
@@ -821,9 +836,9 @@ module Mongo
       #
       # @since 2.7.0
       def op_time
-        if config['lastWrite'] && config['lastWrite']['opTime']
-          config['lastWrite']['opTime']['ts']
-        end
+        return unless config['lastWrite'] && config['lastWrite']['opTime']
+
+        config['lastWrite']['opTime']['ts']
       end
 
       # Time when this server description was created.
@@ -872,46 +887,29 @@ module Mongo
       def ==(other)
         return false if self.class != other.class
         return false if unknown? || other.unknown?
+        return false if server_type != other.server_type
 
         (config.keys + other.config.keys).uniq.all? do |k|
           config[k] == other.config[k] || EXCLUDE_FOR_COMPARISON.include?(k)
         end
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       # @api private
-      def server_version_gte?(version)
-        required_wv = case version
-          when '7.0'
-            21
-          when '6.0'
-            17
-          when '5.2'
-            15
-          when '5.1'
-            14
-          when '5.0'
-            12
-          when '4.4'
-            9
-          when '4.2'
-            8
-          when '4.0'
-            7
-          when '3.6'
-            6
-          when '3.4'
-            5
-          when '3.2'
-            4
-          when '3.0'
-            3
-          when '2.6'
-            2
-          else
-            raise ArgumentError, "Bogus required version #{version}"
-          end
+      SERVER_VERSION_WIRE_VERSION_MAP = {
+        '8.2' => 27,
+        '8.0' => 25,
+        '7.0' => 21,
+        '6.0' => 17,
+        '5.2' => 15,
+        '5.1' => 14,
+        '5.0' => 12,
+        '4.4' => 9,
+        '4.2' => 8,
+      }.freeze
 
+      # @api private
+      def server_version_gte?(version)
         if load_balancer?
           # If we are talking to a load balancer, there is no monitoring
           # and we don't know what server is behind the load balancer.
@@ -920,7 +918,10 @@ module Mongo
           return true
         end
 
-        required_wv >= min_wire_version && required_wv <= max_wire_version
+        required_wv = SERVER_VERSION_WIRE_VERSION_MAP[version]
+        raise NotImplementedError, "Unexpected server version #{version.inspect}" unless required_wv
+
+        required_wv <= max_wire_version
       end
     end
   end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 
@@ -27,9 +26,9 @@ module Mongo
       class AppMetadata < Server::AppMetadata
         def initialize(options = {})
           super
-          if instance_variable_defined?(:@request_auth_mech)
-            remove_instance_variable(:@request_auth_mech)
-          end
+          return unless instance_variable_defined?(:@request_auth_mech)
+
+          remove_instance_variable(:@request_auth_mech)
         end
       end
     end