mongo 2.15.0 → 2.17.0

data/lib/mongo/server/monitor/connection.rb

@@ -194,13 +194,12 @@ module Mongo
         #
         # @raise [Mongo::Error] If handshake failed.
         def handshake!
-          document = handshake_document(
-            @app_metadata,
-            server_api: options[:server_api]
+          command = handshake_command(
+            handshake_document(
+              @app_metadata,
+              server_api: options[:server_api]
+            )
           )
-          # TODO (DR): OP_MSG should be used if api version is declared.
-          # See https://github.com/mongodb/specifications/blob/master/source/message/OP_MSG.rst#id5
-          command = Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1)
           payload = command.serialize.to_s
           message = dispatch_bytes(payload)
           result = Operation::Result.new(message)

data/lib/mongo/server/monitor.rb

@@ -215,7 +215,8 @@ module Mongo
           old_description = server.description
 
           new_description = Description.new(server.address, result,
-            server.round_trip_time_averager.average_round_trip_time)
+            average_round_trip_time: server.round_trip_time_averager.average_round_trip_time
+          )
 
           server.cluster.run_sdam_flow(server.description, new_description, awaited: awaited)
 

data/lib/mongo/server/pending_connection.rb

@@ -71,32 +71,41 @@ module Mongo
           raise Error::InternalDriverError, "Connection description cannot be unknown after successful handshake: #{description.inspect}"
         end
 
-        if speculative_auth_doc && (speculative_auth_result = result['speculativeAuthenticate'])
-          unless description.features.scram_sha_1_enabled?
-            raise Error::InvalidServerAuthResponse, "Speculative auth succeeded on a pre-3.0 server"
-          end
-          case speculative_auth_user.mechanism
-          when :mongodb_x509
-            # Done
-          # We default auth mechanism to scram256, but if user specified
-          # scram explicitly we may be able to authenticate speculatively
-          # with scram.
-          when :scram, :scram256
-            authenticate!(
-              speculative_auth_client_nonce: speculative_auth.conversation.client_nonce,
-              speculative_auth_mech: speculative_auth_user.mechanism,
-              speculative_auth_result: speculative_auth_result,
-            )
-          else
-            raise Error::InternalDriverError, "Speculative auth unexpectedly succeeded for mechanism #{speculative_auth_user.mechanism.inspect}"
+        begin
+          if speculative_auth_doc && (speculative_auth_result = result['speculativeAuthenticate'])
+            unless description.features.scram_sha_1_enabled?
+              raise Error::InvalidServerAuthResponse, "Speculative auth succeeded on a pre-3.0 server"
+            end
+            case speculative_auth_user.mechanism
+            when :mongodb_x509
+              # Done
+            # We default auth mechanism to scram256, but if user specified
+            # scram explicitly we may be able to authenticate speculatively
+            # with scram.
+            when :scram, :scram256
+              authenticate!(
+                speculative_auth_client_nonce: speculative_auth.conversation.client_nonce,
+                speculative_auth_mech: speculative_auth_user.mechanism,
+                speculative_auth_result: speculative_auth_result,
+              )
+            else
+              raise Error::InternalDriverError, "Speculative auth unexpectedly succeeded for mechanism #{speculative_auth_user.mechanism.inspect}"
+            end
+          elsif !description.arbiter?
+            authenticate!
           end
-        elsif !description.arbiter?
-          authenticate!
+        rescue Mongo::Error, Mongo::Error::AuthError => exc
+          exc.service_id = service_id
+          raise
         end
 
         if description.unknown?
           raise Error::InternalDriverError, "Connection description cannot be unknown after successful authentication: #{description.inspect}"
         end
+
+        if server.load_balancer? && !description.mongos?
+          raise Error::BadLoadBalancerTarget, "Load-balanced operation requires being connected a mongos, but the server at #{address.seed} reported itself as #{description.server_type.to_s.gsub('_', ' ')}"
+        end
       end
 
       private
@@ -111,16 +120,14 @@ module Mongo
           raise Error::InternalDriverError, "Cannot handshake because there is no usable socket (for #{address})"
         end
 
-        hello_doc = handshake_document(
-          app_metadata,
-          speculative_auth_doc: speculative_auth_doc,
-          server_api: options[:server_api],
+        hello_command = handshake_command(
+          handshake_document(
+            app_metadata,
+            speculative_auth_doc: speculative_auth_doc,
+            load_balancer: server.load_balancer?,
+            server_api: options[:server_api]
+          )
         )
-
-        # TODO (DR): OP_MSG should be used if api version is declared.
-        # See https://github.com/mongodb/specifications/blob/master/source/message/OP_MSG.rst#id5
-        hello_command = Protocol::Query.new(Database::ADMIN, Database::COMMAND, hello_doc, :limit => -1)
-
         doc = nil
         @server.handle_handshake_failure! do
           begin
@@ -144,6 +151,10 @@ module Mongo
           end
         end
 
+        if @server.force_load_balancer?
+          doc['serviceId'] ||= "fake:#{rand(2**32-1)+1}"
+        end
+
         post_handshake(doc, @server.round_trip_time_averager.average_round_trip_time)
 
         doc
@@ -193,7 +204,7 @@ module Mongo
       # This is a separate method to keep the nesting level down.
       #
       # @return [ Server::Description ] The server description calculated from
-      #   hello response for this particular connection.
+      #   the handshake response for this particular connection.
       def post_handshake(response, average_rtt)
         if response["ok"] == 1
           # Auth mechanism is entirely dependent on the contents of
@@ -210,7 +221,12 @@ module Mongo
           @sasl_supported_mechanisms = nil
         end
 
-        @description = Description.new(address, response, average_rtt).tap do |new_description|
+        @description = Description.new(
+          address, response,
+          average_round_trip_time: average_rtt,
+          load_balancer: server.load_balancer?,
+          force_load_balancer: options[:connect] == :load_balanced,
+        ).tap do |new_description|
           @server.cluster.run_sdam_flow(@server.description, new_description)
         end
       end

data/lib/mongo/server/push_monitor.rb

@@ -110,13 +110,22 @@ module Mongo
         if new_description.topology_version
           @topology_version = new_description.topology_version
         end
-      rescue Mongo::Error => exc
+      rescue IOError, SocketError, SystemCallError, Mongo::Error => exc
+        stop_requested = @lock.synchronize { @stop_requested }
+        if stop_requested
+          # Ignore the exception, see RUBY-2771.
+          return
+        end
+
         msg = "Error running awaited hello on #{server.address}"
         Utils.warn_bg_exception(msg, exc,
           logger: options[:logger],
           log_prefix: options[:log_prefix],
           bg_error_backtrace: options[:bg_error_backtrace],
         )
+
+        # Avoid tight looping in push monitor - see RUBY-2806.
+        sleep(0.5)
       end
 
       def check

data/lib/mongo/server.rb

@@ -54,6 +54,9 @@ module Mongo
     #   done by this server. Note: setting this option to false will make
     #   the server non-functional. It is intended for use in tests which
     #   manually invoke SDAM state transitions.
+    # @option options [ true | false ] :load_balancer Whether this server
+    #   is a load balancer.
+    # @option options [ String ] :connect The client connection mode.
     #
     # @since 2.0.0
     def initialize(address, cluster, monitoring, event_listeners, options = {})
@@ -69,7 +72,10 @@ module Mongo
       end
       @scan_semaphore = DistinguishingSemaphore.new
       @round_trip_time_averager = RoundTripTimeAverager.new
-      @description = Description.new(address, {})
+      @description = Description.new(address, {},
+        load_balancer: !!@options[:load_balancer],
+        force_load_balancer: force_load_balancer?,
+      )
       @last_scan = nil
       @last_scan_monotime = nil
       unless options[:monitoring_io] == false
@@ -107,6 +113,15 @@ module Mongo
     #   description the monitor refreshes.
     attr_reader :description
 
+    # Returns whether this server is forced to be a load balancer.
+    #
+    # @return [ true | false ] Whether this server is forced to be a load balancer.
+    #
+    # @api private
+    def force_load_balancer?
+      options[:connect] == :load_balanced
+    end
+
     # @return [ Time | nil ] last_scan The time when the last server scan
     #   completed, or nil if the server has not been scanned yet.
     #
@@ -180,6 +195,7 @@ module Mongo
                    :secondary?,
                    :standalone?,
                    :unknown?,
+                   :load_balancer?,
                    :last_write_date,
                    :logical_session_timeout
 
@@ -222,20 +238,6 @@ module Mongo
       address == other.address
     end
 
-    # Get a new context for this server in which to send messages.
-    #
-    # @example Get the server context.
-    #   server.context
-    #
-    # @return [ Mongo::Server::Context ] context The server context.
-    #
-    # @since 2.0.0
-    #
-    # @deprecated Will be removed in version 3.0
-    def context
-      Context.new(self)
-    end
-
     # Determine if a connection to the server is able to be established and
     # messages can be sent to it.
     #
@@ -301,13 +303,20 @@ module Mongo
     #
     # @api private
     def start_monitoring
+      publish_opening_event
+      if options[:monitoring_io] != false
+        monitor.run!
+      end
+    end
+
+    # Publishes the server opening event.
+    #
+    # @api private
+    def publish_opening_event
       publish_sdam_event(
         Monitoring::SERVER_OPENING,
         Monitoring::Event::ServerOpening.new(address, cluster.topology)
       )
-      if options[:monitoring_io] != false
-        monitor.run!
-      end
     end
 
     # Get a pretty printed server inspection.
@@ -327,6 +336,8 @@ module Mongo
     # @api private
     def status
       case
+      when load_balancer?
+        'LB'
       when primary?
         'PRIMARY'
       when secondary?
@@ -433,8 +444,8 @@ module Mongo
     # @return [ Object ] The result of the block execution.
     #
     # @since 2.3.0
-    def with_connection(&block)
-      pool.with_connection(&block)
+    def with_connection(service_id: nil, &block)
+      pool.with_connection(service_id: service_id, &block)
     end
 
     # Handle handshake failure.
@@ -444,7 +455,11 @@ module Mongo
     def handle_handshake_failure!
       yield
     rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError => e
-      unknown!(generation: e.generation, stop_push_monitor: true)
+      unknown!(
+        generation: e.generation,
+        service_id: e.service_id,
+        stop_push_monitor: true,
+      )
       raise
     end
 
@@ -467,7 +482,11 @@ module Mongo
       raise
     rescue Mongo::Error::SocketError => e
       # non-timeout network error
-      unknown!(generation: e.generation, stop_push_monitor: true)
+      unknown!(
+        generation: e.generation,
+        service_id: e.service_id,
+        stop_push_monitor: true,
+      )
       raise
     rescue Auth::Unauthorized
       # auth error, keep server description and topology as they are
@@ -513,13 +532,33 @@ module Mongo
     #   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 [ Object ] :service_id Discard state for the specified
+    #   service id only.
     # @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.
+    # @option options [ Object ] :service_id Discard state for the specified
+    #   service id only.
     #
     # @since 2.4.0, SDAM events are sent as of version 2.7.0
     def unknown!(options = {})
+      if load_balancer?
+        # When the client is in load-balanced topology, servers (the one and
+        # only that can be) starts out as a load balancer and stays as a
+        # load balancer indefinitely. As such it is not marked unknown.
+        #
+        # However, this method also clears connection pool for the server
+        # when the latter is marked unknown, and this part needs to happen
+        # when the server is a load balancer.
+        if service_id = options[:service_id]
+          pool.disconnect!(service_id: service_id)
+        elsif Lint.enabled?
+          raise Error::LintError, 'Load balancer was asked to be marked unknown without a service id'
+        end
+        return
+      end
+
       if options[:generation] && options[:generation] < pool.generation
         return
       end
@@ -537,10 +576,16 @@ module Mongo
       # SDAM flow will update description on the server without in-place
       # mutations and invoke SDAM transitions as needed.
       config = {}
+      if options[:service_id]
+        config['serviceId'] = options[:service_id]
+      end
       if options[:topology_version]
         config['topologyVersion'] = options[:topology_version]
       end
-      new_description = Description.new(address, config)
+      new_description = Description.new(address, config,
+        load_balancer: load_balancer?,
+        force_load_balancer: options[:connect] == :load_balanced,
+      )
       cluster.run_sdam_flow(description, new_description, options)
     end
 
@@ -549,11 +594,14 @@ module Mongo
       @description = description
     end
 
+    # @param [ Object ] :service_id Close connections with the specified
+    #   service id only.
+    #
     # @api private
-    def clear_connection_pool
+    def clear_connection_pool(service_id: nil)
       @pool_lock.synchronize do
         if @pool
-          @pool.disconnect!
+          @pool.disconnect!(service_id: service_id)
         end
       end
     end
@@ -577,7 +625,6 @@ require 'mongo/server/connection_base'
 require 'mongo/server/pending_connection'
 require 'mongo/server/connection'
 require 'mongo/server/connection_pool'
-require 'mongo/server/context'
 require 'mongo/server/description'
 require 'mongo/server/monitor'
 require 'mongo/server/round_trip_time_averager'

data/lib/mongo/server_selector/base.rb

@@ -162,6 +162,8 @@ module Mongo
       #   Deprecated and ignored.
       # @param [ Session | nil ] session Optional session to take into account
       #   for mongos pinning. Added in version 2.10.0.
+      # @param [ true | false ] write_aggregation Whether we need a server that
+      #   supports writing aggregations (e.g. with $merge/$out) on secondaries.
       #
       # @return [ Mongo::Server ] A server matching the server preference.
       #
@@ -172,7 +174,11 @@ module Mongo
       #   lint mode is enabled.
       #
       # @since 2.0.0
-      def select_server(cluster, ping = nil, session = nil)
+      def select_server(cluster, ping = nil, session = nil, write_aggregation: false)
+        if cluster.topology.is_a?(Cluster::Topology::LoadBalanced)
+          return cluster.servers.first
+        end
+
         server_selection_timeout = cluster.options[:server_selection_timeout] || SERVER_SELECTION_TIMEOUT
 
         # Special handling for zero timeout: if we have to select a server,
@@ -239,7 +245,7 @@ module Mongo
 =end
 
         loop do
-          server = try_select_server(cluster)
+          server = try_select_server(cluster, write_aggregation: write_aggregation)
 
           if server
             unless cluster.topology.compatible?
@@ -247,7 +253,7 @@ module Mongo
             end
 
             if session && session.starting_transaction? && cluster.sharded?
-              session.pin(server)
+              session.pin_to_server(server)
             end
 
             return server
@@ -290,11 +296,31 @@ module Mongo
       # Tries to find a suitable server, returns the server if one is available
       # or nil if there isn't a suitable server.
       #
+      # @param [ Mongo::Cluster ] cluster The cluster from which to select
+      #   an eligible server.
+      # @param [ true | false ] write_aggregation Whether we need a server that
+      #   supports writing aggregations (e.g. with $merge/$out) on secondaries.
+      #
       # @return [ Server | nil ] A suitable server, if one exists.
       #
       # @api private
-      def try_select_server(cluster)
-        servers = suitable_servers(cluster)
+      def try_select_server(cluster, write_aggregation: false)
+        servers = if write_aggregation && cluster.replica_set?
+          # 1. Check if ALL servers in cluster support secondary writes.
+          is_write_supported = cluster.servers.reduce(true) do |res, server|
+            res && server.features.merge_out_on_secondary_enabled?
+          end
+
+          if is_write_supported
+            # 2. If all servers support secondary writes, we respect read preference.
+            suitable_servers(cluster)
+          else
+            # 3. Otherwise we fallback to primary for replica set.
+            [cluster.servers.detect(&:primary?)]
+          end
+        else
+          suitable_servers(cluster)
+        end
 
         # This list of servers may be ordered in a specific way
         # by the selector (e.g. for secondary preferred, the first

data/lib/mongo/session/session_pool.rb

@@ -133,6 +133,13 @@ module Mongo
       private
 
       def about_to_expire?(session)
+        # Load balancers spec explicitly requires to ignore the logical session
+        # timeout value.
+        # No rationale is provided as of the time of this writing.
+        if @cluster.load_balanced?
+          return false
+        end
+
         logical_session_timeout = @cluster.logical_session_timeout
 
         if logical_session_timeout
@@ -142,6 +149,10 @@ module Mongo
       end
 
       def prune!
+        # Load balancers spec explicitly requires not to prune sessions.
+        # No rationale is provided as of the time of this writing.
+        return if @cluster.load_balanced?
+
         while !@queue.empty?
           if about_to_expire?(@queue[-1])
             @queue.pop

data/lib/mongo/session.rb

@@ -56,10 +56,16 @@ module Mongo
     #   - *:mode* -- the read preference as a string or symbol; valid values are
     #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
     #     and *:nearest*.
+    # @option options [ true | false ] :snapshot Set up the session for
+    #   snapshot reads.
     #
     # @since 2.5.0
     # @api private
     def initialize(server_session, client, options = {})
+      if options[:causal_consistency] && options[:snapshot]
+        raise ArgumentError, ':causal_consistency and :snapshot options cannot be both set on a session'
+      end
+
       @server_session = server_session
       options = options.dup
 
@@ -83,6 +89,12 @@ module Mongo
       @client.cluster
     end
 
+    # @return [ true | false ] Whether the session is configured for snapshot
+    #   reads.
+    def snapshot?
+      !!options[:snapshot]
+    end
+
     # @return [ BSON::Timestamp ] The latest seen operation time for this session.
     #
     # @since 2.5.0
@@ -208,6 +220,12 @@ module Mongo
     # @api private
     attr_reader :pinned_server
 
+    # @return [ Object | nil ] The service id that this session is pinned to,
+    #   if any.
+    #
+    # @api private
+    attr_reader :pinned_service_id
+
     # @return [ BSON::Document | nil ] Recovery token for the sharded
     #   transaction being executed on this session, if any.
     #
@@ -430,6 +448,7 @@ module Mongo
                 transaction_in_progress = false
                 raise
               end
+              @state = NO_TRANSACTION_STATE
               next
             else
               transaction_in_progress = false
@@ -499,6 +518,10 @@ module Mongo
 =end
       end
 
+      if snapshot?
+        raise Mongo::Error::SnapshotSessionTransactionProhibited
+      end
+
       check_if_ended!
 
       if within_states?(STARTING_TRANSACTION_STATE, TRANSACTION_IN_PROGRESS_STATE)
@@ -695,7 +718,7 @@ module Mongo
     # @param [ Server ] server The server to pin this session to.
     #
     # @api private
-    def pin(server)
+    def pin_to_server(server)
       if server.nil?
         raise ArgumentError, 'Cannot pin to a nil server'
       end
@@ -707,11 +730,24 @@ module Mongo
       @pinned_server = server
     end
 
+    # Pins this session to the specified service.
+    #
+    # @param [ Object ] service_id The service id to pin this session to.
+    #
+    # @api private
+    def pin_to_service(service_id)
+      if service_id.nil?
+        raise ArgumentError, 'Cannot pin to a nil service id'
+      end
+      @pinned_service_id = service_id
+    end
+
     # Unpins this session from the pinned server, if the session was pinned.
     #
     # @api private
     def unpin
       @pinned_server = nil
+      @pinned_service_id = nil
     end
 
     # Unpins this session from the pinned server, if the session was pinned
@@ -1004,6 +1040,9 @@ module Mongo
       @server_session.txn_num
     end
 
+    # @api private
+    attr_accessor :snapshot_timestamp
+
     private
 
     # Get the read concern the session will use when starting a transaction.

data/lib/mongo/socket/ocsp_cache.rb

@@ -21,8 +21,7 @@ module Mongo
     # This module caches OCSP responses for their indicated validity time.
     #
     # The key is the CertificateId used for the OCSP request.
-    # The value is the SingleResponse on Ruby 2.4+, or the OpenStruct
-    # emulation of it on Ruby 2.3.
+    # The value is the SingleResponse.
     #
     # @api private
     module OcspCache
@@ -40,7 +39,7 @@ module Mongo
       # expire by the time caller uses them. The caller should not perform
       # update time checks on the returned response.
       #
-      # @return [ OpenSSL::OCSP::SingleResponse | OpenStruct ] The previously
+      # @return [ OpenSSL::OCSP::SingleResponse ] The previously
       #   retrieved response.
       module_function def get(cert_id)
         resp = responses.detect do |resp|

data/lib/mongo/socket/ocsp_verifier.rb

@@ -237,43 +237,12 @@ module Mongo
           return false
         end
 
-        if resp.respond_to?(:find_response)
-          # Ruby 2.4+
-          resp = resp.find_response(cert_id)
-          # TODO make a new class instead of patching the stdlib one?
-          resp.instance_variable_set('@uri', uri)
-          resp.instance_variable_set('@original_uri', original_uri)
-          class << resp
-            attr_reader :uri, :original_uri
-          end
-        else
-          # Ruby 2.3
-          found = nil
-          resp.status.each do |_cert_id, cert_status, revocation_reason, revocation_time, this_update, next_update, extensions|
-            if _cert_id.cmp(cert_id)
-              found = OpenStruct.new(
-                cert_status: cert_status,
-                certid: _cert_id,
-                next_update: next_update,
-                this_update: this_update,
-                revocation_reason: revocation_reason,
-                revocation_time: revocation_time,
-                extensions: extensions,
-                uri: uri,
-                original_uri: original_uri,
-              )
-              class << found
-                # Unlike the stdlib method, this one doesn't accept
-                # any arguments.
-                def check_validity
-                  now = Time.now
-                  this_update <= now && next_update >= now
-                end
-              end
-              break
-            end
-          end
-          resp = found
+        resp = resp.find_response(cert_id)
+        # TODO make a new class instead of patching the stdlib one?
+        resp.instance_variable_set('@uri', uri)
+        resp.instance_variable_set('@original_uri', original_uri)
+        class << resp
+          attr_reader :uri, :original_uri
         end
 
         unless resp

data/lib/mongo/socket.rb

@@ -362,11 +362,7 @@ module Mongo
     end
 
     def allocate_string(capacity)
-      if RUBY_VERSION >= '2.4.0'
-        String.new('', :capacity => capacity, :encoding => 'BINARY')
-      else
-        ('x'*capacity).force_encoding('BINARY')
-      end
+      String.new('', :capacity => capacity, :encoding => 'BINARY')
     end
 
     def read_buffer_size

data/lib/mongo/uri/options_mapper.rb

@@ -268,6 +268,7 @@ module Mongo
       # Topology options
       uri_option 'directConnection', :direct_connection, type: :bool
       uri_option 'connect', :connect, type: :symbol
+      uri_option 'loadBalanced', :load_balanced, type: :bool
 
       # Auth Options
       uri_option 'authSource', :auth_source