mongo 2.14.0 → 2.16.0

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,8 +24,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/executable_transaction_label.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,15 +23,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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,15 +24,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_lookup.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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(service_id: context.service_id) do |connection|
+          operation = final_operation(connection)
+          operation.execute(connection, context: context, options: options)
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -36,47 +39,44 @@ module Mongo
       #
       # @since 2.0.0
       def options(connection)
-        add_slave_ok_flag_maybe(super, connection)
+        options = super
+        if add_secondary_ok_flag?(connection)
+          flags = options[:flags]&.dup || []
+          flags << :secondary_ok
+          options = options.merge(flags: flags)
+        end
+        options
       end
 
-      # 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.
+      # Whether to add the :secondary_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.
       #
-      # @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, 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
+      # @return [ true | false ] Whether the :secondary_ok flag should be added.
+      def add_secondary_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 secondary_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.secondary_ok? || false
         end
-
-        options
       end
 
       def command(connection)
         sel = super
-        update_selector_for_read_pref(sel, connection)
+        add_read_preference_legacy(sel, connection)
       end
 
       # Adds $readPreference field to the command document.
@@ -95,14 +95,21 @@ module Mongo
       #   operation will be executed on.
       #
       # @return [ Hash ] New command document to send to the server.
-      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)
-        else
-          sel
+      def add_read_preference_legacy(sel, connection)
+        if read && (
+          connection.description.mongos? || connection.description.load_balancer?
+        ) && 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 :secondary_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
         end
+        sel
       end
     end
   end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,9 +25,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 +45,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 +75,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
@@ -101,6 +112,7 @@ module Mongo
       rescue Error, Error::AuthError => e
         e.add_note("on #{connection.address.seed}")
         e.generation = connection.generation
+        e.service_id = connection.service_id
         raise e
       end
 
@@ -125,21 +137,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 +150,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/result/aggregatable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/operation/shared/result/use_legacy_error_parser.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -130,7 +133,7 @@ module Mongo
           end
         end
 
-        sel = selector(connection).dup
+        sel = BSON::Document.new(selector(connection))
         add_write_concern!(sel)
         sel[Protocol::Msg::DATABASE_IDENTIFIER] = db_name
 
@@ -166,20 +169,19 @@ module Mongo
         Lint.assert_type(connection, Server::Connection)
 
         # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
-        if connection.description.standalone?
+        read_doc = if connection.description.standalone?
           # Read preference is never sent to standalones.
+          nil
+        elsif connection.server.load_balancer?
+          read&.to_mongos
         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
-          if read
-            doc = read.to_mongos
-            if doc
-              sel['$readPreference'] = doc
-            end
-          end
+          # 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).
+          read&.to_mongos
         elsif connection.server.cluster.single?
           # In Single topology:
           # - If no read preference is specified by the application, the driver
@@ -194,13 +196,15 @@ module Mongo
           if [nil, 'primary'].include?(read_doc['mode'])
             read_doc['mode'] = 'primaryPreferred'
           end
-          sel['$readPreference'] = read_doc
+          read_doc
         else
           # In replica sets, read preference is passed to the server if one
           # is specified by the application, and there is no default.
-          if read
-            sel['$readPreference'] = read.to_doc
-          end
+          read&.to_doc
+        end
+
+        if read_doc
+          sel['$readPreference'] = read_doc
         end
       end
 
@@ -222,9 +226,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/specifiable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,11 +60,6 @@ module Mongo
       # @since 2.0.0
       CURSOR_ID = :cursor_id.freeze
 
-      # The field for cursor ids.
-      #
-      # @since 2.0.0
-      CURSOR_IDS = :cursor_ids.freeze
-
       # The field for an index.
       #
       # @since 2.0.0
@@ -235,7 +233,7 @@ module Mongo
       #
       # @since 2.0.0
       def coll_name
-        spec[COLL_NAME]
+        spec.fetch(COLL_NAME)
       end
 
       # The id of the cursor created on the server.
@@ -250,18 +248,6 @@ module Mongo
         spec[CURSOR_ID]
       end
 
-      # The ids of the cursors to kill from the spec.
-      #
-      # @example Get the cursor ids from the spec.
-      #   specifiable.cursor_ids
-      #
-      # @return [ Array<Integer> ] The cursor ids.
-      #
-      # @since 2.0.0
-      def cursor_ids
-        spec[CURSOR_IDS]
-      end
-
       # Get the index from the specification.
       #
       # @example Get the index specification.
@@ -533,17 +519,6 @@ module Mongo
         @spec[:txn_num]
       end
 
-      # For createIndexes operations, the number of votes that a primary must
-      # wait for before commiting an index. Potential values are:
-      # - an integer from 0 to the number of members of the replica set
-      # - "majority" indicating that a majority of data bearing nodes must vote
-      # - "votingMembers" which means that all voting data bearing nodes must vote
-      #
-      # @return [ nil | Integer | String ] The commitQuorum value of the operation.
-      def commit_quorum
-        @spec[:commit_quorum]
-      end
-
       # The command.
       #
       # @return [ Hash ] The command.
@@ -577,6 +552,16 @@ module Mongo
       def acknowledged_write?
         write_concern.nil? || write_concern.acknowledged?
       end
+
+      def apply_collation(selector, connection, collation)
+        if collation
+          unless connection.features.collation_enabled?
+            raise Error::UnsupportedCollation
+          end
+          selector = selector.merge(collation: collation)
+        end
+        selector
+      end
     end
   end
 end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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
+
+    # @api private
+    module Validatable
+
+      def validate_find_options(connection, selector)
+        if selector.key?(:hint) &&
+          !connection.features.find_and_modify_option_validation_enabled?
+        then
+          raise Error::UnsupportedOption.hint_error
+        end
+
+        if selector.key?(:arrayFilters) &&
+          !connection.features.array_filters_enabled?
+        then
+          raise Error::UnsupportedArrayFilters
+        end
+
+        if selector.key?(:collation) &&
+          !connection.features.collation_enabled?
+        then
+          raise Error::UnsupportedCollation
+        end
+      end
+
+      # selector_or_item here is either:
+      # - The selector as used in a findAndModify command, or
+      # - One of the array elements in the updates array in an update command.
+      def validate_hint_on_update(connection, selector_or_item)
+        if selector_or_item.key?(:hint) &&
+          !connection.features.update_delete_option_validation_enabled?
+        then
+          raise Error::UnsupportedOption.hint_error
+        end
+      end
+
+      # selector_or_item here is either:
+      # - The selector as used in a findAndModify command, or
+      # - One of the array elements in the updates array in an update command.
+      def validate_array_filters(connection, selector_or_item)
+        if selector_or_item.key?(:arrayFilters) &&
+          !connection.features.array_filters_enabled?
+        then
+          raise Error::UnsupportedArrayFilters
+        end
+      end
+
+      # selector_or_item here is either:
+      # - The selector as used in a findAndModify command, or
+      # - One of the array elements in the updates array in an update command.
+      def validate_collation(connection, selector_or_item)
+        if selector_or_item.key?(:collation) &&
+          !connection.features.collation_enabled?
+        then
+          raise Error::UnsupportedCollation
+        end
+      end
+
+      def validate_updates(connection, updates)
+        updates.each do |update|
+          validate_array_filters(connection, update)
+          validate_collation(connection, update)
+          validate_hint_on_update(connection, update)
+        end
+        updates
+      end
+    end
+  end
+end