mongo 2.18.1 → 2.19.1

data/lib/mongo/auth/roles.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -23,82 +23,82 @@ module Mongo
     # @since 2.0.0
     module Roles
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#backup
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#backup
       #
       # @since 2.0.0
       BACKUP = 'backup'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#clusterAdmin
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#clusterAdmin
       #
       # @since 2.0.0
       CLUSTER_ADMIN = 'clusterAdmin'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#clusterManager
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#clusterManager
       #
       # @since 2.0.0
       CLUSTER_MANAGER = 'clusterManager'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#clusterMonitor
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#clusterMonitor
       #
       # @since 2.0.0
       CLUSTER_MONITOR = 'clusterMonitor'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#dbAdmin
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#dbAdmin
       #
       # @since 2.0.0
       DATABASE_ADMIN = 'dbAdmin'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#dbAdminAnyDatabase
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#dbAdminAnyDatabase
       #
       # @since 2.0.0
       DATABASE_ADMIN_ANY_DATABASE = 'dbAdminAnyDatabase'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#dbOwner
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#dbOwner
       #
       # @since 2.0.0
       DATABASE_OWNER = 'dbOwner'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#hostManager
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#hostManager
       #
       # @since 2.0.0
       HOST_MANAGER = 'hostManager'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#read
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#read
       #
       # @since 2.0.0
       READ = 'read'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#readAnyDatabase
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#readAnyDatabase
       #
       # @since 2.0.0
       READ_ANY_DATABASE = 'readAnyDatabase'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#readWriteAnyDatabase
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#readWriteAnyDatabase
       #
       # @since 2.0.0
       READ_WRITE_ANY_DATABASE = 'readWriteAnyDatabase'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#readWrite
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#readWrite
       #
       # @since 2.0.0
       READ_WRITE = 'readWrite'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#restore
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#restore
       #
       # @since 2.0.0
       RESTORE = 'restore'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#root
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#root
       #
       # @since 2.0.0
       ROOT = 'root'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#userAdmin
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#userAdmin
       #
       # @since 2.0.0
       USER_ADMIN = 'userAdmin'.freeze
 
-      # @see http://docs.mongodb.org/manual/reference/built-in-roles/#userAdminAnyDatabase
+      # @see https://www.mongodb.com/docs/manual/reference/built-in-roles/#userAdminAnyDatabase
       #
       # @since 2.0.0
       USER_ADMIN_ANY_DATABASE = 'userAdminAnyDatabase'.freeze

data/lib/mongo/auth/sasl_conversation_base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/auth/scram/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/auth/scram.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/auth/scram256/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/auth/scram256.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/auth/scram_conversation_base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/auth/stringprep/profiles/sasl.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/auth/stringprep/tables.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/auth/stringprep/unicode_normalize/normalize.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright Ayumu Nojima (野島 歩) and Martin J. Dürst (duerst@it.aoyama.ac.jp)
 

data/lib/mongo/auth/stringprep/unicode_normalize/tables.rb

@@ -1,5 +1,6 @@
-# frozen_string_literal: true
 # encoding: us-ascii
+# frozen_string_literal: true
+# rubocop:todo all
 
 # automatically generated by template/unicode_norm_gen.tmpl
 

data/lib/mongo/auth/stringprep.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/auth/user/view.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/auth/user.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/auth/x509/conversation.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/auth/x509.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/auth.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/background_thread.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/bson.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/combineable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/ordered_combiner.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/result.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/result_combiner.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/transformable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/unordered_combiner.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write/validatable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/bulk_write.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -115,7 +115,8 @@ module Mongo
     #   )
     #
     # @param [ Mongo::Collection ] collection The collection.
-    # @param [ Array<Hash, BSON::Document> ] requests The requests, cannot be empty.
+    # @param [ Enumerable<Hash, BSON::Document> ] requests The requests,
+    #   cannot be empty.
     # @param [ Hash, BSON::Document ] options The options.
     #
     # @since 2.1.0
@@ -330,10 +331,9 @@ module Mongo
     #   ArgumentError ]
     #   if the document is invalid.
     def validate_requests!
-      if @requests.empty?
-        raise ArgumentError, "Bulk write requests cannot be empty"
-      end
+      requests_empty = true
       @requests.each do |req|
+        requests_empty = false
         if op = req.keys.first
           if [:update_one, :update_many].include?(op)
             if doc = maybe_first(req.dig(op, :update))
@@ -359,6 +359,8 @@ module Mongo
             end
           end
         end
+      end.tap do
+        raise ArgumentError, "Bulk write requests cannot be empty" if requests_empty
       end
     end
 

data/lib/mongo/caching_cursor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #

data/lib/mongo/client.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -71,6 +71,7 @@ module Mongo
       :local_threshold,
       :logger,
       :log_prefix,
+      :max_connecting,
       :max_idle_time,
       :max_pool_size,
       :max_read_retries,
@@ -80,6 +81,7 @@ module Mongo
       :monitoring_io,
       :password,
       :platform,
+      :populator_io,
       :read,
       :read_concern,
       :read_retry_interval,
@@ -265,6 +267,12 @@ module Mongo
     # @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_connecting The maximum number of
+    #  connections that can be connecting simultaneously. The default is 2.
+    #  This option should be increased if there are many threads that share
+    #  the same client and the application is experiencing timeouts
+    #  while waiting for connections to be established.
+    #  selecting a server for an operation. The default is 2.
     # @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
@@ -462,6 +470,12 @@ module Mongo
     #       and schemaMap, an error will be raised.
     #   - :bypass_query_analysis => Boolean | nil, when true disables automatic
     #     analysis of outgoing commands.
+    #   - :crypt_shared_lib_path => [ String | nil ]  Path that should
+    #     be  the used to load the crypt shared library. Providing this option
+    #     overrides default crypt shared library load paths for libmongocrypt.
+    #   - :crypt_shared_lib_required => [ Boolean | nil ]  Whether
+    #     crypt shared library is required. If 'true', an error will be raised
+    #     if a crypt_shared library cannot be loaded by libmongocrypt.
     #
     #   Notes on automatic encryption:
     #   - Automatic encryption is an enterprise only feature that only applies
@@ -590,9 +604,9 @@ module Mongo
 
       rescue
         begin
-          @cluster.disconnect!
+          @cluster.close
         rescue => e
-          log_warn("Eror disconnecting cluster in client constructor's exception handler: #{e.class}: #{e}")
+          log_warn("Eror closing cluster in client constructor's exception handler: #{e.class}: #{e}")
           # Drop this exception so that the original exception is raised
         end
         raise
@@ -853,6 +867,10 @@ module Mongo
       @write_concern ||= WriteConcern.get(options[:write_concern] || options[:write])
     end
 
+    def closed?
+      !!@closed
+    end
+
     # Close all connections.
     #
     # @return [ true ] Always true.
@@ -860,6 +878,7 @@ module Mongo
     # @since 2.1.0
     def close
       @connect_lock.synchronize do
+        @closed = true
         do_close
       end
       true
@@ -893,6 +912,8 @@ module Mongo
         if @options[:auto_encryption_options]
           build_encrypter
         end
+
+        @closed = false
       end
 
       true
@@ -1127,6 +1148,9 @@ module Mongo
     #
     # @api private
     def with_session(options = {}, &block)
+      # TODO: Add this back in RUBY-3174.
+      # assert_not_closed
+
       session = get_session(options)
 
       yield session
@@ -1189,7 +1213,7 @@ module Mongo
 
     # Implementation for #close, assumes the connect lock is already acquired.
     def do_close
-      @cluster.disconnect!
+      @cluster.close
       close_encrypter
     end
 
@@ -1301,6 +1325,7 @@ module Mongo
         key = k.to_sym
         if VALID_OPTIONS.include?(key)
           validate_max_min_pool_size!(key, opts)
+          validate_max_connecting!(key, opts)
           validate_read!(key, opts)
           if key == :compressors
             compressors = valid_compressors(v)
@@ -1563,6 +1588,23 @@ module Mongo
       true
     end
 
+    # Validates whether the max_connecting option is valid.
+    #
+    # @param [ Symbol ] option The option to validate.
+    # @param [ Hash ] opts The client options.
+    #
+    # @return [ true ] If the option is valid.
+    # @raise [ Error::InvalidMaxConnecting ] If the option is invalid.
+    def validate_max_connecting!(option, opts)
+      if option == :max_connecting && opts.key?(:max_connecting)
+        max_connecting = opts[:max_connecting] || Server::ConnectionPool::DEFAULT_MAX_CONNECTING
+        if max_connecting <= 0
+          raise Error::InvalidMaxConnecting.new(opts[:max_connecting])
+        end
+      end
+      true
+    end
+
     def validate_read!(option, opts)
       if option == :read && opts.has_key?(:read)
         read = opts[:read]
@@ -1570,7 +1612,7 @@ module Mongo
         # for custom classes implementing key access ([]).
         # Instead reject common cases of strings and symbols.
         if read.is_a?(String) || read.is_a?(Symbol)
-          raise Error::InvalidReadOption.new(read, 'must be a hash')
+          raise Error::InvalidReadOption.new(read, "the read preference must be specified as a hash: { mode: #{read.inspect} }")
         end
 
         if mode = read[:mode]
@@ -1582,5 +1624,11 @@ module Mongo
       end
       true
     end
+
+    def assert_not_closed
+      if closed?
+        raise Error::ClientClosed, "The client was closed and is not usable for operations. Call #reconnect to reset this client instance or create a new client instance"
+      end
+    end
   end
 end

data/lib/mongo/client_encryption.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -120,6 +120,46 @@ module Mongo
       @encrypter.encrypt(value, options)
     end
 
+    # Encrypts a Match Expression or Aggregate Expression to query a range index.
+    #
+    # @example Encrypt Match Expression.
+    #   encryption.encrypt_expression(
+    #     {'$and' =>  [{'field' => {'$gt' => 10}}, {'field' =>  {'$lt' => 20 }}]}
+    #   )
+    # @example Encrypt Aggregate Expression.
+    #   encryption.encrypt_expression(
+    #     {'$and' =>  [{'$gt' => ['$field', 10]}, {'$lt' => ['$field', 20]}}
+    #   )
+    #   {$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}]
+    # Only supported when queryType is "rangePreview" and algorithm is "RangePreview".
+    # @note: The Range algorithm is experimental only. It is not intended
+    #   for public use. It is subject to breaking changes.
+    #
+    # @param [ Hash ] expression Expression to encrypt.
+    # # @param [ Hash ] options
+    # @option options [ BSON::Binary ] :key_id A BSON::Binary object of type :uuid
+    #   representing the UUID of the encryption key as it is stored in the key
+    #   vault collection.
+    # @option options [ String ] :key_alt_name The alternate name for the
+    #   encryption key.
+    # @option options [ String ] :algorithm The algorithm used to encrypt the
+    #   expression. The only allowed value is "RangePreview"
+    # @option options [ Integer | nil ] :contention_factor Contention factor
+    #   to be applied If not  provided, it defaults to a value of 0.
+    # @option options [ String | nil ] query_type Query type to be applied.
+    #   The only allowed value is "rangePreview".
+    #
+    # @note The :key_id and :key_alt_name options are mutually exclusive. Only
+    #   one is required to perform explicit encryption.
+    #
+    # @return [ BSON::Binary ] A BSON Binary object of subtype 6 (ciphertext)
+    #   representing the encrypted expression.
+    #
+    # @raise [ ArgumentError ] if disallowed values in options are set.
+    def encrypt_expression(expression, options = {})
+      @encrypter.encrypt_expression(expression, options)
+    end
+
     # Decrypts a value that has already been encrypted.
     #
     # @param [ BSON::Binary ] value A BSON Binary object of subtype 6 (ciphertext)
@@ -205,5 +245,66 @@ module Mongo
       @encrypter.rewrap_many_data_key(filter, opts)
     end
 
+    # Create collection with encrypted fields.
+    #
+    # If :encryption_fields contains a keyId with a null value, a data key
+    # will be automatically generated and assigned to keyId value.
+    #
+    # @note This method does not update the :encrypted_fields_map in the client's
+    #   :auto_encryption_options. Therefore, in order to use the collection
+    #   created by this method with automatic encryption, the user must create
+    #   a new client after calling this function with the :encrypted_fields returned.
+    #
+    # @param [ Mongo::Database ] database Database to create collection in.
+    # @param [ String ] coll_name Name of collection to create.
+    # @param [ Hash ] coll_opts Options for collection to create.
+    # @param [ String ] kms_provider KMS provider to encrypt fields.
+    # @param [ Hash | nil ] master_key Document describing master key to encrypt fields.
+    #
+    # @return [ Array<Operation::Result, Hash> ] The result of the create
+    #   collection operation and the encrypted fields map used to create
+    #   the collection.
+    def create_encrypted_collection(database, coll_name, coll_opts, kms_provider, master_key)
+      raise ArgumentError, 'coll_opts must contain :encrypted_fields' unless coll_opts[:encrypted_fields]
+
+      encrypted_fields = create_data_keys(coll_opts[:encrypted_fields], kms_provider, master_key)
+      begin
+        new_coll_opts = coll_opts.dup.merge(encrypted_fields: encrypted_fields)
+        [database[coll_name].create(new_coll_opts), encrypted_fields]
+      rescue Mongo::Error => e
+        raise Error::CryptError, "Error creating collection with encrypted fields \
+              #{encrypted_fields}: #{e.class}: #{e.message}"
+      end
+    end
+
+    private
+
+    # Create data keys for fields in encrypted_fields that has :keyId key,
+    # but the value is nil.
+    #
+    # @param [ Hash ] encrypted_fields Encrypted fields map.
+    # @param [ String ] kms_provider KMS provider to encrypt fields.
+    # @param [ Hash | nil ] master_key Document describing master key to encrypt fields.
+    #
+    # @return [ Hash ] Encrypted fields map with keyIds for fields
+    #   that did not have one.
+    def create_data_keys(encrypted_fields, kms_provider, master_key)
+      encrypted_fields = encrypted_fields.dup
+      # We must return the partially formed encrypted_fields hash if an error
+      # occurs - https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#create-encrypted-collection-helper
+      # Thefore, we do this in a loop instead of using #map.
+      encrypted_fields[:fields].size.times do |i|
+        field = encrypted_fields[:fields][i]
+        next unless field.is_a?(Hash) && field.fetch(:keyId, false).nil?
+
+        begin
+          encrypted_fields[:fields][i][:keyId] = create_data_key(kms_provider, master_key: master_key)
+        rescue Error::CryptError => e
+          raise Error::CryptError, "Error creating data key for field #{field[:path]} \
+              with encrypted fields #{encrypted_fields}: #{e.class}: #{e.message}"
+        end
+      end
+      encrypted_fields
+    end
   end
 end

data/lib/mongo/cluster/periodic_executor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -197,11 +197,7 @@ module Mongo
           op.execute(server, context: Operation::Context.new(options: options))
 
           if session = kill_spec.session
-            if session.ended?
-              if Lint.enabled?
-                raise Error::LintError, "Ended session for a garbage collected cursor"
-              end
-            elsif session.implicit?
+            if session.implicit?
               session.end_session
             end
           end