mongo 2.12.1 → 2.13.0

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -88,7 +88,7 @@ module Mongo
         end
 
         def bulk_result
-          BulkResult.new(@replies)
+          BulkResult.new(@replies, connection_description)
         end
 
         private

data/lib/mongo/operation/update_user.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/operation/update_user/command.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,12 +29,12 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :updateUser => user.name }.merge(user.spec)
         end
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, command(server), options)
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :updateUser => user.name }.merge(user.spec)
         end
       end

data/lib/mongo/operation/users_info.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/operation/users_info/command.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -30,12 +30,12 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :usersInfo => user_name }
         end
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, command(server), options(server))
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :usersInfo => user_name }
         end
       end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/options.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/options/mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/options/redacted.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/bit_vector.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/compressed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/delete.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/get_more.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/insert.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/kill_cursors.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/message.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -199,10 +199,33 @@ module Mongo
       # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
       #   this message using BSON types instead of native Ruby types wherever
       #   possible.
+      # @option options [ Numeric ] :socket_timeout The timeout to use for
+      #   each read operation.
       #
       # @return [ Message ] Instance of a Message class
-      def self.deserialize(io, max_message_size = MAX_MESSAGE_SIZE, expected_response_to = nil, options = {})
-        length, _request_id, response_to, _op_code = deserialize_header(BSON::ByteBuffer.new(io.read(16)))
+      #
+      # @api private
+      def self.deserialize(io,
+        max_message_size = MAX_MESSAGE_SIZE,
+        expected_response_to = nil,
+        options = {}
+      )
+        # io is usually a Mongo::Socket instance, which supports the
+        # timeout option. For compatibility with whoever might call this
+        # method with some other IO-like object, pass options only when they
+        # are not empty.
+        read_options = {}
+        if timeout = options[:socket_timeout]
+          read_options[:timeout] = timeout
+        end
+
+        if read_options.empty?
+          chunk = io.read(16)
+        else
+          chunk = io.read(16, **read_options)
+        end
+        buf = BSON::ByteBuffer.new(chunk)
+        length, _request_id, response_to, _op_code = deserialize_header(buf)
 
         # Protection from potential DOS man-in-the-middle attacks. See
         # DRIVERS-276.
@@ -216,14 +239,19 @@ module Mongo
           raise Error::UnexpectedResponse.new(expected_response_to, response_to)
         end
 
-        message = Registry.get(_op_code).allocate
-        buffer = BSON::ByteBuffer.new(io.read(length - 16))
+        if read_options.empty?
+          chunk = io.read(length - 16)
+        else
+          chunk = io.read(length - 16, **read_options)
+        end
+        buf = BSON::ByteBuffer.new(chunk)
 
+        message = Registry.get(_op_code).allocate
         message.send(:fields).each do |field|
           if field[:multi]
-            deserialize_array(message, buffer, field, options)
+            deserialize_array(message, buf, field, options)
           else
-            deserialize_field(message, buffer, field, options)
+            deserialize_field(message, buf, field, options)
           end
         end
         if message.is_a?(Msg)
@@ -374,7 +402,7 @@ module Mongo
       #   each of the elements in this array using BSON types wherever possible.
       #
       # @return [Message] Message with deserialized array.
-      def self.deserialize_array(message, io, field, options)
+      def self.deserialize_array(message, io, field, options = {})
         elements = []
         count = message.instance_variable_get(field[:multi])
         count.times { elements << field[:type].deserialize(io, options) }
@@ -392,7 +420,7 @@ module Mongo
       #   this field using BSON types wherever possible.
       #
       # @return [Message] Message with deserialized field.
-      def self.deserialize_field(message, io, field, options)
+      def self.deserialize_field(message, io, field, options = {})
         message.instance_variable_set(
           field[:name],
           field[:type].deserialize(io, options)

data/lib/mongo/protocol/msg.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -60,6 +60,13 @@ module Mongo
       #
       # @since 2.5.0
       def initialize(flags, options, main_document, *sequences)
+        if flags
+          flags.each do |flag|
+            unless KNOWN_FLAGS.key?(flag)
+              raise ArgumentError, "Unknown flag: #{flag.inspect}"
+            end
+          end
+        end
         @flags = flags || []
         @options = options
         unless main_document.is_a?(Hash)
@@ -140,6 +147,8 @@ module Mongo
       #
       # @since 2.5.0
       def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil)
+        validate_document_size!(max_bson_size)
+
         super
         add_check_sum(buffer)
         buffer
@@ -195,15 +204,15 @@ module Mongo
       #
       # @return [ Mongo::Protocol::Msg ] The encrypted message, or the original
       #   message if encryption was not possible or necessary.
-      def maybe_encrypt(server, client)
+      def maybe_encrypt(connection, client)
         # TODO verify compression happens later, i.e. when this method runs
         # the message is not compressed.
         if client && client.encrypter && client.encrypter.encrypt?
-          if server.max_wire_version < 8
+          if connection.description.max_wire_version < 8
             raise Error::CryptError.new(
               "Cannot perform encryption against a MongoDB server older than " +
               "4.2 (wire version less than 8). Currently connected to server " +
-              "with max wire version #{server.max_wire_version}} " +
+              "with max wire version #{connection.description.max_wire_version}} " +
               "(Auto-encryption requires a minimum MongoDB version of 4.2)"
             )
           end
@@ -268,6 +277,23 @@ module Mongo
 
       private
 
+      # Validate that the documents in this message are all smaller than the
+      # maxBsonObjectSize. If not, raise an exception.
+      def validate_document_size!(max_bson_size)
+        max_bson_size ||= Mongo::Server::ConnectionBase::DEFAULT_MAX_BSON_OBJECT_SIZE
+
+        contains_too_large_document = @sections.any? do |section|
+          section[:type] == 1 &&
+            section[:payload][:sequence].any? do |document|
+              document.to_bson.length > max_bson_size
+            end
+        end
+
+        if contains_too_large_document
+          raise Error::MaxBSONSize.new('The document exceeds maximum allowed BSON object size after serialization')
+        end
+      end
+
       def command
         @command ||= if @main_document
           @main_document.dup.tap do |cmd|
@@ -313,10 +339,17 @@ module Mongo
       # @since 2.5.0
       OP_CODE = 2013
 
+      KNOWN_FLAGS = {
+        checksum_present: true,
+        more_to_come: true,
+        exhaust_allowed: true,
+      }
+
       # Available flags for a OP_MSG message.
       FLAGS = Array.new(16).tap do |arr|
         arr[0] = :checksum_present
         arr[1] = :more_to_come
+        arr[16] = :exhaust_allowed
       end.freeze
 
       # @!attribute

data/lib/mongo/protocol/query.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/registry.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/reply.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/serializers.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -440,12 +440,15 @@ module Mongo
         # Deserializes bytes from the byte buffer.
         #
         # @param [ BSON::ByteBuffer ] buffer Buffer containing the value to read.
-        # @param [ Integer ] num_bytes Number of bytes to read.
+        # @param [ Hash ] options The method options.
+        #
+        # @option options [ Integer ] num_bytes Number of bytes to read.
         #
         # @return [ String ] The bytes.
         #
         # @since 2.5.0
-        def self.deserialize(buffer, num_bytes = nil)
+        def self.deserialize(buffer, options = {})
+          num_bytes = options[:num_bytes]
           buffer.get_bytes(num_bytes || buffer.length)
         end
       end

data/lib/mongo/protocol/update.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/retryable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -221,7 +221,7 @@ module Mongo
       rescue Error::SocketError, Error::SocketTimeoutError => e
         e.add_note('modern retry')
         e.add_note("attempt 1")
-        if session.in_transaction? && !ending_transaction
+        if !e.label?('RetryableWriteError')
           raise e
         end
         retry_write(e, session, txn_num, &block)
@@ -230,7 +230,7 @@ module Mongo
         e.add_note("attempt 1")
         if e.unsupported_retryable_write?
           raise_unsupported_error(e)
-        elsif (session.in_transaction? && !ending_transaction) || !e.write_retryable?
+        elsif !e.label?('RetryableWriteError')
           raise e
         end
 
@@ -298,7 +298,7 @@ module Mongo
         if attempt > client.max_write_retries
           raise e
         end
-        if e.write_retryable? && !(session && session.in_transaction?)
+        if e.label?('RetryableWriteError')
           log_retry(e, message: 'Legacy write retry')
           cluster.scan!(false)
           retry
@@ -381,9 +381,11 @@ module Mongo
     def retry_read(original_error, server_selector, session, &block)
       begin
         server = select_server(cluster, server_selector, session)
-      rescue => e
+      rescue Error, Error::AuthError => e
         original_error.add_note("later retry failed: #{e.class}: #{e}")
-        raise original_error
+
+        # See the corresponding note below in retry_write.
+        raise Error::RaiseOriginalError
       end
 
       log_retry(original_error, message: 'Read retry')
@@ -402,11 +404,13 @@ module Mongo
         end
         e.add_note("attempt 2")
         raise e
-      rescue => e
+      rescue Error, Error::AuthError => e
         e.add_note('modern retry')
         original_error.add_note("later retry failed: #{e.class}: #{e}")
         raise original_error
       end
+    rescue Error::RaiseOriginalError
+      raise original_error
     end
 
     def retry_write(original_error, session, txn_num, &block)
@@ -420,7 +424,14 @@ module Mongo
         # Do not need to add "modern retry" here, it should already be on
         # the first exception.
         original_error.add_note('did not retry because server selected for retry does not supoprt retryable writes')
-        raise original_error
+
+        # When we want to raise the original error, we must not run the
+        # rescue blocks below that add diagnostics because the diagnostics
+        # added would either be rendundant (e.g. modern retry note) or wrong
+        # (e.g. "attempt 2", we are raising the exception produced in the
+        # first attempt and haven't attempted the second time). Use the
+        # special marker class to bypass the ordinarily applicable rescues.
+        raise Error::RaiseOriginalError
       end
       log_retry(original_error, message: 'Write retry')
       yield(server, txn_num, true)
@@ -430,18 +441,20 @@ module Mongo
       raise e
     rescue Error::OperationFailure => e
       e.add_note('modern retry')
-      if e.write_retryable?
+      if e.label?('RetryableWriteError')
         e.add_note('attempt 2')
         raise e
       else
         original_error.add_note("later retry failed: #{e.class}: #{e}")
         raise original_error
       end
-    rescue => e
+    rescue Error, Error::AuthError => e
       # Do not need to add "modern retry" here, it should already be on
       # the first exception.
       original_error.add_note("later retry failed: #{e.class}: #{e}")
       raise original_error
+    rescue Error::RaiseOriginalError
+      raise original_error
     end
 
     # This is a separate method to make it possible for the test suite to