mongo 2.10.5 → 2.15.1

data/lib/mongo/server_selector/primary_preferred.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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 +23,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.
       #
@@ -40,13 +42,12 @@ module Mongo
         :primary_preferred
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ true ] true
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         true
       end
 
@@ -59,43 +60,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,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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 +23,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.
       #
@@ -40,13 +42,12 @@ module Mongo
         :secondary
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ true ] true
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         true
       end
 
@@ -59,38 +60,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,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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 +23,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.
       #
@@ -40,13 +42,12 @@ module Mongo
         :secondary_preferred
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk bit should be set on wire protocol messages.
       #   I.e. whether the operation can be performed on a secondary server.
       #
       # @return [ true ] true
-      #
-      # @since 2.0.0
-      def slave_ok?
+      # @api private
+      def secondary_ok?
         true
       end
 
@@ -59,40 +60,36 @@ 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
+        # Always send the read preference to mongos: DRIVERS-1642.
+        to_doc
       end
 
       private
@@ -100,16 +97,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/server_selector.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/server_selector/selectable'
+require 'mongo/server_selector/base'
 require 'mongo/server_selector/nearest'
 require 'mongo/server_selector/primary'
 require 'mongo/server_selector/primary_preferred'

data/lib/mongo/session/server_session.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.

data/lib/mongo/session/session_pool.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -113,9 +116,16 @@ module Mongo
       def end_sessions
         while !@queue.empty?
           server = ServerSelector.get(mode: :primary_preferred).select_server(@cluster)
-          Operation::Command.new(
-              :selector => {endSessions: @queue.shift(10_000).collect { |s| s.session_id }},
-              :db_name => Database::ADMIN).execute(server)
+          op = Operation::Command.new(
+            selector: {
+              endSessions: @queue.shift(10_000).map(&:session_id),
+            },
+            db_name: Database::ADMIN,
+          )
+          context = Operation::Context.new(options: {
+            server_api: server.options[:server_api],
+          })
+          op.execute(server, context: context)
         end
       rescue Mongo::Error, Error::AuthError
       end

data/lib/mongo/session.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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 +230,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.
@@ -364,7 +369,7 @@ module Mongo
     # @since 2.7.0
     def with_transaction(options=nil)
       # Non-configurable 120 second timeout for the entire operation
-      deadline = Time.now + 120
+      deadline = Utils.monotonic_time + 120
       transaction_in_progress = false
       loop do
         commit_options = {}
@@ -377,11 +382,12 @@ module Mongo
           rv = yield self
         rescue Exception => e
           if within_states?(STARTING_TRANSACTION_STATE, TRANSACTION_IN_PROGRESS_STATE)
+            log_warn("Aborting transaction due to #{e.class}: #{e}")
             abort_transaction
             transaction_in_progress = false
           end
 
-          if Time.now >= deadline
+          if Utils.monotonic_time >= deadline
             transaction_in_progress = false
             raise
           end
@@ -403,7 +409,7 @@ module Mongo
             return rv
           rescue Mongo::Error => e
             if e.label?('UnknownTransactionCommitResult')
-              if Time.now >= deadline ||
+              if Utils.monotonic_time >= deadline ||
                 e.is_a?(Error::OperationFailure) && e.max_time_ms_expired?
               then
                 transaction_in_progress = false
@@ -420,7 +426,7 @@ module Mongo
               commit_options[:write_concern] = wc_options.merge(w: :majority)
               retry
             elsif e.label?('TransientTransactionError')
-              if Time.now >= deadline
+              if Utils.monotonic_time >= deadline
                 transaction_in_progress = false
                 raise
               end
@@ -441,7 +447,7 @@ module Mongo
       true
     ensure
       if transaction_in_progress
-        log_warn('with_transaction callback altered with_transaction loop, aborting transaction')
+        log_warn('with_transaction callback broke out of with_transaction loop, aborting transaction')
         begin
           abort_transaction
         rescue Error::OperationFailure, Error::InvalidTransactionOperation
@@ -532,6 +538,7 @@ module Mongo
     #
     # @since 2.6.0
     def commit_transaction(options=nil)
+      QueryCache.clear
       check_if_ended!
       check_if_no_transaction!
 
@@ -578,7 +585,7 @@ module Mongo
               txn_num: txn_num,
               write_concern: write_concern,
             }
-            Operation::Command.new(spec).execute(server)
+            Operation::Command.new(spec).execute(server, context: Operation::Context.new(client: @client, session: self))
           end
         end
       ensure
@@ -600,6 +607,8 @@ module Mongo
     #
     # @since 2.6.0
     def abort_transaction
+      QueryCache.clear
+
       check_if_ended!
       check_if_no_transaction!
 
@@ -616,13 +625,18 @@ 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 },
-              db_name: 'admin',
-              session: self,
-              txn_num: txn_num
-            ).execute(server)
+            begin
+              Operation::Command.new(
+                selector: { abortTransaction: 1 },
+                db_name: 'admin',
+                session: self,
+                txn_num: txn_num
+              ).execute(server, context: Operation::Context.new(client: @client, session: self))
+            ensure
+              unpin
+            end
           end
         end
 
@@ -634,6 +648,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 +682,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.
@@ -697,7 +721,7 @@ module Mongo
     # The exception instance should already have all of the labels set on it
     # (both client- and server-side generated ones).
     #
-    # @param [ Error ] The exception instance to process.
+    # @param [ Error ] error The exception instance to process.
     #
     # @api private
     def unpin_maybe(error)
@@ -729,19 +753,6 @@ module Mongo
       end
     end
 
-    # Add this session's id to a command document.
-    #
-    # @example
-    #   session.add_id!(cmd)
-    #
-    # @return [ Hash, BSON::Document ] The command document.
-    #
-    # @since 2.5.0
-    # @api private
-    def add_id!(command)
-      command.merge!(lsid: session_id)
-    end
-
     # Add the startTransaction field to a command document if applicable.
     #
     # @example
@@ -894,21 +905,21 @@ module Mongo
       end
     end
 
-    # Validate the session.
+    # Validate the session for use by the specified client.
     #
-    # @example
-    #   session.validate!(cluster)
+    # The session must not be ended and must have been created by a client
+    # with the same cluster as the client that the session is to be used with.
     #
-    # @param [ Cluster ] cluster The cluster the session is attempted to be used with.
+    # @param [ Client ] client The client the session is to be used with.
     #
-    # @return [ nil ] nil if the session is valid.
+    # @return [ Session ] self, if the session is valid.
     #
-    # @raise [ Mongo::Error::InvalidSession ] Raise error if the session is not valid.
+    # @raise [ Mongo::Error::InvalidSession ] Exception raised if the session is not valid.
     #
     # @since 2.5.0
     # @api private
-    def validate!(cluster)
-      check_matching_cluster!(cluster)
+    def validate!(client)
+      check_matching_cluster!(client)
       check_if_ended!
       self
     end
@@ -1054,8 +1065,8 @@ module Mongo
       raise Mongo::Error::InvalidSession.new(SESSION_ENDED_ERROR_MSG) if ended?
     end
 
-    def check_matching_cluster!(cluster)
-      if @client.cluster != cluster
+    def check_matching_cluster!(client)
+      if @client.cluster != client.cluster
         raise Mongo::Error::InvalidSession.new(MISMATCHED_CLUSTER_ERROR_MSG)
       end
     end

data/lib/mongo/socket/ocsp_cache.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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
+  class Socket
+
+    # This module caches OCSP responses for their indicated validity time.
+    #
+    # The key is the CertificateId used for the OCSP request.
+    # The value is the SingleResponse on Ruby 2.4+, or the OpenStruct
+    # emulation of it on Ruby 2.3.
+    #
+    # @api private
+    module OcspCache
+      module_function def set(cert_id, response)
+        delete(cert_id)
+        responses << response
+      end
+
+      # Retrieves a cached SingleResponse for the specified CertificateId.
+      #
+      # This method may return expired responses if they are revoked.
+      # Such responses were valid when they were first received.
+      #
+      # This method may also return responses that are valid but that may
+      # expire by the time caller uses them. The caller should not perform
+      # update time checks on the returned response.
+      #
+      # @return [ OpenSSL::OCSP::SingleResponse | OpenStruct ] The previously
+      #   retrieved response.
+      module_function def get(cert_id)
+        resp = responses.detect do |resp|
+          resp.certid.cmp(cert_id)
+        end
+        if resp
+          # Only expire responses with good status.
+          # Once a certificate is revoked, it should stay revoked forever,
+          # hence we should be able to cache revoked responses indefinitely.
+          if resp.cert_status == OpenSSL::OCSP::V_CERTSTATUS_GOOD &&
+            resp.next_update < Time.now
+          then
+            responses.delete(resp)
+            resp = nil
+          end
+        end
+
+        # If we have connected to a server and cached the OCSP response for it,
+        # and then never connect to that server again, the cached OCSP response
+        # is going to remain in memory indefinitely. Periodically remove all
+        # expired OCSP responses, not just the ones matching the certificate id
+        # we are querying by.
+        if rand < 0.01
+          responses.delete_if do |resp|
+            resp.next_update < Time.now
+          end
+        end
+
+        resp
+      end
+
+      module_function def delete(cert_id)
+        responses.delete_if do |resp|
+          resp.certid.cmp(cert_id)
+        end
+      end
+
+      # Clears the driver's OCSP response cache.
+      #
+      # @note Use Mongo.clear_ocsp_cache from applications instead of invoking
+      #   this method directly.
+      module_function def clear
+        responses.replace([])
+      end
+
+      private
+
+      LOCK = Mutex.new
+
+      module_function def responses
+        LOCK.synchronize do
+          @responses ||= []
+        end
+      end
+    end
+  end
+end