mongo 2.23.0 → 2.24.0

data/lib/mongo/collection/helpers.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2022 MongoDB Inc.
 #
@@ -21,7 +20,7 @@ module Mongo
     #
     # @api private
     module Helpers
-      # Executes drop operation and and ignores NamespaceNotFound error.
+      # Executes drop operation and ignores NamespaceNotFound error.
       #
       # @param [ Operation::Drop ] operation Drop operation to be executed.
       # @param [ Session ] session Session to be use for execution.
@@ -30,13 +29,11 @@ module Mongo
       # @return [ Result ] The result of the execution.
       def do_drop(operation, session, context)
         operation.execute(next_primary(nil, session), context: context)
-      rescue Error::OperationFailure::Family => ex
+      rescue Error::OperationFailure::Family => e
         # NamespaceNotFound
-        if ex.code == 26 || ex.code.nil? && ex.message =~ /ns not found/
-          false
-        else
-          raise
-        end
+        raise unless e.code == 26 || (e.code.nil? && e.message =~ /ns not found/)
+
+        false
       end
     end
   end

data/lib/mongo/collection/view/aggregation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/collection/view/aggregation/behavior'
 module Mongo
   class Collection
     class View
-
       # Provides behavior around an aggregation pipeline on a collection view.
       #
       # @since 2.0.0
@@ -71,9 +69,7 @@ module Mongo
         def initialize(view, pipeline, options = {})
           perform_setup(view, options) do
             @pipeline = pipeline.dup
-            unless Mongo.broken_view_aggregate || view.filter.empty?
-              @pipeline.unshift(:$match => view.filter)
-            end
+            @pipeline.unshift(:$match => view.filter) unless Mongo.broken_view_aggregate || view.filter.empty?
           end
         end
 
@@ -104,20 +100,19 @@ module Mongo
         def effective_read_preference(connection)
           return unless view.read_preference
           return view.read_preference unless write?
-          return view.read_preference unless [:secondary, :secondary_preferred].include?(view.read_preference[:mode])
+          return view.read_preference unless %i[secondary secondary_preferred].include?(view.read_preference[:mode])
 
-          primary_read_preference = {mode: :primary}
+          primary_read_preference = { mode: :primary }
           description = connection.description
           if description.primary?
-            log_warn("Routing the Aggregation operation to the primary server")
+            log_warn('Routing the Aggregation operation to the primary server')
             primary_read_preference
           elsif description.mongos? && !description.features.merge_out_on_secondary_enabled?
-            log_warn("Routing the Aggregation operation to the primary server")
+            log_warn('Routing the Aggregation operation to the primary server')
             primary_read_preference
           else
             view.read_preference
           end
-
         end
 
         def send_initial_query(server, context, operation: nil)

data/lib/mongo/collection/view/builder/aggregation.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ module Mongo
   class Collection
     class View
       module Builder
-
         # Builds an aggregation command specification from the view and options.
         #
         # @since 2.2.0
@@ -40,7 +38,7 @@ module Mongo
             # This is intentional; max_await_time_ms is an alias for maxTimeMS
             # used on getMore commands for change streams.
             max_await_time_ms: 'maxTimeMS',
-            max_time_ms: 'maxTimeMS',
+            max_time_ms: 'maxTimeMS'
           ).freeze
 
           def_delegators :@view, :collection, :database, :read, :write_concern
@@ -83,9 +81,7 @@ module Mongo
               session: @options[:session],
               collation: @options[:collation],
             }
-            if write?
-              spec.update(write_concern: write_concern)
-            end
+            spec.update(write_concern: write_concern) if write?
             spec
           end
 
@@ -94,7 +90,7 @@ module Mongo
           def write?
             pipeline.any? do |operator|
               operator[:$out] || operator['$out'] ||
-              operator[:$merge] || operator['$merge']
+                operator[:$merge] || operator['$merge']
             end
           end
 
@@ -111,7 +107,8 @@ module Mongo
             command[:pipeline] = pipeline
             if read_concern = view.read_concern
               command[:readConcern] = Options::Mapper.transform_values_to_strings(
-                read_concern)
+                read_concern
+              )
             end
             command[:cursor] = batch_size_doc
             command.merge!(Options::Mapper.transform_documents(options, MAPPINGS))
@@ -123,7 +120,7 @@ module Mongo
             if value == 0 && write?
               {}
             elsif value
-              { :batchSize => value }
+              { batchSize: value }
             else
               {}
             end

data/lib/mongo/collection/view/builder/map_reduce.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ module Mongo
   class Collection
     class View
       module Builder
-
         # Builds a map/reduce specification from the view and options.
         #
         # @since 2.2.0
@@ -36,7 +34,7 @@ module Mongo
             scope: 'scope',
             verbose: 'verbose',
             bypass_document_validation: 'bypassDocumentValidation',
-            collation: 'collation',
+            collation: 'collation'
           ).freeze
 
           def_delegators :@view, :collection, :database, :filter, :read, :write_concern
@@ -94,24 +92,25 @@ module Mongo
           private
 
           def write?(spec)
-            if out = spec[:selector][:out]
-              out.is_a?(String) ||
-                (out.respond_to?(:keys) && out.keys.first.to_s.downcase != View::MapReduce::INLINE)
-            end
+            return unless out = spec[:selector][:out]
+
+            out.is_a?(String) ||
+              (out.respond_to?(:keys) && out.keys.first.to_s.downcase != View::MapReduce::INLINE)
           end
 
           def map_reduce_command
             command = BSON::Document.new(
-              :mapReduce => collection.name,
-              :map => map,
-              :reduce => reduce,
-              :query => filter,
-              :out => { inline: 1 },
+              mapReduce: collection.name,
+              map: map,
+              reduce: reduce,
+              query: filter,
+              out: { inline: 1 }
             )
             # Shouldn't this use self.read ?
             if collection.read_concern
               command[:readConcern] = Options::Mapper.transform_values_to_strings(
-                collection.read_concern)
+                collection.read_concern
+              )
             end
             command.update(view_options)
             command.update(options.slice(:collation))
@@ -121,16 +120,18 @@ module Mongo
             # Ideally it should be removed here, however due to Mongoid 7
             # using this method and requiring :read to be returned from it,
             # we cannot do this just yet - see RUBY-2932.
-            #command.delete(:read)
+            # command.delete(:read)
 
             command.merge!(Options::Mapper.transform_documents(options, MAPPINGS))
             command
           end
 
           def view_options
-            @view_options ||= (opts = view.options.dup
-                               opts.delete(:session)
-                               opts)
+            @view_options ||= begin
+              opts = view.options.dup
+              opts.delete(:session)
+              opts
+            end
           end
         end
       end

data/lib/mongo/collection/view/builder.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/collection/view/change_stream/retryable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -19,22 +18,18 @@ module Mongo
   class Collection
     class View
       class ChangeStream < Aggregation
-
         # Behavior around resuming a change stream.
         #
         # @since 2.5.0
         module Retryable
-
           private
 
           def read_with_one_retry
             yield
           rescue Mongo::Error => e
-            if e.change_stream_resumable?
-              yield
-            else
-              raise(e)
-            end
+            raise(e) unless e.change_stream_resumable?
+
+            yield
           end
         end
       end

data/lib/mongo/collection/view/change_stream.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
@@ -21,20 +20,11 @@ require 'mongo/collection/view/change_stream/retryable'
 module Mongo
   class Collection
     class View
-
       # Provides behavior around a `$changeStream` pipeline stage in the
       # aggregation framework. Specifying this stage allows users to request
       # that notifications are sent for all changes to a particular collection
       # or database.
       #
-      # @note Only available in server versions 3.6 and higher.
-      # @note ChangeStreams do not work properly with JRuby because of the
-      #  issue documented here: https://github.com/jruby/jruby/issues/4212.
-      #  Namely, JRuby eagerly evaluates #next on an Enumerator in a background
-      #  green thread, therefore calling #next on the change stream will cause
-      #  getMores to be called in a loop in the background.
-      #
-      #
       # @since 2.5.0
       class ChangeStream
         include Aggregation::Behavior
@@ -43,7 +33,7 @@ module Mongo
         # @return [ String ] The fullDocument option default value.
         #
         # @since 2.5.0
-        FULL_DOCUMENT_DEFAULT = 'default'.freeze
+        FULL_DOCUMENT_DEFAULT = 'default'
 
         # @return [ Symbol ] Used to indicate that the change stream should listen for changes on
         #   the entire database rather than just the collection.
@@ -66,6 +56,16 @@ module Mongo
         # @api private
         attr_reader :cursor
 
+        # Refreshes the CSOT timeout for the next iteration. Delegates to the
+        # underlying cursor's refresh_timeout! method so that each call to
+        # try_next starts with a fresh timeout deadline, as required by the
+        # CSOT spec for tailable awaitData cursors.
+        #
+        # @api private
+        def refresh_timeout!
+          @cursor&.refresh_timeout!
+        end
+
         # Initialize the change stream for the provided collection view, pipeline
         # and options.
         #
@@ -114,7 +114,7 @@ module Mongo
         # @option options [ BSON::Timestamp ] :start_at_operation_time Only
         #   return changes that occurred at or after the specified timestamp. Any
         #   command run against the server will return a cluster time that can
-        #   be used here. Only recognized by server versions 4.0+.
+        #   be used here.
         # @option options [ Bson::Document, Hash ] :start_after Similar to :resume_after, this
         #   option takes a resume token and starts a new change stream returning the first
         #   notification after the token. This will allow users to watch collections that have been
@@ -168,12 +168,13 @@ module Mongo
         # @yieldparam [ BSON::Document ] Each change stream document.
         def each
           raise StopIteration.new if closed?
+
           loop do
             document = try_next
             yield document if document
           end
         rescue StopIteration
-          return self
+          self
         end
 
         # Return one document from the change stream, if one is available.
@@ -218,9 +219,8 @@ module Mongo
 
           # We need to verify each doc has an _id, so we
           # have a resume token to work with
-          if doc && doc['_id'].nil?
-            raise Error::MissingResumeToken
-          end
+          raise Error::MissingResumeToken if doc && doc['_id'].nil?
+
           doc
         end
 
@@ -252,14 +252,14 @@ module Mongo
         #
         # @since 2.5.0
         def close(opts = {})
-          unless closed?
-            begin
-              @cursor.close(opts)
-            rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::MissingConnection
-              # ignore
-            end
-            @cursor = nil
+          return if closed?
+
+          begin
+            @cursor.close(opts)
+          rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::MissingConnection
+            # ignore
           end
+          @cursor = nil
         end
 
         # Is the change stream closed?
@@ -340,61 +340,66 @@ module Mongo
         def create_cursor!(timeout_ms = nil)
           # clear the cache because we may get a newer or an older server
           # (rolling upgrades)
-          @start_at_operation_time_supported = nil
-
           session = client.get_session(@options)
-          context = Operation::Context.new(client: client, session: session, view: self, operation_timeouts: timeout_ms ? { operation_timeout_ms: timeout_ms } : operation_timeouts)
+          context = Operation::Context.new(client: client, session: session, view: self,
+                                           operation_timeouts: timeout_ms ? { operation_timeout_ms: timeout_ms } : operation_timeouts)
 
           start_at_operation_time = nil
-          start_at_operation_time_supported = nil
 
           @cursor = read_with_retry_cursor(session, server_selector, self, context: context) do |server|
-            server.with_connection do |connection|
-              start_at_operation_time_supported = connection.description.server_version_gte?('4.0')
-
+            if server.load_balancer?
+              # In load balanced topology, manually check out a connection
+              # so it remains checked out and pinned to the cursor.
+              connection = server.pool.check_out(context: context)
               result = send_initial_query(connection, context)
 
-              if doc = result.replies.first && result.replies.first.documents.first
-                start_at_operation_time = doc['operationTime']
-              else
-                # The above may set @start_at_operation_time to nil
-                # if it was not in the document for some reason,
-                # for consistency set it to nil here as well.
-                # NB: since this block may be executed more than once, each
-                # execution must write to start_at_operation_time either way.
-                start_at_operation_time = nil
-              end
+              start_at_operation_time = if doc = result.replies.first && result.replies.first.documents.first
+                                          doc['operationTime']
+                                        else
+                                          nil
+                                        end
               result
+            else
+              server.with_connection do |connection|
+                result = send_initial_query(connection, context)
+
+                start_at_operation_time = if doc = result.replies.first && result.replies.first.documents.first
+                                            doc['operationTime']
+                                          else
+                                            # The above may set @start_at_operation_time to nil
+                                            # if it was not in the document for some reason,
+                                            # for consistency set it to nil here as well.
+                                            # NB: since this block may be executed more than once, each
+                                            # execution must write to start_at_operation_time either way.
+                                            nil
+                                          end
+                result
+              end
             end
           end
 
           @start_at_operation_time = start_at_operation_time
-          @start_at_operation_time_supported = start_at_operation_time_supported
         end
 
         def pipeline
-          [{ '$changeStream' => change_doc }] + @change_stream_filters
+          [ { '$changeStream' => change_doc } ] + @change_stream_filters
         end
 
         def aggregate_spec(session, read_preference)
-          super(session, read_preference).tap do |spec|
+          super.tap do |spec|
             spec[:selector][:aggregate] = 1 unless for_collection?
           end
         end
 
         def change_doc
           {}.tap do |doc|
-            if @options[:full_document]
-              doc[:fullDocument] = @options[:full_document]
-            end
+            doc[:fullDocument] = @options[:full_document] if @options[:full_document]
 
             if @options[:full_document_before_change]
               doc[:fullDocumentBeforeChange] = @options[:full_document_before_change]
             end
 
-            if @options.key?(:show_expanded_events)
-              doc[:showExpandedEvents] = @options[:show_expanded_events]
-            end
+            doc[:showExpandedEvents] = @options[:show_expanded_events] if @options.key?(:show_expanded_events)
 
             if resuming?
               # We have a resume token once we retrieved any documents.
@@ -405,12 +410,7 @@ module Mongo
                 # Spec says we need to remove both startAtOperationTime and startAfter if
                 # either was passed in by user, thus we won't forward them
                 doc[:resumeAfter] = resume_token
-              elsif @start_at_operation_time_supported && @start_at_operation_time
-                # It is crucial to check @start_at_operation_time_supported
-                # here - we may have switched to an older server that
-                # does not support operation times and therefore shouldn't
-                # try to send one to it!
-                #
+              elsif @start_at_operation_time
                 # @start_at_operation_time is already a BSON::Timestamp
                 doc[:startAtOperationTime] = @start_at_operation_time
               else
@@ -426,7 +426,8 @@ module Mongo
 
               if options[:start_at_operation_time]
                 doc[:startAtOperationTime] = time_to_bson_timestamp(
-                  options[:start_at_operation_time])
+                  options[:start_at_operation_time]
+                )
               end
             end
 
@@ -438,14 +439,14 @@ module Mongo
           initial_query_op(context.session, view.read_preference)
             .execute_with_connection(
               connection,
-              context: context,
+              context: context
             )
         end
 
         def time_to_bson_timestamp(time)
           if time.is_a?(Time)
             seconds = time.to_f
-            BSON::Timestamp.new(seconds.to_i, ((seconds - seconds.to_i) * 1000000).to_i)
+            BSON::Timestamp.new(seconds.to_i, ((seconds - seconds.to_i) * 1_000_000).to_i)
           elsif time.is_a?(BSON::Timestamp)
             time
           else

data/lib/mongo/collection/view/explainable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,38 +17,34 @@
 module Mongo
   class Collection
     class View
-
       # Defines explain related behavior for collection view.
       #
       # @since 2.0.0
       module Explainable
-
         # The query planner verbosity constant.
         #
         # @since 2.2.0
-        QUERY_PLANNER = 'queryPlanner'.freeze
+        QUERY_PLANNER = 'queryPlanner'
 
         # The execution stats verbosity constant.
         #
         # @since 2.2.0
-        EXECUTION_STATS = 'executionStats'.freeze
+        EXECUTION_STATS = 'executionStats'
 
         # The all plans execution verbosity constant.
         #
         # @since 2.2.0
-        ALL_PLANS_EXECUTION = 'allPlansExecution'.freeze
+        ALL_PLANS_EXECUTION = 'allPlansExecution'
 
         # Get the query plan for the query.
         #
         # @example Get the query plan for the query with execution statistics.
         #   view.explain(verbosity: :execution_stats)
         #
-        # @option opts [ true | false ] :verbose The level of detail
-        #   to return for MongoDB 2.6 servers.
         # @option opts [ String | Symbol ] :verbosity The type of information
-        #   to return for MongoDB 3.0 and newer servers. If the value is a
-        #   symbol, it will be stringified and converted from underscore
-        #   style to camel case style (e.g. :query_planner => "queryPlanner").
+        #   to return. If the value is a symbol, it will be stringified and
+        #   converted from underscore style to camel case style
+        #   (e.g. :query_planner => "queryPlanner").
         #
         # @return [ Hash ] A single document with the query plan.
         #
@@ -66,18 +61,14 @@ module Mongo
           !!options[:explain]
         end
 
-        # @option opts [ true | false ] :verbose The level of detail
-        #   to return for MongoDB 2.6 servers.
         # @option opts [ String | Symbol ] :verbosity The type of information
-        #   to return for MongoDB 3.0 and newer servers. If the value is a
-        #   symbol, it will be stringified and converted from underscore
-        #   style to camel case style (e.g. :query_planner => "queryPlanner").
+        #   to return. If the value is a symbol, it will be stringified and
+        #   converted from underscore style to camel case style
+        #   (e.g. :query_planner => "queryPlanner").
         def explain_options(**opts)
           explain_limit = limit || 0
-          # Note: opts will never be nil here.
-          if Symbol === opts[:verbosity]
-            opts[:verbosity] = Utils.camelize(opts[:verbosity])
-          end
+          # NOTE: opts will never be nil here.
+          opts[:verbosity] = Utils.camelize(opts[:verbosity]) if opts[:verbosity].is_a?(Symbol)
           { limit: -explain_limit.abs, explain: opts }
         end
       end

data/lib/mongo/collection/view/immutable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,12 +17,10 @@
 module Mongo
   class Collection
     class View
-
       # Defines behavior around views being configurable and immutable.
       #
       # @since 2.0.0
       module Immutable
-
         # @return [ Hash ] options The additional query options.
         attr_reader :options
 
@@ -31,6 +28,7 @@ module Mongo
 
         def configure(field, value)
           return options[field] if value.nil?
+
           new(options.merge(field => value))
         end
       end