mongo 2.23.0 → 2.24.0

data/lib/mongo/monitoring/event/cmap/connection_checked_out.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 successfully checked out out of a pool.
+        # Event published when a connection is successfully checked out of a pool.
         #
         # @since 2.9.0
         class ConnectionCheckedOut < Base
-
           # @return [ Mongo::Address ] address The address of the server that the connection will
           #   connect to.
           #
@@ -66,7 +63,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} connection_id=#{connection_id} pool=0x#{pool.object_id}>"
+              "address=#{address} connection_id=#{connection_id} pool=0x#{pool.object_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/connection_closed.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 closed.
         #
         # @since 2.9.0
         class ConnectionClosed < Base
-
           # @return [ Symbol ] STALE Indicates that the connection was closed due to it being stale.
           #
           # @since 2.9.0
@@ -97,7 +94,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} connection_id=#{connection_id} reason=#{reason}>"
+              "address=#{address} connection_id=#{connection_id} reason=#{reason}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/connection_created.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 created.
         #
         # @since 2.9.0
         class ConnectionCreated < Base
-
           # @return [ Mongo::Address ] address The address of the server the connection will connect
           #   to.
           #
@@ -58,7 +55,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} connection_id=#{connection_id}>"
+              "address=#{address} connection_id=#{connection_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/connection_ready.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 ready to be used for operations.
         #
         # @since 2.9.0
         class ConnectionReady < Base
-
           # @return [ Mongo::Address ] address The address of the server the connection is connected
           #   to.
           #
@@ -58,7 +55,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} connection_id=#{connection_id}>"
+              "address=#{address} connection_id=#{connection_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/pool_cleared.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 pool is cleared.
         #
         # @since 2.9.0
         class PoolCleared < Base
-
           # @return [ Mongo::Address ] address The address of the server the pool's connections will
           #   connect to.
           #

data/lib/mongo/monitoring/event/cmap/pool_closed.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 pool is closed.
         #
         # @since 2.9.0
         class PoolClosed < Base
-
           # @return [ Mongo::Address ] address The address of the server the pool's connections will
           #   connect to.
           #
@@ -59,7 +56,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} pool=0x#{pool.object_id}>"
+              "address=#{address} pool=0x#{pool.object_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/pool_created.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 pool is created.
         #
         # @since 2.9.0
         class PoolCreated < Base
-
           # @return [ Mongo::Address ] address The address of the server the pool's connections will
           #   connect to.
           #
@@ -66,7 +63,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} options=#{options} pool=0x#{pool.object_id}>"
+              "address=#{address} options=#{options} pool=0x#{pool.object_id}>"
           end
         end
       end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-present MongoDB Inc.
 #
@@ -19,10 +18,8 @@ module Mongo
   class Monitoring
     module Event
       module Cmap
-
         # Event published when a connection pool is marked ready.
         class PoolReady < Base
-
           # @return [ Mongo::Address ] address The address of the server the pool's connections will
           #   connect to.
           attr_reader :address
@@ -58,7 +55,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} options=#{options} pool=0x#{pool.object_id}>"
+              "address=#{address} options=#{options} pool=0x#{pool.object_id}>"
           end
         end
       end

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

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

data/lib/mongo/monitoring/event/command_failed.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event that is fired when a command operation fails.
       #
       # @since 2.1.0
@@ -83,9 +81,8 @@ module Mongo
         #
         # @api private
         def initialize(command_name, database_name, address,
-          request_id, operation_id, message, failure, duration,
-          started_event:, server_connection_id: nil, service_id: nil
-        )
+                       request_id, operation_id, message, failure, duration,
+                       started_event:, server_connection_id: nil, service_id: nil)
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address
@@ -130,9 +127,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload, message,
-          failure, duration, started_event:, server_connection_id: nil,
-          service_id: nil
-        )
+                          failure, duration, started_event:, server_connection_id: nil,
+                          service_id: nil)
           new(
             payload[:command_name],
             payload[:database_name],
@@ -144,7 +140,7 @@ module Mongo
             duration,
             started_event: started_event,
             server_connection_id: server_connection_id,
-            service_id: service_id,
+            service_id: service_id
           )
         end
       end

data/lib/mongo/monitoring/event/command_started.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event that is fired when a command operation starts.
       #
       # @since 2.1.0
@@ -83,10 +81,9 @@ module Mongo
         # @since 2.1.0
         # @api private
         def initialize(command_name, database_name, address, request_id,
-          operation_id, command, socket_object_id: nil, connection_id: nil,
-          connection_generation: nil, server_connection_id: nil,
-          service_id: nil
-        )
+                       operation_id, command, socket_object_id: nil, connection_id: nil,
+                       connection_generation: nil, server_connection_id: nil,
+                       service_id: nil)
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address
@@ -121,9 +118,9 @@ module Mongo
         # @return [ String ] The command summary.
         private def command_summary
           command = self.command
-          remove_keys = %w($clusterTime lsid signature)
+          remove_keys = %w[$clusterTime lsid signature]
           if remove_keys.any? { |k| command.key?(k) }
-            command = Hash[command.reject { |k, v| remove_keys.include?(k) }]
+            command = Hash[command.reject { |k, _v| remove_keys.include?(k) }]
             suffix = ' ...'
           else
             suffix = ''
@@ -148,9 +145,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload,
-          socket_object_id: nil, connection_id: nil, connection_generation: nil,
-          server_connection_id: nil, service_id: nil
-        )
+                          socket_object_id: nil, connection_id: nil, connection_generation: nil,
+                          server_connection_id: nil, service_id: nil)
           new(
             payload[:command_name],
             payload[:database_name],
@@ -167,7 +163,7 @@ module Mongo
             connection_id: connection_id,
             connection_generation: connection_generation,
             server_connection_id: server_connection_id,
-            service_id: service_id,
+            service_id: service_id
           )
         end
 

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,7 +17,6 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event that is fired when a command operation succeeds.
       #
       # @since 2.1.0
@@ -76,9 +74,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def initialize(command_name, database_name, address, request_id,
-          operation_id, reply, duration, started_event:,
-          server_connection_id: nil, service_id: nil
-        )
+                       operation_id, reply, duration, started_event:,
+                       server_connection_id: nil, service_id: nil)
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address
@@ -121,9 +118,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, command_payload,
-          reply_payload, duration, started_event:, server_connection_id: nil,
-          service_id: nil
-        )
+                          reply_payload, duration, started_event:, server_connection_id: nil,
+                          service_id: nil)
           new(
             command_payload[:command_name],
             command_payload[:database_name],
@@ -134,19 +130,15 @@ module Mongo
             duration,
             started_event: started_event,
             server_connection_id: server_connection_id,
-            service_id: service_id,
+            service_id: service_id
           )
         end
 
-        private
-
         def self.generate_reply(command_payload, reply_payload)
           if reply_payload
             reply = reply_payload[:reply]
-            if cursor = reply[:cursor]
-              if !cursor.key?(Collection::NS)
-                cursor.merge!(Collection::NS => namespace(command_payload))
-              end
+            if (cursor = reply[:cursor]) && !cursor.key?(Collection::NS)
+              cursor.merge!(Collection::NS => namespace(command_payload))
             end
             reply
           else

data/lib/mongo/monitoring/event/secure.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -18,26 +17,24 @@
 module Mongo
   class Monitoring
     module Event
-
       # Provides behavior to redact sensitive information from commands and
       # replies.
       #
       # @since 2.1.0
       module Secure
-
         # The list of commands that has the data redacted for security.
         #
         # @since 2.1.0
-        REDACTED_COMMANDS = [
-          'authenticate',
-          'saslStart',
-          'saslContinue',
-          'getnonce',
-          'createUser',
-          'updateUser',
-          'copydbgetnonce',
-          'copydbsaslstart',
-          'copydb'
+        REDACTED_COMMANDS = %w[
+          authenticate
+          saslStart
+          saslContinue
+          getnonce
+          createUser
+          updateUser
+          copydbgetnonce
+          copydbsaslstart
+          copydb
         ].freeze
 
         # Check whether the command is sensitive in terms of command monitoring
@@ -52,10 +49,9 @@ module Mongo
         def sensitive?(command_name:, document:)
           if REDACTED_COMMANDS.include?(command_name.to_s)
             true
-          elsif %w(hello ismaster isMaster).include?(command_name.to_s) &&
-            document['speculativeAuthenticate']
-            then
-            # According to Command Monitoring spec,for hello/legacy hello commands
+          elsif %w[hello ismaster isMaster].include?(command_name.to_s) &&
+                document['speculativeAuthenticate']
+            # According to Command Monitoring spec, for hello/legacy hello commands
             # when speculativeAuthenticate is present, their commands AND replies
             # MUST be redacted from the events.
             # See https://github.com/mongodb/specifications/blob/master/source/command-logging-and-monitoring/command-logging-and-monitoring.md#security
@@ -81,10 +77,10 @@ module Mongo
         #
         # @since 2.1.0
         def redacted(command_name, document)
-          if %w(1 true yes).include?(ENV['MONGO_RUBY_DRIVER_UNREDACT_EVENTS']&.downcase)
+          if %w[1 true yes].include?(ENV['MONGO_RUBY_DRIVER_UNREDACT_EVENTS']&.downcase)
             document
           elsif respond_to?(:started_event) && started_event.sensitive
-            return BSON::Document.new
+            BSON::Document.new
           elsif sensitive?(command_name: command_name, document: document)
             BSON::Document.new
           else
@@ -92,7 +88,6 @@ module Mongo
           end
         end
 
-
         # Is compression allowed for a given command message.
         #
         # @example Determine if compression is allowed for a given command.

data/lib/mongo/monitoring/event/server_closed.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
@@ -18,12 +17,10 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event fired when the server is closed.
       #
       # @since 2.4.0
       class ServerClosed < Mongo::Event::Base
-
         # @return [ Address ] address The server address.
         attr_reader :address
 
@@ -54,7 +51,7 @@ module Mongo
         # @api experimental
         def summary
           "#<#{short_class_name}" +
-          " address=#{address} topology=#{topology.summary}>"
+            " address=#{address} topology=#{topology.summary}>"
         end
       end
     end

data/lib/mongo/monitoring/event/server_description_changed.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
@@ -18,12 +17,10 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event fired when a server's description changes.
       #
       # @since 2.4.0
       class ServerDescriptionChanged < Mongo::Event::Base
-
         # @return [ Address ] address The server address.
         attr_reader :address
 
@@ -60,8 +57,7 @@ module Mongo
         # @since 2.4.0
         # @api private
         def initialize(address, topology, previous_description, new_description,
-          awaited: false
-        )
+                       awaited: false)
           @address = address
           @topology = topology
           @previous_description = previous_description
@@ -79,9 +75,9 @@ module Mongo
         # @api experimental
         def summary
           "#<#{short_class_name}" +
-          " address=#{address}" +
-          # TODO Add summaries to descriptions and use them here
-          " prev=#{previous_description.server_type.upcase} new=#{new_description.server_type.upcase}#{awaited_indicator}>"
+            " address=#{address}" +
+            # TODO: Add summaries to descriptions and use them here
+            " prev=#{previous_description.server_type.upcase} new=#{new_description.server_type.upcase}#{awaited_indicator}>"
         end
 
         private

data/lib/mongo/monitoring/event/server_heartbeat_failed.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,12 +17,10 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event fired when a server heartbeat is dispatched.
       #
       # @since 2.7.0
       class ServerHeartbeatFailed < Mongo::Event::Base
-
         # Create the event.
         #
         # @example Create the event.
@@ -37,9 +34,7 @@ module Mongo
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time, error, awaited: false,
-          started_event:
-        )
+        def initialize(address, round_trip_time, error, started_event:, awaited: false)
           @address = address
           @round_trip_time = round_trip_time
           @error = error
@@ -54,13 +49,13 @@ module Mongo
         attr_reader :round_trip_time
 
         # Alias of round_trip_time.
-        alias :duration :round_trip_time
+        alias duration round_trip_time
 
         # @return [ Exception ] error The exception that occurred in hello call.
         attr_reader :error
 
         # Alias of error for SDAM spec compliance.
-        alias :failure :error
+        alias failure error
 
         # @return [ true | false ] Whether the heartbeat was awaited.
         def awaited?
@@ -83,8 +78,8 @@ module Mongo
         # @api experimental
         def summary
           "#<#{short_class_name}" +
-          " address=#{address}" +
-          " error=#{error.inspect}>"
+            " address=#{address}" +
+            " error=#{error.inspect}>"
         end
       end
     end

data/lib/mongo/monitoring/event/server_heartbeat_started.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,12 +17,10 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event fired when a server heartbeat is dispatched.
       #
       # @since 2.7.0
       class ServerHeartbeatStarted < Mongo::Event::Base
-
         # @return [ Address ] address The server address.
         attr_reader :address
 
@@ -57,7 +54,7 @@ module Mongo
         # @api experimental
         def summary
           "#<#{short_class_name}" +
-          " address=#{address}>"
+            " address=#{address}>"
         end
       end
     end

data/lib/mongo/monitoring/event/server_heartbeat_succeeded.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
@@ -18,12 +17,10 @@
 module Mongo
   class Monitoring
     module Event
-
       # Event fired when a server heartbeat is dispatched.
       #
       # @since 2.7.0
       class ServerHeartbeatSucceeded < Mongo::Event::Base
-
         # Create the event.
         #
         # @example Create the event.
@@ -37,9 +34,7 @@ module Mongo
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time, awaited: false,
-          started_event:
-        )
+        def initialize(address, round_trip_time, started_event:, awaited: false)
           @address = address
           @round_trip_time = round_trip_time
           @awaited = !!awaited
@@ -53,7 +48,7 @@ module Mongo
         attr_reader :round_trip_time
 
         # Alias of round_trip_time.
-        alias :duration :round_trip_time
+        alias duration round_trip_time
 
         # @return [ true | false ] Whether the heartbeat was awaited.
         def awaited?
@@ -76,7 +71,7 @@ module Mongo
         # @api experimental
         def summary
           "#<#{short_class_name}" +
-          " address=#{address}>"
+            " address=#{address}>"
         end
       end
     end