mongo 2.15.0 → 2.17.0

data/lib/mongo/{collection/view → operation/find}/builder/flags.rb

@@ -16,19 +16,17 @@
 # limitations under the License.
 
 module Mongo
-  class Collection
-    class View
+  module Operation
+    class Find
       module Builder
 
-        # Provides behavior for mapping flags.
+        # Provides behavior for converting Ruby options to wire protocol flags
+        # when sending find and related commands (e.g. explain).
         #
-        # @since 2.2.0
+        # @api private
         module Flags
-          extend self
 
           # Options to cursor flags mapping.
-          #
-          # @since 2.2.0
           MAPPINGS = {
             :allow_partial_results => [ :partial ],
             :oplog_replay => [ :oplog_replay ],
@@ -36,20 +34,18 @@ module Mongo
             :tailable => [ :tailable_cursor ],
             :tailable_await => [ :await_data, :tailable_cursor],
             :await_data => [ :await_data ],
-            :exhaust => [ :exhaust ]
+            :exhaust => [ :exhaust ],
           }.freeze
 
-          # Maps an array of flags from the provided options.
+          # Converts Ruby find options to an array of flags.
           #
-          # @example Map the flags.
-          #   Flags.map_flags(options)
+          # Any keys in the input hash that are not options that map to flags
+          # are ignored.
           #
           # @param [ Hash, BSON::Document ] options The options.
           #
           # @return [ Array<Symbol> ] The flags.
-          #
-          # @since 2.2.0
-          def map_flags(options)
+          module_function def map_flags(options)
             MAPPINGS.each.reduce(options[:flags] || []) do |flags, (key, value)|
               cursor_type = options[:cursor_type]
               if options[key] || (cursor_type && cursor_type == key)

data/lib/mongo/operation/find/builder/legacy.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
+# 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
+    class Find
+      module Builder
+
+        # Builds a legacy OP_QUERY specification from options.
+        #
+        # @api private
+        module Legacy
+
+          # Mappings from driver options to legacy server values.
+          #
+          # @since 2.2.0
+          DRIVER_MAPPINGS = {
+            comment: '$comment',
+            explain: '$explain',
+            hint: '$hint',
+            max_scan: '$maxScan',
+            max_time_ms: '$maxTimeMS',
+            max_value: '$max',
+            min_value: '$min',
+            show_disk_loc: '$showDiskLoc',
+            snapshot: '$snapshot',
+            sort: '$orderby',
+            return_key: '$returnKey',
+          }.freeze
+
+          module_function def selector(spec, connection)
+            if Lint.enabled?
+              if spec.keys.any? { |k| String === k }
+                raise Error::LintError, "The spec must contain symbol keys only"
+              end
+            end
+
+            # Server versions that do not have the find command feature
+            # (versions older than 3.2) do not support the allow_disk_use option
+            # but perform no validation and will not raise an error if it is
+            # specified. If the allow_disk_use option is specified, raise an error
+            # to alert the user.
+            unless spec[:allow_disk_use].nil?
+              raise Error::UnsupportedOption.allow_disk_use_error
+            end
+
+            if spec[:collation] && !connection.features.collation_enabled?
+              raise Error::UnsupportedCollation
+            end
+
+            modifiers = {}
+            DRIVER_MAPPINGS.each do |k, server_k|
+              unless (value = spec[k]).nil?
+                modifiers[server_k] = value
+              end
+            end
+
+            selector = spec[:filter] || BSON::Document.new
+            # Write nil into rp if not talking to mongos, rather than false
+            rp = if connection.description.mongos?
+              read_pref_formatted(spec)
+            end
+            if modifiers.any? || rp
+              selector = {'$query' => selector}.update(modifiers)
+
+              if rp
+                selector['$readPreference'] = rp
+              end
+            end
+
+            selector
+          end
+
+          module_function def query_options(spec, connection)
+            query_options = {
+              project: spec[:projection],
+              skip: spec[:skip],
+              limit: spec[:limit],
+              # batch_size is converted to batchSize by Mongo::Protocol::Query.
+              batch_size: spec[:batch_size],
+            }
+
+            unless (flags = Builder::Flags.map_flags(spec)).empty?
+              query_options[:flags] = ((query_options[:flags] || []) + flags).uniq
+            end
+
+            query_options
+          end
+
+          private
+
+          module_function def read_pref_formatted(spec)
+            if spec[:read_preference]
+              raise ArgumentError, "Spec cannot include :read_preference here, use :read"
+            end
+
+            if read = spec[:read]
+              read_pref = ServerSelector.get(read).to_mongos
+              Mongo::Lint.validate_camel_case_read_preference(read_pref)
+              read_pref
+            else
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{collection/view → operation/find}/builder/modifiers.rb

@@ -16,64 +16,70 @@
 # limitations under the License.
 
 module Mongo
-  class Collection
-    class View
+  module Operation
+    class Find
       module Builder
 
-        # Provides behavior for mapping modifiers.
+        # Provides behavior for mapping Ruby options to legacy OP_QUERY
+        # find modifiers.
         #
-        # @since 2.2.0
+        # This module is used in two ways:
+        # 1. When Collection#find is invoked with the legacy OP_QUERY
+        #    syntax (:$query argument etc.), this module is used to map
+        #    the legacy parameters into the Ruby options that normally
+        #    are used by applications.
+        # 2. When sending a find operation using the OP_QUERY protocol,
+        #    this module is used to map the Ruby find options to the
+        #    modifiers in the wire protocol message.
+        #
+        # @api private
         module Modifiers
-          extend self
 
-          # Mappings from driver options to legacy server values.
-          #
-          # @since 2.2.0
+          # Mappings from Ruby options to OP_QUERY modifiers.
           DRIVER_MAPPINGS = BSON::Document.new(
-            sort: '$orderby',
-            hint: '$hint',
             comment: '$comment',
-            snapshot: '$snapshot',
+            explain: '$explain',
+            hint: '$hint',
             max_scan: '$maxScan',
+            max_time_ms: '$maxTimeMS',
             max_value: '$max',
             min_value: '$min',
-            max_time_ms: '$maxTimeMS',
             return_key: '$returnKey',
             show_disk_loc: '$showDiskLoc',
-            explain: '$explain'
+            snapshot: '$snapshot',
+            sort: '$orderby',
           ).freeze
 
-          # Mappings from server values to driver options.
-          #
-          # @since 2.2.0
+          # Mappings from OP_QUERY modifiers to Ruby options.
           SERVER_MAPPINGS = BSON::Document.new(DRIVER_MAPPINGS.invert).freeze
 
-          # Transform the provided server modifiers to driver options.
+          # Transform the provided OP_QUERY modifiers to Ruby options.
           #
           # @example Transform to driver options.
           #   Modifiers.map_driver_options(modifiers)
           #
           # @param [ Hash ] modifiers The modifiers.
           #
-          # @return [ BSON::Document ] The driver options.
-          #
-          # @since 2.2.0
-          def self.map_driver_options(modifiers)
+          # @return [ BSON::Document ] The Ruby options.
+          module_function def map_driver_options(modifiers)
             Options::Mapper.transform_documents(modifiers, SERVER_MAPPINGS)
           end
 
-          # Transform the provided options into a document of only server
+          # Transform the provided Ruby options into a document of OP_QUERY
           # modifiers.
           #
+          # Accepts both string and symbol keys.
+          #
+          # The input mapping may contain additional keys that do not map to
+          # OP_QUERY modifiers, in which case the extra keys are ignored.
+          #
           # @example Map the server modifiers.
           #   Modifiers.map_server_modifiers(options)
           #
           # @param [ Hash, BSON::Document ] options The options.
           #
           # @return [ BSON::Document ] The modifiers.
-          #
-          # @since 2.2.0
-          def self.map_server_modifiers(options)
+          module_function def map_server_modifiers(options)
             Options::Mapper.transform_documents(options, DRIVER_MAPPINGS)
           end
         end

data/lib/mongo/{cursor → operation/find}/builder.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/cursor/builder/op_get_more'
-require 'mongo/cursor/builder/op_kill_cursors'
-require 'mongo/cursor/builder/get_more_command'
-require 'mongo/cursor/builder/kill_cursors_command'
+require 'mongo/operation/find/builder/command'
+require 'mongo/operation/find/builder/flags'
+require 'mongo/operation/find/builder/legacy'
+require 'mongo/operation/find/builder/modifiers'

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

@@ -33,6 +33,15 @@ module Mongo
 
         private
 
+        def selector(connection)
+          # The mappings are BSON::Documents and as such store keys as
+          # strings, the spec here has symbol keys
+          spec = BSON::Document.new(self.spec)
+          {
+            find: coll_name,
+          }.update(Find::Builder::Command.selector(spec, connection))
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end

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

@@ -35,7 +35,16 @@ module Mongo
         private
 
         def message(connection)
-          Protocol::Query.new(db_name, coll_name, command(connection), options(connection))
+          selector = Find::Builder::Legacy.selector(spec, connection)
+          options = options(connection).update(
+            Find::Builder::Legacy.query_options(spec, connection),
+          )
+          Protocol::Query.new(
+            db_name,
+            coll_name,
+            selector,
+            options,
+          )
         end
       end
     end

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

@@ -28,6 +28,18 @@ module Mongo
         include CausalConsistencySupported
         include ExecutableTransactionLabel
         include PolymorphicResult
+
+        private
+
+        def selector(connection)
+          # The mappings are BSON::Documents and as such store keys as
+          # strings, the spec here has symbol keys.
+          spec = BSON::Document.new(self.spec)
+          {
+            find: coll_name,
+            Protocol::Msg::DATABASE_IDENTIFIER => db_name,
+          }.update(Find::Builder::Command.selector(spec, connection))
+        end
       end
     end
   end

data/lib/mongo/operation/find.rb

@@ -19,6 +19,7 @@ require 'mongo/operation/find/command'
 require 'mongo/operation/find/op_msg'
 require 'mongo/operation/find/legacy'
 require 'mongo/operation/find/result'
+require 'mongo/operation/find/builder'
 
 module Mongo
   module Operation

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

@@ -30,6 +30,7 @@ module Mongo
         include Limited
         include ReadPreferenceSupported
         include PolymorphicResult
+        include CommandBuilder
 
         private
 

data/lib/mongo/operation/get_more/command_builder.rb

@@ -0,0 +1,38 @@
+# 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
+    class GetMore
+
+      # @api private
+      module CommandBuilder
+
+        private
+
+        def selector(connection)
+          {
+            getMore: BSON::Int64.new(spec.fetch(:cursor_id)),
+            collection: spec.fetch(:coll_name),
+            batchSize: spec[:batch_size],
+            maxTimeMS: spec[:max_time_ms],
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -27,6 +27,7 @@ module Mongo
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
         include PolymorphicResult
+        include CommandBuilder
       end
     end
   end

data/lib/mongo/operation/get_more.rb

@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/get_more/command_builder'
 require 'mongo/operation/get_more/command'
 require 'mongo/operation/get_more/op_msg'
 require 'mongo/operation/get_more/legacy'

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

@@ -28,9 +28,17 @@ module Mongo
         include Specifiable
         include Executable
         include Limited
+        include CommandBuilder
 
         private
 
+        def selector(connection)
+          {
+            killCursors: coll_name,
+            cursors: int64_cursor_ids,
+          }
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, selector(connection), options(connection))
         end

data/lib/mongo/operation/kill_cursors/command_builder.rb

@@ -0,0 +1,35 @@
+# 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
+    class KillCursors
+
+      # @api private
+      module CommandBuilder
+
+        private
+
+        def int64_cursor_ids
+          spec.fetch(:cursor_ids).map do |id|
+            BSON::Int64.new(id)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -27,11 +27,12 @@ module Mongo
       class Legacy
         include Specifiable
         include Executable
+        include CommandBuilder
 
         private
 
         def message(connection)
-          Protocol::KillCursors.new(coll_name, db_name, cursor_ids)
+          Protocol::KillCursors.new(coll_name, db_name, int64_cursor_ids)
         end
       end
     end

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

@@ -26,6 +26,16 @@ module Mongo
       # @since 2.5.2
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
+        include CommandBuilder
+
+        private
+
+        def selector(connection)
+          {
+            killCursors: coll_name,
+            cursors: int64_cursor_ids,
+          }
+        end
       end
     end
   end

data/lib/mongo/operation/kill_cursors.rb

@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/kill_cursors/command_builder'
 require 'mongo/operation/kill_cursors/command'
 require 'mongo/operation/kill_cursors/op_msg'
 require 'mongo/operation/kill_cursors/legacy'

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

@@ -34,6 +34,14 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.tap do |selector|
+            if selector[:collation] && !connection.features.collation_enabled?
+              raise Error::UnsupportedCollation
+            end
+          end
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end

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

@@ -19,7 +19,7 @@ module Mongo
   module Operation
     class MapReduce
 
-      # A MongoDB mapreduce operation sent as an op message.
+      # A MongoDB map-reduce operation sent as an op message.
       #
       # @api private
       #

data/lib/mongo/operation/result.rb

@@ -429,6 +429,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

@@ -31,6 +31,23 @@ module Mongo
           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_service_id
+                      unless session.pinned_service_id == connection.service_id
+                        raise Error::InternalDriverError, "Expected operation to use service #{session.pinned_session_id} but it used #{connection.service_id}"
+                      end
+                    else
+                      session.pin_to_service(connection.service_id)
+                    end
+                  end
+
+                  if session.snapshot? && !session.snapshot_timestamp
+                    session.snapshot_timestamp = result.snapshot_timestamp
+                  end
+                end
                 process_result(result, connection)
               end
             end
@@ -93,7 +110,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 +122,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,7 +32,7 @@ module Mongo
       #
       # @return [ Mongo::Operation::Result ] The operation result.
       def execute(server, context:, options: {})
-        server.with_connection do |connection|
+        server.with_connection(service_id: context.service_id) do |connection|
           operation = final_operation(connection)
           operation.execute(connection, context: context, options: options)
         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

@@ -112,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