mongo 2.12.1 → 2.13.0

data/lib/mongo/operation/shared/causal_consistency_supported.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.
@@ -33,8 +33,8 @@ module Mongo
       # In order for the override to work correctly the
       # CausalConsistencySupported module must be included after
       # SessionsSupported module in target classes.
-      def apply_causal_consistency!(selector, server)
-        apply_causal_consistency_if_possible(selector, server)
+      def apply_causal_consistency!(selector, connection)
+        apply_causal_consistency_if_possible(selector, connection)
       end
     end
   end

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

@@ -0,0 +1,56 @@
+# 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 Operation
+    module CollectionsInfoOrListCollections
+      include PolymorphicLookup
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server, client: nil)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      # @param [ Mongo::Client ] client The client that will be used to
+      #   perform auto-encryption if it is necessary to encrypt the command
+      #   being executed (optional).
+      #
+      # @return [ Mongo::Operation::CollectionsInfo::Result,
+      #           Mongo::Operation::ListCollections::Result ] The operation result.
+      def execute(server, client:)
+        server.with_connection do |connection|
+          operation = final_operation(connection)
+          operation.execute(connection, client: client)
+        end
+      end
+
+      private
+
+      def final_operation(connection)
+         op_class = if connection.features.list_collections_enabled?
+          if connection.features.op_msg_enabled?
+            ListCollections::OpMsg
+          else
+            ListCollections::Command
+          end
+        else
+          CollectionsInfo::Command
+        end
+
+        op_class.new(spec)
+      end
+    end
+  end
+end

data/lib/mongo/operation/shared/executable.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.
@@ -22,21 +22,27 @@ module Mongo
 
       include ResponseHandling
 
-      def do_execute(server, client, options = {})
+      def do_execute(connection, client, options = {})
         unpin_maybe(session) do
-          add_error_labels do
-            add_server_diagnostics(server) do
-              get_result(server, client, options).tap do |result|
-                process_result(result, server)
+          add_error_labels(client, connection, session) do
+            add_server_diagnostics(connection) do
+              get_result(connection, client, options).tap do |result|
+                process_result(result, connection)
               end
             end
           end
         end
       end
 
-      def execute(server, client:, options: {})
-        do_execute(server, client, options).tap do |result|
-          validate_result(result, server)
+      def execute(connection, client:, options: {})
+        if Lint.enabled?
+          unless connection.is_a?(Mongo::Server::Connection)
+            raise Error::LintError, "Connection argument is of wrong type: #{connection}"
+          end
+        end
+
+        do_execute(connection, client, options).tap do |result|
+          validate_result(result, client, connection)
         end
       end
 
@@ -46,41 +52,53 @@ module Mongo
         Result
       end
 
-      def get_result(server, client, options = {})
-        result_class.new(dispatch_message(server, client, options))
+      def get_result(connection, client, options = {})
+        result_class.new(*dispatch_message(connection, client, options))
       end
 
       # Returns a Protocol::Message or nil as reply.
-      def dispatch_message(server, client, options = {})
-        server.with_connection do |connection|
-          message = build_message(server)
-          message = message.maybe_encrypt(server, client)
-          connection.dispatch([ message ], operation_id, client, options)
-        end
+      def dispatch_message(connection, client, options = {})
+        message = build_message(connection)
+        message = message.maybe_encrypt(connection, client)
+        reply = connection.dispatch([ message ], operation_id, client, options)
+        [reply, connection.description]
       end
 
-      def build_message(server)
-        message(server)
+      def build_message(connection)
+        message(connection)
       end
 
-      def process_result(result, server)
-        server.update_cluster_time(result)
+      def process_result(result, connection)
+        connection.server.update_cluster_time(result)
+
+        process_result_for_sdam(result, connection)
+
+        if session
+          session.process(result)
+        end
+
+        result
+      end
 
-        if result.not_master? || result.node_recovering?
+      def process_result_for_sdam(result, connection)
+        if (result.not_master? || result.node_recovering?) &&
+          connection.generation >= connection.server.pool.generation
+        then
           if result.node_shutting_down?
             keep_pool = false
           else
             # Max wire version needs to be examined while the server is known
-            keep_pool = server.description.server_version_gte?('4.2')
+            keep_pool = connection.description.server_version_gte?('4.2')
           end
 
-          server.unknown!(keep_connection_pool: keep_pool)
+          connection.server.unknown!(
+            keep_connection_pool: keep_pool,
+            generation: connection.generation,
+            topology_version: result.topology_version,
+          )
 
-          server.scan_semaphore.signal
+          connection.server.scan_semaphore.signal
         end
-
-        session.process(result) if session
-        result
       end
     end
   end

data/lib/mongo/operation/shared/executable_no_validate.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.
@@ -21,8 +21,8 @@ module Mongo
     # @api private
     module ExecutableNoValidate
 
-      def execute(server, client:)
-        do_execute(server, client)
+      def execute(connection, client:)
+        do_execute(connection, client)
       end
     end
   end

data/lib/mongo/operation/shared/executable_transaction_label.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/operation/shared/idable.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/operation/shared/limited.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.
@@ -22,7 +22,15 @@ module Mongo
 
       private
 
-      def options(server = nil)
+      # Get the options for executing the operation on a particular connection.
+      #
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
+      #
+      # @return [ Hash ] The options.
+      #
+      # @since 2.0.0
+      def options(connection)
         super.merge(limit: -1)
       end
     end

data/lib/mongo/operation/shared/object_id_generator.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/operation/shared/op_msg_or_command.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.
@@ -23,14 +23,16 @@ module Mongo
       include PolymorphicLookup
 
       def execute(server, client:, options: {})
-        operation = final_operation(server)
-        operation.execute(server, client: client, options: options)
+        server.with_connection do |connection|
+          operation = final_operation(connection)
+          operation.execute(connection, client: client, options: options)
+        end
       end
 
       private
 
-      def final_operation(server)
-        cls = if server.features.op_msg_enabled?
+      def final_operation(connection)
+        cls = if connection.features.op_msg_enabled?
           polymorphic_class(self.class.name, :OpMsg)
         else
           polymorphic_class(self.class.name, :Command)

data/lib/mongo/operation/shared/op_msg_or_find_command.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.
@@ -24,16 +24,18 @@ module Mongo
       include PolymorphicLookup
 
       def execute(server, client:)
-        operation = final_operation(server)
-        operation.execute(server, client: client)
+        server.with_connection do |connection|
+          operation = final_operation(connection)
+          operation.execute(connection, client: client)
+        end
       end
 
       private
 
-      def final_operation(server)
-        cls = if server.features.op_msg_enabled?
+      def final_operation(connection)
+        cls = if connection.features.op_msg_enabled?
           polymorphic_class(self.class.name, :OpMsg)
-        elsif server.features.find_command_enabled?
+        elsif connection.features.find_command_enabled?
           polymorphic_class(self.class.name, :Command)
         else
           polymorphic_class(self.class.name, :Legacy)

data/lib/mongo/operation/shared/op_msg_or_list_indexes_command.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.
@@ -24,16 +24,18 @@ module Mongo
       include PolymorphicLookup
 
       def execute(server, client:)
-        operation = final_operation(server)
-        operation.execute(server, client: client)
+        server.with_connection do |connection|
+          operation = final_operation(connection)
+          operation.execute(connection, client: client)
+        end
       end
 
       private
 
-      def final_operation(server)
-        cls = if server.features.op_msg_enabled?
+      def final_operation(connection)
+        cls = if connection.features.op_msg_enabled?
           polymorphic_class(self.class.name, :OpMsg)
-        elsif server.features.list_indexes_enabled?
+        elsif connection.features.list_indexes_enabled?
           polymorphic_class(self.class.name, :Command)
         else
           polymorphic_class(self.class.name, :Legacy)

data/lib/mongo/operation/shared/polymorphic_lookup.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/operation/shared/polymorphic_result.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/operation/shared/read_preference_supported.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.
@@ -27,32 +27,34 @@ module Mongo
 
       private
 
-      # Get the options for executing the operation on a particular server.
+      # Get the options for executing the operation on a particular connection.
       #
-      # @param [ Server ] server The server that the operation will be
-      #   executed on.
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
       #
       # @return [ Hash ] The options.
       #
       # @since 2.0.0
-      def options(server)
-        add_slave_ok_flag_maybe(super, server)
+      def options(connection)
+        add_slave_ok_flag_maybe(super, connection)
       end
 
       # Adds :slave_ok flag to options based on the read preference specified
-      # in the operation or implied by the topology that the server is a
-      # part of.
+      # 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, server)
+      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 server.standalone?
+          if connection.description.standalone?
             # Read preference is never sent to standalones.
             false
-          elsif server.cluster.single?
+          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.
@@ -72,9 +74,9 @@ module Mongo
         options
       end
 
-      def command(server)
+      def command(connection)
         sel = super
-        update_selector_for_read_pref(sel, server)
+        update_selector_for_read_pref(sel, connection)
       end
 
       # Adds $readPreference field to the command document.
@@ -89,11 +91,12 @@ module Mongo
       # $readPreference is not sent to pre-OP_MSG replica set members.
       #
       # @param [ Hash ] sel Existing command document.
-      # @param [ Server ] server The server that the command is to be sent to.
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
       #
       # @return [ Hash ] New command document to send to the server.
-      def update_selector_for_read_pref(sel, server)
-        if read && server.mongos? && read_pref = read.to_mongos
+      def update_selector_for_read_pref(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)

data/lib/mongo/operation/shared/response_handling.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.
@@ -22,10 +22,10 @@ module Mongo
 
       private
 
-      def validate_result(result, server)
+      def validate_result(result, client, connection)
         unpin_maybe(session) do
-          add_error_labels do
-            add_server_diagnostics(server) do
+          add_error_labels(client, connection, session) do
+            add_server_diagnostics(connection) do
               result.validate!
             end
           end
@@ -38,7 +38,7 @@ module Mongo
       # and server-side errors (Error::OperationFailure); it does not
       # handle server selection errors (Error::NoServerAvailable), for which
       # labels are added in the server selection code.
-      def add_error_labels
+      def add_error_labels(client, connection, session)
         begin
           yield
         rescue Mongo::Error::SocketError => e
@@ -48,6 +48,12 @@ module Mongo
           if session && session.committing_transaction?
             e.add_label('UnknownTransactionCommitResult')
           end
+
+          maybe_add_retryable_write_error_label!(e, connection, client, session)
+
+          raise e
+        rescue Mongo::Error::SocketTimeoutError => e
+          maybe_add_retryable_write_error_label!(e, connection, client, session)
           raise e
         rescue Mongo::Error::OperationFailure => e
           if session && session.committing_transaction?
@@ -57,6 +63,9 @@ module Mongo
               e.add_label('UnknownTransactionCommitResult')
             end
           end
+
+          maybe_add_retryable_write_error_label!(e, connection, client, session)
+
           raise e
         end
       end
@@ -83,12 +92,78 @@ module Mongo
       #
       # This method is intended to add server address information to exceptions
       # raised during execution of operations on servers.
-      def add_server_diagnostics(server)
+      def add_server_diagnostics(connection)
         yield
-      rescue Mongo::Error, Mongo::Error::AuthError => e
-        e.add_note("on #{server.address.seed}")
+      rescue Error::SocketError, Error::SocketTimeoutError
+        # Diagnostics should have already been added by the connection code,
+        # do not add them again.
+        raise
+      rescue Error, Error::AuthError => e
+        e.add_note("on #{connection.address.seed}")
+        e.generation = connection.generation
         raise e
       end
+
+      private
+
+      # A method that will add the RetryableWriteError label to an error if
+      # any of the following conditions are true:
+      #
+      # The error meets the criteria for a retryable error (i.e. has one
+      #   of the retryable error codes or error messages)
+      #
+      # AND the server does not support adding the RetryableWriteError label OR
+      #   the error is a network error (i.e. the driver must add the label)
+      #
+      # AND the error occured during a commitTransaction or abortTransaction
+      #   OR the error occured during a write outside of a transaction on a
+      #   client that has retry writes enabled.
+      #
+      # If these conditions are met, the original error will be mutated.
+      # If they're not met, the error will not be changed.
+      #
+      # @param [ Mongo::Error ] error The error to which to add the label.
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Client | nil ] client The client that is performing
+      #   the operation.
+      # @param [ Mongo::Session ] session The operation's session.
+      #
+      # @note The client argument is optional because some operations, such as
+      #   end_session, do not pass the client as an argument to the execute
+      #   method.
+      def maybe_add_retryable_write_error_label!(error, connection, client, session)
+        in_transaction = session && session.in_transaction?
+        committing_transaction = in_transaction && session.committing_transaction?
+        aborting_transaction = in_transaction && session.aborting_transaction?
+        modern_retry_writes = client && client.options[:retry_writes]
+        legacy_retry_writes = client && !client.options[:retry_writes] &&
+          client.max_write_retries > 0
+
+        # An operation is retryable if it meets one of the following criteria:
+        # - It is a commitTransaction or abortTransaction
+        # - It does not occur during a transaction and the client has enabled
+        #   modern or legacy writes
+        #
+        # Note: any write operation within a transaction (excepting commit and
+        # abort is NOT a retryable operation)
+        retryable_operation = committing_transaction || aborting_transaction ||
+          (!in_transaction && (modern_retry_writes || legacy_retry_writes))
+
+        # An operation should add the RetryableWriteError label if one of the
+        # following conditions is met:
+        # - The server does not support adding the RetryableWriteError label
+        # - The error is a network error
+        should_add_error_label =
+          !connection.description.features.retryable_write_error_label_enabled? ||
+          error.write_concern_error_label?('RetryableWriteError') ||
+          error.is_a?(Mongo::Error::SocketError) ||
+          error.is_a?(Mongo::Error::SocketTimeoutError)
+
+        if retryable_operation && should_add_error_label && error.write_retryable?
+          error.add_label('RetryableWriteError')
+        end
+      end
     end
   end
 end