mongo 2.6.4 → 2.7.0.rc0

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

@@ -0,0 +1,27 @@
+# Copyright (C) 2018-2019 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
+  class Cluster
+    module Topology
+
+      # Defines behavior when a cluster is in replica set topology,
+      # and is a no primary which has been discovered by the driver.
+      #
+      # @since 2.7.0
+      class ReplicaSetWithPrimary < ReplicaSetNoPrimary
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,23 +16,17 @@ module Mongo
   class Cluster
     module Topology
 
-      # Defines behaviour for when a cluster is in sharded topology.
+      # Defines behavior for when a cluster is in sharded topology.
       #
       # @since 2.0.0
-      class Sharded
-        include Monitoring::Publishable
+      class Sharded < Base
+        include NoReplicaSetOptions
 
         # The display name for the topology.
         #
         # @since 2.0.0
         NAME = 'Sharded'.freeze
 
-        # @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.
@@ -42,21 +36,17 @@ module Mongo
         #
         # @since 2.0.0
         def display_name
-          NAME
+          self.class.name.gsub(/.*::/, '')
         end
 
-        # Elect a primary server within this topology.
-        #
-        # @example Elect a primary server.
-        #   topology.elect_primary(description, servers)
+        # @note This method is experimental and subject to change.
         #
-        # @param [ Server::Description ] description The description of the
-        #   elected primary.
-        # @param [ Array<Server> ] servers The list of known servers to the
-        #   cluster.
-        #
-        # @return [ Sharded ] The topology.
-        def elect_primary(description, servers); self; end
+        # @api experimental
+        # @since 2.7.0
+        def summary
+          details = server_descriptions.keys.join(',')
+          "#{display_name}[#{details}]"
+        end
 
         # Determine if the topology would select a readable server for the
         # provided candidates and read preference.
@@ -86,21 +76,6 @@ module Mongo
         # @since 2.4.0
         def has_writable_server?(cluster); true; end
 
-        # Initialize the topology with the options.
-        #
-        # @example Initialize the topology.
-        #   Sharded.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, monitoring, seeds = [])
-          @options = options
-          @monitoring = monitoring
-        end
-
         # A sharded topology is not a replica set.
         #
         # @example Is the topology a replica set?
@@ -111,16 +86,6 @@ module Mongo
         # @since 2.0.0
         def replica_set?; false; end
 
-        # Sharded topologies have no replica set name.
-        #
-        # @example Get the replica set name.
-        #   sharded.replica_set_name
-        #
-        # @return [ nil ] Always nil.
-        #
-        # @since 2.0.0
-        def replica_set_name; nil; end
-
         # Select appropriate servers for this topology.
         #
         # @example Select the servers.
@@ -135,50 +100,6 @@ module Mongo
           servers.select{ |server| server.mongos? }
         end
 
-        # Whether a server description's hosts may be added to the cluster.
-        #
-        # @example Check if a description's hosts may be added to the cluster.
-        #   topology.add_hosts?(description, servers)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        # @param [ Array<Mongo::Server> ] servers The cluster servers.
-        #
-        # @return [ false ] A description's hosts are never added to a
-        #   sharded cluster.
-        #
-        # @since 2.0.6
-        def add_hosts?(description, servers); false; end
-
-        # Whether a description can be used to remove hosts from the cluster.
-        #
-        # @example Check if a description can be used to remove hosts from
-        # the cluster.
-        #   topology.remove_hosts?(description)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        #
-        # @return [ true ] A description can always be used to remove hosts
-        #   from a sharded cluster.
-        #
-        # @since 2.0.6
-        def remove_hosts?(description); true; end
-
-        # Whether a specific server in the cluster can be removed, given a description.
-        #
-        # @example Check if a specific server can be removed from the cluster.
-        #   topology.remove_server?(description, server)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        # @param [ Mongo::Serve ] server The server in question.
-        #
-        # @return [ true, false ] Whether the server can be removed from the cluster.
-        #
-        # @since 2.0.6
-        def remove_server?(description, server)
-          remove_self?(description, server) ||
-            !(server.mongos? || server.unknown?)
-        end
-
         # A sharded topology is sharded.
         #
         # @example Is the topology sharded?
@@ -208,30 +129,6 @@ module Mongo
         #
         # @since 2.0.0
         def unknown?; false; end
-
-        # Notify the topology that a standalone was discovered.
-        #
-        # @example Notify the topology that a standalone was discovered.
-        #   topology.standalone_discovered
-        #
-        # @return [ Topology::Sharded ] Always returns self.
-        #
-        # @since 2.0.6
-        def standalone_discovered; self; end
-
-        # Notify the topology that a member was discovered.
-        #
-        # @example Notify the cluster that a member was discovered.
-        #   topology.member_discovered
-        #
-        # @since 2.4.0
-        def member_discovered; end;
-
-        private
-
-        def remove_self?(description, server)
-          description.is_server?(server) && !(description.mongos? || description.unknown?)
-        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,26 +16,16 @@ module Mongo
   class Cluster
     module Topology
 
-      # Defines behaviour for when a cluster is in single topology.
+      # Defines behavior for when a cluster is in single topology.
       #
       # @since 2.0.0
-      class Single
-        include Monitoring::Publishable
+      class Single < Base
 
         # 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.
@@ -45,21 +35,17 @@ module Mongo
         #
         # @since 2.0.0
         def display_name
-          NAME
+          self.class.name.gsub(/.*::/, '')
         end
 
-        # Elect a primary server within this topology.
-        #
-        # @example Elect a primary server.
-        #   topology.elect_primary(description, servers)
-        #
-        # @param [ Server::Description ] description The description of the
-        #   elected primary.
-        # @param [ Array<Server> ] servers The list of known servers to the
-        #   cluster.
+        # @note This method is experimental and subject to change.
         #
-        # @return [ Single ] The topology.
-        def elect_primary(description, servers); self; end
+        # @api experimental
+        # @since 2.7.0
+        def summary
+          details = server_descriptions.keys.join(',')
+          "#{display_name}[#{details}]"
+        end
 
         # Determine if the topology would select a readable server for the
         # provided candidates and read preference.
@@ -89,22 +75,6 @@ module Mongo
         # @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, monitoring, seeds = [])
-          @options = options
-          @monitoring = monitoring
-          @seed = seeds.first
-        end
-
         # A single topology is not a replica set.
         #
         # @example Is the topology a replica set?
@@ -115,16 +85,6 @@ module Mongo
         # @since 2.0.0
         def replica_set?; false; end
 
-        # Single topologies have no replica set name.
-        #
-        # @example Get the replica set name.
-        #   single.replica_set_name
-        #
-        # @return [ nil ] Always nil.
-        #
-        # @since 2.0.0
-        def replica_set_name; nil; end
-
         # Select appropriate servers for this topology.
         #
         # @example Select the servers.
@@ -139,47 +99,6 @@ module Mongo
           [ servers.detect { |server| !server.unknown? } ]
         end
 
-        # Whether a server description's hosts may be added to the cluster.
-        #
-        # @example Check if a description's hosts may be added to the cluster.
-        #   topology.add_hosts?(description, servers)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        # @param [ Array<Mongo::Server> ] servers The cluster servers.
-        #
-        # @return [ false ] A description's hosts are never added to a
-        #   cluster of Single topology.
-        #
-        # @since 2.0.6
-        def add_hosts?(description, servers); false; end
-
-        # Whether a description can be used to remove hosts from the cluster.
-        #
-        # @example Check if a description can be used to remove hosts from
-        # the cluster.
-        #   topology.remove_hosts?(description)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        #
-        # @return [ true ] A description can never be used to remove hosts
-        #   from a cluster of Single topology.
-        #
-        # @since 2.0.6
-        def remove_hosts?(description); false; end
-
-        # Whether a specific server in the cluster can be removed, given a description.
-        #
-        # @example Check if a specific server can be removed from the cluster.
-        #   topology.remove_server?(description, server)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        # @param [ Mongo::Serve ] server The server in question.
-        #
-        # @return [ false ] A server is never removed from a cluster of Single topology.
-        #
-        # @since 2.0.6
-        def remove_server?(description, server); false; end
-
         # A single topology is not sharded.
         #
         # @example Is the topology sharded?
@@ -210,27 +129,14 @@ module Mongo
         # @since 2.0.0
         def unknown?; false; end
 
-        # Notify the topology that a standalone was discovered.
-        #
-        # @example Notify the topology that a standalone was discovered.
-        #   topology.standalone_discovered
-        #
-        # @return [ Topology::Single ] Always returns self.
-        #
-        # @since 2.0.6
-        def standalone_discovered; self; end
+        private
 
-        # 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)
-          )
+        def validate_options(options, cluster)
+          if cluster.servers_list.length > 1
+            raise ArgumentError, 'Cannot instantiate a single topology with more than one server in the cluster'
+          end
+
+          super(options, cluster)
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,24 +16,17 @@ module Mongo
   class Cluster
     module Topology
 
-      # Defines behaviour for when a cluster is in an unknown state.
+      # Defines behavior for when a cluster is in an unknown state.
       #
       # @since 2.0.0
-      class Unknown
-        include Loggable
-        include Monitoring::Publishable
+      class Unknown < Base
+        include NoReplicaSetOptions
 
         # The display name for the topology.
         #
         # @since 2.0.0
         NAME = 'Unknown'.freeze
 
-        # @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.
@@ -43,28 +36,16 @@ module Mongo
         #
         # @since 2.0.0
         def display_name
-          NAME
+          self.class.name.gsub(/.*::/, '')
         end
 
-        # Elect a primary server within this topology.
-        #
-        # @example Elect a primary server.
-        #   topology.elect_primary(description, servers)
+        # @note This method is experimental and subject to change.
         #
-        # @param [ Server::Description ] description The description of the
-        #   elected primary.
-        # @param [ Array<Server> ] servers The list of known servers to the
-        #   cluster.
-        #
-        # @return [ Sharded, ReplicaSet ] The new topology.
-        def elect_primary(description, servers)
-          if description.mongos?
-            sharded = Sharded.new(options, monitoring)
-            topology_changed(sharded)
-            sharded
-          else
-            initialize_replica_set(description, servers)
-          end
+        # @api experimental
+        # @since 2.7.0
+        def summary
+          details = server_descriptions.keys.join(',')
+          "#{display_name}[#{details}]"
         end
 
         # Determine if the topology would select a readable server for the
@@ -95,22 +76,6 @@ module Mongo
         # @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, monitoring, seeds = [])
-          @options = options
-          @monitoring = monitoring
-          @seeds = seeds
-        end
-
         # An unknown topology is not a replica set.
         #
         # @example Is the topology a replica set?
@@ -121,16 +86,6 @@ module Mongo
         # @since 2.0.0
         def replica_set?; false; end
 
-        # Unknown topologies have no replica set name.
-        #
-        # @example Get the replica set name.
-        #   unknown.replica_set_name
-        #
-        # @return [ nil ] Always nil.
-        #
-        # @since 2.0.0
-        def replica_set_name; nil; end
-
         # Select appropriate servers for this topology.
         #
         # @example Select the servers.
@@ -175,102 +130,6 @@ module Mongo
         #
         # @since 2.0.0
         def unknown?; true; end
-
-        # Whether a server description's hosts may be added to the cluster.
-        #
-        # @example Check if a description's hosts may be added to the cluster.
-        #   topology.add_hosts?(description, servers)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        # @param [ Array<Mongo::Server> ] servers The cluster servers.
-        #
-        # @return [ true, false ] Whether a description's hosts may be added.
-        #
-        # @since 2.0.6
-        def add_hosts?(description, servers)
-          !(description.unknown? || description.ghost?)
-        end
-
-        # Whether a description can be used to remove hosts from the cluster.
-        #
-        # @example Check if a description can be used to remove hosts from the cluster.
-        #   topology.remove_hosts?(description)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        #
-        # @return [ true, false ] Whether hosts may be removed from the cluster.
-        #
-        # @since 2.0.6
-        def remove_hosts?(description)
-          description.standalone?
-        end
-
-        # Whether a specific server in the cluster can be removed, given a description.
-        #
-        # @example Check if a specific server can be removed from the cluster.
-        #   topology.remove_server?(description, server)
-        #
-        # @param [ Mongo::Server::Description ] description The description.
-        # @param [ Mongo::Serve ] server The server in question.
-        #
-        # @return [ true, false ] Whether the server can be removed from the cluster.
-        #
-        # @since 2.0.6
-        def remove_server?(description, server)
-          description.standalone? && description.is_server?(server)
-        end
-
-        # Notify the topology that a standalone was discovered.
-        #
-        # @example Notify the topology that a standalone was discovered.
-        #   topology.standalone_discovered
-        #
-        # @return [ Topology::Unknown, Topology::Single ] Either self or a
-        #   new Single topology.
-        #
-        # @since 2.0.6
-        def standalone_discovered
-          if @seeds.size == 1
-            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)
-          servers.each do |server|
-            if server.standalone? && server.address != description.address
-              server.description.unknown!
-            end
-          end
-          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
   end