RUBY-3390 Add CSOT to list_databases

Author: comandeo-mongo

lib/mongo/client.rb

@@ -937,8 +937,10 @@ def reconnect
     #   See https://mongodb.com/docs/manual/reference/command/listDatabases/
     #   for more information and usage.
     # @option opts [ Session ] :session The session to use.
-    # @option options [ Object ] :comment A user-provided
+    # @option opts [ Object ] :comment A user-provided
     #   comment to attach to this command.
+    # @option opts [ Integer | nil ] :timeout_ms Operation timeout in milliseconds.
+    #    Must a positive integer. The default value is unset which means infinite.
     #
     # @return [ Array<String> ] The names of the databases.
     #
@@ -958,7 +960,11 @@ def database_names(filter = {}, opts = {})
     #
     # @option opts [ true, false ] :authorized_databases A flag that determines
     #   which databases are returned based on user privileges when access control
-    #   is enabled
+    #   is enabled.
+    # @option opts [ Object ] :comment A user-provided
+    #   comment to attach to this command.
+    # @option opts [ Integer | nil ] :timeout_ms Operation timeout in milliseconds.
+    #    Must a positive integer. The default value is unset which means infinite.
     #
     #   See https://mongodb.com/docs/manual/reference/command/listDatabases/
     #   for more information and usage.

lib/mongo/collection.rb

@@ -1200,6 +1200,10 @@ def system_collection?
       name.start_with?('system.')
     end
 
+    # @return [ Integer | nil ] Operation timeout that is for this database or
+    #   for the corresponding client.
+    #
+    # @api private
     def timeout_ms
       options[:timeout_ms] || database.timeout_ms
     end

lib/mongo/database.rb

@@ -245,6 +245,10 @@ def command(operation, opts = {})
     #
     # @option opts :read [ Hash ] The read preference for this command.
     # @option opts :session [ Session ] The session to use for this command.
+    # @option opts [ Object ] :comment A user-provided
+    #   comment to attach to this command.
+    # @option opts [ Integer | nil ] :timeout_ms Operation timeout in milliseconds.
+    #    Must a positive integer. The default value is unset which means infinite.
     #
     # @return [ Hash ] The result of the command execution.
     # @api private
@@ -258,15 +262,20 @@ def read_command(operation, opts = {})
       Lint.validate_underscore_read_preference(txn_read_pref)
       preference = ServerSelector.get(txn_read_pref)
 
-      client.send(:with_session, opts) do |session|
-        read_with_retry(session, preference) do |server|
+      client.with_session(opts) do |session|
+        context = Operation::Context.new(
+          client: client,
+          session: session,
+          operation_timeouts: operation_timeouts(opts)
+        )
+        read_with_retry(session, preference, context) do |server|
           Operation::Command.new(
             selector: operation.dup,
             db_name: name,
             read: preference,
             session: session,
             comment: opts[:comment],
-          ).execute(server, context: Operation::Context.new(client: client, session: session))
+          ).execute(server, context: context)
         end
       end
     end
@@ -279,14 +288,16 @@ def read_command(operation, opts = {})
     # @param [ Hash ] options The options for the operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
-    # @option opts [ Hash ] :write_concern The write concern options.
+    # @option options [ Hash ] :write_concern The write concern options.
+    # @option options [ Integer | nil ] :timeout_ms Operation timeout in milliseconds.
+    #    Must a positive integer. The default value is unset which means infinite.
     #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
     def drop(options = {})
       operation = { :dropDatabase => 1 }
-      client.send(:with_session, options) do |session|
+      client.with_session(options) do |session|
         write_concern = if options[:write_concern]
           WriteConcern.get(options[:write_concern])
         else
@@ -297,7 +308,14 @@ def drop(options = {})
           db_name: name,
           write_concern: write_concern,
           session: session
-        }).execute(next_primary(nil, session), context: Operation::Context.new(client: client, session: session))
+        }).execute(
+          next_primary(nil, session),
+          context: Operation::Context.new(
+            client: client,
+            session: session,
+            operation_timeouts: operation_timeouts(options)
+          )
+        )
       end
     end
 
@@ -498,8 +516,27 @@ def self.create(client)
       client.instance_variable_set(:@database, database)
     end
 
+    # @return [ Integer | nil ] Operation timeout that is for this database or
+    #   for the corresponding client.
+    #
+    # @api private
     def timeout_ms
       options[:timeout_ms] || client.timeout_ms
     end
+
+    # @return [ Hash ] timeout_ms value set on the operation level (if any),
+    #   and/or timeout_ms that is set on collection/database/client level (if any).
+    #
+    # @api private
+    def operation_timeouts(opts)
+      # TODO: We should re-evaluate if we need two timeouts separately.
+      {}.tap do |result|
+        if opts[:timeout_ms].nil?
+          result[:inherited_timeout_ms] = timeout_ms
+        else
+          result[:operation_timeout_ms] = opts.delete(:timeout_ms)
+        end
+      end
+    end
   end
 end

spec/mongo/client_spec.rb

@@ -561,6 +561,74 @@
         expect(command['comment']).to eq('comment')
       end
     end
+
+    context 'with timeout_ms' do
+      # To make it easier with failCommand
+      require_topology :single
+
+      before do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "alwaysOn",
+          data: {
+              failCommands: ["listDatabases"],
+              blockConnection: true,
+              blockTimeMS: 100
+            }
+        })
+      end
+
+      after do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "off"
+        })
+      end
+
+      context 'when timeout_ms is set on command level' do
+        context 'when there is not enough time' do
+          it 'raises' do
+            expect do
+              monitored_client.database_names({}, timeout_ms: 50)
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          it 'does not raise' do
+            expect do
+              monitored_client.database_names({}, timeout_ms: 200)
+            end.not_to raise_error
+          end
+        end
+      end
+
+      context 'when timeout_ms is set on client level' do
+        context 'when there is not enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 50)
+          end
+
+          it 'raises' do
+            expect do
+              client.database_names({})
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 200)
+          end
+
+          it 'does not raise' do
+            expect do
+              monitored_client.database_names({})
+            end.not_to raise_error
+          end
+        end
+      end
+    end
   end
 
   describe '#list_databases' do
@@ -572,8 +640,6 @@
     end
 
     context 'when filter criteria is present' do
-      min_server_fcv '3.6'
-
       include_context 'ensure test db exists'
 
       let(:result) do
@@ -591,8 +657,6 @@
     end
 
     context 'when name_only is true' do
-      min_server_fcv '3.6'
-
       let(:command) do
         Utils.get_command_event(root_authorized_client, 'listDatabases') do |client|
           client.list_databases({}, true)
@@ -667,6 +731,71 @@
         expect(command['comment']).to eq('comment')
       end
     end
+
+    context 'with timeout_ms' do
+      before do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "alwaysOn",
+          data: {
+              failCommands: ["listDatabases"],
+              blockConnection: true,
+              blockTimeMS: 100
+            }
+        })
+      end
+
+      after do
+        root_authorized_client.use('admin').command({
+          configureFailPoint: "failCommand",
+          mode: "off"
+        })
+      end
+
+      context 'when timeout_ms is set on command level' do
+        context 'when there is not enough time' do
+          it 'raises' do
+            expect do
+              monitored_client.list_databases({}, false, timeout_ms: 50)
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          it 'does not raise' do
+            expect do
+              monitored_client.list_databases({}, false, timeout_ms: 200)
+            end.not_to raise_error
+          end
+        end
+      end
+
+      context 'when timeout_ms is set on client level' do
+        context 'when there is not enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 50)
+          end
+
+          it 'raises' do
+            expect do
+              client.list_databases({})
+            end.to raise_error(Mongo::Error::TimeoutError)
+          end
+        end
+
+        context 'when there is enough time' do
+          let(:client) do
+            root_authorized_client.with(timeout_ms: 200)
+          end
+
+          it 'does not raise' do
+            expect do
+              monitored_client.list_databases({})
+            end.not_to raise_error
+          end
+        end
+      end
+    end
   end
 
   describe '#list_mongo_databases' do