mongo 2.23.0 → 2.24.1

data/lib/mongo/auth/stringprep.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -21,8 +20,7 @@ require 'mongo/auth/stringprep/profiles/sasl'
 module Mongo
   module Auth
     # This namespace contains all behavior related to string preparation
-    # (RFC 3454). It's used to implement SCRAM-SHA-256 authentication,
-    # which is available in MongoDB server versions 4.0 and later.
+    # (RFC 3454). It's used to implement SCRAM-SHA-256 authentication.
     #
     # @since 2.6.0
     # @api private
@@ -72,15 +70,14 @@ module Mongo
           raise Mongo::Error::FailedStringPrepValidation.new(Error::FailedStringPrepValidation::INVALID_BIDIRECTIONAL)
         end
 
-        if out.each_char.any? { |c| table_contains?(Tables::D1, c) }
-          if out.each_char.any? { |c| table_contains?(Tables::D2, c) }
-            raise Mongo::Error::FailedStringPrepValidation.new(Error::FailedStringPrepValidation::INVALID_BIDIRECTIONAL)
-          end
-
-          unless table_contains?(Tables::D1, out[0]) && table_contains?(Tables::D1, out[-1])
-            raise Mongo::Error::FailedStringPrepValidation.new(Error::FailedStringPrepValidation::INVALID_BIDIRECTIONAL)
-          end
+        return unless out.each_char.any? { |c| table_contains?(Tables::D1, c) }
+        if out.each_char.any? { |c| table_contains?(Tables::D2, c) }
+          raise Mongo::Error::FailedStringPrepValidation.new(Error::FailedStringPrepValidation::INVALID_BIDIRECTIONAL)
         end
+
+        return if table_contains?(Tables::D1, out[0]) && table_contains?(Tables::D1, out[-1])
+
+        raise Mongo::Error::FailedStringPrepValidation.new(Error::FailedStringPrepValidation::INVALID_BIDIRECTIONAL)
       end
 
       def check_prohibited!(out, prohibited)
@@ -95,7 +92,7 @@ module Mongo
 
       def mapping(c, mappings)
         m = mappings.find { |m| m.has_key?(c) }
-        mapped = (m && m[c]) || [c]
+        mapped = (m && m[c]) || [ c ]
         mapped.map { |i| i.chr(Encoding::UTF_8) }.join
       end
 

data/lib/mongo/auth/user/view.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 Auth
     class User
-
       # Defines behavior for user related operation on databases.
       #
       # @since 2.0.0
@@ -52,7 +50,7 @@ module Mongo
               user: user,
               db_name: database.name,
               session: session,
-              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]),
+              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern])
             )
           end
         end
@@ -89,7 +87,7 @@ module Mongo
               user_name: name,
               db_name: database.name,
               session: session,
-              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]),
+              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern])
             )
           end
         end
@@ -115,7 +113,7 @@ module Mongo
               user: user,
               db_name: database.name,
               session: session,
-              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]),
+              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern])
             )
           end
         end

data/lib/mongo/auth/user.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'mongo/auth/user/view'
 
 module Mongo
   module Auth
-
     # Represents a user in MongoDB.
     #
     # @since 2.0.0
@@ -68,6 +66,7 @@ module Mongo
       # @since 2.0.0
       def ==(other)
         return false unless other.is_a?(User)
+
         name == other.name && database == other.database && password == other.password
       end
 
@@ -96,7 +95,7 @@ module Mongo
       #
       # @since 2.0.0
       def encoded_name
-        name.encode(BSON::UTF8).gsub('=','=3D').gsub(',','=2C')
+        name.encode(BSON::UTF8).gsub('=', '=3D').gsub(',', '=2C')
       end
 
       # Get the hash key for the user.
@@ -120,9 +119,7 @@ module Mongo
       #
       # @since 2.0.0
       def hashed_password
-        unless password
-          raise Error::MissingPassword
-        end
+        raise Error::MissingPassword unless password
 
         @hashed_password ||= Digest::MD5.hexdigest("#{name}:mongo:#{password}").encode(BSON::UTF8)
       end
@@ -131,14 +128,12 @@ module Mongo
       #
       # @api private
       def sasl_prepped_password
-        unless password
-          raise Error::MissingPassword
-        end
+        raise Error::MissingPassword unless password
 
         @sasl_prepped_password ||= StringPrep.prepare(password,
-          StringPrep::Profiles::SASL::MAPPINGS,
-          StringPrep::Profiles::SASL::PROHIBITED,
-          normalize: true, bidi: true).encode(BSON::UTF8)
+                                                      StringPrep::Profiles::SASL::MAPPINGS,
+                                                      StringPrep::Profiles::SASL::PROHIBITED,
+                                                      normalize: true, bidi: true).encode(BSON::UTF8)
       end
 
       # Create the new user.
@@ -176,14 +171,13 @@ module Mongo
             # have not enforced this; warn, reject in lint mode
             if Lint.enabled?
               raise Error::LintError, "Auth mechanism #{@mechanism.inspect} must be specified as a symbol"
-            else
-              log_warn("Auth mechanism #{@mechanism.inspect} should be specified as a symbol")
-              @mechanism = @mechanism.to_sym
             end
+
+            log_warn("Auth mechanism #{@mechanism.inspect} should be specified as a symbol")
+            @mechanism = @mechanism.to_sym
+
           end
-          unless Auth::SOURCES.key?(@mechanism)
-            raise InvalidMechanism.new(options[:auth_mech])
-          end
+          raise InvalidMechanism.new(options[:auth_mech]) unless Auth::SOURCES.key?(@mechanism)
         end
         @auth_mech_properties = options[:auth_mech_properties] || {}
         @roles = options[:roles] || []
@@ -198,15 +192,11 @@ module Mongo
       #
       # @since 2.0.0
       def spec
-        {roles: roles}.tap do |spec|
-          if password
-            spec[:pwd] = password
-          end
+        { roles: roles }.tap do |spec|
+          spec[:pwd] = password if password
         end
       end
 
-      private
-
       # Generate default auth source based on the URI and options
       #
       # @api private

data/lib/mongo/auth/x509/conversation.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 Auth
     class X509
-
       # Defines behavior around a single X.509 conversation between the
       # client and server.
       #
       # @since 2.0.0
       # @api private
       class Conversation < ConversationBase
-
         # The login message.
         #
         # @since 2.0.0

data/lib/mongo/auth/x509.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,17 +16,15 @@
 
 module Mongo
   module Auth
-
     # Defines behavior for X.509 authentication.
     #
     # @since 2.0.0
     # @api private
     class X509 < Base
-
       # The authentication mechanism string.
       #
       # @since 2.0.0
-      MECHANISM = 'MONGODB-X509'.freeze
+      MECHANISM = 'MONGODB-X509'
 
       # Initializes the X.509 authenticator.
       #
@@ -37,11 +34,12 @@ module Mongo
         # The only valid database for X.509 authentication is $external.
         if user.auth_source != '$external'
           user_name_msg = if user.name
-            " #{user.name}"
-          else
-            ''
-          end
-          raise Auth::InvalidConfiguration, "User#{user_name_msg} specifies auth source '#{user.auth_source}', but the only valid auth source for X.509 is '$external'"
+                            " #{user.name}"
+                          else
+                            ''
+                          end
+          raise Auth::InvalidConfiguration,
+                "User#{user_name_msg} specifies auth source '#{user.auth_source}', but the only valid auth source for X.509 is '$external'"
         end
 
         super

data/lib/mongo/auth.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -33,9 +32,7 @@ require 'mongo/auth/x509'
 require 'mongo/error/read_write_retryable'
 require 'mongo/error/labelable'
 
-
 module Mongo
-
   # This namespace contains all authentication related behavior.
   #
   # @since 2.0.0
@@ -46,7 +43,7 @@ module Mongo
     #
     # @since 2.0.0
     # @api private
-    EXTERNAL = '$external'.freeze
+    EXTERNAL = '$external'
 
     # Constant for the nonce command.
     #
@@ -58,7 +55,7 @@ module Mongo
     #
     # @since 2.0.0
     # @api private
-    NONCE = 'nonce'.freeze
+    NONCE = 'nonce'
 
     # Map the symbols parsed from the URI connection string to strategies.
     #
@@ -96,7 +93,8 @@ module Mongo
     # @api private
     def get(user, connection, **opts)
       mechanism = user.mechanism
-      raise InvalidMechanism.new(mechanism) if !SOURCES.has_key?(mechanism)
+      raise InvalidMechanism.new(mechanism) unless SOURCES.has_key?(mechanism)
+
       SOURCES[mechanism].new(user, connection, **opts)
     end
 
@@ -109,7 +107,6 @@ module Mongo
     #
     # @since 2.0.0
     class InvalidMechanism < InvalidConfiguration
-
       # Instantiate the new error.
       #
       # @example Instantiate the error.
@@ -151,8 +148,7 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(user, used_mechanism: nil, message: nil,
-        server: nil, code: nil
-      )
+                     server: nil, code: nil)
         @code = code
 
         configured_bits = []
@@ -160,36 +156,28 @@ module Mongo
           "auth source: #{user.auth_source}",
         ]
 
-        if user.mechanism
-          configured_bits << "mechanism: #{user.mechanism}"
-        end
+        configured_bits << "mechanism: #{user.mechanism}" if user.mechanism
 
-        if used_mechanism
-          used_bits << "used mechanism: #{used_mechanism}"
-        end
+        used_bits << "used mechanism: #{used_mechanism}" if used_mechanism
 
-        if server
-          used_bits << "used server: #{server.address} (#{server.status})"
-        end
+        used_bits << "used server: #{server.address} (#{server.status})" if server
 
         used_user = if user.mechanism == :mongodb_x509
-          'Client certificate'
-        else
-          "User #{user.name}"
-        end
+                      'Client certificate'
+                    else
+                      "User #{user.name}"
+                    end
 
-        if configured_bits.empty?
-          configured_bits = ''
-        else
-          configured_bits = " (#{configured_bits.join(', ')})"
-        end
+        configured_bits = if configured_bits.empty?
+                            ''
+                          else
+                            " (#{configured_bits.join(', ')})"
+                          end
 
         used_bits = " (#{used_bits.join(', ')})"
 
         msg = "#{used_user}#{configured_bits} is not authorized to access #{user.database}#{used_bits}"
-        if message
-          msg += ': ' + message
-        end
+        msg += ': ' + message if message
         super(msg)
       end
     end

data/lib/mongo/background_thread.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -16,7 +15,6 @@
 # limitations under the License.
 
 module Mongo
-
   # The run!, running? and stop! methods used to be part of the public API
   # in some of the classes which now include this module. Therefore these
   # methods must be considered part of the driver's public API for backwards
@@ -111,9 +109,7 @@ module Mongo
     def start!
       @thread = Thread.new do
         catch(:done) do
-          until @stop_requested
-            do_work
-          end
+          do_work until @stop_requested
         end
       end
     end
@@ -130,17 +126,15 @@ module Mongo
       # a background thread could be performing, say, network I/O and if
       # the network is no longer available that could take a long time.
       start_time = Utils.monotonic_time
-      ([0.1, 0.15] + [0.2] * 5 + [0.3] * 20).each do |interval|
-        begin
-          Timeout.timeout(interval) do
-            @thread.join
-          end
-          break
-        rescue ::Timeout::Error
+      ([ 0.1, 0.15 ] + ([ 0.2 ] * 5) + ([ 0.3 ] * 20)).each do |interval|
+        Timeout.timeout(interval) do
+          @thread.join
         end
+        break
+      rescue ::Timeout::Error
       end
 
-      # Some driver objects can be reconnected, for backwards compatibiilty
+      # Some driver objects can be reconnected, for backwards compatibility
       # reasons. Clear the thread instance variable to support this cleanly.
       if @thread.alive?
         log_warn("Failed to stop the background thread in #{self} in #{(Utils.monotonic_time - start_time).to_i} seconds: #{@thread.inspect} (thread status: #{@thread.status})")
@@ -162,12 +156,10 @@ module Mongo
     end
 
     # Override this method to do the work in the background thread.
-    def do_work
-    end
+    def do_work; end
 
     # Override this method to perform additional signaling for the background
     # thread to stop.
-    def pre_stop
-    end
+    def pre_stop; end
   end
 end

data/lib/mongo/bson.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@
 #
 # @since 2.2.1
 class Symbol
-
   # Overrides the default BSON type to use the symbol type instead of a
   # string type.
   #

data/lib/mongo/bulk_write/combineable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,14 +16,12 @@
 
 module Mongo
   class BulkWrite
-
     # Defines behavior around combiners
     #
     # @api private
     #
     # @since 2.1.0
     module Combineable
-
       # @return [ Array<Hash, BSON::Document> ] requests The provided requests.
       attr_reader :requests
 

data/lib/mongo/bulk_write/ordered_combiner.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class BulkWrite
-
     # Combines groups of bulk write operations in order.
     #
     # @api private
@@ -45,7 +43,7 @@ module Mongo
       private
 
       def add(operations, name, document)
-        operations.push({ name => []}) if next_group?(name, operations)
+        operations.push({ name => [] }) if next_group?(name, operations)
         operations[-1][name].push(transform(name, document))
         operations
       end

data/lib/mongo/bulk_write/result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,56 +16,58 @@
 
 module Mongo
   class BulkWrite
-
     # Wraps a series of bulk write operations in a result object.
     #
     # @since 2.0.6
     class Result
-
       # @return [ Boolean ] Is the result acknowledged?
       def acknowledged?
         @acknowledged
       end
 
+      # @return [ Array<String> ] Deduplicated list of "host:port" addresses of
+      #   the servers that produced this bulk write's operations.
+      attr_reader :server_addresses
+
       # Constant for number removed.
       #
       # @since 2.1.0
-      REMOVED_COUNT = 'n_removed'.freeze
+      REMOVED_COUNT = 'n_removed'
 
       # Constant for number inserted.
       #
       # @since 2.1.0
-      INSERTED_COUNT = 'n_inserted'.freeze
+      INSERTED_COUNT = 'n_inserted'
 
       # Constant for inserted ids.
       #
       # @since 2.1.0
-      INSERTED_IDS = 'inserted_ids'.freeze
+      INSERTED_IDS = 'inserted_ids'
 
       # Constant for number matched.
       #
       # @since 2.1.0
-      MATCHED_COUNT = 'n_matched'.freeze
+      MATCHED_COUNT = 'n_matched'
 
       # Constant for number modified.
       #
       # @since 2.1.0
-      MODIFIED_COUNT = 'n_modified'.freeze
+      MODIFIED_COUNT = 'n_modified'
 
       # Constant for upserted.
       #
       # @since 2.1.0
-      UPSERTED = 'upserted'.freeze
+      UPSERTED = 'upserted'
 
       # Constant for number upserted.
       #
       # @since 2.1.0
-      UPSERTED_COUNT = 'n_upserted'.freeze
+      UPSERTED_COUNT = 'n_upserted'
 
       # Constant for upserted ids.
       #
       # @since 2.1.0
-      UPSERTED_IDS = 'upserted_ids'.freeze
+      UPSERTED_IDS = 'upserted_ids'
 
       # The fields contained in the result document returned from executing the
       # operations.
@@ -100,13 +101,17 @@ module Mongo
       #
       # @param [ BSON::Document, Hash ] results The results document.
       # @param [ Boolean ] acknowledged Is the result acknowledged?
+      # @param [ Array<String> ] server_addresses Deduplicated "host:port"
+      #   addresses of the servers that produced the underlying operation
+      #   results.
       #
       # @since 2.1.0
       #
       # @api private
-      def initialize(results, acknowledged)
+      def initialize(results, acknowledged, server_addresses = [])
         @results = results
         @acknowledged = acknowledged
+        @server_addresses = Array(server_addresses).compact.uniq
       end
 
       # Returns the number of documents inserted.
@@ -192,11 +197,9 @@ module Mongo
       #
       # @since 2.1.0
       def validate!
-        if @results['writeErrors'] || @results['writeConcernErrors']
-          raise Error::BulkWriteError.new(@results)
-        else
-          self
-        end
+        raise Error::BulkWriteError.new(@results, server_addresses: @server_addresses) if @results['writeErrors'] || @results['writeConcernErrors']
+
+        self
       end
     end
   end

data/lib/mongo/bulk_write/result_combiner.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,20 +16,22 @@
 
 module Mongo
   class BulkWrite
-
     # Combines bulk write results together.
     #
     # @api private
     #
     # @since 2.1.0
     class ResultCombiner
-
       # @return [ Integer ] count The number of documents in the entire batch.
       attr_reader :count
 
       # @return [ Hash ] results The results hash.
       attr_reader :results
 
+      # @return [ Array<String> ] Deduplicated list of "host:port" addresses of
+      #   the servers that produced the combined operation results.
+      attr_reader :server_addresses
+
       # Create the new result combiner.
       #
       # @api private
@@ -42,6 +43,7 @@ module Mongo
       def initialize
         @results = {}
         @count = 0
+        @server_addresses = []
       end
 
       # Adds a result to the overall results.
@@ -71,6 +73,8 @@ module Mongo
         combine_errors!(result)
         @count += count
         @acknowledged = result.acknowledged?
+        seed = result.connection_description&.address&.seed
+        @server_addresses << seed if seed && !@server_addresses.include?(seed)
       end
 
       # Get the final result.
@@ -81,7 +85,7 @@ module Mongo
       #
       # @since 2.1.0
       def result
-        BulkWrite::Result.new(results, @acknowledged).validate!
+        BulkWrite::Result.new(results, @acknowledged, @server_addresses).validate!
       end
 
       private
@@ -97,12 +101,12 @@ module Mongo
       def combine_ids!(result)
         if result.respond_to?(Result::INSERTED_IDS)
           results[Result::INSERTED_IDS] = (results[Result::INSERTED_IDS] || []) +
-                                            result.inserted_ids
-        end
-        if result.respond_to?(Result::UPSERTED)
-          results[Result::UPSERTED_IDS] = (results[Result::UPSERTED_IDS] || []) +
-                                            result.upserted.map{ |doc| doc['_id'] }
+                                          result.inserted_ids
         end
+        return unless result.respond_to?(Result::UPSERTED)
+
+        results[Result::UPSERTED_IDS] = (results[Result::UPSERTED_IDS] || []) +
+                                        result.upserted.map { |doc| doc['_id'] }
       end
 
       def combine_errors!(result)
@@ -121,10 +125,10 @@ module Mongo
       end
 
       def combine_write_concern_errors!(result)
-        if write_concern_errors = result.aggregate_write_concern_errors(count)
-          results['writeConcernErrors'] = (results['writeConcernErrors'] || []) +
-                                                   write_concern_errors
-        end
+        return unless write_concern_errors = result.aggregate_write_concern_errors(count)
+
+        results['writeConcernErrors'] = (results['writeConcernErrors'] || []) +
+                                        write_concern_errors
       end
     end
   end