mongo 2.11.2 → 2.13.0.beta1

data/lib/mongo/socket/tcp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -20,6 +20,42 @@ module Mongo
     # @since 2.0.0
     class TCP < Socket
 
+      # Initializes a new TCP socket.
+      #
+      # @example Create the TCP socket.
+      #   TCP.new('::1', 27017, 30, Socket::PF_INET)
+      #   TCP.new('127.0.0.1', 27017, 30, Socket::PF_INET)
+      #
+      # @param [ String ] host The hostname or IP address.
+      # @param [ Integer ] port The port number.
+      # @param [ Float ] timeout The socket timeout value.
+      # @param [ Integer ] family The socket family.
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ Float ] :connect_timeout Connect timeout.
+      # @option options [ Address ] :connection_address Address of the
+      #   connection that created this socket.
+      # @option options [ Integer ] :connection_generation Generation of the
+      #   connection (for non-monitoring connections) that created this socket.
+      # @option options [ true | false ] :monitor Whether this socket was
+      #   created by a monitoring connection.
+      #
+      # @since 2.0.0
+      # @api private
+      def initialize(host, port, timeout, family, options = {})
+        super(timeout, options)
+        @host, @port = host, port
+        @family = family
+        @socket = ::Socket.new(family, SOCK_STREAM, 0)
+        begin
+          set_socket_options(@socket)
+          connect!
+        rescue
+          @socket.close
+          raise
+        end
+      end
+
       # @return [ String ] host The host to connect to.
       attr_reader :host
 
@@ -40,36 +76,17 @@ module Mongo
       def connect!
         Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError) do
           socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
-          handle_errors { socket.connect(::Socket.pack_sockaddr_in(port, host)) }
+          map_exceptions do
+            socket.connect(::Socket.pack_sockaddr_in(port, host))
+          end
           self
         end
       end
       private :connect!
 
-      # Initializes a new TCP socket.
-      #
-      # @example Create the TCP socket.
-      #   TCP.new('::1', 27017, 30, Socket::PF_INET)
-      #   TCP.new('127.0.0.1', 27017, 30, Socket::PF_INET)
-      #
-      # @param [ String ] host The hostname or IP address.
-      # @param [ Integer ] port The port number.
-      # @param [ Float ] timeout The socket timeout value.
-      # @param [ Integer ] family The socket family.
-      # @param [ Hash ] options The options.
-      #
-      # @option options [ Float ] :connect_timeout Connect timeout.
-      #
-      # @since 2.0.0
-      def initialize(host, port, timeout, family, options = {})
-        @host, @port, @timeout, @options = host, port, timeout, options
-        super(family)
-        connect!
-      end
-
       private
 
-      def address
+      def human_address
         "#{host}:#{port} (no TLS)"
       end
     end

data/lib/mongo/socket/unix.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -20,9 +20,6 @@ module Mongo
     # @since 2.0.0
     class Unix < Socket
 
-      # @return [ String ] path The path to connect to.
-      attr_reader :path
-
       # Initializes a new Unix socket.
       #
       # @example Create the Unix socket.
@@ -33,17 +30,28 @@ module Mongo
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout (unused).
+      # @option options [ Address ] :connection_address Address of the
+      #   connection that created this socket.
+      # @option options [ Integer ] :connection_generation Generation of the
+      #   connection (for non-monitoring connections) that created this socket.
+      # @option options [ true | false ] :monitor Whether this socket was
+      #   created by a monitoring connection.
       #
       # @since 2.0.0
+      # @api private
       def initialize(path, timeout, options = {})
-        @path, @timeout, @options = path, timeout, options
+        super(timeout, options)
+        @path = path
         @socket = ::UNIXSocket.new(path)
         set_socket_options(@socket)
       end
 
+      # @return [ String ] path The path to connect to.
+      attr_reader :path
+
       private
 
-      def address
+      def human_address
         path
       end
     end

data/lib/mongo/srv.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-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.

data/lib/mongo/srv/monitor.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -13,65 +13,94 @@
 # limitations under the License.
 
 module Mongo
-  module SRV
+  module Srv
 
-    # Polls SRV records for the URI that a cluster was created for and
-    # updates the list of servers in the cluster when records change.
+    # Periodically retrieves SRV records for the cluster's SRV URI, and
+    # sets the cluster's server list to the SRV lookup result.
+    #
+    # If an error is encountered during SRV lookup or an SRV record is invalid
+    # or disallowed for security reasons, a warning is logged and monitoring
+    # continues.
     #
     # @api private
     class Monitor
       include Loggable
-
-      MIN_RESCAN_FREQUENCY = 60
+      include BackgroundThread
+
+      MIN_SCAN_INTERVAL = 60
+
+      DEFAULT_TIMEOUT = 10
+
+      # Creates the SRV monitor.
+      #
+      # @param [ Cluster ] cluster The cluster.
+      # @param [ Hash ] options The cluster options.
+      #
+      # @option options [ Float ] :timeout The timeout to use for DNS lookups.
+      # @option options [ URI::SRVProtocol ] :srv_uri The SRV URI to monitor.
+      # @option options [ Hash ] :resolv_options For internal driver use only.
+      #   Options to pass through to Resolv::DNS constructor for SRV lookups.
+      def initialize(cluster, options = nil)
+        options = if options
+          options.dup
+        else
+          {}
+        end
+        @cluster = cluster
+        @resolver = Srv::Resolver.new(options)
+        unless @srv_uri = options.delete(:srv_uri)
+          raise ArgumentError, 'SRV URI is required'
+        end
+        @options = options.freeze
+        @last_result = @srv_uri.srv_result
+        @stop_semaphore = Semaphore.new
+      end
 
       attr_reader :options
 
-      def initialize(cluster, resolver, srv_records, options = nil)
-        @options = options || {}
-        @cluster = cluster
-        @resolver = resolver
-        @records = srv_records
-        @no_records_found = false
-      end
+      attr_reader :cluster
 
-      def start_monitor!
-        @thread = Thread.new do
-          loop do
-            sleep(rescan_frequency)
-            scan!
-          end
-        end
+      # @return [ Srv::Result ] Last known SRV lookup result. Used for
+      #   determining intervals between SRV lookups, which depend on SRV DNS
+      #   records' TTL values.
+      attr_reader :last_result
 
+      def start!
+        super
         ObjectSpace.define_finalizer(self, self.class.finalize(@thread))
       end
 
+      private
+
+      def do_work
+        scan!
+        @stop_semaphore.wait(scan_interval)
+      end
+
       def scan!
-        @old_hosts = @records.hosts
+        old_hosts = last_result.address_strs
 
         begin
-          @records = @resolver.get_records(@records.hostname)
+          last_result = Timeout.timeout(timeout) do
+            @resolver.get_records(@srv_uri.query_hostname)
+          end
         rescue Resolv::ResolvTimeout => e
-          log_warn("Timed out trying to resolve hostname #{@records.hostname}")
+          log_warn("SRV monitor: timed out trying to resolve hostname #{@srv_uri.query_hostname}: #{e.class}: #{e}")
+          return
+        rescue ::Timeout::Error
+          log_warn("SRV monitor: timed out trying to resolve hostname #{@srv_uri.query_hostname} (timeout=#{timeout})")
           return
         rescue Resolv::ResolvError => e
-          log_warn("Unable to resolve hostname #{@records.hostname}")
+          log_warn("SRV monitor: unable to resolve hostname #{@srv_uri.query_hostname}: #{e.class}: #{e}")
           return
         end
 
-        if @records.empty?
-          @no_records_found = true
+        if last_result.empty?
+          log_warn("SRV monitor: hostname #{@srv_uri.query_hostname} resolved to zero records")
           return
         end
 
-        @no_records_found = false
-
-        (@old_hosts - @records.hosts).each do |host|
-          @cluster.remove(host)
-        end
-
-        (@records.hosts - @old_hosts).each do |host|
-          @cluster.add(host)
-        end
+        @cluster.set_server_list(last_result.address_strs)
       end
 
       def self.finalize(thread)
@@ -80,17 +109,19 @@ module Mongo
         end
       end
 
-      private
-
-      def rescan_frequency
-        if @no_records_found
-          Server:: Monitor::HEARTBEAT_FREQUENCY
-        elsif @records.min_ttl.nil?
-          MIN_RESCAN_FREQUENCY
+      def scan_interval
+        if last_result.empty?
+          [cluster.heartbeat_interval, MIN_SCAN_INTERVAL].min
+        elsif last_result.min_ttl.nil?
+          MIN_SCAN_INTERVAL
         else
-          [@records.min_ttl, MIN_RESCAN_FREQUENCY].max
+          [last_result.min_ttl, MIN_SCAN_INTERVAL].max
         end
       end
+
+      def timeout
+        options[:timeout] || DEFAULT_TIMEOUT
+      end
     end
   end
 end

data/lib/mongo/srv/resolver.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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.

data/lib/mongo/srv/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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.
@@ -13,7 +13,6 @@
 # limitations under the License.
 
 module Mongo
-
   module Srv
 
     # SRV record lookup result.

data/lib/mongo/timeout.rb

@@ -0,0 +1,49 @@
+# Copyright (C) 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.
+# 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
+  module Timeout
+
+    # A wrapper around Ruby core's Timeout::timeout method that provides
+    # a standardized API for Ruby versions older and newer than 2.4.0,
+    # which is when the third argument was introduced.
+    #
+    # @param [ Numeric ] sec The number of seconds before timeout.
+    # @param [ Class ] klass The exception class to raise on timeout, optional.
+    #   When no error exception is provided, Timeout::Error is raised.
+    # @param [ String ] message The error message passed to the exception raised
+    #   on timeout, optional. When no error message is provided, the default
+    #   error message for the exception class is used.
+    def timeout(sec, klass=nil, message=nil)
+      if message && RUBY_VERSION < '2.94.0'
+        begin
+          ::Timeout.timeout(sec) do
+            yield
+          end
+        rescue ::Timeout::Error => e
+          raise klass, message
+        end
+      else
+        # Jruby Timeout::timeout method does not support passing nil arguments.
+        # Remove the nil arguments before passing them along to the core
+        # Timeout::timeout method.
+        optional_args = [klass, message].compact
+        ::Timeout.timeout(sec, *optional_args) do
+          yield
+        end
+      end
+    end
+    module_function :timeout
+  end
+end

data/lib/mongo/topology_version.rb

@@ -0,0 +1,80 @@
+# Copyright (C) 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.
+# 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
+  # TopologyVersion encapsulates the topologyVersion document obtained from
+  # ismaster responses and not master-like OperationFailure errors.
+  #
+  # @api private
+  class TopologyVersion < BSON::Document
+    def initialize(doc)
+      if Lint.enabled?
+        unless doc['processId']
+          raise ArgumentError, 'Creating a topology version without processId field'
+        end
+        unless doc['counter']
+          raise ArgumentError, 'Creating a topology version without counter field'
+        end
+      end
+
+      super
+    end
+
+    # @return [ BSON::ObjectId ] The process id.
+    def process_id
+      self['processId']
+    end
+
+    # @return [ Integer ] The counter.
+    def counter
+      self['counter']
+    end
+
+    # Returns whether this topology version is potentially newer than another
+    # topology version.
+    #
+    # Note that there is no total ordering of topology versions - given
+    # two topology versions, each may be "potentially newer" than the other one.
+    #
+    # @param [ TopologyVersion ] other The other topology version.
+    #
+    # @return [ true | false ] Whether this topology version is potentially newer.
+    # @api private
+    def gt?(other)
+      if process_id != other.process_id
+        true
+      else
+        counter > other.counter
+      end
+    end
+
+    # Returns whether this topology version is potentially newer than or equal
+    # to another topology version.
+    #
+    # Note that there is no total ordering of topology versions - given
+    # two topology versions, each may be "potentially newer" than the other one.
+    #
+    # @param [ TopologyVersion ] other The other topology version.
+    #
+    # @return [ true | false ] Whether this topology version is potentially newer.
+    # @api private
+    def gte?(other)
+      if process_id != other.process_id
+        true
+      else
+        counter >= other.counter
+      end
+    end
+  end
+end