mongo 2.13.0 → 2.15.0.alpha

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

@@ -69,12 +69,12 @@ module Mongo
       @view = view
       @server = server
       @initial_result = result
+      @namespace = result.namespace
       @remaining = limit if limited?
       @cursor_id = result.cursor_id
       if @cursor_id.nil?
         raise ArgumentError, 'Cursor id must be present in the result'
       end
-      @coll_name = nil
       @options = options
       @session = @options[:session]
       unless closed?
@@ -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
@@ -269,7 +270,7 @@ module Mongo
 
       unregister
       read_with_one_retry do
-        kill_cursors_operation.execute(@server, client: client)
+        kill_cursors_operation.execute(@server, context: Operation::Context.new(client: client, session: @session))
       end
 
       nil
@@ -287,7 +288,20 @@ module Mongo
     #
     # @since 2.2.0
     def collection_name
-      @coll_name || collection.name
+      # In most cases, this will be equivalent to the name of the collection
+      # object in the driver. However, in some cases (e.g. when connected
+      # to an Atlas Data Lake), the namespace returned by the find command
+      # may be different, which is why we want to use the collection name based
+      # on the namespace in the command result.
+      if @namespace
+        # Often, the namespace will be in the format "database.collection".
+        # However, sometimes the collection name will contain periods, which
+        # is why this method joins all the namespace components after the first.
+        ns_components = @namespace.split('.')
+        ns_components[1...ns_components.length].join('.')
+      else
+        collection.name
+      end
     end
 
     # Get the cursor id.
@@ -331,7 +345,7 @@ module Mongo
       # doing so may result in silent data loss, the driver no longer retries
       # getMore operations in any circumstance.
       # https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.rst#qa
-      process(get_more_operation.execute(@server, client: client))
+      process(get_more_operation.execute(@server, context: Operation::Context.new(client: client, session: @session)))
     end
 
     private
@@ -381,7 +395,6 @@ module Mongo
 
     def process(result)
       @remaining -= result.returned_count if limited?
-      @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
       # #process is called for the first batch of results. In this case
       # the @cursor_id may be zero (all results fit in the first batch).
       # Thus we need to check both @cursor_id and the cursor_id of the result

data/lib/mongo/database.rb

@@ -104,6 +104,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, :[]
@@ -219,7 +222,9 @@ module Mongo
           :session => session
         )
 
-        op.execute(server, client: client, options: execution_opts)
+        op.execute(server,
+          context: Operation::Context.new(client: client, session: session),
+          options: execution_opts)
       end
     end
 
@@ -250,7 +255,7 @@ module Mongo
             :db_name => name,
             :read => preference,
             :session => session
-          }).execute(server, client: client)
+          }).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
     end
@@ -263,6 +268,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,12 +276,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), client: client)
+        }).execute(next_primary(nil, session), context: Operation::Context.new(client: client, session: session))
       end
     end
 
@@ -315,8 +326,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/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)
@@ -189,7 +189,7 @@ module Mongo
       end
 
       def send_initial_query(server, session, options = {})
-        initial_query_op(session, options).execute(server, client: client)
+        initial_query_op(session, options).execute(server, context: Operation::Context.new(client: client, session: session))
       end
     end
   end

data/lib/mongo/error.rb

@@ -29,16 +29,19 @@ module Mongo
     # An error field, MongoDB < 2.6
     #
     # @since 2.0.0
+    # @deprecated
     ERR = '$err'.freeze
 
     # An error field, MongoDB < 2.4
     #
     # @since 2.0.0
+    # @deprecated
     ERROR = 'err'.freeze
 
     # The standard error message field, MongoDB 3.0+
     #
     # @since 2.0.0
+    # @deprecated
     ERRMSG = 'errmsg'.freeze
 
     # The constant for the writeErrors array.
@@ -174,7 +177,7 @@ require 'mongo/error/credential_check_error'
 require 'mongo/error/crypt_error'
 require 'mongo/error/extra_file_chunk'
 require 'mongo/error/file_not_found'
-require 'mongo/error/operation_failure'
+require 'mongo/error/handshake_error'
 require 'mongo/error/invalid_address'
 require 'mongo/error/invalid_bulk_operation'
 require 'mongo/error/invalid_bulk_operation_type'
@@ -188,6 +191,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
@@ -201,6 +205,7 @@ 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/internal_driver_error'
 require 'mongo/error/kms_error'
 require 'mongo/error/lint_error'
 require 'mongo/error/max_bson_size'
@@ -213,8 +218,10 @@ require 'mongo/error/no_server_available'
 require 'mongo/error/no_srv_records'
 require 'mongo/error/session_ended'
 require 'mongo/error/sessions_not_supported'
+require 'mongo/error/operation_failure'
 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'
@@ -225,7 +232,10 @@ require 'mongo/error/missing_file_chunk'
 require 'mongo/error/missing_password'
 require 'mongo/error/missing_resume_token'
 require 'mongo/error/missing_scram_server_signature'
+require 'mongo/error/server_api_conflict'
+require 'mongo/error/server_api_not_supported'
 require 'mongo/error/unknown_payload_type'
+require 'mongo/error/unmet_dependency'
 require 'mongo/error/unsupported_option'
 require 'mongo/error/unsupported_array_filters'
 require 'mongo/error/unsupported_collation'

data/lib/mongo/error/bulk_write_error.rb

@@ -15,9 +15,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
 
@@ -47,11 +57,15 @@ module Mongo
         return nil unless errors
 
         fragment = errors.first(10).map do |error|
-          "#{error['errmsg']} (#{error['code']})"
-        end.join(', ')
+          "[#{error['code']}]: #{error['errmsg']}"
+        end.join('; ')
 
         fragment += '...' if errors.length > 10
 
+        if errors.length > 1
+          fragment = "Multiple errors: #{fragment}"
+        end
+
         fragment
       end
     end

data/lib/mongo/error/internal_driver_error.rb

@@ -0,0 +1,22 @@
+# 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_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/operation_failure.rb

@@ -89,6 +89,12 @@ module Mongo
       # @since 2.6.0
       attr_reader :code_name
 
+      # @return [ String ] The server-returned error message
+      #   parsed from the response.
+      #
+      # @api experimental
+      attr_reader :server_message
+
       # Whether the error is a retryable error according to the legacy
       # read retry logic.
       #
@@ -97,7 +103,8 @@ module Mongo
       # @since 2.1.1
       # @deprecated
       def retryable?
-        write_retryable? || RETRY_MESSAGES.any?{ |m| message.include?(m) }
+        write_retryable? ||
+        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
       end
 
       # Whether the error is a retryable error according to the modern retryable
@@ -110,11 +117,11 @@ module Mongo
       #
       # @since 2.4.2
       def write_retryable?
-        WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) } ||
-        write_retryable_code?
+        write_retryable_code? ||
+        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
       end
 
-      def write_retryable_code?
+      private def write_retryable_code?
         if code
           WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
         else
@@ -122,7 +129,6 @@ module Mongo
           false
         end
       end
-      private :write_retryable_code?
 
       # Error codes and code names that should result in a failing getMore
       # command on a change stream NOT being resumed.
@@ -215,6 +221,11 @@ module Mongo
       # @since 2.10.0
       attr_reader :write_concern_error_code_name
 
+      # @return [ BSON::Document | nil ] The server-returned error document.
+      #
+      # @api experimental
+      attr_reader :document
+
       # Create the operation failure.
       #
       # @example Create the error object
@@ -229,6 +240,10 @@ module Mongo
       #
       # @option options [ Integer ] :code Error code.
       # @option options [ String ] :code_name Error code name.
+      # @option options [ BSON::Document ] :document The server-returned
+      #   error document.
+      # @option options [ String ] server_message The server-returned
+      #   error message parsed from the response.
       # @option options [ Hash ] :write_concern_error_document The
       #   server-supplied write concern error document, if any.
       # @option options [ Integer ] :write_concern_error_code Error code for
@@ -253,6 +268,8 @@ module Mongo
         @write_concern_error_labels = options[:write_concern_error_labels] || []
         @labels = options[:labels] || []
         @wtimeout = !!options[:wtimeout]
+        @document = options[:document]
+        @server_message = options[:server_message]
       end
 
       # Whether the error is a write concern timeout.
@@ -281,8 +298,10 @@ module Mongo
       #
       # @since 2.10.0
       def unsupported_retryable_write?
-        # code 20 is IllegalOperation
-        code == 20 && message.start_with?("Transaction numbers")
+        # code 20 is IllegalOperation.
+        # Note that the document is expected to be a BSON::Document, thus
+        # either having string keys or providing indifferent access.
+        code == 20 && server_message&.start_with?("Transaction numbers") || false
       end
     end
   end