mongo 2.13.0.beta1 → 2.14.0

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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/topology_changed.rb

@@ -50,7 +50,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " prev=#{previous_topology.summary}" +
           " new=#{new_topology.summary}>"
         end

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

@@ -45,7 +45,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " topology=#{topology.summary}>"
         end
       end

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

@@ -45,7 +45,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " topology=#{topology.summary}>"
         end
       end

data/lib/mongo/monitoring/publishable.rb

@@ -32,7 +32,7 @@ module Mongo
       def publish_sdam_event(topic, event)
         return unless monitoring?
 
-        log_debug("EVENT: #{event.summary}")
+        #log_debug("EVENT: #{event.summary}")
         monitoring.succeeded(topic, event)
       end
 
@@ -45,13 +45,16 @@ module Mongo
       private
 
       def command_started(address, operation_id, payload,
-        socket_object_id: nil, connection_id: nil, connection_generation: nil
+        socket_object_id: nil, connection_id: nil, connection_generation: nil,
+        server_connection_id: nil
       )
         monitoring.started(
           Monitoring::COMMAND,
           Event::CommandStarted.generate(address, operation_id, payload,
             socket_object_id: socket_object_id, connection_id: connection_id,
-            connection_generation: connection_generation)
+            connection_generation: connection_generation,
+            server_connection_id: server_connection_id,
+          )
         )
       end
 

data/lib/mongo/monitoring/server_description_changed_log_subscriber.rb

@@ -25,9 +25,17 @@ module Mongo
       def log_event(event)
         log_debug(
           "Server description for #{event.address} changed from " +
-          "'#{event.previous_description.server_type}' to '#{event.new_description.server_type}'."
+          "'#{event.previous_description.server_type}' to '#{event.new_description.server_type}'#{awaited_indicator(event)}."
         )
       end
+
+      def awaited_indicator(event)
+        if event.awaited?
+          ' [awaited]'
+        else
+          ''
+        end
+      end
     end
   end
 end

data/lib/mongo/monitoring/topology_changed_log_subscriber.rb

@@ -23,7 +23,7 @@ module Mongo
       private
 
       def log_event(event)
-        if event.previous_topology != event.new_topology
+        if event.previous_topology.class != event.new_topology.class
           log_debug(
             "Topology type '#{event.previous_topology.display_name}' changed to " +
             "type '#{event.new_topology.display_name}'."

data/lib/mongo/operation.rb

@@ -50,6 +50,8 @@ require 'mongo/operation/create_index'
 require 'mongo/operation/drop_index'
 
 module Mongo
+
+  # @api private
   module Operation
 
     # The q field constant.

data/lib/mongo/operation/aggregate/result.rb

@@ -14,25 +14,24 @@
 
 module Mongo
   module Operation
-
-    # Aggregate result wrapper.
-    #
-    # @since 2.0.0
     class Aggregate
 
       # Defines custom behavior of results in an aggregation context.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN = 'stages'.freeze
 
         # The legacy field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN_LEGACY = 'serverPipeline'.freeze
 
         # Get the cursor id for the result.
@@ -48,6 +47,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.0.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : 0
         end
@@ -62,8 +62,8 @@ module Mongo
         end
 
         # Get the documents for the aggregation result. This is either the
-        # first document's 'result' field, or if a cursor option was selected, 
-        # it is the 'firstBatch' field in the 'cursor' field of the first 
+        # first document's 'result' field, or if a cursor option was selected,
+        # it is the 'firstBatch' field in the 'cursor' field of the first
         # document returned. Otherwise, it is an explain document.
         #
         # @example Get the documents.
@@ -72,10 +72,11 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
-          docs = reply.documents[0][RESULT] 
+          docs = reply.documents[0][RESULT]
           docs ||= cursor_document[FIRST_BATCH] if cursor_document
-          docs ||= explain_document 
+          docs ||= explain_document
           docs
         end
 

data/lib/mongo/operation/collections_info/command.rb

@@ -27,6 +27,11 @@ module Mongo
 
         private
 
+        def get_result(connection, client, options = {})
+          # This is a Mongo::Operation::CollectionsInfo::Result
+          Result.new(*dispatch_message(connection, client), db_name)
+        end
+
         def selector(connection)
           {}
         end

data/lib/mongo/operation/collections_info/result.rb

@@ -20,8 +20,24 @@ module Mongo
       # collection.
       #
       # @since 2.1.0
+      # @api semiprivate
       class Result < Operation::Result
 
+        # Initialize a new result.
+        #
+        # @param [ Array<Protocol::Message> | nil ] replies The wire protocol replies, if any.
+        # @param [ Server::Description ] connection_description
+        #   Server description of the server that performed the operation that
+        #   this result is for.
+        # @param [ String ] database_name The name of the database that the
+        #   query was sent to.
+        #
+        # @api private
+        def initialize(replies, connection_description, database_name)
+          super(replies, connection_description)
+          @database_name = database_name
+        end
+
         # Get the namespace for the cursor.
         #
         # @example Get the namespace.
@@ -30,8 +46,9 @@ module Mongo
         # @return [ String ] The namespace.
         #
         # @since 2.1.0
+        # @api private
         def namespace
-          Database::NAMESPACES
+          "#{@database_name}.#{Database::NAMESPACES}"
         end
       end
     end

data/lib/mongo/operation/delete/bulk_result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for a delete when part of a bulk write.
       #
       # @since 2.0.0
+      # @api semiprivate
       class BulkResult < Operation::Result
         include Aggregatable
 
@@ -30,6 +31,7 @@ module Mongo
         # @return [ Integer ] The number of documents deleted.
         #
         # @since 2.0.0
+        # @api public
         def n_removed
           return 0 unless acknowledged?
           @replies.reduce(0) do |n, reply|

data/lib/mongo/operation/delete/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for a delete.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the number of documents deleted.
@@ -29,10 +30,12 @@ module Mongo
         # @return [ Integer ] The deleted count.
         #
         # @since 2.0.0
+        # @api public
         def deleted_count
           n
         end
 
+        # @api public
         def bulk_result
           BulkResult.new(@replies, connection_description)
         end

data/lib/mongo/operation/explain/command.rb

@@ -30,6 +30,10 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end

data/lib/mongo/operation/explain/legacy.rb

@@ -29,6 +29,10 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, coll_name, command(connection), options(connection))
         end