Merge pull request #876 from estolfo/RUBY-1222-conn-timeout-2

RUBY-1222 Use connect_timeout when determining address family

Author: estolfo

lib/mongo/address.rb

@@ -119,6 +119,7 @@ def hash
     def initialize(seed, options = {})
       @seed = seed
       @host, @port = parse_host_port
+      @options = options
     end
 
     # Get a pretty printed address inspection.
@@ -138,15 +139,15 @@ def inspect
     # @example Get a socket.
     #   address.socket(5, :ssl => true)
     #
-    # @param [ Float ] timeout The socket timeout.
+    # @param [ Float ] socket_timeout The socket timeout.
     # @param [ Hash ] ssl_options SSL options.
     #
     # @return [ Pool::Socket::SSL, Pool::Socket::TCP, Pool::Socket::Unix ] The socket.
     #
     # @since 2.0.0
-    def socket(timeout, ssl_options = {})
-      @resolver ||= initialize_resolver!(timeout, ssl_options)
-      @resolver.socket(timeout, ssl_options)
+    def socket(socket_timeout, ssl_options = {})
+      @resolver ||= initialize_resolver!(ssl_options)
+      @resolver.socket(socket_timeout, ssl_options)
     end
 
     # Get the address as a string.
@@ -161,19 +162,33 @@ def to_s
       port ? "#{host}:#{port}" : host
     end
 
+    # Connect a socket.
+    #
+    # @example Connect a socket.
+    #   address.connect_socket!(socket)
+    #
+    # @since 2.4.3
+    def connect_socket!(socket)
+      socket.connect!(connect_timeout)
+    end
+
     private
 
-    def initialize_resolver!(timeout, ssl_options)
+    def connect_timeout
+      @connect_timeout ||= @options[:connect_timeout] || Server::CONNECT_TIMEOUT
+    end
+
+    def initialize_resolver!(ssl_options)
       return Unix.new(seed.downcase) if seed.downcase =~ Unix::MATCH
 
       family = (host == LOCALHOST) ? ::Socket::AF_INET : ::Socket::AF_UNSPEC
       error = nil
       ::Socket.getaddrinfo(host, nil, family, ::Socket::SOCK_STREAM).each do |info|
         begin
           res = FAMILY_MAP[info[4]].new(info[3], port, host)
-          res.socket(timeout, ssl_options).connect!.close
+          res.socket(connect_timeout, ssl_options).connect!(connect_timeout).close
           return res
-        rescue IOError, SystemCallError, Error::SocketError => e
+        rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e
           error = e
         end
       end

lib/mongo/address/ipv4.rb

@@ -77,17 +77,17 @@ def initialize(host, port, host_name=nil)
       # @example Get an IPv4 socket.
       #   ipv4.socket(5, :ssl => true)
       #
-      # @param [ Float ] timeout The socket timeout.
+      # @param [ Float ] socket_timeout The socket timeout.
       # @param [ Hash ] ssl_options SSL options.
       #
       # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
       #
       # @since 2.0.0
-      def socket(timeout, ssl_options = {})
+      def socket(socket_timeout, ssl_options = {})
         unless ssl_options.empty?
-          Socket::SSL.new(host, port, host_name, timeout, Socket::PF_INET, ssl_options)
+          Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET, ssl_options)
         else
-          Socket::TCP.new(host, port, timeout, Socket::PF_INET)
+          Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET)
         end
       end
     end

lib/mongo/address/ipv6.rb

@@ -72,17 +72,17 @@ def initialize(host, port, host_name=nil)
       # @example Get an IPv6 socket.
       #   ipv4.socket(5, :ssl => true)
       #
-      # @param [ Float ] timeout The socket timeout.
+      # @param [ Float ] socket_timeout The socket timeout.
       # @param [ Hash ] ssl_options SSL options.
       #
       # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
       #
       # @since 2.0.0
-      def socket(timeout, ssl_options = {})
+      def socket(socket_timeout, ssl_options = {})
         unless ssl_options.empty?
-          Socket::SSL.new(host, port, host_name, timeout, Socket::PF_INET6, ssl_options)
+          Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET6, ssl_options)
         else
-          Socket::TCP.new(host, port, timeout, Socket::PF_INET6)
+          Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET6)
         end
       end
     end

lib/mongo/address/unix.rb

@@ -68,8 +68,8 @@ def initialize(host, port=nil, host_name=nil)
       # @return [ Pool::Socket::Unix ] The socket.
       #
       # @since 2.0.0
-      def socket(timeout, ssl_options = {})
-        Socket::Unix.new(host, timeout)
+      def socket(socket_timeout, ssl_options = {})
+        Socket::Unix.new(host, socket_timeout)
       end
     end
   end

lib/mongo/cluster.rb

@@ -96,7 +96,7 @@ def ==(other)
     #
     # @since 2.0.0
     def add(host)
-      address = Address.new(host)
+      address = Address.new(host, options)
       if !addresses.include?(address)
         if addition_allowed?(address)
           @update_lock.synchronize { @addresses.push(address) }

lib/mongo/server.rb

@@ -44,6 +44,11 @@ class Server
     # @return [ Monitoring ] monitoring The monitoring.
     attr_reader :monitoring
 
+    # The default time in seconds to timeout a connection attempt.
+    #
+    # @since 2.4.3
+    CONNECT_TIMEOUT = 10.freeze
+
     # 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

lib/mongo/server/connectable.rb

@@ -68,18 +68,6 @@ def connected?
         !!@socket && @socket.alive?
       end
 
-      # Get the timeout to execute an operation on a socket.
-      #
-      # @example Get the timeout to execute an operation on a socket.
-      #   connection.timeout
-      #
-      # @return [ Float ] The operation timeout in seconds.
-      #
-      # @since 2.0.0
-      def timeout
-        @timeout ||= options[:socket_timeout]
-      end
-
       protected
 
       attr_reader :socket

lib/mongo/server/connection.rb

@@ -59,8 +59,8 @@ class Connection
       # @since 2.0.0
       def connect!
         unless socket && socket.connectable?
-          @socket = address.socket(timeout, ssl_options)
-          socket.connect!
+          @socket = address.socket(socket_timeout, ssl_options)
+          address.connect_socket!(socket)
           handshake!
           authenticate!
         end
@@ -156,6 +156,20 @@ def ping
         end
       end
 
+      # Get the timeout to execute an operation on a socket.
+      #
+      # @example Get the timeout to execute an operation on a socket.
+      #   connection.timeout
+      #
+      # @return [ Float ] The operation timeout in seconds.
+      #
+      # @since 2.0.0
+      def socket_timeout
+        @timeout ||= options[:socket_timeout]
+      end
+      # @deprecated Please use :socket_timeout instead. Will be removed in 3.0.0
+      alias :timeout :socket_timeout
+
       private
 
       def deliver(messages)

lib/mongo/server/monitor/connection.rb

@@ -41,6 +41,8 @@ class Connection
         # The default time in seconds to timeout a connection attempt.
         #
         # @since 2.1.2
+        #
+        # @deprecated Please use Server::CONNECT_TIMEOUT instead. Will be removed in 3.0.0
         CONNECT_TIMEOUT = 10.freeze
 
         # Send the preserialized ismaster call.
@@ -73,8 +75,8 @@ def ismaster
         # @since 2.0.0
         def connect!
           unless socket && socket.connectable?
-            @socket = address.socket(timeout, ssl_options)
-            socket.connect!
+            @socket = address.socket(socket_timeout, ssl_options)
+            address.connect_socket!(socket)
             handshake!
           end
           true
@@ -122,17 +124,21 @@ def initialize(address, options = {})
           @pid = Process.pid
         end
 
-        # Get the connection timeout.
+        # Get the socket timeout.
         #
-        # @example Get the connection timeout.
-        #   connection.timeout
+        # @example Get the socket timeout.
+        #   connection.socket_timeout
         #
-        # @return [ Float ] The connection timeout in seconds.
+        # @return [ Float ] The socket timeout in seconds. Note that the Monitor's connection
+        #  uses the connect timeout value for calling ismaster. See the Server Discovery and
+        #  Monitoring specification for details.
         #
-        # @since 2.0.0
-        def timeout
-          @timeout ||= options[:connect_timeout] || CONNECT_TIMEOUT
+        # @since 2.4.3
+        def socket_timeout
+          @timeout ||= options[:connect_timeout] || Server::CONNECT_TIMEOUT
         end
+        # @deprecated Please use :socket_timeout instead. Will be removed in 3.0.0
+        alias :timeout :socket_timeout
 
         private
 

lib/mongo/socket/ssl.rb

@@ -38,7 +38,7 @@ class SSL < Socket
       # @return [ Integer ] port The port to connect to.
       attr_reader :port
 
-      # @return [ Float ] timeout The connection timeout.
+      # @return [ Float ] timeout The socket timeout.
       attr_reader :timeout
 
       # Establishes a socket connection.
@@ -52,8 +52,8 @@ class SSL < Socket
       # @return [ SSL ] The connected socket instance.
       #
       # @since 2.0.0
-      def connect!
-        Timeout.timeout(timeout, Error::SocketTimeoutError) do
+      def connect!(connect_timeout = nil)
+        Timeout.timeout(connect_timeout, Error::SocketTimeoutError) do
           handle_errors { @tcp_socket.connect(::Socket.pack_sockaddr_in(port, host)) }
           @socket = OpenSSL::SSL::SSLSocket.new(@tcp_socket, context)
           @socket.hostname = @host_name unless BSON::Environment.jruby?