mongo 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c9b3e878a211c1145f6cbe09912ac0fa3c6463
-  data.tar.gz: d18c8e33629e8915fab3fb76edefb8cc631f65af
+  metadata.gz: d8c7fcad401a8586ae8ba1c0b864238fce8039a2
+  data.tar.gz: 9499b901d192abf1910f71a47fa0316633c32c31
 SHA512:
-  metadata.gz: a6ded8b81178ac9561d5f9a3a8ec83edb31dec5528b8365e83f7d24b1b673e23276c1061956db19879d10feb602dacfeb34bbc7f51e5875fd4593ebfea0aa1c0
-  data.tar.gz: 9431cb7dbb2b2b6a18292f454d84835ddbcee391f2a886bd93d398d3f9190a199f9d7a0f6fc2fc27eb95d32b59d900e6fc09317c2b66ec797fc12a42dabaf87c
+  metadata.gz: 5b4532f3365fda5b9351e334a882e92ccaa7fb0c006fa84b3e5e0bb922f9a8b3a5a7366f00ad1b505d0d7d4298c5438b5e57a5ce0f397105c8f49835618681b3
+  data.tar.gz: 262cb8675d073741690971aa9e141fb53324de2a3835f6e0e024b8faa654fba1aa3c451b4711793ef1e7df0d039e765675c5cb4bf1d1229a214ab70389dac379

data/lib/mongo/client.rb

@@ -36,8 +36,8 @@ module Mongo
     # @return [ Hash ] options The configuration options.
     attr_reader :options
 
-    # Delegate command execution to the current database.
-    def_delegators :@database, :command
+    # Delegate command and collections execution to the current database.
+    def_delegators :@database, :command, :collections
 
     # Delegate subscription to monitoring.
     def_delegators :@monitoring, :subscribe, :unsubscribe
@@ -151,6 +151,10 @@ module Mongo
     # @option options [ Logger ] :logger A custom logger if desired.
     # @option options [ true, false ] :truncate_logs Whether to truncate the
     #   logs at the default 250 characters.
+    # @option options [ Integer ] :max_read_retries The maximum number of read
+    #   retries on mongos query failures.
+    # @option options [ Float ] :read_retry_interval The interval, in seconds,
+    #   in which reads on a mongos are retried.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)

data/lib/mongo/cluster.rb

@@ -25,6 +25,16 @@ module Mongo
     include Event::Subscriber
     include Loggable
 
+    # The default number of mongos read retries.
+    #
+    # @since 2.1.1
+    MAX_READ_RETRIES = 1
+
+    # The default mongos read retry interval, in seconds.
+    #
+    # @since 2.1.1
+    READ_RETRY_INTERVAL = 5
+
     # @return [ Hash ] The options hash.
     attr_reader :options
 
@@ -143,6 +153,32 @@ module Mongo
       @topology = topology.elect_primary(description, servers_list)
     end
 
+    # Get the maximum number of times the cluster can retry a read operation on
+    # a mongos.
+    #
+    # @example Get the max read retries.
+    #   cluster.max_read_retries
+    #
+    # @return [ Integer ] The maximum retries.
+    #
+    # @since 2.1.1
+    def max_read_retries
+      options[:max_read_retries] || MAX_READ_RETRIES
+    end
+
+    # Get the interval, in seconds, in which a mongos read operation is
+    # retried.
+    #
+    # @example Get the read retry interval.
+    #   cluster.read_retry_interval
+    #
+    # @return [ Float ] The interval.
+    #
+    # @since 2.1.1
+    def read_retry_interval
+      options[:read_retry_interval] || READ_RETRY_INTERVAL
+    end
+
     # Notify the cluster that a standalone server was discovered so that the
     # topology can be updated accordingly.
     #

data/lib/mongo/collection/view/readable.rb

@@ -138,7 +138,7 @@ module Mongo
           cmd[:limit] = options[:limit] if options[:limit]
           cmd[:maxTimeMS] = options[:max_time_ms] if options[:max_time_ms]
           read_with_retry do
-            database.command(cmd, options).n
+            database.command(cmd, options).n.to_i
           end
         end
 

data/lib/mongo/error/operation_failure.rb

@@ -18,6 +18,37 @@ module Mongo
     # Raised when an operation fails for some reason.
     #
     # @since 2.0.0
-    class OperationFailure < Error; end
+    class OperationFailure < Error
+
+      # These are magic error messages that could indicate a cluster
+      # reconfiguration behind a mongos. We cannot check error codes as they
+      # change between versions, for example 15988 which has 2 completely
+      # different meanings between 2.4 and 3.0.
+      #
+      # @since 2.1.1
+      RETRY_MESSAGES = [
+        'transport error',
+        'socket exception',
+        "can't connect",
+        'no master',
+        'not master',
+        'connect failed',
+        'error querying',
+        'could not get last error',
+        'connection attempt failed'
+      ].freeze
+
+      # Can the operation that caused the error be retried?
+      #
+      # @example Is the error retryable?
+      #   error.retryable?
+      #
+      # @return [ true, false ] If the error is retryable.
+      #
+      # @since 2.1.1
+      def retryable?
+        RETRY_MESSAGES.any?{ |m| message.include?(m) }
+      end
+    end
   end
 end

data/lib/mongo/retryable.rb

@@ -26,6 +26,8 @@ module Mongo
 
     # Execute a read operation with a retry.
     #
+    # @api private
+    #
     # @example Execute the read.
     #   read_with_retry do
     #     ...
@@ -33,21 +35,35 @@ module Mongo
     #
     # @note This only retries read operations on socket errors.
     #
+    # @param [ Integer ] attempt The retry attempt count - for internal use.
     # @param [ Proc ] block The block to execute.
     #
     # @return [ Result ] The result of the operation.
     #
     # @since 2.1.0
-    def read_with_retry(&block)
+    def read_with_retry(attempt = 0, &block)
       begin
         block.call
       rescue Error::SocketError, Error::SocketTimeoutError
         retry_operation(&block)
+      rescue Error::OperationFailure => e
+        if cluster.sharded? && e.retryable?
+          if attempt < cluster.max_read_retries
+            # We don't scan the cluster in this case as Mongos always returns
+            # ready after a ping no matter what the state behind it is.
+            sleep(cluster.read_retry_interval)
+            read_with_retry(attempt - 1, &block)
+          end
+        else
+          raise e
+        end
       end
     end
 
     # Execute a write operation with a retry.
     #
+    # @api private
+    #
     # @example Execute the write.
     #   write_with_retry do
     #     ...

data/lib/mongo/version.rb

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

data/spec/mongo/client_spec.rb

@@ -742,4 +742,24 @@ describe Mongo::Client do
       expect(client.dup.options).to be_a(Mongo::Options::Redacted)
     end
   end
+
+  describe '#collections' do
+
+    before do
+      authorized_client.database[:users].create
+    end
+
+    after do
+      authorized_client.database[:users].drop
+    end
+
+    let(:collection) do
+      Mongo::Collection.new(authorized_client.database, 'users')
+    end
+
+    it 'refers the current database collections' do
+      expect(authorized_client.collections).to include(collection)
+      expect(authorized_client.collections).to all(be_a(Mongo::Collection))
+    end
+  end
 end

data/spec/mongo/collection/view/readable_spec.rb

@@ -227,6 +227,10 @@ describe Mongo::Collection::View::Readable do
       it 'returns the count of matching documents' do
         expect(view.count).to eq(1)
       end
+
+      it 'returns an integer' do
+        expect(view.count).to be_a(Integer)
+      end
     end
 
     context 'when no selector is provided' do

data/spec/mongo/retryable_spec.rb

@@ -14,6 +14,14 @@ describe Mongo::Retryable do
         @cluster = cluster
       end
 
+      def max_read_retries
+        cluster.max_read_retries
+      end
+
+      def read_retry_interval
+        cluster.read_retry_interval
+      end
+
       def read
         read_with_retry do
           operation.execute
@@ -81,14 +89,80 @@ describe Mongo::Retryable do
 
     context 'when an operation failure occurs' do
 
-      before do
-        expect(operation).to receive(:execute).and_raise(Mongo::Error::OperationFailure).ordered
+      context 'when the cluster is not a mongos' do
+
+        before do
+          expect(operation).to receive(:execute).and_raise(Mongo::Error::OperationFailure).ordered
+          expect(cluster).to receive(:sharded?).and_return(false)
+        end
+
+        it 'raises an exception' do
+          expect {
+            retryable.read
+          }.to raise_error(Mongo::Error::OperationFailure)
+        end
       end
 
-      it 'raises an exception' do
-        expect {
-          retryable.read
-        }.to raise_error(Mongo::Error::OperationFailure)
+      context 'when the cluster is a mongos' do
+
+        context 'when the operation failure is not retryable' do
+
+          let(:error) do
+            Mongo::Error::OperationFailure.new('not authorized')
+          end
+
+          before do
+            expect(operation).to receive(:execute).and_raise(error).ordered
+            expect(cluster).to receive(:sharded?).and_return(true)
+          end
+
+          it 'raises the exception' do
+            expect {
+              retryable.read
+            }.to raise_error(Mongo::Error::OperationFailure)
+          end
+        end
+
+        context 'when the operation failure is retryable' do
+
+          let(:error) do
+            Mongo::Error::OperationFailure.new('no master')
+          end
+
+          context 'when the retry succeeds' do
+
+            before do
+              expect(operation).to receive(:execute).and_raise(error).ordered
+              expect(cluster).to receive(:sharded?).and_return(true)
+              expect(cluster).to receive(:max_read_retries).and_return(1).ordered
+              expect(cluster).to receive(:read_retry_interval).and_return(0.1).ordered
+              expect(operation).to receive(:execute).and_return(true).ordered
+            end
+
+            it 'returns the result' do
+              expect(retryable.read).to be true
+            end
+          end
+
+          context 'when the retry fails once and then succeeds' do
+
+            before do
+              expect(operation).to receive(:execute).and_raise(error).ordered
+              expect(cluster).to receive(:sharded?).and_return(true)
+              expect(cluster).to receive(:max_read_retries).and_return(1).ordered
+              expect(cluster).to receive(:read_retry_interval).and_return(0.1).ordered
+              expect(operation).to receive(:execute).and_raise(error).ordered
+              expect(cluster).to receive(:sharded?).and_return(true)
+              expect(cluster).to receive(:max_read_retries).and_return(1).ordered
+              expect(cluster).to receive(:read_retry_interval).and_return(0.1).ordered
+              expect(operation).to receive(:execute).and_return(true).ordered
+            end
+
+            it 'returns the result' do
+              expect(retryable.read).to be true
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Tyler Brock
@@ -9,30 +9,8 @@ authors:
 - Durran Jordan
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRQwEgYDVQQDDAtkcml2
-  ZXItcnVieTEVMBMGCgmSJomT8ixkARkWBTEwZ2VuMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMB4XDTE0MTEyMDE1NTYxOVoXDTE1MTEyMDE1NTYxOVowQjEUMBIGA1UEAwwL
-  ZHJpdmVyLXJ1YnkxFTATBgoJkiaJk/IsZAEZFgUxMGdlbjETMBEGCgmSJomT8ixk
-  ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANFdSAa8fRm1
-  bAM9za6Z0fAH4g02bqM1NGnw8zJQrE/PFrFfY6IFCT2AsLfOwr1maVm7iU1+kdVI
-  IQ+iI/9+E+ArJ+rbGV3dDPQ+SLl3mLT+vXjfjcxMqI2IW6UuVtt2U3Rxd4QU0kdT
-  JxmcPYs5fDN6BgYc6XXgUjy3m+Kwha2pGctdciUOwEfOZ4RmNRlEZKCMLRHdFP8j
-  4WTnJSGfXDiuoXICJb5yOPOZPuaapPSNXp93QkUdsqdKC32I+KMpKKYGBQ6yisfA
-  5MyVPPCzLR1lP5qXVGJPnOqUAkvEUfCahg7EP9tI20qxiXrR6TSEraYhIFXL0EGY
-  u8KAcPHm5KkCAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
-  BBYEFFt3WbF+9JpUjAoj62cQBgNb8HzXMCAGA1UdEQQZMBeBFWRyaXZlci1ydWJ5
-  QDEwZ2VuLmNvbTAgBgNVHRIEGTAXgRVkcml2ZXItcnVieUAxMGdlbi5jb20wDQYJ
-  KoZIhvcNAQEFBQADggEBAKjvumG2Fy9zAoSc1OEcmAqqOfzx1U+isGyEsz1rs5eT
-  HAIHsxaEdZTjSwDuqyelLDWJHWspeWU5pV5lepfI4cop29wwoPJIJ9Az2RMMbtdv
-  gFApVb6QX61OMenFeOdJ/QZ3n9xcrxJZFdvrXQ5GjEU2anq3dJhFeESwIMlfVJC7
-  7XrlMxizzH712DPfy65dMj0Y39qHdoWYKeCkEoj5UWNcHRK9xgaHJR6prlXrIhgb
-  o2UXDbWtz5PqoFd8EgNJAn3+BG1pwC9S9pVFG3WPucfAx/bE8iq/vvchHei5Y/Vo
-  aAz5f/hY4zFeYWvGDBHYEXE1rTN2hhMSyJscPcFbmz0=
-  -----END CERTIFICATE-----
-date: 2015-09-10 00:00:00.000000000 Z
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson
@@ -59,6 +37,7 @@ files:
 - README.md
 - Rakefile
 - bin/mongo_console
+- lib/csasl/csasl.bundle
 - lib/mongo.rb
 - lib/mongo/address.rb
 - lib/mongo/address/ipv4.rb
@@ -542,7 +521,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongo
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby driver for MongoDB

checksums.yaml.gz.sig

@@ -1,5 +0,0 @@
-�"W5c��a�A��S��
-� !~���G	�7U`A��K�$�
-pno�c��)o��u�� �$��
-+
-+I#W�
��l5���̿�:F��D;��#QnG��*OP:b�[Hٲ+�4�}�V�o}�).�kͯDjݦ�U�|)_�P@<a2*��'���N��!��)��ڴ8�dH>