mongo 2.4.0.rc1 → 2.4.0

data/lib/mongo/cluster/topology/single.rb

@@ -20,15 +20,22 @@ module Mongo
       #
       # @since 2.0.0
       class Single
-
-        # @return [ String ] seed The seed address.
-        attr_reader :seed
+        include Monitoring::Publishable
 
         # The display name for the topology.
         #
         # @since 2.0.0
         NAME = 'Single'.freeze
 
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # @return [ String ] seed The seed address.
+        attr_reader :seed
+
+        # @return [ monitoring ] monitoring the monitoring.
+        attr_reader :monitoring
+
         # Get the display name.
         #
         # @example Get the display name.
@@ -54,16 +61,47 @@ module Mongo
         # @return [ Single ] The topology.
         def elect_primary(description, servers); self; end
 
+        # Determine if the topology would select a readable server for the
+        # provided candidates and read preference.
+        #
+        # @example Is a readable server present?
+        #   topology.has_readable_server?(cluster, server_selector)
+        #
+        # @param [ Cluster ] cluster The cluster.
+        # @param [ ServerSelector ] server_selector The server
+        #   selector.
+        #
+        # @return [ true ] A standalone always has a readable server.
+        #
+        # @since 2.4.0
+        def has_readable_server?(cluster, server_selector = nil); true; end
+
+        # Determine if the topology would select a writable server for the
+        # provided candidates.
+        #
+        # @example Is a writable server present?
+        #   topology.has_writable_server?(servers)
+        #
+        # @param [ Cluster ] cluster The cluster.
+        #
+        # @return [ true ] A standalone always has a writable server.
+        #
+        # @since 2.4.0
+        def has_writable_server?(cluster); true; end
+
         # Initialize the topology with the options.
         #
         # @example Initialize the topology.
         #   Single.new(options)
         #
         # @param [ Hash ] options The options.
+        # @param [ Monitoring ] monitoring The monitoring.
+        # @param [ Array<String> ] seeds The seeds.
         #
         # @since 2.0.0
-        def initialize(options, seeds = [])
+        def initialize(options, monitoring, seeds = [])
           @options = options
+          @monitoring = monitoring
           @seed = seeds.first
         end
 
@@ -181,6 +219,19 @@ module Mongo
         #
         # @since 2.0.6
         def standalone_discovered; self; end
+
+        # Publish that a member of this topology was discovered.
+        #
+        # @example Publish that a member was discovered.
+        #   topology.member_discovered
+        #
+        # @since 2.4.0
+        def member_discovered
+          publish_sdam_event(
+            Monitoring::TOPOLOGY_CHANGED,
+            Monitoring::Event::TopologyChanged.new(self, self)
+          )
+        end
       end
     end
   end

data/lib/mongo/cluster/topology/unknown.rb

@@ -21,6 +21,7 @@ module Mongo
       # @since 2.0.0
       class Unknown
         include Loggable
+        include Monitoring::Publishable
 
         # The display name for the topology.
         #
@@ -30,6 +31,9 @@ module Mongo
         # @return [ Hash ] options The options.
         attr_reader :options
 
+        # @return [ Monitoring ] monitoring The monitoring.
+        attr_reader :monitoring
+
         # Get the display name.
         #
         # @example Get the display name.
@@ -55,23 +59,55 @@ module Mongo
         # @return [ Sharded, ReplicaSet ] The new topology.
         def elect_primary(description, servers)
           if description.mongos?
-            log_debug("Mongos #{description.address.to_s} discovered.")
-            Sharded.new(options)
+            sharded = Sharded.new(options, monitoring)
+            topology_changed(sharded)
+            sharded
           else
             initialize_replica_set(description, servers)
           end
         end
 
+        # Determine if the topology would select a readable server for the
+        # provided candidates and read preference.
+        #
+        # @example Is a readable server present?
+        #   topology.has_readable_server?(cluster, server_selector)
+        #
+        # @param [ Cluster ] cluster The cluster.
+        # @param [ ServerSelector ] server_selector The server
+        #   selector.
+        #
+        # @return [ false ] An Unknown topology will never have a readable server.
+        #
+        # @since 2.4.0
+        def has_readable_server?(cluster, server_selector = nil); false; end
+
+        # Determine if the topology would select a writable server for the
+        # provided candidates.
+        #
+        # @example Is a writable server present?
+        #   topology.has_writable_server?(servers)
+        #
+        # @param [ Cluster ] cluster The cluster.
+        #
+        # @return [ false ] An Unknown topology will never have a writable server.
+        #
+        # @since 2.4.0
+        def has_writable_server?(cluster); false; end
+
         # Initialize the topology with the options.
         #
         # @example Initialize the topology.
         #   Unknown.new(options)
         #
         # @param [ Hash ] options The options.
+        # @param [ Monitoring ] monitoring The monitoring.
+        # @param [ Array<String> ] seeds The seeds.
         #
         # @since 2.0.0
-        def initialize(options, seeds = [])
+        def initialize(options, monitoring, seeds = [])
           @options = options
+          @monitoring = monitoring
           @seeds = seeds
         end
 
@@ -195,25 +231,45 @@ module Mongo
         # @since 2.0.6
         def standalone_discovered
           if @seeds.size == 1
-            Single.new(options, @seeds)
+            single = Single.new(options, monitoring, @seeds)
+            topology_changed(single)
+            single
           else
             self
           end
         end
 
+        # Notify the topology that a member was discovered.
+        #
+        # @example Notify the topology that a member was discovered.
+        #   topology.member_discovered
+        #
+        # @since 2.4.0
+        def member_discovered
+          publish_sdam_event(
+            Monitoring::TOPOLOGY_CHANGED,
+            Monitoring::Event::TopologyChanged.new(self, self)
+          )
+        end
+
         private
 
         def initialize_replica_set(description, servers)
-          log_debug(
-            "Server #{description.address.to_s} discovered as primary in replica set: " +
-            "'#{description.replica_set_name}'. Changing topology to replica set."
-          )
           servers.each do |server|
             if server.standalone? && server.address != description.address
               server.description.unknown!
             end
           end
-          ReplicaSet.new(options.merge(:replica_set => description.replica_set_name))
+          replica_set = ReplicaSet.new(options.merge(:replica_set => description.replica_set_name), monitoring)
+          topology_changed(replica_set)
+          replica_set
+        end
+
+        def topology_changed(new_topology)
+          publish_sdam_event(
+            Monitoring::TOPOLOGY_CHANGED,
+            Monitoring::Event::TopologyChanged.new(self, new_topology)
+          )
         end
       end
     end

data/lib/mongo/error/invalid_server_preference.rb

@@ -33,7 +33,9 @@ module Mongo
       # Error message for when the max staleness is not at least twice the heartbeat frequency.
       #
       # @since 2.4.0
-      INVALID_MAX_STALENESS = "max_staleness must be at least twice the client's heartbeat frequency.".freeze
+      INVALID_MAX_STALENESS = "`max_staleness` value is too small. It must be at least " +
+        "`ServerSelector::SMALLEST_MAX_STALENESS_SECONDS` and (the cluster's heartbeat_frequency " +
+          "setting + `Cluster::IDLE_WRITE_PERIOD_SECONDS`).".freeze
 
       # Error message when max staleness cannot be used because one or more servers has version < 3.4.
       #

data/lib/mongo/event.rb

@@ -16,6 +16,7 @@ require 'mongo/event/listeners'
 require 'mongo/event/publisher'
 require 'mongo/event/subscriber'
 require 'mongo/event/primary_elected'
+require 'mongo/event/member_discovered'
 require 'mongo/event/description_changed'
 require 'mongo/event/standalone_discovered'
 
@@ -30,8 +31,15 @@ module Mongo
     # When a server is elected primary.
     #
     # @since 2.0.0
+    #
+    # @deprecated. Will be removed in 3.0
     PRIMARY_ELECTED = 'primary_elected'.freeze
 
+    # When a server is discovered to be a member of a topology.
+    #
+    # @since 2.4.0
+    MEMBER_DISCOVERED = 'member_discovered'.freeze
+
     # When a server is to be removed from a cluster.
     #
     # @since 2.0.6

data/lib/mongo/event/description_changed.rb

@@ -20,10 +20,17 @@ module Mongo
     #
     # @since 2.0.6
     class DescriptionChanged
+      include Monitoring::Publishable
 
-      # @return [ Mongo::Cluster ] cluster The event publisher.
+      # @return [ Mongo::Cluster ] cluster The cluster.
       attr_reader :cluster
 
+      # @return [ Hash ] options The options.
+      attr_reader :options
+
+      # @return [ Monitoring ] monitoring The monitoring.
+      attr_reader :monitoring
+
       # Initialize the new host added event handler.
       #
       # @example Create the new handler.
@@ -34,6 +41,8 @@ module Mongo
       # @since 2.0.0
       def initialize(cluster)
         @cluster = cluster
+        @options = cluster.options
+        @monitoring = cluster.monitoring
       end
 
       # This event publishes an event to add the cluster and logs the
@@ -45,7 +54,16 @@ module Mongo
       # @param [ Server::Description ] updated The changed description.
       #
       # @since 2.0.0
-      def handle(updated)
+      def handle(previous, updated)
+        publish_sdam_event(
+          Monitoring::SERVER_DESCRIPTION_CHANGED,
+          Monitoring::Event::ServerDescriptionChanged.new(
+            updated.address,
+            cluster.topology,
+            previous,
+            updated
+          )
+        )
         cluster.add_hosts(updated)
         cluster.remove_hosts(updated)
       end

data/lib/mongo/event/member_discovered.rb

@@ -0,0 +1,65 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Event
+
+    # This handles member discovered events for server descriptions.
+    #
+    # @since 2.4.0
+    class MemberDiscovered
+      include Monitoring::Publishable
+
+      # @return [ Mongo::Cluster ] cluster The cluster.
+      attr_reader :cluster
+
+      # @return [ Hash ] options The options.
+      attr_reader :options
+
+      # @return [ Monitoring ] monitoring The monitoring.
+      attr_reader :monitoring
+
+      # Initialize the new member discovered event handler.
+      #
+      # @example Create the new handler.
+      #   MemberDiscovered.new(cluster)
+      #
+      # @param [ Mongo::Cluster ] cluster The cluster to publish from.
+      #
+      # @since 2.0.0
+      def initialize(cluster)
+        @cluster = cluster
+        @options = cluster.options
+        @monitoring = cluster.monitoring
+      end
+
+      # This event tells the cluster that a member of a topology is discovered.
+      #
+      # @example Handle the event.
+      #   member_discovered.handle(previous_description, description)
+      #
+      # @param [ Server::Description ] previous The previous description of the server.
+      # @param [ Server::Description ] updated The updated description of the server.
+      #
+      # @since 2.4.0
+      def handle(previous, updated)
+        if updated.primary? || updated.mongos?
+          cluster.elect_primary!(updated)
+        else
+          cluster.member_discovered
+        end
+      end
+    end
+  end
+end

data/lib/mongo/event/primary_elected.rb

@@ -18,9 +18,11 @@ module Mongo
     # This handles primary elected events for server descriptions.
     #
     # @since 2.0.0
+    #
+    # @deprecated. Will be removed in 3.0
     class PrimaryElected
 
-      # @return [ Mongo::Cluster ] cluster The event publisher.
+      # @return [ Mongo::Cluster ] cluster The cluster.
       attr_reader :cluster
 
       # Initialize the new primary elected event handler.

data/lib/mongo/event/standalone_discovered.rb

@@ -20,7 +20,7 @@ module Mongo
     # @since 2.0.6
     class StandaloneDiscovered
 
-      # @return [ Mongo::Cluster ] cluster The event publisher.
+      # @return [ Mongo::Cluster ] cluster The cluster.
       attr_reader :cluster
 
       # Initialize the new standalone discovered event handler.

data/lib/mongo/monitoring.rb

@@ -15,6 +15,12 @@
 require 'mongo/monitoring/event'
 require 'mongo/monitoring/publishable'
 require 'mongo/monitoring/command_log_subscriber'
+require 'mongo/monitoring/sdam_log_subscriber'
+require 'mongo/monitoring/server_description_changed_log_subscriber'
+require 'mongo/monitoring/server_closed_log_subscriber'
+require 'mongo/monitoring/server_opening_log_subscriber'
+require 'mongo/monitoring/topology_changed_log_subscriber'
+require 'mongo/monitoring/topology_opening_log_subscriber'
 
 module Mongo
 
@@ -28,6 +34,36 @@ module Mongo
     # @since 2.1.0
     COMMAND = 'Command'.freeze
 
+    # Server closed topic.
+    #
+    # @since 2.4.0
+    SERVER_CLOSED = 'ServerClosed'.freeze
+
+    # Server description changed topic.
+    #
+    # @since 2.4.0
+    SERVER_DESCRIPTION_CHANGED = 'ServerDescriptionChanged'.freeze
+
+    # Server opening topic.
+    #
+    # @since 2.4.0
+    SERVER_OPENING = 'ServerOpening'.freeze
+
+    # Topology changed topic.
+    #
+    # @since 2.4.0
+    TOPOLOGY_CHANGED = 'TopologyChanged'.freeze
+
+    # Topology closed topic.
+    #
+    # @since 2.4.0
+    TOPOLOGY_CLOSED = 'TopologyClosed'.freeze
+
+    # Topology opening topic.
+    #
+    # @since 2.4.0
+    TOPOLOGY_OPENING = 'TopologyOpening'.freeze
+
     @@operation_id = 0
     @@operation_id_lock = Mutex.new
 
@@ -101,6 +137,11 @@ module Mongo
           end
         end
         subscribe(COMMAND, CommandLogSubscriber.new(options))
+        subscribe(SERVER_OPENING, ServerOpeningLogSubscriber.new(options))
+        subscribe(SERVER_CLOSED, ServerClosedLogSubscriber.new(options))
+        subscribe(SERVER_DESCRIPTION_CHANGED, ServerDescriptionChangedLogSubscriber.new(options))
+        subscribe(TOPOLOGY_OPENING, TopologyOpeningLogSubscriber.new(options))
+        subscribe(TOPOLOGY_CHANGED, TopologyChangedLogSubscriber.new(options))
       end
     end