mongo 2.10.5 → 2.15.1

data/lib/mongo/database.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -104,6 +107,9 @@ module Mongo
     #
     # @since 2.0.0
     def [](collection_name, options = {})
+      if options[:server_api]
+        raise ArgumentError, 'The :server_api option cannot be specified for collection objects. It can only be specified on Client level'
+      end
       Collection.new(self, collection_name, options)
     end
     alias_method :collection, :[]
@@ -113,6 +119,16 @@ module Mongo
     # @note The set of returned collection names depends on the version of
     #   MongoDB server that fulfills the request.
     #
+    # @param [ Hash ] options
+    #
+    # @option options [ Hash ] :filter A filter on the collections returned.
+    # @option options [ true, false ] :authorized_collections A flag, when
+    #   set to true and used with nameOnly: true, that allows a user without the
+    #   required privilege to run the command when access control is enforced
+    #
+    #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+    #   for more information and usage.
+    #
     # @return [ Array<String> ] Names of the collections.
     #
     # @since 2.0.0
@@ -126,12 +142,25 @@ 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.
+    # @option options [ true, false ] :name_only Indicates whether command
+    #   should return just collection/view names and type or return both the
+    #   name and other information
+    # @option options [ true, false ] :authorized_collections A flag, when
+    #   set to true and used with nameOnly: true, that allows a user without the
+    #   required privilege to run the command when access control is enforced
+    #
+    #   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.
@@ -139,26 +168,45 @@ module Mongo
     # @note The set of returned collections depends on the version of
     #   MongoDB server that fulfills the request.
     #
+    # @param [ Hash ] options
+    #
+    # @option options [ Hash ] :filter A filter on the collections returned.
+    # @option options [ true, false ] :authorized_collections A flag, when
+    #   set to true and used with name_only: true, that allows a user without the
+    #   required privilege to run the command when access control is enforced
+    #
+    #   See https://docs.mongodb.com/manual/reference/command/listCollections/
+    #   for more information and usage.
+    #
     # @return [ Array<Mongo::Collection> ] The collections.
     #
     # @since 2.0.0
-    def collections
-      collection_names.map { |name| collection(name) }
+    def collections(options = {})
+      collection_names(options).map { |name| collection(name) }
     end
 
     # Execute a command on the database.
     #
     # @example Execute a command.
-    #   database.command(:ismaster => 1)
+    #   database.command(:hello => 1)
     #
     # @param [ Hash ] operation The command to execute.
     # @param [ Hash ] opts The command options.
     #
     # @option opts :read [ Hash ] The read preference for this command.
     # @option opts :session [ Session ] The session to use for this command.
-    #
-    # @return [ Hash ] The result of the command execution.
+    # @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 +218,16 @@ 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,
+          context: Operation::Context.new(client: client, session: session),
+          options: execution_opts)
       end
     end
 
@@ -206,7 +258,7 @@ module Mongo
             :db_name => name,
             :read => preference,
             :session => session
-          }).execute(server)
+          }).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
     end
@@ -219,6 +271,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.
     #
@@ -226,12 +279,17 @@ 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,
           write_concern: write_concern,
           session: session
-        }).execute(next_primary(nil, session))
+        }).execute(next_primary(nil, session), context: Operation::Context.new(client: client, session: session))
       end
     end
 
@@ -249,6 +307,9 @@ module Mongo
     # @since 2.0.0
     def initialize(client, name, options = {})
       raise Error::InvalidDatabaseName.new unless name
+      if Lint.enabled? && !(name.is_a?(String) || name.is_a?(Symbol))
+        raise "Database name must be a string or a symbol: #{name}"
+      end
       @client = client
       @name = name.to_s.freeze
       @options = options.freeze
@@ -268,8 +329,20 @@ module Mongo
 
     # Get the Grid "filesystem" for this database.
     #
-    # @example Get the GridFS.
-    #   database.fs
+    # @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.
     #
     # @return [ Grid::FSBucket ] The GridFS for the database.
     #

data/lib/mongo/dbref.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# 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.
@@ -100,8 +103,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/distinguishing_semaphore.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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
+  # This is a semaphore that distinguishes waits ending due to the timeout
+  # being reached from waits ending due to the semaphore being signaled.
+  #
+  # @api private
+  class DistinguishingSemaphore
+    def initialize
+      @lock = Mutex.new
+      @cv = ConditionVariable.new
+      @queue = []
+    end
+
+    # Waits for the semaphore to be signaled up to timeout seconds.
+    # If semaphore is not signaled, returns after timeout seconds.
+    #
+    # @return [ true | false ] true if semaphore was signaled, false if
+    #   timeout was reached.
+    def wait(timeout = nil)
+      @lock.synchronize do
+        @cv.wait(@lock, timeout)
+        (!@queue.empty?).tap do
+          @queue.clear
+        end
+      end
+    end
+
+    def broadcast
+      @lock.synchronize do
+        @queue.push(true)
+        @cv.broadcast
+      end
+    end
+
+    def signal
+      @lock.synchronize do
+        @queue.push(true)
+        @cv.signal
+      end
+    end
+  end
+end

data/lib/mongo/error/auth_error.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2018-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.
@@ -21,7 +24,7 @@ module Mongo
     # backwards compatibility reasons. It is subject to
     # change in future major versions of the driver.
     #
-    # @since 2.10.1
+    # @since 2.11.0
     class AuthError < RuntimeError
       include Notable
     end

data/lib/mongo/error/bulk_write_error.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -15,9 +18,19 @@
 module Mongo
   class Error
 
-    # Exception raised if there are write errors upon executing the bulk
+    # Exception raised if there are write errors upon executing a bulk
     # operation.
     #
+    # Unlike OperationFailure, BulkWriteError does not currently expose
+    # individual error components (such as the error code). The result document
+    # (which can be obtained using the +result+ attribute) provides detailed
+    # error information and can be examined by the application if desired.
+    #
+    # @note A bulk operation that resulted in a BulkWriteError may have
+    #   written some of the documents to the database. If the bulk write
+    #   was unordered, writes may have also continued past the write that
+    #   produced a BulkWriteError.
+    #
     # @since 2.0.0
     class BulkWriteError < Error
 
@@ -35,22 +48,28 @@ 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
-          ''
+      private
+
+      def build_message
+        errors = @result['writeErrors']
+        return nil unless errors
+
+        fragment = errors.first(10).map do |error|
+          "[#{error['code']}]: #{error['errmsg']}"
+        end.join('; ')
+
+        fragment += '...' if errors.length > 10
+
+        if errors.length > 1
+          fragment = "Multiple errors: #{fragment}"
         end
-        "#{self.class}: #{messages}" + notes_tail
+
+        fragment
       end
     end
   end

data/lib/mongo/error/change_stream_resumable.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2018-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/error/closed_stream.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/error/connection_check_out_timeout.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-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.
@@ -33,16 +36,15 @@ module Mongo
 
       # Instantiate the new exception.
       #
-      # @param [ Address ] address
-      # @param [ Float ] wait_timeout
+      # @option options [ Address ] :address
       #
-      # @since 2.9.0
       # @api private
-      def initialize(address, wait_timeout)
-        @address = address
-
-        super("Timed out when attempting to check out a connection from pool with address " +
-                "#{address} after #{wait_timeout} sec")
+      def initialize(msg, options)
+        super(msg)
+        @address = options[:address]
+        unless @address
+          raise ArgumentError, 'Address argument is required'
+        end
       end
     end
   end

data/lib/mongo/error/connection_perished.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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
+
+    # Exception raised when trying to perform operations on a connection that
+    # experienced a network error.
+    class ConnectionPerished < Error
+    end
+  end
+end

data/lib/mongo/error/credential_check_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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
+
+    # Credential check for MONGODB-AWS authentication mechanism failed.
+    #
+    # This exception is raised when the driver attempts to verify the
+    # credentials via STS prior to sending them to the server, and the
+    # verification fails due to an error response from the STS.
+    class CredentialCheckError < AuthError
+    end
+  end
+end

data/lib/mongo/error/crypt_error.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/extra_file_chunk.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/error/{failed_stringprep_validation.rb → failed_string_prep_validation.rb}

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongo
   class Error
     # This exception is raised when stringprep validation fails, such as due to

data/lib/mongo/error/file_not_found.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/error/handshake_error.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2018-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/error/insufficient_iteration_count.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/error/internal_driver_error.rb

@@ -0,0 +1,25 @@
+# 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
+  class Error
+
+    # Raised when the driver detects an internal implementation problem.
+    class InternalDriverError < Error
+    end
+  end
+end

data/lib/mongo/error/invalid_address.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-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 validation of addresses in URIs and SRV records fails.
+    #
+    # @since 2.11.0
+    class InvalidAddress < Error
+    end
+  end
+end

data/lib/mongo/error/invalid_application_name.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2016-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2016-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/error/invalid_bulk_operation.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/error/invalid_bulk_operation_type.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/error/invalid_collection_name.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.