mongo 2.12.1 → 2.13.0

data/lib/mongo/socket/tcp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,34 +20,6 @@ module Mongo
     # @since 2.0.0
     class TCP < Socket
 
-      # @return [ String ] host The host to connect to.
-      attr_reader :host
-
-      # @return [ Integer ] port The port to connect to.
-      attr_reader :port
-
-      # Establishes a socket connection.
-      #
-      # @example Connect the socket.
-      #   sock.connect!
-      #
-      # @note This method mutates the object by setting the socket
-      #   internally.
-      #
-      # @return [ TCP ] The connected socket instance.
-      #
-      # @since 2.0.0
-      def connect!
-        Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError) do
-          socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
-          handle_errors do
-            socket.connect(::Socket.pack_sockaddr_in(port, host))
-          end
-          self
-        end
-      end
-      private :connect!
-
       # Initializes a new TCP socket.
       #
       # @example Create the TCP socket.
@@ -61,10 +33,18 @@ module Mongo
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout.
+      # @option options [ Address ] :connection_address Address of the
+      #   connection that created this socket.
+      # @option options [ Integer ] :connection_generation Generation of the
+      #   connection (for non-monitoring connections) that created this socket.
+      # @option options [ true | false ] :monitor Whether this socket was
+      #   created by a monitoring connection.
       #
       # @since 2.0.0
+      # @api private
       def initialize(host, port, timeout, family, options = {})
-        @host, @port, @timeout, @options = host, port, timeout, options
+        super(timeout, options)
+        @host, @port = host, port
         @family = family
         @socket = ::Socket.new(family, SOCK_STREAM, 0)
         begin
@@ -76,9 +56,37 @@ module Mongo
         end
       end
 
+      # @return [ String ] host The host to connect to.
+      attr_reader :host
+
+      # @return [ Integer ] port The port to connect to.
+      attr_reader :port
+
+      # Establishes a socket connection.
+      #
+      # @example Connect the socket.
+      #   sock.connect!
+      #
+      # @note This method mutates the object by setting the socket
+      #   internally.
+      #
+      # @return [ TCP ] The connected socket instance.
+      #
+      # @since 2.0.0
+      def connect!
+        Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError, "The socket took over #{options[:connect_timeout]} seconds to connect") do
+          socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
+          map_exceptions do
+            socket.connect(::Socket.pack_sockaddr_in(port, host))
+          end
+          self
+        end
+      end
+      private :connect!
+
       private
 
-      def address
+      def human_address
         "#{host}:#{port} (no TLS)"
       end
     end

data/lib/mongo/socket/unix.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,9 +20,6 @@ module Mongo
     # @since 2.0.0
     class Unix < Socket
 
-      # @return [ String ] path The path to connect to.
-      attr_reader :path
-
       # Initializes a new Unix socket.
       #
       # @example Create the Unix socket.
@@ -33,17 +30,28 @@ module Mongo
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout (unused).
+      # @option options [ Address ] :connection_address Address of the
+      #   connection that created this socket.
+      # @option options [ Integer ] :connection_generation Generation of the
+      #   connection (for non-monitoring connections) that created this socket.
+      # @option options [ true | false ] :monitor Whether this socket was
+      #   created by a monitoring connection.
       #
       # @since 2.0.0
+      # @api private
       def initialize(path, timeout, options = {})
-        @path, @timeout, @options = path, timeout, options
+        super(timeout, options)
+        @path = path
         @socket = ::UNIXSocket.new(path)
         set_socket_options(@socket)
       end
 
+      # @return [ String ] path The path to connect to.
+      attr_reader :path
+
       private
 
-      def address
+      def human_address
         path
       end
     end

data/lib/mongo/srv.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/srv/monitor.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/srv/resolver.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/srv/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/timeout.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2020 MongoDB, Inc.
+# Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,15 +24,15 @@ module Mongo
     #   When no error exception is provided, Timeout::Error is raised.
     # @param [ String ] message The error message passed to the exception raised
     #   on timeout, optional. When no error message is provided, the default
-    #   error message is "execution expired".
-    #
-    # @note Ruby versions older than 2.4.0 do not support specifying a custom
-    #   error message, and any error message passed in as an argument will be
-    #   ignored.
+    #   error message for the exception class is used.
     def timeout(sec, klass=nil, message=nil)
-      if RUBY_VERSION < '2.4.0'
-        ::Timeout.timeout(sec, klass) do
-          yield
+      if message && RUBY_VERSION < '2.94.0'
+        begin
+          ::Timeout.timeout(sec) do
+            yield
+          end
+        rescue ::Timeout::Error => e
+          raise klass, message
         end
       else
         # Jruby Timeout::timeout method does not support passing nil arguments.

data/lib/mongo/topology_version.rb

@@ -0,0 +1,89 @@
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  # TopologyVersion encapsulates the topologyVersion document obtained from
+  # ismaster responses and not master-like OperationFailure errors.
+  #
+  # @api private
+  class TopologyVersion < BSON::Document
+    def initialize(doc)
+      if Lint.enabled?
+        unless doc['processId']
+          raise ArgumentError, 'Creating a topology version without processId field'
+        end
+        unless doc['counter']
+          raise ArgumentError, 'Creating a topology version without counter field'
+        end
+      end
+
+      super
+    end
+
+    # @return [ BSON::ObjectId ] The process id.
+    def process_id
+      self['processId']
+    end
+
+    # @return [ Integer ] The counter.
+    def counter
+      self['counter']
+    end
+
+    # Returns whether this topology version is potentially newer than another
+    # topology version.
+    #
+    # Note that there is no total ordering of topology versions - given
+    # two topology versions, each may be "potentially newer" than the other one.
+    #
+    # @param [ TopologyVersion ] other The other topology version.
+    #
+    # @return [ true | false ] Whether this topology version is potentially newer.
+    # @api private
+    def gt?(other)
+      if process_id != other.process_id
+        true
+      else
+        counter > other.counter
+      end
+    end
+
+    # Returns whether this topology version is potentially newer than or equal
+    # to another topology version.
+    #
+    # Note that there is no total ordering of topology versions - given
+    # two topology versions, each may be "potentially newer" than the other one.
+    #
+    # @param [ TopologyVersion ] other The other topology version.
+    #
+    # @return [ true | false ] Whether this topology version is potentially newer.
+    # @api private
+    def gte?(other)
+      if process_id != other.process_id
+        true
+      else
+        counter >= other.counter
+      end
+    end
+
+    # Converts the object to a document suitable for being sent to the server.
+    #
+    # @return [ BSON::Document ] The document.
+    #
+    # @api private
+    def to_doc
+      BSON::Document.new(self).merge(counter: BSON::Int64.new(counter))
+    end
+  end
+end

data/lib/mongo/uri.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -192,12 +192,13 @@ module Mongo
     # @since 2.0.0
     AUTH_MECH_MAP = {
       'GSSAPI'       => :gssapi,
+      'MONGODB-AWS'  => :aws,
       # MONGODB-CR is deprecated and will be removed in driver version 3.0
       'MONGODB-CR'   => :mongodb_cr,
       'MONGODB-X509' => :mongodb_x509,
       'PLAIN'        => :plain,
       'SCRAM-SHA-1'  => :scram,
-      'SCRAM-SHA-256' => :scram256
+      'SCRAM-SHA-256' => :scram256,
     }.freeze
 
     # Options that are allowed to appear more than once in the uri.
@@ -295,42 +296,7 @@ module Mongo
         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
-      # 'tls' and 'ssl'. In order to fulfill this, we parse the values of each instance into an
-      # array; assuming all values in the array are the same, we replace the array with that value.
-      unless @uri_options[:ssl].nil? || @uri_options[:ssl].empty?
-        unless @uri_options[:ssl].uniq.length == 1
-          raise_invalid_error_no_fmt!("all instances of 'tls' and 'ssl' must have the same value")
-        end
-
-        @uri_options[:ssl] = @uri_options[:ssl].first
-      end
-
-      # Check for conflicting TLS insecure options.
-      unless @uri_options[:ssl_verify].nil?
-        unless @uri_options[:ssl_verify_certificate].nil?
-          raise_invalid_error_no_fmt!("'tlsInsecure' and 'tlsAllowInvalidCertificates' cannot both be specified")
-        end
-
-        unless @uri_options[:ssl_verify_hostname].nil?
-          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
-
-      if uri_options[:write_concern] && !uri_options[:write_concern].empty?
-        begin
-          WriteConcern.get(uri_options[:write_concern])
-        rescue Error::InvalidWriteConcern => e
-          raise_invalid_error_no_fmt!("#{e.class}: #{e}")
-        end
-      end
+      validate_uri_options!
     end
 
     # Get the credentials provided in the URI.
@@ -435,9 +401,6 @@ module Mongo
         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 = decode(key)
         value = decode(value)
         add_uri_option(key, value, uri_options)
@@ -487,7 +450,7 @@ module Mongo
     end
 
     def encode(value)
-      ::URI.encode(value)
+      CGI.escape(value).gsub('+', '%20')
     end
 
     # Hash for storing map of URI option parameters to conversion strategies
@@ -544,6 +507,7 @@ module Mongo
     uri_option 'tlsinsecure', :ssl_verify, :type => :inverse_bool
 
     # Topology options
+    uri_option 'directconnection', :direct_connection, type: :bool
     uri_option 'connect', :connect, type: :symbol
 
     # Auth Options
@@ -680,7 +644,7 @@ module Mongo
     # @return [ Hash ] The auth mechanism properties hash.
     def auth_mech_props(value)
       properties = hash_extractor('authMechanismProperties', value)
-      if properties[:canonicalize_host_name]
+      if properties && properties[:canonicalize_host_name]
         properties.merge!(canonicalize_host_name:
           properties[:canonicalize_host_name].downcase == 'true')
       end
@@ -855,15 +819,16 @@ module Mongo
     #
     # @return [ Hash ] The hash built from the string.
     def hash_extractor(name, value)
-      value.split(',').reduce({}) do |set, tag|
+      h = {}
+      value.split(',').each do |tag|
         k, v = tag.split(':')
         if v.nil?
-          log_warn("Invalid hash value for #{name}: #{value}")
-          return nil
+          log_warn("Invalid hash value for #{name}: key `#{k}` does not have a value: #{value}")
         end
 
-        set.merge(k.downcase.to_sym => v)
+        h[k.downcase.to_sym] = v
       end
+      h
     end
 
     # Extract values from the string and put them into an array.
@@ -874,6 +839,55 @@ module Mongo
     def array(value)
       value.split(',')
     end
+
+    def validate_uri_options!
+      # The URI options spec requires that we raise an error if there are conflicting values of
+      # 'tls' and 'ssl'. In order to fulfill this, we parse the values of each instance into an
+      # array; assuming all values in the array are the same, we replace the array with that value.
+      unless uri_options[:ssl].nil? || uri_options[:ssl].empty?
+        unless uri_options[:ssl].uniq.length == 1
+          raise_invalid_error_no_fmt!("all instances of 'tls' and 'ssl' must have the same value")
+        end
+
+        uri_options[:ssl] = uri_options[:ssl].first
+      end
+
+      # Check for conflicting TLS insecure options.
+      unless uri_options[:ssl_verify].nil?
+        unless uri_options[:ssl_verify_certificate].nil?
+          raise_invalid_error_no_fmt!("'tlsInsecure' and 'tlsAllowInvalidCertificates' cannot both be specified")
+        end
+
+        unless uri_options[:ssl_verify_hostname].nil?
+          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
+
+      if uri_options[:write_concern] && !uri_options[:write_concern].empty?
+        begin
+          WriteConcern.get(uri_options[:write_concern])
+        rescue Error::InvalidWriteConcern => e
+          raise_invalid_error_no_fmt!("#{e.class}: #{e}")
+        end
+      end
+
+      if uri_options[:direct_connection]
+        if uri_options[:connect] && uri_options[:connect].to_s != 'direct'
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with connect=#{uri_options[:connect]}")
+        end
+        if servers.length > 1
+          raise_invalid_error_no_fmt!("directConnection=true cannot be used with multiple seeds")
+        end
+      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
+    end
   end
 end