mongo 2.22.0 → 2.24.0

data/lib/mongo/operation/find/builder/command.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,12 +18,10 @@ module Mongo
   module Operation
     class Find
       module Builder
-
         # Builds a find command specification from options.
         #
         # @api private
         module Command
-
           # The mappings from ruby options to the find command.
           OPTION_MAPPINGS = BSON::Document.new(
             allow_disk_use: 'allowDiskUse',
@@ -52,14 +49,10 @@ module Mongo
             snapshot: 'snapshot',
             sort: 'sort',
             tailable: 'tailable',
-            tailable_cursor: 'tailable',
+            tailable_cursor: 'tailable'
           ).freeze
 
-          module_function def selector(spec, connection)
-            if spec[:collation] && !connection.features.collation_enabled?
-              raise Error::UnsupportedCollation
-            end
-
+          module_function def selector(spec, _connection)
             BSON::Document.new.tap do |selector|
               OPTION_MAPPINGS.each do |k, server_k|
                 unless (value = spec[k]).nil?
@@ -86,13 +79,12 @@ module Mongo
           # The +command+ parameter is mutated by this method.
           module_function def convert_limit_and_batch_size!(command)
             if command[:limit] && command[:limit] < 0 &&
-              command[:batchSize] && command[:batchSize] < 0
-            then
+               command[:batchSize] && command[:batchSize] < 0
               command[:limit] = command[:limit].abs
               command[:batchSize] = command[:limit].abs
               command[:singleBatch] = true
             else
-              [:limit, :batchSize].each do |opt|
+              %i[limit batchSize].each do |opt|
                 if command[opt]
                   if command[opt] < 0
                     command[opt] = command[opt].abs

data/lib/mongo/operation/find/builder/flags.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,22 +18,20 @@ module Mongo
   module Operation
     class Find
       module Builder
-
         # Provides behavior for converting Ruby options to wire protocol flags
         # when sending find and related commands (e.g. explain).
         #
         # @api private
         module Flags
-
           # Options to cursor flags mapping.
           MAPPINGS = {
-            :allow_partial_results => [ :partial ],
-            :oplog_replay => [ :oplog_replay ],
-            :no_cursor_timeout => [ :no_cursor_timeout ],
-            :tailable => [ :tailable_cursor ],
-            :tailable_await => [ :await_data, :tailable_cursor],
-            :await_data => [ :await_data ],
-            :exhaust => [ :exhaust ],
+            allow_partial_results: [ :partial ],
+            oplog_replay: [ :oplog_replay ],
+            no_cursor_timeout: [ :no_cursor_timeout ],
+            tailable: [ :tailable_cursor ],
+            tailable_await: %i[await_data tailable_cursor],
+            await_data: [ :await_data ],
+            exhaust: [ :exhaust ],
           }.freeze
 
           # Converts Ruby find options to an array of flags.
@@ -46,12 +43,9 @@ module Mongo
           #
           # @return [ Array<Symbol> ] The flags.
           module_function def map_flags(options)
-            MAPPINGS.each.reduce(options[:flags] || []) do |flags, (key, value)|
+            MAPPINGS.each.each_with_object(options[:flags] || []) do |(key, value), flags|
               cursor_type = options[:cursor_type]
-              if options[key] || (cursor_type && cursor_type == key)
-                flags.push(*value)
-              end
-              flags
+              flags.push(*value) if options[key] || (cursor_type && cursor_type == key)
             end
           end
         end

data/lib/mongo/operation/find/builder/modifiers.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ module Mongo
   module Operation
     class Find
       module Builder
-
         # Provides behavior for mapping Ruby options to legacy OP_QUERY
         # find modifiers.
         #
@@ -34,7 +32,6 @@ module Mongo
         #
         # @api private
         module Modifiers
-
           # Mappings from Ruby options to OP_QUERY modifiers.
           DRIVER_MAPPINGS = BSON::Document.new(
             comment: '$comment',
@@ -47,7 +44,7 @@ module Mongo
             return_key: '$returnKey',
             show_disk_loc: '$showDiskLoc',
             snapshot: '$snapshot',
-            sort: '$orderby',
+            sort: '$orderby'
           ).freeze
 
           # Mappings from OP_QUERY modifiers to Ruby options.

data/lib/mongo/operation/find/builder.rb

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

data/lib/mongo/operation/find/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class Find
-
       # A MongoDB find operation sent as an op message.
       #
       # @api private
@@ -49,26 +47,20 @@ module Mongo
           when nil # non-tailable
             if view.timeout_mode == :cursor_lifetime
               spec[:maxTimeMS] = timeout_ms || view.options[:max_time_ms]
-            else # timeout_mode == :iterable
+            elsif !timeout_ms && view.options[:max_time_ms] # timeout_mode == :iterable
               # drivers MUST honor the timeoutMS option for the initial command
               # but MUST NOT append a maxTimeMS field to the command sent to the
               # server
-              if !timeout_ms && view.options[:max_time_ms]
-                spec[:maxTimeMS] = view.options[:max_time_ms]
-              end
+              spec[:maxTimeMS] = view.options[:max_time_ms]
             end
 
           when :tailable
             # If timeoutMS is set, drivers...MUST NOT append a maxTimeMS field to any commands.
-            if !timeout_ms && view.options[:max_time_ms]
-              spec[:maxTimeMS] = view.options[:max_time_ms]
-            end
+            spec[:maxTimeMS] = view.options[:max_time_ms] if !timeout_ms && view.options[:max_time_ms]
 
           when :tailable_await
             # The server supports the maxTimeMS option for the original command.
-            if timeout_ms || view.options[:max_time_ms]
-              spec[:maxTimeMS] = timeout_ms || view.options[:max_time_ms]
-            end
+            spec[:maxTimeMS] = timeout_ms || view.options[:max_time_ms] if timeout_ms || view.options[:max_time_ms]
           end
 
           spec.tap do |spc|

data/lib/mongo/operation/find/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,13 +17,11 @@
 module Mongo
   module Operation
     class Find
-
       # Defines custom behavior of results in find command.
       #
       # @since 2.2.0
       # @api semiprivate
       class Result < Operation::Result
-
         # Get the cursor id.
         #
         # @example Get the cursor id.

data/lib/mongo/operation/find.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -21,7 +20,6 @@ require 'mongo/operation/find/builder'
 
 module Mongo
   module Operation
-
     # A MongoDB find operation.
     #
     # @api private

data/lib/mongo/operation/get_more/command_builder.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -18,10 +17,8 @@
 module Mongo
   module Operation
     class GetMore
-
       # @api private
       module CommandBuilder
-
         private
 
         def selector(connection)
@@ -31,9 +28,7 @@ module Mongo
             batchSize: spec[:batch_size],
             maxTimeMS: spec[:max_time_ms],
           }.compact.tap do |sel|
-            if spec[:comment] && connection.features.get_more_comment_enabled?
-              sel[:comment] = spec[:comment]
-            end
+            sel[:comment] = spec[:comment] if spec[:comment] && connection.features.get_more_comment_enabled?
           end
         end
       end

data/lib/mongo/operation/get_more/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class GetMore
-
       # A MongoDB getMore operation sent as an op message.
       #
       # @api private
@@ -54,9 +52,17 @@ module Mongo
             # maxAwaitTimeMS option. Drivers MUST error if this option is set,
             # timeoutMS is set to a non-zero value, and maxAwaitTimeMS is greater
             # than or equal to timeoutMS. If this option is set, drivers MUST use
-            # it as the maxTimeMS field on getMore commands.
+            # it as the maxTimeMS field on getMore commands, capped at remaining
+            # CSOT timeout if less than maxAwaitTimeMS.
             max_await_time_ms = view.respond_to?(:max_await_time_ms) ? view.max_await_time_ms : nil
-            spec[:maxTimeMS] = max_await_time_ms if max_await_time_ms
+            if max_await_time_ms
+              effective_ms = if timeout_ms && timeout_ms < max_await_time_ms
+                               timeout_ms
+                             else
+                               max_await_time_ms
+                             end
+              spec[:maxTimeMS] = effective_ms
+            end
           end
 
           spec

data/lib/mongo/operation/get_more/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,13 +17,11 @@
 module Mongo
   module Operation
     class GetMore
-
       # Defines custom behavior of results for the get more command.
       #
       # @since 2.2.0
       # @api semiprivate
       class Result < Operation::Result
-
         # Get the cursor id.
         #
         # @example Get the cursor id.

data/lib/mongo/operation/get_more.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -21,7 +20,6 @@ require 'mongo/operation/get_more/result'
 
 module Mongo
   module Operation
-
     # A MongoDB getMore operation.
     #
     # @api private

data/lib/mongo/operation/indexes/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class Indexes
-
       # A MongoDB indexes operation sent as an op message.
       #
       # @api private

data/lib/mongo/operation/indexes/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,14 +17,12 @@
 module Mongo
   module Operation
     class Indexes
-
       # Defines custom behavior of results when using the
       # listIndexes command.
       #
       # @since 2.0.0
       # @api semiprivate
       class Result < Operation::Result
-
         # Get the cursor id for the result.
         #
         # @example Get the cursor id.
@@ -86,7 +83,7 @@ module Mongo
         # @since 2.0.0
         # @api private
         def validate!
-          !successful? ? raise_operation_failure : self
+          successful? ? self : raise_operation_failure
         end
 
         private
@@ -102,4 +99,3 @@ module Mongo
     end
   end
 end
-

data/lib/mongo/operation/indexes.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/operation/indexes/result'
 
 module Mongo
   module Operation
-
     # A MongoDB indexes operation.
     #
     # @api private

data/lib/mongo/operation/insert/bulk_result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class Insert
-
       # Defines custom behavior of results for an insert when sent as part of a bulk write.
       #
       # @since 2.0.0
@@ -49,7 +47,7 @@ module Mongo
         # @since 2.0.0
         # @api private
         def initialize(replies, connection_description, connection_global_id, ids)
-          @replies = [*replies] if replies
+          @replies = [ *replies ] if replies
           @connection_description = connection_description
           @connection_global_id = connection_global_id
           if replies && replies.first && (doc = replies.first.documents.first)
@@ -61,9 +59,7 @@ module Mongo
               end
               @inserted_ids = []
               ids.each_with_index do |id, index|
-                if bad_indices[index].nil?
-                  @inserted_ids << id
-                end
+                @inserted_ids << id if bad_indices[index].nil?
               end
             # I don't know if acknowledged? check here is necessary,
             # as best as I can tell it doesn't hurt

data/lib/mongo/operation/insert/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class Insert
-
       # A MongoDB insert operation sent as an op message.
       #
       # @api private
@@ -33,12 +31,15 @@ module Mongo
 
         private
 
-        def get_result(connection, context, options = {})
-          # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, context), @ids, context: context)
+        def get_result(connection, context, _options = {})
+          message = build_message(connection, context)
+          connection.tracer.trace_command(message, context, connection) do
+            result = Result.new(*dispatch_message(message, connection, context), @ids, context: context)
+            yield result
+          end
         end
 
-        def selector(connection)
+        def selector(_connection)
           {
             insert: coll_name,
             Protocol::Msg::DATABASE_IDENTIFIER => db_name,

data/lib/mongo/operation/insert/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class Insert
-
       # Defines custom behavior of results for an insert.
       #
       # According to the CRUD spec, reporting the inserted ids
@@ -27,7 +25,6 @@ module Mongo
       # @since 2.0.0
       # @api semiprivate
       class Result < Operation::Result
-
         # Get the ids of the inserted documents.
         #
         # @since 2.0.0

data/lib/mongo/operation/insert.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -21,7 +20,6 @@ require 'mongo/operation/insert/bulk_result'
 
 module Mongo
   module Operation
-
     # A MongoDB insert operation.
     #
     # @api private
@@ -33,10 +31,9 @@ module Mongo
 
       private
 
-      IDENTIFIER = 'documents'.freeze
+      IDENTIFIER = 'documents'
 
-      def validate!(connection)
-      end
+      def validate!(connection); end
     end
   end
 end

data/lib/mongo/operation/kill_cursors/command_builder.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -18,10 +17,8 @@
 module Mongo
   module Operation
     class KillCursors
-
       # @api private
       module CommandBuilder
-
         private
 
         def int64_cursor_ids

data/lib/mongo/operation/kill_cursors/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class KillCursors
-
       # A MongoDB killcursors operation sent as an op message.
       #
       # @api private
@@ -30,7 +28,7 @@ module Mongo
 
         private
 
-        def selector(connection)
+        def selector(_connection)
           {
             killCursors: coll_name,
             cursors: int64_cursor_ids,

data/lib/mongo/operation/kill_cursors.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/operation/kill_cursors/op_msg'
 
 module Mongo
   module Operation
-
     # A MongoDB killcursors operation.
     #
     # @api private

data/lib/mongo/operation/list_collections/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class ListCollections
-
       # A MongoDB listcollections operation sent as an op message.
       #
       # @api private
@@ -30,11 +28,11 @@ module Mongo
 
         private
 
-        def selector(connection)
+        def selector(_connection)
           (spec[SELECTOR] || {}).merge({
-            listCollections: 1,
-            comment: spec[:comment]
-          }).compact
+                                         listCollections: 1,
+                                         comment: spec[:comment]
+                                       }).compact
         end
       end
     end

data/lib/mongo/operation/list_collections/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,14 +17,12 @@
 module Mongo
   module Operation
     class ListCollections
-
       # Defines custom behavior of results when using the
       # listCollections command.
       #
       # @since 2.0.0
       # @api semiprivate
       class Result < Operation::Result
-
         # Get the cursor id for the result.
         #
         # @example Get the cursor id.
@@ -93,7 +90,7 @@ module Mongo
               labels: parser.labels,
               wtimeout: parser.wtimeout,
               document: parser.document,
-              server_message: parser.server_message,
+              server_message: parser.server_message
             )
           end
         end

data/lib/mongo/operation/list_collections.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/operation/list_collections/result'
 
 module Mongo
   module Operation
-
     # A MongoDB listcollections operation.
     #
     # @api private

data/lib/mongo/operation/map_reduce/op_msg.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   module Operation
     class MapReduce
-
       # A MongoDB map-reduce operation sent as an op message.
       #
       # @api private

data/lib/mongo/operation/map_reduce/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,30 +17,28 @@
 module Mongo
   module Operation
     class MapReduce
-
       # Defines custom behavior of results for a map reduce operation.
       #
       # @since 2.0.0
       # @api semiprivate
       class Result < Operation::Result
-
         # The counts field for the map/reduce.
         #
         # @since 2.0.0
         # @api private
-        COUNTS = 'counts'.freeze
+        COUNTS = 'counts'
 
         # The field name for a result without a cursor.
         #
         # @since 2.0.0
         # @api private
-        RESULTS = 'results'.freeze
+        RESULTS = 'results'
 
         # The time the operation took constant.
         #
         # @since 2.0.0
         # @api private
-        TIME = 'timeMillis'.freeze
+        TIME = 'timeMillis'
 
         # Gets the map/reduce counts from the reply.
         #