mongo 2.22.0 → 2.24.0

data/lib/mongo/server/description/features.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   class Server
     class Description
-
       # Defines behavior around what features a specific server supports.
       #
       # @since 2.0.0
@@ -26,12 +24,6 @@ module Mongo
         # List of features and the wire protocol version they appear in.
         #
         # Wire protocol versions map to server releases as follows:
-        # -  2 => 2.6
-        # -  3 => 3.0
-        # -  4 => 3.2
-        # -  5 => 3.4
-        # -  6 => 3.6
-        # -  7 => 4.0
         # -  8 => 4.2
         # -  9 => 4.4
         # - 13 => 5.0
@@ -44,55 +36,59 @@ module Mongo
           get_more_comment: 9,
           retryable_write_error_label: 9,
           commit_quorum: 9,
-          # Server versions older than 4.2 do not reliably validate options
-          # provided by the client during findAndModify operations, requiring the
-          # driver to raise client-side errors when those options are provided.
-          find_and_modify_option_validation: 8,
-          sharded_transactions: 8,
-          transactions: 7,
-          scram_sha_256: 7,
-          array_filters: 6,
-          op_msg: 6,
-          sessions: 6,
-          collation: 5,
-          max_staleness: 5,
-          # Server versions older than 3.4 do not reliably validate options
-          # provided by the client during update/delete operations, requiring the
-          # driver to raise client-side errors when those options are provided.
-          update_delete_option_validation: 5,
-          find_command: 4,
-          list_collections: 3,
-          list_indexes: 3,
-          scram_sha_1: 3,
-          write_command: 2,
-          users_info: 2,
         }.freeze
 
         # Error message if the server is too old for this version of the driver.
         #
         # @since 2.5.0
-        SERVER_TOO_OLD = "Server at (%s) reports wire version (%s), but this version of the Ruby driver " +
-                           "requires at least (%s)."
+        SERVER_TOO_OLD = 'Server at (%s) reports wire version (%s), but this version of the Ruby driver ' +
+                         'requires at least (%s).'
+
+        # Warning message if the server version is deprecated.
+        SERVER_DEPRECATED = 'Server at (%s) reports wire version (%s), but support for that wire version ' \
+                            'is deprecated and will be removed in a future version of the Ruby driver. ' \
+                            'Please upgrade your MongoDB server to a newer version soon.'
 
         # Error message if the driver is too old for the version of the server.
         #
         # @since 2.5.0
-        DRIVER_TOO_OLD = "Server at (%s) requires wire version (%s), but this version of the Ruby driver " +
-                           "only supports up to (%s)."
+        DRIVER_TOO_OLD = 'Server at (%s) requires wire version (%s), but this version of the Ruby driver ' +
+                         'only supports up to (%s).'
+
+        # An empty range constant, for use in DEPRECATED_WIRE_VERSIONS.
+        EMPTY_RANGE = (0...0).freeze
 
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (6..25).freeze
+        DRIVER_WIRE_VERSIONS = 8..25
+
+        # The wire protocol versions that are deprecated in this version of the
+        # driver. Support for these versions will be removed in the future.
+        #
+        # If there are multiple currently-deprecated wire versions, this should
+        # be set to a range of those versions.
+        #
+        # If there is only a single currently-deprecated wire version, this should
+        # be set to a range where the min and max are the same value.
+        #
+        # If there are no currently-deprecated wire versions, this should be
+        # set to an empty range (e.g. the EMPTY_RANGE constant).
+        DEPRECATED_WIRE_VERSIONS = EMPTY_RANGE
+
+        # make sure the deprecated versions are valid
+        if DEPRECATED_WIRE_VERSIONS.min && (DRIVER_WIRE_VERSIONS.min > DEPRECATED_WIRE_VERSIONS.max)
+          raise ArgumentError, 'DEPRECATED_WIRE_VERSIONS must be empty, or be within DRIVER_WIRE_VERSIONS'
+        end
 
         # Create the methods for each mapping to tell if they are supported.
         #
         # @since 2.0.0
-        MAPPINGS.each do |name, version|
+        MAPPINGS.each do |name, _version|
           # Determine whether or not the feature is supported.
           #
           # @example Is a feature enabled?
-          #   features.list_collections_enabled?
+          #   features.feature_enabled?
           #
           # @return [ true, false ] Whether the feature is supported.
           #
@@ -116,39 +112,35 @@ module Mongo
         #
         # @since 2.0.0
         def initialize(server_wire_versions, address = nil)
-          if server_wire_versions.min.nil?
-            raise ArgumentError, "server_wire_versions's min is nil"
-          end
-          if server_wire_versions.max.nil?
-            raise ArgumentError, "server_wire_versions's max is nil"
-          end
+          raise ArgumentError, "server_wire_versions's min is nil" if server_wire_versions.min.nil?
+          raise ArgumentError, "server_wire_versions's max is nil" if server_wire_versions.max.nil?
+
           @server_wire_versions = server_wire_versions
           @address = address
 
-          if Mongo::Lint.enabled?
-            freeze
-          end
+          return unless Mongo::Lint.enabled?
+
+          freeze
         end
 
         # Check that there is an overlap between the driver supported wire
-        #   version range and the server wire version range.
-        #
-        # @example Verify the wire version overlap.
-        #   features.check_driver_support!
+        # version range and the server wire version range. Also checks to see
+        # if the server is using a deprecated wire version.
         #
         # @raise [ Error::UnsupportedFeatures ] If the wire version range is
         #   not covered by the driver.
-        #
-        # @since 2.5.1
         def check_driver_support!
-          if DRIVER_WIRE_VERSIONS.min > @server_wire_versions.max
-            raise Error::UnsupportedFeatures.new(SERVER_TOO_OLD % [@address,
-                                                                   @server_wire_versions.max,
-                                                                   DRIVER_WIRE_VERSIONS.min])
+          if DEPRECATED_WIRE_VERSIONS.include?(@server_wire_versions.max)
+            feature = "wire_version:#{@address}"
+            Mongo::Deprecations.warn(feature, format(SERVER_DEPRECATED, @address, @server_wire_versions.max))
+
+          elsif DRIVER_WIRE_VERSIONS.min > @server_wire_versions.max
+            raise Error::UnsupportedFeatures.new(format(SERVER_TOO_OLD, @address, @server_wire_versions.max,
+                                                        DRIVER_WIRE_VERSIONS.min))
+
           elsif DRIVER_WIRE_VERSIONS.max < @server_wire_versions.min
-            raise Error::UnsupportedFeatures.new(DRIVER_TOO_OLD % [@address,
-                                                                   @server_wire_versions.min,
-                                                                   DRIVER_WIRE_VERSIONS.max])
+            raise Error::UnsupportedFeatures.new(format(DRIVER_TOO_OLD, @address, @server_wire_versions.min,
+                                                        DRIVER_WIRE_VERSIONS.max))
           end
         end
       end

data/lib/mongo/server/description/load_balancer.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   class Server
     class Description
-
       # Represents an assumed description of servers behind load balancers.
       class LoadBalancer
         def initialize(address)