mongo 2.11.4 → 2.12.3

data/lib/mongo/database.rb

@@ -126,12 +126,18 @@ module Mongo
     #   information hash per collection, depends on the MongoDB server
     #   version that fulfills the request.
     #
+    # @param [ Hash ] options
+    #
+    # @option options [ Hash ] :filter A filter on the collections returned.
+    #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+    #   for more information and usage.
+    #
     # @return [ Array<Hash> ] Array of information hashes, one for each
     #   collection in the database.
     #
     # @since 2.0.5
-    def list_collections
-      View.new(self).list_collections
+    def list_collections(**options)
+      View.new(self).list_collections(**options)
     end
 
     # Get all the non-system collections that belong to this database.
@@ -156,9 +162,18 @@ module Mongo
     #
     # @option opts :read [ Hash ] The read preference for this command.
     # @option opts :session [ Session ] The session to use for this command.
+    # @option opts :execution_options [ Hash ] Options to pass to the code that
+    #   executes this command. This is an internal option and is subject to
+    #   change.
+    #   - :deserialize_as_bson [ Boolean ] Whether to deserialize the response
+    #     to this command using BSON types intead of native Ruby types wherever
+    #     possible.
     #
     # @return [ Mongo::Operation::Result ] The result of the command execution.
     def command(operation, opts = {})
+      opts = opts.dup
+      execution_opts = opts.delete(:execution_options) || {}
+
       txn_read_pref = if opts[:session] && opts[:session].in_transaction?
         opts[:session].txn_read_preference
       else
@@ -170,12 +185,14 @@ module Mongo
 
       client.send(:with_session, opts) do |session|
         server = selector.select_server(cluster, nil, session)
-        Operation::Command.new({
+        op = Operation::Command.new(
           :selector => operation.dup,
           :db_name => name,
           :read => selector,
           :session => session
-        }).execute(server)
+        )
+
+        op.execute(server, client: client, options: execution_opts)
       end
     end
 
@@ -206,7 +223,7 @@ module Mongo
             :db_name => name,
             :read => preference,
             :session => session
-          }).execute(server)
+          }).execute(server, client: client)
         end
       end
     end
@@ -231,7 +248,7 @@ module Mongo
           db_name: name,
           write_concern: write_concern,
           session: session
-        }).execute(next_primary(nil, session))
+        }).execute(next_primary(nil, session), client: client)
       end
     end
 

data/lib/mongo/database/view.rb

@@ -78,12 +78,18 @@ module Mongo
       # @example Get info on each collection.
       #   database.list_collections
       #
+      # @param [ Hash ] options
+      #
+      # @option options [ Hash ] :filter A filter on the collections returned.
+      #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+      #   for more information and usage.
+      #
       # @return [ Array<Hash> ] Info for each collection in the database.
       #
       # @since 2.0.5
-      def list_collections
+      def list_collections(**options)
         session = client.send(:get_session)
-        collections_info(session, ServerSelector.primary)
+        collections_info(session, ServerSelector.primary, **options)
       end
 
       # Create the new database view.
@@ -157,7 +163,10 @@ module Mongo
             cursor: batch_size ? { batchSize: batch_size } : {} },
           db_name: @database.name,
           session: session
-        }.tap { |spec| spec[:selector][:nameOnly] = true if options[:name_only] }
+        }.tap do |spec|
+          spec[:selector][:nameOnly] = true if options[:name_only]
+          spec[:selector][:filter] = options[:filter] if options[:filter]
+        end
       end
 
       def initial_query_op(session, options = {})
@@ -165,7 +174,7 @@ module Mongo
       end
 
       def send_initial_query(server, session, options = {})
-        initial_query_op(session, options).execute(server)
+        initial_query_op(session, options).execute(server, client: client)
       end
     end
   end

data/lib/mongo/dbref.rb

@@ -100,8 +100,15 @@ module Mongo
       # @see http://bsonspec.org/#/specification
       #
       # @since 2.0.0
-      def from_bson(buffer)
-        decoded = super
+      def from_bson(buffer, **options)
+        # bson-ruby 4.8.0 changes #from_bson API to take **options.
+        # However older bsons fail if invoked with a plain super here,
+        # even if options are empty.
+        decoded = if options.empty?
+          super(buffer)
+        else
+          super
+        end
         if ref = decoded[COLLECTION]
           decoded = DBRef.new(ref, decoded[ID], decoded[DATABASE])
         end

data/lib/mongo/error.rb

@@ -152,6 +152,7 @@ require 'mongo/error/change_stream_resumable'
 require 'mongo/error/bulk_write_error'
 require 'mongo/error/closed_stream'
 require 'mongo/error/connection_check_out_timeout'
+require 'mongo/error/crypt_error'
 require 'mongo/error/extra_file_chunk'
 require 'mongo/error/file_not_found'
 require 'mongo/error/operation_failure'
@@ -159,6 +160,7 @@ require 'mongo/error/invalid_address'
 require 'mongo/error/invalid_bulk_operation'
 require 'mongo/error/invalid_bulk_operation_type'
 require 'mongo/error/invalid_collection_name'
+require 'mongo/error/invalid_cursor_operation'
 require 'mongo/error/invalid_database_name'
 require 'mongo/error/invalid_document'
 require 'mongo/error/invalid_file'
@@ -177,10 +179,12 @@ require 'mongo/error/invalid_update_document'
 require 'mongo/error/invalid_uri'
 require 'mongo/error/invalid_write_concern'
 require 'mongo/error/insufficient_iteration_count'
+require 'mongo/error/kms_error'
 require 'mongo/error/lint_error'
 require 'mongo/error/max_bson_size'
 require 'mongo/error/max_message_size'
 require 'mongo/error/mismatched_domain'
+require 'mongo/error/mongocryptd_spawn_error'
 require 'mongo/error/multi_index_drop'
 require 'mongo/error/need_primary_server'
 require 'mongo/error/no_server_available'
@@ -189,7 +193,7 @@ require 'mongo/error/session_ended'
 require 'mongo/error/pool_closed_error'
 require 'mongo/error/socket_error'
 require 'mongo/error/socket_timeout_error'
-require 'mongo/error/failed_stringprep_validation'
+require 'mongo/error/failed_string_prep_validation'
 require 'mongo/error/unchangeable_collection_option'
 require 'mongo/error/unexpected_chunk_length'
 require 'mongo/error/unexpected_response'

data/lib/mongo/error/bulk_write_error.rb

@@ -35,22 +35,24 @@ module Mongo
       # @since 2.0.0
       def initialize(result)
         @result = result
+        # Exception constructor behaves differently for a nil argument and
+        # for no argument. Avoid passing nil explicitly.
+        super(*[build_message])
       end
 
-      def to_s
-        messages = if errors = result['writeErrors']
-          frag = ': ' + errors[0..10].map do |error|
-            "#{error['errmsg']} (#{error['code']})"
-          end.join(', ')
-          if errors.length > 10
-            frag += '...'
-          else
-            frag
-          end
-        else
-          ''
-        end
-        "#{self.class}: #{messages}" + notes_tail
+      private
+
+      def build_message
+        errors = @result['writeErrors']
+        return nil unless errors
+
+        fragment = errors.first(10).map do |error|
+          "#{error['errmsg']} (#{error['code']})"
+        end.join(', ')
+
+        fragment += '...' if errors.length > 10
+
+        fragment
       end
     end
   end

data/lib/mongo/error/crypt_error.rb

@@ -0,0 +1,31 @@
+# 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
+
+    # An error related to client-side encryption.
+    class CryptError < Mongo::Error
+      # Create a new CryptError
+      #
+      # @param [ Integer | nil ] code The optional libmongocrypt error code
+      # @param [ String ] message The error message
+      def initialize(message, code: nil)
+        msg = message
+        msg += " (libmongocrypt error code #{code})" if code
+        super(msg)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_cursor_operation.rb

@@ -0,0 +1,27 @@
+# Copyright (C) 2019 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
+
+    # Exception raised when an unsupported operation is attempted on a cursor.
+    #
+    # Examples:
+    # - Attempting to iterate a regular cursor more than once.
+    # - Attempting to call try_next on a caching cursor after it had been
+    #   iterated completely the first time.
+    class InvalidCursorOperation < Error
+    end
+  end
+end

data/lib/mongo/error/kms_error.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
+
+    # A KMS-related error during client-side encryption.
+    class KmsError < CryptError
+    end
+  end
+end

data/lib/mongo/error/max_bson_size.rb

@@ -24,16 +24,27 @@ module Mongo
       # The message is constant.
       #
       # @since 2.0.0
-      MESSAGE = "Document exceeds allowed max BSON size.".freeze
+      MESSAGE = "The document exceeds maximum allowed BSON size".freeze
 
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
       #   Mongo::Error::MaxBSONSize.new(max)
       #
+      # @param [ String | Numeric ] max_size_or_msg The message to use or
+      #   the maximum size to insert into the predefined message. The
+      #   Numeric argument type is deprecated.
+      #
       # @since 2.0.0
-      def initialize(max_size = nil)
-        super(max_size ?  MESSAGE + " The max is #{max_size}." : MESSAGE)
+      def initialize(max_size_or_msg = nil)
+        if max_size_or_msg.is_a?(Numeric)
+          msg = "#{MESSAGE}. The maximum allowed size is #{max_size_or_msg}"
+        elsif max_size_or_msg
+          msg = max_size_or_msg
+        else
+          msg = MESSAGE
+        end
+        super(msg)
       end
     end
   end

data/lib/mongo/error/mongocryptd_spawn_error.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
+
+    # An error related to spawning mongocryptd for client-side encryption.
+    class MongocryptdSpawnError < CryptError
+    end
+  end
+end

data/lib/mongo/error/no_server_available.rb

@@ -32,9 +32,14 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(server_selector, cluster=nil, msg=nil)
-        msg ||= "No #{server_selector.name} server is available in cluster: #{cluster.summary} " +
-                "with timeout=#{server_selector.server_selection_timeout}, " +
-                "LT=#{server_selector.local_threshold}"
+        unless msg
+          msg = "No #{server_selector.name} server is available"
+          if cluster
+            msg += " in cluster: #{cluster.summary}"
+          end
+          msg += " with timeout=#{server_selector.server_selection_timeout}, " +
+            "LT=#{server_selector.local_threshold}"
+        end
 
         super(msg)
       end

data/lib/mongo/error/notable.rb

@@ -45,26 +45,11 @@ module Mongo
         @notes << note
       end
 
-      # @api public
-      def message
-        super + notes_tail
-      end
-
       # @api public
       def to_s
         super + notes_tail
       end
 
-      # @api public
-      def inspect
-        msg = super
-        if msg.end_with?('>')
-          msg[0...msg.length-1] + notes_tail + '>'
-        else
-          msg + notes_tail
-        end
-      end
-
       private
 
       # @api private

data/lib/mongo/error/operation_failure.rb

@@ -39,6 +39,7 @@ module Mongo
         {:code_name => 'HostUnreachable', :code => 6},
         {:code_name => 'NetworkTimeout', :code => 89},
         {:code_name => 'SocketException', :code => 9001},
+        {:code_name => 'ExceededTimeLimit', :code => 262}
       ].freeze
 
       # These are magic error messages that could indicate a master change.

data/lib/mongo/error/parser.rb

@@ -76,7 +76,7 @@ module Mongo
       # examined because the status (ok: 1) is not part of the document and
       # there is no way to distinguish successful from failed responses using
       # the document itself, and a successful response may legitimately have
-      # {code: 123, codeName: 'foo'} as the contents of a user-inserted
+      # { code: 123, codeName: 'foo' } as the contents of a user-inserted
       # document. The legacy server versions do not fill out code nor codeName
       # thus not reading them does not lose information.
       #

data/lib/mongo/grid/file.rb

@@ -104,6 +104,11 @@ module Mongo
       #   chunk objects and assemble the data. If we have an IO object, then
       #   it's the original file data and we must split it into chunks and set
       #   the original data itself.
+      #
+      # @param [ IO, String, Array<BSON::Document> ] value The file object,
+      #   file contents or chunk documents.
+      #
+      # @return [ Array<Grid::File::Chunk> ] Array of chunks.
       def initialize_chunks!(value)
         if value.is_a?(Array)
           @chunks = value.map{ |doc| Chunk.new(doc) }

data/lib/mongo/grid/file/chunk.rb

@@ -151,6 +151,7 @@ module Mongo
           # @return [ String ] The assembled data.
           #
           # @since 2.0.0
+          # @api private
           def assemble(chunks)
             chunks.reduce(''){ |data, chunk| data << chunk.data.data }
           end
@@ -167,6 +168,7 @@ module Mongo
           # @return [ Array<Chunk> ] The chunks of the data.
           #
           # @since 2.0.0
+          # @api private
           def split(io, file_info, offset = 0)
             io = StringIO.new(io) if io.is_a?(String)
             parts = Enumerator.new { |y| y << io.read(file_info.chunk_size) until io.eof? }

data/lib/mongo/grid/file/info.rb

@@ -204,7 +204,7 @@ module Mongo
         # @note This method is transitional and is provided for backwards compatibility.
         # It will be removed when md5 support is deprecated entirely.
         #
-        # @param [ String ] The bytes to use to update the digest.
+        # @param [ String ] bytes The bytes to use to update the digest.
         #
         # @return [ Digest::MD5 ] The md5 hash object.
         #
@@ -254,7 +254,8 @@ module Mongo
           BSON::Document.new(
             :_id => BSON::ObjectId.new,
             :chunkSize => Chunk::DEFAULT_SIZE,
-            :uploadDate => Time.now.utc,
+            # MongoDB stores times with millisecond precision
+            :uploadDate => Time.now.utc.round(3),
             :contentType => DEFAULT_CONTENT_TYPE
           )
         end