mongo 2.22.0 → 2.24.0

data/lib/mongo/database.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 require 'mongo/database/view'
 
 module Mongo
-
   # Represents a database on the db server and operations that can execute on
   # it at this level.
   #
@@ -30,33 +28,33 @@ module Mongo
     # The admin database name.
     #
     # @since 2.0.0
-    ADMIN = 'admin'.freeze
+    ADMIN = 'admin'
 
     # The "collection" that database commands operate against.
     #
     # @since 2.0.0
-    COMMAND = '$cmd'.freeze
+    COMMAND = '$cmd'
 
     # The default database options.
     #
     # @since 2.0.0
-    DEFAULT_OPTIONS = Options::Redacted.new(:database => ADMIN).freeze
+    DEFAULT_OPTIONS = Options::Redacted.new(database: ADMIN).freeze
 
     # Database name field constant.
     #
     # @since 2.1.0
     # @deprecated
-    NAME = 'name'.freeze
+    NAME = 'name'
 
     # Databases constant.
     #
     # @since 2.1.0
-    DATABASES = 'databases'.freeze
+    DATABASES = 'databases'
 
     # The name of the collection that holds all the collection names.
     #
     # @since 2.0.0
-    NAMESPACES = 'system.namespaces'.freeze
+    NAMESPACES = 'system.namespaces'
 
     # @return [ Client ] client The database client.
     attr_reader :client
@@ -74,7 +72,8 @@ module Mongo
                    :server_selector,
                    :read_concern,
                    :write_concern,
-                   :encrypted_fields_map
+                   :encrypted_fields_map,
+                   :tracer
 
     # @return [ Mongo::Server ] Get the primary server from the cluster.
     def_delegators :cluster,
@@ -93,6 +92,7 @@ module Mongo
     # @since 2.0.0
     def ==(other)
       return false unless other.is_a?(Database)
+
       name == other.name
     end
 
@@ -109,11 +109,13 @@ module Mongo
     # @since 2.0.0
     def [](collection_name, options = {})
       if options[:server_api]
-        raise ArgumentError, 'The :server_api option cannot be specified for collection objects. It can only be specified on Client level'
+        raise ArgumentError,
+              'The :server_api option cannot be specified for collection objects. It can only be specified on Client level'
       end
+
       Collection.new(self, collection_name, options)
     end
-    alias_method :collection, :[]
+    alias collection []
 
     # Get all the names of the non-system collections in the database.
     #
@@ -222,7 +224,7 @@ module Mongo
     #   executes this command. This is an internal option and is subject to
     #   change.
     #   - :deserialize_as_bson [ Boolean ] Whether to deserialize the response
-    #     to this command using BSON types intead of native Ruby types wherever
+    #     to this command using BSON types instead of native Ruby types wherever
     #     possible.
     #
     # @return [ Mongo::Operation::Result ] The result of the command execution.
@@ -230,31 +232,30 @@ module Mongo
       opts = opts.dup
       execution_opts = opts.delete(:execution_options) || {}
 
-      txn_read_pref = if opts[:session] && opts[:session].in_transaction?
-        opts[:session].txn_read_preference
-      else
-        nil
-      end
+      txn_read_pref = (opts[:session].txn_read_preference if opts[:session] && opts[:session].in_transaction?)
       txn_read_pref ||= opts[:read] || ServerSelector::PRIMARY
       Lint.validate_underscore_read_preference(txn_read_pref)
       selector = ServerSelector.get(txn_read_pref)
 
       client.with_session(opts) do |session|
-        server = selector.select_server(cluster, nil, session)
+        context = Operation::Context.new(
+          client: client,
+          session: session,
+          operation_timeouts: operation_timeouts(opts)
+        )
         op = Operation::Command.new(
-          :selector => operation,
-          :db_name => name,
-          :read => selector,
-          :session => session
+          selector: operation,
+          db_name: name,
+          read: selector,
+          session: session
         )
 
-        op.execute(server,
-          context: Operation::Context.new(
-            client: client,
-            session: session,
-            operation_timeouts: operation_timeouts(opts)
-          ),
-          options: execution_opts)
+        retry_enabled = client.options[:retry_reads] != false &&
+                        client.options[:retry_writes] != false
+        with_overload_retry(context: context, retry_enabled: retry_enabled) do
+          server = selector.select_server(cluster, nil, session)
+          op.execute(server, context: context, options: execution_opts)
+        end
       end
     end
 
@@ -267,19 +268,17 @@ module Mongo
     # @option opts :session [ Session ] The session to use for this command.
     # @option opts [ Object ] :comment A user-provided
     #   comment to attach to this command.
-    # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+    # @option opts [ Integer ] :timeout_ms The operation timeout in milliseconds.
     #    Must be a non-negative integer. An explicit value of 0 means infinite.
     #    The default value is unset which means the value is inherited from
     #    the database or the client.
+    # @option opts :op_name [ String | nil ] The name of the operation for
+    #    tracing purposes.
     #
     # @return [ Hash ] The result of the command execution.
     # @api private
     def read_command(operation, opts = {})
-      txn_read_pref = if opts[:session] && opts[:session].in_transaction?
-        opts[:session].txn_read_preference
-      else
-        nil
-      end
+      txn_read_pref = (opts[:session].txn_read_preference if opts[:session] && opts[:session].in_transaction?)
       txn_read_pref ||= opts[:read] || ServerSelector::PRIMARY
       Lint.validate_underscore_read_preference(txn_read_pref)
       preference = ServerSelector.get(txn_read_pref)
@@ -290,14 +289,18 @@ module Mongo
           session: session,
           operation_timeouts: operation_timeouts(opts)
         )
-        read_with_retry(session, preference, context) do |server|
-          Operation::Command.new(
-            selector: operation.dup,
-            db_name: name,
-            read: preference,
-            session: session,
-            comment: opts[:comment],
-          ).execute(server, context: context)
+        operation = Operation::Command.new(
+          selector: operation.dup,
+          db_name: name,
+          read: preference,
+          session: session,
+          comment: opts[:comment]
+        )
+        op_name = opts[:op_name] || 'command'
+        tracer.trace_operation(operation, context, op_name: op_name) do
+          read_with_retry(session, preference, context) do |server|
+            operation.execute(server, context: context)
+          end
         end
       end
     end
@@ -320,26 +323,26 @@ module Mongo
     #
     # @since 2.0.0
     def drop(options = {})
-      operation = { :dropDatabase => 1 }
+      operation = { dropDatabase: 1 }
       client.with_session(options) do |session|
         write_concern = if options[:write_concern]
-          WriteConcern.get(options[:write_concern])
-        else
-          self.write_concern
-        end
+                          WriteConcern.get(options[:write_concern])
+                        else
+                          self.write_concern
+                        end
         Operation::DropDatabase.new({
-          selector: operation,
-          db_name: name,
-          write_concern: write_concern,
-          session: session
-        }).execute(
-          next_primary(nil, session),
-          context: Operation::Context.new(
-            client: client,
-            session: session,
-            operation_timeouts: operation_timeouts(options)
-          )
-        )
+                                      selector: operation,
+                                      db_name: name,
+                                      write_concern: write_concern,
+                                      session: session
+                                    }).execute(
+                                      next_primary(nil, session),
+                                      context: Operation::Context.new(
+                                        client: client,
+                                        session: session,
+                                        operation_timeouts: operation_timeouts(options)
+                                      )
+                                    )
       end
     end
 
@@ -364,6 +367,7 @@ module Mongo
       if Lint.enabled? && !(name.is_a?(String) || name.is_a?(Symbol))
         raise "Database name must be a string or a symbol: #{name}"
       end
+
       @client = client
       @name = name.to_s.freeze
       @options = options.freeze
@@ -451,9 +455,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. As of version 4.0, this stage allows users to request that
-    # notifications are sent for all changes that occur in the client's database.
+    # Allows users to request that notifications are sent for all changes that
+    # occur in the client's database.
     #
     # @example Get change notifications for a given database..
     #  database.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])
@@ -500,7 +503,6 @@ module Mongo
     # @option options [ BSON::Timestamp ] :start_at_operation_time Only return
     #   changes that occurred 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
@@ -524,7 +526,8 @@ module Mongo
         Mongo::Collection::View.new(collection("#{COMMAND}.aggregate"), {}, view_options),
         pipeline,
         Mongo::Collection::View::ChangeStream::DATABASE,
-        options)
+        options
+      )
     end
 
     # Create a database for the provided client, for use when we don't want the

data/lib/mongo/dbref.rb

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

data/lib/mongo/deprecations.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'mongo/loggable'
+
+module Mongo
+  # Used for reporting deprecated behavior in the driver. When it is possible
+  # to detect that a deprecated feature is being used, a warning should be issued
+  # through this module.
+  #
+  # The warning will be issued no more than once for that feature, regardless
+  # of how many times Mongo::Deprecations.warn is called.
+  #
+  # @example Issue a deprecation warning.
+  #   Mongo::Deprecations.warn(:old_feature, "The old_feature is deprecated, use new_feature instead.")
+  #
+  # @api private
+  module Deprecations
+    extend self
+    extend Mongo::Loggable
+
+    # Mutex for synchronizing access to warned features.
+    # @api private
+    MUTEX = Thread::Mutex.new
+
+    # Issue a warning about a deprecated feature. The warning is written to the
+    # logger, and will not be written more than once per feature.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    # @param [ String ] message The deprecation message.
+    def warn(feature, message)
+      MUTEX.synchronize do
+        return if _warned?(feature)
+
+        _warned!(feature)
+        log_warn("[DEPRECATION:#{feature}] #{message}")
+      end
+    end
+
+    # Check if a warning for a given deprecated feature has already been issued.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    # @param [ true | false ] prefix Whether to check for prefix matches.
+    #
+    # @return [ true | false ] If a warning has already been issued.
+    def warned?(feature, prefix: false)
+      MUTEX.synchronize { _warned?(feature, prefix: prefix) }
+    end
+
+    # Mark that a warning for a given deprecated feature has been issued.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    def warned!(feature)
+      MUTEX.synchronize { _warned!(feature) }
+      nil
+    end
+
+    # Clears all memory of previously warned features.
+    def clear!
+      MUTEX.synchronize { warned_features reset: true }
+      nil
+    end
+
+    private
+
+    # Set of features that have already been warned about.
+    #
+    # @param [ true | false ] reset Whether to reset the warned features.
+    #
+    # @return [ Set<String> ] The set of warned features.
+    def warned_features(reset: false)
+      @warned_features = nil if reset
+      @warned_features ||= Set.new
+    end
+
+    # Check if a warning for a given deprecated feature has already been issued.
+    # This version is not thread-safe.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    # @param [ true | false ] prefix Whether to check for prefix matches.
+    #
+    # @return [ true | false ] If a warning has already been issued.
+    def _warned?(feature, prefix: false)
+      if prefix
+        warned_features.any? { |f| f.to_s.start_with?(feature) }
+      else
+        warned_features.include?(feature.to_s)
+      end
+    end
+
+    # Mark that a warning for a given deprecated feature has been issued.
+    # This version is not thread-safe.
+    #
+    # @param [ String | Symbol ] feature The deprecated feature.
+    def _warned!(feature)
+      warned_features.add(feature.to_s)
+    end
+  end
+end

data/lib/mongo/distinguishing_semaphore.rb

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

data/lib/mongo/error/auth_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when authentication fails.
     #
     # Note: This class is derived from RuntimeError for

data/lib/mongo/error/bad_load_balancer_target.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Raised when the driver is in load-balancing mode but a connection
     # is established to something other than a mongos.
     class BadLoadBalancerTarget < Error

data/lib/mongo/error/bulk_write_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Exception raised if there are write errors upon executing a bulk
     # operation.
     #
@@ -33,7 +31,6 @@ module Mongo
     #
     # @since 2.0.0
     class BulkWriteError < Error
-
       # @return [ BSON::Document ] result The error result.
       attr_reader :result
 
@@ -48,9 +45,11 @@ module Mongo
       # @since 2.0.0
       def initialize(result)
         @result = result
+
         # Exception constructor behaves differently for a nil argument and
         # for no argument. Avoid passing nil explicitly.
-        super(*[build_message])
+        message = build_message
+        message ? super(message) : super()
       end
 
       private
@@ -77,24 +76,22 @@ module Mongo
         errors = @result['writeErrors']
         return nil unless errors
 
-        fragment = ""
+        fragment = ''
         cut_short = false
         errors.first(10).each_with_index do |error, i|
-          fragment += "; " if fragment.length > 0
+          fragment += '; ' if fragment.length > 0
           fragment += "[#{error['code']}]: #{error['errmsg']}"
           fragment += " -- #{error['errInfo'].to_json}" if error['errInfo']
 
           if fragment.length > 3000
-            cut_short = i < [9, errors.length].min
+            cut_short = i < [ 9, errors.length ].min
             break
           end
         end
 
         fragment += '...' if errors.length > 10 || cut_short
 
-        if errors.length > 1
-          fragment = "Multiple errors: #{fragment}"
-        end
+        fragment = "Multiple errors: #{fragment}" if errors.length > 1
 
         fragment
       end

data/lib/mongo/error/change_stream_resumable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # A module signifying the error will always cause change stream to
     # resume once.
     #

data/lib/mongo/error/client_closed.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2022 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     class ClientClosed < Error
     end
   end

data/lib/mongo/error/closed_stream.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Raised if the Grid::FSBucket::Stream object is closed and an operation is attempted.
     #
     # @since 2.1.0
     class ClosedStream < Error
-
       # Create the new exception.
       #
       # @example Create the new exception.
@@ -30,7 +27,7 @@ module Mongo
       #
       # @since 2.1.0
       def initialize
-        super("The stream is closed and cannot be written to or read from.")
+        super('The stream is closed and cannot be written to or read from.')
       end
     end
   end

data/lib/mongo/error/connection_check_out_timeout.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Exception raised when trying to check out a connection from a connection
     # pool, the pool is at its max size and no connections become available
     # within the configured wait timeout.
@@ -27,7 +25,6 @@ module Mongo
     #
     # @since 2.9.0
     class ConnectionCheckOutTimeout < ::Timeout::Error
-
       # @return [ Mongo::Address ] address The address of the server the
       #   pool's connections connect to.
       #
@@ -42,9 +39,9 @@ module Mongo
       def initialize(msg, options)
         super(msg)
         @address = options[:address]
-        unless @address
-          raise ArgumentError, 'Address argument is required'
-        end
+        return if @address
+
+        raise ArgumentError, 'Address argument is required'
       end
     end
   end

data/lib/mongo/error/connection_perished.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Exception raised when trying to perform operations on a connection that
     # experienced a network error.
     class ConnectionPerished < Error

data/lib/mongo/error/connection_unavailable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2022 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Exception raised when trying to check out a connection with a specific
     # global id, and the connection for that global id no longer exists in the
     # pool.

data/lib/mongo/error/credential_check_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # Credential check for MONGODB-AWS authentication mechanism failed.
     #
     # This exception is raised when the driver attempts to verify the

data/lib/mongo/error/crypt_error.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Error
-
     # An error related to client-side encryption.
     class CryptError < Mongo::Error
       # Create a new CryptError

data/lib/mongo/error/extra_file_chunk.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -17,12 +16,10 @@
 
 module Mongo
   class Error
-
     # Raised if an extra chunk is found.
     #
     # @since 2.1.0
     class ExtraFileChunk < Error
-
       # Create the new exception.
       #
       # @example Create the new exception.
@@ -30,7 +27,7 @@ module Mongo
       #
       # @since 2.1.0
       def initialize
-        super("Extra file chunk found.")
+        super('Extra file chunk found.')
       end
     end
   end