mongo 2.4.1 → 2.14.0

data/lib/mongo/server.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# Copyright (C) 2014-2020 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,13 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/server/connectable'
-require 'mongo/server/connection'
-require 'mongo/server/connection_pool'
-require 'mongo/server/context'
-require 'mongo/server/description'
-require 'mongo/server/monitor'
-
 module Mongo
 
   # Represents a single server on the server side that can be standalone, part of
@@ -28,6 +21,66 @@ module Mongo
   class Server
     extend Forwardable
     include Monitoring::Publishable
+    include Event::Publisher
+
+    # The default time in seconds to timeout a connection attempt.
+    #
+    # @since 2.4.3
+    CONNECT_TIMEOUT = 10.freeze
+
+    # Instantiate a new server object. Will start the background refresh and
+    # subscribe to the appropriate events.
+    #
+    # @api private
+    #
+    # @example Initialize the server.
+    #   Mongo::Server.new('127.0.0.1:27017', cluster, monitoring, listeners)
+    #
+    # @note Server must never be directly instantiated outside of a Cluster.
+    #
+    # @param [ Address ] address The host:port address to connect to.
+    # @param [ Cluster ] cluster  The cluster the server belongs to.
+    # @param [ Monitoring ] monitoring The monitoring.
+    # @param [ Event::Listeners ] event_listeners The event listeners.
+    # @param [ Hash ] options The server options.
+    #
+    # @option options [ Boolean ] :monitor For internal driver use only:
+    #   whether to monitor the server after instantiating it.
+    # @option options [ true, false ] :monitoring_io For internal driver
+    #   use only. Set to false to prevent SDAM-related I/O from being
+    #   done by this server. Note: setting this option to false will make
+    #   the server non-functional. It is intended for use in tests which
+    #   manually invoke SDAM state transitions.
+    #
+    # @since 2.0.0
+    def initialize(address, cluster, monitoring, event_listeners, options = {})
+      @address = address
+      @cluster = cluster
+      @monitoring = monitoring
+      options = options.dup
+      _monitor = options.delete(:monitor)
+      @options = options.freeze
+      @event_listeners = event_listeners
+      @connection_id_gen = Class.new do
+        include Id
+      end
+      @scan_semaphore = DistinguishingSemaphore.new
+      @round_trip_time_averager = RoundTripTimeAverager.new
+      @description = Description.new(address, {})
+      @last_scan = nil
+      unless options[:monitoring_io] == false
+        @monitor = Monitor.new(self, event_listeners, monitoring,
+          options.merge(
+            app_metadata: Monitor::AppMetadata.new(cluster.options),
+            heartbeat_interval: cluster.heartbeat_interval,
+        ))
+        unless _monitor == false
+          start_monitoring
+        end
+      end
+      @connected = true
+      @pool_lock = Mutex.new
+    end
 
     # @return [ String ] The configured address for the server.
     attr_reader :address
@@ -35,7 +88,8 @@ module Mongo
     # @return [ Cluster ] cluster The server cluster.
     attr_reader :cluster
 
-    # @return [ Monitor ] monitor The server monitor.
+    # @return [ nil | Monitor ] monitor The server monitor. nil if the servenr
+    #   was created with monitoring_io: false option.
     attr_reader :monitor
 
     # @return [ Hash ] The options hash.
@@ -44,10 +98,53 @@ module Mongo
     # @return [ Monitoring ] monitoring The monitoring.
     attr_reader :monitoring
 
-    # Get the description from the monitor and scan on monitor.
-    def_delegators :monitor, :description, :scan!, :heartbeat_frequency, :last_scan
+    # @return [ Server::Description ] description The server
+    #   description the monitor refreshes.
+    attr_reader :description
+
+    # @return [ Time | nil ] last_scan The time when the last server scan
+    #   completed, or nil if the server has not been scanned yet.
+    #
+    # @since 2.4.0
+    def last_scan
+      if description && !description.config.empty?
+        description.last_update_time
+      else
+        @last_scan
+      end
+    end
+
+    # @deprecated
+    def heartbeat_frequency
+      cluster.heartbeat_interval
+    end
+
+    # @deprecated
     alias :heartbeat_frequency_seconds :heartbeat_frequency
 
+    # Performs an immediate, synchronous check of the server.
+    #
+    # @deprecated
+    def_delegators :monitor, :scan!
+
+    # The compressor negotiated by the server monitor, if any.
+    #
+    # This attribute is nil if no server check has not yet completed, and if
+    # no compression was negatiated.
+    #
+    # @note Compression is negotiated for each connection separately.
+    #
+    # @return [ String | nil ] The negotiated compressor.
+    #
+    # @deprecated
+    def compressor
+      if monitor
+        monitor.compressor
+      else
+        nil
+      end
+    end
+
     # Delegate convenience methods to the monitor description.
     def_delegators :description,
                    :arbiter?,
@@ -66,12 +163,27 @@ module Mongo
                    :secondary?,
                    :standalone?,
                    :unknown?,
-                   :unknown!,
-                   :last_write_date
+                   :last_write_date,
+                   :logical_session_timeout
 
     # Get the app metadata from the cluster.
     def_delegators :cluster,
-                   :app_metadata
+                   :app_metadata,
+                   :cluster_time,
+                   :update_cluster_time
+
+    def_delegators :features,
+                   :check_driver_support!
+
+    # @return [ Semaphore ] Semaphore to signal to request an immediate scan
+    #   of this server by its monitor, if one is running.
+    #
+    # @api private
+    attr_reader :scan_semaphore
+
+    # @return [ RoundTripTimeAverager ] Round trip time averager object.
+    # @api private
+    attr_reader :round_trip_time_averager
 
     # Is this server equal to another?
     #
@@ -111,23 +223,53 @@ module Mongo
     # @return [ true, false ] If the server is connectable.
     #
     # @since 2.1.0
-    def connectable?
-      with_connection do |connection|
-        connection.connectable?
-      end
-    end
+    #
+    # @deprecated No longer necessary with Server Selection specification.
+    def connectable?; end
 
-    # Disconnect the server from the connection.
+    # Disconnect the driver from this server.
     #
-    # @example Disconnect the server.
-    #   server.disconnect!
+    # Disconnects all idle connections to this server in its connection pool,
+    # if any exist. Stops the populator of the connection pool, if it is
+    # running. Does not immediately close connections which are presently
+    # checked out (i.e. in use) - such connections will be closed when they
+    # are returned to their respective connection pools. Stop the server's
+    # background monitor.
     #
-    # @return [ true ] Always tru with no exception.
+    # @return [ true ] Always true.
     #
     # @since 2.0.0
     def disconnect!
-      pool.disconnect!
-      monitor.stop! and true
+      if monitor
+        monitor.stop!
+      end
+      _pool = @pool_lock.synchronize do
+        @pool
+      end
+      if _pool
+        # For backwards compatibility we disconnect/clear the pool rather
+        # than close it here. We also stop the populator which allows the
+        # the pool to continue providing connections but stops it from
+        # connecting in background on clients/servers that are in fact
+        # intended to be closed and no longer used.
+        begin
+          _pool.disconnect!(stop_populator: true)
+        rescue Error::PoolClosedError
+          # If the pool was already closed, we don't need to do anything here.
+        end
+      end
+      @connected = false
+      true
+    end
+
+    # Whether the server is connected.
+    #
+    # @return [ true|false ] Whether the server is connected.
+    #
+    # @api private
+    # @since 2.7.0
+    def connected?
+      @connected
     end
 
     # When the server is flagged for garbage collection, stop the monitor
@@ -143,36 +285,21 @@ module Mongo
       proc { monitor.stop! }
     end
 
-    # Instantiate a new server object. Will start the background refresh and
-    # subscribe to the appropriate events.
+    # Start monitoring the server.
     #
-    # @api private
+    # Used internally by the driver to add a server to a cluster
+    # while delaying monitoring until the server is in the cluster.
     #
-    # @example Initialize the server.
-    #   Mongo::Server.new('127.0.0.1:27017', cluster, monitoring, listeners)
-    #
-    # @note Server must never be directly instantiated outside of a Cluster.
-    #
-    # @param [ Address ] address The host:port address to connect to.
-    # @param [ Cluster ] cluster  The cluster the server belongs to.
-    # @param [ Monitoring ] monitoring The monitoring.
-    # @param [ Event::Listeners ] event_listeners The event listeners.
-    # @param [ Hash ] options The server options.
-    #
-    # @since 2.0.0
-    def initialize(address, cluster, monitoring, event_listeners, options = {})
-      @address = address
-      @cluster = cluster
-      @monitoring = monitoring
-      @options = options.freeze
+    # @api private
+    def start_monitoring
       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!
-      ObjectSpace.define_finalizer(self, self.class.finalize(monitor))
+      if options[:monitoring_io] != false
+        ObjectSpace.define_finalizer(self, self.class.finalize(monitor))
+        monitor.run!
+      end
     end
 
     # Get a pretty printed server inspection.
@@ -184,7 +311,62 @@ module Mongo
     #
     # @since 2.0.0
     def inspect
-      "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port}>"
+      "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port} #{status}>"
+    end
+
+    # @return [ String ] String representing server status (e.g. PRIMARY).
+    #
+    # @api private
+    def status
+      case
+      when primary?
+        'PRIMARY'
+      when secondary?
+        'SECONDARY'
+      when standalone?
+        'STANDALONE'
+      when arbiter?
+        'ARBITER'
+      when ghost?
+        'GHOST'
+      when other?
+        'OTHER'
+      when mongos?
+        'MONGOS'
+      when unknown?
+        'UNKNOWN'
+      else
+        # Since the summary method is often used for debugging, do not raise
+        # an exception in case none of the expected types matched
+        nil
+      end
+    end
+
+    # @note This method is experimental and subject to change.
+    #
+    # @api experimental
+    # @since 2.7.0
+    def summary
+      status = self.status || ''
+      if replica_set_name
+        status += " replica_set=#{replica_set_name}"
+      end
+
+      unless monitor&.running?
+        status += " NO-MONITORING"
+      end
+
+      if @pool
+        status += " pool=#{@pool.summary}"
+      end
+
+      address_bit = if address
+        "#{address.host}:#{address.port}"
+      else
+        'nil'
+      end
+
+      "#<Server address=#{address_bit} #{status}>"
     end
 
     # Get the connection pool for this server.
@@ -192,11 +374,13 @@ module Mongo
     # @example Get the connection pool for the server.
     #   server.pool
     #
-    # @return [ Mongo::Pool ] The connection pool.
+    # @return [ Mongo::Server::ConnectionPool ] The connection pool.
     #
     # @since 2.0.0
     def pool
-      @pool ||= cluster.pool(self)
+      @pool_lock.synchronize do
+        @pool ||= ConnectionPool.new(self, options)
+      end
     end
 
     # Determine if the provided tags are a subset of the server's tags.
@@ -224,7 +408,10 @@ module Mongo
     #
     # @since 2.1.0
     def reconnect!
-      monitor.restart! and true
+      if options[:monitoring_io] != false
+        monitor.restart!
+      end
+      @connected = true
     end
 
     # Execute a block of code with a connection, that is checked out of the
@@ -242,6 +429,17 @@ module Mongo
       pool.with_connection(&block)
     end
 
+    # Handle handshake failure.
+    #
+    # @since 2.7.0
+    # @api private
+    def handle_handshake_failure!
+      yield
+    rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError => e
+      unknown!(generation: e.generation, stop_push_monitor: true)
+      raise
+    end
+
     # Handle authentication failure.
     #
     # @example Handle possible authentication failure.
@@ -256,9 +454,122 @@ module Mongo
     # @since 2.3.0
     def handle_auth_failure!
       yield
+    rescue Mongo::Error::SocketTimeoutError
+      # possibly cluster is slow, do not give up on it
+      raise
+    rescue Mongo::Error::SocketError => e
+      # non-timeout network error
+      unknown!(generation: e.generation, stop_push_monitor: true)
+      raise
     rescue Auth::Unauthorized
-      unknown!
+      # auth error, keep server description and topology as they are
+      pool.disconnect!
       raise
     end
+
+    # Whether the server supports modern read retries.
+    #
+    # @api private
+    def retry_reads?
+      !!(features.sessions_enabled? && logical_session_timeout)
+    end
+
+    # Will writes sent to this server be retried.
+    #
+    # @example Will writes be retried.
+    #   server.retry_writes?
+    #
+    # @return [ true, false ] If writes will be retried.
+    #
+    # @note Retryable writes are only available on server versions 3.6+ and with
+    #   sharded clusters or replica sets.
+    #
+    # @since 2.5.0
+    def retry_writes?
+      !!(features.sessions_enabled? && logical_session_timeout && !standalone?)
+    end
+
+    # Marks server unknown and publishes the associated SDAM event
+    # (server description changed).
+    #
+    # If the generation is passed in options, the server will only be marked
+    # unknown if the passed generation is no older than the current generation
+    # of the server's connection pool.
+    #
+    # @param [ Hash ] options Options.
+    #
+    # @option options [ Integer ] :generation Connection pool generation of
+    #   the connection that was used for the operation that produced the error.
+    # @option options [ true | false ] :keep_connection_pool Usually when the
+    #   new server description is unknown, the connection pool on the
+    #   respective server is cleared. Set this option to true to keep the
+    #   existing connection pool (required when handling not master errors
+    #   on 4.2+ servers).
+    # @option options [ TopologyVersion ] :topology_version Topology version
+    #   of the error response that is causing the server to be marked unknown.
+    # @option options [ true | false ] :stop_push_monitor Whether to stop
+    #   the PushMonitor associated with the server, if any.
+    #
+    # @since 2.4.0, SDAM events are sent as of version 2.7.0
+    def unknown!(options = {})
+      if options[:generation] && options[:generation] < pool.generation
+        return
+      end
+
+      if options[:topology_version] && description.topology_version &&
+        !options[:topology_version].gt?(description.topology_version)
+      then
+        return
+      end
+
+      if options[:stop_push_monitor]
+        monitor&.stop_push_monitor!
+      end
+
+      # SDAM flow will update description on the server without in-place
+      # mutations and invoke SDAM transitions as needed.
+      config = {}
+      if options[:topology_version]
+        config['topologyVersion'] = options[:topology_version]
+      end
+      new_description = Description.new(address, config)
+      cluster.run_sdam_flow(description, new_description, options)
+    end
+
+    # @api private
+    def update_description(description)
+      @description = description
+    end
+
+    # @api private
+    def clear_connection_pool
+      @pool_lock.synchronize do
+        if @pool
+          @pool.disconnect!
+        end
+      end
+    end
+
+    # @api private
+    def next_connection_id
+      @connection_id_gen.next_id
+    end
+
+    # @api private
+    def update_last_scan
+      @last_scan = Time.now
+    end
   end
 end
+
+require 'mongo/server/app_metadata'
+require 'mongo/server/connection_common'
+require 'mongo/server/connection_base'
+require 'mongo/server/pending_connection'
+require 'mongo/server/connection'
+require 'mongo/server/connection_pool'
+require 'mongo/server/context'
+require 'mongo/server/description'
+require 'mongo/server/monitor'
+require 'mongo/server/round_trip_time_averager'
+require 'mongo/server/push_monitor'