mongo 2.22.0 → 2.24.0

data/lib/mongo/collection.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -21,7 +20,6 @@ require 'mongo/collection/helpers'
 require 'mongo/collection/queryable_encryption'
 
 module Mongo
-
   # Represents a collection in the database and operations that can directly be
   # applied to one.
   #
@@ -35,12 +33,12 @@ module Mongo
     # The capped option.
     #
     # @since 2.1.0
-    CAPPED = 'capped'.freeze
+    CAPPED = 'capped'
 
     # The ns field constant.
     #
     # @since 2.1.0
-    NS = 'ns'.freeze
+    NS = 'ns'
 
     # @return [ Mongo::Database ] The database the collection resides in.
     attr_reader :database
@@ -57,22 +55,24 @@ module Mongo
     # Delegate to the cluster for the next primary.
     def_delegators :cluster, :next_primary
 
+    def_delegators :client, :tracer
+
     # Options that can be updated on a new Collection instance via the #with method.
     #
     # @since 2.1.0
-    CHANGEABLE_OPTIONS = [ :read, :read_concern, :write, :write_concern ].freeze
+    CHANGEABLE_OPTIONS = %i[read read_concern write write_concern].freeze
 
     # Options map to transform create collection options.
     #
     # @api private
     CREATE_COLLECTION_OPTIONS = {
-      :time_series => :timeseries,
-      :expire_after => :expireAfterSeconds,
-      :clustered_index => :clusteredIndex,
-      :change_stream_pre_and_post_images => :changeStreamPreAndPostImages,
-      :encrypted_fields => :encryptedFields,
-      :validator => :validator,
-      :view_on => :viewOn
+      time_series: :timeseries,
+      expire_after: :expireAfterSeconds,
+      clustered_index: :clusteredIndex,
+      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
@@ -88,6 +88,7 @@ module Mongo
     # @since 2.0.0
     def ==(other)
       return false unless other.is_a?(Collection)
+
       name == other.name && database == other.database && options == other.options
     end
 
@@ -164,17 +165,17 @@ module Mongo
       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
+
       @database = database
       @name = name.to_s.freeze
       @options = options.dup
       @timeout_ms = options.delete(:timeout_ms)
-=begin WriteConcern object support
-      if @options[:write_concern].is_a?(WriteConcern::Base)
-        # Cache the instance so that we do not needlessly reconstruct it.
-        @write_concern = @options[:write_concern]
-        @options[:write_concern] = @write_concern.options
-      end
-=end
+      # WriteConcern object support
+      #       if @options[:write_concern].is_a?(WriteConcern::Base)
+      #         # Cache the instance so that we do not needlessly reconstruct it.
+      #         @write_concern = @options[:write_concern]
+      #         @options[:write_concern] = @write_concern.options
+      #       end
       @options.freeze
     end
 
@@ -236,7 +237,8 @@ module Mongo
     # @since 2.0.0
     def write_concern
       @write_concern ||= WriteConcern.get(
-        options[:write_concern] || options[:write] || database.write_concern)
+        options[:write_concern] || options[:write] || database.write_concern
+      )
     end
 
     # Get the write concern to use for an operation on this collection,
@@ -252,12 +254,10 @@ module Mongo
     # @api private
     def write_concern_with_session(session)
       wc = write_concern
-      if session && session.in_transaction?
-        if wc && !wc.acknowledged?
-          opts = wc.options.dup
-          opts.delete(:w)
-          return WriteConcern.get(opts)
-        end
+      if session && session.in_transaction? && wc && !wc.acknowledged?
+        opts = wc.options.dup
+        opts.delete(:w)
+        return WriteConcern.get(opts)
       end
       wc
     end
@@ -301,12 +301,8 @@ module Mongo
         raise Error::UnchangeableCollectionOption.new(k) unless CHANGEABLE_OPTIONS.include?(k)
       end
       options = @options.dup
-      if options[:write] && new_options[:write_concern]
-        options.delete(:write)
-      end
-      if options[:write_concern] && new_options[:write]
-        options.delete(:write_concern)
-      end
+      options.delete(:write) if options[:write] && new_options[:write_concern]
+      options.delete(:write_concern) if options[:write_concern] && new_options[:write]
       Collection.new(database, name, options.update(new_options))
     end
 
@@ -320,8 +316,8 @@ module Mongo
     # @since 2.0.0
     def capped?
       database.list_collections(filter: { name: name })
-        .first
-        &.dig('options', CAPPED) || false
+              .first
+              &.dig('options', CAPPED) || false
     end
 
     # Force the collection to be created in the database.
@@ -387,44 +383,45 @@ module Mongo
       # serialization.
       # TODO put the list of read options in a class-level constant when
       # we figure out what the full set of them is.
-      options = Hash[self.options.merge(opts).reject do |key, value|
-        %w(read read_preference read_concern session).include?(key.to_s)
+      options = Hash[self.options.merge(opts).reject do |key, _value|
+        %w[read read_preference read_concern session].include?(key.to_s)
       end]
       # Converting Ruby options to server style.
       CREATE_COLLECTION_OPTIONS.each do |ruby_key, server_key|
-        if options.key?(ruby_key)
-          options[server_key] = options.delete(ruby_key)
-        end
+        options[server_key] = options.delete(ruby_key) if options.key?(ruby_key)
       end
-      operation = { :create => name }.merge(options)
+      operation = { create: name }.merge(options)
       operation.delete(:write)
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
         write_concern = if opts[:write_concern]
-          WriteConcern.get(opts[:write_concern])
-        else
-          self.write_concern
-        end
+                          WriteConcern.get(opts[:write_concern])
+                        else
+                          self.write_concern
+                        end
 
         context = Operation::Context.new(
           client: client,
           session: session
         )
-        maybe_create_qe_collections(opts[:encrypted_fields], client, session) do |encrypted_fields|
-          Operation::Create.new(
-            selector: operation,
-            db_name: database.name,
-            write_concern: write_concern,
-            session: session,
-            # Note that these are collection options, collation isn't
-            # taken from options passed to the create method.
-            collation: options[:collation] || options['collation'],
-            encrypted_fields: encrypted_fields,
-            validator: options[:validator],
-          ).execute(
-            next_primary(nil, session),
-            context: context
-          )
+        operation = Operation::Create.new(
+          selector: operation,
+          db_name: database.name,
+          write_concern: write_concern,
+          session: session,
+          # Note that these are collection options, collation isn't
+          # taken from options passed to the create method.
+          collation: options[:collation] || options['collation'],
+          validator: options[:validator]
+        )
+        tracer.trace_operation(operation, context, op_name: 'createCollection') do
+          maybe_create_qe_collections(opts[:encrypted_fields], client, session) do |encrypted_fields|
+            operation.encrypted_fields = encrypted_fields
+            operation.execute(
+              next_primary(nil, session),
+              context: context
+            )
+          end
         end
       end
     end
@@ -453,25 +450,27 @@ module Mongo
     # @since 2.0.0
     def drop(opts = {})
       client.with_session(opts) do |session|
-        maybe_drop_emm_collections(opts[:encrypted_fields], client, session) do
-          temp_write_concern = write_concern
-          write_concern = if opts[:write_concern]
-            WriteConcern.get(opts[:write_concern])
-          else
-            temp_write_concern
+        context = Operation::Context.new(
+          client: client,
+          session: session,
+          operation_timeouts: operation_timeouts(opts)
+        )
+        temp_write_concern = write_concern
+        write_concern = if opts[:write_concern]
+                          WriteConcern.get(opts[:write_concern])
+                        else
+                          temp_write_concern
+                        end
+        operation = Operation::Drop.new({
+                                          selector: { drop: name },
+                                          db_name: database.name,
+                                          write_concern: write_concern,
+                                          session: session,
+                                        })
+        tracer.trace_operation(operation, context, op_name: 'dropCollection') do
+          maybe_drop_emm_collections(opts[:encrypted_fields], client, session) do
+            do_drop(operation, session, context)
           end
-          context = Operation::Context.new(
-            client: client,
-            session: session,
-            operation_timeouts: operation_timeouts(opts)
-          )
-          operation = Operation::Drop.new({
-            selector: { :drop => name },
-            db_name: database.name,
-            write_concern: write_concern,
-            session: session,
-          })
-          do_drop(operation, session, context)
         end
       end
     end
@@ -569,10 +568,8 @@ module Mongo
       View.new(self, {}, options).aggregate(pipeline, options)
     end
 
-    # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline
-    # stage is supported in the aggregation framework. This stage allows users
-    # to request that notifications are sent for all changes to a particular
-    # collection.
+    # Allows users to request that notifications are sent for all changes
+    # to a particular collection.
     #
     # @example Get change notifications for a given collection.
     #   collection.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])
@@ -620,7 +617,6 @@ module Mongo
     # @option options [ BSON::Timestamp ] :start_at_operation_time Only return
     #   changes that occurred at or after the specified timestamp. Any command run
     #   against the server will return a cluster time that can be used here.
-    #   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
@@ -679,7 +675,7 @@ module Mongo
     #
     # @deprecated Use #count_documents or estimated_document_count instead. However, note that the
     #   following operators will need to be substituted when switching to #count_documents:
-    #     * $where should be replaced with $expr (only works on 3.6+)
+    #     * $where should be replaced with $expr
     #     * $near should be replaced with $geoWithin with $center
     #     * $nearSphere should be replaced with $geoWithin with $centerSphere
     def count(filter = nil, options = {})
@@ -699,7 +695,7 @@ module Mongo
     #
     # @option options :skip [ Integer ] The number of documents to skip.
     # @option options :hint [ Hash ] Override default index selection and force
-    #   MongoDB to use a specific index for the query. Requires server version 3.6+.
+    #   MongoDB to use a specific index for the query.
     # @option options :limit [ Integer ] Max number of docs to count.
     # @option options :max_time_ms [ Integer ] The maximum amount of time to allow the
     #   command to run.
@@ -851,33 +847,34 @@ module Mongo
 
       client.with_session(opts) do |session|
         write_concern = if opts[:write_concern]
-          WriteConcern.get(opts[:write_concern])
-        else
-          write_concern_with_session(session)
-        end
+                          WriteConcern.get(opts[:write_concern])
+                        else
+                          write_concern_with_session(session)
+                        end
 
-        if document.nil?
-          raise ArgumentError, "Document to be inserted cannot be nil"
-        end
+        raise ArgumentError, 'Document to be inserted cannot be nil' if document.nil?
 
         context = Operation::Context.new(
           client: client,
           session: session,
           operation_timeouts: operation_timeouts(opts)
-          )
-        write_with_retry(write_concern, context: context) do |connection, txn_num, context|
-          Operation::Insert.new(
-            :documents => [ document ],
-            :db_name => database.name,
-            :coll_name => name,
-            :write_concern => write_concern,
-            :bypass_document_validation => !!opts[:bypass_document_validation],
-            :options => opts,
-            :id_generator => client.options[:id_generator],
-            :session => session,
-            :txn_num => txn_num,
-            :comment => opts[:comment]
-          ).execute_with_connection(connection, context: context)
+        )
+        operation = Operation::Insert.new(
+          documents: [ document ],
+          db_name: database.name,
+          coll_name: name,
+          write_concern: write_concern,
+          bypass_document_validation: !!opts[:bypass_document_validation],
+          options: opts,
+          id_generator: client.options[:id_generator],
+          session: session,
+          comment: opts[:comment]
+        )
+        tracer.trace_operation(operation, context) do
+          write_with_retry(write_concern, context: context) do |connection, txn_num, context|
+            operation.txn_num = txn_num
+            operation.execute_with_connection(connection, context: context)
+          end
         end
       end
     end
@@ -910,7 +907,7 @@ module Mongo
     def insert_many(documents, options = {})
       QueryCache.clear_namespace(namespace)
 
-      inserts = documents.map{ |doc| { :insert_one => doc }}
+      inserts = documents.map { |doc| { insert_one: doc } }
       bulk_write(inserts, options)
     end
 

data/lib/mongo/condition_variable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -32,6 +31,7 @@ module Mongo
     def wait(timeout = nil)
       raise_unless_locked!
       return false if timeout && timeout < 0
+
       @cv.wait(@lock, timeout)
     end
 
@@ -50,9 +50,9 @@ module Mongo
     private
 
     def raise_unless_locked!
-      unless @lock.owned?
-        raise ArgumentError, "the lock must be owned when calling this method"
-      end
+      return if @lock.owned?
+
+      raise ArgumentError, 'the lock must be owned when calling this method'
     end
   end
 end

data/lib/mongo/config/options.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongo
   module Config
-
     # Encapsulates logic for setting options.
     module Options
-
       # Get the defaults or initialize a new empty hash.
       #
       # @return [ Hash ] The default options.

data/lib/mongo/config/validators/option.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongo
   module Config
     module Validators
-
       # Validator for configuration options.
       #
       # @api private
@@ -17,9 +15,9 @@ module Mongo
         #
         # @param [ String ] option The name of the option.
         def validate(option)
-          unless Config.settings.keys.include?(option.to_sym)
-            raise Mongo::Error::InvalidConfigOption.new(option)
-          end
+          return if Config.settings.keys.include?(option.to_sym)
+
+          raise Mongo::Error::InvalidConfigOption.new(option)
         end
       end
     end

data/lib/mongo/config.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongo/config/options"
-require "mongo/config/validators/option"
+require 'mongo/config/options'
+require 'mongo/config/validators/option'
 
 module Mongo
-
   # This module defines configuration options for Mongo.
   #
   # @api private
@@ -27,6 +25,10 @@ module Mongo
     # validate the parameters and raise an error if they are invalid.
     option :validate_update_replace, default: false
 
+    # When this flag is set to true, the CSFLE will use Ruby types for
+    # decryption instead of BSON types.
+    option :csfle_convert_to_ruby_types, default: false
+
     # Set the configuration options.
     #
     # @example Set the options.

data/lib/mongo/crypt/auto_decryption_context.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   module Crypt
-
     # A Context object initialized for auto decryption
     #
     # @api private
     class AutoDecryptionContext < Context
-
       # Create a new AutoEncryptionContext object
       #
       # @param [ Mongo::Crypt::Handle ] mongocrypt a Handle that
@@ -38,6 +35,15 @@ module Mongo
 
         Binding.ctx_decrypt_init(self, @command)
       end
+
+      # Which BSON mode to use when creating documents from the outcome of
+      # the state machine. The returned value is based on the
+      # +Mongo::Config.csfle_convert_to_ruby_types+ option.
+      #
+      # @return [ Symbol, nil ] The BSON mode.
+      def bson_mode
+        Mongo::Config.csfle_convert_to_ruby_types ? nil : :bson
+      end
     end
   end
 end

data/lib/mongo/crypt/auto_encrypter.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,8 +16,7 @@
 
 module Mongo
   module Crypt
-
-    # An AutoEcnrypter is an object that encapsulates the behavior of
+    # An AutoEncrypter is an object that encapsulates the behavior of
     # automatic encryption. It controls all resources associated with
     # auto-encryption, including the libmongocrypt handle, key vault client
     # object, mongocryptd client object, and encryption I/O.
@@ -29,19 +27,15 @@ module Mongo
     #
     # @api private
     class AutoEncrypter
-
-      attr_reader :mongocryptd_client
-      attr_reader :key_vault_client
-      attr_reader :metadata_client
-      attr_reader :options
+      attr_reader :mongocryptd_client, :key_vault_client, :metadata_client, :options
 
       # A Hash of default values for the :extra_options option
       DEFAULT_EXTRA_OPTIONS = Options::Redacted.new({
-        mongocryptd_uri: 'mongodb://localhost:27020',
-        mongocryptd_bypass_spawn: false,
-        mongocryptd_spawn_path: 'mongocryptd',
-        mongocryptd_spawn_args: ['--idleShutdownTimeoutSecs=60'],
-      })
+                                                      mongocryptd_uri: 'mongodb://localhost:27020',
+                                                      mongocryptd_bypass_spawn: false,
+                                                      mongocryptd_spawn_path: 'mongocryptd',
+                                                      mongocryptd_spawn_args: [ '--idleShutdownTimeoutSecs=60' ],
+                                                    })
 
       # Set up encryption-related options and instance variables
       # on the class that includes this module. Calls the same method
@@ -105,6 +99,7 @@ module Mongo
           bypass_query_analysis: @options[:bypass_query_analysis],
           crypt_shared_lib_path: @options[:extra_options][:crypt_shared_lib_path],
           crypt_shared_lib_required: @options[:extra_options][:crypt_shared_lib_required],
+          disable_crypt_shared_lib_search: @options[:extra_options][:disable_crypt_shared_lib_search]
         )
 
         @mongocryptd_options = @options[:extra_options].slice(
@@ -114,9 +109,9 @@ module Mongo
           :mongocryptd_spawn_args
         )
         @mongocryptd_options[:mongocryptd_bypass_spawn] = @options[:bypass_auto_encryption] ||
-          @options[:extra_options][:mongocryptd_bypass_spawn] ||
-          @crypt_handle.crypt_shared_lib_available? ||
-          @options[:extra_options][:crypt_shared_lib_required]
+                                                          @options[:extra_options][:mongocryptd_bypass_spawn] ||
+                                                          @crypt_handle.crypt_shared_lib_available? ||
+                                                          @options[:extra_options][:crypt_shared_lib_required]
 
         unless @options[:extra_options][:crypt_shared_lib_required] || @crypt_handle.crypt_shared_lib_available? || @options[:bypass_query_analysis]
           @mongocryptd_client = Client.new(
@@ -137,33 +132,31 @@ module Mongo
             metadata_client: @metadata_client,
             mongocryptd_options: @mongocryptd_options
           )
-        rescue
+        rescue StandardError
           begin
             @mongocryptd_client&.close
-          rescue => e
+          rescue StandardError => e
             log_warn("Error closing mongocryptd client in auto encrypter's constructor: #{e.class}: #{e}")
             # Drop this exception so that the original exception is raised
           end
           raise
         end
-      rescue
+      rescue StandardError
         if @key_vault_client && @key_vault_client != options[:client] &&
-          @key_vault_client.cluster != options[:client].cluster
-        then
+           @key_vault_client.cluster != options[:client].cluster
           begin
             @key_vault_client.close
-          rescue => e
+          rescue StandardError => 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
+           @metadata_client.cluster != options[:client].cluster
           begin
             @metadata_client.close
-          rescue => e
+          rescue StandardError => 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
@@ -216,14 +209,12 @@ module Mongo
         @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.cluster != options[:client].cluster
           @key_vault_client.close
         end
 
         if @metadata_client && @metadata_client != options[:client] &&
-          @metadata_client.cluster != options[:client].cluster
-        then
+           @metadata_client.cluster != options[:client].cluster
           @metadata_client.close
         end
 
@@ -234,7 +225,7 @@ module Mongo
 
       # Returns a new set of options with the following changes:
       # - sets default values for all extra_options
-      # - adds --idleShtudownTimeoutSecs=60 to extra_options[:mongocryptd_spawn_args]
+      # - adds --idleShutdownTimeoutSecs=60 to extra_options[:mongocryptd_spawn_args]
       #   if not already present
       # - sets bypass_auto_encryption to false
       # - sets default key vault client
@@ -268,20 +259,20 @@ module Mongo
       def set_or_create_clients(options)
         client = options[:client]
         @key_vault_client = if options[:key_vault_client]
-          options[:key_vault_client]
-        elsif client.options[:max_pool_size] == 0
-          client
-        else
-          internal_client(client)
-        end
+                              options[:key_vault_client]
+                            elsif client.options[:max_pool_size] == 0
+                              client
+                            else
+                              internal_client(client)
+                            end
 
         @metadata_client = if options[:bypass_auto_encryption]
-          nil
-        elsif client.options[:max_pool_size] == 0
-          client
-        else
-          internal_client(client)
-        end
+                             nil
+                           elsif client.options[:max_pool_size] == 0
+                             client
+                           else
+                             internal_client(client)
+                           end
       end
 
       # Creates or return already created internal client to be used for
@@ -296,7 +287,7 @@ module Mongo
         @internal_client ||= client.with(
           auto_encryption_options: nil,
           min_pool_size: 0,
-          monitoring: client.send(:monitoring),
+          monitoring: client.send(:monitoring)
         )
       end
     end

data/lib/mongo/crypt/auto_encryption_context.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   module Crypt
-
     # A Context object initialized for auto encryption
     #
     # @api private
     class AutoEncryptionContext < Context
-
       # Create a new AutoEncryptionContext object
       #
       # @param [ Mongo::Crypt::Handle ] mongocrypt a Handle that