mongo 2.12.1 → 2.13.0

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,8 +19,7 @@ module Mongo
     #   of candidates.
     #
     # @since 2.0.0
-    class Nearest
-      include Selectable
+    class Nearest < Base
 
       # Name of the this read preference in the server's format.
       #
@@ -58,38 +57,44 @@ 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
 
       # Select the near servers taking into account any defined tag sets and
       #   local threshold between the nearest server and other servers.
       #
-      # @example Select nearest servers given a list of candidates.
-      #   preference = Mongo::ServerSelector::Nearest.new
-      #   preference.select_server(cluster)
-      #
       # @return [ Array ] The nearest servers from the list of candidates.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         matching_servers = filter_stale_servers(candidates, primary(candidates).first)
         matching_servers = match_tag_sets(matching_servers) unless tag_sets.empty?
         near_servers(matching_servers)

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,8 +20,7 @@ module Mongo
     #   of candidates.
     #
     # @since 2.0.0
-    class Primary
-      include Selectable
+    class Primary < Base
 
       # Name of the this read preference in the server's format.
       #
@@ -59,48 +58,45 @@ 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
-      #
-      # @return [ nil ] nil
+      # Whether the hedge option is allowed to be defined for this server preference.
       #
-      # @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.
-      #
-      # @example Convert this server preference definition into a format
-      #   for a server.
-      #   preference = Mongo::ServerSelector::Primary.new
-      #   preference.to_doc
+      #   for sending to a MongoDB server (i.e., as a command field).
       #
-      # @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
 
       # Select the primary server from a list of candidates.
       #
-      # @example Select the primary server given a list of candidates.
-      #   preference = Mongo::ServerSelector::Primary.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] The primary server from the list of candidates.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         primary(candidates)
       end
 

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,8 +20,7 @@ module Mongo
     #   primary preferred, given a list of candidates.
     #
     # @since 2.0.0
-    class PrimaryPreferred
-      include Selectable
+    class PrimaryPreferred < Base
 
       # Name of the this read preference in the server's format.
       #
@@ -59,43 +58,51 @@ 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
 
       # Select servers taking into account any defined tag sets and
       #   local threshold, with the primary preferred.
       #
-      # @example Select servers given a list of candidates,
-      #   with the primary preferred.
-      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] A list of servers matching tag sets and acceptable
       #   latency with the primary preferred.
       #
       # @since 2.0.0
-      def select(candidates)
-        primary = primary(candidates)
-        secondaries = near_servers(secondaries(candidates))
-        primary.first ? primary : secondaries
+      def select_in_replica_set(candidates)
+        primaries = primary(candidates)
+        if primaries.first
+          primaries
+        else
+          near_servers(secondaries(candidates))
+        end
       end
 
       def max_staleness_allowed?

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,8 +20,7 @@ module Mongo
     #   of candidates.
     #
     # @since 2.0.0
-    class Secondary
-      include Selectable
+    class Secondary < Base
 
       # Name of the this read preference in the server's format.
       #
@@ -59,38 +58,44 @@ 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
 
       # Select the secondary servers taking into account any defined tag sets and
       #   local threshold between the nearest secondary and other secondaries.
       #
-      # @example Select secondary servers given a list of candidates.
-      #   preference = Mongo::ServerSelector::Secondary.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] The secondary servers from the list of candidates.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         near_servers(secondaries(candidates))
       end
 

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,8 +20,7 @@ module Mongo
     #   secondaries preferred, given a list of candidates.
     #
     # @since 2.0.0
-    class SecondaryPreferred
-      include Selectable
+    class SecondaryPreferred < Base
 
       # Name of the this read preference in the server's format.
       #
@@ -59,40 +58,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
@@ -100,16 +100,11 @@ module Mongo
       # Select servers taking into account any defined tag sets and
       #   local threshold, with secondaries.
       #
-      # @example Select servers given a list of candidates,
-      #   with secondaries preferred.
-      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
-      #   preference.select([candidate_1, candidate_2])
-      #
       # @return [ Array ] A list of servers matching tag sets and acceptable
       #   latency with secondaries preferred.
       #
       # @since 2.0.0
-      def select(candidates)
+      def select_in_replica_set(candidates)
         near_servers(secondaries(candidates)) + primary(candidates)
       end
 

data/lib/mongo/session.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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.
@@ -227,7 +227,9 @@ module Mongo
     # Error message describing that sessions are not supported by the server version.
     #
     # @since 2.5.0
+    # @deprecated
     SESSIONS_NOT_SUPPORTED = 'Sessions are not supported by the connected servers.'.freeze
+    # Note: SESSIONS_NOT_SUPPORTED is used by Mongoid - do not remove from driver.
 
     # The state of a session in which the last operation was not related to
     # any transaction or no operations have yet occurred.
@@ -616,6 +618,7 @@ module Mongo
 
       begin
         unless starting_transaction?
+          @aborting_transaction = true
           write_with_retry(self, txn_options[:write_concern], true) do |server, txn_num|
             Operation::Command.new(
               selector: { abortTransaction: 1 },
@@ -634,6 +637,8 @@ module Mongo
       rescue Exception
         @state = TRANSACTION_ABORTED_STATE
         raise
+      ensure
+        @aborting_transaction = false
       end
 
       # No official return value, but return true so that in interactive
@@ -666,6 +671,14 @@ module Mongo
       !!@committing_transaction
     end
 
+    # @return [ true | false ] Whether the session is currently aborting a
+    #   transaction.
+    #
+    # @api private
+    def aborting_transaction?
+      !!@aborting_transaction
+    end
+
     # Pins this session to the specified server, which should be a mongos.
     #
     # @param [ Server ] server The server to pin this session to.