mongo 2.12.4 → 2.13.0

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -75,6 +75,17 @@ module Mongo
           @duration = duration
         end
 
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @api experimental
+        def summary
+          "#<#{short_class_name} address=#{address} #{database_name}.#{command_name}>"
+        end
+
         # Create the event from a wire protocol message payload.
         #
         # @example Create the event.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -45,12 +45,18 @@ module Mongo
         # @api private
         attr_reader :socket_object_id
 
+        # @api private
+        attr_reader :connection_generation
+
         # @return [ Integer ] The ID for the connection over which the command
         #   is sent.
         #
         # @api private
         attr_reader :connection_id
 
+        # @api private
+        attr_reader :server_connection_id
+
         # Create the new event.
         #
         # @example Create the event.
@@ -65,7 +71,8 @@ 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
+          operation_id, command, socket_object_id: nil, connection_id: nil,
+          connection_generation: nil, server_connection_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -75,6 +82,37 @@ module Mongo
           @command = redacted(command_name, command)
           @socket_object_id = socket_object_id
           @connection_id = connection_id
+          @connection_generation = connection_generation
+          @server_connection_id = server_connection_id
+        end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @api experimental
+        def summary
+          "#<#{short_class_name} address=#{address} #{database_name}.#{command_name} command=#{command_summary}>"
+        end
+
+        # Returns the command, formatted as a string, with automatically added
+        # keys elided ($clusterTime, lsid, signature).
+        #
+        # @return [ String ] The command summary.
+        private def command_summary
+          command = self.command
+          remove_keys = %w($clusterTime lsid signature)
+          if remove_keys.any? { |k| command.key?(k) }
+            command = Hash[command.reject { |k, v| remove_keys.include?(k) }]
+            suffix = ' ...'
+          else
+            suffix = ''
+          end
+          command.map do |k, v|
+            "#{k}=#{v.inspect}"
+          end.join(' ') + suffix
         end
 
         # Create the event from a wire protocol message payload.
@@ -91,7 +129,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload,
-          socket_object_id: nil, connection_id: nil
+          socket_object_id: nil, connection_id: nil, connection_generation: nil,
+          server_connection_id: nil
         )
           new(
             payload[:command_name],
@@ -107,6 +146,8 @@ module Mongo
             payload[:command].merge('$db' => payload[:database_name]),
             socket_object_id: socket_object_id,
             connection_id: connection_id,
+            connection_generation: connection_generation,
+            server_connection_id: server_connection_id,
           )
         end
 

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -67,6 +67,17 @@ module Mongo
           @duration = duration
         end
 
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @api experimental
+        def summary
+          "#<#{short_class_name} address=#{address} #{database_name}.#{command_name}>"
+        end
+
         # Create the event from a wire protocol message payload.
         #
         # @example Create the event.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -50,7 +50,13 @@ module Mongo
         #
         # @since 2.1.0
         def redacted(command_name, document)
-          REDACTED_COMMANDS.include?(command_name.to_s) ? BSON::Document.new : document
+          if REDACTED_COMMANDS.include?(command_name.to_s) &&
+            !%w(1 true yes).include?(ENV['MONGO_RUBY_DRIVER_UNREDACT_EVENTS']&.downcase)
+          then
+            BSON::Document.new
+          else
+            document
+          end
         end
 
         # Is compression allowed for a given command message.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB, Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -50,7 +50,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " address=#{address} topology=#{topology.summary}>"
         end
       end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB, Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -35,6 +35,13 @@ module Mongo
         #   description.
         attr_reader :new_description
 
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        #
+        # @api experimental
+        def awaited?
+          @awaited
+        end
+
         # Create the event.
         #
         # @example Create the event.
@@ -44,13 +51,19 @@ module Mongo
         # @param [ Integer ] topology The topology.
         # @param [ Server::Description ] previous_description The previous description.
         # @param [ Server::Description ] new_description The new description.
+        # @param [ true | false ] awaited Whether the server description was
+        #   a result of processing an awaited ismaster response.
         #
         # @since 2.4.0
-        def initialize(address, topology, previous_description, new_description)
+        # @api private
+        def initialize(address, topology, previous_description, new_description,
+          awaited: false
+        )
           @address = address
           @topology = topology
           @previous_description = previous_description
           @new_description = new_description
+          @awaited = !!awaited
         end
 
         # Returns a concise yet useful summary of the event.
@@ -62,10 +75,20 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
-          " address=#{address} topology=#{topology.summary}" +
+          "#<#{short_class_name}" +
+          " address=#{address}" +
           # TODO Add summaries to descriptions and use them here
-          " prev=#{previous_description.inspect} new=#{new_description.inspect}>"
+          " prev=#{previous_description.server_type.upcase} new=#{new_description.server_type.upcase}#{awaited_indicator}>"
+        end
+
+        private
+
+        def awaited_indicator
+          if awaited?
+            ' [awaited]'
+          else
+            ''
+          end
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -36,6 +36,11 @@ module Mongo
         # Alias of error for SDAM spec compliance.
         alias :failure :error
 
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        def awaited?
+          @awaited
+        end
+
         # Create the event.
         #
         # @example Create the event.
@@ -43,13 +48,15 @@ module Mongo
         #
         # @param [ Address ] address The server address.
         # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        # @param [ true | false ] awaited Whether the heartbeat was awaited.
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time, error)
+        def initialize(address, round_trip_time, error, awaited: false)
           @address = address
           @round_trip_time = round_trip_time
           @error = error
+          @awaited = !!awaited
         end
 
         # Returns a concise yet useful summary of the event.
@@ -61,7 +68,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " address=#{address}" +
           " error=#{error.inspect}>"
         end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -24,17 +24,24 @@ module Mongo
         # @return [ Address ] address The server address.
         attr_reader :address
 
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        def awaited?
+          @awaited
+        end
+
         # Create the event.
         #
         # @example Create the event.
         #   ServerHeartbeatStarted.new(address)
         #
         # @param [ Address ] address The server address.
+        # @param [ true | false ] awaited Whether the heartbeat was awaited.
         #
         # @since 2.7.0
         # @api private
-        def initialize(address)
+        def initialize(address, awaited: false)
           @address = address
+          @awaited = !!awaited
         end
 
         # Returns a concise yet useful summary of the event.
@@ -46,7 +53,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " address=#{address}>"
         end
       end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -30,6 +30,11 @@ module Mongo
         # Alias of round_trip_time.
         alias :duration :round_trip_time
 
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        def awaited?
+          @awaited
+        end
+
         # Create the event.
         #
         # @example Create the event.
@@ -37,12 +42,14 @@ module Mongo
         #
         # @param [ Address ] address The server address.
         # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        # @param [ true | false ] awaited Whether the heartbeat was awaited.
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time)
+        def initialize(address, round_trip_time, awaited: false)
           @address = address
           @round_trip_time = round_trip_time
+          @awaited = !!awaited
         end
 
         # Returns a concise yet useful summary of the event.
@@ -54,7 +61,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " address=#{address}>"
         end
       end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019 MongoDB, Inc.
+# Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -50,7 +50,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " address=#{address} topology=#{topology.summary}>"
         end
       end