mongo 2.11.2 → 2.13.0.beta1

data/lib/mongo/collection/view/aggregation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -108,7 +108,10 @@ module Mongo
         end
 
         def valid_server?(server)
-          server.standalone? || server.mongos? || server.primary? || secondary_ok?
+          description = server.with_connection do |connection|
+            connection.description
+          end
+          description.standalone? || description.mongos? || description.primary? || secondary_ok?
         end
 
         def write?
@@ -125,11 +128,11 @@ module Mongo
             server = cluster.next_primary(nil, session)
           end
           validate_collation!(server)
-          initial_query_op(session).execute(server)
+          initial_query_op(session).execute(server, client: client)
         end
 
         def validate_collation!(server)
-          if options[:collation] && !server.features.collation_enabled?
+          if options[:collation] && !server.with_connection { |connection| connection.features }.collation_enabled?
             raise Error::UnsupportedCollation.new
           end
         end

data/lib/mongo/collection/view/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/collection/view/builder/aggregation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/collection/view/builder/find_command.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.
@@ -48,6 +48,7 @@ module Mongo
             no_cursor_timeout: 'noCursorTimeout',
             await_data: 'awaitData',
             allow_partial_results: 'allowPartialResults',
+            allow_disk_use: 'allowDiskUse',
             collation: 'collation'
           ).freeze
 
@@ -101,6 +102,9 @@ module Mongo
                 collection.read_concern)
             end
             command = Options::Mapper.transform_documents(convert_flags(options), MAPPINGS, document)
+            if command['oplogReplay']
+              log_warn("oplogReplay is deprecated and ignored by MongoDB 4.4 and later")
+            end
             convert_limit_and_batch_size(command)
             command
           end
@@ -135,6 +139,10 @@ module Mongo
               o.merge!(key => true)
             end
           end
+
+          def log_warn(*args)
+            database.client.log_warn(*args)
+          end
         end
       end
     end

data/lib/mongo/collection/view/builder/flags.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/collection/view/builder/map_reduce.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/collection/view/builder/modifiers.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/collection/view/builder/op_query.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.

data/lib/mongo/collection/view/change_stream.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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.
@@ -147,19 +147,16 @@ module Mongo
         # @since 2.6.0
         def try_next
           raise StopIteration.new if closed?
-          retried = false
-
           begin
             doc = @cursor.try_next
           rescue Mongo::Error => e
-            if retried || !e.change_stream_resumable?
+            if !e.change_stream_resumable?
               raise
             end
 
-            retried = true
             # Rerun initial aggregation.
             # Any errors here will stop iteration and break out of this
-            # method
+            # method.
 
             # Save cursor's resume token so we can use it
             # to create a new cursor
@@ -194,12 +191,21 @@ module Mongo
         # @example Close the change stream.
         #   stream.close
         #
-        # @return [ nil ] nil.
+        # @note This method attempts to close the cursor used by the change
+        #   stream, which in turn closes the server-side change stream cursor.
+        #   This method ignores any errors that occur when closing the
+        #   server-side cursor.
+        #
+        # @return [ nil ] Always nil.
         #
         # @since 2.5.0
         def close
           unless closed?
-            begin; @cursor.send(:kill_cursors); rescue; end
+            begin
+              @cursor.close
+            rescue Error::OperationFailure
+              # ignore
+            end
             @cursor = nil
           end
         end
@@ -340,7 +346,7 @@ module Mongo
         end
 
         def send_initial_query(server, session)
-          initial_query_op(session).execute(server)
+          initial_query_op(session).execute(server, client: client)
         end
 
         def time_to_bson_timestamp(time)

data/lib/mongo/collection/view/change_stream/retryable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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.

data/lib/mongo/collection/view/explainable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/collection/view/immutable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/collection/view/iterable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -55,23 +55,38 @@ module Mongo
           end
         end
 
-        # Stop the iteration by sending a KillCursors command to the server.
+        # Cleans up resources associated with this query.
         #
-        # @example Stop the iteration.
-        #   view.close_query
+        # If there is a server cursor associated with this query, it is
+        # closed by sending a KillCursors command to the server.
+        #
+        # @note This method propagates any errors that occur when closing the
+        #   server-side cursor.
+        #
+        # @return [ nil ] Always nil.
+        #
+        # @raise [ Error::OperationFailure ] If the server cursor close fails.
         #
         # @since 2.1.0
         def close_query
-          @cursor.send(:kill_cursors) if @cursor && !@cursor.closed?
+          if @cursor
+            @cursor.close
+          end
         end
         alias :kill_cursors :close_query
 
         private
 
         def initial_query_op(server, session)
-          if server.features.find_command_enabled?
+          if server.with_connection { |connection| connection.features }.find_command_enabled?
             initial_command_op(session)
           else
+            # 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.
+            raise Error::UnsupportedOption.allow_disk_use_error if options.key?(:allow_disk_use)
             Operation::Find.new(Builder::OpQuery.new(self).specification)
           end
         end
@@ -86,7 +101,7 @@ module Mongo
 
         def send_initial_query(server, session = nil)
           validate_collation!(server, collation)
-          initial_query_op(server, session).execute(server)
+          initial_query_op(server, session).execute(server, client: client)
         end
       end
     end

data/lib/mongo/collection/view/map_reduce.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -225,7 +225,10 @@ module Mongo
         end
 
         def valid_server?(server)
-          server.standalone? || server.mongos? || server.primary? || secondary_ok?
+          description = server.with_connection do |connection|
+            connection.description
+          end
+          description.standalone? || description.mongos? || description.primary? || secondary_ok?
         end
 
         def secondary_ok?
@@ -239,7 +242,7 @@ module Mongo
             server = cluster.next_primary(nil, session)
           end
           validate_collation!(server)
-          initial_query_op(session).execute(server)
+          initial_query_op(session).execute(server, client: client)
         end
 
         def fetch_query_spec
@@ -251,7 +254,7 @@ module Mongo
         end
 
         def fetch_query_op(server, session)
-          if server.features.find_command_enabled?
+          if server.with_connection { |connection| connection.features }.find_command_enabled?
             Operation::Find.new(find_command_spec(session))
           else
             Operation::Find.new(fetch_query_spec)
@@ -259,11 +262,11 @@ module Mongo
         end
 
         def send_fetch_query(server, session)
-          fetch_query_op(server, session).execute(server)
+          fetch_query_op(server, session).execute(server, client: client)
         end
 
         def validate_collation!(server)
-          if (view.options[:collation] || options[:collation]) && !server.features.collation_enabled?
+          if (view.options[:collation] || options[:collation]) && !server.with_connection { |connection| connection.features }.collation_enabled?
             raise Error::UnsupportedCollation.new
           end
         end

data/lib/mongo/collection/view/readable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -48,6 +48,14 @@ module Mongo
           Aggregation.new(self, pipeline, options)
         end
 
+        # Allows the server to write temporary data to disk while executing
+        # a find operation.
+        #
+        # @return [ View ] The new view.
+        def allow_disk_use
+          configure(:allow_disk_use, true)
+        end
+
         # Allows the query to get partial results if some shards are down.
         #
         # @example Allow partial results.
@@ -155,7 +163,7 @@ module Mongo
                                      :options => {:limit => -1},
                                      :read => read_pref,
                                      :session => session
-              ).execute(server)
+              ).execute(server, client: client)
             end.n.to_i
           end
         end
@@ -222,7 +230,7 @@ module Mongo
                 db_name: database.name,
                 read: read_pref,
                 session: session
-              ).execute(server)
+              ).execute(server, client: client)
             end.n.to_i
           end
         end
@@ -267,7 +275,7 @@ module Mongo
                                         :options => {:limit => -1},
                                         :read => read_pref,
                                         :session => session
-                                       }).execute(server)
+                                       }).execute(server, client: client)
             end.first['values']
           end
         end
@@ -602,21 +610,21 @@ module Mongo
                   :read_concern => read_concern,
                   :session => session,
                 }.merge!(options))
-          cmd.execute(server).cursor_ids.map do |cursor_id|
-            result = if server.features.find_command_enabled?
+          cmd.execute(server, client: client).cursor_ids.map do |cursor_id|
+            result = if server.with_connection { |connection| connection.features }.find_command_enabled?
               Operation::GetMore.new({
                 :selector => {:getMore => BSON::Int64.new(cursor_id),
                              :collection => collection.name},
                 :db_name => database.name,
                 :session => session,
-              }).execute(server)
+              }).execute(server, client: client)
              else
               Operation::GetMore.new({
                 :to_return => 0,
                 :cursor_id => BSON::Int64.new(cursor_id),
                 :db_name => database.name,
                 :coll_name => collection.name
-              }).execute(server)
+              }).execute(server, client: client)
             end
             Cursor.new(self, result, server, session: session)
           end

data/lib/mongo/collection/view/writable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -39,10 +39,10 @@ module Mongo
         # @option opts [ Hash ] :projection The fields to include or exclude in the returned doc.
         # @option opts [ Hash ] :sort The key and direction pairs by which the result set
         #   will be sorted.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ BSON::Document, nil ] The document, if found.
         #
@@ -58,12 +58,14 @@ module Mongo
             cmd[:writeConcern] = applied_write_concern.options if applied_write_concern
             write_with_retry(session, applied_write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
+              apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))
+
               Operation::Command.new(
                   :selector => cmd,
                   :db_name => database.name,
                   :session => session,
                   :txn_num => txn_num
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end.first['value']
         end
@@ -83,9 +85,9 @@ module Mongo
         # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ BSON::Document ] The document.
         #
@@ -111,12 +113,12 @@ module Mongo
         # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
         # an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ BSON::Document ] The document.
         #
@@ -139,12 +141,14 @@ module Mongo
             write_with_retry(session, applied_write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
               apply_array_filters!(cmd, server, opts)
+              apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))
+
               Operation::Command.new(
                   :selector => cmd,
                   :db_name => database.name,
                   :session => session,
                   :txn_num => txn_num
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end.first['value']
           value unless value.nil? || value.empty?
@@ -159,6 +163,8 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ Result ] The response from the database.
         #
@@ -169,13 +175,15 @@ module Mongo
             write_concern = write_concern_with_session(session)
             nro_write_with_retry(session, write_concern) do |server|
               apply_collation!(delete_doc, server, opts)
+              apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Delete.new(
                   :deletes => [ delete_doc ],
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
                   :session => session
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end
         end
@@ -189,6 +197,8 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ Result ] The response from the database.
         #
@@ -199,6 +209,8 @@ module Mongo
             write_concern = write_concern_with_session(session)
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(delete_doc, server, opts)
+              apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Delete.new(
                   :deletes => [ delete_doc ],
                   :db_name => collection.database.name,
@@ -206,7 +218,7 @@ module Mongo
                   :write_concern => write_concern,
                   :session => session,
                   :txn_num => txn_num
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end
         end
@@ -225,6 +237,8 @@ module Mongo
         #   not to skip document level validation.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ Result ] The response from the database.
         #
@@ -234,13 +248,14 @@ module Mongo
                          Operation::U => replacement,
                         }
           if opts[:upsert]
-            update_doc[:upsert] = true
+            update_doc['upsert'] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
 
               Operation::Update.new(
                   :updates => [ update_doc ],
@@ -250,7 +265,7 @@ module Mongo
                   :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session,
                   :txn_num => txn_num
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end
         end
@@ -271,6 +286,8 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to
         #   which array elements an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ Result ] The response from the database.
         #
@@ -281,13 +298,15 @@ module Mongo
                          Operation::MULTI => true,
                          }
           if opts[:upsert]
-            update_doc[:upsert] = true
+            update_doc['upsert'] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
             nro_write_with_retry(session, write_concern) do |server|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Update.new(
                   :updates => [ update_doc ],
                   :db_name => collection.database.name,
@@ -295,7 +314,7 @@ module Mongo
                   :write_concern => write_concern,
                   :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end
         end
@@ -316,6 +335,8 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to
         #   which array elements an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ Result ] The response from the database.
         #
@@ -325,13 +346,14 @@ module Mongo
                          Operation::U => spec,
                          }
           if opts[:upsert]
-            update_doc[:upsert] = true
+            update_doc['upsert'] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
 
               Operation::Update.new(
                   :updates => [ update_doc ],
@@ -341,13 +363,35 @@ module Mongo
                   :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session,
                   :txn_num => txn_num
-              ).execute(server)
+              ).execute(server, client: client)
             end
           end
         end
 
         private
 
+        def apply_hint!(doc, server, opts)
+          if hint = opts[:hint]
+            features = server.with_connection do |connection|
+              connection.description.features
+            end
+
+            write_concern = opts[:write_concern]
+            if write_concern && !write_concern.acknowledged?
+              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+            end
+
+            if doc.key?(:findAndModify) &&
+                !features.find_and_modify_option_validation_enabled?
+              raise Error::UnsupportedOption.hint_error
+            elsif !features.update_delete_option_validation_enabled?
+              raise Error::UnsupportedOption.hint_error
+            end
+
+            doc[:hint] = opts[:hint]
+          end
+        end
+
         def apply_array_filters!(doc, server, opts = {})
           if filters = opts[:array_filters] || opts[ARRAY_FILTERS]
             validate_array_filters!(server, filters)
@@ -356,7 +400,7 @@ module Mongo
         end
 
         def validate_array_filters!(server, filters)
-          if filters && !server.features.array_filters_enabled?
+          if filters && !server.with_connection { |connection| connection.features }.array_filters_enabled?
             raise Error::UnsupportedArrayFilters.new
           end
         end