mongo 2.8.0 → 2.9.0.rc0

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

@@ -179,10 +179,13 @@ module Mongo
         # @note This method mutates the connection by setting the socket to nil
         #   if the closing succeeded.
         #
+        # @note This method accepts an options argument for compatibility with
+        #   Server::Connections. However, all options are ignored.
+        #
         # @return [ true ] If the disconnect succeeded.
         #
         # @since 2.0.0
-        def disconnect!
+        def disconnect!(options = nil)
           if socket
             socket.close
             @socket = nil

data/lib/mongo/session.rb

@@ -443,6 +443,26 @@ module Mongo
       end
     end
 
+    # Whether reads executed with this session can be retried according to
+    # the modern retryable reads specification.
+    #
+    # If this method returns true, the modern retryable reads have been
+    # requested by the application. If the server selected for a read operation
+    # supports modern retryable reads, they will be used for that particular
+    # operation. If the server selected for a read operation does not support
+    # modern retryable reads, the read will not be retried.
+    #
+    # If this method returns false, legacy retryable reads have been requested
+    # by the application. Legacy retryable read logic will be used regardless
+    # of server version of the server(s) that the client is connected to.
+    # The number of read retries is given by :max_read_retries client option,
+    # which is 1 by default and can be set to 0 to disable legacy read retries.
+    #
+    # @api private
+    def retry_reads?
+      client.options[:retry_reads] != false
+    end
+
     # Will writes executed with this session be retried.
     #
     # @example Will writes be retried.
@@ -874,6 +894,23 @@ module Mongo
       @client.cluster
     end
 
+		protected
+
+    # Get the read concern the session will use when starting a transaction.
+    #
+    # This is a driver style hash with underscore keys.
+    #
+    # @example Get the session's transaction read concern.
+    #   session.txn_read_concern
+    #
+    # @return [ Hash ] The read concern used for starting transactions.
+    #
+    # @since 2.9.0
+    def txn_read_concern
+      # Read concern is inherited from client but not db or collection.
+      txn_options && txn_options[:read_concern] || @client.read_concern
+    end
+
     private
 
     def within_states?(*states)
@@ -891,11 +928,6 @@ module Mongo
         Mongo::Error::InvalidTransactionOperation::NO_TRANSACTION_STARTED)
     end
 
-    def txn_read_concern
-      # Read concern is inherited from client but not db or collection.
-      txn_options && txn_options[:read_concern] || @client.read_concern
-    end
-
     def txn_write_concern
       (txn_options && txn_options[:write_concern]) ||
         (@client.write_concern && @client.write_concern.options)

data/lib/mongo/session/session_pool.rb

@@ -64,9 +64,9 @@ module Mongo
         "#<Mongo::Session::SessionPool:0x#{object_id} current_size=#{@queue.size}>"
       end
 
-      # Checkout a server session from the pool.
+      # Check out a server session from the pool.
       #
-      # @example Checkout a session.
+      # @example Check out a session.
       #   pool.checkout
       #
       # @return [ ServerSession ] The server session.

data/lib/mongo/socket.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'socket'
-require 'timeout'
 require 'mongo/socket/ssl'
 require 'mongo/socket/tcp'
 require 'mongo/socket/unix'

data/lib/mongo/socket/ssl.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'openssl'
-
 module Mongo
   class Socket
 

data/lib/mongo/uri.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'uri'
-
 module Mongo
 
   # The URI class provides a way for users to parse the MongoDB uri as
@@ -260,6 +258,9 @@ module Mongo
       @options = options
       parsed_scheme, _, remaining = string.partition(SCHEME_DELIM)
       raise_invalid_error!(INVALID_SCHEME) unless parsed_scheme == scheme
+      if remaining.empty?
+        raise_invalid_error!('No hosts in the URI')
+      end
       parse!(remaining)
 
       # The URI options spec requires that we raise an error if there are conflicting values of
@@ -283,6 +284,12 @@ module Mongo
           raise_invalid_error_no_fmt!("tlsInsecure' and 'tlsAllowInvalidHostnames' cannot both be specified")
         end
       end
+
+      # Since we know that the only URI option that sets :ssl_cert is "tlsCertificateKeyFile", any
+      # value set for :ssl_cert must also be set for :ssl_key.
+      if @uri_options[:ssl_cert]
+        @uri_options[:ssl_key] = @uri_options[:ssl_cert]
+      end
     end
 
     # Get the credentials provided in the URI.
@@ -317,17 +324,38 @@ module Mongo
       MONGODB_SCHEME
     end
 
-    def parse_creds_hosts!(string)
-      hosts, creds = split_creds_hosts(string)
+    def parse!(remaining)
+      hosts_and_db, options = remaining.split('?', 2)
+      if options && options.index('?')
+        raise_invalid_error!("Options contain an unescaped question mark (?), or the database name contains a question mark and was not escaped")
+      end
+
+      if options && !hosts_and_db.index('/')
+        raise_invalid_error!("MongoDB URI must have a slash (/) after the hosts if options are given")
+      end
+
+      hosts, db = hosts_and_db.split('/', 2)
+      if db && db.index('/')
+        raise_invalid_error!("Database name contains an unescaped slash (/): #{db}")
+      end
+
+      if hosts.index('@')
+        creds, hosts = hosts.split('@', 2)
+        if hosts.empty?
+          raise_invalid_error!("Empty hosts list")
+        end
+        if hosts.index('@')
+          raise_invalid_error!("Unescaped @ in auth info")
+        end
+      end
+
       @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)
+      @uri_options = Options::Redacted.new(parse_uri_options!(options))
+      if db
+        @database = parse_database!(db)
+      end
     end
 
     def extract_db_opts!(string)
@@ -339,28 +367,23 @@ module Mongo
       [ creds_hosts, db_opts ].map { |s| s.reverse }
     end
 
-    def split_creds_hosts(string)
-      hosts, _, creds = string.reverse.partition(AUTH_DELIM)
-      hosts, creds = creds, hosts if hosts.empty?
-      [ hosts, creds ].map { |s| s.reverse }
-    end
-
-    def parse_db_opts!(string)
-      auth_db, _, uri_opts = string.partition(URI_OPTS_DELIM)
-      @uri_options = Options::Redacted.new(parse_uri_options!(uri_opts))
-      @database = parse_database!(auth_db)
-    end
-
     def parse_uri_options!(string)
       return {} unless string
       string.split(INDIV_URI_OPTS_DELIM).reduce({}) do |uri_options, opt|
-        raise_invalid_error!(INVALID_OPTS_VALUE_DELIM) unless opt.index(URI_OPTS_VALUE_DELIM)
-        key, value = opt.split(URI_OPTS_VALUE_DELIM)
+        key, value = opt.split('=', 2)
+        if value.nil?
+          raise_invalid_error!("Option #{key} has no value")
+        end
+        if value.index('=')
+          raise_invalid_error!("Value for option #{key} contains the key/value delimiter (=): #{value}")
+        end
+        key = ::URI.decode(key)
         strategy = URI_OPTION_MAP[key.downcase]
         if strategy.nil?
           log_warn("Unsupported URI option '#{key}' on URI '#{@string}'. It will be ignored.")
         else
-          add_uri_option(strategy, value, uri_options)
+          value = ::URI.decode(value)
+          add_uri_option(key, strategy, value, uri_options)
         end
         uri_options
       end
@@ -465,10 +488,10 @@ module Mongo
     uri_option 'maxidletimems', :max_idle_time, :type => :max_idle_time
 
     # Write Options
-    uri_option 'w', :w, :group => :write
+    uri_option 'w', :w, :group => :write, type: :w
     uri_option 'journal', :j, :group => :write, :type => :journal
-    uri_option 'fsync', :fsync, :group => :write
-    uri_option 'wtimeoutms', :timeout, :group => :write, :type => :wtimeout
+    uri_option 'fsync', :fsync, :group => :write, type: :bool
+    uri_option 'wtimeoutms', :wtimeout, :group => :write, :type => :wtimeout
 
     # Read Options
     uri_option 'readpreference', :mode, :group => :read, :type => :read_mode
@@ -493,7 +516,7 @@ module Mongo
     uri_option 'tlsinsecure', :ssl_verify, :type => :ssl_verify
 
     # Topology options
-    uri_option 'connect', :connect
+    uri_option 'connect', :connect, type: :symbol
 
     # Auth Options
     uri_option 'authsource', :auth_source, :type => :auth_source
@@ -503,38 +526,25 @@ module Mongo
     # Client Options
     uri_option 'appname', :app_name
     uri_option 'compressors', :compressors, :type => :array
-    uri_option 'readconcernlevel', :read_concern
+    uri_option 'readconcernlevel', :level, group: :read_concern
     uri_option 'retrywrites', :retry_writes, :type => :retry_writes
     uri_option 'zlibcompressionlevel', :zlib_compression_level, :type => :zlib_compression_level
 
-    # Casts option values that do not have a specifically provided
-    # transformation to the appropriate type.
-    #
-    # @param value [String] The value to be cast.
-    #
-    # @return [true, false, Fixnum, Symbol] The cast value.
-    def cast(value)
-      if value == 'true'
-        true
-      elsif value == 'false'
-        false
-      elsif value =~ /\A[\d]\z/
-        value.to_i
-      else
-        decode(value).to_sym
-      end
-    end
-
     # Applies URI value transformation by either using the default cast
     # or a transformation appropriate for the given type.
     #
+    # @param key [String] URI option name.
     # @param value [String] The value to be transformed.
     # @param type [Symbol] The transform method.
-    def apply_transform(value, type = nil)
+    def apply_transform(key, value, type)
       if type
-        send(type, value)
+        if respond_to?("convert_#{type}", true)
+          send("convert_#{type}", key, value)
+        else
+          send(type, value)
+        end
       else
-        cast(value)
+        value
       end
     end
 
@@ -581,12 +591,13 @@ module Mongo
     #   Transforms the value.
     #   Merges the option into the target.
     #
+    # @param key [String] URI option name.
     # @param strategy [Symbol] The strategy for this option.
     # @param value [String] The value of the option.
     # @param uri_options [Hash] The base option target.
-    def add_uri_option(strategy, value, uri_options)
+    def add_uri_option(key, strategy, value, uri_options)
       target = select_target(uri_options, strategy[:group])
-      value = apply_transform(value, strategy[:type])
+      value = apply_transform(key, value, strategy[:type])
       merge_uri_option(target, value, strategy[:name])
     end
 
@@ -656,7 +667,7 @@ module Mongo
       properties = hash_extractor('authMechanismProperties', value)
       if properties[:canonicalize_host_name]
         properties.merge!(canonicalize_host_name:
-                            properties[:canonicalize_host_name] == 'true')
+          %w(true TRUE).include?(properties[:canonicalize_host_name]))
       end
       properties
     end
@@ -718,7 +729,7 @@ module Mongo
     # @return [ true | false | nil ] The journal value parsed out, otherwise nil (and a warning
     #   will be logged).
     def journal(value)
-      bool('journal', value)
+      convert_bool('journal', value)
     end
 
     # Parses the ssl value from the URI.
@@ -728,7 +739,7 @@ module Mongo
     # @return [ Array<true | false> ] The ssl value parsed out (stored in an array to facilitate
     #   keeping track of all values).
     def ssl(value)
-      [bool('ssl', value)]
+      [convert_bool('ssl', value)]
     end
 
     # Parses the tls value from the URI.
@@ -738,7 +749,7 @@ module Mongo
     # @return [ Array<true | false> ] The tls value parsed out (stored in an array to facilitate
     #   keeping track of all values).
     def tls(value)
-      [bool('tls', value)]
+      [convert_bool('tls', value)]
     end
 
     # Parses the ssl_verify value from the tlsInsecure URI value. Note that this will be the inverse
@@ -781,20 +792,70 @@ module Mongo
     # @return [ true | false | nil ] The boolean value parsed out, otherwise nil (and a warning
     #   will be logged).
     def retry_writes(value)
-      bool('retryWrites', value)
+      convert_bool('retryWrites', value)
     end
 
-    # Parses a boolean value.
+    # Converts +value+ into an integer.
     #
-    # @param value [ String ] The URI option value.
+    # If the value is not a valid integer, warns and returns nil.
     #
-    # @return [ true | false | nil ] The boolean value parsed out, otherwise nil (and a warning
-    #   will be logged).
-    def bool(name, value)
+    # @param name [ String ] Name of the URI option being processed.
+    # @param value [ String ] URI option value.
+    #
+    # @return [ nil | Integer ] Converted value.
+    def convert_integer(name, value)
+      unless /\A\d+\z/ =~ value
+        log_warn("#{value} is not a valid integer for #{name}")
+        return nil
+      end
+
+      value.to_i
+    end
+
+    # Converts +value+ into a symbol.
+    #
+    # @param name [ String ] Name of the URI option being processed.
+    # @param value [ String ] URI option value.
+    #
+    # @return [ Symbol ] Converted value.
+    def convert_symbol(name, value)
+      value.to_sym
+    end
+
+    # Converts +value+ as a write concern.
+    #
+    # If +value+ is the word "majority", returns the symbol :majority.
+    # If +value+ is a number, returns the number as an integer.
+    # Otherwise returns the string +value+ unchanged.
+    #
+    # @param name [ String ] Name of the URI option being processed.
+    # @param value [ String ] URI option value.
+    #
+    # @return [ Integer | Symbol | String ] Converted value.
+    def convert_w(name, value)
+      case value
+      when 'majority'
+        :majority
+      when /\A[0-9]+\z/
+        value.to_i
+      else
+        value
+      end
+    end
+
+    # Converts +value+ to a boolean.
+    #
+    # Returns true for 'true', false for 'false', otherwise nil.
+    #
+    # @param name [ String ] Name of the URI option being processed.
+    # @param value [ String ] URI option value.
+    #
+    # @return [ true | false | nil ] Converted value.
+    def convert_bool(name, value)
       case value
-      when "true"
+      when "true", 'TRUE'
         true
-      when "false"
+      when "false", 'FALSE'
         false
       else
         log_warn("invalid boolean option for #{name}: #{value}")
@@ -809,7 +870,7 @@ module Mongo
     # @return [ true | false | nil ] The inverse of the  boolean value parsed out, otherwise nil
     #   (and a warning will be logged).
      def inverse_bool(name, value)
-      b = bool(name, value)
+      b = convert_bool(name, value)
 
       if b.nil?
         nil

data/lib/mongo/uri/srv_protocol.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'resolv'
-
 module Mongo
 
   class URI
@@ -65,6 +63,7 @@ module Mongo
       INVALID_PORT = "It is not allowed to specify a port in a connection string with the " +
                        "'#{MONGODB_SRV_SCHEME}' protocol.".freeze
 
+      # @deprecated
       INVALID_DOMAIN = "The domain name must consist of at least two parts: the domain name, " +
                          "and a TLD.".freeze
 
@@ -93,22 +92,45 @@ module Mongo
         @resolver ||= Resolv::DNS.new
       end
 
-      def parse_creds_hosts!(string)
-        hostname, creds = split_creds_hosts(string)
-        validate_hostname!(hostname)
+      def parse!(remaining)
+        super
+
+        if @servers.length != 1
+          raise_invalid_error!(INVALID_HOST)
+        end
+        hostname = @servers.first
+        validate_hostname(hostname)
+
         records = get_records(hostname)
         @txt_options = get_txt_opts(hostname) || {}
         @servers = parse_servers!(records.join(','))
-        @user = parse_user!(creds)
-        @password = parse_password!(creds)
       end
 
-      def validate_hostname!(hostname)
-        raise_invalid_error!(INVALID_HOST) if hostname.empty?
-        raise_invalid_error!(INVALID_HOST) if hostname.include?(HOST_DELIM)
+      # Validates the hostname used in an SRV URI.
+      #
+      # The hostname cannot include a port.
+      #
+      # The hostname must not begin with a dot, end with a dot, or have
+      # consecutive dots. The hostname must have a minimum of 3 total
+      # components (foo.bar.tld).
+      #
+      # Raises Error::InvalidURI if validation fails.
+      def validate_hostname(hostname)
         raise_invalid_error!(INVALID_PORT) if hostname.include?(HOST_PORT_DELIM)
-        _, _, domain = hostname.partition(DOT_PARTITION)
-        raise_invalid_error!(INVALID_DOMAIN) unless domain.include?(DOT_PARTITION)
+
+        if hostname.start_with?('.')
+          raise_invalid_error!("Hostname cannot start with a dot: #{hostname}")
+        end
+        if hostname.end_with?('.')
+          raise_invalid_error!("Hostname cannot end with a dot: #{hostname}")
+        end
+        parts = hostname.split('.')
+        if parts.any?(&:empty?)
+          raise_invalid_error!("Hostname cannot have consecutive dots: #{hostname}")
+        end
+        if parts.length < 3
+          raise_invalid_error!("Hostname must have a minimum of 3 components (foo.bar.tld): #{hostname}")
+        end
       end
 
       def get_records(hostname)
@@ -149,7 +171,7 @@ module Mongo
           key, value = opt.split(URI_OPTS_VALUE_DELIM)
           raise Error::InvalidTXTRecord.new(INVALID_TXT_RECORD_OPTION) unless VALID_TXT_OPTIONS.include?(key.downcase)
           strategy = URI_OPTION_MAP[key.downcase]
-          add_uri_option(strategy, value, txt_options)
+          add_uri_option(key, strategy, value, txt_options)
           txt_options
         end
       end