mongo 2.6.4 → 2.7.0.rc0

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

@@ -1,339 +0,0 @@
-# Copyright (C) 2014-2018 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 behaviour when a cluster is in replica set topology.
-      #
-      # @since 2.0.0
-      class ReplicaSet
-        include Loggable
-        include Monitoring::Publishable
-
-        # Constant for the replica set name configuration option.
-        #
-        # @since 2.0.0
-        REPLICA_SET_NAME = :replica_set.freeze
-
-        # @return [ Hash ] options The options.
-        attr_reader :options
-
-        # @return [ Monitoring ] monitoring The monitoring.
-        attr_reader :monitoring
-
-        # The display name for the topology.
-        #
-        # @since 2.0.0
-        NAME = 'Replica Set'.freeze
-
-        # Get the display name.
-        #
-        # @example Get the display name.
-        #   ReplicaSet.display_name
-        #
-        # @return [ String ] The display name.
-        #
-        # @since 2.0.0
-        def display_name
-          NAME
-        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.
-        #
-        # @return [ ReplicaSet ] The topology.
-        def elect_primary(description, servers)
-          if description.replica_set_name == replica_set_name
-            unless detect_stale_primary!(description)
-              servers.each do |server|
-                if server.primary? && server.address != description.address
-                  server.description.unknown!
-                end
-              end
-              update_max_election_id(description)
-              update_max_set_version(description)
-            end
-          else
-            log_warn(
-              "Server #{description.address.to_s} has incorrect replica set name: " +
-              "'#{description.replica_set_name}'. The current replica set name is '#{replica_set_name}'."
-            )
-          end
-          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, false ] If a readable server is present.
-        #
-        # @since 2.4.0
-        def has_readable_server?(cluster, server_selector = nil)
-          (server_selector || ServerSelector.get(mode: :primary)).candidates(cluster).any?
-        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, false ] If a writable server is present.
-        #
-        # @since 2.4.0
-        def has_writable_server?(cluster)
-          cluster.servers.any?{ |server| server.primary? }
-        end
-
-        # Initialize the topology with the options.
-        #
-        # @example Initialize the topology.
-        #   ReplicaSet.new(options)
-        #
-        # @param [ Hash ] options The options.
-        # @param [ Monitoring ] monitoring The monitoring.
-        # @param [ Array<String> ] seeds The seeds.
-        #
-        # @option options [ Symbol ] :replica_set Name of the replica set to
-        #   connect to. Can be left blank (either nil or the empty string are
-        #   accepted) to discover the name from the seeds. If the seeds
-        #   belong to different replica sets there is no guarantee which
-        #   replica set is selected - in particular, the driver may choose
-        #   the replica set name of a secondary if it returns its response
-        #   prior to a primary belonging to a different replica set.
-        #
-        # @since 2.0.0
-        def initialize(options, monitoring, seeds = [])
-          @options = options
-          @monitoring = monitoring
-          @max_election_id = nil
-          @max_set_version = nil
-        end
-
-        # A replica set topology is a replica set.
-        #
-        # @example Is the topology a replica set?
-        #   ReplicaSet.replica_set?
-        #
-        # @return [ true ] Always true.
-        #
-        # @since 2.0.0
-        def replica_set?; true; end
-
-        # Get the replica set name configured for this topology.
-        #
-        # @example Get the replica set name.
-        #   topology.replica_set_name
-        #
-        # @return [ String ] The name of the configured replica set.
-        #
-        # @since 2.0.0
-        def replica_set_name
-          @replica_set_name ||= options[REPLICA_SET_NAME]
-        end
-
-        # Select appropriate servers for this topology.
-        #
-        # @example Select the servers.
-        #   ReplicaSet.servers(servers)
-        #
-        # @param [ Array<Server> ] servers The known servers.
-        #
-        # @return [ Array<Server> ] The servers in the replica set.
-        #
-        # @since 2.0.0
-        def servers(servers)
-          servers.select do |server|
-            (replica_set_name.nil? || server.replica_set_name == replica_set_name) &&
-              server.primary? || server.secondary?
-          end
-        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)
-          !!(member_of_this_set?(description) &&
-              (!has_primary?(servers) || description.primary?))
-        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.config.empty? &&
-            (description.primary? ||
-              description.me_mismatch? ||
-                description.hosts.empty? ||
-                  !member_of_this_set?(description))
-        end
-
-        # Whether a specific server in the cluster can be removed, given a description.
-        # As described in the SDAM spec, a server should be removed if the server's
-        # address does not match the "me" field of the isMaster response, if the server
-        # has a different replica set name, or if an isMaster response from the primary
-        # does not contain the server's address in the list of known hosts. Note that as
-        # described by the spec, a server determined to be of type Unknown from its
-        # isMaster response is NOT removed from the topology.
-        #
-        # @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)
-          ((server.address == description.address) && description.me_mismatch?) ||
-          remove_self?(description, server) ||
-            (member_of_this_set?(description) &&
-                description.server_type == :primary &&
-                !description.servers.empty? &&
-                  !description.lists_server?(server))
-        end
-
-        # A replica set topology is not sharded.
-        #
-        # @example Is the topology sharded?
-        #   ReplicaSet.sharded?
-        #
-        # @return [ false ] Always false.
-        #
-        # @since 2.0.0
-        def sharded?; false; end
-
-        # A replica set topology is not single.
-        #
-        # @example Is the topology single?
-        #   ReplicaSet.single?
-        #
-        # @return [ false ] Always false.
-        #
-        # @since 2.0.0
-        def single?; false; end
-
-        # A replica set topology is not unknown.
-        #
-        # @example Is the topology unknown?
-        #   ReplicaSet.unknown?
-        #
-        # @return [ false ] Always false.
-        #
-        # @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::ReplicaSet ] Always returns self.
-        #
-        # @since 2.0.6
-        def standalone_discovered; self; 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; end;
-
-        private
-
-        def update_max_election_id(description)
-          if description.election_id &&
-              (@max_election_id.nil? ||
-                  description.election_id > @max_election_id)
-            @max_election_id = description.election_id
-          end
-        end
-
-        def update_max_set_version(description)
-          if description.set_version &&
-              (@max_set_version.nil? ||
-                  description.set_version > @max_set_version)
-            @max_set_version = description.set_version
-          end
-        end
-
-        def detect_stale_primary!(description)
-          if description.election_id && description.set_version
-            if @max_set_version && @max_election_id &&
-                (description.set_version < @max_set_version ||
-                    (description.set_version == @max_set_version &&
-                        description.election_id < @max_election_id))
-              description.unknown!
-            end
-          end
-        end
-
-        def has_primary?(servers)
-          servers.find { |s| s.primary? }
-        end
-
-        def member_of_this_set?(description)
-          description.replica_set_member? &&
-            description.replica_set_name == replica_set_name
-        end
-
-        # As described by the SDAM spec, a server should be removed from the
-        # topology upon receiving its isMaster response if no error occurred
-        # and replica set name does not match that of the topology.
-        def remove_self?(description, server)
-          !description.unknown? &&
-            !member_of_this_set?(description) &&
-              description.is_server?(server) &&
-                !description.ghost?
-        end
-      end
-    end
-  end
-end

data/lib/mongo/event/member_discovered.rb

@@ -1,67 +0,0 @@
-# Copyright (C) 2015-2018 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.
-
-require 'mongo/monitoring/publishable'
-
-module Mongo
-  module Event
-
-    # This handles member discovered events for server descriptions.
-    #
-    # @since 2.4.0
-    class MemberDiscovered < Base
-      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

@@ -1,55 +0,0 @@
-# Copyright (C) 2015-2018 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 primary elected events for server descriptions.
-    #
-    # @since 2.0.0
-    #
-    # @deprecated. Will be removed in 3.0
-    class PrimaryElected < Base
-
-      # @return [ Mongo::Cluster ] cluster The cluster.
-      attr_reader :cluster
-
-      # Initialize the new primary elected event handler.
-      #
-      # @example Create the new handler.
-      #   PrimaryElected.new(cluster)
-      #
-      # @param [ Mongo::Cluster ] cluster The cluster to publish from.
-      #
-      # @since 2.0.0
-      def initialize(cluster)
-        @cluster = cluster
-      end
-
-      # This event tells the cluster to take all previous primaries to an
-      # unknown state.
-      #
-      # @example Handle the event.
-      #   primary_elected.handle(description)
-      #
-      # @param [ Server::Description ] description The description of the
-      #   elected server.
-      #
-      # @since 2.0.0
-      def handle(description)
-        cluster.elect_primary!(description)
-      end
-    end
-  end
-end