mongo 2.4.1 → 2.14.0

data/lib/mongo/server/description.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 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.
@@ -13,7 +13,6 @@
 # limitations under the License.
 
 require 'mongo/server/description/features'
-require 'mongo/server/description/inspector'
 
 module Mongo
   class Server
@@ -21,12 +20,20 @@ module Mongo
     # Represents a description of the server, populated by the result of the
     # ismaster command.
     #
+    # Note: Unknown servers do not have wire versions, but for legacy reasons
+    # we return 0 for min_wire_version and max_wire_version of any server that does
+    # not have them. Presently the driver sometimes constructs commands when the
+    # server is unknown, so references to min_wire_version and max_wire_version
+    # should not be nil. When driver behavior is changed
+    # (https://jira.mongodb.org/browse/RUBY-1805), this may no longer be necessary.
+    #
     # @since 2.0.0
     class Description
 
       # Constant for reading arbiter info from config.
       #
       # @since 2.0.0
+      # @deprecated
       ARBITER = 'arbiterOnly'.freeze
 
       # Constant for reading arbiters info from config.
@@ -47,16 +54,19 @@ module Mongo
       # Constant for the key for the message value.
       #
       # @since 2.0.0
+      # @deprecated
       MESSAGE = 'msg'.freeze
 
       # Constant for the message that indicates a sharded cluster.
       #
       # @since 2.0.0
+      # @deprecated
       MONGOS_MESSAGE = 'isdbgrid'.freeze
 
       # Constant for determining ghost servers.
       #
       # @since 2.0.0
+      # @deprecated
       REPLICA_SET = 'isreplicaset'.freeze
 
       # Constant for reading max bson size info from config.
@@ -107,6 +117,7 @@ module Mongo
       # The legacy wire protocol version.
       #
       # @since 2.0.0
+      # @deprecated Will be removed in 3.0.
       LEGACY_WIRE_VERSION = 0.freeze
 
       # Constant for reading passive info from config.
@@ -122,11 +133,18 @@ module Mongo
       # Constant for reading primary info from config.
       #
       # @since 2.0.0
+      # @deprecated
       PRIMARY = 'ismaster'.freeze
 
+      # Constant for reading primary host field from config.
+      #
+      # @since 2.5.0
+      PRIMARY_HOST = 'primary'.freeze
+
       # Constant for reading secondary info from config.
       #
       # @since 2.0.0
+      # @deprecated
       SECONDARY = 'secondary'.freeze
 
       # Constant for reading replica set name info from config.
@@ -154,10 +172,60 @@ module Mongo
       # @since 2.1.0
       LOCAL_TIME = 'localTime'.freeze
 
+      # Constant for reading operationTime info from config.
+      #
+      # @since 2.5.0
+      OPERATION_TIME = 'operationTime'.freeze
+
+      # Constant for reading logicalSessionTimeoutMinutes info from config.
+      #
+      # @since 2.5.0
+      LOGICAL_SESSION_TIMEOUT_MINUTES = 'logicalSessionTimeoutMinutes'.freeze
+
+      # Constant for reading connectionId info from config.
+      #
+      # @api private
+      CONNECTION_ID = 'connectionId'.freeze
+
       # Fields to exclude when comparing two descriptions.
       #
       # @since 2.0.6
-      EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME ].freeze
+      EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME,
+                                 LAST_WRITE,
+                                 OPERATION_TIME,
+                                 Operation::CLUSTER_TIME,
+                                 CONNECTION_ID,
+                               ].freeze
+
+      # Instantiate the new server description from the result of the ismaster
+      # command.
+      #
+      # @example Instantiate the new description.
+      #   Description.new(address, { 'ismaster' => true }, 0.5)
+      #
+      # @param [ Address ] address The server address.
+      # @param [ Hash ] config The result of the ismaster command.
+      # @param [ Float ] average_round_trip_time The moving average time (sec) the ismaster
+      #   call took to complete.
+      #
+      # @since 2.0.0
+      def initialize(address, config = {}, average_round_trip_time = nil)
+        @address = address
+        @config = config
+        @features = Features.new(wire_versions, me || @address.to_s)
+        @average_round_trip_time = average_round_trip_time
+        @last_update_time = Time.now.dup.freeze
+
+        if Mongo::Lint.enabled?
+          # prepopulate cache instance variables
+          hosts
+          arbiters
+          passives
+          topology_version
+
+          freeze
+        end
+      end
 
       # @return [ Address ] address The server's address.
       attr_reader :address
@@ -166,12 +234,14 @@ module Mongo
       attr_reader :config
 
       # @return [ Features ] features The features for the server.
-      attr_reader :features
+      def features
+        @features
+      end
 
       # @return [ Float ] The moving average time the ismaster call took to complete.
       attr_reader :average_round_trip_time
 
-      # Will return true if the server is an arbiter.
+      # Returns whether this server is an arbiter, per the SDAM spec.
       #
       # @example Is the server an arbiter?
       #   description.arbiter?
@@ -180,7 +250,9 @@ module Mongo
       #
       # @since 2.0.0
       def arbiter?
-        !!config[ARBITER] && !replica_set_name.nil?
+        ok? &&
+        config['arbiterOnly'] == true &&
+        !!config['setName']
       end
 
       # Get a list of all arbiters in the replica set.
@@ -195,7 +267,7 @@ module Mongo
         @arbiters ||= (config[ARBITERS] || []).map { |s| s.downcase }
       end
 
-      # Is the server a ghost in a replica set?
+      # Whether this server is a ghost, per the SDAM spec.
       #
       # @example Is the server a ghost?
       #   description.ghost?
@@ -204,7 +276,8 @@ module Mongo
       #
       # @since 2.0.0
       def ghost?
-        !!config[REPLICA_SET]
+        ok? &&
+        config['isreplicaset'] == true
       end
 
       # Will return true if the server is hidden.
@@ -216,7 +289,7 @@ module Mongo
       #
       # @since 2.0.0
       def hidden?
-        !!config[HIDDEN]
+        ok? && !!config[HIDDEN]
       end
 
       # Get a list of all servers in the replica set.
@@ -231,25 +304,6 @@ module Mongo
         @hosts ||= (config[HOSTS] || []).map { |s| s.downcase }
       end
 
-      # Instantiate the new server description from the result of the ismaster
-      # command.
-      #
-      # @example Instantiate the new description.
-      #   Description.new(address, { 'ismaster' => true }, 0.5)
-      #
-      # @param [ Address ] address The server address.
-      # @param [ Hash ] config The result of the ismaster command.
-      # @param [ Float ] average_round_trip_time The moving average time (sec) the ismaster
-      #   call took to complete.
-      #
-      # @since 2.0.0
-      def initialize(address, config = {}, average_round_trip_time = 0)
-        @address = address
-        @config = config
-        @features = Features.new(wire_versions)
-        @average_round_trip_time = average_round_trip_time
-      end
-
       # Inspect the server description.
       #
       # @example Inspect the server description
@@ -298,7 +352,7 @@ module Mongo
         config[MAX_WRITE_BATCH_SIZE] || DEFAULT_MAX_WRITE_BATCH_SIZE
       end
 
-      # Get the maximum wire version.
+      # Get the maximum wire version. Defaults to zero.
       #
       # @example Get the max wire version.
       #   description.max_wire_version
@@ -307,10 +361,10 @@ module Mongo
       #
       # @since 2.0.0
       def max_wire_version
-        config[MAX_WIRE_VERSION] || LEGACY_WIRE_VERSION
+        config[MAX_WIRE_VERSION] || 0
       end
 
-      # Get the minimum wire version.
+      # Get the minimum wire version. Defaults to zero.
       #
       # @example Get the min wire version.
       #   description.min_wire_version
@@ -319,13 +373,16 @@ module Mongo
       #
       # @since 2.0.0
       def min_wire_version
-        config[MIN_WIRE_VERSION] || LEGACY_WIRE_VERSION
+        config[MIN_WIRE_VERSION] || 0
       end
 
       # Get the me field value.
       #
-      # @example Get the me field value.
-      #   description.me
+      # @note The value in me field may differ from the server description's
+      #   address. This can happen, for example, in split horizon configurations.
+      #   The SDAM spec only requires removing servers whose me does not match
+      #   their address in some of the situations (e.g. when the server in
+      #   question is an RS member but not a primary).
       #
       # @return [ String ] The me field.
       #
@@ -370,6 +427,47 @@ module Mongo
         config[SET_VERSION]
       end
 
+      # @return [ TopologyVersion | nil ] The topology version.
+      def topology_version
+        unless defined?(@topology_version)
+          @topology_version = config['topologyVersion'] &&
+            TopologyVersion.new(config['topologyVersion'])
+        end
+        @topology_version
+      end
+
+      # Returns whether topology version in this description is potentially
+      # newer than or equal to topology version in another description.
+      #
+      # @param [ Server::Description ] other_desc The other server description.
+      #
+      # @return [ true | false ] Whether topology version in this description
+      #   is potentially newer or equal.
+      # @api private
+      def topology_version_gt?(other_desc)
+        if topology_version.nil? || other_desc.topology_version.nil?
+          true
+        else
+          topology_version.gt?(other_desc.topology_version)
+        end
+      end
+
+      # Returns whether topology version in this description is potentially
+      # newer than topology version in another description.
+      #
+      # @param [ Server::Description ] other_desc The other server description.
+      #
+      # @return [ true | false ] Whether topology version in this description
+      #   is potentially newer.
+      # @api private
+      def topology_version_gte?(other_desc)
+        if topology_version.nil? || other_desc.topology_version.nil?
+          true
+        else
+          topology_version.gte?(other_desc.topology_version)
+        end
+      end
+
       # Get the lastWriteDate from the lastWrite subdocument in the config.
       #
       # @example Get the lastWriteDate value.
@@ -382,7 +480,19 @@ module Mongo
         config[LAST_WRITE][LAST_WRITE_DATE] if config[LAST_WRITE]
       end
 
-      # Is the server a mongos?
+      # Get the logicalSessionTimeoutMinutes from the config.
+      #
+      # @example Get the logicalSessionTimeoutMinutes value in minutes.
+      #   description.logical_session_timeout
+      #
+      # @return [ Integer, nil ] The logical session timeout in minutes.
+      #
+      # @since 2.5.0
+      def logical_session_timeout
+        config[LOGICAL_SESSION_TIMEOUT_MINUTES] if config[LOGICAL_SESSION_TIMEOUT_MINUTES]
+      end
+
+      # Returns whether this server is a mongos, per the SDAM spec.
       #
       # @example Is the server a mongos?
       #   description.mongos?
@@ -391,10 +501,10 @@ module Mongo
       #
       # @since 2.0.0
       def mongos?
-        config[MESSAGE] == MONGOS_MESSAGE
+        ok? && config['msg'] == 'isdbgrid'
       end
 
-      # Is the description of type other.
+      # Returns whether the server is an other, per the SDAM spec.
       #
       # @example Is the description of type other.
       #   description.other?
@@ -403,8 +513,14 @@ module Mongo
       #
       # @since 2.0.0
       def other?
-        (!primary? && !secondary? && !passive? && !arbiter?) ||
-          (hidden? && !replica_set_name.nil?)
+        # The SDAM spec is slightly confusing on what "other" means,
+        # but it's referred to it as "RSOther" which means a non-RS member
+        # cannot be "other".
+        ok? &&
+        !!config['setName'] && (
+          config['hidden'] == true ||
+          !primary? && !secondary? && !arbiter?
+        )
       end
 
       # Will return true if the server is passive.
@@ -416,7 +532,7 @@ module Mongo
       #
       # @since 2.0.0
       def passive?
-        !!config[PASSIVE]
+        ok? && !!config[PASSIVE]
       end
 
       # Get a list of the passive servers in the cluster.
@@ -431,7 +547,19 @@ module Mongo
         @passives ||= (config[PASSIVES] || []).map { |s| s.downcase }
       end
 
-      # Will return true if the server is a primary.
+      # Get the address of the primary host.
+      #
+      # @example Get the address of the primary.
+      #   description.primary_host
+      #
+      # @return [ String | nil ] The address of the primary.
+      #
+      # @since 2.6.0
+      def primary_host
+        config[PRIMARY_HOST] && config[PRIMARY_HOST].downcase
+      end
+
+      # Returns whether this server is a primary, per the SDAM spec.
       #
       # @example Is the server a primary?
       #   description.primary?
@@ -440,7 +568,9 @@ module Mongo
       #
       # @since 2.0.0
       def primary?
-        !!config[PRIMARY] && !replica_set_name.nil?
+        ok? &&
+        config['ismaster'] == true &&
+        !!config['setName']
       end
 
       # Get the name of the replica set the server belongs to, returns nil if
@@ -468,7 +598,7 @@ module Mongo
         hosts + arbiters + passives
       end
 
-      # Will return true if the server is a secondary.
+      # Returns whether this server is a secondary, per the SDAM spec.
       #
       # @example Is the server a secondary?
       #   description.secondary?
@@ -477,7 +607,9 @@ module Mongo
       #
       # @since 2.0.0
       def secondary?
-        !!config[SECONDARY] && !replica_set_name.nil?
+        ok? &&
+        config['secondary'] == true &&
+        !!config['setName']
       end
 
       # Returns the server type as a symbol.
@@ -495,10 +627,11 @@ module Mongo
         return :primary if primary?
         return :secondary if secondary?
         return :standalone if standalone?
+        return :other if other?
         :unknown
       end
 
-      # Is this server a standalone server?
+      # Returns whether this server is a standalone, per the SDAM spec.
       #
       # @example Is the server standalone?
       #   description.standalone?
@@ -507,10 +640,13 @@ module Mongo
       #
       # @since 2.0.0
       def standalone?
-        replica_set_name.nil? && !mongos? && !ghost? && !unknown?
+        ok? &&
+        config['msg'] != 'isdbgrid' &&
+        config['setName'].nil? &&
+        config['isreplicaset'] != true
       end
 
-      # Is the server description currently unknown?
+      # Returns whether this server is an unknown, per the SDAM spec.
       #
       # @example Is the server description unknown?
       #   description.unknown?
@@ -519,22 +655,13 @@ module Mongo
       #
       # @since 2.0.0
       def unknown?
-        config.empty? || (config[Operation::Result::OK] &&
-                            config[Operation::Result::OK] != 1)
+        config.empty? || config.keys == %w(topologyVersion) || !ok?
       end
 
-      # A result from another server's ismaster command before this server has
-      # refreshed causes the need for this description to become unknown before
-      # the next refresh.
-      #
-      # @example Force an unknown state.
-      #   description.unknown!
-      #
-      # @return [ true ] Always true.
-      #
-      # @since 2.0.0
-      def unknown!
-        @config = {} and true
+      # @api private
+      def ok?
+        config[Operation::Result::OK] &&
+          config[Operation::Result::OK] == 1 || false
       end
 
       # Get the range of supported wire versions for the server.
@@ -557,6 +684,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
@@ -570,6 +698,7 @@ module Mongo
       #   of servers.
       #
       # @since 2.0.6
+      # @deprecated
       def lists_server?(server)
         servers.include?(server.address.to_s)
       end
@@ -584,7 +713,18 @@ module Mongo
       #
       # @since 2.0.6
       def replica_set_member?
-        !(standalone? || mongos?)
+        ok? && !(standalone? || mongos?)
+      end
+
+      # Whether this description is from a data-bearing server
+      # (standalone, mongos, primary or secondary).
+      #
+      # @return [ true, false ] Whether the description is from a data-bearing
+      #   server.
+      #
+      # @since 2.7.0
+      def data_bearing?
+        mongos? || primary? || secondary? || standalone?
       end
 
       # Check if there is a mismatch between the address host and the me field.
@@ -596,7 +736,35 @@ module Mongo
       #
       # @since 2.0.6
       def me_mismatch?
-        !!(address.to_s != me if me)
+        !!(address.to_s.downcase != me.downcase if me)
+      end
+
+      # opTime in lastWrite subdocument of the ismaster response.
+      #
+      # @return [ BSON::Timestamp ] The timestamp.
+      #
+      # @since 2.7.0
+      def op_time
+        if config['lastWrite'] && config['lastWrite']['opTime']
+          config['lastWrite']['opTime']['ts']
+        end
+      end
+
+      # Time when this server description was created.
+      #
+      # @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
+
+      # @api experimental
+      def server_connection_id
+        config['connectionId']
       end
 
       # Check equality of two descriptions.
@@ -612,17 +780,36 @@ module Mongo
       def ==(other)
         return false if self.class != other.class
         return false if unknown? || other.unknown?
-        compare_config(other)
-      end
-      alias_method :eql?, :==
-
-      private
 
-      def compare_config(other)
-        config.keys.all? do |k|
+        (config.keys + other.config.keys).uniq.all? do |k|
           config[k] == other.config[k] || EXCLUDE_FOR_COMPARISON.include?(k)
         end
       end
+      alias_method :eql?, :==
+
+      # @api private
+      def server_version_gte?(version)
+        required_wv = case version
+          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
+
+        required_wv >= min_wire_version && required_wv <= max_wire_version
+      end
     end
   end
 end

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

@@ -0,0 +1,34 @@
+# 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.
+# 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
+    class Monitor
+      # App metadata for monitoring sockets.
+      #
+      # It is easiest to start with the normal app metadata and remove
+      # authentication-related bits.
+      #
+      # @api private
+      class AppMetadata < Server::AppMetadata
+        def initialize(options)
+          super
+          if instance_variable_defined?(:@request_auth_mech)
+            remove_instance_variable(:@request_auth_mech)
+          end
+        end
+      end
+    end
+  end
+end