mongo 2.11.3 → 2.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1ec5495bf06a11fa0003454eb892099bc1a86da8ef1694fc25990c18d2f64ba
-  data.tar.gz: b07b2a3f5b71e89e66d6117253e1c85e4c6c90b8a8bb2f17cee24a8b47b9dad8
+  metadata.gz: d3363520c62689e2f649389acd84f68b46dba99a62d82c174c77414f66e055dd
+  data.tar.gz: 7b1a54bcc8657047ec15b61cdf39588965fc9328d0ac56aa294f7891ef7fb3e2
 SHA512:
-  metadata.gz: 6e88a5e7d0a2bd2917c4ba887d38786229fd9f64e2056b894ccd3289983b52f7aa8b293d77c46df4412d1fb01faed8bb41bfe93fa08e5085a8ec88fe22aaed34
-  data.tar.gz: fe47a5b889ff2b9449475e040d6e189bc984158e5c6b0cfab055dcce83d7efb090ec129eb5afee5cfed7a4b30ddda6bcc0d60e1b8720ff96f188548f28a75460
+  metadata.gz: 546bfab9a6042f6194f87efc8f19fa92ee9828040d1f34a98045e243cce6f056837e4144856a37803f964cf345724ccfdeb6eb2d407f265b4a02e7a14622f0a1
+  data.tar.gz: 9eb09ae2c44b3cee7cd9c082af7702b0acd4b56674a6c17b3959c05f654987b3b34f6d87c8d74d9863f312addc01a8de090899a879847d014fa0e7c9baa217d6

data/lib/mongo/address.rb

@@ -66,6 +66,8 @@ module Mongo
     # @param [ String ] seed The provided address.
     # @param [ Hash ] options The address options.
     #
+    # @option options [ Float ] :connect_timeout Connect timeout.
+    #
     # @since 2.0.0
     def initialize(seed, options = {})
       if seed.nil?
@@ -85,6 +87,9 @@ module Mongo
     # @return [ Integer ] port The port.
     attr_reader :port
 
+    # @api private
+    attr_reader :options
+
     # Check equality of the address to another.
     #
     # @example Check address equality.
@@ -138,13 +143,30 @@ module Mongo
       "#<Mongo::Address:0x#{object_id} address=#{to_s}>"
     end
 
-    # Get a socket for the provided address, given the options.
+    # Get a socket for the address stored in this object, given the options.
+    #
+    # If the address stored in this object looks like a Unix path, this method
+    # returns a Unix domain socket for this path.
     #
-    # The address the socket connects to is determined by the algorithm described in the
-    # #intialize_resolver! documentation. Each time this method is called, #initialize_resolver!
-    # will be called, meaning that a new hostname lookup will occur. This is done so that any
-    # changes to which addresses the hostname resolves to will be picked up even if a socket has
-    # been connected to it before.
+    # Otherwise, this method attempts to resolve the address stored in
+    # this object to IPv4 and IPv6 addresses using +Socket#getaddrinfo+, then
+    # connects to the resulting addresses and returns the socket of the first
+    # successful connection. The order in which address families (IPv4/IPV6)
+    # are tried is the same order in which the addresses are returned by
+    # +getaddrinfo+, and is determined by the host system.
+    #
+    # Name resolution is performed on each +socket+ call. This is done so that
+    # any changes to which addresses the host names used as seeds or in
+    # server configuration resolve to are immediately noticed by the driver,
+    # even if a socket has been connected to the affected host name/address
+    # before. However, note that DNS TTL values may still affect when a change
+    # to a host address is noticed by the driver.
+    #
+    # This method propagates any exceptions raised during DNS resolution and
+    # subsequent connection attempts. In case of a host name resolving to
+    # multiple IP addresses, the error raised by the last attempt is propagated
+    # to the caller. This method does not map exceptions to Mongo::Error
+    # subclasses, and may raise any subclass of Exception.
     #
     # @example Get a socket.
     #   address.socket(5, :ssl => true)
@@ -155,11 +177,34 @@ module Mongo
     #
     # @option options [ Float ] :connect_timeout Connect timeout.
     #
-    # @return [ Mongo::Socket::SSL, Mongo::Socket::TCP, Mongo::Socket::Unix ] The socket.
+    # @return [ Mongo::Socket::SSL | Mongo::Socket::TCP | Mongo::Socket::Unix ]
+    #   The socket.
+    #
+    # @raise [ Exception ] If network connection failed.
     #
     # @since 2.0.0
     def socket(socket_timeout, ssl_options = {}, options = {})
-      create_resolver(ssl_options).socket(socket_timeout, ssl_options, options)
+      if seed.downcase =~ Unix::MATCH
+        specific_address = Unix.new(seed.downcase)
+        return specific_address.socket(socket_timeout, ssl_options, options)
+      end
+
+      options = {
+        connect_timeout: Server::CONNECT_TIMEOUT,
+      }.update(options)
+
+      family = (host == LOCALHOST) ? ::Socket::AF_INET : ::Socket::AF_UNSPEC
+      error = nil
+      ::Socket.getaddrinfo(host, nil, family, ::Socket::SOCK_STREAM).each do |info|
+        begin
+          specific_address = FAMILY_MAP[info[4]].new(info[3], port, host)
+          socket = specific_address.socket(socket_timeout, ssl_options, options)
+          return socket
+        rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e
+          error = e
+        end
+      end
+      raise error
     end
 
     # Get the address as a string.
@@ -182,37 +227,8 @@ module Mongo
       end
     end
 
-    # @api private
-    def connect_timeout
-      @connect_timeout ||= @options[:connect_timeout] || Server::CONNECT_TIMEOUT
-    end
-
     private
 
-    # To determine which address the socket will connect to, the driver will
-    # attempt to connect to each IP address returned by Socket::getaddrinfo in
-    # sequence. Once a successful connection is made, a resolver with that
-    # IP address specified is returned. If no successful connection is
-    # made, the error made by the last connection attempt is raised.
-    def create_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
-          specific_address = FAMILY_MAP[info[4]].new(info[3], port, host)
-          socket = specific_address.socket(
-            connect_timeout, ssl_options, connect_timeout: connect_timeout)
-          socket.close
-          return specific_address
-        rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e
-          error = e
-        end
-      end
-      raise error
-    end
-
     def parse_host_port
       address = seed.downcase
       case address

data/lib/mongo/server/connection.rb

@@ -187,8 +187,7 @@ module Mongo
 
       # Separate method to permit easier mocking in the test suite.
       def do_connect
-        socket = address.socket(socket_timeout, ssl_options,
-          connect_timeout: address.connect_timeout)
+        socket = address.socket(socket_timeout, ssl_options, address.options)
 
         begin
           handshake!(socket)

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

@@ -162,8 +162,7 @@ module Mongo
         # @since 2.0.0
         def connect!
           unless @socket
-            socket = address.socket(socket_timeout, ssl_options,
-              connect_timeout: address.connect_timeout)
+            socket = address.socket(socket_timeout, ssl_options, address.options)
             handshake!(socket)
             @socket = socket
           end

data/lib/mongo/socket.rb

@@ -63,7 +63,16 @@ module Mongo
     def alive?
       sock_arr = [ @socket ]
       if Kernel::select(sock_arr, nil, sock_arr, 0)
-        eof?
+        # The eof? call is supposed to return immediately since select
+        # indicated the socket is readable. However, if @socket is an SSL
+        # socket, eof? can block anyway - see RUBY-2140.
+        begin
+          Timeout.timeout(0.1) do
+            eof?
+          end
+        rescue ::Timeout::Error
+          true
+        end
       else
         true
       end

data/lib/mongo/version.rb

@@ -17,5 +17,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.11.3'.freeze
+  VERSION = '2.11.4'.freeze
 end

data/spec/integration/bson_symbol_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Symbol encoding to BSON' do
+  let(:value) { :foo }
+
+  let(:hash) do
+    {'foo' => value}
+  end
+
+  let(:serialized) do
+    hash.to_bson.to_s
+  end
+
+  let(:expected) do
+    "\x12\x00\x00\x00\x0Efoo\x00\x04\x00\x00\x00foo\x00\x00".force_encoding('binary')
+  end
+
+  it 'encodes symbol to BSON symbol' do
+    serialized.should == expected
+  end
+
+  it 'round-trips symbol values' do
+    buffer = BSON::ByteBuffer.new(serialized)
+    Hash.from_bson(buffer).should == hash
+  end
+
+  it 'round-trips symbol values using the same byte buffer' do
+    if BSON::Environment.jruby?
+      pending 'https://jira.mongodb.org/browse/RUBY-2128'
+    end
+
+    Hash.from_bson(hash.to_bson).should == hash
+  end
+end

data/spec/integration/connection_spec.rb

@@ -12,17 +12,18 @@ describe 'Connections' do
   let(:server) { client.cluster.servers.first }
 
   describe '#connect!' do
-    # On JRuby 9.2.7.0, this line:
-    # expect_any_instance_of(Mongo::Socket).to receive(:write).and_raise(exception)
-    # ... appears to produce a moment in which Mongo::Socket#write is undefined
-    # entirely, resulting in this failure:
-    # RSpec::Expectations::ExpectationNotMetError: expected Mongo::Error::SocketError, got #<NameError: undefined method `write' for class `Mongo::Socket'>
-    fails_on_jruby
+
+    let(:connection) do
+      Mongo::Server::Connection.new(server, server.options)
+    end
 
     context 'network error during handshake' do
-      let(:connection) do
-        Mongo::Server::Connection.new(server, server.options)
-      end
+      # On JRuby 9.2.7.0, this line:
+      # expect_any_instance_of(Mongo::Socket).to receive(:write).and_raise(exception)
+      # ... appears to produce a moment in which Mongo::Socket#write is undefined
+      # entirely, resulting in this failure:
+      # RSpec::Expectations::ExpectationNotMetError: expected Mongo::Error::SocketError, got #<NameError: undefined method `write' for class `Mongo::Socket'>
+      fails_on_jruby
 
       let(:exception) { Mongo::Error::SocketError }
 
@@ -120,6 +121,53 @@ describe 'Connections' do
           expect(client.cluster.topology).to be_a(Mongo::Cluster::Topology::ReplicaSetNoPrimary)
         end
       end
+
+      describe 'number of sockets created' do
+
+        before do
+          server
+        end
+
+        shared_examples_for 'is 1 per connection' do
+          it 'is 1 per connection' do
+            # Instantiating a connection object should not create any sockets
+            RSpec::Mocks.with_temporary_scope do
+              expect(socket_cls).not_to receive(:new)
+
+              connection
+            end
+
+            # When the connection connects, exactly one socket should be created
+            # (and subsequently connected)
+            RSpec::Mocks.with_temporary_scope do
+              expect(socket_cls).to receive(:new).and_call_original
+
+              connection.connect!
+            end
+          end
+        end
+
+        let(:socket_cls) { ::Socket }
+
+        it_behaves_like 'is 1 per connection'
+
+        context 'connection to Unix domain socket' do
+          # Server does not allow Unix socket connections when TLS is enabled
+          require_no_tls
+
+          let(:port) { SpecConfig.instance.any_port }
+
+          let(:client) do
+            new_local_client(["/tmp/mongodb-#{port}.sock"], connect: :direct).tap do |client|
+              stop_monitoring(client)
+            end
+          end
+
+          let(:socket_cls) { ::UNIXSocket }
+
+          it_behaves_like 'is 1 per connection'
+        end
+      end
     end
 
     describe 'wire protocol version range update' do

data/spec/integration/retryable_errors_spec.rb

@@ -24,7 +24,7 @@ describe 'Failing retryable operations' do
     end
 
     after do
-      ClusterTools.instance.direct_client_for_each_server do |client|
+      ClusterTools.instance.direct_client_for_each_data_bearing_server do |client|
         client.use(:admin).database.command(clear_fail_point_command)
       end
     end
@@ -62,7 +62,7 @@ describe 'Failing retryable operations' do
           server.monitor.stop!
         end
 
-        ClusterTools.instance.direct_client_for_each_server do |client|
+        ClusterTools.instance.direct_client_for_each_data_bearing_server do |client|
           client.use(:admin).database.command(fail_point_command)
         end
       end

data/spec/mongo/address_spec.rb

@@ -249,11 +249,7 @@ describe Mongo::Address do
       end
     end
 
-    context 'when creating a socket using the resolver' do
-
-      before do
-        address.send(:create_resolver, SpecConfig.instance.ssl_options)
-      end
+    context 'when creating a socket' do
 
       it 'uses the host, not the IP address' do
         expect(address.socket(0.0).host).to eq(socket_address_or_host)
@@ -285,6 +281,24 @@ describe Mongo::Address do
         end
       end
     end
+
+    describe ':connect_timeout option' do
+      clean_slate
+
+      let(:address) { Mongo::Address.new('127.0.0.1') }
+
+      it 'defaults to 10' do
+        RSpec::Mocks.with_temporary_scope do
+          resolved_address = double('address')
+          # This test's expectation
+          expect(resolved_address).to receive(:socket).with(0, {}, connect_timeout: 10)
+
+          expect(Mongo::Address::IPv4).to receive(:new).and_return(resolved_address)
+
+          address.socket(0)
+        end
+      end
+    end
   end
 
   describe '#to_s' do
@@ -320,12 +334,4 @@ describe Mongo::Address do
       end
     end
   end
-
-  describe '#connect_timeout' do
-    let(:address) { Mongo::Address.new('127.0.0.1') }
-
-    it 'defaults to 10' do
-      expect(address.send(:connect_timeout)).to eq(10)
-    end
-  end
 end

data/spec/mongo/auth/scram/conversation_spec.rb

@@ -35,6 +35,8 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
     end
 
     describe '#start' do
+      # Test uses global assertions
+      clean_slate
 
       let(:query) do
         conversation.start(nil)

data/spec/mongo/collection_spec.rb

@@ -278,9 +278,9 @@ describe Mongo::Collection do
           require_topology :replica_set
 
           let(:client_options) do
-            {
+            SpecConfig.instance.auth_options.merge(
               read: { mode: :primary_preferred },
-            }
+            )
           end
 
           let(:subscriber) { EventSubscriber.new }

data/spec/mongo/server/connection_spec.rb

@@ -1080,7 +1080,7 @@ describe Mongo::Server::Connection, retry: 3 do
         end
 
         it 'uses the connect_timeout for the address' do
-          expect(connection.address.send(:connect_timeout)).to eq(3)
+          expect(connection.address.options[:connect_timeout]).to eq(3)
         end
 
         it 'uses the socket_timeout as the socket_timeout' do
@@ -1099,7 +1099,7 @@ describe Mongo::Server::Connection, retry: 3 do
         end
 
         it 'uses the connect_timeout for the address' do
-          expect(connection.address.send(:connect_timeout)).to eq(3)
+          expect(connection.address.options[:connect_timeout]).to eq(3)
         end
 
         it 'does not use a socket_timeout' do
@@ -1120,8 +1120,8 @@ describe Mongo::Server::Connection, retry: 3 do
           connection.connect!
         end
 
-        it 'uses the default connect_timeout for the address' do
-          expect(connection.address.send(:connect_timeout)).to eq(10)
+        it 'does not specify connect_timeout for the address' do
+          expect(connection.address.options[:connect_timeout]).to be nil
         end
 
         it 'uses the socket_timeout' do
@@ -1139,8 +1139,8 @@ describe Mongo::Server::Connection, retry: 3 do
           connection.connect!
         end
 
-        it 'uses the default connect_timeout for the address' do
-          expect(connection.address.send(:connect_timeout)).to eq(10)
+        it 'does not specify connect_timeout for the address' do
+          expect(connection.address.options[:connect_timeout]).to be nil
         end
 
         it 'does not use a socket_timeout' do

data/spec/mongo/server/monitor/connection_spec.rb

@@ -66,7 +66,7 @@ describe Mongo::Server::Monitor::Connection do
       end
 
       it 'uses the connect_timeout for the address' do
-        expect(connection.address.send(:connect_timeout)).to eq(3)
+        expect(connection.address.options[:connect_timeout]).to eq(3)
       end
 
       it 'uses the connect_timeout as the socket_timeout' do
@@ -81,7 +81,7 @@ describe Mongo::Server::Monitor::Connection do
       end
 
       it 'uses the connect_timeout for the address' do
-        expect(connection.address.send(:connect_timeout)).to eq(3)
+        expect(connection.address.options[:connect_timeout]).to eq(3)
       end
 
       it 'uses the connect_timeout as the socket_timeout' do
@@ -98,8 +98,8 @@ describe Mongo::Server::Monitor::Connection do
         SpecConfig.instance.test_options.merge(connect_timeout: nil, socket_timeout: 5)
       end
 
-      it 'uses the default connect_timeout for the address' do
-        expect(connection.address.send(:connect_timeout)).to eq(10)
+      it 'does not specify connect_timeout for the address' do
+        expect(connection.address.options[:connect_timeout]).to be nil
       end
 
       it 'uses the connect_timeout as the socket_timeout' do
@@ -113,8 +113,8 @@ describe Mongo::Server::Monitor::Connection do
         SpecConfig.instance.test_options.merge(connect_timeout: nil, socket_timeout: nil)
       end
 
-      it 'uses the default connect_timeout for the address' do
-        expect(connection.address.send(:connect_timeout)).to eq(10)
+      it 'does not specify connect_timeout for the address' do
+        expect(connection.address.options[:connect_timeout]).to be nil
       end
 
       it 'uses the connect_timeout as the socket_timeout' do