mongo 2.13.0.beta1 → 2.14.0

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

@@ -18,6 +18,7 @@ module Mongo
     # Custom behavior for operations that support the bypassdocumentvalidation option.
     #
     # @since 2.5.2
+    # @api private
     module BypassDocumentValidation
 
       private

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

@@ -18,6 +18,7 @@ module Mongo
     # Custom behavior for operations that support causal consistency.
     #
     # @since 2.5.2
+    # @api private
     module CausalConsistencySupported
 
       private

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

@@ -14,6 +14,8 @@
 
 module Mongo
   module Operation
+
+    # @api private
     module CollectionsInfoOrListCollections
       include PolymorphicLookup
 

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

@@ -18,6 +18,7 @@ module Mongo
     # Shared executable behavior of operations.
     #
     # @since 2.5.2
+    # @api private
     module Executable
 
       include ResponseHandling

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

@@ -18,6 +18,7 @@ module Mongo
     # Shared behavior of operations that require its documents to each have an id.
     #
     # @since 2.5.2
+    # @api private
     module Idable
 
       def documents
@@ -61,4 +62,4 @@ module Mongo
       end
     end
   end
-end
+end

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

@@ -18,6 +18,7 @@ module Mongo
     # Shared behavior of operations that require its documents to each have an id.
     #
     # @since 2.5.2
+    # @api private
     module Limited
 
       private

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

@@ -18,6 +18,7 @@ module Mongo
     # The default generator of ids for documents.
     #
     # @since 2.2.0
+    # @api private
     class ObjectIdGenerator
 
       # Generate a new id.

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

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of bulk write results
       #
       # @since 2.0.0
+      # @api private
       module Aggregatable
 
         # Aggregate the write errors returned from this result.

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

@@ -18,6 +18,7 @@ module Mongo
     # Shared behavior of operations that support a session.
     #
     # @since 2.5.2
+    # @api private
     module SessionsSupported
 
       private

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

@@ -19,6 +19,7 @@ module Mongo
     # various values from the spec.
     #
     # @since 2.0.0
+    # @api private
     module Specifiable
 
       # The field for database name.

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

@@ -18,6 +18,7 @@ module Mongo
     # Shared behavior of operations that write (update, insert, delete).
     #
     # @since 2.5.2
+    # @api private
     module Write
 
       include ResponseHandling

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

@@ -18,6 +18,7 @@ module Mongo
     # Custom behavior for operations that support write concern.
     #
     # @since 2.5.2
+    # @api private
     module WriteConcernSupported
 
       private

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

@@ -21,17 +21,20 @@ module Mongo
         # version <= 2.4.
         #
         # @since 2.0.0
+        # @api semiprivate
         class Result < Operation::Result
           include Operation::Result::UseLegacyErrorParser
 
           # Whether an existing document was updated.
           #
           # @since 2.0.0
+          # @api private
           UPDATED_EXISTING = 'updatedExisting'.freeze
 
           # The upserted docs field in the result.
           #
           # @since 2.0.0
+          # @api private
           UPSERTED = 'upserted'.freeze
 
           # Get the number of documents matched.
@@ -42,6 +45,7 @@ module Mongo
           # @return [ Integer ] The matched count.
           #
           # @since 2.0.0
+          # @api public
           def matched_count
             return 0 unless acknowledged?
             if upsert?
@@ -59,6 +63,7 @@ module Mongo
           # @return [ nil ] Always omitted for legacy versions.
           #
           # @since 2.0.0
+          # @api public
           def modified_count; end
 
           # The identifier of the inserted document if an upsert
@@ -70,6 +75,7 @@ module Mongo
           # @return [ Object ] The upserted id.
           #
           # @since 2.0.0
+          # @api public
           def upserted_id
             first[UPSERTED] if upsert?
           end
@@ -82,6 +88,7 @@ module Mongo
           # @return [ Integer ] The number upserted.
           #
           # @since 2.4.2
+          # @api public
           def upserted_count
             upsert? ? n : 0
           end

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

@@ -19,16 +19,19 @@ module Mongo
       # Defines custom behavior of results for an update.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The number of modified docs field in the result.
         #
         # @since 2.0.0
+        # @api private
         MODIFIED = 'nModified'.freeze
 
         # The upserted docs field in the result.
         #
         # @since 2.0.0
+        # @api private
         UPSERTED = 'upserted'.freeze
 
         # Get the number of documents matched.
@@ -39,6 +42,7 @@ module Mongo
         # @return [ Integer ] The matched count.
         #
         # @since 2.0.0
+        # @api public
         def matched_count
           return 0 unless acknowledged?
           if upsert?
@@ -56,6 +60,7 @@ module Mongo
         # @return [ Integer ] The modified count.
         #
         # @since 2.0.0
+        # @api public
         def modified_count
           return 0 unless acknowledged?
           first[MODIFIED]
@@ -70,6 +75,7 @@ module Mongo
         # @return [ Object ] The upserted id.
         #
         # @since 2.0.0
+        # @api public
         def upserted_id
           return nil unless upsert?
           upsert?.first['_id']
@@ -83,10 +89,12 @@ module Mongo
         # @return [ Integer ] The number upserted.
         #
         # @since 2.4.2
+        # @api public
         def upserted_count
           upsert? ? n : 0
         end
 
+        # @api public
         def bulk_result
           BulkResult.new(@replies, connection_description)
         end

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

@@ -20,13 +20,16 @@ module Mongo
       # usersInfo command.
       #
       # @since 2.1.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The field name for the users document in a usersInfo result.
         #
         # @since 2.1.0
+        # @api private
         USERS = 'users'.freeze
 
+        # @api public
         def documents
           reply.documents.first[USERS]
         end

data/lib/mongo/protocol/message.rb

@@ -177,10 +177,19 @@ module Mongo
       #
       # @param buffer [String] buffer where the message should be inserted
       # @return [String] buffer containing the serialized message
-      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil)
+      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil, bson_overhead = nil)
+        max_size =
+          if max_bson_size && bson_overhead
+            max_bson_size + bson_overhead
+          elsif max_bson_size
+            max_bson_size
+          else
+            nil
+          end
+
         start = buffer.length
         serialize_header(buffer)
-        serialize_fields(buffer, max_bson_size)
+        serialize_fields(buffer, max_size)
         buffer.replace_int32(start, buffer.length - start)
       end
 
@@ -199,10 +208,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 +248,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 +411,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 +429,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

@@ -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)
@@ -139,7 +146,9 @@ module Mongo
       # @return [ BSON::ByteBuffer ] buffer containing the serialized message.
       #
       # @since 2.5.0
-      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil)
+      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil, bson_overhead = nil)
+        validate_document_size!(max_bson_size)
+
         super
         add_check_sum(buffer)
         buffer
@@ -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

@@ -115,12 +115,48 @@ module Mongo
         compress_if_possible(selector.keys.first, compressor, zlib_compression_level)
       end
 
+      # Serializes message into bytes that can be sent on the wire.
+      #
+      # @param [ BSON::ByteBuffer ] buffer where the message should be inserted.
+      # @param [ Integer ] max_bson_size The maximum bson object size.
+      #
+      # @return [ BSON::ByteBuffer ] buffer containing the serialized message.
+      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil, bson_overhead = nil)
+        validate_document_size!(max_bson_size)
+
+        super
+      end
+
       protected
 
       attr_reader :upconverter
 
       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
+
+        documents = if @selector.key?(:documents)
+                      @selector[:documents]
+                    elsif @selector.key?(:deletes)
+                      @selector[:deletes]
+                    elsif @selector.key?(:updates)
+                      @selector[:updates]
+                    else
+                      []
+                    end
+
+        contains_too_large_document = documents.any? do |doc|
+          doc.to_bson.length > max_bson_size
+        end
+
+        if contains_too_large_document
+          raise Error::MaxBSONSize.new('The document exceeds maximum allowed BSON object size after serialization')
+        end
+      end
+
       # The operation code required to specify a Query message.
       # @return [Fixnum] the operation code.
       #