mongo 2.8.0 → 2.9.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9696938332fb0fee42821edacd510e1a83217adf91e8418655d54da3c14edbc3
-  data.tar.gz: 12bd18e5b2f36f28f8efca9d5cd03851f0ca593a3bc0e72f57404479bd837e34
+  metadata.gz: bdc48b8fb67060880d69ada836cc9c468abe7fd2b2e959cffaeee5edb410f68a
+  data.tar.gz: c8a365dac958eea89f939f78a668474f9f2e5d1ddb94e8cf772d8eeccb52d6a2
 SHA512:
-  metadata.gz: bf455a48c0b6def9c3e509660b3eacfe8a5cba5578cfd181f621edbaeef497fbd04da6706e80edcf5a879aedd54fdc95fa3f94e2a4d3f64e311291a53cd0c5b5
-  data.tar.gz: 290186d4c7f26812685b26543a392dc5fe82847c8f2071746ba1d1d83af44c9a6ecedc69ebd41df09f96d7950844c41f44cdd1b02c5f1cc870a84b0416479684
+  metadata.gz: 6984456cca54c0a352903f1336a6a5c3674eacdd6abf7f9558900cc11d33806d9c32aa7700bcc950a0a8ca973ea5c7f5ad223dbd49c267c04e68703cfb98eda3
+  data.tar.gz: 1ea50f9927a8bb622bf0188c1b158d00f80d35fe0fae72e81c6bac9a94775a3be3f7404b6674962db97833d3449f3bed448fff177527c853fd2e8610c78c783a

data/Rakefile

@@ -33,6 +33,18 @@ namespace :spec do
     SpecSetup.new.run
   end
 
+  desc 'Prints configuration used by the test suite'
+  task :config do
+    $: << File.join(File.dirname(__FILE__), 'spec')
+
+    # Since this task is usually used for troubleshooting of test suite
+    # configuration, leave driver log level at the default of debug to
+    # have connection diagnostics printed during handshakes and such.
+    require 'support/spec_config'
+    require 'support/client_registry'
+    SpecConfig.instance.print_summary
+  end
+
   task :ci => ['spec:prepare', :spec]
 end
 

data/lib/mongo.rb

@@ -12,9 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'base64'
 require 'forwardable'
-require 'bson'
+require 'ipaddr'
+require 'logger'
 require 'openssl'
+require 'rbconfig'
+require 'resolv'
+require 'securerandom'
+require 'set'
+require 'socket'
+require 'stringio'
+require 'timeout'
+require 'uri'
+require 'zlib'
+
+require 'bson'
+
 require 'mongo/id'
 require 'mongo/bson'
 require 'mongo/semaphore'

data/lib/mongo/address/ipv6.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'ipaddr'
-
 module Mongo
   class Address
 

data/lib/mongo/auth/scram/conversation.rb

@@ -12,9 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'securerandom'
-require 'base64'
-
 module Mongo
   module Auth
     class SCRAM

data/lib/mongo/bulk_write/result_combiner.rb

@@ -53,8 +53,18 @@ module Mongo
       #
       # @since 2.1.0
       def combine!(result, count)
-        combine_counts!(result)
-        combine_ids!(result)
+        # Errors can be communicated by the server in a variety of fields:
+        # writeError, writeErrors, writeConcernError, writeConcernErrors.
+        # Currently only errors given in writeConcernErrors will cause
+        # counts not to be added, because this behavior is covered by the
+        # retryable writes tests. It is possible that some or all of the
+        # other errors should also be excluded when combining counts and
+        # ids, and it is also possible that only a subset of these error
+        # fields is actually possible in the context of bulk writes.
+        unless result.write_concern_error?
+          combine_counts!(result)
+          combine_ids!(result)
+        end
         combine_errors!(result)
         @count += count
       end

data/lib/mongo/client.rb

@@ -26,7 +26,10 @@ module Mongo
     # subcomponents.
     #
     # @since 2.1.0
-    CRUD_OPTIONS = [ :database, :read, :write, :retry_writes ].freeze
+    CRUD_OPTIONS = [
+      :database, :read, :write, :retry_reads, :retry_writes,
+      :max_read_retries, :read_retry_interval, :max_write_retries,
+    ].freeze
 
     # Valid client options.
     #
@@ -47,6 +50,7 @@ module Mongo
       :max_idle_time,
       :max_pool_size,
       :max_read_retries,
+      :max_write_retries,
       :min_pool_size,
       :monitoring,
       :monitoring_io,
@@ -56,6 +60,7 @@ module Mongo
       :read_concern,
       :read_retry_interval,
       :replica_set,
+      :retry_reads,
       :retry_writes,
       :scan,
       :sdam_proc,
@@ -170,7 +175,7 @@ module Mongo
     #   # connect to the replica set if given the address of a server in
     #   # a replica set
     #
-    # @param [ Array<String>, String ] addresses_or_uri The array of server addresses in the
+    # @param [ Array<String> | String ] addresses_or_uri The array of server addresses in the
     #   form of host:port or a MongoDB URI connection string.
     # @param [ Hash ] options The options to be used by the client.
     #
@@ -204,7 +209,9 @@ module Mongo
     # @option options [ Integer ] :max_pool_size The maximum size of the
     #   connection pool.
     # @option options [ Integer ] :max_read_retries The maximum number of read
-    #   retries on mongos query failures.
+    #   retries when legacy read retries are in use.
+    # @option options [ Integer ] :max_write_retries The maximum number of write
+    #   retries when legacy write retries are in use.
     # @option options [ Integer ] :min_pool_size The minimum size of the
     #   connection pool.
     # @option options [ true, false ] :monitoring If false is given, the
@@ -238,9 +245,13 @@ module Mongo
     #   in which reads on a mongos are retried.
     # @option options [ Symbol ] :replica_set The name of the replica set to
     #   connect to. Servers not in this replica set will be ignored.
-    # @option options [ true, false ] :retry_writes Retry writes once when
+    # @option options [ true | false ] :retry_reads If true, modern retryable
+    #   reads are enabled (which is the default). If false, modern retryable
+    #   reads are disabled and legacy retryable reads are enabled.
+    # @option options [ true | false ] :retry_writes Retry writes once when
     #   connected to a replica set or sharded cluster versions 3.6 and up.
-    # @option options [ true, false ] :scan Whether to scan all seeds
+    #   (Default is true.)
+    # @option options [ true | false ] :scan Whether to scan all seeds
     #   in constructor. The default in driver version 2.x is to do so;
     #   driver version 3.x will not scan seeds in constructor. Opt in to the
     #   new behavior by setting this option to false. *Note:* setting
@@ -318,6 +329,12 @@ module Mongo
       else
         options = {}
       end
+      unless options[:retry_reads] == false
+        options[:retry_reads] = true
+      end
+      unless options[:retry_writes] == false
+        options[:retry_writes] = true
+      end
       Lint.validate_underscore_read_preference(options[:read])
       Lint.validate_read_concern_option(options[:read_concern])
       if addresses_or_uri.is_a?(::String)
@@ -357,9 +374,45 @@ module Mongo
         server_selection_semaphore: @server_selection_semaphore,
         # but need to put the database back in for auth...
         database: options[:database],
+
+        # Put these options in for legacy compatibility, but note that
+        # their values on the client and the cluster do not have to match -
+        # applications should read these values from client, not from cluster
+        max_read_retries: options[:max_read_retries],
+        read_retry_interval: options[:read_retry_interval],
       )
     end
 
+    # Get the maximum number of times the client can retry a read operation
+    # when using legacy read retries.
+    #
+    # @return [ Integer ] The maximum number of retries.
+    #
+    # @api private
+    def max_read_retries
+      options[:max_read_retries] || Cluster::MAX_READ_RETRIES
+    end
+
+    # Get the interval, in seconds, in which read retries when using legacy
+    # read retries.
+    #
+    # @return [ Float ] The interval.
+    #
+    # @api private
+    def read_retry_interval
+      options[:read_retry_interval] || Cluster::READ_RETRY_INTERVAL
+    end
+
+    # Get the maximum number of times the client can retry a write operation
+    # when using legacy write retries.
+    #
+    # @return [ Integer ] The maximum number of retries.
+    #
+    # @api private
+    def max_write_retries
+      options[:max_write_retries] || Cluster::MAX_WRITE_RETRIES
+    end
+
     # Get an inspection of the client as a string.
     #
     # @example Inspect the client.
@@ -714,7 +767,7 @@ module Mongo
 
     def validate_max_min_pool_size!(option, opts)
       if option == :min_pool_size && opts[:min_pool_size]
-        max = opts[:max_pool_size] || Server::ConnectionPool::Queue::MAX_SIZE
+        max = opts[:max_pool_size] || Server::ConnectionPool::DEFAULT_MAX_SIZE
         raise Error::InvalidMinPoolSize.new(opts[:min_pool_size], max) unless opts[:min_pool_size] <= max
       end
       true

data/lib/mongo/cluster.rb

@@ -29,17 +29,18 @@ module Mongo
     include Event::Subscriber
     include Loggable
 
-    # The default number of mongos read retries.
+    # The default number of legacy read retries.
     #
     # @since 2.1.1
     MAX_READ_RETRIES = 1
 
-    # The default number of mongos write retries.
+    # The default number of legacy write retries.
     #
     # @since 2.4.2
     MAX_WRITE_RETRIES = 1
 
-    # The default mongos read retry interval, in seconds.
+    # The default read retry interval, in seconds, when using legacy read
+    # retries.
     #
     # @since 2.1.1
     READ_RETRY_INTERVAL = 5
@@ -246,21 +247,30 @@ module Mongo
                    :single?, :unknown?
     def_delegators :@cursor_reaper, :register_cursor, :schedule_kill_cursor, :unregister_cursor
 
-    # Get the maximum number of times the cluster can retry a read operation on
-    # a mongos.
+    # Get the maximum number of times the client can retry a read operation
+    # when using legacy read retries.
+    #
+    # @note max_read_retries should be retrieved from the Client instance,
+    #   not from a Cluster instance, because clusters may be shared between
+    #   clients with different values for max read retries.
     #
     # @example Get the max read retries.
     #   cluster.max_read_retries
     #
-    # @return [ Integer ] The maximum retries.
+    # @return [ Integer ] The maximum number of retries.
     #
     # @since 2.1.1
+    # @deprecated
     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.
+    # Get the interval, in seconds, in which read retries when using legacy
+    # read retries.
+    #
+    # @note read_retry_interval should be retrieved from the Client instance,
+    #   not from a Cluster instance, because clusters may be shared between
+    #   clients with different values for the read retry interval.
     #
     # @example Get the read retry interval.
     #   cluster.read_retry_interval
@@ -268,6 +278,7 @@ module Mongo
     # @return [ Float ] The interval.
     #
     # @since 2.1.1
+    # @deprecated
     def read_retry_interval
       options[:read_retry_interval] || READ_RETRY_INTERVAL
     end

data/lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'set'
-
 module Mongo
 
   class Cluster

data/lib/mongo/cluster/reapers/socket_reaper.rb

@@ -16,7 +16,7 @@ module Mongo
 
   class Cluster
 
-    # A manager that calls a method on each of a cluster's pools to close stale
+    # A manager that calls a method on each of a cluster's pools to close idle
     #  sockets.
     #
     # @api private
@@ -29,7 +29,7 @@ module Mongo
       # @example Initialize the socket reaper.
       #   SocketReaper.new(cluster)
       #
-      # @param [ Mongo::Cluster ] cluster The cluster whose pools' stale sockets
+      # @param [ Mongo::Cluster ] cluster The cluster whose pools' idle sockets
       #  need to be reaped at regular intervals.
       #
       # @since 2.5.0
@@ -37,23 +37,26 @@ module Mongo
         @cluster = cluster
       end
 
-      # Execute the operation to close the pool's stale sockets.
+      # Execute the operation to close the pool's idle sockets.
       #
-      # @example Close the stale sockets in each of the cluster's pools.
+      # @example Close the idle sockets in each of the cluster's pools.
       #   socket_reaper.execute
       #
       # @since 2.5.0
       def execute
         @cluster.servers.each do |server|
-          server.pool.close_stale_sockets!
-        end and true
+          server.pool.close_idle_sockets
+        end
+        true
       end
 
-      # When the socket reaper is garbage-collected, there's no need to close stale sockets;
-      #   sockets will be closed anyway when the pools are garbage-collected.
+      # When the socket reaper is garbage-collected, there's no need to close
+      #   idle sockets; sockets will be closed anyway when the pools are
+      #   garbage collected.
       #
       # @since 2.5.0
-      def flush; end
+      def flush
+      end
     end
   end
 end

data/lib/mongo/collection.rb

@@ -97,7 +97,7 @@ module Mongo
     #
     # @since 2.2.0
     def read_concern
-      options[:read_concern]
+      options[:read_concern] || database.read_concern
     end
 
     # Get the server selector on this collection.

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

@@ -110,8 +110,12 @@ module Mongo
           server.standalone? || server.mongos? || server.primary? || secondary_ok?
         end
 
+        def out?
+          pipeline.any? { |op| op.key?('$out') || op.key?(:$out) }
+        end
+
         def secondary_ok?
-          pipeline.none? { |op| op.key?('$out') || op.key?(:$out) }
+          !out?
         end
 
         def send_initial_query(server, session)

data/lib/mongo/collection/view/builder/map_reduce.rb

@@ -133,7 +133,7 @@ module Mongo
 
           def map_reduce_command
             command = BSON::Document.new(
-              :mapreduce => collection.name,
+              :mapReduce => collection.name,
               :map => map,
               :reduce => reduce,
               :query => filter,

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

@@ -81,6 +81,12 @@ module Mongo
         #   return changes that occurred at or after the specified timestamp. Any
         #   command run against the server will return a cluster time that can
         #   be used here. Only recognized by server versions 4.0+.
+        # @option options [ Bson::Document, Hash ] :start_after Similar to :resume_after, this
+        #   option takes a resume token and starts a new change stream returning the first
+        #   notification after the token. This will allow users to watch collections that have been
+        #   dropped and recreated or newly renamed collections without missing any notifications.
+        #
+        #   The server will report an error if `startAfter` and `resumeAfter` are both specified.
         #
         # @since 2.5.0
         def initialize(view, pipeline, changes_for, options = {})
@@ -89,6 +95,7 @@ module Mongo
           @change_stream_filters = pipeline && pipeline.dup
           @options = options && options.dup.freeze
           @resume_token = @options[:resume_after]
+          @start_after = @options[:start_after]
           create_cursor!
 
           # We send different parameters when we resume a change stream
@@ -263,17 +270,22 @@ module Mongo
           @start_at_operation_time_supported = nil
 
           session = client.send(:get_session, @options)
-          server = server_selector.select_server(cluster)
-          result = send_initial_query(server, session)
-          if doc = result.replies.first && result.replies.first.documents.first
-            @start_at_operation_time = doc['operationTime']
-          else
-            # The above may set @start_at_operation_time to nil
-            # if it was not in the document for some reason,
-            # for consistency set it to nil here as well
-            @start_at_operation_time = nil
+          start_at_operation_time = nil
+          @cursor = read_with_retry_cursor(session, server_selector, view) do |server|
+            result = send_initial_query(server, session)
+            if doc = result.replies.first && result.replies.first.documents.first
+              start_at_operation_time = doc['operationTime']
+            else
+              # The above may set @start_at_operation_time to nil
+              # if it was not in the document for some reason,
+              # for consistency set it to nil here as well.
+              # NB: since this block may be executed more than once, each
+              # execution must write to start_at_operation_time either way.
+              start_at_operation_time = nil
+            end
+            result
           end
-          @cursor = Cursor.new(view, result, server, disable_retry: true, session: session)
+          @start_at_operation_time = start_at_operation_time
         end
 
         def pipeline
@@ -296,6 +308,10 @@ module Mongo
               if @resume_token
                 # Spec says we need to remove startAtOperationTime if
                 # one was passed in by user, thus we won't forward it
+              elsif @start_after
+                # The spec says to set `resumeAfter` to the `startAfter` token and not to send
+                # either `startAfter` or `startAtOperationTime`.
+                @resume_token = @start_after
               elsif start_at_operation_time_supported? && @start_at_operation_time
                 # It is crucial to check @start_at_operation_time_supported
                 # here - we may have switched to an older server that
@@ -309,6 +325,10 @@ module Mongo
                 raise Mongo::Error::MissingResumeToken
               end
             else
+              if @start_after
+                doc[:startAfter] = @start_after
+              end
+
               if options[:start_at_operation_time]
                 doc[:startAtOperationTime] = time_to_bson_timestamp(
                   options[:start_at_operation_time])