mongo 2.14.1 → 2.15.0.alpha

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/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.
       #
@@ -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

data/lib/mongo/error/parser.rb

@@ -42,28 +42,53 @@ module Mongo
     # Class for parsing the various forms that errors can come in from MongoDB
     # command responses.
     #
+    # The errors can be reported by the server in a number of ways:
+    # - {ok:0} response indicates failure. In newer servers, code, codeName
+    #   and errmsg fields should be set. In older servers some may not be set.
+    # - {ok:1} response with a write concern error (writeConcernError top-level
+    #   field). This indicates that the node responding successfully executed
+    #   the request, but not enough other nodes successfully executed the
+    #   request to satisfy the write concern.
+    # - {ok:1} response with writeErrors top-level field. This can be obtained
+    #   in a bulk write but also in a non-bulk write. In a non-bulk write
+    #   there should be exactly one error in the writeErrors list.
+    #   The case of multiple errors is handled by BulkWrite::Result.
+    # - {ok:1} response with writeConcernErrors top-level field. This can
+    #   only be obtained in a bulk write and is handled by BulkWrite::Result,
+    #   not by this class.
+    #
+    # Note that writeErrors do not have codeName fields - they just provide
+    # codes and messages. writeConcernErrors may similarly not provide code
+    # names.
+    #
     # @since 2.0.0
+    # @api private
     class Parser
       include SdamErrorDetection
 
-      # @return [ BSON::Document ] document The returned document.
+      # @return [ BSON::Document ] The returned document.
       attr_reader :document
 
-      # @return [ String ] message The error message parsed from the document.
+      # @return [ String ] The full error message to be used in the
+      #   raised exception.
       attr_reader :message
 
-      # @return [ Array<Protocol::Message> ] replies The message replies.
+      # @return [ String ] The server-returned error message
+      #   parsed from the response.
+      attr_reader :server_message
+
+      # @return [ Array<Protocol::Message> ] The message replies.
       attr_reader :replies
 
-      # @return [ Integer ] code The error code parsed from the document.
+      # @return [ Integer ] The error code parsed from the document.
       # @since 2.6.0
       attr_reader :code
 
-      # @return [ String ] code_name The error code name parsed from the document.
+      # @return [ String ] The error code name parsed from the document.
       # @since 2.6.0
       attr_reader :code_name
 
-      # @return [ Array<String> ] labels The set of labels associated with the error.
+      # @return [ Array<String> ] The set of labels associated with the error.
       # @since 2.7.0
       attr_reader :labels
 
@@ -145,33 +170,61 @@ module Mongo
         write_concern_error_document && write_concern_error_document['errorLabels']
       end
 
+      class << self
+        def build_message(code: nil, code_name: nil, message: nil)
+          if code_name && code
+            "[#{code}:#{code_name}]: #{message}"
+          elsif code_name
+            # This surely should never happen, if there's a code name
+            # there ought to also be the code provided.
+            # Handle this case for completeness.
+            "[#{code_name}]: #{message}"
+          elsif code
+            "[#{code}]: #{message}"
+          else
+            message
+          end
+        end
+      end
+
       private
 
       def parse!
+        if document['ok'] != 1 && document['writeErrors']
+          raise ArgumentError, "writeErrors should only be given in successful responses"
+        end
+
         @message = ""
-        parse_single(@message, ERR)
-        parse_single(@message, ERROR)
-        parse_single(@message, ERRMSG)
+        parse_single(@message, '$err')
+        parse_single(@message, 'err')
+        parse_single(@message, 'errmsg')
         parse_multiple(@message, 'writeErrors')
         if write_concern_error_document
-          parse_single(@message, ERRMSG, write_concern_error_document)
+          parse_single(@message, 'errmsg', write_concern_error_document)
         end
         parse_flag(@message)
         parse_code
         parse_labels
         parse_wtimeout
+
+        @server_message = @message
+        @message = self.class.build_message(
+          code: code,
+          code_name: code_name,
+          message: @message,
+        )
       end
 
       def parse_single(message, key, doc = document)
         if error = doc[key]
-          append(message ,"#{error} (#{doc[CODE]})")
+          append(message, error)
         end
       end
 
       def parse_multiple(message, key)
         if errors = document[key]
           errors.each do |error|
-            parse_single(message, ERRMSG, error)
+            parse_single(message, 'errmsg', error)
           end
         end
       end

data/lib/mongo/error/server_api_conflict.rb

@@ -0,0 +1,23 @@
+# 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
+
+    # Exception raised when a Client has :server_api configured and an
+    # operation attempts to specify any of server API version parameters.
+    class ServerApiConflict < Error
+    end
+  end
+end

data/lib/mongo/error/server_api_not_supported.rb

@@ -0,0 +1,24 @@
+# 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
+
+    # Exception raised when a Client has :server_api configured and an
+    # operation is executed against a pre-3.6 MongoDB server using a legacy
+    # wire protocol message that does not permit sending API parameters.
+    class ServerApiNotSupported < Error
+    end
+  end
+end

data/lib/mongo/error/unmet_dependency.rb

@@ -0,0 +1,21 @@
+# 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 if an optional dependency of the driver is not met.
+    class UnmetDependency < Error; 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'
@@ -202,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'
@@ -214,6 +218,7 @@ 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'
@@ -227,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/index/view.rb

@@ -127,6 +127,7 @@ module Mongo
       #   data-bearing members of a replica set, including the primary, must
       #   complete the index builds successfully before the primary marks
       #   the indexes as ready.
+      # @option options [ Session ] :session The session to use for the operation.
       #
       # @note Note that the options listed may be subset of those available.
       # See the MongoDB documentation for a full list of supported options by server version.
@@ -137,7 +138,15 @@ module Mongo
       def create_one(keys, options = {})
         options = options.dup
 
-        create_options = { commit_quorum: options.delete(:commit_quorum) }
+        create_options = {}
+        if session = @options[:session]
+          create_options[:session] = session
+        end
+        %i(commit_quorum session).each do |key|
+          if value = options.delete(key)
+            create_options[key] = value
+          end
+        end
         create_many({ key: keys }.merge(options), create_options)
       end
 
@@ -166,19 +175,20 @@ module Mongo
       #   - commit_quorum: Specify how many data-bearing members of a replica set,
       #     including the primary, must complete the index builds successfully
       #     before the primary marks the indexes as ready.
+      #   - session: The session to use.
       #
       # @return [ Result ] The result of the command.
       #
       # @since 2.0.0
       def create_many(*models)
-        client.send(:with_session, @options) do |session|
-          server = next_primary(nil, session)
+        models = models.flatten
+        options = {}
+        if models && !models.last.key?(:key)
+          options = models.pop
+        end
 
-          models = models.flatten
-          options = {}
-          if models && !models.last.key?(:key)
-            options = models.pop
-          end
+        client.send(:with_session, @options.merge(options)) do |session|
+          server = next_primary(nil, session)
 
           # While server versions 3.4 and newer generally perform option
           # validation, there was a bug on server versions 4.2.0 - 4.2.5 where
@@ -208,7 +218,7 @@ module Mongo
 
           spec[:write_concern] = write_concern if description.features.collation_enabled?
 
-          Operation::CreateIndex.new(spec).execute(server, client: client)
+          Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
 
@@ -286,7 +296,7 @@ module Mongo
                  }
           server = next_primary(nil, session)
           spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled?
-          Operation::DropIndex.new(spec).execute(server, client: client)
+          Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
 
@@ -322,7 +332,7 @@ module Mongo
       end
 
       def send_initial_query(server, session)
-        initial_query_op(session).execute(server, client: client)
+        initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
       end
 
       def with_generated_names(models, server)

data/lib/mongo/monitoring/event/server_heartbeat_failed.rb

@@ -21,6 +21,29 @@ module Mongo
       # @since 2.7.0
       class ServerHeartbeatFailed < Mongo::Event::Base
 
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerHeartbeatSucceeded.new(address, duration)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @param [ Monitoring::Event::ServerHeartbeatStarted ] started_event
+        #   The corresponding started event.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(address, round_trip_time, error, awaited: false,
+          started_event:
+        )
+          @address = address
+          @round_trip_time = round_trip_time
+          @error = error
+          @awaited = !!awaited
+          @started_event = started_event
+        end
+
         # @return [ Address ] address The server address.
         attr_reader :address
 
@@ -41,23 +64,11 @@ module Mongo
           @awaited
         end
 
-        # Create the event.
-        #
-        # @example Create the event.
-        #   ServerHeartbeatSucceeded.new(address, duration)
-        #
-        # @param [ Address ] address The server address.
-        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
-        # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @return [ Monitoring::Event::ServerHeartbeatStarted ]
+        #   The corresponding started event.
         #
-        # @since 2.7.0
-        # @api private
-        def initialize(address, round_trip_time, error, awaited: false)
-          @address = address
-          @round_trip_time = round_trip_time
-          @error = error
-          @awaited = !!awaited
-        end
+        # @api experimental
+        attr_reader :started_event
 
         # Returns a concise yet useful summary of the event.
         #

data/lib/mongo/monitoring/event/server_heartbeat_succeeded.rb

@@ -21,20 +21,6 @@ module Mongo
       # @since 2.7.0
       class ServerHeartbeatSucceeded < Mongo::Event::Base
 
-        # @return [ Address ] address The server address.
-        attr_reader :address
-
-        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
-        attr_reader :round_trip_time
-
-        # Alias of round_trip_time.
-        alias :duration :round_trip_time
-
-        # @return [ true | false ] Whether the heartbeat was awaited.
-        def awaited?
-          @awaited
-        end
-
         # Create the event.
         #
         # @example Create the event.
@@ -43,15 +29,40 @@ module Mongo
         # @param [ Address ] address The server address.
         # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
         # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @param [ Monitoring::Event::ServerHeartbeatStarted ] started_event
+        #   The corresponding started event.
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time, awaited: false)
+        def initialize(address, round_trip_time, awaited: false,
+          started_event:
+        )
           @address = address
           @round_trip_time = round_trip_time
           @awaited = !!awaited
+          @started_event = started_event
         end
 
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
+        attr_reader :round_trip_time
+
+        # Alias of round_trip_time.
+        alias :duration :round_trip_time
+
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        def awaited?
+          @awaited
+        end
+
+        # @return [ Monitoring::Event::ServerHeartbeatStarted ]
+        #   The corresponding started event.
+        #
+        # @api experimental
+        attr_reader :started_event
+
         # Returns a concise yet useful summary of the event.
         #
         # @return [ String ] String summary of the event.

data/lib/mongo/monitoring.rb

@@ -307,9 +307,9 @@ module Mongo
     # @api private
     def publish_heartbeat(server, awaited: false)
       if monitoring?
-        event = Event::ServerHeartbeatStarted.new(
+        started_event = Event::ServerHeartbeatStarted.new(
           server.address, awaited: awaited)
-        started(SERVER_HEARTBEAT, event)
+        started(SERVER_HEARTBEAT, started_event)
       end
 
       # The duration we publish in heartbeat succeeded/failed events is
@@ -328,14 +328,23 @@ module Mongo
       rescue => exc
         if monitoring?
           event = Event::ServerHeartbeatFailed.new(
-            server.address, Time.now-start_time, exc, awaited: awaited)
+            server.address,
+            Time.now-start_time,
+            exc,
+            awaited: awaited,
+            started_event: started_event,
+          )
           failed(SERVER_HEARTBEAT, event)
         end
         raise
       else
         if monitoring?
           event = Event::ServerHeartbeatSucceeded.new(
-            server.address, Time.now-start_time, awaited: awaited)
+            server.address,
+            Time.now-start_time,
+            awaited: awaited,
+            started_event: started_event,
+          )
           succeeded(SERVER_HEARTBEAT, event)
         end
         result

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

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

data/lib/mongo/operation/collections_info.rb

@@ -25,7 +25,24 @@ module Mongo
     # @since 2.0.0
     class CollectionsInfo
       include Specifiable
-      include CollectionsInfoOrListCollections
+      include PolymorphicOperation
+      include PolymorphicLookup
+
+      private
+
+      def final_operation(connection)
+         op_class = if connection.features.list_collections_enabled?
+          if connection.features.op_msg_enabled?
+            ListCollections::OpMsg
+          else
+            ListCollections::Command
+          end
+        else
+          CollectionsInfo::Command
+        end
+
+        op_class.new(spec)
+      end
     end
   end
 end