mongo 2.6.4 → 2.7.0.rc0

data/lib/mongo/server/description/features.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.
@@ -16,13 +16,22 @@ module Mongo
   class Server
     class Description
 
-      # Defines behaviour around what features a specific server supports.
+      # Defines behavior around what features a specific server supports.
       #
       # @since 2.0.0
       class Features
 
         # List of features and the wire protocol version they appear in.
         #
+        # Wire protocol versions map to server releases as follows:
+        # - 2 => 2.6
+        # - 3 => 3.0
+        # - 4 => 3.2
+        # - 5 => 3.4
+        # - 6 => 3.6
+        # - 7 => 4.0
+        # - 8 => 4.2
+        #
         # @since 2.0.0
         MAPPINGS = {
           :transactions => 7,
@@ -55,7 +64,7 @@ module Mongo
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (2..7).freeze
+        DRIVER_WIRE_VERSIONS = (2..8).freeze
 
         # Create the methods for each mapping to tell if they are supported.
         #
@@ -88,8 +97,18 @@ module Mongo
         #
         # @since 2.0.0
         def initialize(server_wire_versions, address = nil)
+          if server_wire_versions.min.nil?
+            raise ArgumentError, "server_wire_versions's min is nil"
+          end
+          if server_wire_versions.max.nil?
+            raise ArgumentError, "server_wire_versions's max is nil"
+          end
           @server_wire_versions = server_wire_versions
           @address = address
+
+          if Mongo::Lint.enabled?
+            freeze
+          end
         end
 
         # Check that there is an overlap between the driver supported wire

data/lib/mongo/server/monitor.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,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/server/monitor/connection'
-
 module Mongo
   class Server
 
@@ -24,6 +22,7 @@ module Mongo
     class Monitor
       include Loggable
       extend Forwardable
+      include Event::Publisher
 
       # The default time for a server to refresh its status is 10 seconds.
       #
@@ -39,22 +38,52 @@ module Mongo
       # The weighting factor (alpha) for calculating the average moving round trip time.
       #
       # @since 2.0.0
+      # @deprecated Will be removed in version 3.0.
       RTT_WEIGHT_FACTOR = 0.2.freeze
 
-      # @return [ Mongo::Connection ] connection The connection to use.
+      # Create the new server monitor.
+      #
+      # @example Create the server monitor.
+      #   Mongo::Server::Monitor.new(address, listeners, monitoring)
+      #
+      # @note Monitor must never be directly instantiated outside of a Server.
+      #
+      # @param [ Address ] address The address to monitor.
+      # @param [ Event::Listeners ] event_listeners The event listeners.
+      # @param [ Monitoring ] monitoring The monitoring..
+      # @param [ Hash ] options The options.
+      # @option options [ Float ] :heartbeat_frequency The interval, in seconds,
+      #   between server description refreshes via ismaster.
+      #
+      # @since 2.0.0
+      # @api private
+      def initialize(address, event_listeners, monitoring, options = {})
+        unless monitoring.is_a?(Monitoring)
+          raise ArgumentError, "Wrong monitoring type: #{monitoring.inspect}"
+        end
+        @description = Description.new(address, {})
+        @event_listeners = event_listeners
+        @monitoring = monitoring
+        @options = options.freeze
+        @round_trip_time_averager = RoundTripTimeAverager.new
+        @scan_semaphore = Semaphore.new
+        # This is a Mongo::Server::Monitor::Connection
+        @connection = Connection.new(address, options)
+        @last_scan = nil
+        @mutex = Mutex.new
+      end
+
+      # @return [ Mongo::Server::Monitor::Connection ] connection The connection to use.
       attr_reader :connection
 
       # @return [ Server::Description ] description The server
       #   description the monitor refreshes.
       attr_reader :description
 
-      # @return [ Description::Inspector ] inspector The description inspector.
-      attr_reader :inspector
-
       # @return [ Hash ] options The server options.
       attr_reader :options
 
-      # @return [ Time ] last_scan The time of the last server scan.
+      # @return [ Time ] last_scan The time when the last server scan started.
       #
       # @since 2.4.0
       attr_reader :last_scan
@@ -63,31 +92,11 @@ module Mongo
       # of the connection.
       def_delegators :connection, :compressor
 
-      # Perform a check of the server with throttling, and update
-      # the server's description.
-      #
-      # If the server was checked less than MIN_SCAN_FREQUENCY seconds
-      # ago, sleep until MIN_SCAN_FREQUENCY seconds have passed since the last
-      # check. Then perform the check which involves running isMaster
-      # on the server being monitored and updating the server description
-      # as a result.
-      #
-      # @note If the system clock is set to a time in the past, this method
-      #   can sleep for a very long time.
-      #
-      # @example Run a scan.
-      #   monitor.scan!
-      #
-      # @return [ Description ] The updated description.
-      #
-      # @since 2.0.0
-      def scan!
-        throttle_scan_frequency!
-        @description = inspector.run(description, *ismaster)
-      end
+      # @return [ Monitoring ] monitoring The monitoring.
+      attr_reader :monitoring
 
-      # Get the refresh interval for the server. This will be defined via an option
-      # or will default to 5.
+      # Get the refresh interval for the server. This will be defined via an
+      # option or will default to 10.
       #
       # @example Get the refresh interval.
       #   server.heartbeat_frequency
@@ -99,29 +108,8 @@ module Mongo
         @heartbeat_frequency ||= options[:heartbeat_frequency] || HEARTBEAT_FREQUENCY
       end
 
-      # Create the new server monitor.
-      #
       # @api private
-      #
-      # @example Create the server monitor.
-      #   Mongo::Server::Monitor.new(address, listeners)
-      #
-      # @note Monitor must never be directly instantiated outside of a Server.
-      #
-      # @param [ Address ] address The address to monitor.
-      # @param [ Event::Listeners ] listeners The event listeners.
-      # @param [ Hash ] options The options.
-      #
-      # @since 2.0.0
-      def initialize(address, listeners, options = {})
-        @description = Description.new(address, {})
-        @inspector = Description::Inspector.new(listeners)
-        @options = options.freeze
-        @connection = Connection.new(address, options)
-        @last_round_trip_time = nil
-        @last_scan = nil
-        @mutex = Mutex.new
-      end
+      attr_reader :scan_semaphore
 
       # Runs the server monitor. Refreshing happens on a separate thread per
       # server.
@@ -135,23 +123,82 @@ module Mongo
       def run!
         @thread = Thread.new(heartbeat_frequency) do |i|
           loop do
-            sleep(i)
             scan!
+            @scan_semaphore.wait(i)
           end
         end
       end
 
+      # Perform a check of the server with throttling, and update
+      # the server's description and average round trip time.
+      #
+      # If the server was checked less than MIN_SCAN_FREQUENCY seconds
+      # ago, sleep until MIN_SCAN_FREQUENCY seconds have passed since the last
+      # check. Then perform the check which involves running isMaster
+      # on the server being monitored and updating the server description
+      # as a result.
+      #
+      # @note If the system clock is set to a time in the past, this method
+      #   can sleep for a very long time.
+      #
+      # @example Run a scan.
+      #   monitor.scan!
+      #
+      # @return [ Description ] The updated description.
+      #
+      # @since 2.0.0
+      def scan!
+        throttle_scan_frequency!
+        result = ismaster
+        new_description = Description.new(description.address, result,
+          @round_trip_time_averager.average_round_trip_time)
+        publish(Event::DESCRIPTION_CHANGED, description, new_description)
+        # If this server's response has a mismatched me, or for other reasons,
+        # this server may be removed from topology. When this happens the
+        # monitor thread gets killed. As a result, any code after the publish
+        # call may not run in a particular monitor instance, hence there
+        # shouldn't be any code here.
+        @description = new_description
+        # This call can be after the publish event because if the
+        # monitoring thread gets killed the server is closed and no client
+        # should be waiting for it
+        if options[:server_selection_semaphore]
+          options[:server_selection_semaphore].broadcast
+        end
+        @description
+      end
+
       # Stops the server monitor. Kills the thread so it doesn't continue
       # taking memory and sending commands to the connection.
       #
       # @example Stop the monitor.
       #   monitor.stop!
       #
-      # @return [ Boolean ] Is the Thread stopped?
+      # @param [ Boolean ] wait Whether to wait for background threads to
+      #   finish running.
+      #
+      # @return [ Boolean ] Is the thread stopped?
       #
       # @since 2.0.0
-      def stop!
-        connection.disconnect! && @thread.kill && @thread.stop?
+      def stop!(wait=false)
+        # Although disconnect! documentation implies a possibility of
+        # failure, all of our disconnects always return true
+        if connection.disconnect!
+          if @thread
+            @thread.kill
+            if wait
+              @thread.join
+              @thread = nil
+              true
+            else
+              !@thread.alive?
+            end
+          else
+            true
+          end
+        else
+          false
+        end
       end
 
       # Restarts the server monitor unless the current thread is alive.
@@ -163,29 +210,48 @@ module Mongo
       #
       # @since 2.1.0
       def restart!
-        @thread.alive? ? @thread : run!
+        if @thread && @thread.alive?
+          @thread
+        else
+          run!
+        end
       end
 
-      private
-
-      def average_round_trip_time(start)
-        new_rtt = Time.now - start
-        RTT_WEIGHT_FACTOR * new_rtt + (1 - RTT_WEIGHT_FACTOR) * (@last_round_trip_time || new_rtt)
-      end
+      # @api private
+      attr_reader :round_trip_time_averager
 
-      def calculate_average_round_trip_time(start)
-        @last_round_trip_time = average_round_trip_time(start)
-      end
+      private
 
       def ismaster
         @mutex.synchronize do
-          start = Time.now
-          begin
-            return connection.ismaster, calculate_average_round_trip_time(start)
-          rescue Exception => e
-            log_debug(e.message)
-            return {}, calculate_average_round_trip_time(start)
+          if monitoring.monitoring?
+            monitoring.started(
+              Monitoring::SERVER_HEARTBEAT,
+              Monitoring::Event::ServerHeartbeatStarted.new(connection.address)
+            )
+          end
+
+          result, exc, rtt, average_rtt = round_trip_time_averager.measure do
+            connection.ismaster
           end
+          if exc
+            log_debug("Error running ismaster on #{connection.address}: #{exc.message}")
+            if monitoring.monitoring?
+              monitoring.failed(
+                Monitoring::SERVER_HEARTBEAT,
+                Monitoring::Event::ServerHeartbeatFailed.new(connection.address, rtt, exc)
+              )
+            end
+            result = {}
+          else
+            if monitoring.monitoring?
+              monitoring.succeeded(
+                Monitoring::SERVER_HEARTBEAT,
+                Monitoring::Event::ServerHeartbeatSucceeded.new(connection.address, rtt)
+              )
+            end
+          end
+          result
         end
       end
 
@@ -202,3 +268,6 @@ module Mongo
     end
   end
 end
+
+require 'mongo/server/monitor/connection'
+require 'mongo/server/monitor/app_metadata'

data/lib/mongo/server/monitor/app_metadata.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 Server
+    class Monitor
+      # App metadata for monitoring sockets.
+      #
+      # It is easiest to start with the normal app metadata and remove
+      # authentication-related bits.
+      #
+      # @api private
+      class AppMetadata < Server::AppMetadata
+        def initialize(options)
+          super
+          if instance_variable_defined?(:@request_auth_mech)
+            remove_instance_variable(:@request_auth_mech)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/monitor/connection.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -42,7 +42,7 @@ module Mongo
         # The constant for the ismaster command as an OP_MSG (server versions >= 3.6).
         #
         # @since 2.5.0
-        ISMASTER_OP_MSG_MESSAGE = Protocol::Msg.new([:none], {}, ISMASTER_OP_MSG)
+        ISMASTER_OP_MSG_MESSAGE = Protocol::Msg.new([], {}, ISMASTER_OP_MSG)
 
         # The raw bytes for the ismaster message.
         #
@@ -73,6 +73,46 @@ module Mongo
         COMPRESSION_WARNING = 'The server has no compression algorithms in common with those requested. ' +
                                 'Compression will not be used.'.freeze
 
+        # Initialize a new socket connection from the client to the server.
+        #
+        # @api private
+        #
+        # @example Create the connection.
+        #   Connection.new(address)
+        #
+        # @note Connection must never be directly instantiated outside of a
+        #   Monitor.
+        #
+        # @param [ Mongo::Address ] address The address the connection is for.
+        # @param [ Hash ] options The connection options.
+        #
+        # @option options [ Mongo::Server::Monitor::AppMetadata ] :app_metadata
+        #   Metadata to use for handshake. If missing or nil, handshake will
+        #   not be performed. Although a Mongo::Server::AppMetadata instance
+        #   will also work, monitoring connections are meant to use
+        #   Mongo::Server::Monitor::AppMetadata instances in order to omit
+        #   performing SCRAM negotiation with the server, as monitoring
+        #   sockets do not authenticate.
+        # @option options [ Array<String> ] :compressors A list of potential
+        #   compressors to use, in order of preference. The driver chooses the
+        #   first compressor that is also supported by the server. Currently the
+        #   driver only supports 'zlib'.
+        # @option options [ Float ] :connect_timeout The timeout, in seconds,
+        #   to use for network operations. This timeout is used for all
+        #   socket operations rather than connect calls only, contrary to
+        #   what the name implies,
+        #
+        # @since 2.0.0
+        def initialize(address, options = {})
+          @address = address
+          @options = options.freeze
+          @app_metadata = options[:app_metadata]
+          @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
+          @socket = nil
+          @pid = Process.pid
+          @compressor = nil
+        end
+
         # The compressor, which is determined during the handshake.
         #
         # @since 2.5.0
@@ -134,30 +174,6 @@ module Mongo
           true
         end
 
-        # Initialize a new socket connection from the client to the server.
-        #
-        # @api private
-        #
-        # @example Create the connection.
-        #   Connection.new(address)
-        #
-        # @note Connection must never be directly instantiated outside of a
-        #   Monitor.
-        #
-        # @param [ Mongo::Address ] address The address the connection is for.
-        # @param [ Hash ] options The connection options.
-        #
-        # @since 2.0.0
-        def initialize(address, options = {})
-          @address = address
-          @options = options.freeze
-          @app_metadata = options[:app_metadata]
-          @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
-          @socket = nil
-          @pid = Process.pid
-          @compressor = nil
-        end
-
         # Get the socket timeout.
         #
         # @example Get the socket timeout.