mongo 2.4.0.rc1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fceb612725957e97b29a1b35a376821d685dea7
-  data.tar.gz: 3f1ee5867327a164aa2bff5e00a517387df406e0
+  metadata.gz: 18d9f304edd2e651c1dfde03646f780951e4d068
+  data.tar.gz: d7bc0adaa7a4dc5eb8f319caafb1a98fd1357233
 SHA512:
-  metadata.gz: 70a87aadb4c5f8a31582dfada8c8810a4a71d8c7b59fd4fda010f2d680a8d555a2401e190e37d37106f268d40019e67926a7cb48ae33f5937d90b5227e9b29af
-  data.tar.gz: c6d42e01149a0140f59494999d98e69a3f7df8480fc5fac6054d518fca9d80fa58278e3529a8b9e7274ef069080d4e5f07cf1aae72e3119c90527465268b01b1
+  metadata.gz: 83e651334a083f7acb5e11c9c7cb650a8ce13ab3f7fb10ee4a839e05d7d2edca3adcdb3aeae3b795771b3c8b370772471565a0812cbdf30754c8a50b7e5c217a
+  data.tar.gz: 34db7e14619cc5b08235fff572034a19c282c982439f6feb7d3769ed5c402b05c60029309fc877d3505e8df6de31baee0519b4ebd6e36bfdeae926807f9e146b

data/lib/mongo/auth/cr/conversation.rb

@@ -98,7 +98,7 @@ module Mongo
 
         # Create the new conversation.
         #
-        # @example Create the new coversation.
+        # @example Create the new conversation.
         #   Conversation.new(user, "admin")
         #
         # @param [ Auth::User ] user The user to converse about.

data/lib/mongo/auth/ldap/conversation.rb

@@ -70,7 +70,7 @@ module Mongo
 
         # Create the new conversation.
         #
-        # @example Create the new coversation.
+        # @example Create the new conversation.
         #   Conversation.new(user, "admin")
         #
         # @param [ Auth::User ] user The user to converse about.

data/lib/mongo/auth/scram/conversation.rb

@@ -172,7 +172,7 @@ module Mongo
 
         # Create the new conversation.
         #
-        # @example Create the new coversation.
+        # @example Create the new conversation.
         #   Conversation.new(user)
         #
         # @param [ Auth::User ] user The user to converse about.

data/lib/mongo/auth/x509/conversation.rb

@@ -60,17 +60,19 @@ module Mongo
         #
         # @since 2.0.0
         def start
+          login = LOGIN.merge(mechanism: X509::MECHANISM)
+          login[:user] = user.name if user.name
           Protocol::Query.new(
             Auth::EXTERNAL,
             Database::COMMAND,
-            LOGIN.merge(user: user.name, mechanism: X509::MECHANISM),
+            login,
             limit: -1
           )
         end
 
         # Create the new conversation.
         #
-        # @example Create the new coversation.
+        # @example Create the new conversation.
         #   Conversation.new(user, "admin")
         #
         # @param [ Auth::User ] user The user to converse about.

data/lib/mongo/client.rb

@@ -48,6 +48,7 @@ module Mongo
       :min_pool_size,
       :monitoring,
       :password,
+      :platform,
       :read,
       :read_retry_interval,
       :replica_set,
@@ -200,10 +201,10 @@ module Mongo
     #   certification authority certifications used to validate certs passed from the
     #   other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or
     #   :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.
-    # @option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object An array of OpenSSL::X509::Certificate
-    #   reprenting the certification authority certifications used to validate certs passed from the
-    #   other end of the connection. One of :ssl_ca_cert, :ssl_ca_cert_string or
-    #   :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.
+    # @option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object An array of
+    #   OpenSSL::X509::Certificate representing the certification authority certifications used
+    #   to validate certs passed from the other end of the connection. One of :ssl_ca_cert,
+    #   :ssl_ca_cert_string or :ssl_ca_cert_object (in order of priority) is required for :ssl_verify.
     # @option options [ Float ] :socket_timeout The timeout, in seconds, to
     #   execute operations on a socket.
     # @option options [ String ] :user The user name.
@@ -222,6 +223,8 @@ module Mongo
     #   for documents. Must respond to #generate.
     # @option options [ String, Symbol ] :app_name Application name that is printed to the
     #   mongod logs upon establishing a connection in server versions >= 3.4.
+    # @option options [ String ] :platform Platform information to include in the
+    #   metadata printed to the mongod logs upon establishing a connection in server versions >= 3.4.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)

data/lib/mongo/cluster.rb

@@ -24,6 +24,7 @@ module Mongo
   # @since 2.0.0
   class Cluster
     extend Forwardable
+    include Monitoring::Publishable
     include Event::Subscriber
     include Loggable
 
@@ -37,9 +38,17 @@ module Mongo
     # @since 2.1.1
     READ_RETRY_INTERVAL = 5
 
+    # How often an idle primary writes a no-op to the oplog.
+    #
+    # @since 2.4.0
+    IDLE_WRITE_PERIOD_SECONDS = 10
+
     # @return [ Hash ] The options hash.
     attr_reader :options
 
+    # @return [ Monitoring ] monitoring The monitoring.
+    attr_reader :monitoring
+
     # @return [ Object ] The cluster topology.
     attr_reader :topology
 
@@ -49,7 +58,8 @@ module Mongo
     # @since 2.4.0
     attr_reader :app_metadata
 
-    def_delegators :topology, :replica_set?, :replica_set_name, :sharded?, :single?, :unknown?
+    def_delegators :topology, :replica_set?, :replica_set_name, :sharded?,
+                   :single?, :unknown?, :member_discovered
     def_delegators :@cursor_reaper, :register_cursor, :schedule_kill_cursor, :unregister_cursor
 
     # Determine if this cluster of servers is equal to another object. Checks the
@@ -84,7 +94,6 @@ module Mongo
       address = Address.new(host)
       if !addresses.include?(address)
         if addition_allowed?(address)
-          log_debug("Adding #{address.to_s} to the cluster.")
           @update_lock.synchronize { @addresses.push(address) }
           server = Server.new(address, self, @monitoring, event_listeners, options)
           @update_lock.synchronize { @servers.push(server) }
@@ -93,6 +102,34 @@ module Mongo
       end
     end
 
+    # Determine if the cluster would select a readable server for the
+    # provided read preference.
+    #
+    # @example Is a readable server present?
+    #   topology.has_readable_server?(server_selector)
+    #
+    # @param [ ServerSelector ] server_selector The server
+    #   selector.
+    #
+    # @return [ true, false ] If a readable server is present.
+    #
+    # @since 2.4.0
+    def has_readable_server?(server_selector = nil)
+      topology.has_readable_server?(self, server_selector)
+    end
+
+    # Determine if the cluster would select a writable server.
+    #
+    # @example Is a writable server present?
+    #   topology.has_writable_server?
+    #
+    # @return [ true, false ] If a writable server is present.
+    #
+    # @since 2.4.0
+    def has_writable_server?
+      topology.has_writable_server?(self)
+    end
+
     # Instantiate the new cluster.
     #
     # @api private
@@ -114,16 +151,26 @@ module Mongo
       @event_listeners = Event::Listeners.new
       @options = options.freeze
       @app_metadata ||= AppMetadata.new(self)
-      @topology = Topology.initial(seeds, options)
       @update_lock = Mutex.new
       @pool_lock = Mutex.new
+      @topology = Topology.initial(seeds, monitoring, options)
+
+      publish_sdam_event(
+        Monitoring::TOPOLOGY_OPENING,
+        Monitoring::Event::TopologyOpening.new(@topology)
+      )
 
       subscribe_to(Event::STANDALONE_DISCOVERED, Event::StandaloneDiscovered.new(self))
       subscribe_to(Event::DESCRIPTION_CHANGED, Event::DescriptionChanged.new(self))
-      subscribe_to(Event::PRIMARY_ELECTED, Event::PrimaryElected.new(self))
+      subscribe_to(Event::MEMBER_DISCOVERED, Event::MemberDiscovered.new(self))
 
       seeds.each{ |seed| add(seed) }
 
+      publish_sdam_event(
+        Monitoring::TOPOLOGY_CHANGED,
+        Monitoring::Event::TopologyChanged.new(@topology, @topology)
+      ) if @servers.size > 1
+
       @cursor_reaper = CursorReaper.new
       @cursor_reaper.run!
 
@@ -259,11 +306,14 @@ module Mongo
     #
     # @since 2.0.0
     def remove(host)
-      log_debug("#{host} being removed from the cluster.")
       address = Address.new(host)
       removed_servers = @servers.select { |s| s.address == address }
       @update_lock.synchronize { @servers = @servers - removed_servers }
       removed_servers.each{ |server| server.disconnect! } if removed_servers
+      publish_sdam_event(
+        Monitoring::SERVER_CLOSED,
+        Monitoring::Event::ServerClosed.new(address, topology)
+      )
       @update_lock.synchronize { @addresses.reject! { |addr| addr == address } }
     end
 

data/lib/mongo/cluster/app_metadata.rb

@@ -53,6 +53,7 @@ module Mongo
       # @since 2.4.0
       def initialize(cluster)
         @app_name = cluster.options[:app_name]
+        @platform = cluster.options[:platform]
       end
 
       # Get the bytes of the ismaster message including this metadata.
@@ -133,7 +134,12 @@ module Mongo
       end
 
       def platform
-        [RUBY_VERSION, RUBY_PLATFORM, RbConfig::CONFIG['build']].join(', ')
+        [
+          @platform,
+          RUBY_VERSION,
+          RUBY_PLATFORM,
+          RbConfig::CONFIG['build']
+        ].compact.join(', ')
       end
     end
   end

data/lib/mongo/cluster/topology.rb

@@ -26,14 +26,14 @@ module Mongo
     module Topology
       extend self
 
-      # The 2 various topologies for server selection.
+      # The various topologies for server selection.
       #
       # @since 2.0.0
       OPTIONS = {
         replica_set: ReplicaSet,
         sharded: Sharded,
         direct: Single
-      }
+      }.freeze
 
       # Get the initial cluster topology for the provided options.
       #
@@ -41,18 +41,19 @@ module Mongo
       #   Topology.initial(topology: :replica_set)
       #
       # @param [ Array<String> ] seeds The addresses of the configured servers.
+      # @param [ Monitoring ] monitoring The monitoring.
       # @param [ Hash ] options The cluster options.
       #
       # @return [ ReplicaSet, Sharded, Single ] The topology.
       #
       # @since 2.0.0
-      def initial(seeds, options)
+      def initial(seeds, monitoring, options)
         if options.has_key?(:connect)
-          OPTIONS.fetch(options[:connect]).new(options, seeds)
+          OPTIONS.fetch(options[:connect]).new(options, monitoring, seeds)
         elsif options.has_key?(:replica_set)
-          ReplicaSet.new(options, seeds)
+          ReplicaSet.new(options, monitoring, options)
         else
-          Unknown.new(options, seeds)
+          Unknown.new(options, monitoring, seeds)
         end
       end
     end

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

@@ -21,6 +21,7 @@ module Mongo
       # @since 2.0.0
       class ReplicaSet
         include Loggable
+        include Monitoring::Publishable
 
         # Constant for the replica set name configuration option.
         #
@@ -30,6 +31,9 @@ module Mongo
         # @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
@@ -61,7 +65,6 @@ module Mongo
         def elect_primary(description, servers)
           if description.replica_set_name == replica_set_name
             unless detect_stale_primary!(description)
-              log_debug("Server #{description.address.to_s} elected as primary in #{replica_set_name}.")
               servers.each do |server|
                 if server.primary? && server.address != description.address
                   server.description.unknown!
@@ -79,16 +82,51 @@ module Mongo
           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.
         #
         # @since 2.0.0
-        def initialize(options, seeds = [])
+        def initialize(options, monitoring, seeds = [])
           @options = options
+          @monitoring = monitoring
           @max_election_id = nil
           @max_set_version = nil
         end
@@ -222,6 +260,14 @@ module Mongo
         # @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)

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

@@ -20,12 +20,19 @@ module Mongo
       #
       # @since 2.0.0
       class Sharded
+        include Monitoring::Publishable
 
         # 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.
@@ -51,16 +58,47 @@ module Mongo
         # @return [ Sharded ] 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 Sharded cluster 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 Sharded cluster 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.
         #   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, seeds = [])
+        def initialize(options, monitoring, seeds = [])
           @options = options
+          @monitoring = monitoring
         end
 
         # A sharded topology is not a replica set.
@@ -181,6 +219,14 @@ module Mongo
         # @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)