mongo 2.10.0.rc0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08673c7408cfc3fce9f682577a1156fe312c5f6806b4ea4ecef3d946dd7b0d3b'
-  data.tar.gz: 4811269ce3f01bd7508de797bf32c68bc7f6e858ca3949d12fa604dd011e41ab
+  metadata.gz: 1a1e6b0cb6b8548601a5ad4c4758361f9815d65750b52fef6b2393eb09ab5ae4
+  data.tar.gz: '084a8d5a64bba3ffaab853919918f9cb214754edbaec4ac22eeaee5e9954f39b'
 SHA512:
-  metadata.gz: fdfddf7f78f3eabb7d2c0249680ad0bacbfac5425f2ed8719a9dad96fc308cb969ee51edf290df7394a161819bb9c55f5180c765a2edf3f03ef3976c04f2be78
-  data.tar.gz: fe9b0f8aa59ce594ffef9da66a107e99f2d41d50ba29ae8fd318f15e53c9b574411d73c5d12450bdf4be7b6490820c847367a55157acdbbd8f59124cb74c075f
+  metadata.gz: 19fc6811951a53cfef86d647849337fb56014e97d2cf9aec0ea0de58f3525632a96e04c1f5a6ecd4f6de8f7a853faded939e59f716d9fa4a6c9ac40a7e742ce9
+  data.tar.gz: '08ff4b626997aa23fb9db94893818e2326cc2c13032ea4dabf512628b436597f13a2c69a2693d57fd58d60208c384660b4c811ca98b8aeb1a47994b212a0dbd5'

data/lib/mongo/error/operation_failure.rb

@@ -252,6 +252,18 @@ module Mongo
       def max_time_ms_expired?
         code == 50 # MaxTimeMSExpired
       end
+
+      # Whether the error is caused by an attempted retryable write
+      # on a storage engine that does not support retryable writes.
+      #
+      # @return [ true | false ] Whether the error is caused by an attempted
+      # retryable write on a storage engine that does not support retryable writes.
+      #
+      # @since 2.10.0
+      def unsupported_retryable_write?
+        # code 20 is IllegalOperation
+        code == 20 && message.start_with?("Transaction numbers")
+      end
     end
   end
 end

data/lib/mongo/retryable.rb

@@ -215,9 +215,12 @@ module Mongo
         end
         retry_write(e, session, txn_num, &block)
       rescue Error::OperationFailure => e
-        if (session.in_transaction? && !ending_transaction) || !e.write_retryable?
+        if e.unsupported_retryable_write?
+          raise_unsupported_error(e)
+        elsif (session.in_transaction? && !ending_transaction) || !e.write_retryable?
           raise
         end
+
         retry_write(e, session, txn_num, &block)
       end
     end
@@ -403,5 +406,15 @@ module Mongo
       end
       Logger.logger.warn "#{message} due to: #{e.class.name} #{e.message}"
     end
+
+    # Retry writes on MMAPv1 should raise an actionable error; append actionable
+    # information to the error message and preserve the backtrace.
+    def raise_unsupported_error(e)
+      new_error = Error::OperationFailure.new("#{e.class}: #{e} "\
+        "This MongoDB deployment does not support retryable writes. Please add "\
+        "retryWrites=false to your connection string or use the retry_writes: false Ruby client option")
+      new_error.set_backtrace(e.backtrace)
+      raise new_error
+    end
   end
 end

data/lib/mongo/server/description.rb

@@ -20,6 +20,13 @@ module Mongo
     # Represents a description of the server, populated by the result of the
     # ismaster command.
     #
+    # Note: Unknown servers do not have wire versions, but for legacy reasons
+    # we return 0 for min_wire_version and max_wire_version of any server that does
+    # not have them. Presently the driver sometimes constructs commands when the
+    # server is unknown, so references to min_wire_version and max_wire_version
+    # should not be nil. When driver behavior is changed
+    # (https://jira.mongodb.org/browse/RUBY-1805), this may no longer be necessary.
+    #
     # @since 2.0.0
     class Description
 
@@ -192,9 +199,7 @@ module Mongo
       def initialize(address, config = {}, average_round_trip_time = nil)
         @address = address
         @config = config
-        unless unknown?
-          @features = Features.new(wire_versions, me || @address.to_s)
-        end
+        @features = Features.new(wire_versions, me || @address.to_s)
         @average_round_trip_time = average_round_trip_time
         @last_update_time = Time.now.dup.freeze
 
@@ -216,9 +221,6 @@ module Mongo
 
       # @return [ Features ] features The features for the server.
       def features
-        if unknown?
-          return Features.new(0..0, address.to_s)
-        end
         @features
       end
 
@@ -333,7 +335,7 @@ module Mongo
         config[MAX_WRITE_BATCH_SIZE] || DEFAULT_MAX_WRITE_BATCH_SIZE
       end
 
-      # Get the maximum wire version.
+      # Get the maximum wire version. Defaults to zero.
       #
       # @example Get the max wire version.
       #   description.max_wire_version
@@ -342,10 +344,10 @@ module Mongo
       #
       # @since 2.0.0
       def max_wire_version
-        config[MAX_WIRE_VERSION]
+        config[MAX_WIRE_VERSION] || 0
       end
 
-      # Get the minimum wire version.
+      # Get the minimum wire version. Defaults to zero.
       #
       # @example Get the min wire version.
       #   description.min_wire_version
@@ -354,7 +356,7 @@ module Mongo
       #
       # @since 2.0.0
       def min_wire_version
-        config[MIN_WIRE_VERSION]
+        config[MIN_WIRE_VERSION] || 0
       end
 
       # Get the me field value.

data/lib/mongo/session.rb

@@ -299,7 +299,7 @@ module Mongo
         if within_states?(TRANSACTION_IN_PROGRESS_STATE)
           begin
             abort_transaction
-          rescue Mongo::Error
+          rescue Mongo::Error, Error::AuthError
           end
         end
         @client.cluster.session_pool.checkin(@server_session)
@@ -429,6 +429,9 @@ module Mongo
               transaction_in_progress = false
               raise
             end
+          rescue Error::AuthError
+            transaction_in_progress = false
+            raise
           end
         end
       end

data/lib/mongo/session/session_pool.rb

@@ -117,7 +117,7 @@ module Mongo
               :selector => {endSessions: @queue.shift(10_000).collect { |s| s.session_id }},
               :db_name => Database::ADMIN).execute(server)
         end
-      rescue Mongo::Error
+      rescue Mongo::Error, Error::AuthError
       end
 
       private

data/lib/mongo/socket.rb

@@ -49,6 +49,9 @@ module Mongo
     # @return [ Hash ] The options.
     attr_reader :options
 
+    # @return [ Float ] timeout The socket timeout.
+    attr_reader :timeout
+
     # Is the socket connection alive?
     #
     # @example Is the socket alive?
@@ -123,10 +126,14 @@ module Mongo
     def read(length)
       handle_errors do
         data = read_from_socket(length)
-        raise IOError unless (data.length > 0 || length == 0)
+        unless (data.length > 0 || length == 0)
+          raise IOError, "Expected to read > 0 bytes but read 0 bytes"
+        end
         while data.length < length
           chunk = read_from_socket(length - data.length)
-          raise IOError unless (chunk.length > 0 || length == 0)
+          unless (chunk.length > 0 || length == 0)
+            raise IOError, "Expected to read > 0 bytes but read 0 bytes"
+          end
           data << chunk
         end
         data
@@ -185,7 +192,9 @@ module Mongo
         return ''.force_encoding('BINARY')
       end
 
-      deadline = (Time.now + timeout) if timeout
+      if _timeout = self.timeout
+        deadline = Time.now + _timeout
+      end
 
       # We want to have a fixed and reasonably small size buffer for reads
       # because, for example, OpenSSL reads in 16 kb chunks max.
@@ -232,10 +241,22 @@ module Mongo
           data[retrieved, chunk.length] = chunk
           retrieved += chunk.length
         end
-      rescue IO::WaitReadable
-        select_timeout = (deadline - Time.now) if deadline
-        if (select_timeout && select_timeout <= 0) || !Kernel::select([@socket], nil, [@socket], select_timeout)
-          raise Timeout::Error.new("Took more than #{timeout} seconds to receive data.")
+      # As explained in https://ruby-doc.com/core-trunk/IO.html#method-c-select,
+      # reading from a TLS socket may require writing which may raise WaitWritable
+      rescue IO::WaitReadable, IO::WaitWritable => exc
+        if deadline
+          select_timeout = deadline - Time.now
+          if select_timeout <= 0
+            raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
+          end
+        end
+        if exc.is_a?(IO::WaitReadable)
+          select_args = [[@socket], nil, [@socket], select_timeout]
+        else
+          select_args = [nil, [@socket], [@socket], select_timeout]
+        end
+        unless Kernel::select(*select_args)
+          raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
         end
         retry
       end

data/lib/mongo/socket/ssl.rb

@@ -33,9 +33,6 @@ module Mongo
       # @return [ Integer ] port The port to connect to.
       attr_reader :port
 
-      # @return [ Float ] timeout The socket timeout.
-      attr_reader :timeout
-
       # Establishes a socket connection.
       #
       # @example Connect the socket.

data/lib/mongo/socket/tcp.rb

@@ -26,9 +26,6 @@ module Mongo
       # @return [ Integer ] port The port to connect to.
       attr_reader :port
 
-      # @return [ Float ] timeout The socket timeout.
-      attr_reader :timeout
-
       # Establishes a socket connection.
       #
       # @example Connect the socket.

data/lib/mongo/socket/unix.rb

@@ -23,9 +23,6 @@ module Mongo
       # @return [ String ] path The path to connect to.
       attr_reader :path
 
-      # @return [ Float ] timeout The socket timeout.
-      attr_reader :timeout
-
       # Initializes a new Unix socket.
       #
       # @example Create the Unix socket.

data/lib/mongo/version.rb

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

data/spec/integration/retryable_writes_errors_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Retryable writes errors tests' do
+  describe 'when the storage engine does not support retryable writes but the server does' do
+    require_mmapv1
+    min_server_fcv '3.6'
+    require_topology :replica_set, :sharded
+
+    before do
+      collection.delete_many
+    end
+
+    let(:collection) do
+      client[authorized_collection.name]
+    end
+
+    let(:client) do
+      authorized_client.with(retry_writes: true)
+    end
+
+    after do
+      client.close(true)
+    end
+
+    context 'when a retryable write is attempted' do
+      it 'raises an actionable error message' do
+        expect {
+          collection.insert_one(a:1)
+        }.to raise_error(Mongo::Error::OperationFailure, /This MongoDB deployment does not support retryable writes. Please add retryWrites=false to your connection string or use the retry_writes: false Ruby client option/)
+        expect(collection.find.count).to eq(0)
+      end
+    end
+  end
+end

data/spec/mongo/retryable_spec.rb

@@ -591,5 +591,18 @@ describe Mongo::Retryable do
       end
     end
 
+    context 'when an error due to using an unsupported storage engine occurs' do
+      before do
+        expect(operation).to receive(:execute).and_raise(
+          Mongo::Error::OperationFailure.new('Transaction numbers are only allowed on...',
+            nil, :code=>20)).ordered
+      end
+
+      it 'raises an exception with the correct error message' do
+        expect {
+          retryable.write
+        }.to raise_error(Mongo::Error::OperationFailure, /This MongoDB deployment does not support retryable writes. Please add retryWrites=false to your connection string or use the retry_writes: false Ruby client option/)
+      end
+    end
   end
 end

data/spec/mongo/server/connection_spec.rb

@@ -757,26 +757,30 @@ describe Mongo::Server::Connection, retry: 3 do
       end
     end
 
-    context 'when a socket timeout is set' do
+    context 'when a socket timeout is set on client' do
 
       let(:connection) do
         described_class.new(server, socket_timeout: 10)
       end
 
-      it 'sets the timeout' do
+      it 'is propagated to connection timeout' do
         expect(connection.timeout).to eq(10)
       end
+    end
 
+    context 'when an operation never completes' do
       let(:client) do
-        authorized_client.with(socket_timeout: 1.5)
+        authorized_client.with(socket_timeout: 1.5,
+          # Read retries would cause the reads to be attempted twice,
+          # thus making the find take twice as long to time out.
+          retry_reads: false, max_read_retries: 0)
       end
 
       before do
-        authorized_collection.delete_many
-        authorized_collection.insert_one(a: 1)
+        client.cluster.next_primary
       end
 
-      it 'raises a timeout when it expires' do
+      it 'times out and raises SocketTimeoutError' do
         start = Time.now
         begin
           Timeout::timeout(1.5 + 15) do
@@ -784,11 +788,11 @@ describe Mongo::Server::Connection, retry: 3 do
           end
         rescue => ex
           end_time = Time.now
-          expect(ex).to be_a(Timeout::Error)
-          expect(ex.message).to eq("Took more than 1.5 seconds to receive data.")
+          expect(ex).to be_a(Mongo::Error::SocketTimeoutError)
+          expect(ex.message).to match(/Took more than 1.5 seconds to receive data/)
         end
-        # Account for wait queue timeout (2s) and rescue
-        expect(end_time - start).to be_within(2.5).of(1.5)
+        # allow 1.5 seconds +- 0.5 seconds
+        expect(end_time - start).to be_within(1).of(2)
       end
 
       context 'when the socket_timeout is negative' do
@@ -816,7 +820,7 @@ describe Mongo::Server::Connection, retry: 3 do
         it 'raises a timeout error' do
           expect {
             reply
-          }.to raise_exception(Timeout::Error)
+          }.to raise_exception(Mongo::Error::SocketTimeoutError)
         end
       end
     end

data/spec/mongo/server/description_spec.rb

@@ -21,7 +21,7 @@ describe Mongo::Server::Description do
       'maxMessageSizeBytes' => 48000000,
       'maxWriteBatchSize' => 1000,
       'maxWireVersion' => 2,
-      'minWireVersion' => 0,
+      'minWireVersion' => 1,
       'localTime' => Time.now,
       'lastWrite' => { 'lastWriteDate' => Time.now },
       'logicalSessionTimeoutMinutes' => 7,
@@ -194,7 +194,7 @@ describe Mongo::Server::Description do
       end
 
       it 'returns the default' do
-        expect(description.max_wire_version).to be nil
+        expect(description.max_wire_version).to eq(0)
       end
     end
   end
@@ -208,7 +208,7 @@ describe Mongo::Server::Description do
       end
 
       it 'returns the value' do
-        expect(description.min_wire_version).to eq(0)
+        expect(description.min_wire_version).to eq(1)
       end
     end
 
@@ -219,7 +219,7 @@ describe Mongo::Server::Description do
       end
 
       it 'returns the default' do
-        expect(description.min_wire_version).to be nil
+        expect(description.min_wire_version).to eq(0)
       end
     end
   end

data/spec/mongo/socket_spec.rb

@@ -1,4 +1,4 @@
-require 'lite_spec_helper'
+require 'spec_helper'
 
 describe Mongo::Socket do
 
@@ -51,4 +51,66 @@ describe Mongo::Socket do
       end.to raise_error(Mongo::Error::SocketError, 'OpenSSL::SSL::SSLError: Test error (for fake-address) (MongoDB may not be configured with SSL support)')
     end
   end
+
+  describe '#read' do
+    let(:target_host) do
+      host = ClusterConfig.instance.primary_address_host
+      # Take ipv4 address
+      Socket.getaddrinfo(host, 0).detect { |ai| ai.first == 'AF_INET' }[3]
+    end
+
+    let(:socket) do
+      Mongo::Socket::TCP.new(target_host, ClusterConfig.instance.primary_address_port, 1, Socket::PF_INET)
+    end
+
+    let(:raw_socket) { socket.instance_variable_get('@socket') }
+
+    let(:wait_readable_class) do
+      Class.new(Exception) do
+        include IO::WaitReadable
+      end
+    end
+
+    context 'timeout' do
+      clean_slate_for_all
+
+      shared_examples_for 'times out' do
+        it 'times out' do
+          expect(socket).to receive(:timeout).at_least(:once).and_return(0.2)
+          # When we raise WaitWritable, the socket object is ready for
+          # writing which makes the read method invoke read_nonblock many times
+          expect(raw_socket).to receive(:read_nonblock).at_least(:once) do |len, buf|
+            sleep 0.01
+            raise exception_class
+          end
+
+          expect do
+            socket.read(10)
+          end.to raise_error(Mongo::Error::SocketTimeoutError, /Took more than .* seconds to receive data \(for /)
+        end
+      end
+
+      context 'with WaitReadable' do
+
+        let(:exception_class) do
+          Class.new(Exception) do
+            include IO::WaitReadable
+          end
+        end
+
+        it_behaves_like 'times out'
+      end
+
+      context 'with WaitWritable' do
+
+        let(:exception_class) do
+          Class.new(Exception) do
+            include IO::WaitWritable
+          end
+        end
+
+        it_behaves_like 'times out'
+      end
+    end
+  end
 end

data/spec/support/cluster_config.rb

@@ -74,6 +74,20 @@ class ClusterConfig
     end
   end
 
+  def primary_address_str
+    primary_address
+  end
+
+  def primary_address_host
+    both = primary_address_str
+    both.split(':').first
+  end
+
+  def primary_address_port
+    both = primary_address_str
+    both.split(':')[1] || 27017
+  end
+
   # Try running a command on the admin database to see if the mongod was
   # started with auth.
   def auth_enabled?

data/spec/support/spec_config.rb

@@ -337,7 +337,6 @@ EOT
     {
       max_pool_size: 1,
       heartbeat_frequency: 20,
-      max_read_retries: 5,
       # The test suite seems to perform a number of operations
       # requiring server selection. Hence a timeout of 1 here,
       # together with e.g. a misconfigured replica set,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo
 version: !ruby/object:Gem::Version
-  version: 2.10.0.rc0
+  version: 2.10.0
 platform: ruby
 authors:
 - Tyler Brock
@@ -31,7 +31,7 @@ cert_chain:
   bMYVwXXhV8czdzgkQB/ZPWHSbEWXnmkze1mzvqWBCPOVXYrcnL9cnEl/RoxtS1hr
   Db6Ac6mCUSYfYHBWpWqxjc45n70i5Xi1
   -----END CERTIFICATE-----
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson
@@ -456,6 +456,7 @@ files:
 - spec/integration/read_concern_spec.rb
 - spec/integration/read_preference_spec.rb
 - spec/integration/reconnect_spec.rb
+- spec/integration/retryable_writes_errors_spec.rb
 - spec/integration/retryable_writes_spec.rb
 - spec/integration/sdam_error_handling_spec.rb
 - spec/integration/sdam_events_spec.rb
@@ -1110,9 +1111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -1216,6 +1217,7 @@ test_files:
 - spec/integration/time_zone_querying_spec.rb
 - spec/integration/mongos_pinning_spec.rb
 - spec/integration/heartbeat_events_spec.rb
+- spec/integration/retryable_writes_errors_spec.rb
 - spec/integration/docs_examples_spec.rb
 - spec/integration/sdam_error_handling_spec.rb
 - spec/mongo/cursor_spec.rb