mongo 2.6.4 → 2.7.0.rc0

data/lib/mongo/cluster/topology.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.
@@ -12,14 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/cluster/topology/replica_set'
-require 'mongo/cluster/topology/sharded'
-require 'mongo/cluster/topology/single'
-require 'mongo/cluster/topology/unknown'
-
 module Mongo
   class Cluster
-
     # Defines behavior for getting servers.
     #
     # Topologies are associated with their clusters - for example, a
@@ -35,14 +29,28 @@ module Mongo
     # @since 2.0.0
     module Topology
       extend self
+    end
+  end
+end
 
+require 'mongo/cluster/topology/base'
+require 'mongo/cluster/topology/no_replica_set_options'
+require 'mongo/cluster/topology/replica_set_no_primary'
+require 'mongo/cluster/topology/replica_set_with_primary'
+require 'mongo/cluster/topology/sharded'
+require 'mongo/cluster/topology/single'
+require 'mongo/cluster/topology/unknown'
+
+module Mongo
+  class Cluster
+    module Topology
       # The various topologies for server selection.
       #
       # @since 2.0.0
       OPTIONS = {
-        replica_set: ReplicaSet,
+        replica_set: ReplicaSetNoPrimary,
         sharded: Sharded,
-        direct: Single
+        direct: Single,
       }.freeze
 
       # Get the initial cluster topology for the provided options.
@@ -50,21 +58,34 @@ module Mongo
       # @example Get the initial cluster topology.
       #   Topology.initial(topology: :replica_set)
       #
-      # @param [ Array<String> ] seeds The addresses of the configured servers.
+      # @param [ Cluster ] cluster The cluster.
       # @param [ Monitoring ] monitoring The monitoring.
       # @param [ Hash ] options The cluster options.
       #
       # @return [ ReplicaSet, Sharded, Single ] The topology.
       #
       # @since 2.0.0
-      def initial(seeds, monitoring, options)
-        if options.has_key?(:connect)
-          OPTIONS.fetch(options[:connect].to_sym).new(options, monitoring, seeds)
-        elsif options.has_key?(:replica_set)
-          ReplicaSet.new(options, monitoring, seeds)
+      # @api private
+      def initial(cluster, monitoring, options)
+        cls = if options.key?(:connect)
+          OPTIONS.fetch(options[:connect].to_sym)
+        elsif options.key?(:replica_set) || options.key?(:replica_set_name)
+          ReplicaSetNoPrimary
         else
-          Unknown.new(options, monitoring, seeds)
+          Unknown
+        end
+        # Options here are client/cluster/server options.
+        # In particular the replica set name key is different for
+        # topology.
+        # If replica_set_name is given (as might be internally by driver),
+        # use that key.
+        # Otherwise (e.g. options passed down from client),
+        # move replica_set to replica_set_name.
+        if (cls <= ReplicaSetNoPrimary || cls == Single) && !options[:replica_set_name]
+          options = options.dup
+          options[:replica_set_name] = options.delete(:replica_set)
         end
+        cls.new(options, monitoring, cluster)
       end
     end
   end

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

@@ -0,0 +1,218 @@
+# 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 common to all topologies.
+      #
+      # @since 2.7.0
+      class Base
+        extend Forwardable
+        include Loggable
+        include Monitoring::Publishable
+
+        # Initialize the topology with the options.
+        #
+        # @param [ Hash ] options The options.
+        # @param [ Monitoring ] monitoring The monitoring.
+        # @param [ Cluster ] cluster The cluster.
+        #
+        # @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 cluster. If the addresses
+        #   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.
+        #   This option can only be specified when instantiating a replica
+        #   set topology.
+        # @option options [ BSON::ObjectId ] :max_election_id Max election id
+        #   per the SDAM specification.
+        #   This option can only be specified when instantiating a replica
+        #   set topology.
+        # @option options [ Integer ] :max_set_version Max set version
+        #   per the SDAM specification.
+        #   This option can only be specified when instantiating a replica
+        #   set topology.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(options, monitoring, cluster)
+          options = validate_options(options, cluster)
+
+          @options = options
+          @monitoring = monitoring
+          @cluster = cluster
+          # The list of server descriptions is simply fixed at the time of
+          # topology creation. If server description change later, a
+          # new topology instance should be created.
+          @server_descriptions = {}
+          (servers = cluster.servers_list).each do |server|
+            @server_descriptions[server.address.to_s] = server.description
+          end
+
+          begin
+            server_descriptions.each do |address_str, desc|
+              unless desc.unknown?
+                desc.features.check_driver_support!
+              end
+            end
+          rescue Error::UnsupportedFeatures => e
+            @compatible = false
+            @compatibility_error = e
+          else
+            @compatible = true
+          end
+
+          @have_data_bearing_servers = false
+          @logical_session_timeout = server_descriptions.inject(nil) do |min, (address_str, desc)|
+            # LST is only read from data-bearing servers
+            if desc.data_bearing?
+              @have_data_bearing_servers = true
+              break unless timeout = desc.logical_session_timeout
+              [timeout, (min || timeout)].min
+            else
+              min
+            end
+          end
+
+          if Mongo::Lint.enabled?
+            freeze
+          end
+        end
+
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # @return [ Cluster ] The cluster.
+        # @api private
+        attr_reader :cluster
+        private :cluster
+
+        # @return [ Array<String> ] addresses Server addresses.
+        def addresses
+          cluster.addresses.map(&:seed)
+        end
+
+        # @return [ monitoring ] monitoring the monitoring.
+        attr_reader :monitoring
+
+        # 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
+          options[:replica_set_name]
+        end
+
+        # @return [ Hash ] server_descriptions The map of address strings to
+        #   server descriptions, one for each server in the cluster.
+        #
+        # @since 2.7.0
+        attr_reader :server_descriptions
+
+        # @return [ true|false ] compatible Whether topology is compatible
+        #   with the driver.
+        #
+        # @since 2.7.0
+        def compatible?
+          @compatible
+        end
+
+        # @return [ Exception ] compatibility_error If topology is incompatible
+        #   with the driver, an exception with information regarding the incompatibility.
+        #   If topology is compatible with the driver, nil.
+        #
+        # @since 2.7.0
+        attr_reader :compatibility_error
+
+        # The logical session timeout value in minutes.
+        #
+        # @note The value is in minutes, unlike most other times in the
+        #   driver which are returned in seconds.
+        #
+        # @return [ Integer, nil ] The logical session timeout.
+        #
+        # @since 2.7.0
+        attr_reader :logical_session_timeout
+
+        # @return [ true | false ] have_data_bearing_servers Whether the
+        #   topology has any data bearing servers, for the purposes of
+        #   logical session timeout calculation.
+        #
+        # @api private
+        def data_bearing_servers?
+          @have_data_bearing_servers
+        end
+
+        # The largest electionId ever reported by a primary.
+        # May be nil.
+        #
+        # @return [ BSON::ObjectId ] The election id.
+        #
+        # @since 2.7.0
+        def max_election_id
+          options[:max_election_id]
+        end
+
+        # The largest setVersion ever reported by a primary.
+        # May be nil.
+        #
+        # @return [ Integer ] The set version.
+        #
+        # @since 2.7.0
+        def max_set_version
+          options[:max_set_version]
+        end
+
+        # @api private
+        def new_max_election_id(description)
+          if description.election_id &&
+              (max_election_id.nil? ||
+                  description.election_id > max_election_id)
+            description.election_id
+          else
+            max_election_id
+          end
+        end
+
+        # @api private
+        def new_max_set_version(description)
+          if description.set_version &&
+              (max_set_version.nil? ||
+                  description.set_version > max_set_version)
+            description.set_version
+          else
+            max_set_version
+          end
+        end
+
+        private
+
+        # Validates and/or transforms options as necessary for the topology.
+        #
+        # @return [ Hash ] New options
+        def validate_options(options, cluster)
+          options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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
+      module NoReplicaSetOptions
+        private
+
+        def validate_options(options, cluster)
+          # These options can be set to nil for convenience, but not to
+          # any value including an empty string.
+          [:replica_set_name, :max_election_id, :max_set_version].each do |option|
+            if options[option]
+              raise ArgumentError, "Topology #{self.class.name} cannot have the :#{option} option set"
+            end
+          end
+          super(options, cluster)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+# 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.
+# 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 there is no primary or the primary has not yet been discovered
+      # by the driver.
+      #
+      # @since 2.0.0
+      class ReplicaSetNoPrimary < Base
+
+        # The display name for the topology.
+        #
+        # @since 2.0.0
+        # @deprecated
+        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
+          self.class.name.gsub(/.*::/, '')
+        end
+
+        # @note This method is experimental and subject to change.
+        #
+        # @api experimental
+        # @since 2.7.0
+        def summary
+          details = server_descriptions.keys.join(',')
+          if details != ''
+            details << ','
+          end
+          details << "name=#{replica_set_name}"
+          if max_set_version
+            details << ",v=#{max_set_version}"
+          end
+          if max_election_id
+            details << ",e=#{max_election_id && max_election_id.to_s.sub(/^0+/, '')}"
+          end
+          "#{display_name}[#{details}]"
+        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
+
+        # A replica set topology is a replica set.
+        #
+        # @example Is the topology a replica set?
+        #   topology.replica_set?
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 2.0.0
+        def replica_set?; true; 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
+
+        # 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
+
+        private
+
+        def validate_options(options, cluster)
+          if options[:replica_set_name] == ''
+            options = options.merge(replica_set_name: nil)
+          end
+
+          unless options[:replica_set_name]
+            raise ArgumentError, 'Cannot instantiate a replica set topology without a replica set name'
+          end
+
+          super(options, cluster)
+        end
+      end
+    end
+  end
+end