mongo 2.12.4 → 2.13.0

data/lib/mongo/bulk_write/combineable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -25,13 +25,6 @@ module Mongo
       # @return [ Array<Hash, BSON::Document> ] requests The provided requests.
       attr_reader :requests
 
-      # @return [ true, false ] has_collation Whether one or more operations has a collation defined.
-      attr_reader :has_collation
-
-      # @return [ true, false ] has_array_filters Whether one or more operations specifies an array
-      # filters option.
-      attr_reader :has_array_filters
-
       # Create the ordered combiner.
       #
       # @api private
@@ -46,6 +39,25 @@ module Mongo
         @requests = requests
         @has_collation = false
         @has_array_filters = false
+        @has_hint = false
+      end
+
+      # @return [ Boolean ] Whether one or more operation specifies the collation
+      #   option.
+      def has_collation?
+        @has_collation
+      end
+
+      # @return [ Boolean ] Whether one or more operation specifies the
+      #   array_filters option.
+      def has_array_filters?
+        @has_array_filters
+      end
+
+      # @return [ Boolean ] Whether one or more operation specifies the
+      #   hint option.
+      def has_hint?
+        @has_hint
       end
 
       private

data/lib/mongo/bulk_write/ordered_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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/bulk_write/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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/bulk_write/result_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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/bulk_write/transformable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -61,6 +61,7 @@ module Mongo
           Operation::LIMIT => 0,
         }.tap do |d|
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -73,6 +74,7 @@ module Mongo
           Operation::LIMIT => 1,
         }.tap do |d|
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -91,10 +93,9 @@ module Mongo
           Operation::Q => doc[:filter],
           Operation::U => doc[:replacement],
         }.tap do |d|
-          if doc[:upsert]
-            d['upsert'] = true
-          end
+          d['upsert'] = true if doc[:upsert]
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -107,11 +108,10 @@ module Mongo
           Operation::U => doc[:update],
           Operation::MULTI => true,
         }.tap do |d|
-          if doc[:upsert]
-            d['upsert'] = true
-          end
+          d['upsert'] = true if doc[:upsert]
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -123,11 +123,10 @@ module Mongo
           Operation::Q => doc[:filter],
           Operation::U => doc[:update],
         }.tap do |d|
-          if doc[:upsert]
-            d['upsert'] = true
-          end
+          d['upsert'] = true if doc[:upsert]
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 

data/lib/mongo/bulk_write/unordered_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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/bulk_write/validatable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -47,6 +47,10 @@ module Mongo
         if document.respond_to?(:keys) && document[:array_filters]
           @has_array_filters = true
         end
+
+        if document.respond_to?(:keys) && document[:hint]
+          @has_hint = true
+        end
       end
 
       private

data/lib/mongo/client.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.
@@ -55,8 +55,10 @@ module Mongo
       :auth_mech_properties,
       :auth_source,
       :auto_encryption_options,
+      :bg_error_backtrace,
       :cleanup,
       :compressors,
+      :direct_connection,
       :connect,
       :connect_timeout,
       :database,
@@ -102,6 +104,7 @@ module Mongo
       :truncate_logs,
       :user,
       :wait_queue_timeout,
+      :wrapping_libraries,
       :write,
       :write_concern,
       :zlib_compression_level,
@@ -205,7 +208,6 @@ module Mongo
     #   connection string is also provided, these options take precedence over any
     #   analogous options present in the URI string.
     #
-    #
     # @option options [ String, Symbol ] :app_name Application name that is
     #   printed to the mongod logs upon establishing a connection in server
     #   versions >= 3.4.
@@ -213,11 +215,19 @@ module Mongo
     #   use. One of :mongodb_cr, :mongodb_x509, :plain, :scram, :scram256
     # @option options [ Hash ] :auth_mech_properties
     # @option options [ String ] :auth_source The source to authenticate from.
+    # @option options [ true | false | nil | Integer ] :bg_error_backtrace
+    #   Experimental. Set to true to log complete backtraces for errors in
+    #   background threads. Set to false or nil to not log backtraces. Provide
+    #   a positive integer to log up to that many backtrace lines.
     # @option options [ Array<String> ] :compressors A list of potential
     #   compressors to use, in order of preference. The driver chooses the
     #   first compressor that is also supported by the server. Currently the
     #   driver only supports 'zlib'.
-    # @option options [ Symbol ] :connect The connection method to use. This
+    # @option options [ true | false ] :direct_connection Whether to connect
+    #   directly to the specified seed, bypassing topology discovery. Exactly
+    #   one seed must be provided.
+    # @option options [ Symbol ] :connect Deprecated - use :direct_connection
+    #   option instead of this option. The connection method to use. This
     #   forces the cluster to behave in the specified way instead of
     #   auto-discovering. One of :direct, :replica_set, :sharded
     # @option options [ Float ] :connect_timeout The timeout, in seconds, to
@@ -294,7 +304,7 @@ module Mongo
     #   will ignore it and will never scan seeds in the constructor.
     # @option options [ Proc ] :sdam_proc A Proc to invoke with the client
     #   as the argument prior to performing server discovery and monitoring.
-    #   Use this to set up SDAM event listeners to receive events dispatched
+    #   Use this to set up SDAM event listeners to receive events published
     #   during client construction.
     #
     #   Note: the client is not fully constructed when sdam_proc is invoked,
@@ -366,6 +376,10 @@ module Mongo
     # @option options [ String ] :user The user name.
     # @option options [ Float ] :wait_queue_timeout The time to wait, in
     #   seconds, in the connection pool for a connection to be checked in.
+    # @option options [ Array<Hash> ] :wrapping_libraries Information about
+    #   libraries such as ODMs that are wrapping the driver, to be added to
+    #    metadata sent to the server. Specify the lower level libraries first.
+    #    Allowed hash keys: :name, :version, :platform.
     # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
     #   option.
     # @option options [ Hash ] :write_concern The write concern options.
@@ -439,6 +453,12 @@ module Mongo
         @srv_records = uri.srv_records
       else
         addresses = addresses_or_uri
+        addresses.each do |addr|
+          if addr =~ /\Amongodb(\+srv)?:\/\//i
+            raise ArgumentError, "Host '#{addr}' should not contain protocol. Did you mean to not use an array?"
+          end
+        end
+
         @srv_records = nil
       end
 
@@ -446,18 +466,7 @@ module Mongo
       # construction
       sdam_proc = options.delete(:sdam_proc)
 
-      # For gssapi service_name, the default option is given in a hash
-      # (one level down from the top level).
-      merged_options = default_options(options)
-      options.each do |k, v|
-        default_v = merged_options[k]
-        if Hash === default_v
-          v = default_v.merge(v)
-        end
-        merged_options[k] = v
-      end
-      options = merged_options
-
+      options = default_options(options).merge(options)
       @options = validate_new_options!(options)
 =begin WriteConcern object support
       if @options[:write_concern].is_a?(WriteConcern::Base)
@@ -467,7 +476,7 @@ module Mongo
       end
 =end
       @options.freeze
-      validate_options!
+      validate_options!(addresses)
       validate_authentication_options!
 
       @database = Database.new(self, @options[:database], @options)
@@ -496,7 +505,6 @@ module Mongo
           end
         end
 
-        yield(self) if block_given?
       rescue
         begin
           @cluster.disconnect!
@@ -506,6 +514,14 @@ module Mongo
         end
         raise
       end
+
+      if block_given?
+        begin
+          yield(self)
+        ensure
+          close
+        end
+      end
     end
 
     # @api private
@@ -616,7 +632,7 @@ module Mongo
     #
     # @return [ BSON::Document ] The user-defined read preference.
     #   The document may have the following fields:
-    #   - *:mode* -- read preference specified as a symbol; valid values are
+    #   - *:read* -- read preference specified as a symbol; valid values are
     #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
     #     and *:nearest*.
     #   - *:tag_sets* -- an array of hashes.
@@ -809,6 +825,13 @@ module Mongo
     # @param [ Hash ] filter The filter criteria for getting a list of databases.
     # @param [ Hash ] opts The command options.
     #
+    # @option opts [ true, false ] :authorized_databases A flag that determines
+    #   which databases are returned based on user privileges when access control
+    #   is enabled
+    #
+    #   See https://docs.mongodb.com/manual/reference/command/listDatabases/
+    #   for more information and usage.
+    #
     # @return [ Array<String> ] The names of the databases.
     #
     # @since 2.0.5
@@ -825,6 +848,13 @@ module Mongo
     # @param [ true, false ] name_only Whether to only return each database name without full metadata.
     # @param [ Hash ] opts The command options.
     #
+    # @option opts [ true, false ] :authorized_databases A flag that determines
+    #   which databases are returned based on user privileges when access control
+    #   is enabled
+    #
+    #   See https://docs.mongodb.com/manual/reference/command/listDatabases/
+    #   for more information and usage.
+    #
     # @return [ Array<Hash> ] The info for each database.
     #
     # @since 2.0.5
@@ -832,6 +862,7 @@ module Mongo
       cmd = { listDatabases: 1 }
       cmd[:nameOnly] = !!name_only
       cmd[:filter] = filter unless filter.empty?
+      cmd[:authorizedDatabases] = true if opts[:authorized_databases]
       use(Database::ADMIN).database.read_command(cmd, opts).first[Database::DATABASES]
     end
 
@@ -872,8 +903,16 @@ module Mongo
     #
     # @since 2.5.0
     def start_session(options = {})
-      get_session(options.merge(implicit: false)) or
-        raise Error::InvalidSession.new(Session::SESSIONS_NOT_SUPPORTED)
+      session = get_session!(options.merge(implicit: false))
+      if block_given?
+        begin
+          yield session
+        ensure
+          session.end_session
+        end
+      else
+        session
+      end
     end
 
     # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline stage is supported
@@ -919,6 +958,59 @@ module Mongo
         options)
     end
 
+    # Returns a session to use for operations if possible.
+    #
+    # If :session option is set, validates that session and returns it.
+    # Otherwise, if deployment supports sessions, creates a new session and
+    # returns it. When a new session is created, the session will be implicit
+    # (lifecycle is managed by the driver) if the :implicit option is given,
+    # otherwise the session will be explicit (lifecycle managed by the
+    # application). If deployment does not support session, returns nil.
+    #
+    # @option options [ true | false ] :implicit When no session is passed in,
+    #   whether to create an implicit session.
+    # @option options [ Session ] :session The session to validate and return.
+    #
+    # @return [ Session | nil ] Session object or nil if sessions are not
+    #   supported by the deployment.
+    #
+    # @api private
+    def get_session(options = {})
+      get_session!(options)
+    rescue Error::SessionsNotSupported
+      nil
+    end
+
+    # Creates a session to use for operations if possible and yields it to
+    # the provided block.
+    #
+    # If :session option is set, validates that session and uses it.
+    # Otherwise, if deployment supports sessions, creates a new session and
+    # uses it. When a new session is created, the session will be implicit
+    # (lifecycle is managed by the driver) if the :implicit option is given,
+    # otherwise the session will be explicit (lifecycle managed by the
+    # application). If deployment does not support session, yields nil to
+    # the block.
+    #
+    # When the block finishes, if the session was created and was implicit,
+    # or if an implicit session was passed in, the session is ended which
+    # returns it to the pool of available sessions.
+    #
+    # @option options [ true | false ] :implicit When no session is passed in,
+    #   whether to create an implicit session.
+    # @option options [ Session ] :session The session to validate and return.
+    #
+    # @api private
+    def with_session(options = {}, &block)
+      session = get_session(options)
+
+      yield session
+    ensure
+      if session && session.implicit?
+        session.end_session
+      end
+    end
+
     private
 
     # Create a new encrypter object using the client's auto encryption options
@@ -951,30 +1043,34 @@ module Mongo
       close_encrypter
     end
 
-    # If options[:session] is set, validates that session and returns it.
-    # If deployment supports sessions, creates a new session and returns it.
-    # The session is implicit unless options[:implicit] is given.
-    # If deployment does not support session, returns nil.
+    # Returns a session to use for operations.
     #
-    # @return [ Session | nil ] Session object or nil if sessions are not
-    #   supported by the deployment.
-    def get_session(options = {})
+    # If :session option is set, validates that session and returns it.
+    # Otherwise, if deployment supports sessions, creates a new session and
+    # returns it. When a new session is created, the session will be implicit
+    # (lifecycle is managed by the driver) if the :implicit option is given,
+    # otherwise the session will be explicit (lifecycle managed by the
+    # application). If deployment does not support session, raises
+    # Error::InvalidSession.
+    #
+    # @option options [ true | false ] :implicit When no session is passed in,
+    #   whether to create an implicit session.
+    # @option options [ Session ] :session The session to validate and return.
+    #
+    # @return [ Session ] A session object.
+    #
+    # @raise Error::SessionsNotSupported if sessions are not supported by
+    #   the deployment.
+    #
+    # @api private
+    def get_session!(options = {})
       if options[:session]
         return options[:session].validate!(self)
       end
 
-      if cluster.sessions_supported?
-        Session.new(cluster.session_pool.checkout, self, { implicit: true }.merge(options))
-      end
-    end
+      cluster.validate_session_support!
 
-    def with_session(options = {}, &block)
-      session = get_session(options)
-      yield(session)
-    ensure
-      if session && session.implicit?
-        session.end_session
-      end
+      Session.new(cluster.session_pool.checkout, self, { implicit: true }.merge(options))
     end
 
     def initialize_copy(original)
@@ -1023,10 +1119,82 @@ module Mongo
     # Validates all options after they are set on the client.
     # This method is intended to catch combinations of options which are
     # not allowed.
-    def validate_options!
+    def validate_options!(addresses = nil)
       if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
         raise ArgumentError, "If :write and :write_concern are both given, they must be identical: #{options.inspect}"
       end
+
+      if options[:direct_connection]
+        if options[:connect] && options[:connect].to_sym != :direct
+          raise ArgumentError, "Conflicting client options: direct_connection=true and connect=#{options[:connect]}"
+        end
+        # When a new client is created, we get the list of seed addresses
+        if addresses && addresses.length > 1
+          raise ArgumentError, "direct_connection=true cannot be used with multiple seeds"
+        end
+        # When a client is copied using #with, we have a cluster
+        if cluster && !cluster.topology.is_a?(Mongo::Cluster::Topology::Single)
+          raise ArgumentError, "direct_connection=true cannot be used with topologies other than Single (this client is #{cluster.topology.class.name.sub(/.*::/, '')})"
+        end
+      end
+
+      if options[:direct_connection] == false && options[:connect] && options[:connect].to_sym == :direct
+        raise ArgumentError, "Conflicting client options: direct_connection=false and connect=#{options[:connect]}"
+      end
+
+      %i(connect_timeout socket_timeout).each do |key|
+        if value = options[key]
+          unless Numeric === value
+            raise ArgumentError, "#{key} must be a non-negative number: #{value}"
+          end
+          if value < 0
+            raise ArgumentError, "#{key} must be a non-negative number: #{value}"
+          end
+        end
+      end
+
+      if value = options[:bg_error_backtrace]
+        case value
+        when Integer
+          if value <= 0
+            raise ArgumentError, ":bg_error_backtrace option value must be true, false, nil or a positive integer: #{value}"
+          end
+        when true
+          # OK
+        else
+          raise ArgumentError, ":bg_error_backtrace option value must be true, false, nil or a positive integer: #{value}"
+        end
+      end
+
+      if libraries = options[:wrapping_libraries]
+        unless Array === libraries
+          raise ArgumentError, ":wrapping_libraries must be an array of hashes: #{libraries}"
+        end
+
+        libraries = libraries.map do |library|
+          Utils.shallow_symbolize_keys(library)
+        end
+
+        libraries.each do |library|
+          unless Hash === library
+            raise ArgumentError, ":wrapping_libraries element is not a hash: #{library}"
+          end
+
+          if library.empty?
+            raise ArgumentError, ":wrapping_libraries element is empty"
+          end
+
+          unless (library.keys - %i(name platform version)).empty?
+            raise ArgumentError, ":wrapping_libraries element has invalid keys (allowed keys: :name, :platform, :version): #{library}"
+          end
+
+          library.each do |key, value|
+            if value.include?('|')
+              raise ArgumentError, ":wrapping_libraries element value cannot include '|': #{value}"
+            end
+          end
+        end
+      end
     end
 
     # Validates all authentication-related options after they are set on the client
@@ -1054,11 +1222,11 @@ module Mongo
         raise Mongo::Auth::InvalidMechanism.new(auth_mech)
       end
 
-      if user.nil? && auth_mech != :mongodb_x509
+      if user.nil? && !%i(aws mongodb_x509).include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration, "Username is required for auth mechanism #{auth_mech}"
       end
 
-      if password.nil? && ![:gssapi, :mongodb_x509].include?(auth_mech)
+      if password.nil? && !%i(aws gssapi mongodb_x509).include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration, "Password is required for auth mechanism #{auth_mech}"
       end
 
@@ -1066,7 +1234,11 @@ module Mongo
         raise Mongo::Auth::InvalidConfiguration, 'Password is not supported for :mongodb_x509 auth mechanism'
       end
 
-      if [:gssapi, :mongodb_x509].include?(auth_mech)
+      if auth_mech == :aws && user && !password
+        raise Mongo::Auth::InvalidConfiguration, 'Username is provided but password is not provided for :aws auth mechanism'
+      end
+
+      if %i(aws gssapi mongodb_x509).include?(auth_mech)
         if !['$external', nil].include?(auth_source)
           raise Mongo::Auth::InvalidConfiguration, "#{auth_source} is an invalid auth source for #{auth_mech}; valid options are $external and nil"
         end
@@ -1077,7 +1249,7 @@ module Mongo
         end
       end
 
-      if mech_properties && auth_mech != :gssapi
+      if mech_properties && !%i(aws gssapi).include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration, ":mechanism_properties are not supported for auth mechanism #{auth_mech}"
       end
     end