mongo 2.18.0.beta1 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27dd7818b5dc4a0b930ad91ec1607720ad7a02b1b6ea801499e7102ad758db17
-  data.tar.gz: 7c06c0a8e70f17a81529b727fcecb10c6a39c04fd36111cac51d3802b1494bf0
+  metadata.gz: b1a032a8e48c1bc78d55d09cf8b607ec98402fb5f5e4a9a3fd11c566ee74b84f
+  data.tar.gz: 4ed2f33af97f4e5ab3da1b6acad5c90f3d7bfd0baee576d8e1df1b246b60637e
 SHA512:
-  metadata.gz: 6551874d18d17670e04c13a05ec7e1ee793dfe5984933dbd476adf12603d65ff36c377681d5eb49b94b8da9523d8e196a306da8f3496b0400f6c82302db9b4ea
-  data.tar.gz: f337ac92bc26479b70ce26a6c88056a57ee2201c586fa134ead68ad00041368fd77edb4c07d7db7e042d1525aeca75998c51e6209b77069b752739cc68d96aae
+  metadata.gz: 148a1228124e7895b96ef7931d7ba480748464f730e42c384da5ee64806bc173691db11d278cf7f189fefb4b06c1fe6999ac7cad1934f9dfdbd84a4cb89427a8
+  data.tar.gz: e9d7cc2c3dd95b8e2cdbc0017d12fcf7d10df4416999356709029c466f74f8ac07cbe5a868a3bd0392ea6a9d380f8cdba73ad0970fe249048832ad0a11983f47

data/lib/mongo/bulk_write.rb

@@ -115,7 +115,7 @@ module Mongo
     #   )
     #
     # @param [ Mongo::Collection ] collection The collection.
-    # @param [ Array<Hash, BSON::Document> ] requests The requests.
+    # @param [ Array<Hash, BSON::Document> ] requests The requests, cannot be empty.
     # @param [ Hash, BSON::Document ] options The options.
     #
     # @since 2.1.0
@@ -324,9 +324,15 @@ module Mongo
     # and some which are not), in which case the driver expects the server to
     # fail the operation with an error.
     #
-    # @raise [ Error::InvalidUpdateDocument, Error::InvalidReplacementDocument ]
+    # Raise an ArgumentError if requests is empty.
+    #
+    # @raise [ Error::InvalidUpdateDocument, Error::InvalidReplacementDocument,
+    #   ArgumentError ]
     #   if the document is invalid.
     def validate_requests!
+      if @requests.empty?
+        raise ArgumentError, "Bulk write requests cannot be empty"
+      end
       @requests.each do |req|
         if op = req.keys.first
           if [:update_one, :update_many].include?(op)

data/lib/mongo/client.rb

@@ -268,7 +268,7 @@ module Mongo
     # @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
-    #   connection pool.
+    #   connection pool. Setting this option to zero creates an unlimited connection pool.
     # @option options [ Integer ] :max_read_retries The maximum number of read
     #   retries when legacy read retries are in use.
     # @option options [ Integer ] :max_write_retries The maximum number of write
@@ -437,7 +437,8 @@ module Mongo
     #     are :aws, :azure, :gcp, :kmip, :local. There may be more than one
     #     kms provider specified.
     #   - :schema_map => Hash | nil, JSONSchema for one or more collections
-    #     specifying which fields should be encrypted.
+    #     specifying which fields should be encrypted. This option is
+    #     mutually exclusive with :schema_map_path.
     #     - Note: Schemas supplied in the schema_map only apply to configuring
     #       automatic encryption for client side encryption. Other validation
     #       rules in the JSON schema will not be enforced by the driver and will
@@ -448,6 +449,9 @@ module Mongo
     #       the client into sending unencrypted data that should be encrypted.
     #     - Note: If a collection is present on both the :encrypted_fields_map
     #       and :schema_map, an error will be raised.
+    #   - :schema_map_path => String | nil A path to a file contains the JSON schema
+    #   of the collection that stores auto encrypted documents. This option is
+    #   mutually exclusive with :schema_map.
     #   - :bypass_auto_encryption => Boolean, when true, disables auto encryption;
     #     defaults to false.
     #   - :extra_options => Hash | nil, options related to spawning mongocryptd
@@ -763,7 +767,7 @@ module Mongo
         # We can't use the same cluster if some options that would affect it
         # have changed.
         if cluster_modifying?(opts)
-          Cluster.create(client)
+          Cluster.create(client, monitoring: opts[:monitoring])
         end
       end
     end
@@ -1053,6 +1057,11 @@ module Mongo
     #   Only recognized by server versions 4.0+.
     # @option options [ Object ] :comment A user-provided
     #   comment to attach to this command.
+    # @option options [ Boolean ] :show_expanded_events Enables the server to
+    #   send the 'expanded' list of change stream events. The list of additional
+    #   events included with this flag set are: createIndexes, dropIndexes,
+    #   modify, create, shardCollection, reshardCollection,
+    #   refineCollectionShardKey.
     #
     # @note A change stream only allows 'majority' read concern.
     # @note This helper method is preferable to running a raw aggregation with a $changeStream
@@ -1064,8 +1073,11 @@ module Mongo
     def watch(pipeline = [], options = {})
       return use(Database::ADMIN).watch(pipeline, options) unless database.name == Database::ADMIN
 
+      view_options = options.dup
+      view_options[:await_data] = true if options[:max_await_time_ms]
+
       Mongo::Collection::View::ChangeStream.new(
-        Mongo::Collection::View.new(self["#{Database::COMMAND}.aggregate"]),
+        Mongo::Collection::View.new(self["#{Database::COMMAND}.aggregate"], {}, view_options),
         pipeline,
         Mongo::Collection::View::ChangeStream::CLUSTER,
         options)
@@ -1544,7 +1556,9 @@ module Mongo
     def validate_max_min_pool_size!(option, opts)
       if option == :min_pool_size && opts[:min_pool_size]
         max = opts[:max_pool_size] || Server::ConnectionPool::DEFAULT_MAX_SIZE
-        raise Error::InvalidMinPoolSize.new(opts[:min_pool_size], max) unless opts[:min_pool_size] <= max
+        if max != 0 && opts[:min_pool_size] > max
+          raise Error::InvalidMinPoolSize.new(opts[:min_pool_size], max)
+        end
       end
       true
     end

data/lib/mongo/client_encryption.rb

@@ -43,7 +43,7 @@ module Mongo
     #
     # @raise [ ArgumentError ] If required options are missing or incorrectly
     #   formatted.
-    def initialize(key_vault_client, options={})
+    def initialize(key_vault_client, options = {})
       @encrypter = Crypt::ExplicitEncrypter.new(
         key_vault_client,
         options[:key_vault_namespace],
@@ -71,13 +71,19 @@ module Mongo
     #     will not be properly parsed.
     # @option options [ Array<String> ] :key_alt_names An optional array of
     #   strings specifying alternate names for the new data key.
+    # @option options [ String | nil ] :key_material Optional
+    #   96 bytes to use as custom key material for the data key being created.
+    #   If :key_material option is given, the custom key material is used
+    #   for encrypting and decrypting data.
     #
     # @return [ BSON::Binary ] The 16-byte UUID of the new data key as a
     #   BSON::Binary object with type :uuid.
     def create_data_key(kms_provider, options={})
       key_document = Crypt::KMS::MasterKeyDocument.new(kms_provider, options)
+
       key_alt_names = options[:key_alt_names]
-      @encrypter.create_and_insert_data_key(key_document, key_alt_names)
+      key_material = options[:key_material]
+      @encrypter.create_and_insert_data_key(key_document, key_alt_names, key_material)
     end
 
     # Encrypts a value using the specified encryption key and algorithm.
@@ -97,10 +103,10 @@ module Mongo
     #   to be applied if encryption algorithm is set to "Indexed". If not
     #   provided, it defaults to a value of 0. Contention factor should be set
     #   only if encryption algorithm is set to "Indexed".
-    # @option options [ Symbol ] query_type Query type to be applied
+    # @option options [ String | nil ] query_type Query type to be applied
     # if encryption algorithm is set to "Indexed". Query type should be set
     #   only if encryption algorithm is set to "Indexed". The only allowed
-    #   value is :equality.
+    #   value is "equality".
     #
     # @note The :key_id and :key_alt_name options are mutually exclusive. Only
     #   one is required to perform explicit encryption.
@@ -123,5 +129,81 @@ module Mongo
     def decrypt(value)
       @encrypter.decrypt(value)
     end
+
+    # Adds a key_alt_name for the key in the key vault collection with the given id.
+    #
+    # @param [ BSON::Binary ] id Id of the key to add new key alt name.
+    # @param [ String ] key_alt_name New key alt name to add.
+    #
+    # @return [ BSON::Document | nil ] Document describing the identified key
+    #   before adding the key alt name, or nil if no such key.
+    def add_key_alt_name(id, key_alt_name)
+      @encrypter.add_key_alt_name(id, key_alt_name)
+    end
+
+    # Removes the key with the given id from the key vault collection.
+    #
+    # @param [ BSON::Binary ] id Id of the key to delete.
+    #
+    # @return [ Operation::Result ] The response from the database for the delete_one
+    #   operation that deletes the key.
+    def delete_key(id)
+      @encrypter.delete_key(id)
+    end
+
+    # Finds a single key with the given id.
+    #
+    # @param [ BSON::Binary ] id Id of the key to get.
+    #
+    # @return [ BSON::Document | nil ] The found key document or nil
+    #   if not found.
+    def get_key(id)
+      @encrypter.get_key(id)
+    end
+
+    # Returns a key in the key vault collection with the given key_alt_name.
+    #
+    # @param [ String ] key_alt_name Key alt name to find a key.
+    #
+    # @return [ BSON::Document | nil ] The found key document or nil
+    #   if not found.
+    def get_key_by_alt_name(key_alt_name)
+      @encrypter.get_key_by_alt_name(key_alt_name)
+    end
+
+    # Returns all keys in the key vault collection.
+    #
+    # @return [ Collection::View ] Keys in the key vault collection.
+    def get_keys
+      @encrypter.get_keys
+    end
+    alias :keys :get_keys
+
+    # Removes a key_alt_name from a key in the key vault collection with the given id.
+    #
+    # @param [ BSON::Binary ] id Id of the key to remove key alt name.
+    # @param [ String ] key_alt_name Key alt name to remove.
+    #
+    # @return [ BSON::Document | nil ] Document describing the identified key
+    #   before removing the key alt name, or nil if no such key.
+    def remove_key_alt_name(id, key_alt_name)
+      @encrypter.remove_key_alt_name(id, key_alt_name)
+    end
+
+    # Decrypts multiple data keys and (re-)encrypts them with a new master_key,
+    #   or with their current master_key if a new one is not given.
+    #
+    # @param [ Hash ] filter Filter used to find keys to be updated.
+    # @param [ Hash ] options
+    #
+    # @option options [ String ] :provider KMS provider to encrypt keys.
+    # @option options [ Hash | nil ] :master_key Document describing master key
+    #   to encrypt keys.
+    #
+    # @return [ Crypt::RewrapManyDataKeyResult ] Result of the operation.
+    def rewrap_many_data_key(filter, opts = {})
+      @encrypter.rewrap_many_data_key(filter, opts)
+    end
+
   end
 end

data/lib/mongo/cluster.rb

@@ -280,20 +280,22 @@ module Mongo
     # Create a cluster for the provided client, for use when we don't want the
     # client's original cluster instance to be the same.
     #
-    # @api private
-    #
     # @example Create a cluster for the client.
     #   Cluster.create(client)
     #
     # @param [ Client ] client The client to create on.
+    # @param [ Monitoring | nil ] monitoring. The monitoring instance to use
+    #   with the new cluster. If nil, a new instance of Monitoring will be
+    #   created.
     #
     # @return [ Cluster ] The cluster.
     #
     # @since 2.0.0
-    def self.create(client)
+    # @api private
+    def self.create(client, monitoring: nil)
       cluster = Cluster.new(
         client.cluster.addresses.map(&:to_s),
-        Monitoring.new,
+        monitoring || Monitoring.new,
         client.cluster_options,
       )
       client.instance_variable_set(:@cluster, cluster)

data/lib/mongo/collection/view/aggregation.rb

@@ -97,6 +97,9 @@ module Mongo
         def initialize(view, pipeline, options = {})
           @view = view
           @pipeline = pipeline.dup
+          unless Mongo.broken_view_aggregate || view.filter.empty?
+            @pipeline.unshift(:$match => view.filter)
+          end
           @options = BSON::Document.new(options).freeze
         end
 

data/lib/mongo/collection/view/change_stream.rb

@@ -115,6 +115,11 @@ module Mongo
         #   dropped and recreated or newly renamed collections without missing any notifications.
         # @option options [ Object ] :comment A user-provided
         #   comment to attach to this command.
+        # @option options [ Boolean ] :show_expanded_events Enables the server to
+        #   send the 'expanded' list of change stream events. The list of additional
+        #   events included with this flag set are: createIndexes, dropIndexes,
+        #   modify, create, shardCollection, reshardCollection,
+        #   refineCollectionShardKey.
         #
         #   The server will report an error if `startAfter` and `resumeAfter` are both specified.
         #
@@ -343,6 +348,10 @@ module Mongo
               doc[:fullDocumentBeforeChange] = @options[:full_document_before_change]
             end
 
+            if @options.key?(:show_expanded_events)
+              doc[:showExpandedEvents] = @options[:show_expanded_events]
+            end
+
             if resuming?
               # We have a resume token once we retrieved any documents.
               # However, if the first getMore fails and the user didn't pass

data/lib/mongo/collection/view/iterable.rb

@@ -170,6 +170,7 @@ module Mongo
             max_time_ms: options[:max_time_ms],
             max_value: options[:max_value],
             min_value: options[:min_value],
+            no_cursor_timeout: options[:no_cursor_timeout],
             return_key: options[:return_key],
             show_disk_loc: options[:show_disk_loc],
             comment: options[:comment],

data/lib/mongo/collection/view/readable.rb

@@ -58,6 +58,7 @@ module Mongo
         #
         # @since 2.0.0
         def aggregate(pipeline, options = {})
+          options = @options.merge(options) unless Mongo.broken_view_options
           aggregation = Aggregation.new(self, pipeline, options)
 
           # Because the $merge and $out pipeline stages write documents to the
@@ -167,6 +168,7 @@ module Mongo
         #     * $near should be replaced with $geoWithin with $center
         #     * $nearSphere should be replaced with $geoWithin with $centerSphere
         def count(opts = {})
+          opts = @options.merge(opts) unless Mongo.broken_view_options
           cmd = { :count => collection.name, :query => filter }
           cmd[:skip] = opts[:skip] if opts[:skip]
           cmd[:hint] = opts[:hint] if opts[:hint]
@@ -219,12 +221,13 @@ module Mongo
         #
         # @since 2.6.0
         def count_documents(opts = {})
+          opts = @options.merge(opts) unless Mongo.broken_view_options
           pipeline = [:'$match' => filter]
           pipeline << { :'$skip' => opts[:skip] } if opts[:skip]
           pipeline << { :'$limit' => opts[:limit] } if opts[:limit]
           pipeline << { :'$group' => { _id: 1, n: { :'$sum' => 1 } } }
 
-          opts = opts.select { |k, _| [:hint, :max_time_ms, :read, :collation, :session, :comment].include?(k) }
+          opts = opts.slice(:hint, :max_time_ms, :read, :collation, :session, :comment)
           opts[:collation] ||= collation
 
           first = aggregate(pipeline, opts).first
@@ -254,11 +257,12 @@ module Mongo
           end
 
           %i[limit skip].each do |opt|
-            if @options.key?(opt)
+            if options.key?(opt) || opts.key?(opt)
               raise ArgumentError, "Cannot call estimated_document_count when querying with #{opt}"
             end
           end
 
+          opts = @options.merge(opts) unless Mongo.broken_view_options
           Mongo::Lint.validate_underscore_read_preference(opts[:read])
           read_pref = opts[:read] || read_preference
           selector = ServerSelector.get(read_pref || server_selector)
@@ -305,6 +309,8 @@ module Mongo
         #   command to run.
         # @option opts [ Hash ] :read The read preference options.
         # @option opts [ Hash ] :collation The collation to use.
+        # @option options [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         #
         # @return [ Array<Object> ] The list of distinct values.
         #
@@ -313,9 +319,10 @@ module Mongo
           if field_name.nil?
             raise ArgumentError, 'Field name for distinct operation must be not nil'
           end
+          opts = @options.merge(opts) unless Mongo.broken_view_options
           cmd = { :distinct => collection.name,
                   :key => field_name.to_s,
-                  :query => filter }
+                  :query => filter, }
           cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
           if read_concern
             cmd[:readConcern] = Options::Mapper.transform_values_to_strings(
@@ -332,6 +339,7 @@ module Mongo
                 options: {:limit => -1},
                 read: read_pref,
                 session: session,
+                comment: opts[:comment],
                 # For some reason collation was historically accepted as a
                 # string key. Note that this isn't documented as valid usage.
                 collation: opts[:collation] || opts['collation'] || collation,

data/lib/mongo/collection.rb

@@ -72,6 +72,7 @@ module Mongo
       :change_stream_pre_and_post_images => :changeStreamPreAndPostImages,
       :encrypted_fields => :encryptedFields,
       :validator => :validator,
+      :view_on => :viewOn
     }
 
     # Check if a collection is equal to another object. Will check the name and
@@ -482,6 +483,11 @@ module Mongo
     #   Only recognized by server versions 4.0+.
     # @option options [ Object ] :comment A user-provided
     #   comment to attach to this command.
+    # @option options [ Boolean ] :show_expanded_events Enables the server to
+    #   send the 'expanded' list of change stream events. The list of additional
+    #   events included with this flag set are: createIndexes, dropIndexes,
+    #   modify, create, shardCollection, reshardCollection,
+    #   refineCollectionShardKey.
     #
     # @note A change stream only allows 'majority' read concern.
     # @note This helper method is preferable to running a raw aggregation with
@@ -491,7 +497,9 @@ module Mongo
     #
     # @since 2.5.0
     def watch(pipeline = [], options = {})
-      View::ChangeStream.new(View.new(self, {}, options), pipeline, nil, options)
+      view_options = options.dup
+      view_options[:await_data] = true if options[:max_await_time_ms]
+      View::ChangeStream.new(View.new(self, {}, view_options), pipeline, nil, options)
     end
 
     # Gets an estimated number of matching documents in the collection.

data/lib/mongo/config.rb

@@ -13,6 +13,17 @@ module Mongo
     extend Options
     extend self
 
+    # When this flag is off, an aggregation done on a view will be executed over
+    # the documents included in that view, instead of all documents in the
+    # collection. When this flag is on, the view fiter is ignored.
+    option :broken_view_aggregate, default: true
+
+    # When this flag is set to false, the view options will be correctly
+    # propagated to readable methods.
+    option :broken_view_options, default: true
+
+    # When this flag is set to true, the update and replace methods will
+    # validate the paramters and raise an error if they are invalid.
     option :validate_update_replace, default: false
 
     # Set the configuration options.

data/lib/mongo/crypt/auto_encrypter.rb

@@ -57,7 +57,10 @@ module Mongo
       # @option options [ String ] :key_vault_namespace The namespace of the key
       #   vault in the format database.collection.
       # @option options [ Hash | nil ] :schema_map The JSONSchema of the collection(s)
-      #   with encrypted fields.
+      #   with encrypted fields. This option is mutually exclusive with :schema_map_path.
+      # @option options [ String | nil ] :schema_map_path A path to a file contains the JSON schema
+      #   of the collection that stores auto encrypted documents. This option is
+      #   mutually exclusive with :schema_map.
       # @option options [ Boolean | nil ] :bypass_auto_encryption When true, disables
       #   auto-encryption. Default is false.
       # @option options [ Hash | nil ] :extra_options Options related to spawning
@@ -82,12 +85,15 @@ module Mongo
       # @raise [ ArgumentError ] If required options are missing or incorrectly
       #   formatted.
       def initialize(options)
+        # Note that this call may eventually, via other method invocations,
+        # create additional clients which have to be cleaned up.
         @options = set_default_options(options).freeze
 
         @crypt_handle = Crypt::Handle.new(
           Crypt::KMS::Credentials.new(@options[:kms_providers]),
           Crypt::KMS::Validations.validate_tls_options(@options[:kms_tls_options]),
           schema_map: @options[:schema_map],
+          schema_map_path: @options[:schema_map_path],
           encrypted_fields_map: @options[:encrypted_fields_map],
           bypass_query_analysis: @options[:bypass_query_analysis]
         )
@@ -119,6 +125,30 @@ module Mongo
           end
           raise
         end
+      rescue
+        if @key_vault_client && @key_vault_client != options[:client] &&
+          @key_vault_client.cluster != options[:client].cluster
+        then
+          begin
+            @key_vault_client.close
+          rescue => e
+            log_warn("Error closing key vault client in auto encrypter's constructor: #{e.class}: #{e}")
+            # Drop this exception so that the original exception is raised
+          end
+        end
+
+        if @metadata_client && @metadata_client != options[:client] &&
+          @metadata_client.cluster != options[:client].cluster
+        then
+          begin
+            @metadata_client.close
+          rescue => e
+            log_warn("Error closing metadata client in auto encrypter's constructor: #{e.class}: #{e}")
+            # Drop this exception so that the original exception is raised
+          end
+        end
+
+        raise
       end
 
       # Whether this encrypter should perform encryption (returns false if
@@ -164,6 +194,18 @@ module Mongo
       def close
         @mongocryptd_client.close if @mongocryptd_client
 
+        if @key_vault_client && @key_vault_client != options[:client] &&
+          @key_vault_client.cluster != options[:client].cluster
+        then
+          @key_vault_client.close
+        end
+
+        if @metadata_client && @metadata_client != options[:client] &&
+          @metadata_client.cluster != options[:client].cluster
+        then
+          @metadata_client.close
+        end
+
         true
       end
 
@@ -206,26 +248,16 @@ module Mongo
         client = options[:client]
         @key_vault_client = if options[:key_vault_client]
           options[:key_vault_client]
-        # https://jira.mongodb.org/browse/RUBY-3010
-        # https://jira.mongodb.org/browse/RUBY-3011
-        # Specification requires to use existing client when connection pool
-        # size is unlimited (0). Ruby driver does not support unlimited pool
-        # size.
-        # elsif client.options[:max_pool_size] == 0
-        #   client
+        elsif client.options[:max_pool_size] == 0
+          client
         else
           internal_client(client)
         end
 
         @metadata_client = if options[:bypass_auto_encryption]
           nil
-        # Specification requires to use existing client when connection pool
-        # size is unlimited (0). Ruby driver does not support unlimited pool
-        # size.
-        # https://jira.mongodb.org/browse/RUBY-3010
-        # https://jira.mongodb.org/browse/RUBY-3011
-        # elsif client.options[:max_pool_size] == 0
-        #   client
+        elsif client.options[:max_pool_size] == 0
+          client
         else
           internal_client(client)
         end
@@ -242,12 +274,8 @@ module Mongo
       def internal_client(client)
         @internal_client ||= client.with(
           auto_encryption_options: nil,
-          # Specification requires that the internal client's connection pool
-          # size is unlimited (0). Ruby driver does not support unlimited pool
-          # size.
-          # https://jira.mongodb.org/browse/RUBY-3010
-          # https://jira.mongodb.org/browse/RUBY-3011
-          # max_pool_size: 0
+          min_pool_size: 0,
+          monitoring: client.send(:monitoring),
         )
       end
     end