mongo 2.15.0 → 2.18.1

data/lib/mongo/operation/result.rb

@@ -97,9 +97,12 @@ module Mongo
       #   this result is for. This parameter is allowed to be nil for
       #   compatibility with existing mongo_kerberos library, but should
       #   always be not nil in the driver proper.
+      # @param [ Integer ] connection_global_id
+      #   Global id of the connection on which the operation that
+      #   this result is for was performed.
       #
       # @api private
-      def initialize(replies, connection_description = nil)
+      def initialize(replies, connection_description = nil, connection_global_id = nil)
         if replies
           if replies.is_a?(Array)
             if replies.length != 1
@@ -114,6 +117,7 @@ module Mongo
           end
           @replies = [ reply ]
           @connection_description = connection_description
+          @connection_global_id = connection_global_id
         end
       end
 
@@ -128,6 +132,12 @@ module Mongo
       # @api private
       attr_reader :connection_description
 
+      # @return [ Object ] Global is of the connection that
+      #   the operation was performed on that this result is for.
+      #
+      # @api private
+      attr_reader :connection_global_id
+
       # @api private
       def_delegators :parser,
         :not_master?, :node_recovering?, :node_shutting_down?
@@ -148,6 +158,15 @@ module Mongo
         !!@replies
       end
 
+      # Whether the result contains cursor_id
+      #
+      # @return [ true, false ] If the result contains cursor_id.
+      #
+      # @api private
+      def has_cursor_id?
+        acknowledged? && replies.last.respond_to?(:cursor_id)
+      end
+
       # Get the cursor id if the response is acknowledged.
       #
       # @note Cursor ids of 0 indicate there is no cursor on the server.
@@ -238,10 +257,7 @@ module Mongo
         end
       end
 
-      # Get the count of documents returned by the server.
-      #
-      # @example Get the number returned.
-      #   result.returned_count
+      # Get the number of documents returned by the server in this batch.
       #
       # @return [ Integer ] The number of documents returned.
       #
@@ -429,6 +445,12 @@ module Mongo
         !!(first_document && first_document['writeConcernError'])
       end
 
+      def snapshot_timestamp
+        if doc = reply.documents.first
+          doc['cursor']&.[]('atClusterTime') || doc['atClusterTime']
+        end
+      end
+
       private
 
       def aggregate_returned_count

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

@@ -27,10 +27,42 @@ module Mongo
       include ResponseHandling
 
       def do_execute(connection, context, options = {})
-        unpin_maybe(session) do
+        session&.materialize_if_needed
+        unpin_maybe(session, connection) do
           add_error_labels(connection, context) do
             add_server_diagnostics(connection) do
               get_result(connection, context, options).tap do |result|
+                if session
+                  if session.in_transaction? &&
+                    connection.description.load_balancer?
+                  then
+                    if session.pinned_connection_global_id
+                      unless session.pinned_connection_global_id == connection.global_id
+                        raise(
+                          Error::InternalDriverError,
+                          "Expected operation to use connection #{session.pinned_connection_global_id} but it used #{connection.global_id}"
+                        )
+                      end
+                    else
+                      session.pin_to_connection(connection.global_id)
+                      connection.pin
+                    end
+                  end
+
+                  if session.snapshot? && !session.snapshot_timestamp
+                    session.snapshot_timestamp = result.snapshot_timestamp
+                  end
+                end
+
+                if result.has_cursor_id? &&
+                  connection.description.load_balancer?
+                then
+                  if result.cursor_id == 0
+                    connection.unpin
+                  else
+                    connection.pin
+                  end
+                end
                 process_result(result, connection)
               end
             end
@@ -65,7 +97,7 @@ module Mongo
         message = build_message(connection, context)
         message = message.maybe_encrypt(connection, context)
         reply = connection.dispatch([ message ], context, options)
-        [reply, connection.description]
+        [reply, connection.description, connection.global_id]
       end
 
       # @param [ Mongo::Server::Connection ] connection The connection on which
@@ -93,7 +125,7 @@ module Mongo
 
       def process_result_for_sdam(result, connection)
         if (result.not_master? || result.node_recovering?) &&
-          connection.generation >= connection.server.pool.generation
+          connection.generation >= connection.server.pool.generation(service_id: connection.service_id)
         then
           if result.node_shutting_down?
             keep_pool = false
@@ -105,6 +137,7 @@ module Mongo
           connection.server.unknown!(
             keep_connection_pool: keep_pool,
             generation: connection.generation,
+            service_id: connection.service_id,
             topology_version: result.topology_version,
           )
 

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

@@ -32,11 +32,23 @@ module Mongo
       #
       # @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)
+        server.with_connection(connection_global_id: context.connection_global_id) do |connection|
+          execute_with_connection(connection, context: context, options: options)
         end
       end
+
+      # Execute the operation.
+      #
+      # @param [ Mongo::Server::Connection ] connection The connection to send
+      #   the operation through.
+      # @param [ Operation::Context ] context The operation context.
+      # @param [ Hash ] options Operation execution options.
+      #
+      # @return [ Mongo::Operation::Result ] The operation result.
+      def execute_with_connection(connection, context:, options: {})
+        operation = final_operation(connection)
+        operation.execute(connection, context: context, options: options)
+      end
     end
   end
 end

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

@@ -96,7 +96,9 @@ module Mongo
       #
       # @return [ Hash ] New command document to send to the server.
       def add_read_preference_legacy(sel, connection)
-        if read && connection.description.mongos? && read_pref = read.to_mongos
+        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

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

@@ -30,7 +30,7 @@ module Mongo
       #   the operation is performed.
       # @param [ Mongo::Operation::Context ] context The operation context.
       def validate_result(result, connection, context)
-        unpin_maybe(context.session) do
+        unpin_maybe(context.session, connection) do
           add_error_labels(connection, context) do
             add_server_diagnostics(connection) do
               result.validate!
@@ -81,19 +81,20 @@ module Mongo
         end
       end
 
-      # Unpins the session if the session is pinned and the yielded to block
-      # raises errors that are required to unpin the session.
+      # Unpins the session and/or the connection if  the yielded to block
+      # raises errors that are required to unpin the session and the connection.
       #
       # @note This method takes the session as an argument because this module
       #   is included in BulkWrite which does not store the session in the
       #   receiver (despite Specifiable doing so).
       #
       # @param [ Session | nil ] session Session to consider.
-      def unpin_maybe(session)
+      # @param [ Connection | nil ] connection Connection to unpin.
+      def unpin_maybe(session, connection)
         yield
       rescue Mongo::Error => e
         if session
-          session.unpin_maybe(e)
+          session.unpin_maybe(e, connection)
         end
         raise
       end
@@ -112,6 +113,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
 

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

@@ -133,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
 
@@ -169,8 +169,11 @@ 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'
@@ -178,12 +181,7 @@ module Mongo
           # 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
-              sel['$readPreference'] = doc
-            end
-          end
+          read&.to_mongos
         elsif connection.server.cluster.single?
           # In Single topology:
           # - If no read preference is specified by the application, the driver
@@ -198,14 +196,21 @@ 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
+          # is specified by the application, except for primary read preferences.
+          read_doc = BSON::Document.new(read&.to_doc || {})
+          if [nil, 'primary'].include?(read_doc['mode'])
+            nil
+          else
+            read_doc
           end
         end
+
+        if read_doc
+          sel['$readPreference'] = read_doc
+        end
       end
 
       def apply_session_options(sel, connection)
@@ -224,6 +229,17 @@ module Mongo
         then
           sel[:recoveryToken] = session.recovery_token
         end
+
+        if session.snapshot?
+          unless connection.description.server_version_gte?('5.0')
+            raise Error::SnapshotSessionInvalidServerVersion
+          end
+
+          sel[:readConcern] = {level: 'snapshot'}
+          if session.snapshot_timestamp
+            sel[:readConcern][:atClusterTime] = session.snapshot_timestamp
+          end
+        end
       end
 
       def build_message(connection, context)
@@ -241,10 +257,14 @@ module Mongo
         super.tap do |message|
           if session = context.session
             # Serialize the message to detect client-side problems,
-            # such as invalid BSON keys. The message will be serialized again
+            # such as invalid BSON keys or too large messages.
+            # The message will be serialized again
             # later prior to being sent to the connection.
-            message.serialize(BSON::ByteBuffer.new)
-
+            buf = BSON::ByteBuffer.new
+            message.serialize(buf)
+            if buf.length > connection.max_message_size
+              raise Error::MaxMessageSize.new(connection.max_message_size)
+            end
             session.update_state!
           end
         end

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

@@ -60,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
@@ -238,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.
@@ -253,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.
@@ -536,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.
@@ -580,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

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

@@ -35,21 +35,27 @@ module Mongo
       #
       # @since 2.5.2
       def execute(server, context:)
-        server.with_connection do |connection|
-          validate!(connection)
-          op = if connection.features.op_msg_enabled?
-              self.class::OpMsg.new(spec)
-            elsif !acknowledged_write?
-              self.class::Legacy.new(spec)
-            else
-              self.class::Command.new(spec)
-            end
-
-          result = op.execute(connection, context: context)
-          validate_result(result, connection, context)
+        server.with_connection(connection_global_id: context.connection_global_id) do |connection|
+          execute_with_connection(connection, context: context)
         end
       end
 
+      # Execute the operation.
+      #
+      # @param [ Mongo::Server::Connection ] connection The connection to send
+      #   the operation through.
+      # @param [ Operation::Context ] context The operation context.
+      # @param [ Hash ] options Operation execution options.
+      #
+      # @return [ Mongo::Operation::Result ] The operation result.
+      def execute_with_connection(connection, context:)
+        validate!(connection)
+        op = self.class::OpMsg.new(spec)
+
+        result = op.execute(connection, context: context)
+        validate_result(result, connection, context)
+      end
+
       # Execute the bulk write operation.
       #
       # @param [ Mongo::Server::Connection ] connection The connection over

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

@@ -32,13 +32,16 @@ module Mongo
         include BypassDocumentValidation
         include ExecutableNoValidate
         include PolymorphicResult
+        include Validatable
 
         private
 
         def selector(connection)
-          { update: coll_name,
-            updates: send(IDENTIFIER),
-            ordered: ordered? }
+          {
+            update: coll_name,
+            updates: validate_updates(connection, send(IDENTIFIER)),
+            ordered: ordered?,
+          }
         end
 
         def message(connection)

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

@@ -29,17 +29,22 @@ module Mongo
         include ExecutableNoValidate
         include ExecutableTransactionLabel
         include PolymorphicResult
+        include Validatable
 
         private
 
         def selector(connection)
-          { update: coll_name,
-            Protocol::Msg::DATABASE_IDENTIFIER => db_name,
-            ordered: ordered? }
+          {
+            update: coll_name,
+            ordered: ordered?,
+            let: spec[:let],
+            comment: spec[:comment]
+          }.compact
         end
 
         def message(connection)
-          section = Protocol::Msg::Section1.new(IDENTIFIER, send(IDENTIFIER))
+          updates = validate_updates(connection, send(IDENTIFIER))
+          section = Protocol::Msg::Section1.new(IDENTIFIER, updates)
           Protocol::Msg.new(flags, {}, command(connection), section)
         end
       end

data/lib/mongo/operation/update.rb

@@ -17,7 +17,6 @@
 
 require 'mongo/operation/update/command'
 require 'mongo/operation/update/op_msg'
-require 'mongo/operation/update/legacy'
 require 'mongo/operation/update/result'
 require 'mongo/operation/update/bulk_result'
 

data/lib/mongo/operation/{delete/legacy.rb → write_command/command.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # encoding: utf-8
 
-# Copyright (C) 2018-2020 MongoDB Inc.
+# 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.
@@ -17,39 +17,33 @@
 
 module Mongo
   module Operation
-    class Delete
+    class WriteCommand
 
-      # A MongoDB delete operation sent as a legacy wire protocol message.
+      # A MongoDB write command operation sent as a command message.
       #
       # @api private
-      #
-      # @since 2.5.2
-      class Legacy
+      class Command
         include Specifiable
         include Executable
-        include PolymorphicResult
+        include Limited
+        include ReadPreferenceSupported
+        include Validatable
 
         private
 
-        def selector
-          send(IDENTIFIER).first
+        def selector(connection)
+          super.tap do |selector|
+            if selector.key?(:findAndModify)
+              validate_find_options(connection, selector)
+            end
+            if wc = spec[:write_concern]
+              selector[:writeConcern] = wc.options
+            end
+          end
         end
 
         def message(connection)
-          opts = (selector[Operation::LIMIT] || 0) <= 0 ? {} : { :flags => [ :single_remove ] }
-          Protocol::Delete.new(db_name, coll_name, selector[Operation::Q], opts)
-        end
-
-        def gle
-          wc = write_concern ||  WriteConcern.get(WriteConcern::DEFAULT)
-          if gle_message = wc.get_last_error
-            Protocol::Query.new(
-                db_name,
-                Database::COMMAND,
-                gle_message,
-                options.merge(limit: -1)
-            )
-          end
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end