mongo 2.5.0.beta → 2.5.0

data/lib/mongo/server/description.rb

@@ -124,6 +124,11 @@ module Mongo
       # @since 2.0.0
       PRIMARY = 'ismaster'.freeze
 
+      # Constant for reading primary host field from config.
+      #
+      # @since 2.5.0
+      PRIMARY_HOST = 'primary'.freeze
+
       # Constant for reading secondary info from config.
       #
       # @since 2.0.0
@@ -169,7 +174,8 @@ module Mongo
       # @since 2.0.6
       EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME,
                                  LAST_WRITE,
-                                 OPERATION_TIME ].freeze
+                                 OPERATION_TIME,
+                                 Operation::CLUSTER_TIME ].freeze
 
       # @return [ Address ] address The server's address.
       attr_reader :address
@@ -258,7 +264,7 @@ module Mongo
       def initialize(address, config = {}, average_round_trip_time = 0)
         @address = address
         @config = config
-        @features = Features.new(wire_versions)
+        @features = Features.new(wire_versions, me)
         @average_round_trip_time = average_round_trip_time
       end
 
@@ -464,7 +470,9 @@ module Mongo
       #
       # @since 2.0.0
       def primary?
-        !!config[PRIMARY] && !replica_set_name.nil?
+        !!config[PRIMARY] &&
+          (config[PRIMARY_HOST].nil? || config[PRIMARY_HOST] == address.to_s) &&
+            !replica_set_name.nil?
       end
 
       # Get the name of the replica set the server belongs to, returns nil if

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

@@ -38,10 +38,22 @@ module Mongo
           :users_info => 2
         }.freeze
 
+        # Error message if the server is too old for this version of the driver.
+        #
+        # @since 2.5.0
+        SERVER_TOO_OLD = "Server at (%s) reports wire version (%s), but this version of the Ruby driver " +
+                           "requires at least (%s)."
+
+        # Error message if the driver is too old for the version of the server.
+        #
+        # @since 2.5.0
+        DRIVER_TOO_OLD = "Server at (%s) requires wire version (%s), but this version of the Ruby driver " +
+                           "only supports up to (%s)."
+
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (0..6).freeze
+        DRIVER_WIRE_VERSIONS = (2..6).freeze
 
         # Create the methods for each mapping to tell if they are supported.
         #
@@ -74,17 +86,24 @@ module Mongo
         #   versions.
         #
         # @since 2.0.0
-        def initialize(server_wire_versions)
+        def initialize(server_wire_versions, address = nil)
           @server_wire_versions = server_wire_versions
-          check_driver_support!
+          check_driver_support!(address) unless server_wire_versions == ZERO_RANGE
         end
 
         private
 
-        def check_driver_support!
-          if DRIVER_WIRE_VERSIONS.max < server_wire_versions.min ||
-             DRIVER_WIRE_VERSIONS.min > server_wire_versions.max
-            raise Error::UnsupportedFeatures.new(server_wire_versions)
+        ZERO_RANGE = (0..0).freeze
+
+        def check_driver_support!(address)
+          if DRIVER_WIRE_VERSIONS.min > server_wire_versions.max
+            raise Error::UnsupportedFeatures.new(SERVER_TOO_OLD % [address,
+                                                                   server_wire_versions.max,
+                                                                   DRIVER_WIRE_VERSIONS.min])
+          elsif DRIVER_WIRE_VERSIONS.max < server_wire_versions.min
+            raise Error::UnsupportedFeatures.new(DRIVER_TOO_OLD % [address,
+                                                                   server_wire_versions.min,
+                                                                   DRIVER_WIRE_VERSIONS.max])
           end
         end
       end

data/lib/mongo/session.rb

@@ -34,13 +34,23 @@ module Mongo
     # @since 2.5.0
     attr_reader :client
 
-    def_delegators :@server_session, :session_id
+    # The cluster time for this session.
+    #
+    # @since 2.5.0
+    attr_reader :cluster_time
+
+    # The latest seen operation time for this session.
+    #
+    # @since 2.5.0
+    attr_reader :operation_time
+
+    def_delegators :client, :cluster
 
     # Error message describing that the session was attempted to be used by a client different from the
     # one it was originally associated with.
     #
     # @since 2.5.0
-    MISTMATCHED_CLUSTER_ERROR_MSG = 'The client used to create this session does not match that of client ' +
+    MISMATCHED_CLUSTER_ERROR_MSG = 'The client used to create this session does not match that of client ' +
         'initiating this operation. Please only use this session for operations through its parent client.'.freeze
 
     # Error message describing that the session cannot be used because it has already been ended.
@@ -66,7 +76,20 @@ module Mongo
     def initialize(server_session, client, options = {})
       @server_session = server_session
       @client = client
-      @options = options
+      @options = options.dup.freeze
+      @cluster_time = nil
+    end
+
+    # Get a formatted string for use in inspection.
+    #
+    # @example Inspect the session object.
+    #   session.inspect
+    #
+    # @return [ String ] The session inspection.
+    #
+    # @since 2.5.0
+    def inspect
+      "#<Mongo::Session:0x#{object_id} session_id=#{session_id} options=#{@options}>"
     end
 
     # End this session.
@@ -144,19 +167,113 @@ module Mongo
     # @example Process a response from the server.
     #   session.process(result)
     #
-    # @param [ Operation::Result ] The result from the operation.
+    # @param [ Operation::Result ] result The result from the operation.
     #
     # @return [ Operation::Result ] The result.
     #
     # @since 2.5.0
     def process(result)
-      set_operation_time(result)
+      unless implicit_session?
+        set_operation_time(result)
+        set_cluster_time(result)
+      end
       @server_session.set_last_use!
       result
     end
 
+    # Advance the cached cluster time document for this session.
+    #
+    # @example Advance the cluster time.
+    #   session.advance_cluster_time(doc)
+    #
+    # @param [ BSON::Document, Hash ] new_cluster_time The new cluster time.
+    #
+    # @return [ BSON::Document, Hash ] The new cluster time.
+    #
+    # @since 2.5.0
+    def advance_cluster_time(new_cluster_time)
+      if @cluster_time
+        @cluster_time = [ @cluster_time, new_cluster_time ].max_by { |doc| doc[Cluster::CLUSTER_TIME] }
+      else
+        @cluster_time = new_cluster_time
+      end
+    end
+
+    # Advance the cached operation time for this session.
+    #
+    # @example Advance the operation time.
+    #   session.advance_operation_time(timestamp)
+    #
+    # @param [ BSON::Timestamp ] new_operation_time The new operation time.
+    #
+    # @return [ BSON::Timestamp ] The max operation time, considering the current and new times.
+    #
+    # @since 2.5.0
+    def advance_operation_time(new_operation_time)
+      if @operation_time
+        @operation_time = [ @operation_time, new_operation_time ].max
+      else
+        @operation_time = new_operation_time
+      end
+    end
+    
+    # Will writes executed with this session be retried.
+    #
+    # @example Will writes be retried.
+    #   session.retry_writes?
+    #
+    # @return [ true, false ] If writes will be retried.
+    #
+    # @note Retryable writes are only available on server versions at least 3.6 and with
+    #   sharded clusters or replica sets.
+    #
+    # @since 2.5.0
+    def retry_writes?
+      !!client.options[:retry_writes] && (cluster.replica_set? || cluster.sharded?)
+    end
+
+    # Get the session id.
+    #
+    # @example Get the session id.
+    #   session.session_id
+    #
+    # @return [ BSON::Document ] The session id.
+    #
+    # @since 2.5.0
+    def session_id
+      @server_session.session_id if @server_session
+    end
+
+    # Increment and return the next transaction number.
+    #
+    # @example Get the next transaction number.
+    #   server_session.next_txn_num
+    #
+    # @return [ Integer ] The next transaction number.
+    #
+    # @since 2.5.0
+    def next_txn_num
+      @server_session.next_txn_num if @server_session
+    end
+
     private
 
+    def causal_consistency_doc(read_concern)
+      if operation_time && causal_consistency?
+        (read_concern || {}).merge(:afterClusterTime => operation_time)
+      else
+        read_concern
+      end
+    end
+
+    def causal_consistency?
+      @causal_consistency ||= (if @options.key?(:causal_consistency)
+                                 @options[:causal_consistency] == true
+                               else
+                                 true
+                               end)
+    end
+
     def implicit_session?
       @implicit_session ||= !!(@options.key?(:implicit) && @options[:implicit] == true)
     end
@@ -167,13 +284,23 @@ module Mongo
       end
     end
 
+    def set_cluster_time(result)
+      if cluster_time_doc = result.cluster_time
+        if @cluster_time.nil?
+          @cluster_time = cluster_time_doc
+        elsif cluster_time_doc[Cluster::CLUSTER_TIME] > @cluster_time[Cluster::CLUSTER_TIME]
+          @cluster_time = cluster_time_doc
+        end
+      end
+    end
+
     def check_if_ended!
       raise Mongo::Error::InvalidSession.new(SESSION_ENDED_ERROR_MSG) if ended?
     end
 
     def check_matching_client!(client)
       if @client != client
-        raise Mongo::Error::InvalidSession.new(MISTMATCHED_CLUSTER_ERROR_MSG)
+        raise Mongo::Error::InvalidSession.new(MISMATCHED_CLUSTER_ERROR_MSG)
       end
     end
   end

data/lib/mongo/session/server_session.rb

@@ -46,6 +46,8 @@ module Mongo
       # @since 2.5.0
       def initialize
         set_last_use!
+        session_id
+        @txn_num = -1
       end
 
       # Update the last_use attribute of the server session to now.
@@ -53,6 +55,8 @@ module Mongo
       # @example Set the last use field to now.
       #   server_session.set_last_use!
       #
+      # @return [ Time ] The last time the session was used.
+      #
       # @since 2.5.0
       def set_last_use!
         @last_use = Time.now
@@ -63,11 +67,37 @@ module Mongo
       # @example Get the session id.
       #   server_session.session_id
       #
+      # @return [ BSON::Document ] The session id.
+      #
       # @since 2.5.0
       def session_id
         @session_id ||= (bytes = [SecureRandom.uuid.gsub(DASH_REGEX, '')].pack(UUID_PACK)
                           BSON::Document.new(id: BSON::Binary.new(bytes, :uuid)))
       end
+
+      # Increment and return the next transaction number.
+      #
+      # @example Get the next transaction number.
+      #   server_session.next_txn_num
+      #
+      # @return [ Integer ] The next transaction number.
+      #
+      # @since 2.5.0
+      def next_txn_num
+        @txn_num += 1
+      end
+
+      # Get a formatted string for use in inspection.
+      #
+      # @example Inspect the session object.
+      #   session.inspect
+      #
+      # @return [ String ] The session inspection.
+      #
+      # @since 2.5.0
+      def inspect
+        "#<Mongo::Session::ServerSession:0x#{object_id} session_id=#{session_id} last_use=#{@last_use}>"
+      end
     end
   end
 end

data/lib/mongo/session/session_pool.rb

@@ -23,11 +23,6 @@ module Mongo
     # @since 2.5.0
     class SessionPool
 
-      # The command sent to the server to end a session.
-      #
-      # @since 2.5.0
-      END_SESSION = { :endSessions => 1 }.freeze
-
       # Create a SessionPool.
       #
       # @example
@@ -57,6 +52,18 @@ module Mongo
         @client = client
       end
 
+      # Get a formatted string for use in inspection.
+      #
+      # @example Inspect the session pool object.
+      #   session_pool.inspect
+      #
+      # @return [ String ] The session pool inspection.
+      #
+      # @since 2.5.0
+      def inspect
+        "#<Mongo::Session::SessionPool:0x#{object_id} current_size=#{@queue.size}>"
+      end
+
       # Checkout a session to be used in the context of a block and return the session back to
       #   the pool after the block completes.
       #
@@ -70,8 +77,7 @@ module Mongo
       # @since 2.5.0
       def with_session
         server_session = checkout
-        result = yield(server_session)
-        result
+        yield(server_session)
       ensure
         begin; checkin(server_session) if server_session; rescue; end
       end
@@ -104,7 +110,7 @@ module Mongo
       # @example Checkin a session.
       #   pool.checkin(session)
       #
-      # @param [ Session::ServerSession ] The session to checkin.
+      # @param [ Session::ServerSession ] session The session to checkin.
       #
       # @since 2.5.0
       def checkin(session)
@@ -123,19 +129,13 @@ module Mongo
       #
       # @since 2.5.0
       def end_sessions
-        if @client
-          ids = @queue.collect { |s| s.session_id }
-
-          while !ids.empty?
-            begin
-              Operation::Commands::Command.new({
-                                                 :selector => END_SESSION.merge(ids: ids.shift(10_000)),
-                                                 :db_name => Database::ADMIN
-                                               }).execute(@client.cluster.next_primary)
-            rescue
-            end
-          end
+        while !@queue.empty?
+          server = ServerSelector.get(mode: :primary_preferred).select_server(@client.cluster)
+          Operation::Commands::Command.new(
+              :selector => {endSessions: @queue.shift(10_000).collect { |s| s.session_id }},
+              :db_name => Database::ADMIN).execute(server)
         end
+      rescue
       end
 
       private

data/lib/mongo/uri.rb

@@ -22,8 +22,8 @@ module Mongo
   # http://docs.mongodb.org/manual/reference/connection-string/
   #
   # @example Use the uri string to make a client connection.
-  #   uri = URI.new('mongodb://localhost:27017')
-  #   client = Client.new(uri.server, uri.options)
+  #   uri = Mongo::URI.new('mongodb://localhost:27017')
+  #   client = Mongo::Client.new(uri.servers, uri.options)
   #   client.login(uri.credentials)
   #   client[uri.database]
   #
@@ -46,6 +46,39 @@ module Mongo
     # @since 2.0.0
     attr_reader :servers
 
+    # The mongodb connection string scheme.
+    #
+    # @deprecated Will be removed in 3.0.
+    #
+    # @since 2.0.0
+    SCHEME = 'mongodb://'.freeze
+
+    # The mongodb connection string scheme root.
+    #
+    # @since 2.5.0
+    MONGODB_SCHEME = 'mongodb'.freeze
+
+    # The mongodb srv protocol connection string scheme root.
+    #
+    # @since 2.5.0
+    MONGODB_SRV_SCHEME = 'mongodb+srv'.freeze
+
+    # Error details for an invalid scheme.
+    #
+    # @since 2.1.0
+    INVALID_SCHEME = "Invalid scheme. Scheme must be '#{MONGODB_SCHEME}' or '#{MONGODB_SRV_SCHEME}'".freeze
+
+    # MongoDB URI format specification.
+    #
+    # @since 2.0.0
+    FORMAT = 'mongodb://[username:password@]host1[:port1][,host2[:port2]' +
+        ',...[,hostN[:portN]]][/[database][?options]]'.freeze
+
+    # MongoDB URI (connection string) documentation url
+    #
+    # @since 2.0.0
+    HELP = 'http://docs.mongodb.org/manual/reference/connection-string/'.freeze
+
     # Unsafe characters that must be urlencoded.
     #
     # @since 2.1.0
@@ -56,11 +89,6 @@ module Mongo
     # @since 2.1.0
     UNIX_SOCKET = /.sock/
 
-    # The mongodb connection string scheme.
-    #
-    # @since 2.0.0
-    SCHEME = 'mongodb://'.freeze
-
     # The character delimiting hosts.
     #
     # @since 2.1.0
@@ -101,10 +129,10 @@ module Mongo
     # @since 2.1.0
     AUTH_DELIM = '@'.freeze
 
-    # Error details for an invalid scheme.
+    # Scheme delimiter.
     #
-    # @since 2.1.0
-    INVALID_SCHEME = "Invalid scheme. Scheme must be '#{SCHEME}'".freeze
+    # @since 2.5.0
+    SCHEME_DELIM = '://'.freeze
 
     # Error details for an invalid options format.
     #
@@ -142,17 +170,6 @@ module Mongo
     # @since 2.1.0
     INVALID_PORT = "Invalid port. Port must be an integer greater than 0 and less than 65536".freeze
 
-    # MongoDB URI format specification.
-    #
-    # @since 2.0.0
-    FORMAT = 'mongodb://[username:password@]host1[:port1][,host2[:port2]' +
-      ',...[,hostN[:portN]]][/[database][?options]]'.freeze
-
-    # MongoDB URI (connection string) documentation url
-    #
-    # @since 2.0.0
-    HELP = 'http://docs.mongodb.org/manual/reference/connection-string/'.freeze
-
     # Map of URI read preference modes to ruby driver read preference modes
     #
     # @since 2.0.0
@@ -180,23 +197,24 @@ module Mongo
     # @since 2.1.0
     REPEATABLE_OPTIONS = [ :tag_sets ]
 
-    # Create the new uri from the provided string.
+    # Get either a URI object or a SRVProtocol URI object.
     #
-    # @example Create the new URI.
-    #   URI.new('mongodb://localhost:27017')
+    # @example Get the uri object.
+    #   URI.get(string)
     #
-    # @param [ String ] string The uri string.
-    # @param [ Hash ] options The options.
-    #
-    # @raise [ Error::InvalidURI ] If the uri does not match the spec.
+    # @return [URI, URI::SRVProtocol] The uri object.
     #
-    # @since 2.0.0
-    def initialize(string, options = {})
-      @string = string
-      @options = options
-      _, scheme, remaining = @string.partition(SCHEME)
-      raise_invalid_error!(INVALID_SCHEME) unless scheme == SCHEME
-      setup!(remaining)
+    # @since 2.5.0
+    def self.get(string, opts = {})
+      scheme, _, remaining = string.partition(SCHEME_DELIM)
+      case scheme
+        when MONGODB_SCHEME
+          URI.new(string, opts)
+        when MONGODB_SRV_SCHEME
+          SRVProtocol.new(string, opts)
+        else
+          raise Error::InvalidURI.new(string, INVALID_SCHEME)
+      end
     end
 
     # Gets the options hash that needs to be passed to a Mongo::Client on
@@ -214,6 +232,25 @@ module Mongo
       @user ? opts.merge(credentials) : opts
     end
 
+    # Create the new uri from the provided string.
+    #
+    # @example Create the new URI.
+    #   URI.new('mongodb://localhost:27017')
+    #
+    # @param [ String ] string The uri string.
+    # @param [ Hash ] options The options.
+    #
+    # @raise [ Error::InvalidURI ] If the uri does not match the spec.
+    #
+    # @since 2.0.0
+    def initialize(string, options = {})
+      @string = string
+      @options = options
+      parsed_scheme, _, remaining = string.partition(SCHEME_DELIM)
+      raise_invalid_error!(INVALID_SCHEME) unless parsed_scheme == scheme
+      parse!(remaining)
+    end
+
     # Get the credentials provided in the URI.
     #
     # @example Get the credentials.
@@ -242,7 +279,18 @@ module Mongo
 
     private
 
-    def setup!(remaining)
+    def scheme
+      MONGODB_SCHEME
+    end
+
+    def parse_creds_hosts!(string)
+      hosts, creds = split_creds_hosts(string)
+      @servers = parse_servers!(hosts)
+      @user = parse_user!(creds)
+      @password = parse_password!(creds)
+    end
+
+    def parse!(remaining)
       creds_hosts, db_opts = extract_db_opts!(remaining)
       parse_creds_hosts!(creds_hosts)
       parse_db_opts!(db_opts)
@@ -257,13 +305,6 @@ module Mongo
       [ creds_hosts, db_opts ].map { |s| s.reverse }
     end
 
-    def parse_creds_hosts!(string)
-      hosts, creds = split_creds_hosts(string)
-      @servers = parse_servers!(hosts)
-      @user = parse_user!(creds)
-      @password = parse_password!(creds)
-    end
-
     def split_creds_hosts(string)
       hosts, _, creds = string.reverse.partition(AUTH_DELIM)
       hosts, creds = creds, hosts if hosts.empty?
@@ -330,13 +371,14 @@ module Mongo
           validate_port_string!(p)
         elsif host =~ UNIX_SOCKET
           raise_invalid_error!(UNESCAPED_UNIX_SOCKET) if host =~ UNSAFE
+          host = decode(host)
         end
         servers << host
       end
     end
 
     def raise_invalid_error!(details)
-      raise Error::InvalidURI.new(@string, details)
+      raise Error::InvalidURI.new(@string, details, FORMAT)
     end
 
     def decode(value)
@@ -585,3 +627,5 @@ module Mongo
     end
   end
 end
+
+require 'mongo/uri/srv_protocol'