mongo 2.3.1 → 2.4.0.rc0

data/lib/mongo/server/connection.rb

@@ -43,7 +43,8 @@ module Mongo
                      :features,
                      :max_bson_object_size,
                      :max_message_size,
-                     :mongos?
+                     :mongos?,
+                     :app_metadata
 
       # Tell the underlying socket to establish a connection to the host.
       #
@@ -60,6 +61,7 @@ module Mongo
         unless socket && socket.connectable?
           @socket = address.socket(timeout, ssl_options)
           socket.connect!
+          handshake!
           authenticate!
         end
         true
@@ -79,6 +81,7 @@ module Mongo
       def disconnect!
         if socket
           socket.close
+          @auth_mechanism = nil
           @socket = nil
         end
         true
@@ -130,6 +133,7 @@ module Mongo
         @server = server
         @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
         @socket = nil
+        @auth_mechanism = nil
         @pid = Process.pid
       end
 
@@ -159,6 +163,17 @@ module Mongo
         messages.last.replyable? ? read(messages.last.request_id) : nil
       end
 
+      def handshake!
+        if socket && socket.connectable?
+          socket.write(app_metadata.ismaster_bytes)
+          response = Protocol::Reply.deserialize(socket, max_message_size).documents[0]
+          min_wire_version = response[Description::MIN_WIRE_VERSION] || Description::LEGACY_WIRE_VERSION
+          max_wire_version = response[Description::MAX_WIRE_VERSION] || Description::LEGACY_WIRE_VERSION
+          features = Description::Features.new(min_wire_version..max_wire_version)
+          @auth_mechanism = (features.scram_sha_1_enabled? || @server.features.scram_sha_1_enabled?) ? :scram : :mongodb_cr
+        end
+      end
+
       def authenticate!
         if options[:user]
           user = Auth::User.new(Options::Redacted.new(:auth_mech => default_mechanism).merge(options))
@@ -169,16 +184,7 @@ module Mongo
       end
 
       def default_mechanism
-        if socket && socket.connectable?
-          socket.write(Monitor::Connection::ISMASTER_BYTES)
-          ismaster = Protocol::Reply.deserialize(socket, max_message_size).documents[0]
-          min_wire_version = ismaster[Description::MIN_WIRE_VERSION] || Description::LEGACY_WIRE_VERSION
-          max_wire_version = ismaster[Description::MAX_WIRE_VERSION] || Description::LEGACY_WIRE_VERSION
-          features = Description::Features.new(min_wire_version..max_wire_version)
-          (features.scram_sha_1_enabled? || @server.features.scram_sha_1_enabled?) ? :scram : :mongodb_cr
-        else
-          @server.features.scram_sha_1_enabled? ? :scram : :mongodb_cr
-        end
+        @auth_mechanism || (@server.features.scram_sha_1_enabled? ? :scram : :mongodb_cr)
       end
 
       def write(messages, buffer = BSON::ByteBuffer.new)

data/lib/mongo/server/description.rb

@@ -84,6 +84,16 @@ module Mongo
       # @since 2.0.0
       MAX_WRITE_BATCH_SIZE = 'maxWriteBatchSize'.freeze
 
+      # Constant for the lastWrite subdocument.
+      #
+      # @since 2.4.0
+      LAST_WRITE = 'lastWrite'.freeze
+
+      # Constant for the lastWriteDate field in the lastWrite subdocument.
+      #
+      # @since 2.4.0
+      LAST_WRITE_DATE = 'lastWriteDate'.freeze
+
       # Constant for reading the me field.
       #
       # @since 2.1.0
@@ -360,6 +370,18 @@ module Mongo
         config[SET_VERSION]
       end
 
+      # Get the lastWriteDate from the lastWrite subdocument in the config.
+      #
+      # @example Get the lastWriteDate value.
+      #   description.last_write_date
+      #
+      # @return [ Time ] The last write date.
+      #
+      # @since 2.4.0
+      def last_write_date
+        config[LAST_WRITE][LAST_WRITE_DATE] if config[LAST_WRITE]
+      end
+
       # Is the server a mongos?
       #
       # @example Is the server a mongos?

data/lib/mongo/server/description/features.rb

@@ -25,6 +25,8 @@ module Mongo
         #
         # @since 2.0.0
         MAPPINGS = {
+          :collation => 5,
+          :max_staleness => 5,
           :find_command => 4,
           :list_collections => 3,
           :list_indexes => 3,

data/lib/mongo/server/monitor.rb

@@ -53,6 +53,11 @@ module Mongo
       # @return [ Hash ] options The server options.
       attr_reader :options
 
+      # @return [ Time ] last_scan The time of the last server scan.
+      #
+      # @since 2.4.0
+      attr_reader :last_scan
+
       # Force the monitor to immediately do a check of its server.
       #
       # @example Force a scan.

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

@@ -75,6 +75,7 @@ module Mongo
           unless socket && socket.connectable?
             @socket = address.socket(timeout, ssl_options)
             socket.connect!
+            handshake!
           end
           true
         end
@@ -115,6 +116,7 @@ module Mongo
         def initialize(address, options = {})
           @address = address
           @options = options.freeze
+          @app_metadata = options[:app_metadata]
           @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
           @socket = nil
           @pid = Process.pid
@@ -131,6 +133,15 @@ module Mongo
         def timeout
           @timeout ||= options[:connect_timeout] || CONNECT_TIMEOUT
         end
+
+        private
+
+        def handshake!
+          if @app_metadata
+            socket.write(@app_metadata.ismaster_bytes)
+            Protocol::Reply.deserialize(socket, Mongo::Protocol::Message::MAX_MESSAGE_SIZE).documents[0]
+          end
+        end
       end
     end
   end

data/lib/mongo/server_selector/nearest.rb

@@ -67,6 +67,7 @@ module Mongo
       def to_mongos
         preference = { :mode => 'nearest' }
         preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
         preference
       end
 
@@ -76,18 +77,20 @@ module Mongo
       #   local threshold between the nearest server and other servers.
       #
       # @example Select nearest servers given a list of candidates.
-      #   preference = Mongo::Serverreference::Nearest.new
+      #   preference = Mongo::ServerSelector::Nearest.new
       #   preference.select_server(cluster)
       #
       # @return [ Array ] The nearest servers from the list of candidates.
       #
       # @since 2.0.0
       def select(candidates)
-        if tag_sets.empty?
-          near_servers(candidates)
-        else
-          near_servers(match_tag_sets(candidates))
-        end
+        matching_servers = filter_stale_servers(candidates, primary(candidates).first)
+        matching_servers = match_tag_sets(matching_servers) unless tag_sets.empty?
+        near_servers(matching_servers)
+      end
+
+      def max_staleness_allowed?
+        true
       end
     end
   end

data/lib/mongo/server_selector/primary.rb

@@ -83,6 +83,10 @@ module Mongo
       def select(candidates)
         primary(candidates)
       end
+
+      def max_staleness_allowed?
+        false
+      end
     end
   end
 end

data/lib/mongo/server_selector/primary_preferred.rb

@@ -68,6 +68,7 @@ module Mongo
       def to_mongos
         preference = { :mode => 'primaryPreferred' }
         preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
         preference
       end
 
@@ -87,7 +88,12 @@ module Mongo
       # @since 2.0.0
       def select(candidates)
         primary = primary(candidates)
-        primary.first ? primary : near_servers(secondaries(candidates))
+        secondaries = near_servers(secondaries(candidates))
+        primary.first ? primary : secondaries
+      end
+
+      def max_staleness_allowed?
+        true
       end
     end
   end

data/lib/mongo/server_selector/secondary.rb

@@ -68,6 +68,7 @@ module Mongo
       def to_mongos
         preference = { :mode => 'secondary' }
         preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
         preference
       end
 
@@ -86,6 +87,10 @@ module Mongo
       def select(candidates)
         near_servers(secondaries(candidates))
       end
+
+      def max_staleness_allowed?
+        true
+      end
     end
   end
 end

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -68,9 +68,10 @@ module Mongo
       #
       # @since 2.0.0
       def to_mongos
-        return nil if tag_sets.empty?
+        return nil if tag_sets.empty? && max_staleness.nil?
         preference = { mode: 'secondaryPreferred' }
-        preference.merge!({ tags: tag_sets })
+        preference.merge!({ tags: tag_sets }) unless tag_sets.empty?
+        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
         preference
       end
 
@@ -91,6 +92,10 @@ module Mongo
       def select(candidates)
         near_servers(secondaries(candidates)) + primary(candidates)
       end
+
+      def max_staleness_allowed?
+        true
+      end
     end
   end
 end

data/lib/mongo/server_selector/selectable.rb

@@ -26,6 +26,12 @@ module Mongo
       # @return [ Array ] tag_sets The tag sets used to select servers.
       attr_reader :tag_sets
 
+      # @return [ Float ] max_staleness The maximum replication lag, in seconds, that a
+      #   secondary can suffer and still be eligible for a read.
+      #
+      # @since 2.4.0
+      attr_reader :max_staleness
+
       # Check equality of two server selector.
       #
       # @example Check server selector equality.
@@ -38,7 +44,8 @@ module Mongo
       # @since 2.0.0
       def ==(other)
         name == other.name &&
-          tag_sets == other.tag_sets
+          tag_sets == other.tag_sets &&
+            max_staleness == other.max_staleness
       end
 
       # Initialize the server selector.
@@ -60,9 +67,9 @@ module Mongo
       # @since 2.0.0
       def initialize(options = {})
         @options = (options || {}).freeze
-        tag_sets = options[:tag_sets] || []
-        validate_tag_sets!(tag_sets)
-        @tag_sets = tag_sets.freeze
+        @tag_sets = (options[:tag_sets] || []).freeze
+        @max_staleness = options[:max_staleness] if options[:max_staleness] && options[:max_staleness] > 0
+        validate!
       end
 
       # Inspect the server selector.
@@ -74,7 +81,7 @@ module Mongo
       #
       # @since 2.2.0
       def inspect
-        "#<#{self.class.name}:0x#{object_id} tag_sets=#{tag_sets.inspect}>"
+        "#<#{self.class.name}:0x#{object_id} tag_sets=#{tag_sets.inspect} max_staleness=#{max_staleness.inspect}>"
       end
 
       # Select a server from eligible candidates.
@@ -143,10 +150,11 @@ module Mongo
 
       def candidates(cluster)
         if cluster.single?
-          cluster.servers
+          cluster.servers.each { |server| validate_max_staleness_support!(server) }
         elsif cluster.sharded?
-          near_servers(cluster.servers)
+          near_servers(cluster.servers).each { |server| validate_max_staleness_support!(server) }
         else
+          validate_max_staleness_value!(cluster)
           select(cluster.servers)
         end
       end
@@ -175,6 +183,7 @@ module Mongo
       # @since 2.0.0
       def secondaries(candidates)
         matching_servers = candidates.select(&:secondary?)
+        matching_servers = filter_stale_servers(matching_servers, primary(candidates).first)
         matching_servers = match_tag_sets(matching_servers) unless tag_sets.empty?
         matching_servers
       end
@@ -212,9 +221,47 @@ module Mongo
         matches || []
       end
 
-      def validate_tag_sets!(tag_sets)
-        if !tag_sets.all? { |set| set.empty? } && !tags_allowed?
-          raise Error::InvalidServerPreference.new(name)
+      def filter_stale_servers(candidates, primary = nil)
+        return candidates unless @max_staleness
+        max_staleness_ms = @max_staleness * 1000
+
+        if primary
+          candidates.select do |server|
+            validate_max_staleness_support!(server)
+            staleness = (server.last_scan - server.last_write_date) -
+                        (primary.last_scan - primary.last_write_date)  +
+                        (server.heartbeat_frequency * 1000)
+            staleness <= max_staleness_ms
+          end
+        else
+          max_write_date = candidates.collect(&:last_write_date).max
+          candidates.select do |server|
+            validate_max_staleness_support!(server)
+            staleness = max_write_date - server.last_write_date + (server.heartbeat_frequency * 1000)
+            staleness <= max_staleness_ms
+          end
+        end
+      end
+
+      def validate!
+        if !@tag_sets.all? { |set| set.empty? } && !tags_allowed?
+          raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::NO_TAG_SUPPORT)
+        elsif @max_staleness && !max_staleness_allowed?
+          raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::NO_MAX_STALENESS_SUPPORT)
+        end
+      end
+
+      def validate_max_staleness_support!(server)
+        if @max_staleness && !server.features.max_staleness_enabled?
+          raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::NO_MAX_STALENESS_WITH_LEGACY_SERVER)
+        end
+      end
+
+      def validate_max_staleness_value!(cluster)
+        return unless @max_staleness
+        heartbeat_frequency = cluster.options[:heartbeat_frequency] || Server::Monitor::HEARTBEAT_FREQUENCY
+        if @max_staleness < heartbeat_frequency * 2
+          raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::INVALID_MAX_STALENESS)
         end
       end
     end

data/lib/mongo/socket/ssl.rb

@@ -56,6 +56,7 @@ module Mongo
         Timeout.timeout(timeout, Error::SocketTimeoutError) do
           handle_errors { @tcp_socket.connect(::Socket.pack_sockaddr_in(port, host)) }
           @socket = OpenSSL::SSL::SSLSocket.new(@tcp_socket, context)
+          @socket.hostname = @host_name unless BSON::Environment.jruby?
           @socket.sync_close = true
           handle_errors { @socket.connect }
           verify_certificate!(@socket)

data/lib/mongo/uri.rb

@@ -374,6 +374,7 @@ module Mongo
     # Read Options
     uri_option 'readpreference', :mode, :group => :read, :type => :read_mode
     uri_option 'readpreferencetags', :tag_sets, :group => :read, :type => :read_tags
+    uri_option 'maxstalenessms', :max_staleness, :group => :read, :type => :ms_convert
 
     # Pool options
     uri_option 'minpoolsize', :min_pool_size
@@ -391,6 +392,9 @@ module Mongo
     uri_option 'authmechanism', :auth_mech, :type => :auth_mech
     uri_option 'authmechanismproperties', :auth_mech_properties, :type => :auth_mech_props
 
+    # Client Options
+    uri_option 'appname', :app_name
+
     # Casts option values that do not have a specifically provided
     # transformation to the appropriate type.
     #

data/lib/mongo/version.rb

@@ -17,5 +17,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.3.1'.freeze
+  VERSION = '2.4.0.rc0'.freeze
 end

data/lib/mongo/write_concern.rb

@@ -76,6 +76,7 @@ module Mongo
     #
     # @since 2.0.0
     def get(options)
+      return options if options.is_a?(Unacknowledged) || options.is_a?(Acknowledged)
       if options
         validate!(options)
         if unacknowledged?(options)

data/mongo.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |s|
   s.has_rdoc          = 'yard'
   s.bindir            = 'bin'
 
-  s.add_dependency 'bson', '~> 4.1'
+  s.add_dependency 'bson', '~> 4.2.0.rc0'
 end

data/spec/mongo/auth/cr_spec.rb

@@ -14,8 +14,14 @@ describe Mongo::Auth::CR do
     Mongo::Event::Listeners.new
   end
 
+  let(:cluster) do
+    double('cluster').tap do |cl|
+      allow(cl).to receive(:app_metadata).and_return(app_metadata)
+    end
+  end
+
   let(:server) do
-    Mongo::Server.new(address, double('cluster'), monitoring, listeners, TEST_OPTIONS)
+    Mongo::Server.new(address, cluster, monitoring, listeners, TEST_OPTIONS)
   end
 
   let(:connection) do