mongo 2.22.0 → 2.24.0

data/lib/mongo/operation/shared/polymorphic_result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of instantiating a result class matching the
     # operation class.
     #
@@ -28,12 +26,12 @@ module Mongo
     module PolymorphicResult
       include PolymorphicLookup
 
-      private
-
       def self.included(base)
         base.extend ClassMethods
       end
 
+      private
+
       module ClassMethods
         attr_accessor :result_class
       end

data/lib/mongo/operation/shared/read_preference_supported.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Operation
-
     # Read preference handling for pre-OP_MSG operation implementations.
     #
     # This module is not used by OP_MSG operation classes (those deriving
@@ -27,7 +25,6 @@ module Mongo
     # @since 2.5.2
     # @api private
     module ReadPreferenceSupported
-
       private
 
       # Get the options for executing the operation on a particular connection.
@@ -70,7 +67,7 @@ module Mongo
           # In replica sets and sharded clusters, read preference is passed
           # to the server if one is specified by the application, and there
           # is no default.
-          read && read.secondary_ok? || false
+          (read && read.secondary_ok?) || false
         end
       end
 
@@ -96,18 +93,16 @@ module Mongo
       #
       # @return [ Hash ] New command document to send to the server.
       def add_read_preference_legacy(sel, connection)
+        # If the read preference contains only mode and mode is secondary
+        # preferred and we are sending to a pre-OP_MSG server, this read
+        # preference is indicated by the :secondary_ok wire protocol flag
+        # and $readPreference command parameter isn't sent.
         if read && (
-          connection.description.mongos? || connection.description.load_balancer?
-        ) && read_pref = read.to_mongos
-          # If the read preference contains only mode and mode is secondary
-          # preferred and we are sending to a pre-OP_MSG server, this read
-          # preference is indicated by the :secondary_ok wire protocol flag
-          # and $readPreference command parameter isn't sent.
-          if read_pref != {mode: 'secondaryPreferred'}
-            Mongo::Lint.validate_camel_case_read_preference(read_pref)
-            sel = sel[:$query] ? sel : {:$query => sel}
-            sel = sel.merge(:$readPreference => read_pref)
-          end
+                  connection.description.mongos? || connection.description.load_balancer?
+                ) && (read_pref = read.to_mongos) && (read_pref != { mode: 'secondaryPreferred' })
+          Mongo::Lint.validate_camel_case_read_preference(read_pref)
+          sel = { :$query => sel } unless sel[:$query]
+          sel = sel.merge(:$readPreference => read_pref)
         end
         sel
       end

data/lib/mongo/operation/shared/response_handling.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of response handling for operations.
     #
     # @api private
     module ResponseHandling
-
       private
 
       # @param [ Mongo::Operation::Result ] result The operation result.
@@ -52,12 +49,8 @@ module Mongo
       def add_error_labels(connection, context)
         yield
       rescue Mongo::Error::SocketError => e
-        if context.in_transaction? && !context.committing_transaction?
-          e.add_label('TransientTransactionError')
-        end
-        if context.committing_transaction?
-          e.add_label('UnknownTransactionCommitResult')
-        end
+        e.add_label('TransientTransactionError') if context.in_transaction? && !context.committing_transaction?
+        e.add_label('UnknownTransactionCommitResult') if context.committing_transaction?
 
         maybe_add_retryable_write_error_label!(e, connection, context)
 
@@ -66,12 +59,10 @@ module Mongo
         maybe_add_retryable_write_error_label!(e, connection, context)
         raise e
       rescue Mongo::Error::OperationFailure::Family => e
-        if context.committing_transaction?
-          if e.write_retryable? || e.wtimeout? || (e.write_concern_error? &&
+        if context.committing_transaction? && (e.write_retryable? || e.wtimeout? || (e.write_concern_error? &&
               !Session::UNLABELED_WRITE_CONCERN_CODES.include?(e.write_concern_error_code)
-          ) || e.max_time_ms_expired?
-            e.add_label('UnknownTransactionCommitResult')
-          end
+                                                                                    ) || e.max_time_ms_expired?)
+          e.add_label('UnknownTransactionCommitResult')
         end
 
         maybe_add_retryable_write_error_label!(e, connection, context)
@@ -91,9 +82,7 @@ module Mongo
       def unpin_maybe(session, connection)
         yield
       rescue Mongo::Error => e
-        if session
-          session.unpin_maybe(e, connection)
-        end
+        session.unpin_maybe(e, connection) if session
         raise
       end
 
@@ -115,8 +104,6 @@ module Mongo
         raise e
       end
 
-      private
-
       # A method that will add the RetryableWriteError label to an error if
       # any of the following conditions are true:
       #
@@ -126,8 +113,8 @@ module Mongo
       # AND the server does not support adding the RetryableWriteError label OR
       #   the error is a network error (i.e. the driver must add the label)
       #
-      # AND the error occured during a commitTransaction or abortTransaction
-      #   OR the error occured during a write outside of a transaction on a
+      # AND the error occurred during a commitTransaction or abortTransaction
+      #   OR the error occurred during a write outside of a transaction on a
       #   client that has retry writes enabled.
       #
       # If these conditions are met, the original error will be mutated.
@@ -150,8 +137,8 @@ module Mongo
         # Note: any write operation within a transaction (excepting commit and
         # abort is NOT a retryable operation)
         retryable_operation = context.committing_transaction? ||
-          context.aborting_transaction? ||
-          !context.in_transaction? && context.any_retry_writes?
+                              context.aborting_transaction? ||
+                              (!context.in_transaction? && context.any_retry_writes?)
 
         # An operation should add the RetryableWriteError label if one of the
         # following conditions is met:
@@ -163,9 +150,9 @@ module Mongo
           error.is_a?(Mongo::Error::SocketError) ||
           error.is_a?(Mongo::Error::SocketTimeoutError)
 
-        if retryable_operation && should_add_error_label && error.write_retryable?
-          error.add_label('RetryableWriteError')
-        end
+        return unless retryable_operation && should_add_error_label && error.write_retryable?
+
+        error.add_label('RetryableWriteError')
       end
     end
   end

data/lib/mongo/operation/shared/result/aggregatable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,13 +17,11 @@
 module Mongo
   module Operation
     class Result
-
       # Defines custom behavior of bulk write results
       #
       # @since 2.0.0
       # @api private
       module Aggregatable
-
         # Aggregate the write errors returned from this result.
         #
         # @example Aggregate the write errors.
@@ -37,13 +34,14 @@ module Mongo
         # @since 2.0.0
         def aggregate_write_errors(count)
           return unless @replies
+
           @replies.reduce(nil) do |errors, reply|
-            if write_errors = reply.documents.first['writeErrors']
-              wes = write_errors.collect do |we|
-                we.merge!('index' => count + we['index'])
-              end
-              (errors || []) << wes if wes
+            next unless write_errors = reply.documents.first['writeErrors']
+
+            wes = write_errors.collect do |we|
+              we.merge!('index' => count + we['index'])
             end
+            (errors || []) << wes if wes
           end
         end
 
@@ -59,12 +57,13 @@ module Mongo
         # @since 2.0.0
         def aggregate_write_concern_errors(count)
           return unless @replies
+
           @replies.each_with_index.reduce(nil) do |errors, (reply, _)|
-            if write_concern_errors = reply.documents.first['writeConcernErrors']
-              (errors || []) << write_concern_errors.reduce(nil) do |errs, wce|
-                wce.merge!('index' => count + wce['index'])
-                (errs || []) << write_concern_error
-              end
+            next unless write_concern_errors = reply.documents.first['writeConcernErrors']
+
+            (errors || []) << write_concern_errors.reduce(nil) do |errs, wce|
+              wce.merge!('index' => count + wce['index'])
+              (errs || []) << write_concern_error
             end
           end
         end

data/lib/mongo/operation/shared/sessions_supported.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,28 +16,26 @@
 
 module Mongo
   module Operation
-
     # Shared behavior of operations that support a session.
     #
     # @since 2.5.2
     # @api private
     module SessionsSupported
-
       private
 
       ZERO_TIMESTAMP = BSON::Timestamp.new(0, 0)
 
-      READ_COMMANDS = [
-        :aggregate,
-        :count,
-        :dbStats,
-        :distinct,
-        :find,
-        :geoNear,
-        :geoSearch,
-        :group,
-        :mapReduce,
-        :parallelCollectionScan
+      READ_COMMANDS = %i[
+        aggregate
+        count
+        dbStats
+        distinct
+        find
+        geoNear
+        geoSearch
+        group
+        mapReduce
+        parallelCollectionScan
       ].freeze
 
       # Adds causal consistency document to the selector, if one can be
@@ -62,31 +59,32 @@ module Mongo
       # must have the current operation time. Also, topology must be
       # replica set or sharded cluster.
       def apply_causal_consistency_if_possible(selector, connection)
-        if !connection.description.standalone?
-          cc_doc = session.send(:causal_consistency_doc)
-          if cc_doc
-            rc_doc = (selector[:readConcern] || read_concern || {}).merge(cc_doc)
-            selector[:readConcern] = Options::Mapper.transform_values_to_strings(
-              rc_doc)
-          end
-        end
+        return if connection.description.standalone?
+
+        cc_doc = session.send(:causal_consistency_doc)
+        return unless cc_doc
+
+        rc_doc = (selector[:readConcern] || read_concern || {}).merge(cc_doc)
+        selector[:readConcern] = Options::Mapper.transform_values_to_strings(
+          rc_doc
+        )
       end
 
       def flags
-        acknowledged_write? ? [] : [:more_to_come]
+        acknowledged_write? ? [] : [ :more_to_come ]
       end
 
       def apply_cluster_time!(selector, connection)
-        if !connection.description.standalone?
-          cluster_time = [
-            connection.cluster_time,
-            session&.cluster_time,
-          ].compact.max
-
-          if cluster_time
-            selector['$clusterTime'] = cluster_time
-          end
-        end
+        return if connection.description.standalone?
+
+        cluster_time = [
+          connection.cluster_time,
+          session&.cluster_time,
+        ].compact.max
+
+        return unless cluster_time
+
+        selector['$clusterTime'] = cluster_time
       end
 
       def read_command?(sel)
@@ -126,10 +124,8 @@ module Mongo
       end
 
       def command(connection)
-        if Lint.enabled?
-          unless connection.is_a?(Server::Connection)
-            raise Error::LintError, "Connection is not a Connection instance: #{connection}"
-          end
+        if Lint.enabled? && !connection.is_a?(Server::Connection)
+          raise Error::LintError, "Connection is not a Connection instance: #{connection}"
         end
 
         sel = BSON::Document.new(selector(connection))
@@ -138,11 +134,9 @@ module Mongo
 
         add_read_preference(sel, connection)
 
-        if connection.features.sessions_enabled?
+        if connection.description.logical_session_timeout
           apply_cluster_time!(sel, connection)
-          if session && (acknowledged_write? || session.in_transaction?)
-            apply_session_options(sel, connection)
-          end
+          apply_session_options(sel, connection) if session && (acknowledged_write? || session.in_transaction?)
         elsif session && session.explicit?
           apply_session_options(sel, connection)
         end
@@ -169,47 +163,45 @@ module Mongo
 
         # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#topology-type-single
         read_doc = if connection.description.standalone?
-          # Read preference is never sent to standalones.
-          nil
-        elsif connection.server.load_balancer?
-          read&.to_mongos
-        elsif connection.description.mongos?
-          # When server is a mongos:
-          # - $readPreference is never sent when mode is 'primary'
-          # - Otherwise $readPreference is sent
-          # When mode is 'secondaryPreferred' $readPreference is currently
-          # required to only be sent when a non-mode field (i.e. tag_sets)
-          # is present, but this causes wrong behavior (DRIVERS-1642).
-          read&.to_mongos
-        elsif connection.server.cluster.single?
-          # In Single topology:
-          # - If no read preference is specified by the application, the driver
-          #   adds mode: primaryPreferred.
-          # - If a read preference is specified by the application, the driver
-          #   replaces the mode with primaryPreferred.
-          read_doc = if read
-            BSON::Document.new(read.to_doc)
-          else
-            BSON::Document.new
-          end
-          if [nil, 'primary'].include?(read_doc['mode'])
-            read_doc['mode'] = 'primaryPreferred'
-          end
-          read_doc
-        else
-          # In replica sets, read preference is passed to the server if one
-          # is specified by the application, except for primary read preferences.
-          read_doc = BSON::Document.new(read&.to_doc || {})
-          if [nil, 'primary'].include?(read_doc['mode'])
-            nil
-          else
-            read_doc
-          end
-        end
-
-        if read_doc
-          sel['$readPreference'] = read_doc
-        end
+                     # Read preference is never sent to standalones.
+                     nil
+                   elsif connection.server.load_balancer?
+                     read&.to_mongos
+                   elsif connection.description.mongos?
+                     # When server is a mongos:
+                     # - $readPreference is never sent when mode is 'primary'
+                     # - Otherwise $readPreference is sent
+                     # When mode is 'secondaryPreferred' $readPreference is currently
+                     # required to only be sent when a non-mode field (i.e. tag_sets)
+                     # is present, but this causes wrong behavior (DRIVERS-1642).
+                     read&.to_mongos
+                   elsif connection.server.cluster.single?
+                     # In Single topology:
+                     # - If no read preference is specified by the application, the driver
+                     #   adds mode: primaryPreferred.
+                     # - If a read preference is specified by the application, the driver
+                     #   replaces the mode with primaryPreferred.
+                     read_doc = if read
+                                  BSON::Document.new(read.to_doc)
+                                else
+                                  BSON::Document.new
+                                end
+                     read_doc['mode'] = 'primaryPreferred' if [ nil, 'primary' ].include?(read_doc['mode'])
+                     read_doc
+                   else
+                     # In replica sets, read preference is passed to the server if one
+                     # is specified by the application, except for primary read preferences.
+                     read_doc = BSON::Document.new(read&.to_doc || {})
+                     if [ nil, 'primary' ].include?(read_doc['mode'])
+                       nil
+                     else
+                       read_doc
+                     end
+                   end
+
+        return unless read_doc
+
+        sel['$readPreference'] = read_doc
       end
 
       def apply_session_options(sel, connection)
@@ -224,27 +216,24 @@ module Mongo
         validate_read_preference!(sel)
         apply_txn_num!(sel)
         if session.recovery_token &&
-          (sel[:commitTransaction] || sel[:abortTransaction])
-        then
+           (sel[:commitTransaction] || sel[:abortTransaction])
           sel[:recoveryToken] = session.recovery_token
         end
 
-        if session.snapshot?
-          unless connection.description.server_version_gte?('5.0')
-            raise Error::SnapshotSessionInvalidServerVersion
-          end
+        return unless session.snapshot?
+        raise Error::SnapshotSessionInvalidServerVersion unless connection.description.server_version_gte?('5.0')
 
-          sel[:readConcern] = {level: 'snapshot'}
-          if session.snapshot_timestamp
-            sel[:readConcern][:atClusterTime] = session.snapshot_timestamp
-          end
-        end
+        sel[:readConcern] = { level: 'snapshot' }
+        return unless session.snapshot_timestamp
+
+        sel[:readConcern][:atClusterTime] = session.snapshot_timestamp
       end
 
       def build_message(connection, context)
-        if self.session != context.session
-          if self.session
-            raise Error::InternalDriverError, "Operation session #{self.session.inspect} does not match context session #{context.session.inspect}"
+        if session != context.session
+          if session
+            raise Error::InternalDriverError,
+                  "Operation session #{session.inspect} does not match context session #{context.session.inspect}"
           else
             # Some operations are not constructed with sessions but are
             # executed in a context where a session is available.
@@ -261,9 +250,8 @@ module Mongo
             # later prior to being sent to the connection.
             buf = BSON::ByteBuffer.new
             message.serialize(buf)
-            if buf.length > connection.max_message_size
-              raise Error::MaxMessageSize.new(connection.max_message_size)
-            end
+            raise Error::MaxMessageSize.new(connection.max_message_size) if buf.length > connection.max_message_size
+
             session.update_state!
           end
         end