mongo 2.14.1 → 2.15.0.alpha

data/lib/mongo/operation/context.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 2021 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
+
+    # Context for operations.
+    #
+    # Holds various objects needed to make decisions about operation execution
+    # in a single container, and provides facade methods for the contained
+    # objects.
+    #
+    # @api private
+    class Context
+      def initialize(client: nil, session: nil, options: nil)
+        if options
+          if client
+            raise ArgumentError, 'Client and options cannot both be specified'
+          end
+
+          if session
+            raise ArgumentError, 'Session and options cannot both be specified'
+          end
+        end
+
+        @client = client
+        @session = session
+        @options = options
+      end
+
+      attr_reader :client
+      attr_reader :session
+      attr_reader :options
+
+      def in_transaction?
+        session&.in_transaction? || false
+      end
+
+      def starting_transaction?
+        session&.starting_transaction? || false
+      end
+
+      def committing_transaction?
+        in_transaction? && session.committing_transaction?
+      end
+
+      def aborting_transaction?
+        in_transaction? && session.aborting_transaction?
+      end
+
+      def modern_retry_writes?
+        client && client.options[:retry_writes]
+      end
+
+      def legacy_retry_writes?
+        client && !client.options[:retry_writes] && client.max_write_retries > 0
+      end
+
+      def any_retry_writes?
+        modern_retry_writes? || legacy_retry_writes?
+      end
+
+      def server_api
+        if client
+          client.options[:server_api]
+        elsif options
+          options[:server_api]
+        end
+      end
+
+      def encrypt?
+        client&.encrypter&.encrypt? || false
+      end
+
+      def decrypt?
+        !!client&.encrypter
+      end
+
+      def encrypter
+        if client&.encrypter
+          client.encrypter
+        else
+          raise Error::InternalDriverError, 'Encrypter should only be accessed when encryption is to be performed'
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/indexes.rb

@@ -27,7 +27,21 @@ module Mongo
     # @since 2.0.0
     class Indexes
       include Specifiable
-      include OpMsgOrListIndexesCommand
+      include PolymorphicOperation
+      include PolymorphicLookup
+
+      private
+
+      def final_operation(connection)
+        cls = if connection.features.op_msg_enabled?
+          polymorphic_class(self.class.name, :OpMsg)
+        elsif connection.features.list_indexes_enabled?
+          polymorphic_class(self.class.name, :Command)
+        else
+          polymorphic_class(self.class.name, :Legacy)
+        end
+        cls.new(spec)
+      end
     end
   end
 end

data/lib/mongo/operation/insert/command.rb

@@ -32,9 +32,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector(connection)

data/lib/mongo/operation/insert/legacy.rb

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector

data/lib/mongo/operation/insert/op_msg.rb

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector(connection)

data/lib/mongo/operation/list_collections/result.rb

@@ -88,7 +88,10 @@ module Mongo
               code: parser.code,
               code_name: parser.code_name,
               labels: parser.labels,
-              wtimeout: parser.wtimeout)
+              wtimeout: parser.wtimeout,
+              document: parser.document,
+              server_message: parser.server_message,
+            )
           end
         end
 

data/lib/mongo/operation/parallel_scan/command.rb

@@ -37,7 +37,8 @@ module Mongo
               read_concern)
           end
           sel[:maxTimeMS] = max_time_ms if max_time_ms
-          add_read_preference_legacy(sel, connection)
+          update_selector_for_read_pref(sel, connection)
+          sel
         end
 
         def message(connection)

data/lib/mongo/operation/result.rb

@@ -332,6 +332,8 @@ module Mongo
           labels: parser.labels,
           wtimeout: parser.wtimeout,
           connection_description: connection_description,
+          document: parser.document,
+          server_message: parser.server_message,
         )
       end
 

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

@@ -23,11 +23,11 @@ module Mongo
 
       include ResponseHandling
 
-      def do_execute(connection, client, options = {})
+      def do_execute(connection, context, options = {})
         unpin_maybe(session) do
-          add_error_labels(client, connection, session) do
+          add_error_labels(connection, context) do
             add_server_diagnostics(connection) do
-              get_result(connection, client, options).tap do |result|
+              get_result(connection, context, options).tap do |result|
                 process_result(result, connection)
               end
             end
@@ -35,15 +35,15 @@ module Mongo
         end
       end
 
-      def execute(connection, client:, options: {})
+      def execute(connection, context:, 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)
+        do_execute(connection, context, options).tap do |result|
+          validate_result(result, connection, context)
         end
       end
 
@@ -53,20 +53,30 @@ module Mongo
         Result
       end
 
-      def get_result(connection, client, options = {})
-        result_class.new(*dispatch_message(connection, client, options))
+      def get_result(connection, context, options = {})
+        result_class.new(*dispatch_message(connection, context, options))
       end
 
       # Returns a Protocol::Message or nil as reply.
-      def dispatch_message(connection, client, options = {})
-        message = build_message(connection)
-        message = message.maybe_encrypt(connection, client)
-        reply = connection.dispatch([ message ], operation_id, client, options)
+      def dispatch_message(connection, context, options = {})
+        message = build_message(connection, context)
+        message = message.maybe_encrypt(connection, context)
+        reply = connection.dispatch([ message ], context, options)
         [reply, connection.description]
       end
 
-      def build_message(connection)
-        message(connection)
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      def build_message(connection, context)
+        msg = message(connection)
+        if (server_api = context.server_api) &&
+          # Commands in a transaction do not allow API parameters.
+          !(context.in_transaction? && !context.starting_transaction?)
+        then
+          msg = msg.maybe_add_server_api(server_api)
+        end
+        msg
       end
 
       def process_result(result, connection)

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

@@ -21,8 +21,8 @@ module Mongo
     # @api private
     module ExecutableNoValidate
 
-      def execute(connection, client:)
-        do_execute(connection, client)
+      def execute(connection, context:)
+        do_execute(connection, context)
       end
     end
   end

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

@@ -20,15 +20,9 @@ module Mongo
     #
     # @api private
     module OpMsgOrCommand
+      include PolymorphicOperation
       include PolymorphicLookup
 
-      def execute(server, client:, options: {})
-        server.with_connection do |connection|
-          operation = final_operation(connection)
-          operation.execute(connection, client: client, options: options)
-        end
-      end
-
       private
 
       def final_operation(connection)

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

@@ -21,15 +21,9 @@ module Mongo
     #
     # @api private
     module OpMsgOrFindCommand
+      include PolymorphicOperation
       include PolymorphicLookup
 
-      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)

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

@@ -0,0 +1,39 @@
+# Copyright (C) 2021 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
+
+    # Shared behavior of implementing an operation differently based on
+    # the server that will be executing the operation.
+    #
+    # @api private
+    module PolymorphicOperation
+
+      # Execute the operation.
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      # @param [ Operation::Context ] context The operation context.
+      # @param [ Hash ] options Operation execution options.
+      #
+      # @return [ Mongo::Operation::Result ] The operation result.
+      def execute(server, context:, options: {})
+        server.with_connection do |connection|
+          operation = final_operation(connection)
+          operation.execute(connection, context: context, options: options)
+        end
+      end
+    end
+  end
+end

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

@@ -36,44 +36,47 @@ module Mongo
       #
       # @since 2.0.0
       def options(connection)
-        options = super
-        if add_slave_ok_flag?(connection)
-          flags = options[:flags]&.dup || []
-          flags << :slave_ok
-          options = options.merge(flags: flags)
-        end
-        options
+        add_slave_ok_flag_maybe(super, connection)
       end
 
-      # Whether to add the :slave_ok flag to the request based on the
-      # read preference specified in the operation or implied by the topology
-      # that the connection's server is a part of.
+      # Adds :slave_ok flag to options based on the read preference specified
+      # 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 [ true | false ] Whether the :slave_ok flag should be added.
-      def add_slave_ok_flag?(connection)
-        # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
-        if connection.description.standalone?
-          # Read preference is never sent to standalones.
-          false
-        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.
-          true
-        else
-          # In replica sets and sharded clusters, read preference is passed
-          # to the server if one is specified by the application, and there
-          # is no default.
-          read && read.slave_ok? || false
+      # @return [ Hash ] The new options.
+      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 connection.description.standalone?
+            # Read preference is never sent to standalones.
+            false
+          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.
+            true
+          else
+            # In replica sets and sharded clusters, read preference is passed
+            # to the server if one is specified by the application, and there
+            # is no default.
+            read && read.slave_ok?
+          end
+
+        if add_flag
+          options= options.dup
+          (options[:flags] ||= []) << :slave_ok
         end
+
+        options
       end
 
       def command(connection)
         sel = super
-        add_read_preference_legacy(sel, connection)
+        update_selector_for_read_pref(sel, connection)
       end
 
       # Adds $readPreference field to the command document.
@@ -92,19 +95,14 @@ module Mongo
       #   operation will be executed on.
       #
       # @return [ Hash ] New command document to send to the server.
-      def add_read_preference_legacy(sel, connection)
+      def update_selector_for_read_pref(sel, connection)
         if read && connection.description.mongos? && read_pref = read.to_mongos
-          # If the read preference contains only mode and mode is secondary
-          # preferred and we are sending to a pre-OP_MSG server, this read
-          # preference is indicated by the :slave_ok wire protocol flag
-          # and $readPreference command parameter isn't sent.
-          if read_pref != {mode: 'secondaryPreferred'}
-            Mongo::Lint.validate_camel_case_read_preference(read_pref)
-            sel = sel[:$query] ? sel : {:$query => sel}
-            sel = sel.merge(:$readPreference => read_pref)
-          end
+          Mongo::Lint.validate_camel_case_read_preference(read_pref)
+          sel = sel[:$query] ? sel : {:$query => sel}
+          sel = sel.merge(:$readPreference => read_pref)
+        else
+          sel
         end
-        sel
       end
     end
   end

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

@@ -22,9 +22,13 @@ module Mongo
 
       private
 
-      def validate_result(result, client, connection)
-        unpin_maybe(session) do
-          add_error_labels(client, connection, session) do
+      # @param [ Mongo::Operation::Result ] result The operation result.
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      def validate_result(result, connection, context)
+        unpin_maybe(context.session) do
+          add_error_labels(connection, context) do
             add_server_diagnostics(connection) do
               result.validate!
             end
@@ -38,25 +42,29 @@ 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(client, connection, session)
+      #
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      def add_error_labels(connection, context)
         begin
           yield
         rescue Mongo::Error::SocketError => e
-          if session && session.in_transaction? && !session.committing_transaction?
+          if context.in_transaction? && !context.committing_transaction?
             e.add_label('TransientTransactionError')
           end
-          if session && session.committing_transaction?
+          if context.committing_transaction?
             e.add_label('UnknownTransactionCommitResult')
           end
 
-          maybe_add_retryable_write_error_label!(e, connection, client, session)
+          maybe_add_retryable_write_error_label!(e, connection, context)
 
           raise e
         rescue Mongo::Error::SocketTimeoutError => e
-          maybe_add_retryable_write_error_label!(e, connection, client, session)
+          maybe_add_retryable_write_error_label!(e, connection, context)
           raise e
         rescue Mongo::Error::OperationFailure => e
-          if session && session.committing_transaction?
+          if context.committing_transaction?
             if e.write_retryable? || e.wtimeout? || (e.write_concern_error? &&
                 !Session::UNLABELED_WRITE_CONCERN_CODES.include?(e.write_concern_error_code)
             ) || e.max_time_ms_expired?
@@ -64,7 +72,7 @@ module Mongo
             end
           end
 
-          maybe_add_retryable_write_error_label!(e, connection, client, session)
+          maybe_add_retryable_write_error_label!(e, connection, context)
 
           raise e
         end
@@ -125,21 +133,12 @@ module Mongo
       # @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.
+      # @param [ Mongo::Operation::Context ] context The operation context.
       #
       # @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
-
+      def maybe_add_retryable_write_error_label!(error, connection, context)
         # 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
@@ -147,8 +146,9 @@ module Mongo
         #
         # 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))
+        retryable_operation = context.committing_transaction? ||
+          context.aborting_transaction? ||
+          !context.in_transaction? && context.any_retry_writes?
 
         # An operation should add the RetryableWriteError label if one of the
         # following conditions is met:

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

@@ -171,10 +171,9 @@ module Mongo
         elsif connection.description.mongos?
           # When server is a mongos:
           # - $readPreference is never sent when mode is 'primary'
+          # - When mode is 'secondaryPreferred' $readPreference is only sent
+          #   when a non-mode field (i.e. tag_sets) is present
           # - Otherwise $readPreference is sent
-          # When mode is 'secondaryPreferred' $readPreference is currently
-          # required to only be sent when a non-mode field (i.e. tag_sets)
-          # is present, but this causes wrong behavior (DRIVERS-1642).
           if read
             doc = read.to_mongos
             if doc
@@ -223,9 +222,20 @@ module Mongo
         end
       end
 
-      def build_message(connection)
+      def build_message(connection, context)
+        if self.session != context.session
+          if self.session
+            raise Error::InternalDriverError, "Operation session #{self.session.inspect} does not match context session #{context.session.inspect}"
+          else
+            # Some operations are not constructed with sessions but are
+            # executed in a context where a session is available.
+            # This could be OK or a driver issue.
+            # TODO investigate.
+          end
+        end
+
         super.tap do |message|
-          if session
+          if session = context.session
             # Serialize the message to detect client-side problems,
             # such as invalid BSON keys. The message will be serialized again
             # later prior to being sent to the connection.

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

@@ -25,18 +25,13 @@ module Mongo
 
       # 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).
+      # @param [ Operation::Context ] context The operation context.
       #
       # @return [ Mongo::Operation::Result ] The operation result.
       #
       # @since 2.5.2
-      def execute(server, client:)
+      def execute(server, context:)
         server.with_connection do |connection|
           validate!(connection)
           op = if connection.features.op_msg_enabled?
@@ -47,34 +42,29 @@ module Mongo
               self.class::Command.new(spec)
             end
 
-          result = op.execute(connection, client: client)
-          validate_result(result, client, connection)
+          result = op.execute(connection, context: context)
+          validate_result(result, connection, context)
         end
       end
 
       # Execute the bulk write operation.
       #
-      # @example
-      #   operation.bulk_execute(connection, client: nil)
-      #
       # @param [ Mongo::Server::Connection ] connection The connection over
       #   which to send the operation.
-      # @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).
+      # @param [ Operation::Context ] context The operation context.
       #
       # @return [ Mongo::Operation::Delete::BulkResult,
       #           Mongo::Operation::Insert::BulkResult,
       #           Mongo::Operation::Update::BulkResult ] The bulk result.
       #
       # @since 2.5.2
-      def bulk_execute(connection, client:)
+      def bulk_execute(connection, context:)
         Lint.assert_type(connection, Server::Connection)
 
         if connection.features.op_msg_enabled?
-          self.class::OpMsg.new(spec).execute(connection, client: client).bulk_result
+          self.class::OpMsg.new(spec).execute(connection, context: context).bulk_result
         else
-          self.class::Command.new(spec).execute(connection, client: client).bulk_result
+          self.class::Command.new(spec).execute(connection, context: context).bulk_result
         end
       end