mongo 2.13.2 → 2.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1730c9274095cd8113fe9ac6d8f48b82ea3228aeb0b327988ab580105c745e3
-  data.tar.gz: d8a224877facc2e078dceb63c01eb9351f558ec9ea8a42b9264b909a77855d56
+  metadata.gz: 41f37eb33cbd1ebf2c916187b4610eefd895885042eeb3949882ce0a8c4ed069
+  data.tar.gz: db734108633f8b5988eaa15de33165182233ba5064f0b805298747256fb578b1
 SHA512:
-  metadata.gz: 93e0f291aa4e52e81decda048473b8330eac80c17251cde83fb66592800d066d14010142893fabb00d896cdf409aa0bc7dd25feba3ca27b443d94cd44a6542e6
-  data.tar.gz: 6e19b5c2a3f846ae7ffb0feab92b92bbfb0d88d21536d8e66eaccfc63f3dc8236cf7672b6aa23e9d51696135138529819f7fd3fff122c4d1608f8bf6081086b8
+  metadata.gz: 27c0c7ca84b6b7983767eb652f6aa5968362d8b42a4adf3eab3ee4a11fe4e74d36096b636436ac5075b31207470a67a8c5ecb00eac7f27a3889966ee30d84db9
+  data.tar.gz: 86c9fb09b3fb9c9512db2e7caed2f21ac2d53ee75f671d1cbcc92b89afa0d471cc1217552c3971ee9641f90b4c710692ab885c454f8701371726623e16114604

data/lib/mongo/collection.rb

@@ -573,6 +573,8 @@ module Mongo
     # @param [ Array<Hash> ] documents The documents to insert.
     # @param [ Hash ] options The insert options.
     #
+    # @option options [ true | false ] :ordered Whether the operations
+    #   should be executed in order.
     # @option options [ Session ] :session The session to use for the operation.
     #
     # @return [ Result ] The database response wrapper.

data/lib/mongo/database.rb

@@ -315,8 +315,20 @@ module Mongo
 
     # Get the Grid "filesystem" for this database.
     #
-    # @example Get the GridFS.
-    #   database.fs
+    # @param [ Hash ] options The GridFS options.
+    #
+    # @option options [ String ] :bucket_name The prefix for the files and chunks
+    #   collections.
+    # @option options [ Integer ] :chunk_size Override the default chunk
+    #   size.
+    # @option options [ String ] :fs_name The prefix for the files and chunks
+    #   collections.
+    # @option options [ String ] :read The read preference.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+    #   option.
+    # @option options [ Hash ] :write_concern The write concern options.
+    #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
     #
     # @return [ Grid::FSBucket ] The GridFS for the database.
     #

data/lib/mongo/grid/fs_bucket.rb

@@ -36,6 +36,43 @@ module Mongo
       # @since 2.1.0
       FILES_INDEX = { filename: 1, uploadDate: 1 }.freeze
 
+      # Create the GridFS.
+      #
+      # @example Create the GridFS.
+      #   Grid::FSBucket.new(database)
+      #
+      # @param [ Database ] database The database the files reside in.
+      # @param [ Hash ] options The GridFS options.
+      #
+      # @option options [ String ] :bucket_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ Integer ] :chunk_size Override the default chunk
+      #   size.
+      # @option options [ String ] :fs_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ String ] :read The read preference.
+      # @option options [ Session ] :session The session to use.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+      #
+      # @since 2.0.0
+      def initialize(database, options = {})
+        @database = database
+        @options = options.dup
+=begin WriteConcern object support
+        if @options[:write_concern].is_a?(WriteConcern::Base)
+          # Cache the instance so that we do not needlessly reconstruct it.
+          @write_concern = @options[:write_concern]
+          @options[:write_concern] = @write_concern.options
+        end
+=end
+        @options.freeze
+        @chunks_collection = database[chunks_name]
+        @files_collection = database[files_name]
+      end
+
       # @return [ Collection ] chunks_collection The chunks collection.
       #
       # @since 2.0.0
@@ -133,43 +170,6 @@ module Mongo
         file.id
       end
 
-      # Create the GridFS.
-      #
-      # @example Create the GridFS.
-      #   Grid::FSBucket.new(database)
-      #
-      # @param [ Database ] database The database the files reside in.
-      # @param [ Hash ] options The GridFS options.
-      #
-      # @option options [ String ] :fs_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ String ] :bucket_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ Integer ] :chunk_size Override the default chunk
-      #   size.
-      # @option options [ String ] :read The read preference.
-      # @option options [ Session ] :session The session to use.
-      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
-      #   option.
-      # @option options [ Hash ] :write_concern The write concern options.
-      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
-      #
-      # @since 2.0.0
-      def initialize(database, options = {})
-        @database = database
-        @options = options.dup
-=begin WriteConcern object support
-        if @options[:write_concern].is_a?(WriteConcern::Base)
-          # Cache the instance so that we do not needlessly reconstruct it.
-          @write_concern = @options[:write_concern]
-          @options[:write_concern] = @write_concern.options
-        end
-=end
-        @options.freeze
-        @chunks_collection = database[chunks_name]
-        @files_collection = database[files_name]
-      end
-
       # Get the prefix for the GridFS
       #
       # @example Get the prefix.

data/lib/mongo/operation/parallel_scan/command.rb

@@ -37,8 +37,7 @@ module Mongo
               read_concern)
           end
           sel[:maxTimeMS] = max_time_ms if max_time_ms
-          update_selector_for_read_pref(sel, connection)
-          sel
+          add_read_preference_legacy(sel, connection)
         end
 
         def message(connection)

data/lib/mongo/operation/shared/read_preference_supported.rb

@@ -36,47 +36,44 @@ module Mongo
       #
       # @since 2.0.0
       def options(connection)
-        add_slave_ok_flag_maybe(super, connection)
+        options = super
+        if add_slave_ok_flag?(connection)
+          flags = options[:flags]&.dup || []
+          flags << :slave_ok
+          options = options.merge(flags: flags)
+        end
+        options
       end
 
-      # Adds :slave_ok flag to options based on the read preference specified
-      # in the operation or implied by the topology that the connection's
-      # server is a part of.
+      # Whether to add the :slave_ok flag to the request based on the
+      # read preference specified in the operation or implied by the topology
+      # that the connection's server is a part of.
       #
-      # @param [ Hash ] options The options calculated so far.
       # @param [ Server::Connection ] connection The connection that the
       #   operation will be executed on.
       #
-      # @return [ Hash ] The new options.
-      def add_slave_ok_flag_maybe(options, connection)
-        add_flag =
-          # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
-          if connection.description.standalone?
-            # Read preference is never sent to standalones.
-            false
-          elsif connection.server.cluster.single?
-            # In Single topology the driver forces primaryPreferred read
-            # preference mode (via the slave_ok flag, in case of old servers)
-            # so that the query is satisfied.
-            true
-          else
-            # In replica sets and sharded clusters, read preference is passed
-            # to the server if one is specified by the application, and there
-            # is no default.
-            read && read.slave_ok?
-          end
-
-        if add_flag
-          options= options.dup
-          (options[:flags] ||= []) << :slave_ok
+      # @return [ true | false ] Whether the :slave_ok flag should be added.
+      def add_slave_ok_flag?(connection)
+        # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
+        if connection.description.standalone?
+          # Read preference is never sent to standalones.
+          false
+        elsif connection.server.cluster.single?
+          # In Single topology the driver forces primaryPreferred read
+          # preference mode (via the slave_ok flag, in case of old servers)
+          # so that the query is satisfied.
+          true
+        else
+          # In replica sets and sharded clusters, read preference is passed
+          # to the server if one is specified by the application, and there
+          # is no default.
+          read && read.slave_ok? || false
         end
-
-        options
       end
 
       def command(connection)
         sel = super
-        update_selector_for_read_pref(sel, connection)
+        add_read_preference_legacy(sel, connection)
       end
 
       # Adds $readPreference field to the command document.
@@ -95,14 +92,19 @@ module Mongo
       #   operation will be executed on.
       #
       # @return [ Hash ] New command document to send to the server.
-      def update_selector_for_read_pref(sel, connection)
+      def add_read_preference_legacy(sel, connection)
         if read && connection.description.mongos? && read_pref = read.to_mongos
-          Mongo::Lint.validate_camel_case_read_preference(read_pref)
-          sel = sel[:$query] ? sel : {:$query => sel}
-          sel = sel.merge(:$readPreference => read_pref)
-        else
-          sel
+          # If the read preference contains only mode and mode is secondary
+          # preferred and we are sending to a pre-OP_MSG server, this read
+          # preference is indicated by the :slave_ok wire protocol flag
+          # and $readPreference command parameter isn't sent.
+          if read_pref != {mode: 'secondaryPreferred'}
+            Mongo::Lint.validate_camel_case_read_preference(read_pref)
+            sel = sel[:$query] ? sel : {:$query => sel}
+            sel = sel.merge(:$readPreference => read_pref)
+          end
         end
+        sel
       end
     end
   end

data/lib/mongo/operation/shared/sessions_supported.rb

@@ -170,9 +170,10 @@ module Mongo
         elsif connection.description.mongos?
           # When server is a mongos:
           # - $readPreference is never sent when mode is 'primary'
-          # - When mode is 'secondaryPreferred' $readPreference is only sent
-          #   when a non-mode field (i.e. tag_sets) is present
           # - Otherwise $readPreference is sent
+          # When mode is 'secondaryPreferred' $readPreference is currently
+          # required to only be sent when a non-mode field (i.e. tag_sets)
+          # is present, but this causes wrong behavior (DRIVERS-1642).
           if read
             doc = read.to_mongos
             if doc

data/lib/mongo/protocol/msg.rb

@@ -43,8 +43,8 @@ module Mongo
       #   Msg.new([:more_to_come], {}, { ismaster: 1 },
       #           { type: 1, payload: { identifier: 'documents', sequence: [..] } })
       #
-      # @param [ Array<Symbol> ] flags The flag bits. Current supported values
-      #   are :more_to_come and :checksum_present.
+      # @param [ Array<Symbol> ] flags The flag bits. Currently supported
+      #   values are :more_to_come and :checksum_present.
       # @param [ Hash ] options The options.
       # @param [ BSON::Document, Hash ] main_document The document that will
       #   become the payload type 0 section. Can contain global args as they

data/lib/mongo/protocol/query.rb

@@ -46,18 +46,18 @@ module Mongo
       # @example Find all user ids.
       #   Query.new('xgen', 'users', {}, :fields => {:id => 1})
       #
-      # @param database [String, Symbol] The database to query.
-      # @param collection [String, Symbol] The collection to query.
-      # @param selector [Hash] The query selector.
-      # @param options [Hash] The additional query options.
+      # @param [ String, Symbol ] database The database to query.
+      # @param [ String, Symbol ] collection The collection to query.
+      # @param [ Hash ] selector The query selector.
+      # @param [ Hash ] options The additional query options.
       #
-      # @option options :project [Hash] The projection.
-      # @option options :skip [Integer] The number of documents to skip.
-      # @option options :limit [Integer] The number of documents to return.
-      # @option options :flags [Array] The flags for the query message.
-      #
-      #   Supported flags: +:tailable_cursor+, +:slave_ok+, +:oplog_replay+,
-      #   +:no_cursor_timeout+, +:await_data+, +:exhaust+, +:partial+
+      # @option options [ Array<Symbol> ] :flags The flag bits.
+      #   Currently supported values are :await_data, :exhaust,
+      #   :no_cursor_timeout, :oplog_replay, :partial, :slave_ok,
+      #   :tailable_cursor.
+      # @option options [ Integer ] :limit The number of documents to return.
+      # @option options [ Hash ] :project The projection.
+      # @option options [ Integer ] :skip The number of documents to skip.
       def initialize(database, collection, selector, options = {})
         @database = database
         @namespace = "#{database}.#{collection}"

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -86,13 +86,8 @@ module Mongo
       #
       # @since 2.0.0
       def to_mongos
-        if tag_sets.empty? && max_staleness.nil? && hedge.nil?
-          # The server preference is not sent to mongos as part of the query
-          # selector if there are no tag sets, for maximum backwards compatibility.
-          nil
-        else
-          to_doc
-        end
+        # Always send the read preference to mongos: DRIVERS-1642.
+        to_doc
       end
 
       private

data/lib/mongo/version.rb

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

data/spec/integration/sdam_error_handling_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'SDAM error handling' do
-  clean_slate_for_all
+  clean_slate
 
   after do
     # Close all clients after every test to avoid leaking expectations into

data/spec/integration/sdam_events_spec.rb

@@ -67,10 +67,8 @@ describe 'SDAM events' do
         started_events.length.should <= 10
 
         succeeded_events = subscriber.select_succeeded_events(Mongo::Monitoring::Event::ServerHeartbeatSucceeded)
-        # Since we gracefully close the client, we expect each heartbeat
-        # to complete.
         started_events.length.should > 1
-        (succeeded_events.length-1..succeeded_events.length).should include(started_events.length)
+        (succeeded_events.length..succeeded_events.length+1).should include(started_events.length)
       end
     end
 
@@ -109,9 +107,9 @@ describe 'SDAM events' do
         # There may be in-flight ismasters that don't complete, both
         # regular and awaited.
         started_awaited.length.should > 1
-        (succeeded_awaited.length-1..succeeded_awaited.length).should include(started_awaited.length)
+        (succeeded_awaited.length..succeeded_awaited.length+1).should include(started_awaited.length)
         started_regular.length.should > 1
-        (succeeded_regular.length-1..succeeded_regular.length).should include(started_regular.length)
+        (succeeded_regular.length..succeeded_regular.length+1).should include(started_regular.length)
       end
     end
   end

data/spec/integration/secondary_reads_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe 'Secondary reads' do
+  before do
+    root_authorized_client.use('sr')['secondary_reads'].drop
+    root_authorized_client.use('sr')['secondary_reads'].insert_one(test: 1)
+  end
+
+  shared_examples 'performs reads as per read preference' do
+
+    %i(primary primary_preferred).each do |mode|
+
+      context mode.inspect do
+
+        let(:client) do
+          root_authorized_client.with(read: {mode: mode}).use('sr')
+        end
+
+        it 'reads from primary' do
+          start_stats = get_read_counters
+
+          30.times do
+            client['secondary_reads'].find.to_a
+          end
+
+          end_stats = get_read_counters
+
+          end_stats[:secondary].should be_within(10).of(start_stats[:secondary])
+          end_stats[:primary].should >= start_stats[:primary] + 30
+        end
+      end
+    end
+
+    %i(secondary secondary_preferred).each do |mode|
+
+      context mode.inspect do
+        let(:client) do
+          root_authorized_client.with(read: {mode: mode}).use('sr')
+        end
+
+        it 'reads from secondaries' do
+          start_stats = get_read_counters
+
+          30.times do
+            client['secondary_reads'].find.to_a
+          end
+
+          end_stats = get_read_counters
+
+          end_stats[:primary].should be_within(10).of(start_stats[:primary])
+          end_stats[:secondary].should >= start_stats[:secondary] + 30
+        end
+      end
+    end
+  end
+
+  context 'replica set' do
+    require_topology :replica_set
+
+    include_examples 'performs reads as per read preference'
+  end
+
+  context 'sharded cluster' do
+    require_topology :sharded
+
+    include_examples 'performs reads as per read preference'
+  end
+
+  def get_read_counters
+    client = ClientRegistry.instance.global_client('root_authorized')
+    addresses = []
+    if client.cluster.sharded?
+      doc = client.use('admin').command(listShards: 1).documents.first
+      doc['shards'].each do |shard|
+        addresses += shard['host'].split('/').last.split(',')
+      end
+    else
+      client.cluster.servers.each do |server|
+        next unless server.primary? || server.secondary?
+        addresses << server.address.seed
+      end
+    end
+    stats = Hash.new(0)
+    addresses.each do |address|
+      ClientRegistry.instance.new_local_client(
+        [address],
+        SpecConfig.instance.all_test_options.merge(connect: :direct),
+      ) do |c|
+        server = c.cluster.servers.first
+        next unless server.primary? || server.secondary?
+        stat = c.command(serverStatus: 1).documents.first
+        queries = stat['opcounters']['query']
+        if server.primary?
+          stats[:primary] += queries
+        else
+          stats[:secondary] += queries
+        end
+      end
+    end
+    stats
+  end
+end