mongo 2.12.4 → 2.13.0

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.
@@ -177,19 +177,10 @@ 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, 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
-
+      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil)
         start = buffer.length
         serialize_header(buffer)
-        serialize_fields(buffer, max_size)
+        serialize_fields(buffer, max_bson_size)
         buffer.replace_int32(start, buffer.length - start)
       end
 
@@ -208,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.
@@ -225,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)

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

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.

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

data/lib/mongo/semaphore.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.

data/lib/mongo/server.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.
@@ -64,7 +64,7 @@ module Mongo
       @connection_id_gen = Class.new do
         include Id
       end
-      @scan_semaphore = Semaphore.new
+      @scan_semaphore = DistinguishingSemaphore.new
       @round_trip_time_averager = RoundTripTimeAverager.new
       @description = Description.new(address, {})
       @last_scan = nil
@@ -72,6 +72,7 @@ module Mongo
         @monitor = Monitor.new(self, event_listeners, monitoring,
           options.merge(
             app_metadata: Monitor::AppMetadata.new(cluster.options),
+            heartbeat_interval: cluster.heartbeat_interval,
         ))
         unless _monitor == false
           start_monitoring
@@ -121,6 +122,8 @@ module Mongo
     # @deprecated
     alias :heartbeat_frequency_seconds :heartbeat_frequency
 
+    # Performs an immediate, synchronous check of the server.
+    #
     # @deprecated
     def_delegators :monitor, :scan!
 
@@ -428,8 +431,8 @@ module Mongo
     # @api private
     def handle_handshake_failure!
       yield
-    rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError
-      unknown!
+    rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError => e
+      unknown!(generation: e.generation, stop_push_monitor: true)
       raise
     end
 
@@ -450,9 +453,9 @@ module Mongo
     rescue Mongo::Error::SocketTimeoutError
       # possibly cluster is slow, do not give up on it
       raise
-    rescue Mongo::Error::SocketError
+    rescue Mongo::Error::SocketError => e
       # non-timeout network error
-      unknown!
+      unknown!(generation: e.generation, stop_push_monitor: true)
       raise
     rescue Auth::Unauthorized
       # auth error, keep server description and topology as they are
@@ -485,19 +488,48 @@ module Mongo
     # Marks server unknown and publishes the associated SDAM event
     # (server description changed).
     #
+    # If the generation is passed in options, the server will only be marked
+    # unknown if the passed generation is no older than the current generation
+    # of the server's connection pool.
+    #
     # @param [ Hash ] options Options.
     #
+    # @option options [ Integer ] :generation Connection pool generation of
+    #   the connection that was used for the operation that produced the error.
     # @option options [ true | false ] :keep_connection_pool Usually when the
     #   new server description is unknown, the connection pool on the
     #   respective server is cleared. Set this option to true to keep the
     #   existing connection pool (required when handling not master errors
     #   on 4.2+ servers).
+    # @option options [ TopologyVersion ] :topology_version Topology version
+    #   of the error response that is causing the server to be marked unknown.
+    # @option options [ true | false ] :stop_push_monitor Whether to stop
+    #   the PushMonitor associated with the server, if any.
     #
     # @since 2.4.0, SDAM events are sent as of version 2.7.0
     def unknown!(options = {})
+      if options[:generation] && options[:generation] < pool.generation
+        return
+      end
+
+      if options[:topology_version] && description.topology_version &&
+        !options[:topology_version].gt?(description.topology_version)
+      then
+        return
+      end
+
+      if options[:stop_push_monitor]
+        monitor&.stop_push_monitor!
+      end
+
       # SDAM flow will update description on the server without in-place
       # mutations and invoke SDAM transitions as needed.
-      cluster.run_sdam_flow(description, Description.new(address), options)
+      config = {}
+      if options[:topology_version]
+        config['topologyVersion'] = options[:topology_version]
+      end
+      new_description = Description.new(address, config)
+      cluster.run_sdam_flow(description, new_description, options)
     end
 
     # @api private
@@ -527,7 +559,6 @@ module Mongo
 end
 
 require 'mongo/server/app_metadata'
-require 'mongo/server/connectable'
 require 'mongo/server/connection_common'
 require 'mongo/server/connection_base'
 require 'mongo/server/pending_connection'
@@ -537,3 +568,4 @@ require 'mongo/server/context'
 require 'mongo/server/description'
 require 'mongo/server/monitor'
 require 'mongo/server/round_trip_time_averager'
+require 'mongo/server/push_monitor'