mongo 2.22.0 → 2.24.0

data/lib/mongo/index/view.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'mongo/cursor/nontailable'
 
 module Mongo
   module Index
-
     # A class representing a view of indexes.
     #
     # @since 2.0.0
@@ -45,43 +43,44 @@ module Mongo
 
       def_delegators :@collection, :cluster, :database, :read_preference, :write_concern, :client
       def_delegators :cluster, :next_primary
+      def_delegators :client, :tracer
 
       # The index key field.
       #
       # @since 2.0.0
-      KEY = 'key'.freeze
+      KEY = 'key'
 
       # The index name field.
       #
       # @since 2.0.0
-      NAME = 'name'.freeze
+      NAME = 'name'
 
       # The mappings of Ruby index options to server options.
       #
       # @since 2.0.0
       OPTIONS = {
-        :background => :background,
-        :bits => :bits,
-        :bucket_size => :bucketSize,
-        :default_language => :default_language,
-        :expire_after => :expireAfterSeconds,
-        :expire_after_seconds => :expireAfterSeconds,
-        :key => :key,
-        :language_override => :language_override,
-        :max => :max,
-        :min => :min,
-        :name => :name,
-        :partial_filter_expression => :partialFilterExpression,
-        :sparse => :sparse,
-        :sphere_version => :'2dsphereIndexVersion',
-        :storage_engine => :storageEngine,
-        :text_version => :textIndexVersion,
-        :unique => :unique,
-        :version => :v,
-        :weights => :weights,
-        :collation => :collation,
-        :comment => :comment,
-        :wildcard_projection => :wildcardProjection,
+        background: :background,
+        bits: :bits,
+        bucket_size: :bucketSize,
+        default_language: :default_language,
+        expire_after: :expireAfterSeconds,
+        expire_after_seconds: :expireAfterSeconds,
+        key: :key,
+        language_override: :language_override,
+        max: :max,
+        min: :min,
+        name: :name,
+        partial_filter_expression: :partialFilterExpression,
+        sparse: :sparse,
+        sphere_version: :'2dsphereIndexVersion',
+        storage_engine: :storageEngine,
+        text_version: :textIndexVersion,
+        unique: :unique,
+        version: :v,
+        weights: :weights,
+        collation: :collation,
+        comment: :comment,
+        wildcard_projection: :wildcardProjection,
       }.freeze
 
       # Drop an index by its name.
@@ -100,6 +99,7 @@ module Mongo
       # @since 2.0.0
       def drop_one(name, options = {})
         raise Error::MultiIndexDrop.new if name == Index::ALL
+
         drop_by_name(name, options)
       end
 
@@ -131,7 +131,7 @@ module Mongo
       # @option options [ true, false ] :unique (false) If true, this index will enforce
       #   a uniqueness constraint on that field.
       # @option options [ true, false ] :background (false) If true, the index will be built
-      #   in the background (only available for server versions >= 1.3.2 )
+      #   in the background
       # @option options [ true, false ] :drop_dups (false) If creating a unique index on
       #   this collection, this option will keep the first document the database indexes
       #   and drop all subsequent documents with duplicate values on this field.
@@ -171,7 +171,7 @@ module Mongo
         if session = @options[:session]
           create_options[:session] = session
         end
-        %i(commit_quorum session comment timeout_ms max_time_ms).each do |key|
+        %i[commit_quorum session comment timeout_ms max_time_ms].each do |key|
           if value = options.delete(key)
             create_options[key] = value
           end
@@ -194,9 +194,6 @@ module Mongo
       #     { commit_quorum: 'majority' }
       #   )
       #
-      # @note On MongoDB 3.0.0 and higher, the indexes will be created in
-      #   parallel on the server.
-      #
       # @param [ Array<Hash> ] models The index specifications. Each model MUST
       #   include a :key option, except for the last item in the Array, which
       #   may be a Hash specifying options relevant to the createIndexes operation.
@@ -216,17 +213,13 @@ module Mongo
       def create_many(*models)
         models = models.flatten
         options = {}
-        if models && !models.last.key?(:key)
-          options = models.pop
-        end
+        options = models.pop if models && !models.last.key?(:key)
 
         client.with_session(@options.merge(options)) do |session|
-          server = next_primary(nil, session)
-
-          indexes = normalize_models(models, server)
+          indexes = normalize_models(models)
           indexes.each do |index|
             if index[:bucketSize] || index['bucketSize']
-              client.log_warn("Haystack indexes (bucketSize index option) are deprecated as of MongoDB 4.4")
+              client.log_warn('Haystack indexes (bucketSize index option) are deprecated as of MongoDB 4.4')
             end
           end
 
@@ -244,7 +237,14 @@ module Mongo
             session: session,
             operation_timeouts: operation_timeouts(options)
           )
-          Operation::CreateIndex.new(spec).execute(server, context: context)
+          operation = Operation::CreateIndex.new(spec)
+          tracer.trace_operation(operation, context, op_name: 'createIndexes') do
+            retry_enabled = collection.client.options[:retry_writes] != false
+            with_overload_retry(context: context, retry_enabled: retry_enabled) do
+              server = next_primary(nil, session)
+              operation.execute(server, context: context)
+            end
+          end
         end
       end
 
@@ -283,16 +283,16 @@ module Mongo
           session: session,
           operation_timeouts: operation_timeouts(@options)
         )
-
-        cursor = read_with_retry_cursor(session, ServerSelector.primary, self, context: context) do |server|
-          send_initial_query(server, session, context)
-        end
-        if block_given?
-          cursor.each do |doc|
-            yield doc
+        op = initial_query_op(session)
+        tracer.trace_operation(op, context, op_name: 'listIndexes') do
+          cursor = read_with_retry_cursor(session, ServerSelector.primary, self, context: context) do |server|
+            send_initial_query(op, server, session, context)
+          end
+          if block_given?
+            cursor.each(&block)
+          else
+            cursor.to_enum
           end
-        else
-          cursor.to_enum
         end
       end
 
@@ -359,13 +359,20 @@ module Mongo
             write_concern: write_concern,
           }
           spec[:comment] = opts[:comment] unless opts[:comment].nil?
-          server = next_primary(nil, session)
           context = Operation::Context.new(
             client: client,
             session: session,
             operation_timeouts: operation_timeouts(opts)
           )
-          Operation::DropIndex.new(spec).execute(server, context: context)
+          op = Operation::DropIndex.new(spec)
+          op_name = (name == Index::ALL) ? 'dropIndexes' : 'dropIndex'
+          tracer.trace_operation(op, context, op_name: op_name) do
+            retry_enabled = collection.client.options[:retry_writes] != false
+            with_overload_retry(context: context, retry_enabled: retry_enabled) do
+              server = next_primary(nil, session)
+              op.execute(server, context: context)
+            end
+          end
         end
       end
 
@@ -376,25 +383,28 @@ module Mongo
       def indexes_spec(session)
         { selector: {
             listIndexes: collection.name,
-            cursor: batch_size ? { batchSize: batch_size } : {} },
+            cursor: batch_size ? { batchSize: batch_size } : {}
+          },
           coll_name: collection.name,
           db_name: database.name,
-          session: session
-        }
+          session: session }
       end
 
       def initial_query_op(session)
         Operation::Indexes.new(indexes_spec(session))
       end
 
-      def limit; -1; end
+      def limit
+        -1
+      end
 
       def normalize_keys(spec)
         return false if spec.is_a?(String)
+
         Options::Mapper.transform_keys_to_strings(spec)
       end
 
-      def normalize_models(models, server)
+      def normalize_models(models)
         models.map do |model|
           # Transform options first which gives us a mutable hash
           Options::Mapper.transform(model, OPTIONS).tap do |model|
@@ -403,12 +413,12 @@ module Mongo
         end
       end
 
-      def send_initial_query(server, session, context)
+      def send_initial_query(op, server, _session, context)
         if server.load_balancer?
           connection = server.pool.check_out(context: context)
-          initial_query_op(session).execute_with_connection(connection, context: context)
+          op.execute_with_connection(connection, context: context)
         else
-          initial_query_op(session).execute(server, context: context)
+          op.execute(server, context: context)
         end
       end
     end

data/lib/mongo/index.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -18,16 +17,14 @@
 require 'mongo/index/view'
 
 module Mongo
-
   # Contains constants for indexing purposes.
   #
   # @since 2.0.0
   module Index
-
     # Wildcard constant for all.
     #
     # @since 2.1.0
-    ALL = '*'.freeze
+    ALL = '*'
 
     # Specify ascending order for an index.
     #
@@ -42,32 +39,32 @@ module Mongo
     # Specify a 2d Geo index.
     #
     # @since 2.0.0
-    GEO2D = '2d'.freeze
+    GEO2D = '2d'
 
     # Specify a 2d sphere Geo index.
     #
     # @since 2.0.0
-    GEO2DSPHERE = '2dsphere'.freeze
+    GEO2DSPHERE = '2dsphere'
 
     # Specify a geoHaystack index.
     #
     # @since 2.0.0
     # @deprecated
-    GEOHAYSTACK = 'geoHaystack'.freeze
+    GEOHAYSTACK = 'geoHaystack'
 
     # Encodes a text index.
     #
     # @since 2.0.0
-    TEXT = 'text'.freeze
+    TEXT = 'text'
 
     # Specify a hashed index.
     #
     # @since 2.0.0
-    HASHED = 'hashed'.freeze
+    HASHED = 'hashed'
 
     # Constant for the indexes collection.
     #
     # @since 2.0.0
-    COLLECTION = 'system.indexes'.freeze
+    COLLECTION = 'system.indexes'
   end
 end

data/lib/mongo/lint.rb

@@ -1,57 +1,52 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongo
-
   # @api private
   module Lint
-
     # Raises LintError if +obj+ is not of type +cls+.
     def assert_type(obj, cls)
       return unless enabled?
-      unless obj.is_a?(cls)
-        raise Error::LintError, "Expected #{obj} to be a #{cls}"
-      end
+      return if obj.is_a?(cls)
+
+      raise Error::LintError, "Expected #{obj} to be a #{cls}"
     end
     module_function :assert_type
 
     def validate_underscore_read_preference(read_pref)
       return unless enabled?
       return if read_pref.nil?
-      unless read_pref.is_a?(Hash)
-        raise Error::LintError, "Read preference is not a hash: #{read_pref}"
-      end
+      raise Error::LintError, "Read preference is not a hash: #{read_pref}" unless read_pref.is_a?(Hash)
+
       validate_underscore_read_preference_mode(read_pref[:mode] || read_pref['mode'])
     end
     module_function :validate_underscore_read_preference
 
     def validate_underscore_read_preference_mode(mode)
       return unless enabled?
-      if mode
-        unless %w(primary primary_preferred secondary secondary_preferred nearest).include?(mode.to_s)
-          raise Error::LintError, "Invalid read preference mode: #{mode}"
-        end
-      end
+
+      return unless mode
+      return if %w[primary primary_preferred secondary secondary_preferred nearest].include?(mode.to_s)
+
+      raise Error::LintError, "Invalid read preference mode: #{mode}"
     end
     module_function :validate_underscore_read_preference_mode
 
     def validate_camel_case_read_preference(read_pref)
       return unless enabled?
       return if read_pref.nil?
-      unless read_pref.is_a?(Hash)
-        raise Error::LintError, "Read preference is not a hash: #{read_pref}"
-      end
+      raise Error::LintError, "Read preference is not a hash: #{read_pref}" unless read_pref.is_a?(Hash)
+
       validate_camel_case_read_preference_mode(read_pref[:mode] || read_pref['mode'])
     end
     module_function :validate_camel_case_read_preference
 
     def validate_camel_case_read_preference_mode(mode)
       return unless enabled?
-      if mode
-        unless %w(primary primaryPreferred secondary secondaryPreferred nearest).include?(mode.to_s)
-          raise Error::LintError, "Invalid read preference mode: #{mode}"
-        end
-      end
+
+      return unless mode
+      return if %w[primary primaryPreferred secondary secondaryPreferred nearest].include?(mode.to_s)
+
+      raise Error::LintError, "Invalid read preference mode: #{mode}"
     end
     module_function :validate_camel_case_read_preference_mode
 
@@ -76,29 +71,28 @@ module Mongo
     def validate_read_concern_option(read_concern)
       return unless enabled?
       return if read_concern.nil?
-      unless read_concern.is_a?(Hash)
-        raise Error::LintError, "Read concern is not a hash: #{read_concern}"
-      end
+      raise Error::LintError, "Read concern is not a hash: #{read_concern}" unless read_concern.is_a?(Hash)
       return if read_concern.empty?
+
       keys = read_concern.keys
-      if read_concern.is_a?(BSON::Document)
-        # Permits indifferent access
-        allowed_keys = ['level']
-      else
-        # Does not permit indifferent access
-        allowed_keys = [:level]
-      end
-      if keys != allowed_keys
-        raise Error::LintError, "Read concern has invalid keys: #{keys.inspect}"
-      end
+      allowed_keys = if read_concern.is_a?(BSON::Document)
+                       # Permits indifferent access
+                       [ 'level' ]
+                     else
+                       # Does not permit indifferent access
+                       [ :level ]
+                     end
+      raise Error::LintError, "Read concern has invalid keys: #{keys.inspect}" if keys != allowed_keys
+
       level = read_concern[:level]
-      return if [:local, :available, :majority, :linearizable, :snapshot].include?(level)
+      return if %i[local available majority linearizable snapshot].include?(level)
+
       raise Error::LintError, "Read concern level is invalid: value must be a symbol: #{level.inspect}"
     end
     module_function :validate_read_concern_option
 
     def enabled?
-      ENV['MONGO_RUBY_DRIVER_LINT'] && %w(1 yes true on).include?(ENV['MONGO_RUBY_DRIVER_LINT'].downcase)
+      ENV['MONGO_RUBY_DRIVER_LINT'] && %w[1 yes true on].include?(ENV['MONGO_RUBY_DRIVER_LINT'].downcase)
     end
     module_function :enabled?
   end

data/lib/mongo/loggable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -16,16 +15,14 @@
 # limitations under the License.
 
 module Mongo
-
   # Allows objects to easily log operations.
   #
   # @since 2.0.0
   module Loggable
-
     # The standard MongoDB log prefix.
     #
     # @since 2.0.0
-    PREFIX = 'MONGODB'.freeze
+    PREFIX = 'MONGODB'
 
     # Convenience method to log debug messages with the standard prefix.
     #
@@ -41,7 +38,7 @@ module Mongo
 
     # Convenience method to log error messages with the standard prefix.
     #
-    # @example Log a error message.
+    # @example Log an error message.
     #   log_error('Message')
     #
     # @param [ String ] message The message to log.
@@ -65,7 +62,7 @@ module Mongo
 
     # Convenience method to log info messages with the standard prefix.
     #
-    # @example Log a info message.
+    # @example Log an info message.
     #   log_info('Message')
     #
     # @param [ String ] message The message to log.
@@ -96,13 +93,13 @@ module Mongo
     #
     # @since 2.1.0
     def logger
-      ((respond_to?(:options) && options && options[:logger]) || Logger.logger)
+      (respond_to?(:options) && options && options[:logger]) || Logger.logger
     end
 
     private
 
     def format_message(message)
-      format("%s | %s".freeze, _mongo_log_prefix, message)
+      format('%s | %s', _mongo_log_prefix, message)
     end
 
     def _mongo_log_prefix

data/lib/mongo/logger.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -16,14 +15,11 @@
 # limitations under the License.
 
 module Mongo
-
   # Provides ability to log messages.
   #
   # @since 2.0.0
   class Logger
-
     class << self
-
       # Get the wrapped logger. If none was set will return a default info
       # level logger.
       #
@@ -47,9 +43,7 @@ module Mongo
       # @return [ ::Logger ] The wrapped logger.
       #
       # @since 2.0.0
-      def logger=(other)
-        @logger = other
-      end
+      attr_writer :logger
 
       # Get the global logger level.
       #

data/lib/mongo/monitoring/cmap_log_subscriber.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 Monitoring
-
     # Subscribes to CMAP events and logs them.
     #
     # @since 2.9.0

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   class Monitoring
-
     # Subscribes to command events and logs them.
     #
     # @since 2.1.0
@@ -56,14 +54,13 @@ module Mongo
       #
       # @since 2.1.0
       def started(event)
-        if logger.debug?
-          _prefix = prefix(event,
-            connection_generation: event.connection_generation,
-            connection_id: event.connection_id,
-            server_connection_id: event.server_connection_id,
-          )
-          log_debug("#{_prefix} | STARTED | #{format_command(event.command)}")
-        end
+        return unless logger.debug?
+
+        _prefix = prefix(event,
+                         connection_generation: event.connection_generation,
+                         connection_id: event.connection_id,
+                         server_connection_id: event.server_connection_id)
+        log_debug("#{_prefix} | STARTED | #{format_command(event.command)}")
       end
 
       # Handle the command succeeded event.
@@ -75,9 +72,9 @@ module Mongo
       #
       # @since 2.1.0
       def succeeded(event)
-        if logger.debug?
-          log_debug("#{prefix(event)} | SUCCEEDED | #{'%.3f' % event.duration}s")
-        end
+        return unless logger.debug?
+
+        log_debug("#{prefix(event)} | SUCCEEDED | #{'%.3f' % event.duration}s")
       end
 
       # Handle the command failed event.
@@ -89,34 +86,29 @@ module Mongo
       #
       # @since 2.1.0
       def failed(event)
-        if logger.debug?
-          log_debug("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
-        end
+        return unless logger.debug?
+
+        log_debug("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
       end
 
       private
 
       def format_command(args)
-        begin
-          truncating? ? truncate(args) : args.inspect
-        rescue Exception
-          '<Unable to inspect arguments>'
-        end
+        truncating? ? truncate(args) : args.inspect
+      rescue Exception
+        '<Unable to inspect arguments>'
       end
 
       def prefix(event, connection_generation: nil, connection_id: nil,
-        server_connection_id: nil
-      )
-        extra = [connection_generation, connection_id].compact.join(':')
-        if extra == ''
-          extra = nil
-        else
-          extra = "conn:#{extra}"
-        end
-        if server_connection_id
-          extra += " sconn:#{server_connection_id}"
-        end
-        "#{event.address.to_s} req:#{event.request_id}#{extra && " #{extra}"} | " +
+                 server_connection_id: nil)
+        extra = [ connection_generation, connection_id ].compact.join(':')
+        extra = if extra == ''
+                  nil
+                else
+                  "conn:#{extra}"
+                end
+        extra += " sconn:#{server_connection_id}" if server_connection_id
+        "#{event.address} req:#{event.request_id}#{extra && " #{extra}"} | " +
           "#{event.database_name}.#{event.command_name}"
       end
 

data/lib/mongo/monitoring/event/cmap/base.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ module Mongo
   class Monitoring
     module Event
       module Cmap
-
         # Base class for CMAP events.
         #
         # @since 2.9.0

data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -19,12 +18,10 @@ module Mongo
   class Monitoring
     module Event
       module Cmap
-
         # Event published when a connection is unable to be checked out of a pool.
         #
         # @since 2.9.0
         class ConnectionCheckOutFailed < Base
-
           # @return [ Symbol ] POOL_CLOSED Indicates that the connection check
           #   out failed due to the pool already being closed.
           #
@@ -79,7 +76,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} address=#{address} " +
-                "reason=#{reason}>"
+              "reason=#{reason}>"
           end
         end
       end