mongo 2.22.0 → 2.24.0

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

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -20,7 +19,6 @@ require 'mongo/cursor_host'
 module Mongo
   class Collection
     class View
-
       # Defines iteration related behavior for collection views, including
       # cursor instantiation.
       #
@@ -40,23 +38,22 @@ module Mongo
         # @since 2.0.0
         #
         # @yieldparam [ Hash ] Each matching document.
-        def each
+        def each(&block)
           @cursor = prefer_cached_cursor? ? cached_cursor : new_cursor_for_iteration
           return @cursor.to_enum unless block_given?
 
           limit_for_cached_query = compute_limit_for_cached_query
 
-          # Ruby versions 2.5 and older do not support arr[0..nil] syntax, so
-          # this must be a separate conditional.
+          # TODO: rather than pulling the entire (limited) result set into
+          # memory, this should tell the cursor about the limit and then let
+          # the cursor limit the iteration as necessary.
           cursor_to_iterate = if limit_for_cached_query
-            @cursor.to_a[0...limit_for_cached_query]
-          else
-            @cursor
-          end
+                                @cursor.to_a[0...limit_for_cached_query]
+                              else
+                                @cursor
+                              end
 
-          cursor_to_iterate.each do |doc|
-            yield doc
-          end
+          cursor_to_iterate.each(&block)
         end
 
         # Cleans up resources associated with this query.
@@ -73,11 +70,11 @@ module Mongo
         #
         # @since 2.1.0
         def close_query
-          if @cursor
-            @cursor.close
-          end
+          return unless @cursor
+
+          @cursor.close
         end
-        alias :kill_cursors :close_query
+        alias kill_cursors close_query
 
         private
 
@@ -88,19 +85,24 @@ module Mongo
             operation_timeouts: operation_timeouts,
             view: self
           )
-
-          if respond_to?(:write?, true) && write?
-            server = server_selector.select_server(cluster, nil, session, write_aggregation: true)
-            result = send_initial_query(server, context)
-
-            if use_query_cache?
-              CachingCursor.new(view, result, server, session: session, context: context)
+          op = initial_query_op(session)
+          tracer.trace_operation(op, context) do
+            if respond_to?(:write?, true) && write?
+              retry_enabled = collection.client.options[:retry_writes] != false
+              with_overload_retry(context: context, retry_enabled: retry_enabled) do
+                server = server_selector.select_server(cluster, nil, session, write_aggregation: true)
+                result = send_initial_query(server, context, operation: op)
+
+                if use_query_cache?
+                  CachingCursor.new(view, result, server, session: session, context: context)
+                else
+                  Cursor.new(view, result, server, session: session, context: context)
+                end
+              end
             else
-              Cursor.new(view, result, server, session: session, context: context)
-            end
-          else
-            read_with_retry_cursor(session, server_selector, view, context: context) do |server|
-              send_initial_query(server, context)
+              read_with_retry_cursor(session, server_selector, view, context: context) do |server|
+                send_initial_query(server, context, operation: op)
+              end
             end
           end
         end
@@ -154,7 +156,7 @@ module Mongo
           }
 
           if spec[:oplog_replay]
-            collection.client.log_warn("The :oplog_replay option is deprecated and ignored by MongoDB 4.4 and later")
+            collection.client.log_warn('The :oplog_replay option is deprecated and ignored by MongoDB 4.4 and later')
           end
 
           maybe_set_tailable_options(spec)
@@ -167,11 +169,18 @@ module Mongo
           end
         end
 
-        def send_initial_query(server, context)
-          operation = initial_query_op(context.session)
+        def send_initial_query(server, context, operation: nil)
+          operation ||= initial_query_op(context.session)
           if server.load_balancer?
-            # Connection will be checked in when cursor is drained.
-            connection = server.pool.check_out(context: context)
+            # Connection will be checked in when cursor is drained,
+            # unless the connection is pinned to a transaction (in which
+            # case it stays checked out for the transaction duration).
+            if context.connection_global_id
+              connection = server.pool.check_out_pinned_connection(
+                context.connection_global_id
+              )
+            end
+            connection ||= server.pool.check_out(context: context)
             operation.execute_with_connection(connection, context: context)
           else
             operation.execute(server, context: context)
@@ -210,10 +219,10 @@ module Mongo
           # If a query with a limit is performed, the query cache will
           # re-use results from an earlier query with the same or larger
           # limit, and then impose the lower limit during iteration.
-          return QueryCache.normalized_limit(limit)
+          QueryCache.normalized_limit(limit)
         end
 
-        # Add tailable cusror options to the command specifiction if needed.
+        # Add tailable cursor options to the command specification if needed.
         #
         # @param [ Hash ] spec The command specification.
         def maybe_set_tailable_options(spec)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   class Collection
     class View
-
       # Provides behavior around a map/reduce operation on the collection
       # view.
       #
@@ -33,13 +31,13 @@ module Mongo
         # The inline option.
         #
         # @since 2.1.0
-        INLINE = 'inline'.freeze
+        INLINE = 'inline'
 
         # Reroute message.
         #
         # @since 2.1.0
         # @deprecated
-        REROUTE = 'Rerouting the MapReduce operation to the primary server.'.freeze
+        REROUTE = 'Rerouting the MapReduce operation to the primary server'
 
         # @return [ View ] view The collection view.
         attr_reader :view
@@ -68,11 +66,12 @@ module Mongo
         # @since 2.0.0
         #
         # @yieldparam [ Hash ] Each matching document.
-        def each
+        def each(&block)
           @cursor = nil
           session = client.get_session(@options)
           server = cluster.next_primary(nil, session)
-          context = Operation::Context.new(client: client, session: session, operation_timeouts: view.operation_timeouts)
+          context = Operation::Context.new(client: client, session: session,
+                                           operation_timeouts: view.operation_timeouts)
           if server.load_balancer?
             # Connection will be checked in when cursor is drained.
             connection = server.pool.check_out(context: context)
@@ -84,9 +83,7 @@ module Mongo
           end
           @cursor = Cursor.new(view, result, server, session: session)
           if block_given?
-            @cursor.each do |doc|
-              yield doc
-            end
+            @cursor.each(&block)
           else
             @cursor.to_enum
           end
@@ -124,7 +121,8 @@ module Mongo
           @reduce_function = reduce.dup.freeze
           @options = BSON::Document.new(options).freeze
 
-          client.log_warn('The map_reduce operation is deprecated, please use the aggregation pipeline instead')
+          Deprecations.warn(:map_reduce,
+                            'The map_reduce operation is deprecated, please use the aggregation pipeline instead.')
         end
 
         # Set or get the jsMode flag for the operation.
@@ -179,12 +177,12 @@ module Mongo
         # Returns the database name where the map-reduce result is written to.
         # If the result is returned inline, returns nil.
         def out_database_name
-          if options[:out]
-            if options[:out].respond_to?(:keys) && (db = options[:out][:db])
-              db
-            else
-              database.name
-            end
+          return unless options[:out]
+
+          if options[:out].respond_to?(:keys) && (db = options[:out][:db])
+            db
+          else
+            database.name
           end
         end
 
@@ -232,7 +230,7 @@ module Mongo
           view.send(:with_session, @options) do |session|
             write_concern = view.write_concern_with_session(session)
             context = Operation::Context.new(client: client, session: session)
-            nro_write_with_retry(write_concern, context: context) do |connection, txn_num, context|
+            nro_write_with_retry(write_concern, context: context) do |connection, _txn_num, context|
               send_initial_query_with_connection(connection, session, context: context)
             end
           end
@@ -240,7 +238,7 @@ module Mongo
 
         private
 
-        OUT_ACTIONS = [ :replace, :merge, :reduce ].freeze
+        OUT_ACTIONS = %i[replace merge reduce].freeze
 
         def server_selector
           @view.send(:server_selector)
@@ -276,11 +274,7 @@ module Mongo
         end
 
         def valid_server?(description)
-          if secondary_ok?
-            true
-          else
-            description.standalone? || description.mongos? || description.primary? || description.load_balancer?
-          end
+          secondary_ok? || description.standalone? || description.mongos? || description.primary? || description.load_balancer?
         end
 
         def secondary_ok?
@@ -298,7 +292,7 @@ module Mongo
           if valid_server?(connection.description)
             op.execute_with_connection(connection, context: context)
           else
-            msg = "Rerouting the MapReduce operation to the primary server - #{connection.address} is not suitable because it is not currently the primray"
+            msg = "#{REROUTE} - #{connection.address} is not suitable because it is not currently the primary"
             log_warn(msg)
             server = cluster.next_primary(nil, session)
             op.execute(server, context: context)
@@ -310,7 +304,8 @@ module Mongo
         end
 
         def find_command_spec(session)
-          Builder::MapReduce.new(map_function, reduce_function, view, options.merge(session: session)).command_specification
+          Builder::MapReduce.new(map_function, reduce_function, view,
+                                 options.merge(session: session)).command_specification
         end
 
         def fetch_query_op(session)