feedback from copilot

Author: jamis

lib/mongo.rb

@@ -34,7 +34,6 @@
 
 require 'bson'
 
-require 'mongo/deprecations'
 require 'mongo/id'
 require 'mongo/bson'
 require 'mongo/semaphore'
@@ -43,6 +42,7 @@
 require 'mongo/csot_timeout_holder'
 require 'mongo/options'
 require 'mongo/loggable'
+require 'mongo/deprecations'
 require 'mongo/cluster_time'
 require 'mongo/topology_version'
 require 'mongo/monitoring'

lib/mongo/deprecations.rb

@@ -25,6 +25,9 @@ module Deprecations
 
     # Issue a warning about a deprecated feature. The warning is written to the
     # logger, and will not be written more than once per feature.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    # @param [ String ] message The deprecation message.
     def warn(feature, message)
       MUTEX.synchronize do
         return if _warned?(feature)
@@ -37,6 +40,7 @@ def warn(feature, message)
     # Check if a warning for a given deprecated feature has already been issued.
     #
     # @param [ String | Symbol ] feature The deprecated feature.
+    # @param [ true | false ] prefix Whether to check for prefix matches.
     #
     # @return [ true | false ] If a warning has already been issued.
     def warned?(feature, prefix: false)
@@ -48,21 +52,34 @@ def warned?(feature, prefix: false)
     # @param [ String | Symbol ] feature The deprecated feature.
     def warned!(feature)
       MUTEX.synchronize { _warned!(feature) }
+      nil
     end
 
     # Clears all memory of previously warned features.
     def clear!
       MUTEX.synchronize { warned_features reset: true }
-      true
+      nil
     end
 
     private
 
+    # Set of features that have already been warned about.
+    #
+    # @param [ true | false ] reset Whether to reset the warned features.
+    #
+    # @return [ Set<String> ] The set of warned features.
     def warned_features(reset: false)
       @warned_features = nil if reset
       @warned_features ||= Set.new
     end
 
+    # Check if a warning for a given deprecated feature has already been issued.
+    # This version is not thread-safe.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    # @param [ true | false ] prefix Whether to check for prefix matches.
+    #
+    # @return [ true | false ] If a warning has already been issued.
     def _warned?(feature, prefix: false)
       if prefix
         warned_features.any? { |f| feature.to_s.start_with?(f) }
@@ -71,6 +88,10 @@ def _warned?(feature, prefix: false)
       end
     end
 
+    # Mark that a warning for a given deprecated feature has been issued.
+    # This version is not thread-safe.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
     def _warned!(feature)
       warned_features.add(feature.to_s)
     end

lib/mongo/server/description/features.rb

@@ -85,6 +85,9 @@ class Features
         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
@@ -100,9 +103,16 @@ class Features
         # 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 array.
+        # set to an empty range (e.g. the EMPTY_RANGE constant).
         DEPRECATED_WIRE_VERSIONS = 6..6
 
+        # make sure the deprecated versions are valid
+        if DEPRECATED_WIRE_VERSIONS.min
+          if DRIVER_WIRE_VERSIONS.min > DEPRECATED_WIRE_VERSIONS.max
+            raise ArgumentError, 'DEPRECATED_WIRE_VERSIONS must be empty, or be within DRIVER_WIRE_VERSIONS'
+          end
+        end
+
         # Create the methods for each mapping to tell if they are supported.
         #
         # @since 2.0.0