mongo 2.15.1 → 2.16.0.alpha1

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

@@ -173,6 +173,10 @@ module Mongo
       #
       # @since 2.0.0
       def select_server(cluster, ping = nil, session = nil)
+        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,
@@ -247,7 +251,7 @@ module Mongo
             end
 
             if session && session.starting_transaction? && cluster.sharded?
-              session.pin(server)
+              session.pin_to_server(server)
             end
 
             return server

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

@@ -208,6 +208,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 +436,7 @@ module Mongo
                 transaction_in_progress = false
                 raise
               end
+              @state = NO_TRANSACTION_STATE
               next
             else
               transaction_in_progress = false
@@ -695,7 +702,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 +714,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

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/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

data/lib/mongo/uri/srv_protocol.rb

@@ -80,7 +80,7 @@ module Mongo
       DOT_PARTITION = '.'.freeze
 
       # @return [ Array<String> ] VALID_TXT_OPTIONS The valid options for a TXT record to specify.
-      VALID_TXT_OPTIONS = ['replicaset', 'authsource'].freeze
+      VALID_TXT_OPTIONS = %w(replicaset authsource loadbalanced).freeze
 
       # @return [ String ] INVALID_HOST Error message format string indicating that the hostname in
       #   in the URI does not fit the expected form.
@@ -102,11 +102,6 @@ module Mongo
       #   were found.
       NO_SRV_RECORDS = "The DNS query returned no SRV records for '%s'".freeze
 
-      # @return [ String ] INVALID_TXT_RECORD_OPTION Error message format string indicating that an
-      #   unexpected TXT record option was found.
-      INVALID_TXT_RECORD_OPTION = "TXT records can only specify the options " +
-                                    "[#{VALID_TXT_OPTIONS.join(', ')}].".freeze
-
       # @return [ String ] FORMAT The expected SRV URI format.
       FORMAT = 'mongodb+srv://[username:password@]host[/[database][?options]]'.freeze
 
@@ -222,8 +217,11 @@ module Mongo
       def parse_txt_options!(string)
         string.split(INDIV_URI_OPTS_DELIM).reduce({}) do |txt_options, opt|
           raise Error::InvalidTXTRecord.new(INVALID_OPTS_VALUE_DELIM) unless opt.index(URI_OPTS_VALUE_DELIM)
-          key, value = opt.split(URI_OPTS_VALUE_DELIM)
-          raise Error::InvalidTXTRecord.new(INVALID_TXT_RECORD_OPTION) unless VALID_TXT_OPTIONS.include?(key.downcase)
+          key, value = opt.split('=')
+          unless VALID_TXT_OPTIONS.include?(key.downcase)
+            msg = "TXT records can only specify the options [#{VALID_TXT_OPTIONS.join(', ')}]: #{string}"
+            raise Error::InvalidTXTRecord.new(msg)
+          end
           options_mapper.add_uri_option(key, value, txt_options)
           txt_options
         end

data/lib/mongo/uri.rb

@@ -520,6 +520,24 @@ module Mongo
       elsif uri_options[:direct_connection] == false && uri_options[:connect].to_s == 'direct'
         raise_invalid_error_no_fmt!("directConnection=false cannot be used with connect=direct")
       end
+
+      if uri_options[:load_balanced]
+        if servers.length > 1
+          raise_invalid_error_no_fmt!("loadBalanced=true cannot be used with multiple seeds")
+        end
+
+        if uri_options[:direct_connection]
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with loadBalanced=true")
+        end
+
+        if uri_options[:connect] && uri_options[:connect].to_sym == :direct
+          raise_invalid_error_no_fmt!("connect=direct cannot be used with loadBalanced=true")
+        end
+
+        if uri_options[:replica_set]
+          raise_invalid_error_no_fmt!("loadBalanced=true cannot be used with replicaSet option")
+        end
+      end
     end
   end
 end

data/lib/mongo/utils.rb

@@ -102,13 +102,6 @@ module Mongo
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
 
-    # Hash#compact implementation for Ruby 2.3
-    module_function def compact_hash(hash)
-      Hash[hash.reject do |k, v|
-        v.nil?
-      end]
-    end
-
     # Hash#compact implementation for Ruby 2.3/2.4
     # Implementation based on activesupport 5.2.3
     module_function def slice_hash(hash, *keys)

data/lib/mongo/version.rb

@@ -20,5 +20,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.15.1'.freeze
+  VERSION = '2.16.0.alpha1'.freeze
 end

data/mongo.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.require_paths     = ['lib']
   s.bindir            = 'bin'
 
-  s.required_ruby_version = ">= 2.3"
+  s.required_ruby_version = ">= 2.4"
 
   s.add_dependency 'bson', '>=4.8.2', '<5.0.0'
 end

data/spec/integration/auth_spec.rb

@@ -14,7 +14,7 @@ describe 'Auth' do
     end
 
     let(:base_options) do
-      SpecConfig.instance.monitoring_options
+      SpecConfig.instance.monitoring_options.merge(connect: SpecConfig.instance.test_options[:connect])
     end
 
     let(:connection) do
@@ -276,4 +276,34 @@ describe 'Auth' do
       client.database.command(ping: 1)
     end
   end
+
+  context 'in lb topology' do
+    require_topology :load_balanced
+
+    context 'when authentication fails with network error' do
+      let(:server) do
+        authorized_client.cluster.next_primary
+      end
+
+      let(:base_options) do
+        SpecConfig.instance.monitoring_options.merge(connect: SpecConfig.instance.test_options[:connect])
+      end
+
+      let(:connection) do
+        Mongo::Server::Connection.new(server, base_options)
+      end
+
+      it 'includes service id in exception' do
+        expect_any_instance_of(Mongo::Server::PendingConnection).to receive(:authenticate!).and_raise(Mongo::Error::SocketError)
+
+        begin
+          connection.connect!
+        rescue Mongo::Error::SocketError => exc
+          exc.service_id.should_not be nil
+        else
+          fail 'Expected the SocketError to be raised'
+        end
+      end
+    end
+  end
 end

data/spec/integration/awaited_ismaster_spec.rb

@@ -9,7 +9,7 @@ describe 'awaited hello' do
   # If we send the consecutive hello commands to different mongoses,
   # they have different process ids, and so the awaited one would return
   # immediately.
-  require_no_multi_shard
+  require_no_multi_mongos
 
   let(:client) { authorized_client }
 

data/spec/integration/bulk_write_spec.rb

@@ -21,7 +21,7 @@ describe 'Bulk writes' do
   end
 
   context 'when bulk write needs to be split' do
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:max_bson_size) { Mongo::Server::ConnectionBase::DEFAULT_MAX_BSON_OBJECT_SIZE }
 

data/spec/integration/change_stream_spec.rb

@@ -53,7 +53,7 @@ describe 'Change stream integration', retry: 4 do
       it 'raises an exception and does not attempt to resume' do
         change_stream
 
-        subscriber = EventSubscriber.new
+        subscriber = Mrss::EventSubscriber.new
         authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
 
         expect do
@@ -523,7 +523,7 @@ describe 'Change stream integration', retry: 4 do
     let(:events) do
       start_after
 
-      subscriber = EventSubscriber.new
+      subscriber = Mrss::EventSubscriber.new
       authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
       use_stream
 
@@ -582,7 +582,7 @@ describe 'Change stream integration', retry: 4 do
     let(:stream) { authorized_collection.watch }
 
     let(:events) do
-      subscriber = EventSubscriber.new
+      subscriber = Mrss::EventSubscriber.new
       authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
       use_stream
       subscriber.succeeded_events.select { |e|

data/spec/integration/client_construction_spec.rb

@@ -236,4 +236,58 @@ describe 'Client construction' do
       expect(client.cluster.addresses).to eq([Mongo::Address.new(primary_address)])
     end
   end
+
+  context 'when deployment is not a sharded cluster' do
+    require_topology :single, :replica_set
+
+    let(:client) do
+      ClientRegistry.instance.new_local_client(
+        [SpecConfig.instance.addresses.first],
+        SpecConfig.instance.test_options.merge(options),
+      )
+    end
+
+    context 'when load-balanced topology is requested' do
+      let(:options) do
+        {connect: :load_balanced, replica_set: nil}
+      end
+
+      it 'creates the client successfully' do
+        client.should be_a(Mongo::Client)
+      end
+
+      it 'fails all operations' do
+        lambda do
+          client.command(ping: true)
+        end.should raise_error(Mongo::Error::BadLoadBalancerTarget)
+      end
+    end
+  end
+
+  context 'when in load-balanced mode' do
+    require_topology :load_balanced
+
+    let(:client) do
+      ClientRegistry.instance.new_local_client(
+        [SpecConfig.instance.addresses.first],
+        SpecConfig.instance.test_options.merge(options),
+      )
+    end
+
+    context 'when load-balanced topology is requested via the URI option' do
+      let(:options) do
+        {connect: nil, load_balanced: true}
+      end
+
+      it 'creates the client successfully' do
+        client.should be_a(Mongo::Client)
+      end
+
+      it 'fails all operations' do
+        lambda do
+          client.command(ping: true)
+        end.should raise_error(Mongo::Error::MissingServiceId)
+      end
+    end
+  end
 end

data/spec/integration/client_side_encryption/auto_encryption_bulk_writes_spec.rb

@@ -11,7 +11,7 @@ describe 'Bulk writes with auto-encryption enabled' do
   include_context 'define shared FLE helpers'
   include_context 'with local kms_providers'
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
 
   let(:client) do
     new_local_client(

data/spec/integration/client_side_encryption/auto_encryption_command_monitoring_spec.rb

@@ -15,7 +15,7 @@ describe 'Auto Encryption' do
   include_context 'define shared FLE helpers'
   include_context 'with local kms_providers'
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
   let(:db_name) { 'auto_encryption' }
 
   let(:encryption_client) do

data/spec/integration/client_side_encryption/bson_size_limit_spec.rb

@@ -11,7 +11,7 @@ describe 'Client-Side Encryption' do
 
     include_context 'define shared FLE helpers'
 
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:client) do
       authorized_client.use('db')

data/spec/integration/client_side_encryption/data_key_spec.rb

@@ -11,7 +11,7 @@ describe 'Client-Side Encryption' do
 
     include_context 'define shared FLE helpers'
 
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:client) do
       new_local_client(

data/spec/integration/client_spec.rb

@@ -21,6 +21,8 @@ describe 'Client' do
     end
 
     context 'after all servers are marked unknown' do
+      require_topology :single, :replica_set, :sharded
+
       before do
         client.cluster.servers.each do |server|
           server.unknown!

data/spec/integration/command_monitoring_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 
 describe 'Command monitoring' do
 
-  let(:subscriber) { EventSubscriber.new }
+  let(:subscriber) { Mrss::EventSubscriber.new }
 
   let(:client) do
     authorized_client.with(app_name: 'command monitoring spec').tap do |client|