mongo 2.4.0.rc1 → 2.4.0

data/lib/mongo/monitoring/topology_changed_log_subscriber.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2016 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 Monitoring
+
+    # Subscribes to Topology Changed events and logs them.
+    #
+    # @since 2.4.0
+    class TopologyChangedLogSubscriber < SDAMLogSubscriber
+
+      private
+
+      def log_event(event)
+        if event.previous_topology != event.new_topology
+          log_debug(
+            "Topology type '#{event.previous_topology.display_name.downcase}' changed to " +
+            "type '#{event.new_topology.display_name.downcase}'."
+          )
+        else
+          log_debug(
+            "There was a change in the members of the '#{event.new_topology.display_name.downcase}' " +
+              "topology."
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/topology_opening_log_subscriber.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2016 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 Monitoring
+
+    # Subscribes to Topology Openeing events and logs them.
+    #
+    # @since 2.4.0
+    class TopologyOpeningLogSubscriber < SDAMLogSubscriber
+
+      private
+
+      def log_event(event)
+        log_debug("Topology type '#{event.topology.display_name.downcase}' initializing.")
+      end
+    end
+  end
+end

data/lib/mongo/server.rb

@@ -27,6 +27,7 @@ module Mongo
   # @since 2.0.0
   class Server
     extend Forwardable
+    include Monitoring::Publishable
 
     # @return [ String ] The configured address for the server.
     attr_reader :address
@@ -45,6 +46,7 @@ module Mongo
 
     # Get the description from the monitor and scan on monitor.
     def_delegators :monitor, :description, :scan!, :heartbeat_frequency, :last_scan
+    alias :heartbeat_frequency_seconds :heartbeat_frequency
 
     # Delegate convenience methods to the monitor description.
     def_delegators :description,
@@ -163,6 +165,10 @@ module Mongo
       @cluster = cluster
       @monitoring = monitoring
       @options = options.freeze
+      publish_sdam_event(
+        Monitoring::SERVER_OPENING,
+        Monitoring::Event::ServerOpening.new(address, cluster.topology)
+      )
       @monitor = Monitor.new(address, event_listeners, options.merge(app_metadata: cluster.app_metadata))
       monitor.scan!
       monitor.run!

data/lib/mongo/server/connection.rb

@@ -175,7 +175,7 @@ module Mongo
       end
 
       def authenticate!
-        if options[:user]
+        if options[:user] || options[:auth_mech]
           user = Auth::User.new(Options::Redacted.new(:auth_mech => default_mechanism).merge(options))
           @server.handle_auth_failure! do
             Auth.get(user).login(self)

data/lib/mongo/server/description.rb

@@ -239,7 +239,7 @@ module Mongo
       #
       # @param [ Address ] address The server address.
       # @param [ Hash ] config The result of the ismaster command.
-      # @param [ Float ] average_round_trip_time The moving average time (ms) the ismaster
+      # @param [ Float ] average_round_trip_time The moving average time (sec) the ismaster
       #   call took to complete.
       #
       # @since 2.0.0
@@ -480,6 +480,24 @@ module Mongo
         !!config[SECONDARY] && !replica_set_name.nil?
       end
 
+      # Returns the server type as a symbol.
+      #
+      # @example Get the server type.
+      #   description.server_type
+      #
+      # @return [ Symbol ] The server type.
+      #
+      # @since 2.4.0
+      def server_type
+        return :arbiter if arbiter?
+        return :ghost if ghost?
+        return :sharded if mongos?
+        return :primary if primary?
+        return :secondary if secondary?
+        return :standalone if standalone?
+        :unknown
+      end
+
       # Is this server a standalone server?
       #
       # @example Is the server standalone?
@@ -501,7 +519,8 @@ module Mongo
       #
       # @since 2.0.0
       def unknown?
-        config.empty? || config[Operation::Result::OK] != 1
+        config.empty? || (config[Operation::Result::OK] &&
+                            config[Operation::Result::OK] != 1)
       end
 
       # A result from another server's ismaster command before this server has
@@ -592,6 +611,7 @@ module Mongo
       # @since 2.0.6
       def ==(other)
         return false if self.class != other.class
+        return false if unknown? || other.unknown?
         compare_config(other)
       end
       alias_method :eql?, :==
@@ -599,7 +619,7 @@ module Mongo
       private
 
       def compare_config(other)
-        !config.keys.empty? && config.keys.all? do |k|
+        config.keys.all? do |k|
           config[k] == other.config[k] || EXCLUDE_FOR_COMPARISON.include?(k)
         end
       end

data/lib/mongo/server/description/inspector.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/server/description/inspector/member_discovered'
+# @deprecated. Will be removed in 3.0
 require 'mongo/server/description/inspector/primary_elected'
 require 'mongo/server/description/inspector/description_changed'
 require 'mongo/server/description/inspector/standalone_discovered'
@@ -34,7 +36,7 @@ module Mongo
         INSPECTORS = [
             Inspector::StandaloneDiscovered,
             Inspector::DescriptionChanged,
-            Inspector::PrimaryElected
+            Inspector::MemberDiscovered
         ].freeze
 
         # @return [ Array ] inspectors The description inspectors.
@@ -61,7 +63,7 @@ module Mongo
         #
         # @param [ Description ] description The old description.
         # @param [ Hash ] ismaster The updated ismaster.
-        # @param [ Float ] average_round_trip_time The moving average round trip time (ms).
+        # @param [ Float ] average_round_trip_time The moving average round trip time (sec).
         #
         # @return [ Description ] The new description.
         #

data/lib/mongo/server/description/inspector/description_changed.rb

@@ -46,8 +46,8 @@ module Mongo
           #
           # @since 2.0.0
           def run(description, updated)
-            unless description == updated
-              publish(Event::DESCRIPTION_CHANGED, updated)
+            unless (description.unknown? && updated.unknown?) || (description == updated)
+              publish(Event::DESCRIPTION_CHANGED, description, updated)
             end
           end
         end

data/lib/mongo/server/description/inspector/member_discovered.rb

@@ -0,0 +1,59 @@
+# 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
+  class Server
+    class Description
+      class Inspector
+
+        # Handles inspecting the result of an ismaster command to check if this
+        # a server is a member of a known topology.
+        #
+        # @since 2.4.0
+        class MemberDiscovered
+          include Event::Publisher
+
+          # Instantiate the member discovered inspection.
+          #
+          # @example Instantiate the inspection.
+          #   MemberDiscovered.new(listeners)
+          #
+          # @param [ Event::Listeners ] event_listeners The event listeners.
+          #
+          # @since 2.4.0
+          def initialize(event_listeners)
+            @event_listeners = event_listeners
+          end
+
+          # Run the member discovered inspection.
+          #
+          # @example Run the inspection.
+          #   MemberDiscovered.run(description, {})
+          #
+          # @param [ Description ] description The server description.
+          # @param [ Description ] updated The updated description.
+          #
+          # @since 2.4.0
+          def run(description, updated)
+            if (!description.primary? && updated.primary?) ||
+                (!description.mongos? && updated.mongos?) ||
+                (description.unknown? && !updated.unknown?)
+              publish(Event::MEMBER_DISCOVERED, description, updated)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/description/inspector/primary_elected.rb

@@ -21,6 +21,8 @@ module Mongo
         # server was elected primary.
         #
         # @since 2.0.0
+        #
+        # @deprecated. Will be removed in 3.0
         class PrimaryElected
           include Event::Publisher
 

data/lib/mongo/server_selector.rb

@@ -38,6 +38,11 @@ module Mongo
     # @since 2.0.0
     SERVER_SELECTION_TIMEOUT = 30.freeze
 
+    # The smallest allowed max staleness value, in seconds.
+    #
+    # @since 2.4.0
+    SMALLEST_MAX_STALENESS_SECONDS = 90
+
     # Primary read preference.
     #
     # @since 2.1.0
@@ -48,11 +53,11 @@ module Mongo
     #
     # @since 2.0.0
     PREFERENCES = {
-        nearest: Nearest,
-        primary: Primary,
-        primary_preferred: PrimaryPreferred,
-        secondary: Secondary,
-        secondary_preferred: SecondaryPreferred
+      nearest: Nearest,
+      primary: Primary,
+      primary_preferred: PrimaryPreferred,
+      secondary: Secondary,
+      secondary_preferred: SecondaryPreferred
     }.freeze
 
     # Create a server selector object.

data/lib/mongo/server_selector/nearest.rb

@@ -67,7 +67,7 @@ module Mongo
       def to_mongos
         preference = { :mode => 'nearest' }
         preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
+        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
         preference
       end
 

data/lib/mongo/server_selector/primary_preferred.rb

@@ -68,7 +68,7 @@ module Mongo
       def to_mongos
         preference = { :mode => 'primaryPreferred' }
         preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
+        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
         preference
       end
 

data/lib/mongo/server_selector/secondary.rb

@@ -68,7 +68,7 @@ module Mongo
       def to_mongos
         preference = { :mode => 'secondary' }
         preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
+        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
         preference
       end
 

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -71,7 +71,7 @@ module Mongo
         return nil if tag_sets.empty? && max_staleness.nil?
         preference = { mode: 'secondaryPreferred' }
         preference.merge!({ tags: tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessMS: max_staleness * 1000 }) if max_staleness
+        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
         preference
       end
 

data/lib/mongo/server_selector/selectable.rb

@@ -26,7 +26,7 @@ module Mongo
       # @return [ Array ] tag_sets The tag sets used to select servers.
       attr_reader :tag_sets
 
-      # @return [ Float ] max_staleness The maximum replication lag, in seconds, that a
+      # @return [ Integer ] max_staleness The maximum replication lag, in seconds, that a
       #   secondary can suffer and still be eligible for a read.
       #
       # @since 2.4.0
@@ -68,7 +68,7 @@ module Mongo
       def initialize(options = {})
         @options = (options || {}).freeze
         @tag_sets = (options[:tag_sets] || []).freeze
-        @max_staleness = options[:max_staleness] if options[:max_staleness] && options[:max_staleness] > 0
+        @max_staleness = options[:max_staleness] unless options[:max_staleness] == -1
         validate!
       end
 
@@ -146,19 +146,29 @@ module Mongo
         @local_threshold ||= (options[:local_threshold] || ServerSelector::LOCAL_THRESHOLD)
       end
 
-      private
-
+      # Get the potential candidates to select from the cluster.
+      #
+      # @example Get the server candidates.
+      #   selectable.candidates(cluster)
+      #
+      # @param [ Cluster ] cluster The cluster.
+      #
+      # @return [ Array<Server> ] The candidate servers.
+      #
+      # @since 2.4.0
       def candidates(cluster)
         if cluster.single?
           cluster.servers.each { |server| validate_max_staleness_support!(server) }
         elsif cluster.sharded?
           near_servers(cluster.servers).each { |server| validate_max_staleness_support!(server) }
         else
-          validate_max_staleness_value!(cluster)
+          validate_max_staleness_value!(cluster) unless cluster.unknown?
           select(cluster.servers)
         end
       end
 
+      private
+
       # Select the primary from a list of provided candidates.
       #
       # @param [ Array ] candidates List of candidate servers to select the
@@ -200,7 +210,7 @@ module Mongo
       def near_servers(candidates = [])
         return candidates if candidates.empty?
         nearest_server = candidates.min_by(&:average_round_trip_time)
-        threshold = nearest_server.average_round_trip_time + (local_threshold * 1000)
+        threshold = nearest_server.average_round_trip_time + local_threshold
         candidates.select { |server| server.average_round_trip_time <= threshold }.shuffle!
       end
 
@@ -230,14 +240,14 @@ module Mongo
             validate_max_staleness_support!(server)
             staleness = (server.last_scan - server.last_write_date) -
                         (primary.last_scan - primary.last_write_date)  +
-                        (server.heartbeat_frequency * 1000)
+                        (server.heartbeat_frequency_seconds * 1000)
             staleness <= max_staleness_ms
           end
         else
           max_write_date = candidates.collect(&:last_write_date).max
           candidates.select do |server|
             validate_max_staleness_support!(server)
-            staleness = max_write_date - server.last_write_date + (server.heartbeat_frequency * 1000)
+            staleness = max_write_date - server.last_write_date + (server.heartbeat_frequency_seconds * 1000)
             staleness <= max_staleness_ms
           end
         end
@@ -258,10 +268,12 @@ module Mongo
       end
 
       def validate_max_staleness_value!(cluster)
-        return unless @max_staleness
-        heartbeat_frequency = cluster.options[:heartbeat_frequency] || Server::Monitor::HEARTBEAT_FREQUENCY
-        if @max_staleness < heartbeat_frequency * 2
-          raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::INVALID_MAX_STALENESS)
+        if @max_staleness
+          heartbeat_frequency_seconds = cluster.options[:heartbeat_frequency] || Server::Monitor::HEARTBEAT_FREQUENCY
+          unless @max_staleness >= [ SMALLEST_MAX_STALENESS_SECONDS,
+                                     (heartbeat_frequency_seconds  + Cluster::IDLE_WRITE_PERIOD_SECONDS) ].max
+            raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::INVALID_MAX_STALENESS)
+          end
         end
       end
     end

data/lib/mongo/uri.rb

@@ -374,7 +374,7 @@ module Mongo
     # Read Options
     uri_option 'readpreference', :mode, :group => :read, :type => :read_mode
     uri_option 'readpreferencetags', :tag_sets, :group => :read, :type => :read_tags
-    uri_option 'maxstalenessms', :max_staleness, :group => :read, :type => :ms_convert
+    uri_option 'maxstalenessseconds', :max_staleness, :group => :read
 
     # Pool options
     uri_option 'minpoolsize', :min_pool_size