RUBY-3111 Fix test failures in BSON master cause by the changing of the Illegal Key error (#2617)

* RUBY-3111 Fix test failures in BSON master cause by the changing of the Illegal Key error

* RUBY-3111 add min server version on retryable_writes_test

* RUBY-3111 change to 4.4+

Author: neilshweky

spec/integration/retryable_writes_errors_spec.rb

@@ -35,6 +35,7 @@
   context "when encountering a NoWritesPerformed error after an error with a RetryableWriteError label" do
     require_topology :replica_set
     require_fail_command
+    min_server_version '4.4'
 
     let(:failpoint1) do
       {

spec/mongo/protocol/caching_hash_spec.rb

@@ -36,6 +36,7 @@
   end
 
   describe "#needs_validation?" do
+    max_bson_version "4.99.99"
 
     before do
       hash.to_bson(BSON::ByteBuffer.new, validation)

spec/mongo/protocol/msg_spec.rb

@@ -390,6 +390,7 @@
     end
 
     context 'when the validating_keys option is true with payload 1' do
+      max_bson_version '4.99.99'
 
       let(:sequences) do
         [ section ]

spec/runners/transactions/operation.rb

@@ -73,10 +73,7 @@ def execute(target, context)
           'exception' => e,
           'error' => true,
         }
-      # We do not have a base class for client side BSON-related errors.
-      # See https://jira.mongodb.org/browse/RUBY-1806.
-      # Rescue this particular exception for the time being.
-      rescue BSON::String::IllegalKey => e
+      rescue bson_error => e
         {
           'exception' => e,
           'clientError' => true,
@@ -323,6 +320,15 @@ def wait_for_primary_change(client, context)
           end
         end
       end
+
+      # The error to rescue BSON tests for. If we still define
+      # BSON::String::IllegalKey then we should rescue that particular error,
+      # otherwise, rescue an arbitrary BSON::Error
+      def bson_error
+        BSON::String.const_defined?(:IllegalKey) ?
+          BSON::String.const_get(:IllegalKey) :
+          BSON::Error
+      end
     end
   end
 end

spec/runners/unified/test.rb

@@ -395,7 +395,7 @@ def execute_operation(op)
             end
 
             public_send(method_name, op)
-          rescue Mongo::Error, BSON::String::IllegalKey, Mongo::Auth::Unauthorized, ArgumentError => e
+          rescue Mongo::Error, bson_error, Mongo::Auth::Unauthorized, ArgumentError => e
             if expected_error.use('isClientError')
               # isClientError doesn't actually mean a client error.
               # It means anything other than OperationFailure. DRIVERS-1799
@@ -554,5 +554,14 @@ def create_client(**opts)
       ).update(opts)
       Mongo::Client.new(*args)
     end
+
+    # The error to rescue BSON tests for. If we still define
+    # BSON::String::IllegalKey then we should rescue that particular error,
+    # otherwise, rescue an arbitrary BSON::Error
+    def bson_error
+      BSON::String.const_defined?(:IllegalKey) ?
+        BSON::String.const_get(:IllegalKey) :
+        BSON::Error
+    end
   end
 end

spec/support/constraints.rb

@@ -16,4 +16,18 @@ def require_local_tls
       end
     end
   end
+
+  def max_bson_version(version)
+    required_version = version.split('.').map(&:to_i)
+    actual_version = bson_version(required_version.length)
+    before(:all) do
+      if (actual_version <=> required_version) > 0
+        skip "bson-ruby version #{version} or lower is required"
+      end
+    end
+  end
+
+  def bson_version(precision)
+    BSON::VERSION.split('.')[0...precision].map(&:to_i)
+  end
 end