mongo 2.22.0 → 2.24.0

data/lib/mongo/cursor.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -16,7 +15,6 @@
 # limitations under the License.
 
 module Mongo
-
   # Client-side representation of an iterator over a query result set on
   # the server.
   #
@@ -82,14 +80,14 @@ module Mongo
       @namespace = result.namespace
       @remaining = limit if limited?
       set_cursor_id(result)
-      if @cursor_id.nil?
-        raise ArgumentError, 'Cursor id must be present in the result'
-      end
+      raise ArgumentError, 'Cursor id must be present in the result' if @cursor_id.nil?
+
       @options = options
       @session = @options[:session]
       @connection_global_id = result.connection_global_id
       @context = @options[:context]&.with(connection_global_id: connection_global_id_for_context) || fresh_context
       @explicitly_closed = false
+      @get_more_network_error = false
       @lock = Mutex.new
       if server.load_balancer?
         # We need the connection in the cursor only in load balanced topology;
@@ -126,9 +124,8 @@ module Mongo
     #
     # @api private
     def self.finalize(kill_spec, cluster)
-      unless KillSpec === kill_spec
-        raise ArgumentError, "First argument must be a KillSpec: #{kill_spec.inspect}"
-      end
+      raise ArgumentError, "First argument must be a KillSpec: #{kill_spec.inspect}" unless kill_spec.is_a?(KillSpec)
+
       proc do
         cluster.schedule_kill_cursor(kill_spec)
       end
@@ -161,7 +158,6 @@ module Mongo
     #
     # @since 2.0.0
     def each
-
       # If we already iterated past the first batch (i.e., called get_more
       # at least once), the cursor on the server side has advanced past
       # the first batch and restarting iteration from the beginning by
@@ -184,9 +180,8 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
-          if explicitly_closed?
-            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
-          end
+          raise Error::InvalidCursorOperation, 'Cursor was explicitly closed' if explicitly_closed?
+
           yield document if document
         end
         self
@@ -195,9 +190,8 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
-          if explicitly_closed?
-            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
-          end
+          raise Error::InvalidCursorOperation, 'Cursor was explicitly closed' if explicitly_closed?
+
           documents << document if document
         end
         documents
@@ -235,16 +229,16 @@ module Mongo
         # On empty batches, we cache the batch resume token
         cache_batch_resume_token
 
-        unless closed?
+        if closed?
+          @fully_iterated = true
+          raise StopIteration
+        else
           if exhausted?
             close
             @fully_iterated = true
             raise StopIteration
           end
           @documents = get_more
-        else
-          @fully_iterated = true
-          raise StopIteration
         end
       else
         # cursor is closed here
@@ -252,20 +246,16 @@ module Mongo
       end
 
       # If there is at least one document, cache its _id
-      if @documents[0]
-        cache_resume_token(@documents[0])
-      end
+      cache_resume_token(@documents[0]) if @documents[0]
 
       # Cache the batch resume token if we are iterating
       # over the last document, or if the batch is empty
       if @documents.size <= 1
         cache_batch_resume_token
-        if closed?
-          @fully_iterated = true
-        end
+        @fully_iterated = true if closed?
       end
 
-      return @documents.shift
+      @documents.shift
     end
 
     # Get the batch size.
@@ -277,7 +267,7 @@ module Mongo
     #
     # @since 2.2.0
     def batch_size
-      value = @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
+      value = (@view.batch_size && @view.batch_size > 0) ? @view.batch_size : limit
       if value == 0
         nil
       else
@@ -308,19 +298,21 @@ module Mongo
       ctx = context ? context.refresh(timeout_ms: opts[:timeout_ms]) : fresh_context(opts)
 
       unregister
-      read_with_one_retry do
-        spec = {
-          coll_name: collection_name,
-          db_name: database.name,
-          cursor_ids: [id],
-        }
-        op = Operation::KillCursors.new(spec)
-        execute_operation(op, context: ctx)
+      unless @get_more_network_error
+        read_with_one_retry do
+          spec = {
+            coll_name: collection_name,
+            db_name: database.name,
+            cursor_ids: [ id ],
+          }
+          op = Operation::KillCursors.new(spec)
+          execute_operation(op, context: ctx)
+        end
       end
 
       nil
-    rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable
-      # Errors are swallowed since there is noting can be done by handling them.
+    rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable, Error::ConnectionPerished
+      # Errors are swallowed since there is nothing can be done by handling them.
     ensure
       end_session
       @cursor_id = 0
@@ -369,19 +361,6 @@ module Mongo
       @cursor_id
     end
 
-    # Get the number of documents to return. Used on 3.0 and lower server
-    # versions.
-    #
-    # @example Get the number to return.
-    #   cursor.to_return
-    #
-    # @return [ Integer ] The number of documents to return.
-    #
-    # @since 2.2.0
-    def to_return
-      use_limit? ? @remaining : (batch_size || 0)
-    end
-
     # Execute a getMore command and return the batch of documents
     # obtained from the server.
     #
@@ -396,7 +375,21 @@ module Mongo
       # doing so may result in silent data loss, the driver no longer retries
       # getMore operations in any circumstance.
       # https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.md#qa
-      process(execute_operation(get_more_operation))
+      #
+      # However, overload errors (SystemOverloadedError + RetryableError) are
+      # retried with exponential backoff since the server never processed
+      # the request.
+      with_overload_retry(context: possibly_refreshed_context) do
+        process(execute_operation(get_more_operation))
+      end
+    rescue Error::SocketError, Error::SocketTimeoutError
+      @get_more_network_error = true
+      raise
+    rescue Error::OperationFailure => e
+      # When overload retries are exhausted on getMore, close the cursor
+      # so that killCursors is sent to the server.
+      close if e.label?('RetryableError') && e.label?('SystemOverloadedError')
+      raise
     end
 
     # @api private
@@ -417,6 +410,18 @@ module Mongo
       !!@fully_iterated
     end
 
+    # Refreshes the cursor's CSOT context so that the next getMore starts
+    # with a fresh timeout deadline. Used by tailable awaitData cursors to
+    # implement per-iteration timeout refresh as required by the CSOT spec.
+    # Only refreshes if this is a tailable awaitData cursor with an active timeout.
+    #
+    # @api private
+    def refresh_timeout!
+      return unless view.cursor_type == :tailable_await && context.timeout?
+
+      @context = @context.refresh(view: view)
+    end
+
     private
 
     def explicitly_closed?
@@ -427,7 +432,7 @@ module Mongo
 
     def batch_size_for_get_more
       if batch_size && use_limit?
-        [batch_size, @remaining].min
+        [ batch_size, @remaining ].min
       else
         batch_size
       end
@@ -438,9 +443,9 @@ module Mongo
     end
 
     def cache_resume_token(doc)
-      if doc[:_id] && doc[:_id].is_a?(Hash)
-        @resume_token = doc[:_id] && doc[:_id].dup.freeze
-      end
+      return unless doc[:_id] && doc[:_id].is_a?(Hash)
+
+      @resume_token = doc[:_id] && doc[:_id].dup.freeze
     end
 
     def cache_batch_resume_token
@@ -453,13 +458,10 @@ module Mongo
         db_name: database.name,
         coll_name: collection_name,
         cursor_id: id,
-        # 3.2+ servers use batch_size, 3.0- servers use to_return.
-        # TODO should to_return be calculated in the operation layer?
         batch_size: batch_size_for_get_more,
-        to_return: to_return
       }
-      if view.respond_to?(:options) && view.options.is_a?(Hash)
-        spec[:comment] = view.options[:comment] unless view.options[:comment].nil?
+      if view.respond_to?(:options) && view.options.is_a?(Hash) && !view.options[:comment].nil?
+        spec[:comment] = view.options[:comment]
       end
       Operation::GetMore.new(spec)
     end
@@ -484,9 +486,7 @@ module Mongo
       end
       @cursor_id = set_cursor_id(result)
 
-      if result.respond_to?(:post_batch_resume_token)
-        @post_batch_resume_token = result.post_batch_resume_token
-      end
+      @post_batch_resume_token = result.post_batch_resume_token if result.respond_to?(:post_batch_resume_token)
 
       end_session if closed?
 
@@ -527,6 +527,11 @@ module Mongo
     # @return [ Operation::Context ] the (possibly-refreshed) context.
     def possibly_refreshed_context
       return context if view.timeout_mode == :cursor_lifetime
+      # For tailable await cursors with CSOT, the timeout budget is shared across
+      # all getMore commands (cumulative). Only update the view reference; keep
+      # the same deadline so remaining time decreases across getMores.
+      return context.with(view: view) if view.cursor_type == :tailable_await
+
       context.refresh(view: view)
     end
 
@@ -580,7 +585,12 @@ module Mongo
       return if @connection.nil?
       return unless @connection.server.load_balancer?
 
-      @connection.connection_pool.check_in(@connection)
+      @connection.unpin
+      # Do not check in if the connection is still pinned by something
+      # else (e.g. a transaction).
+      unless @connection.pinned?
+        @connection.connection_pool.check_in(@connection)
+      end
       @connection = nil
     end
   end

data/lib/mongo/cursor_host.rb

@@ -31,7 +31,6 @@ module Mongo
     #   detected.
     #
     # @api private
-    # rubocop:disable Metrics
     def validate_timeout_mode!(options, forbid: [])
       forbid.each do |key|
         raise ArgumentError, "#{key} is not allowed here" if options.key?(key)
@@ -49,19 +48,19 @@ module Mongo
           if timeout_mode == :cursor_lifetime
             raise ArgumentError, 'tailable cursors only support `timeout_mode: :iteration`'
           end
-
-          # "Drivers MUST error if [the maxAwaitTimeMS] option is set,
-          # timeoutMS is set to a non-zero value, and maxAwaitTimeMS is
-          # greater than or equal to timeoutMS."
-          max_await_time_ms = options[:max_await_time_ms] || 0
-          if cursor_type == :tailable_await && max_await_time_ms >= timeout_ms
-            raise ArgumentError, ':max_await_time_ms must not be >= :timeout_ms'
-          end
         else
           # "For non-tailable cursors, the default value of timeoutMode
           # is CURSOR_LIFETIME."
           timeout_mode ||= :cursor_lifetime
         end
+
+        # "Drivers MUST error if [the maxAwaitTimeMS] option is set,
+        # timeoutMS is set to a non-zero value, and maxAwaitTimeMS is
+        # greater than or equal to timeoutMS."
+        max_await_time_ms = options[:max_await_time_ms] || 0
+        if max_await_time_ms.positive? && max_await_time_ms >= timeout_ms
+          raise ArgumentError, ':max_await_time_ms must not be >= :timeout_ms'
+        end
       elsif timeout_mode
         # "Drivers MUST error if timeoutMode is set and timeoutMS is not."
         raise ArgumentError, ':timeout_ms must be set if :timeout_mode is set'
@@ -77,6 +76,5 @@ module Mongo
       # if no timeout_mode was set initially.
       @timeout_mode = timeout_mode
     end
-    # rubocop:enable Metrics
   end
 end

data/lib/mongo/database/view.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'mongo/cursor/nontailable'
 
 module Mongo
   class Database
-
     # A class representing a view of a database.
     #
     # @since 2.0.0
@@ -45,6 +43,8 @@ module Mongo
       # @return [ Collection ] collection The command collection.
       attr_reader :collection
 
+      def_delegators :@database, :tracer
+
       # Get all the names of the non-system collections in the database.
       #
       # @note The set of returned collection names depends on the version of
@@ -80,19 +80,13 @@ module Mongo
           session: session,
           operation_timeouts: operation_timeouts(options)
         )
+
         cursor = read_with_retry_cursor(session, ServerSelector.primary, self, context: context) do |server|
           send_initial_query(server, session, context, options.merge(name_only: true))
         end
-        cursor.map do |info|
-          if cursor.initial_result.connection_description.features.list_collections_enabled?
-            info['name']
-          else
-            (info['name'] &&
-              info['name'].sub("#{@database.name}.", ''))
-          end
-        end.reject do |name|
-          name.start_with?('system.') || name.include?('$')
-        end
+
+        cursor.map { |info| info['name'] }
+              .reject { |name| name.start_with?('system.') || name.include?('$') }
       end
 
       # Get info on all the collections in the database.
@@ -152,7 +146,7 @@ module Mongo
 
         validate_timeout_mode!(options)
 
-        @batch_size =  nil
+        @batch_size = nil
         @limit = nil
         @collection = @database[Database::COMMAND]
       end
@@ -207,34 +201,26 @@ module Mongo
 
       private
 
-      def collections_info(session, server_selector, options = {}, &block)
+      def collections_info(session, server_selector, options = {})
+        @batch_size = options[:batch_size] if options[:batch_size]
         description = nil
         context = Operation::Context.new(
           client: client,
           session: session,
           operation_timeouts: operation_timeouts(options)
         )
-        cursor = read_with_retry_cursor(session, server_selector, self, context: context) do |server|
-          # TODO take description from the connection used to send the query
-          # once https://jira.mongodb.org/browse/RUBY-1601 is fixed.
-          description = server.description
-          send_initial_query(server, session, context, options)
-        end
-        # On 3.0+ servers, we get just the collection names.
-        # On 2.6 server, we get collection names prefixed with the database
-        # name. We need to filter system collections out here because
-        # in the caller we don't know which server version executed the
-        # command and thus what the proper filtering logic should be
-        # (it is valid for collection names to have dots, thus filtering out
-        # collections named system.* here for 2.6 servers would actually
-        # filter out collections in the system database).
-        if description.server_version_gte?('3.0')
-          cursor.reject do |doc|
-            doc['name'].start_with?('system.') || doc['name'].include?('$')
+        op = initial_query_op(session, options)
+        tracer.trace_operation(op, context, op_name: 'listCollections') do
+          cursor = read_with_retry_cursor(session, server_selector, self, context: context) do |server|
+            # TODO: take description from the connection used to send the query
+            # once https://jira.mongodb.org/browse/RUBY-1601 is fixed.
+            description = server.description
+            send_initial_query(server, session, context, options)
           end
-        else
+
+          # Filter out the system collections
           cursor.reject do |doc|
-            doc['name'].start_with?("#{database.name}.system") || doc['name'].include?('$')
+            doc['name'].start_with?('system.') || doc['name'].include?('$')
           end
         end
       end
@@ -242,10 +228,10 @@ module Mongo
       def collections_info_spec(session, options = {})
         { selector: {
             listCollections: 1,
-            cursor: batch_size ? { batchSize: batch_size } : {} },
+            cursor: batch_size ? { batchSize: batch_size } : {}
+          },
           db_name: @database.name,
-          session: session
-        }.tap do |spec|
+          session: session }.tap do |spec|
           spec[:selector][:nameOnly] = true if options[:name_only]
           spec[:selector][:filter] = options[:filter] if options[:filter]
           spec[:selector][:authorizedCollections] = true if options[:authorized_collections]
@@ -285,9 +271,7 @@ module Mongo
       def send_initial_query(server, session, context, options = {})
         opts = options.dup
         execution_opts = {}
-        if opts.key?(:deserialize_as_bson)
-          execution_opts[:deserialize_as_bson] = opts.delete(:deserialize_as_bson)
-        end
+        execution_opts[:deserialize_as_bson] = opts.delete(:deserialize_as_bson) if opts.key?(:deserialize_as_bson)
         if server.load_balancer?
           connection = server.pool.check_out(context: context)
           initial_query_op(session, opts).execute_with_connection(