mongo 2.12.4 → 2.13.0.beta1

data/lib/mongo/server_selector.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.
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/server_selector/base'
 require 'mongo/server_selector/selectable'
 require 'mongo/server_selector/nearest'
 require 'mongo/server_selector/primary'

data/lib/mongo/server_selector/base.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  module ServerSelector
+
+    # @api private
+    class Base
+      private
+
+      # Convert this server preference definition into a format appropriate
+      #   for sending to a MongoDB server (i.e., as a command field).
+      #
+      # @return [ Hash ] The server preference formatted as a command field value.
+      #
+      # @since 2.0.0
+      def full_doc
+        @full_doc ||= begin
+          preference = { :mode => self.class.const_get(:SERVER_FORMATTED_NAME) }
+          preference.update(tags: tag_sets) unless tag_sets.empty?
+          preference.update(maxStalenessSeconds: max_staleness) if max_staleness
+          preference.update(hedge: hedge) if hedge
+          preference
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/nearest.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.
@@ -19,7 +19,7 @@ module Mongo
     #   of candidates.
     #
     # @since 2.0.0
-    class Nearest
+    class Nearest < Base
       include Selectable
 
       # Name of the this read preference in the server's format.
@@ -58,24 +58,34 @@ module Mongo
         true
       end
 
-      # Convert this server preference definition into a format appropriate
-      #   for a mongos server.
+      # Whether the hedge option is allowed to be defined for this server preference.
       #
-      # @example Convert this server preference definition into a format
-      #   for mongos.
-      #   preference = Mongo::ServerSelector::Nearest.new
-      #   preference.to_mongos
+      # @return [ true ] true
+      def hedge_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for sending to a MongoDB server (i.e., as a command field).
       #
-      # @return [ Hash ] The server preference formatted for a mongos server.
+      # @return [ Hash ] The server preference formatted as a command field value.
       #
       # @since 2.0.0
-      def to_mongos
-        @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
-          preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-          preference)
+      def to_doc
+        full_doc
       end
-      alias :to_doc :to_mongos
+
+      # Convert this server preference definition into a value appropriate
+      #   for sending to a mongos.
+      #
+      # This method may return nil if the read preference should not be sent
+      # to a mongos.
+      #
+      # @return [ Hash | nil ] The server preference converted to a mongos
+      #   command field value.
+      #
+      # @since 2.0.0
+      alias :to_mongos :to_doc
 
       private
 

data/lib/mongo/server_selector/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.
@@ -20,7 +20,7 @@ module Mongo
     #   of candidates.
     #
     # @since 2.0.0
-    class Primary
+    class Primary < Base
       include Selectable
 
       # Name of the this read preference in the server's format.
@@ -59,34 +59,35 @@ module Mongo
         false
       end
 
-      # Convert this server preference definition into a format appropriate
-      #   for a mongos server.
-      #
-      # @example Convert this server preference definition into a format
-      #   for mongos.
-      #   preference = Mongo::ServerSelector::Primary.new
-      #   preference.to_mongos
+      # Whether the hedge option is allowed to be defined for this server preference.
       #
-      # @return [ nil ] nil
-      #
-      # @since 2.0.0
-      def to_mongos
-        nil
+      # @return [ false ] false
+      def hedge_allowed?
+        false
       end
 
       # Convert this server preference definition into a format appropriate
-      #   for a mongodb server.
+      #   for sending to a MongoDB server (i.e., as a command field).
       #
-      # @example Convert this server preference definition into a format
-      #   for a server.
-      #   preference = Mongo::ServerSelector::Primary.new
-      #   preference.to_doc
-      #
-      # @return [ Hash ] The server preference formatted for a mongodb server.
+      # @return [ Hash ] The server preference formatted as a command field value.
       #
       # @since 2.5.0
       def to_doc
-        @doc ||= { mode: SERVER_FORMATTED_NAME }
+        { mode: SERVER_FORMATTED_NAME }
+      end
+
+      # Convert this server preference definition into a value appropriate
+      #   for sending to a mongos.
+      #
+      # This method may return nil if the read preference should not be sent
+      # to a mongos.
+      #
+      # @return [ Hash | nil ] The server preference converted to a mongos
+      #   command field value.
+      #
+      # @since 2.0.0
+      def to_mongos
+        nil
       end
 
       private

data/lib/mongo/server_selector/primary_preferred.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.
@@ -20,7 +20,7 @@ module Mongo
     #   primary preferred, given a list of candidates.
     #
     # @since 2.0.0
-    class PrimaryPreferred
+    class PrimaryPreferred < Base
       include Selectable
 
       # Name of the this read preference in the server's format.
@@ -59,24 +59,34 @@ module Mongo
         true
       end
 
-      # Convert this server preference definition into a format appropriate
-      #   for a mongos server.
+      # Whether the hedge option is allowed to be defined for this server preference.
       #
-      # @example Convert this server preference definition into a format
-      #   for mongos.
-      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
-      #   preference.to_mongos
+      # @return [ true ] true
+      def hedge_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for sending to a MongoDB server (i.e., as a command field).
       #
-      # @return [ Hash ] The server preference formatted for a mongos server.
+      # @return [ Hash ] The server preference formatted as a command field value.
       #
       # @since 2.0.0
-      def to_mongos
-        @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
-          preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-          preference)
+      def to_doc
+        full_doc
       end
-      alias :to_doc :to_mongos
+
+      # Convert this server preference definition into a value appropriate
+      #   for sending to a mongos.
+      #
+      # This method may return nil if the read preference should not be sent
+      # to a mongos.
+      #
+      # @return [ Hash | nil ] The server preference converted to a mongos
+      #   command field value.
+      #
+      # @since 2.0.0
+      alias :to_mongos :to_doc
 
       private
 

data/lib/mongo/server_selector/secondary.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.
@@ -20,7 +20,7 @@ module Mongo
     #   of candidates.
     #
     # @since 2.0.0
-    class Secondary
+    class Secondary < Base
       include Selectable
 
       # Name of the this read preference in the server's format.
@@ -59,24 +59,34 @@ module Mongo
         true
       end
 
-      # Convert this server preference definition into a format appropriate
-      #   for a mongos server.
+      # Whether the hedge option is allowed to be defined for this server preference.
       #
-      # @example Convert this server preference definition into a format
-      #   for mongos.
-      #   preference = Mongo::ServerSelector::Secondary.new
-      #   preference.to_mongos
+      # @return [ true ] true
+      def hedge_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for sending to a MongoDB server (i.e., as a command field).
       #
-      # @return [ Hash ] The server preference formatted for a mongos server.
+      # @return [ Hash ] The server preference formatted as a command field value.
       #
       # @since 2.0.0
-      def to_mongos
-        @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
-          preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-          preference)
+      def to_doc
+        full_doc
       end
-      alias :to_doc :to_mongos
+
+      # Convert this server preference definition into a value appropriate
+      #   for sending to a mongos.
+      #
+      # This method may return nil if the read preference should not be sent
+      # to a mongos.
+      #
+      # @return [ Hash | nil ] The server preference converted to a mongos
+      #   command field value.
+      #
+      # @since 2.0.0
+      alias :to_mongos :to_doc
 
       private
 

data/lib/mongo/server_selector/secondary_preferred.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.
@@ -20,7 +20,7 @@ module Mongo
     #   secondaries preferred, given a list of candidates.
     #
     # @since 2.0.0
-    class SecondaryPreferred
+    class SecondaryPreferred < Base
       include Selectable
 
       # Name of the this read preference in the server's format.
@@ -59,40 +59,41 @@ module Mongo
         true
       end
 
-      # Convert this server preference definition into a format appropriate
-      #   for a mongos server.
-      # Note that the server preference is not sent to mongos as part of the query
-      #   selector if there are no tag sets, for maximum backwards compatibility.
+      # Whether the hedge option is allowed to be defined for this server preference.
       #
-      # @example Convert this server preference definition into a format
-      #   for mongos.
-      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
-      #   preference.to_mongos
+      # @return [ true ] true
+      def hedge_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for sending to a MongoDB server (i.e., as a command field).
       #
-      # @return [ Hash ] The server preference formatted for a mongos server.
+      # @return [ Hash ] The server preference formatted as a command field value.
       #
       # @since 2.0.0
-      def to_mongos
-        return nil if tag_sets.empty? && max_staleness.nil?
-        to_doc
+      def to_doc
+        full_doc
       end
 
-      # Convert this server preference definition into a format appropriate
-      #   for a server.
+      # Convert this server preference definition into a value appropriate
+      #   for sending to a mongos.
       #
-      # @example Convert this server preference definition into a format
-      #   for a server.
-      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
-      #   preference.to_doc
+      # This method may return nil if the read preference should not be sent
+      # to a mongos.
       #
-      # @return [ Hash ] The server preference formatted for a server.
+      # @return [ Hash | nil ] The server preference converted to a mongos
+      #   command field value.
       #
-      # @since 2.5.0
-      def to_doc
-        @doc ||= (preference = { mode: SERVER_FORMATTED_NAME }
-          preference.merge!({ tags: tag_sets }) unless tag_sets.empty?
-          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-          preference)
+      # @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
       end
 
       private

data/lib/mongo/server_selector/selectable.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.
@@ -36,6 +36,10 @@ module Mongo
       #   in seconds, that a secondary can suffer and still be eligible for a read.
       #   A value of -1 is treated identically to nil, which is to not
       #   have a maximum staleness.
+      # @option options [ Hash | nil ] hedge A Hash specifying whether to enable hedged
+      #   reads on the server. Hedged reads are not enabled by default. When
+      #   specifying this option, it must be in the format: { enabled: true },
+      #   where the value of the :enabled key is a boolean value.
       #
       # @raise [ Error::InvalidServerPreference ] If tag sets are specified
       #   but not allowed.
@@ -46,9 +50,11 @@ module Mongo
         if options[:max_staleness] == -1
           options.delete(:max_staleness)
         end
-        @options = options.freeze
-        @tag_sets = (options[:tag_sets] || []).freeze
+        @options = options
+        @tag_sets = options[:tag_sets] || []
         @max_staleness = options[:max_staleness]
+        @hedge = options[:hedge]
+
         validate!
       end
 
@@ -64,6 +70,10 @@ module Mongo
       # @since 2.4.0
       attr_reader :max_staleness
 
+      # @return [ Hash | nil ] hedge The document specifying whether to enable
+      #   hedged reads.
+      attr_reader :hedge
+
       # Check equality of two server selector.
       #
       # @example Check server selector equality.
@@ -75,9 +85,8 @@ module Mongo
       #
       # @since 2.0.0
       def ==(other)
-        name == other.name &&
-          tag_sets == other.tag_sets &&
-            max_staleness == other.max_staleness
+        name == other.name && hedge == other.hedge &&
+          max_staleness == other.max_staleness && tag_sets == other.tag_sets
       end
 
       # Inspect the server selector.
@@ -89,7 +98,7 @@ module Mongo
       #
       # @since 2.2.0
       def inspect
-        "#<#{self.class.name}:0x#{object_id} tag_sets=#{tag_sets.inspect} max_staleness=#{max_staleness.inspect}>"
+        "#<#{self.class.name}:0x#{object_id} tag_sets=#{tag_sets.inspect} max_staleness=#{max_staleness.inspect} hedge=#{hedge}>"
       end
 
       # Select a server from the specified cluster, taking into account
@@ -215,14 +224,6 @@ module Mongo
             # and we should take the first server here respecting the order
             server = servers.first
 
-            if cluster.topology.single? &&
-              cluster.topology.replica_set_name &&
-              cluster.topology.replica_set_name != server.description.replica_set_name
-            then
-              msg = "Cluster topology specifies replica set name #{cluster.topology.replica_set_name}, but the server has replica set name #{server.description.replica_set_name || '<nil>'}"
-              raise Error::NoServerAvailable.new(self, cluster, msg)
-            end
-
             if session && session.starting_transaction? && cluster.sharded?
               session.pin(server)
             end
@@ -445,6 +446,20 @@ module Mongo
         elsif @max_staleness && !max_staleness_allowed?
           raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::NO_MAX_STALENESS_SUPPORT)
         end
+
+        if @hedge
+          unless hedge_allowed?
+            raise Error::InvalidServerPreference.new(Error::InvalidServerPreference::NO_HEDGE_SUPPORT)
+          end
+
+          unless @hedge.is_a?(Hash) && @hedge.key?(:enabled) &&
+              [true, false].include?(@hedge[:enabled])
+            raise Error::InvalidServerPreference.new(
+              "`hedge` value (#{hedge}) is invalid - hedge must be a Hash in the " \
+              "format { enabled: true }"
+            )
+          end
+        end
       end
 
       def validate_max_staleness_support!(server)