mongo 2.13.3 → 2.14.0.rc1

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

@@ -48,6 +48,8 @@ module Mongo
         #
         # @since 2.0.0
         def find_one_and_delete(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           cmd = { :findAndModify => collection.name, :query => filter, :remove => true }
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
@@ -127,6 +129,8 @@ module Mongo
         #
         # @since 2.0.0
         def find_one_and_update(document, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           cmd = { :findAndModify => collection.name, :query => filter }
           cmd[:update] = document
           cmd[:fields] = projection if projection
@@ -175,6 +179,8 @@ module Mongo
         #
         # @since 2.0.0
         def delete_many(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           delete_doc = { Operation::Q => filter, Operation::LIMIT => 0 }
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
@@ -191,7 +197,7 @@ module Mongo
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
-                  :bypass_document_validation => !!opts[:bypass_document_validation], 
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session
               ).execute(server, client: client)
             end
@@ -216,6 +222,8 @@ module Mongo
         #
         # @since 2.0.0
         def delete_one(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           delete_doc = { Operation::Q => filter, Operation::LIMIT => 1 }
           with_session(opts) do |session|
             write_concern = if opts[:write_concern]
@@ -263,6 +271,8 @@ module Mongo
         #
         # @since 2.0.0
         def replace_one(replacement, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => replacement,
                         }
@@ -319,6 +329,8 @@ module Mongo
         #
         # @since 2.0.0
         def update_many(spec, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
                          Operation::MULTI => true,
@@ -374,6 +386,8 @@ module Mongo
         #
         # @since 2.0.0
         def update_one(spec, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
                          }

data/lib/mongo/collection/view.rb

@@ -120,27 +120,31 @@ module Mongo
       #   server can write temporary data to disk while executing the find
       #   operation. This option is only available on MongoDB server versions
       #   4.4 and newer.
-      # @option options :comment [ String ] Associate a comment with the query.
-      # @option options :batch_size [ Integer ] The number of docs to return in
-      #   each response from MongoDB.
-      # @option options :projection [ Hash ] The fields to include or exclude in
-      #   returned docs.
-      # @option options :hint [ Hash ] Override default index selection and force
-      #   MongoDB to use a specific index for the query.
-      # @option options :limit [ Integer ] Max number of docs to return.
-      # @option options :max_scan [ Integer ] Constrain the query to only scan the
-      #   specified number of docs. Use to prevent queries from running too long.
-      #   Deprecated as of MongoDB server version 4.0.
-      # @option options :read [ Symbol ] The read preference to use for the query.
-      #   If none is provided, the collection's default read preference is used.
-      # @option options :show_disk_loc [ true, false ] Return disk location info as
-      #   a field in each doc.
-      # @option options :skip [ Integer ] The number of documents to skip.
-      # @option options :snapshot [ true, false ] Prevents returning a doc more than
-      #   once. Deprecated as of MongoDB server version 4.0.
-      # @option options :sort [ Hash ] The key and direction pairs used to sort the
-      #   results.
+      # @option options [ Integer ] :batch_size The number of documents to
+      #   return in each response from MongoDB.
       # @option options [ Hash ] :collation The collation to use.
+      # @option options [ String ] :comment Associate a comment with the query.
+      # @option options [ Hash ] :explain Execute an explain with the provided
+      #   explain options (known options are :verbose and :verbosity) rather
+      #   than a find.
+      # @option options [ Hash ] :hint Override the default index selection and
+      #   force MongoDB to use a specific index for the query.
+      # @option options [ Integer ] :limit Max number of documents to return.
+      # @option options [ Integer ] :max_scan Constrain the query to only scan
+      #   the specified number of documents. Use to prevent queries from
+      #   running for too long. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :projection The fields to include or exclude
+      #   in the returned documents.
+      # @option options [ Hash ] :read The read preference to use for the
+      #   query. If none is provided, the collection's default read preference
+      #   is used.
+      # @option options [ true | false ] :show_disk_loc Return disk location
+      #   info as a field in each doc.
+      # @option options [ Integer ] :skip The number of documents to skip.
+      # @option options [ true | false ] :snapshot Prevents returning a
+      #   document more than once. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :sort The key and direction pairs used to sort
+      #   the results.
       #
       # @since 2.0.0
       def initialize(collection, filter = {}, options = {})

data/lib/mongo/collection.rb

@@ -223,6 +223,7 @@ module Mongo
     # @param [ Hash ] opts The options for the create operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
@@ -239,6 +240,11 @@ module Mongo
       operation.delete(:write)
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          self.write_concern
+        end
         server = next_primary(nil, session)
         if (options[:collation] || options[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation
@@ -264,12 +270,19 @@ module Mongo
     # @param [ Hash ] opts The options for the drop operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
     def drop(opts = {})
       client.send(:with_session, opts) do |session|
+        temp_write_concern = write_concern
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          temp_write_concern
+        end
         Operation::Drop.new({
                               selector: { :drop => name },
                               db_name: database.name,
@@ -543,6 +556,8 @@ module Mongo
     #
     # @since 2.0.0
     def insert_one(document, opts = {})
+      QueryCache.clear_namespace(namespace)
+
       client.send(:with_session, opts) do |session|
         write_concern = if opts[:write_concern]
           WriteConcern.get(opts[:write_concern])
@@ -573,14 +588,14 @@ module Mongo
     # @param [ Array<Hash> ] documents The documents to insert.
     # @param [ Hash ] options The insert options.
     #
-    # @option options [ true | false ] :ordered Whether the operations
-    #   should be executed in order.
     # @option options [ Session ] :session The session to use for the operation.
     #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
     def insert_many(documents, options = {})
+      QueryCache.clear_namespace(namespace)
+
       inserts = documents.map{ |doc| { :insert_one => doc }}
       bulk_write(inserts, options)
     end
@@ -863,5 +878,14 @@ module Mongo
     def namespace
       "#{database.name}.#{name}"
     end
+
+    # Whether the collection is a system collection.
+    #
+    # @return [ Boolean ] Whether the system is a system collection.
+    #
+    # @api private
+    def system_collection?
+      name.start_with?('system.')
+    end
   end
 end

data/lib/mongo/crypt/encryption_io.rb

@@ -21,7 +21,7 @@ module Mongo
     # @api private
     class EncryptionIO
 
-      # Timeout used for SSL socket connection, reading, and writing.
+      # Timeout used for TLS socket connection, reading, and writing.
       # There is no specific timeout written in the spec. See SPEC-1394
       # for a discussion and updates on what this timeout should be.
       SOCKET_TIMEOUT = 10
@@ -236,10 +236,10 @@ module Mongo
         end
       end
 
-      # Provide an SSL socket to be used for KMS calls in a block API
+      # Provide a TLS socket to be used for KMS calls in a block API
       #
-      # @param [ String ] endpoint The URI at which to connect the SSL socket.
-      # @yieldparam [ OpenSSL::SSL::SSLSocket ] ssl_socket Yields an SSL socket
+      # @param [ String ] endpoint The URI at which to connect the TLS socket.
+      # @yieldparam [ OpenSSL::SSL::SSLSocket ] ssl_socket Yields a TLS socket
       #   connected to the specified endpoint.
       #
       # @raise [ Mongo::Error::KmsError ] If the socket times out or raises
@@ -277,7 +277,7 @@ module Mongo
               Timeout.timeout(
                 SOCKET_TIMEOUT,
                 Error::SocketTimeoutError,
-                'KMS SSL socket close timed out'
+                'KMS TLS socket close timed out'
               ) do
                 ssl_socket.sysclose
               end
@@ -285,7 +285,7 @@ module Mongo
             end
           end
         ensure
-          # Still close tcp socket manually in case ssl socket creation
+          # Still close tcp socket manually in case TLS socket creation
           # fails.
           begin
             Timeout.timeout(

data/lib/mongo/cursor.rb

@@ -138,6 +138,7 @@ module Mongo
     #
     # @since 2.0.0
     def each
+
       # If we already iterated past the first batch (i.e., called get_more
       # at least once), the cursor on the server side has advanced past
       # the first batch and restarting iteration from the beginning by

data/lib/mongo/database/view.rb

@@ -100,7 +100,7 @@ module Mongo
       #
       # @return [ Array<Hash> ] Info for each collection in the database.
       #
-      # @since 2.0.5
+      # @since 2.0.5 
       def list_collections(options = {})
         session = client.send(:get_session)
         collections_info(session, ServerSelector.primary, options)

data/lib/mongo/database.rb

@@ -263,6 +263,7 @@ module Mongo
     # @param [ Hash ] options The options for the operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
@@ -270,6 +271,11 @@ module Mongo
     def drop(options = {})
       operation = { :dropDatabase => 1 }
       client.send(:with_session, options) do |session|
+        write_concern = if options[:write_concern]
+          WriteConcern.get(options[:write_concern])
+        else
+          self.write_concern
+        end
         Operation::DropDatabase.new({
           selector: operation,
           db_name: name,
@@ -315,20 +321,8 @@ module Mongo
 
     # Get the Grid "filesystem" for this database.
     #
-    # @param [ Hash ] options The GridFS options.
-    #
-    # @option options [ String ] :bucket_name The prefix for the files and chunks
-    #   collections.
-    # @option options [ Integer ] :chunk_size Override the default chunk
-    #   size.
-    # @option options [ String ] :fs_name The prefix for the files and chunks
-    #   collections.
-    # @option options [ String ] :read The read preference.
-    # @option options [ Session ] :session The session to use.
-    # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
-    #   option.
-    # @option options [ Hash ] :write_concern The write concern options.
-    #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+    # @example Get the GridFS.
+    #   database.fs
     #
     # @return [ Grid::FSBucket ] The GridFS for the database.
     #

data/lib/mongo/error/invalid_read_concern.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 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
+  class Error
+
+    # Raised when an invalid read concern is provided.
+    class InvalidReadConcern < Error
+      # Instantiate the new exception.
+      def initialize(msg = nil)
+        super(msg || 'Invalid read concern option provided.' \
+              'The only valid key is :level, for which accepted values are' \
+              ':local, :majority, and :snapshot')
+      end
+    end
+  end
+end

data/lib/mongo/error/server_certificate_revoked.rb

@@ -0,0 +1,22 @@
+# Copyright (C) 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
+  class Error
+
+    # Server certificate has been revoked (determined via OCSP).
+    class ServerCertificateRevoked < Error
+    end
+  end
+end

data/lib/mongo/error/unsupported_option.rb

@@ -17,39 +17,39 @@ module Mongo
 
     # Raised if an unsupported option is specified for an operation.
     class UnsupportedOption < Error
-      # @api private
-      #
       # The error message provided when the user passes the hint option to
       # a write operation against a server that does not support the hint
       # option and does not provide option validation.
+      #
+      # @api private
       HINT_MESSAGE = "The MongoDB server handling this request does not support " \
         "the hint option on this command. The hint option is supported on update " \
         "commands on MongoDB server versions 4.2 and later and on findAndModify " \
         "and delete commands on MongoDB server versions 4.4 and later"
 
-      # @api private
-      #
       # The error message provided when the user passes the hint option to
       # an unacknowledged write operation.
+      #
+      # @api private
       UNACKNOWLEDGED_HINT_MESSAGE = "The hint option cannot be specified on " \
         "an unacknowledged write operation. Remove the hint option or perform " \
         "this operation with a write concern of at least { w: 1 }"
 
-      # @api private
-      #
       # The error message provided when the user passes the allow_disk_use
       # option to a find operation against a server that does not support the
       # allow_disk_use operation and does not provide option validation.
+      #
+      # @api private
       ALLOW_DISK_USE_MESSAGE = "The MongoDB server handling this request does " \
         "not support the allow_disk_use option on this command. The " \
         "allow_disk_use option is supported on find commands on MongoDB " \
         "server versions 4.4 and later"
 
-      # @api private
-      #
       # The error message provided when the user passes the commit_quorum option
       # to a createIndexes operation against a server that does not support
       # that option.
+      #
+      # @api private
       COMMIT_QUORUM_MESSAGE = "The MongoDB server handling this request does " \
         "not support the commit_quorum option on this command. The commit_quorum " \
         "option is supported on createIndexes commands on MongoDB server versions " \
@@ -57,14 +57,14 @@ module Mongo
 
       # Raise an error about an unsupported hint option.
       #
-      # @param [ Hash ] options
-      #
       # @option options [ Boolean ] unacknowledged_write Whether this error
       #   pertains to a hint option passed to an unacknowledged write. Defaults
       #   to false.
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.hint_error(**options)
         unacknowledged_write = options[:unacknowledged_write] || false
 
@@ -79,10 +79,10 @@ module Mongo
 
       # Raise an error about an unsupported allow_disk_use option.
       #
-      # @param [ Hash ] options
-      #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.allow_disk_use_error
         new(ALLOW_DISK_USE_MESSAGE)
       end
@@ -91,6 +91,8 @@ module Mongo
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.commit_quorum_error
         new(COMMIT_QUORUM_MESSAGE)
       end

data/lib/mongo/error.rb

@@ -188,6 +188,7 @@ require 'mongo/error/invalid_min_pool_size'
 require 'mongo/error/invalid_read_option'
 require 'mongo/error/invalid_application_name'
 require 'mongo/error/invalid_nonce'
+require 'mongo/error/invalid_read_concern'
 require 'mongo/error/invalid_replacement_document'
 require 'mongo/error/invalid_server_auth_response'
 # Subclass of InvalidServerAuthResponse
@@ -215,6 +216,7 @@ require 'mongo/error/session_ended'
 require 'mongo/error/sessions_not_supported'
 require 'mongo/error/pool_closed_error'
 require 'mongo/error/raise_original_error'
+require 'mongo/error/server_certificate_revoked'
 require 'mongo/error/socket_error'
 require 'mongo/error/socket_timeout_error'
 require 'mongo/error/failed_string_prep_validation'

data/lib/mongo/grid/fs_bucket.rb

@@ -36,43 +36,6 @@ module Mongo
       # @since 2.1.0
       FILES_INDEX = { filename: 1, uploadDate: 1 }.freeze
 
-      # Create the GridFS.
-      #
-      # @example Create the GridFS.
-      #   Grid::FSBucket.new(database)
-      #
-      # @param [ Database ] database The database the files reside in.
-      # @param [ Hash ] options The GridFS options.
-      #
-      # @option options [ String ] :bucket_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ Integer ] :chunk_size Override the default chunk
-      #   size.
-      # @option options [ String ] :fs_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ String ] :read The read preference.
-      # @option options [ Session ] :session The session to use.
-      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
-      #   option.
-      # @option options [ Hash ] :write_concern The write concern options.
-      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
-      #
-      # @since 2.0.0
-      def initialize(database, options = {})
-        @database = database
-        @options = options.dup
-=begin WriteConcern object support
-        if @options[:write_concern].is_a?(WriteConcern::Base)
-          # Cache the instance so that we do not needlessly reconstruct it.
-          @write_concern = @options[:write_concern]
-          @options[:write_concern] = @write_concern.options
-        end
-=end
-        @options.freeze
-        @chunks_collection = database[chunks_name]
-        @files_collection = database[files_name]
-      end
-
       # @return [ Collection ] chunks_collection The chunks collection.
       #
       # @since 2.0.0
@@ -170,6 +133,43 @@ module Mongo
         file.id
       end
 
+      # Create the GridFS.
+      #
+      # @example Create the GridFS.
+      #   Grid::FSBucket.new(database)
+      #
+      # @param [ Database ] database The database the files reside in.
+      # @param [ Hash ] options The GridFS options.
+      #
+      # @option options [ String ] :fs_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ String ] :bucket_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ Integer ] :chunk_size Override the default chunk
+      #   size.
+      # @option options [ String ] :read The read preference.
+      # @option options [ Session ] :session The session to use.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+      #
+      # @since 2.0.0
+      def initialize(database, options = {})
+        @database = database
+        @options = options.dup
+=begin WriteConcern object support
+        if @options[:write_concern].is_a?(WriteConcern::Base)
+          # Cache the instance so that we do not needlessly reconstruct it.
+          @write_concern = @options[:write_concern]
+          @options[:write_concern] = @write_concern.options
+        end
+=end
+        @options.freeze
+        @chunks_collection = database[chunks_name]
+        @files_collection = database[files_name]
+      end
+
       # Get the prefix for the GridFS
       #
       # @example Get the prefix.

data/lib/mongo/lint.rb

@@ -4,12 +4,13 @@ module Mongo
   module Lint
 
     # Raises LintError if +obj+ is not of type +cls+.
-    module_function def assert_type(obj, cls)
+    def assert_type(obj, cls)
       return unless enabled?
       unless obj.is_a?(cls)
         raise Error::LintError, "Expected #{obj} to be a #{cls}"
       end
     end
+    module_function :assert_type
 
     def validate_underscore_read_preference(read_pref)
       return unless enabled?

data/lib/mongo/logger.rb

@@ -21,7 +21,7 @@ module Mongo
 
     class << self
 
-      # Get the wrapped logger. If none was set will return a default debug
+      # Get the wrapped logger. If none was set will return a default info
       # level logger.
       #
       # @example Get the wrapped logger.
@@ -75,8 +75,8 @@ module Mongo
       private
 
       def default_logger
-        logger = ::Logger.new($stdout)
-        logger.level = ::Logger::DEBUG
+        logger = ::Logger.new(STDOUT)
+        logger.level = ::Logger::INFO
         logger
       end
     end

data/lib/mongo/operation/aggregate/result.rb

@@ -14,25 +14,24 @@
 
 module Mongo
   module Operation
-
-    # Aggregate result wrapper.
-    #
-    # @since 2.0.0
     class Aggregate
 
       # Defines custom behavior of results in an aggregation context.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN = 'stages'.freeze
 
         # The legacy field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN_LEGACY = 'serverPipeline'.freeze
 
         # Get the cursor id for the result.
@@ -48,6 +47,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.0.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : 0
         end
@@ -62,8 +62,8 @@ module Mongo
         end
 
         # Get the documents for the aggregation result. This is either the
-        # first document's 'result' field, or if a cursor option was selected, 
-        # it is the 'firstBatch' field in the 'cursor' field of the first 
+        # first document's 'result' field, or if a cursor option was selected,
+        # it is the 'firstBatch' field in the 'cursor' field of the first
         # document returned. Otherwise, it is an explain document.
         #
         # @example Get the documents.
@@ -72,10 +72,11 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
-          docs = reply.documents[0][RESULT] 
+          docs = reply.documents[0][RESULT]
           docs ||= cursor_document[FIRST_BATCH] if cursor_document
-          docs ||= explain_document 
+          docs ||= explain_document
           docs
         end
 

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

@@ -27,11 +27,6 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
-          # This is a Mongo::Operation::CollectionsInfo::Result
-          Result.new(*dispatch_message(connection, client), db_name)
-        end
-
         def selector(connection)
           {}
         end