mongo 2.10.5 → 2.11.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8527a8f3a30fbe793408b726ac3cd9c751aa2abae43f62122280c196f3885bb5
-  data.tar.gz: 92efeea394a0070ebeefb63c66cdfe33535ebf09a7bdc4373cf50d15df1bf3ba
+  metadata.gz: b7c88c591ffb30fe10134db69727372a4d1c3801a11dce59804ebe53d475d08f
+  data.tar.gz: 16ce4f803cd46df9e0bc6948048fc4c0ea5356d437fbf75b149d38cd872ccca1
 SHA512:
-  metadata.gz: 50ebc39f36eab6b9de4cc20c0864f0d2bbdf8331c40690564c8bbe1260ca2df263ba9d1e0746b928b687de378f3194d53b1319648fbc061bf8b9861c406325e3
-  data.tar.gz: 0706a73de3f10992c3e8ad1fec0aec150221c122d98dae4fe95c05a6371c1c34987fa54041cefbebfe82e502161ac13515b09e059fdb6296a603c6acdc32d3de
+  metadata.gz: eb30b7789af0a8816ce50e4b5c3be68e0b0a6f3a0b2da8d4c13a6f6bc8ad826b6a6b505e99df369ed49b24543baa28ff08db655ce3701c1fd2f13b55d4bb9374
+  data.tar.gz: 7490c21d89f2b2c88aaa69d8203973869c409c637c0a212cb2d3cd2783ca258cd6a2df6729375e39894303b39541fd0296faee7c691d1b3e4c3553f6c6169385

data/CONTRIBUTING.md

@@ -23,7 +23,7 @@ Environment
 We recommend using [rbenv](https://github.com/sstephenson/rbenv) to set up
 the Ruby development and testing environments, though other tools like
 [RVM](https://rvm.io/) will also work. The driver currently supports
-MRI 1.9.3-2.6 and JRuby 9.1-9.2.
+MRI 2.3-2.6 and JRuby 9.2.
 
 A MongoDB cluster is required to run the tests. Setup procedures and
 recommendations for various clusters, as well as how to configure the

data/lib/mongo.rb

@@ -44,6 +44,7 @@ require 'mongo/event'
 require 'mongo/address'
 require 'mongo/auth'
 require 'mongo/protocol'
+require 'mongo/background_thread'
 require 'mongo/cluster'
 require 'mongo/cursor'
 require 'mongo/collection'
@@ -56,6 +57,7 @@ require 'mongo/server'
 require 'mongo/server_selector'
 require 'mongo/session'
 require 'mongo/socket'
+require 'mongo/srv'
 require 'mongo/uri'
 require 'mongo/version'
 require 'mongo/write_concern'

data/lib/mongo/address.rb

@@ -15,6 +15,7 @@
 require 'mongo/address/ipv4'
 require 'mongo/address/ipv6'
 require 'mongo/address/unix'
+require 'mongo/address/validator'
 
 module Mongo
 
@@ -67,6 +68,9 @@ module Mongo
     #
     # @since 2.0.0
     def initialize(seed, options = {})
+      if seed.nil?
+        raise ArgumentError, "address must be not nil"
+      end
       @seed = seed
       @host, @port = parse_host_port
       @options = options

data/lib/mongo/address/validator.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 2017-2019 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
+
+  class Address
+
+    # @api private
+    module Validator
+
+      # Takes an address string in ipv4/ipv6/hostname/socket path format and
+      # validates its format.
+      def validate_address_str!(address_str)
+        case address_str
+        when /\A\[[\d:]+\](?::(\d+))?\z/
+          # ipv6 with optional port
+          if port_str = $1
+            validate_port_str!(port_str)
+          end
+        when /\A\//, /\.sock\z/
+          # Unix socket path.
+          # Spec requires us to validate that the path has no unescaped
+          # slashes, but if this were to be the case, parsing would have
+          # already failed elsewhere because the URI would've been split in
+          # a weird place.
+          # The spec also allows relative socket paths and requires that
+          # socket paths end in ".sock". We accept all paths but special case
+          # the .sock extension to avoid relative paths falling into the
+          # host:port case below.
+        when /[\/\[\]]/
+          # Not a host:port nor an ipv4 address with optional port.
+          # Possibly botched ipv6 address with e.g. port delimiter present and
+          # port missing, or extra junk before or after.
+          raise Error::InvalidAddress,
+            "Invalid hostname: #{address_str}"
+        when /:.*:/m
+          raise Error::InvalidAddress,
+            "Multiple port delimiters are not allowed: #{address_str}"
+        else
+          # host:port or ipv4 address with optional port number
+          host, port = address_str.split(':')
+          if host.empty?
+            raise Error::InvalidAddress, "Host is empty: #{address_str}"
+          end
+
+          validate_hostname!(host)
+
+          if port && port.empty?
+            raise Error::InvalidAddress, "Port is empty: #{address_str}"
+          end
+
+          validate_port_str!(port)
+        end
+      end
+
+      private
+
+      # Validates format of the hostname, in particular for further use as
+      # the origin in same origin verification.
+      #
+      # The hostname must have been normalized to remove the trailing dot if
+      # it was obtained from a DNS record. This method prohibits trailing dots.
+      def validate_hostname!(host)
+        # Since we are performing same origin verification during SRV
+        # processing, prohibit leading dots in hostnames, trailing dots
+        # and runs of multiple dots. DNS resolution of SRV records yields
+        # hostnames with trailing dots, those trailing dots are removed
+        # during normalization process prior to validation.
+        if host.start_with?('.')
+          raise Error::InvalidAddress, "Hostname cannot start with a dot: #{host}"
+        end
+        if host.end_with?('.')
+          raise Error::InvalidAddress, "Hostname cannot end with a dot: #{host}"
+        end
+        if host.include?('..')
+          raise Error::InvalidAddress, "Runs of multiple dots are not allowed in hostname: #{host}"
+        end
+      end
+
+      def validate_port_str!(port)
+        unless port.nil? || (port.length > 0 && port.to_i > 0 && port.to_i <= 65535)
+          raise Error::InvalidAddress,
+            "Invalid port: #{port}. Port must be an integer greater than 0 and less than 65536"
+        end
+      end
+    end
+  end
+end

data/lib/mongo/auth.rb

@@ -70,10 +70,15 @@ module Mongo
       SOURCES[mechanism].new(user)
     end
 
+    # Raised when trying to authorize with an invalid configuration
+    #
+    # @since 2.11.0
+    class InvalidConfiguration < Mongo::Error::AuthError; end
+
     # Raised when trying to get an invalid authorization mechanism.
     #
     # @since 2.0.0
-    class InvalidMechanism < RuntimeError
+    class InvalidMechanism < InvalidConfiguration
 
       # Instantiate the new error.
       #
@@ -94,7 +99,7 @@ module Mongo
     # Raised when a user is not authorized on a database.
     #
     # @since 2.0.0
-    class Unauthorized < RuntimeError
+    class Unauthorized < Mongo::Error::AuthError
 
       # Instantiate the new error.
       #

data/lib/mongo/auth/user.rb

@@ -151,8 +151,6 @@ module Mongo
       #   authorized for.
       # @option options [ String ] :user The user name.
       # @option options [ String ] :password The user's password.
-      # @option options [ String ] :pwd Legacy option for the user's password.
-      #   If :password and :pwd are both specified, :password takes precedence.
       # @option options [ Symbol ] :auth_mech The authorization mechanism.
       # @option options [ Array<String>, Array<Hash> ] roles The user roles.
       # @option options [ String ] :client_key The user's client key cached from a previous
@@ -198,11 +196,7 @@ module Mongo
       #
       # @since 2.0.0
       def spec
-        {roles: roles}.tap do |spec|
-          if password
-            spec[:pwd] = password
-          end
-        end
+        { pwd: password, roles: roles }
       end
 
       private

data/lib/mongo/background_thread.rb

@@ -0,0 +1,135 @@
+# Copyright (C) 2019 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
+
+  # The run!, running? and stop! methods used to be part of the public API
+  # in some of the classes which now include this module. Therefore these
+  # methods must be considered part of the driver's public API for backwards
+  # compatibility reasons. However using these methods outside of the driver
+  # is deprecated.
+  #
+  # @api private
+  module BackgroundThread
+    include Loggable
+
+    # Start the background thread.
+    #
+    # If the thread is already running, this method does nothing.
+    #
+    # @api public for backwards compatibility only
+    def run!
+      if running?
+        @thread
+      else
+        start!
+      end
+    end
+
+    # @api public for backwards compatibility only
+    def running?
+      if @thread
+        @thread.alive?
+      else
+        false
+      end
+    end
+
+    # Stop the background thread and wait for to terminate for a reasonable
+    # amount of time.
+    #
+    # @return [ true | false ] Whether the thread was terminated.
+    #
+    # @api public for backwards compatibility only
+    def stop!
+      # If the thread was not started, there is nothing to stop.
+      #
+      # Classes including this module may want to perform additional
+      # cleanup, which they can do by overriding this method.
+      return true unless @thread
+
+      # Background threads generally perform operations in a loop.
+      # This flag is meant to be checked on each iteration of the
+      # working loops and the thread should stop working when this flag
+      # is set.
+      @stop_requested = true
+
+      # Besides setting the flag, a particular class may have additional
+      # ways of signaling the background thread to either stop working or
+      # wake up to check the stop flag, for example, setting a semaphore.
+      # This can be accomplished by providing the pre_stop method.
+      pre_stop
+
+      # Now we have requested the graceful termination, and we could wait
+      # for the thread to exit on its own accord. A future version of the
+      # driver may allow a certain amount of time for the thread to quit.
+      # For now, we additionally use the Ruby machinery to request the thread
+      # be terminated, and do so immediately.
+      #
+      # Note that this may cause the background thread to terminate in
+      # the middle of an operation.
+      @thread.kill
+
+      # Wait for the thread to die. This is important in order to reliably
+      # clean up resources like connections knowing that no background
+      # thread will reconnect because it is still working.
+      #
+      # However, we do not want to wait indefinitely because in theory
+      # a background thread could be performing, say, network I/O and if
+      # the network is no longer available that could take a long time.
+      start_time = Time.now
+      ([0.1, 0.15] + [0.2] * 5 + [0.3] * 20).each do |interval|
+        begin
+          Timeout.timeout(interval) do
+            @thread.join
+          end
+          break
+        rescue Timeout::Error
+        end
+      end
+
+      # Some driver objects can be reconnected, for backwards compatibiilty
+      # reasons. Clear the thread instance variable to support this cleanly.
+      if @thread.alive?
+        log_warn("Failed to stop background thread in #{self} in #{(Time.now - start_time).to_i} seconds")
+        false
+      else
+        @thread = nil
+        true
+      end
+    end
+
+    private
+
+    # @return [ Thread ] The created Thread instance.
+    def start!
+      @thread = Thread.new do
+        catch(:done) do
+          until @stop_requested
+            do_work
+          end
+        end
+      end
+    end
+
+    # Override this method to do the work in the background thread.
+    def do_work
+    end
+
+    # Override this method to perform additional signaling for the background
+    # thread to stop.
+    def pre_stop
+    end
+  end
+end

data/lib/mongo/bulk_write/transformable.rb

@@ -92,7 +92,7 @@ module Mongo
           Operation::U => doc[:replacement],
         }.tap do |d|
           if doc[:upsert]
-            d['upsert'] = true
+            d[:upsert] = true
           end
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
         end
@@ -108,7 +108,7 @@ module Mongo
           Operation::MULTI => true,
         }.tap do |d|
           if doc[:upsert]
-            d['upsert'] = true
+            d[:upsert] = true
           end
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
@@ -124,7 +124,7 @@ module Mongo
           Operation::U => doc[:update],
         }.tap do |d|
           if doc[:upsert]
-            d['upsert'] = true
+            d[:upsert] = true
           end
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]

data/lib/mongo/client.rb

@@ -62,6 +62,7 @@ module Mongo
       :id_generator,
       :local_threshold,
       :logger,
+      :log_prefix,
       :max_idle_time,
       :max_pool_size,
       :max_read_retries,
@@ -75,6 +76,7 @@ module Mongo
       :read_concern,
       :read_retry_interval,
       :replica_set,
+      :resolv_options,
       :retry_reads,
       :retry_writes,
       :scan,
@@ -215,13 +217,16 @@ module Mongo
     # @option options [ Float ] :connect_timeout The timeout, in seconds, to
     #   attempt a connection.
     # @option options [ String ] :database The database to connect to.
-    # @option options [ Float ] :heartbeat_frequency The number of seconds for
-    #   the server monitor to refresh it's description via ismaster.
+    # @option options [ Float ] :heartbeat_frequency The interval, in seconds,
+    #   for the server monitor to refresh its description via ismaster.
     # @option options [ Object ] :id_generator A custom object to generate ids
     #   for documents. Must respond to #generate.
     # @option options [ Integer ] :local_threshold The local threshold boundary
     #   in seconds for selecting a near server for an operation.
-    # @option options [ Logger ] :logger A custom logger if desired.
+    # @option options [ Logger ] :logger A custom logger to use.
+    # @option options [ String ] :log_prefix A custom log prefix to use when
+    #   logging. This option is experimental and subject to change in a future
+    #   version of the driver.
     # @option options [ Integer ] :max_idle_time The maximum seconds a socket can remain idle
     #   since it has been checked in to the pool.
     # @option options [ Integer ] :max_pool_size The maximum size of the
@@ -361,6 +366,8 @@ module Mongo
     #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
     # @option options [ Integer ] :zlib_compression_level The Zlib compression level to use, if using compression.
     #   See Ruby's Zlib module for valid levels.
+    # @option options [ Hash ] :resolv_options For internal driver use only.
+    #   Options to pass through to Resolv::DNS constructor for SRV lookups.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = nil)
@@ -370,8 +377,14 @@ module Mongo
         options = {}
       end
 
+      srv_uri = nil
       if addresses_or_uri.is_a?(::String)
         uri = URI.get(addresses_or_uri, options)
+        if uri.is_a?(URI::SRVProtocol)
+          # If the URI is an SRV URI, note this so that we can start
+          # SRV polling if the topology is a sharded cluster.
+          srv_uri = uri
+        end
         addresses = uri.servers
         uri_options = uri.client_options.dup
         # Special handing for :write and :write_concern: allow client Ruby
@@ -382,8 +395,10 @@ module Mongo
           uri_options.delete(:write_concern)
         end
         options = uri_options.merge(options)
+        @srv_records = uri.srv_records
       else
         addresses = addresses_or_uri
+        @srv_records = nil
       end
 
       unless options[:retry_reads] == false
@@ -407,6 +422,7 @@ module Mongo
 =end
       @options.freeze
       validate_options!
+      validate_authentication_options!
 
       @database = Database.new(self, @options[:database], @options)
 
@@ -418,8 +434,7 @@ module Mongo
         sdam_proc.call(self)
       end
 
-      @server_selection_semaphore = Semaphore.new
-      @cluster = Cluster.new(addresses, @monitoring, cluster_options)
+      @cluster = Cluster.new(addresses, @monitoring, cluster_options.merge(srv_uri: srv_uri))
 
       # Unset monitoring, it will be taken out of cluster from now on
       remove_instance_variable('@monitoring')
@@ -435,7 +450,6 @@ module Mongo
       options.reject do |key, value|
         CRUD_OPTIONS.include?(key.to_sym)
       end.merge(
-        server_selection_semaphore: @server_selection_semaphore,
         # but need to put the database back in for auth...
         database: options[:database],
 
@@ -444,7 +458,14 @@ module Mongo
         # applications should read these values from client, not from cluster
         max_read_retries: options[:max_read_retries],
         read_retry_interval: options[:read_retry_interval],
-      )
+      ).tap do |options|
+        # If the client has a cluster already, forward srv_uri to the new
+        # cluster to maintain SRV monitoring. If the client is brand new,
+        # its constructor sets srv_uri manually.
+        if cluster
+          options.update(srv_uri: cluster.options[:srv_uri])
+        end
+      end
     end
 
     # Get the maximum number of times the client can retry a read operation
@@ -616,6 +637,7 @@ module Mongo
         options.update(opts)
         @options = options.freeze
         validate_options!
+        validate_authentication_options!
       end
     end
 
@@ -647,17 +669,11 @@ module Mongo
 
     # Close all connections.
     #
-    # @example Disconnect the client.
-    #   client.close
-    #
-    # @param [ Boolean ] wait Whether to wait for background threads to
-    #   finish running.
-    #
     # @return [ true ] Always true.
     #
     # @since 2.1.0
-    def close(wait=false)
-      @cluster.disconnect!(wait)
+    def close
+      @cluster.disconnect!
       true
     end
 
@@ -857,7 +873,7 @@ module Mongo
     end
 
     # Validates all options after they are set on the client.
-    # This method is intended to catch combinations of options which do are
+    # This method is intended to catch combinations of options which are
     # not allowed.
     def validate_options!
       if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
@@ -865,6 +881,48 @@ module Mongo
       end
     end
 
+    # Validates all authentication-related options after they are set on the client
+    # This method is intended to catch combinations of options which are not allowed
+    def validate_authentication_options!
+      auth_mech = options[:auth_mech]
+      user = options[:user]
+      password = options[:password]
+      auth_source = options[:auth_source]
+      mech_properties = options[:auth_mech_properties]
+
+      if auth_mech.nil?
+        if user && user.empty?
+          raise Mongo::Auth::InvalidConfiguration.new('empty username is not supported for default auth mechanism')
+        end
+
+        return
+      end
+
+      if !Mongo::Auth::SOURCES.key?(auth_mech)
+        raise Mongo::Auth::InvalidMechanism.new(auth_mech)
+      end
+
+      if user.nil? && auth_mech != :mongodb_x509
+        raise Mongo::Auth::InvalidConfiguration.new("user is required for mechanism #{auth_mech}")
+      end
+
+      if password.nil? && ![:gssapi, :mongodb_x509].include?(auth_mech)
+        raise Mongo::Auth::InvalidConfiguration.new("password is required for mechanism #{auth_mech}")
+      end
+
+      if password && auth_mech == :mongodb_x509
+        raise Mongo::Auth::InvalidConfiguration.new('password is not supported for mongodb_x509')
+      end
+
+      if ![:external, nil].include?(auth_source) && [:gssapi, :mongodb_x509].include?(auth_mech)
+        raise Mongo::Auth::InvalidConfiguration.new("#{auth_source} is an invalid auth source for #{auth_mech}; valid options are $external and nil")
+      end
+
+      if mech_properties && auth_mech != :gssapi
+        raise Mongo::Auth::InvalidConfiguration.new("mechanism_properties are not supported for #{auth_mech}")
+      end
+    end
+
     def valid_compressors(compressors)
       compressors.select do |compressor|
         if !VALID_COMPRESSORS.include?(compressor)