mongo 2.15.0.alpha → 2.16.0

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

@@ -0,0 +1,110 @@
+# 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 find command specification from options.
+        #
+        # @api private
+        module Command
+
+          # The mappings from ruby options to the find command.
+          OPTION_MAPPINGS = BSON::Document.new(
+            allow_disk_use: 'allowDiskUse',
+            allow_partial_results: 'allowPartialResults',
+            await_data: 'awaitData',
+            batch_size: 'batchSize',
+            collation: 'collation',
+            comment: 'comment',
+            filter: 'filter',
+            hint: 'hint',
+            limit: 'limit',
+            max_scan: 'maxScan',
+            max_time_ms: 'maxTimeMS',
+            max_value: 'max',
+            min_value: 'min',
+            no_cursor_timeout: 'noCursorTimeout',
+            oplog_replay: 'oplogReplay',
+            projection: 'projection',
+            read_concern: 'readConcern',
+            return_key: 'returnKey',
+            show_disk_loc: 'showRecordId',
+            single_batch: 'singleBatch',
+            skip: 'skip',
+            snapshot: 'snapshot',
+            sort: 'sort',
+            tailable: 'tailable',
+            tailable_cursor: 'tailable',
+          ).freeze
+
+          module_function def selector(spec, connection)
+            if spec[:collation] && !connection.features.collation_enabled?
+              raise Error::UnsupportedCollation
+            end
+
+            BSON::Document.new.tap do |selector|
+              OPTION_MAPPINGS.each do |k, server_k|
+                unless (value = spec[k]).nil?
+                  selector[server_k] = value
+                end
+              end
+
+              if rc = selector[:readConcern]
+                selector[:readConcern] = Options::Mapper.transform_values_to_strings(rc)
+              end
+
+              convert_limit_and_batch_size!(selector)
+            end
+          end
+
+          private
+
+          # Converts negative limit and batchSize parameters in the
+          # find command to positive ones. Removes the parameters if their
+          # values are zero.
+          #
+          # This is only used for find commmand, not for OP_QUERY path.
+          #
+          # The +command+ parameter is mutated by this method.
+          module_function def convert_limit_and_batch_size!(command)
+            if command[:limit] && command[:limit] < 0 &&
+              command[:batchSize] && command[:batchSize] < 0
+            then
+              command[:limit] = command[:limit].abs
+              command[:batchSize] = command[:limit].abs
+              command[:singleBatch] = true
+            else
+              [:limit, :batchSize].each do |opt|
+                if command[opt]
+                  if command[opt] < 0
+                    command[opt] = command[opt].abs
+                    command[:singleBatch] = true
+                  elsif command[opt] == 0
+                    command.delete(opt)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{collection/view → operation/find}/builder/flags.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");
@@ -13,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 ],
@@ -33,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

@@ -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");
@@ -13,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.
+        #
+        # 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.
         #
-        # @since 2.2.0
+        # @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

@@ -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");
@@ -12,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

@@ -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");
@@ -30,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/result.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/find/legacy.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");
@@ -32,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

@@ -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");
@@ -25,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/result.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/find.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");
@@ -16,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

@@ -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");
@@ -27,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/legacy.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/get_more/op_msg.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");
@@ -24,6 +27,7 @@ module Mongo
       class OpMsg < OpMsgBase
         include ExecutableTransactionLabel
         include PolymorphicResult
+        include CommandBuilder
       end
     end
   end

data/lib/mongo/operation/get_more/result.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/get_more.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");
@@ -12,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/indexes/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");

data/lib/mongo/operation/indexes/legacy.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/indexes/op_msg.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/indexes/result.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/indexes.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/insert/bulk_result.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/insert/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");