mongo 2.11.2 → 2.13.0.beta1

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/sdam_flow.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -58,74 +58,33 @@ class Mongo::Cluster
     def update_server_descriptions
       servers_list.each do |server|
         if server.address == updated_desc.address
-          changed = server.description != updated_desc
+          # SDAM flow must be run when topology version in the new description
+          # is equal to the current topology version, per the example in
+          # https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#what-is-the-purpose-of-topologyversion
+          unless updated_desc.topology_version_gte?(server.description)
+            return false
+          end
+
+          @server_description_changed = server.description != updated_desc
+
           # Always update server description, so that fields that do not
           # affect description equality comparisons but are part of the
           # description are updated.
           server.update_description(updated_desc)
           server.update_last_scan
-          # But return if there was a content difference between
-          # descriptions, and if there wasn't we'll skip the remainder of
-          # sdam flow
-          return changed
+
+          # If there was no content difference between descriptions, we
+          # still need to run sdam flow, but if the flow produces no change
+          # in topology we will omit sending events.
+          return true
         end
       end
       false
     end
 
     def server_description_changed
-      if updated_desc.me_mismatch? && updated_desc.primary? &&
-        (topology.unknown? || topology.replica_set?)
-      then
-        # When the driver receives a description claiming to be a primary,
-        # we are obligated by spec tests to add and remove hosts in that
-        # description even if it also has a me mismatch. The me mismatch
-        # scenario though presents a number of problems:
-        #
-        # 1. Effectively, the server's address changes, meaning we cannot
-        # update the description of the server whose description change we
-        # are processing (instead servers are added and removed), but we
-        # behave to an extent as if we are updating the description, which
-        # causes a bunch of awkwardness.
-        # 2. The server for which we are processing the response will be
-        # removed from topology, which may cause the current thread to terminate
-        # prior to running the entire sdam flow. To deal with this we separate
-        # the removal event publication from actually removing the server
-        # from topology, which again complicates the flow.
-
-        # Primary-with-me-mismatch response could be the first one we receive
-        # when the topology is still unknown. Change to RS without primary
-        # in this case.
-        if topology.unknown?
-          @topology = Topology::ReplicaSetNoPrimary.new(
-            topology.options.merge(replica_set_name: updated_desc.replica_set_name),
-            topology.monitoring, self)
-        end
-
-        servers = add_servers_from_desc(updated_desc)
-        # Spec tests require us to remove servers based on data in descrptions
-        # with me mismatches. The driver will be more resilient if it only
-        # removed servers from descriptions with matching mes.
-        remove_servers_not_in_desc(updated_desc)
-
-        servers.each do |server|
-          server.start_monitoring
-        end
-
-        # The rest of sdam flow assumes the server being removed is not the one
-        # whose description we are processing, and publishes description update
-        # event. Since we are removing the server whose response we are
-        # processing, do not publish description change event but mark it
-        # published (by assigning to @previous_desc).
-        do_remove(updated_desc.address.to_s)
-        @previous_desc = updated_desc
-
-        # We may have removed the current primary, check if there is a primary.
-        check_if_has_primary
-        # Publish topology change event.
-        commit_changes
-        disconnect_servers
-        return
+      @previous_server_descriptions = servers_list.map do |server|
+        [server.address.to_s, server.description]
       end
 
       unless update_server_descriptions
@@ -139,7 +98,16 @@ class Mongo::Cluster
 
       case topology
       when Topology::Single
-        # no changes ever
+        if topology.replica_set_name
+          if updated_desc.replica_set_name != topology.replica_set_name
+            log_warn(
+              "Server #{updated_desc.address.to_s} has an incorrect replica set name '#{updated_desc.replica_set_name}'; expected '#{topology.replica_set_name}'"
+            )
+            @updated_desc = ::Mongo::Server::Description.new(updated_desc.address,
+              {}, updated_desc.average_round_trip_time)
+            update_server_descriptions
+          end
+        end
       when Topology::Unknown
         if updated_desc.standalone?
           update_unknown_with_standalone
@@ -158,10 +126,16 @@ class Mongo::Cluster
         end
       when Topology::Sharded
         unless updated_desc.unknown? || updated_desc.mongos?
+          log_warn(
+            "Removing server #{updated_desc.address.to_s} because it is of the wrong type (#{updated_desc.server_type.to_s.upcase}) - expected SHARDED"
+          )
           remove
         end
       when Topology::ReplicaSetWithPrimary
         if updated_desc.standalone? || updated_desc.mongos?
+          log_warn(
+            "Removing server #{updated_desc.address.to_s} because it is of the wrong type (#{updated_desc.server_type.to_s.upcase}) - expected a replica set member"
+          )
           remove
           check_if_has_primary
         elsif updated_desc.primary?
@@ -173,6 +147,9 @@ class Mongo::Cluster
         end
       when Topology::ReplicaSetNoPrimary
         if updated_desc.standalone? || updated_desc.mongos?
+          log_warn(
+            "Removing server #{updated_desc.address.to_s} because it is of the wrong type (#{updated_desc.server_type.to_s.upcase}) - expected a replica set member"
+          )
           remove
         elsif updated_desc.primary?
           # Here we change topology type to RS with primary, however
@@ -233,8 +210,8 @@ class Mongo::Cluster
       if topology.replica_set_name != updated_desc.replica_set_name
         log_warn(
           "Removing server #{updated_desc.address.to_s} because it has an " +
-          "incorrect replica set name (#{updated_desc.replica_set_name}); " +
-          "current set name is #{topology.replica_set_name}"
+          "incorrect replica set name '#{updated_desc.replica_set_name}'; " +
+          "expected '#{topology.replica_set_name}'"
         )
         remove
         check_if_has_primary
@@ -440,6 +417,16 @@ class Mongo::Cluster
     end
 
     def publish_description_change_event
+      # This method may be invoked when server description definitely changed
+      # but prior to the topology getting updated. Therefore we check both
+      # server description changes and overall topology changes. When this
+      # method is called at the end of SDAM flow as part of "commit changes"
+      # step, server description change is incorporated into the topology
+      # change.
+      unless @server_description_changed || topology_effectively_changed?
+        return
+      end
+
       # updated_desc here may not be the description we received from
       # the server - in case of a stale primary, the server reported itself
       # as being a primary but updated_desc here will be unknown.
@@ -492,7 +479,7 @@ class Mongo::Cluster
       start_pool_if_data_bearing
 
       topology_changed_event_published = false
-      if topology.object_id != cluster.topology.object_id || @need_topology_changed_event
+      if !topology.equal?(cluster.topology) || @need_topology_changed_event
         # We are about to publish topology changed event.
         # Recreate the topology instance to get its server descriptions
         # up to date.
@@ -517,6 +504,10 @@ class Mongo::Cluster
         return
       end
 
+      unless topology_effectively_changed?
+        return
+      end
+
       # If we are here, there has been a change in the server descriptions
       # in our topology, but topology class has not changed.
       # Publish the topology changed event and recreate the topology to
@@ -584,5 +575,26 @@ class Mongo::Cluster
     def became_unknown?
       updated_desc.unknown? && !original_desc.unknown?
     end
+
+    # Returns whether topology meaningfully changed as a result of running
+    # SDAM flow.
+    #
+    # The spec defines topology equality through equality of topology types
+    # and server descriptions in each topology; this definition is not usable
+    # by us because our topology objects do not hold server descriptions and
+    # are instead "live". Thus we have to store the full list of server
+    # descriptions at the beginning of SDAM flow and compare them to the
+    # current ones.
+    def topology_effectively_changed?
+      unless topology.equal?(cluster.topology)
+        return true
+      end
+
+      server_descriptions = servers_list.map do |server|
+        [server.address.to_s, server.description]
+      end
+
+      @previous_server_descriptions != server_descriptions
+    end
   end
 end

data/lib/mongo/cluster/topology.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -62,12 +62,29 @@ module Mongo
       # @param [ Monitoring ] monitoring The monitoring.
       # @param [ Hash ] options The cluster options.
       #
+      # @option options [ true | false ] :direct_connection Whether to connect
+      #   directly to the specified seed, bypassing topology discovery. Exactly
+      #   one seed must be provided.
+      # @option options [ Symbol ] :connect Deprecated - use :direct_connection
+      #   option instead of this option. The connection method to use. This
+      #   forces the cluster to behave in the specified way instead of
+      #   auto-discovering. One of :direct, :replica_set, :sharded
+      # @option options [ Symbol ] :replica_set The name of the replica set to
+      #   connect to. Servers not in this replica set will be ignored.
+      #
       # @return [ ReplicaSet, Sharded, Single ] The topology.
       #
       # @since 2.0.0
       # @api private
       def initial(cluster, monitoring, options)
-        cls = if options.key?(:connect)
+        cls = if options[:direct_connection]
+          if options[:connect] && options[:connect] && options[:connect].to_sym != :direct
+            raise ArgumentError, "Conflicting topology options: direct_connection=true and connect=#{options[:connect]}"
+          end
+          Single
+        elsif options[:direct_connection] == false && options[:connect] && options[:connect].to_sym == :direct
+          raise ArgumentError, "Conflicting topology options: direct_connection=false and connect=#{options[:connect]}"
+        elsif options.key?(:connect)
           OPTIONS.fetch(options[:connect].to_sym)
         elsif options.key?(:replica_set) || options.key?(:replica_set_name)
           ReplicaSetNoPrimary

data/lib/mongo/cluster/topology/base.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/topology/no_replica_set_options.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/topology/replica_set_no_primary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/topology/replica_set_with_primary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/topology/sharded.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/topology/single.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster/topology/unknown.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/cluster_time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/collection.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -240,7 +240,7 @@ module Mongo
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
         server = next_primary(nil, session)
-        if (options[:collation] || options[Operation::COLLATION]) && !server.features.collation_enabled?
+        if (options[:collation] || options[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation
         end
 
@@ -249,7 +249,7 @@ module Mongo
                                 db_name: database.name,
                                 write_concern: write_concern,
                                 session: session
-                                }).execute(server)
+                                }).execute(server, client: client)
       end
     end
 
@@ -275,7 +275,7 @@ module Mongo
                               db_name: database.name,
                               write_concern: write_concern,
                               session: session
-                              }).execute(next_primary(nil, session))
+                              }).execute(next_primary(nil, session), client: client)
       end
     rescue Error::OperationFailure => ex
       raise ex unless ex.message =~ /ns not found/
@@ -293,6 +293,10 @@ module Mongo
     # @param [ Hash ] filter The filter to use in the find.
     # @param [ Hash ] options The options for the find.
     #
+    # @option options [ true, false ] :allow_disk_use When set to true, the
+    #   server can write temporary data to disk while executing the find
+    #   operation. This option is only available on MongoDB server versions
+    #   4.4 and newer.
     # @option options [ true, false ] :allow_partial_results Allows the query to get partial
     #   results if some shards are down.
     # @option options [ Integer ] :batch_size The number of documents returned in each batch
@@ -545,7 +549,7 @@ module Mongo
               :id_generator => client.options[:id_generator],
               :session => session,
               :txn_num => txn_num
-           ).execute(server)
+           ).execute(server, client: client)
         end
       end
     end
@@ -601,6 +605,8 @@ module Mongo
     #
     # @option options [ Hash ] :collation The collation to use.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -619,6 +625,8 @@ module Mongo
     #
     # @option options [ Hash ] :collation The collation to use.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -665,6 +673,8 @@ module Mongo
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -690,6 +700,8 @@ module Mongo
     # @option options [ Array ] :array_filters A set of filters specifying to which array elements
     #   an update should apply.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -715,6 +727,8 @@ module Mongo
     # @option options [ Array ] :array_filters A set of filters specifying to which array elements
     #   an update should apply.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -741,6 +755,8 @@ module Mongo
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
@@ -777,6 +793,8 @@ module Mongo
     # @option options [ Array ] :array_filters A set of filters specifying to which array elements
     #   an update should apply.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ BSON::Document ] The document.
     #
@@ -811,6 +829,8 @@ module Mongo
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
     # @option options [ Session ] :session The session to use.
+    # @option options [ Hash | String ] :hint The index to use for this operation.
+    #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
     #
     # @return [ BSON::Document ] The document.
     #

data/lib/mongo/collection/view.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -116,10 +116,14 @@ module Mongo
       # @param [ Hash ] filter The query filter.
       # @param [ Hash ] options The additional query options.
       #
+      # @option options [ true, false ] :allow_disk_use When set to true, the
+      #   server can write temporary data to disk while executing the find
+      #   operation. This option is only available on MongoDB server versions
+      #   4.4 and newer.
       # @option options :comment [ String ] Associate a comment with the query.
       # @option options :batch_size [ Integer ] The number of docs to return in
       #   each response from MongoDB.
-      # @option options :fields [ Hash ] The fields to include or exclude in
+      # @option options :projection [ Hash ] The fields to include or exclude in
       #   returned docs.
       # @option options :hint [ Hash ] Override default index selection and force
       #   MongoDB to use a specific index for the query.
@@ -197,7 +201,7 @@ module Mongo
       end
 
       def validate_collation!(server, coll)
-        if coll &&!server.features.collation_enabled?
+        if coll && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation.new
         end
       end