mongo 2.17.2 → 2.18.1

data/lib/mongo/error/invalid_update_document.rb

@@ -25,17 +25,37 @@ module Mongo
 
       # The error message.
       #
-      # @since 2.0.0
+      # @deprecated
       MESSAGE = 'Invalid update document provided'.freeze
 
-      # Instantiate the new exception.
+      # Construct the error message.
+      #
+      # @param [ String ] key The invalid key.
+      #
+      # @return [ String ] The error message.
       #
-      # @example Instantiate the exception.
-      #   Mongo::Error::InvalidUpdateDocument.new
+      # @api private
+      def self.message(key)
+        message = "Invalid update document provided. Updates documents must only "
+        message += "contain only atomic modifiers. The \"#{key}\" key is invalid."
+        message
+      end
+
+      # Send and cache the warning.
+      #
+      # @api private
+      def self.warn(logger, key)
+        @warned ||= begin
+          logger.warn(message(key))
+          true
+        end
+      end
+
+      # Instantiate the new exception.
       #
-      # @since 2.0.0
-      def initialize
-        super(MESSAGE)
+      # @param [ String ] :key The invalid key.
+      def initialize(key: nil)
+        super(self.class.message(key))
       end
     end
   end

data/lib/mongo/error/labelable.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2022 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 module encapsulating functionality to manage labels added to errors.
+    #
+    # @note Although methods of this module are part of the public API,
+    #   the fact that these methods are defined on this module and not on
+    #   the classes which include this module is not part of the public API.
+    #
+    # @api semipublic
+    module Labelable
+
+      # Does the error have the given label?
+      #
+      # @example
+      #   error.label?(label)
+      #
+      # @param [ String ] label The label to check if the error has.
+      #
+      # @return [ true, false ] Whether the error has the given label.
+      #
+      # @since 2.6.0
+      def label?(label)
+        @labels && @labels.include?(label)
+      end
+
+      # Gets the set of labels associated with the error.
+      #
+      # @example
+      #   error.labels
+      #
+      # @return [ Array ] The set of labels.
+      #
+      # @since 2.7.0
+      def labels
+        if @labels
+          @labels.dup
+        else
+          []
+        end
+      end
+
+      # Adds the specified label to the error instance, if the label is not
+      # already in the set of labels.
+      #
+      # @param [ String ] label The label to add.
+      #
+      # @api private
+      def add_label(label)
+        @labels ||= []
+        @labels << label unless label?(label)
+      end
+    end
+  end
+end

data/lib/mongo/error/missing_connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2022 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 check out connection that does not exist.
+    class MissingConnection < Error
+    end
+  end
+end

data/lib/mongo/error/missing_file_chunk.rb

@@ -30,11 +30,17 @@ module Mongo
       #   Mongo::Error::MissingFileChunk.new(expected_n, chunk)
       #
       # @param [ Integer ] expected_n The expected index value.
-      # @param [ Grid::File::Chunk ] chunk The chunk read from GridFS.
+      # @param [ Grid::File::Chunk | Integer ] chunk The chunk read from GridFS.
       #
       # @since 2.1.0
+      #
+      # @api private
       def initialize(expected_n, chunk)
-        super("Unexpected chunk in sequence. Expected next chunk to have index #{expected_n} but it has index #{chunk.n}")
+        if chunk.is_a?(Integer)
+          super("Missing chunk(s). Expected #{expected_n} chunks but got #{chunk}.")
+        else
+          super("Unexpected chunk in sequence. Expected next chunk to have index #{expected_n} but it has index #{chunk.n}")
+        end
       end
     end
   end

data/lib/mongo/error/notable.rb

@@ -70,6 +70,13 @@ module Mongo
       # @api experimental
       attr_accessor :service_id
 
+      # Returns global id of the connection on which the error occurred.
+      #
+      # @return [ Integer | nil ] Connection global id.
+      #
+      # @api private
+      attr_accessor :connection_global_id
+
       # @api public
       def to_s
         super + notes_tail

data/lib/mongo/error/operation_failure.rb

@@ -14,6 +14,7 @@
 # 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.
+require 'mongo/error/read_write_retryable'
 
 module Mongo
   class Error
@@ -24,53 +25,7 @@ module Mongo
     class OperationFailure < Error
       extend Forwardable
       include SdamErrorDetection
-
-      # Error codes and code names that should result in a failing write
-      # being retried.
-      #
-      # @since 2.6.0
-      # @api private
-      WRITE_RETRY_ERRORS = [
-        {:code_name => 'HostUnreachable', :code => 6},
-        {:code_name => 'HostNotFound', :code => 7},
-        {:code_name => 'NetworkTimeout', :code => 89},
-        {:code_name => 'ShutdownInProgress', :code => 91},
-        {:code_name => 'PrimarySteppedDown', :code => 189},
-        {:code_name => 'ExceededTimeLimit', :code => 262},
-        {:code_name => 'SocketException', :code => 9001},
-        {:code_name => 'NotMaster', :code => 10107},
-        {:code_name => 'InterruptedAtShutdown', :code => 11600},
-        {:code_name => 'InterruptedDueToReplStateChange', :code => 11602},
-        {:code_name => 'NotPrimaryNoSecondaryOk', :code => 13435},
-        {:code_name => 'NotMasterOrSecondary', :code => 13436},
-      ].freeze
-
-      # These are magic error messages that could indicate a master change.
-      #
-      # @since 2.4.2
-      # @api private
-      WRITE_RETRY_MESSAGES = [
-        'not master',
-        'node is recovering',
-      ].freeze
-
-      # These are magic error messages that could indicate a cluster
-      # reconfiguration behind a mongos.
-      #
-      # @since 2.1.1
-      # @api private
-      RETRY_MESSAGES = WRITE_RETRY_MESSAGES + [
-        'transport error',
-        'socket exception',
-        "can't connect",
-        'connect failed',
-        'error querying',
-        'could not get last error',
-        'connection attempt failed',
-        'interrupted at shutdown',
-        'unknown replica set',
-        'dbclient error communicating with server'
-      ].freeze
+      include ReadWriteRetryable
 
       def_delegators :@result, :operation_time
 
@@ -98,41 +53,6 @@ module Mongo
       # @api experimental
       attr_reader :server_message
 
-      # Whether the error is a retryable error according to the legacy
-      # read retry logic.
-      #
-      # @return [ true, false ]
-      #
-      # @since 2.1.1
-      # @deprecated
-      def retryable?
-        write_retryable? ||
-        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
-      end
-
-      # Whether the error is a retryable error according to the modern retryable
-      # reads and retryable writes specifications.
-      #
-      # This method is also used by the legacy retryable write logic to determine
-      # whether an error is a retryable one.
-      #
-      # @return [ true, false ]
-      #
-      # @since 2.4.2
-      def write_retryable?
-        write_retryable_code? ||
-        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
-      end
-
-      private def write_retryable_code?
-        if code
-          WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
-        else
-          # return false rather than nil
-          false
-        end
-      end
-
       # Error codes and code names that should result in a failing getMore
       # command on a change stream NOT being resumed.
       #
@@ -162,7 +82,7 @@ module Mongo
       #
       # @since 2.6.0
       # @api private
-      CHANGE_STREAM_RESUME_MESSAGES = WRITE_RETRY_MESSAGES
+      CHANGE_STREAM_RESUME_MESSAGES = ReadWriteRetryable::WRITE_RETRY_MESSAGES
 
       # Can the change stream on which this error occurred be resumed,
       # provided the operation that triggered this error was a getMore?
@@ -224,6 +144,12 @@ module Mongo
       # @since 2.10.0
       attr_reader :write_concern_error_code_name
 
+      # @return [ String | nil ] The details of the error.
+      #   For WriteConcernErrors this is `document['writeConcernError']['errInfo']`.
+      #   For WriteErrors this is `document['writeErrors'][0]['errInfo']`.
+      #   For all other errors this is nil.
+      attr_reader :details
+
       # @return [ BSON::Document | nil ] The server-returned error document.
       #
       # @api experimental
@@ -258,10 +184,10 @@ module Mongo
       # @option options [ Array<String> ] :labels The set of labels associated
       #   with the error.
       # @option options [ true | false ] :wtimeout Whether the error is a wtimeout.
-      #
-      # @since 2.5.0, options added in 2.6.0
       def initialize(message = nil, result = nil, options = {})
-        super(message)
+        @details = retrieve_details(options[:document])
+        super(append_details(message, @details))
+
         @result = result
         @code = options[:code]
         @code_name = options[:code_name]
@@ -306,6 +232,28 @@ module Mongo
         # either having string keys or providing indifferent access.
         code == 20 && server_message&.start_with?("Transaction numbers") || false
       end
+
+      private
+
+      # Retrieve the details from a document
+      #
+      # @return [ Hash | nil ] the details extracted from the document
+      def retrieve_details(document)
+        return nil unless document
+        if wce = document['writeConcernError']
+          return wce['errInfo']
+        elsif we = document['writeErrors']&.first
+          return we['errInfo']
+        end
+      end
+
+      # Append the details to the message
+      #
+      # @return [ String ] the message with the details appended to it
+      def append_details(message, details)
+        return message unless details && message
+        message + " -- #{details.to_json}"
+      end
     end
   end
 end

data/lib/mongo/error/read_write_retryable.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2022 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 module encapsulating functionality to indicate whether errors are
+    # retryable.
+    #
+    # @note Although methods of this module are part of the public API,
+    #   the fact that these methods are defined on this module and not on
+    #   the classes which include this module is not part of the public API.
+    #
+    # @api semipublic
+    module ReadWriteRetryable
+
+      # Error codes and code names that should result in a failing write
+      # being retried.
+      #
+      # @api private
+      WRITE_RETRY_ERRORS = [
+        {:code_name => 'HostUnreachable', :code => 6},
+        {:code_name => 'HostNotFound', :code => 7},
+        {:code_name => 'NetworkTimeout', :code => 89},
+        {:code_name => 'ShutdownInProgress', :code => 91},
+        {:code_name => 'PrimarySteppedDown', :code => 189},
+        {:code_name => 'ExceededTimeLimit', :code => 262},
+        {:code_name => 'SocketException', :code => 9001},
+        {:code_name => 'NotMaster', :code => 10107},
+        {:code_name => 'InterruptedAtShutdown', :code => 11600},
+        {:code_name => 'InterruptedDueToReplStateChange', :code => 11602},
+        {:code_name => 'NotPrimaryNoSecondaryOk', :code => 13435},
+        {:code_name => 'NotMasterOrSecondary', :code => 13436},
+      ].freeze
+
+      # These are magic error messages that could indicate a master change.
+      #
+      # @api private
+      WRITE_RETRY_MESSAGES = [
+        'not master',
+        'node is recovering',
+      ].freeze
+
+      # These are magic error messages that could indicate a cluster
+      # reconfiguration behind a mongos.
+      #
+      # @api private
+      RETRY_MESSAGES = WRITE_RETRY_MESSAGES + [
+        'transport error',
+        'socket exception',
+        "can't connect",
+        'connect failed',
+        'error querying',
+        'could not get last error',
+        'connection attempt failed',
+        'interrupted at shutdown',
+        'unknown replica set',
+        'dbclient error communicating with server'
+      ].freeze
+
+      # Whether the error is a retryable error according to the legacy
+      # read retry logic.
+      #
+      # @return [ true, false ]
+      #
+      # @deprecated
+      def retryable?
+        write_retryable? ||
+        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
+      end
+
+      # Whether the error is a retryable error according to the modern retryable
+      # reads and retryable writes specifications.
+      #
+      # This method is also used by the legacy retryable write logic to determine
+      # whether an error is a retryable one.
+      #
+      # @return [ true, false ]
+      def write_retryable?
+        write_retryable_code? ||
+        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
+      end
+
+      private def write_retryable_code?
+        if code
+          WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
+        else
+          # return false rather than nil
+          false
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{operation/kill_cursors/legacy.rb → error/session_not_materialized.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # encoding: utf-8
 
-# Copyright (C) 2014-2020 MongoDB Inc.
+# Copyright (C) 2022 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,26 +16,14 @@
 # limitations under the License.
 
 module Mongo
-  module Operation
-    class KillCursors
+  class Error
 
-      # A MongoDB killcursors operation sent as a legacy wire protocol message.
-      #
-      # @api private
-      #
-      # @since 2.5.2
-      class Legacy
-        include Specifiable
-        include Executable
-        include CommandBuilder
-
-        private
-
-        def message(connection)
-          Protocol::KillCursors.new(coll_name, db_name, int64_cursor_ids)
-        end
+    # This exception is raised when a session is attempted to be used but
+    # it was never materialized.
+    class SessionNotMaterialized < InvalidSession
+      def initialize
+        super("The session was not materialized and cannot be used. Use start_session or with_session in order to start a session that will be materialized.")
       end
     end
   end
 end
-

data/lib/mongo/error.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 
 require 'mongo/error/notable'
+require 'mongo/error/labelable'
 
 module Mongo
   # Base error class for all Mongo related errors.
@@ -23,6 +24,7 @@ module Mongo
   # @since 2.0.0
   class Error < StandardError
     include Notable
+    include Labelable
 
     # The error code field.
     #
@@ -109,24 +111,9 @@ module Mongo
 
     def initialize(msg = nil)
       super
-      @labels = []
       @write_concern_error_labels = []
     end
 
-    # Does the error have the given label?
-    #
-    # @example
-    #   error.label?(label)
-    #
-    # @param [ String ] label The label to check if the error has.
-    #
-    # @return [ true, false ] Whether the error has the given label.
-    #
-    # @since 2.6.0
-    def label?(label)
-      @labels.include?(label)
-    end
-
     # Does the write concern error have the given label?
     #
     # @param [ String ] label The label to check for the presence of.
@@ -136,34 +123,12 @@ module Mongo
       @write_concern_error_labels.include?(label)
     end
 
-    # Gets the set of labels associated with the error.
-    #
-    # @example
-    #   error.labels
-    #
-    # @return [ Array ] The set of labels.
-    #
-    # @since 2.7.0
-    def labels
-      @labels.dup
-    end
-
     # The set of error labels associated with the write concern error.
     #
     # @return [ Array<String> ] The list of error labels.
     def write_concern_error_labels
       @write_concern_error_labels.dup
     end
-
-    # Adds the specified label to the error instance, if the label is not
-    # already in the set of labels.
-    #
-    # @param [ String ] label The label to add.
-    #
-    # @api private
-    def add_label(label)
-      @labels << label unless label?(label)
-    end
   end
 end
 
@@ -186,6 +151,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_config_option'
 require 'mongo/error/invalid_cursor_operation'
 require 'mongo/error/invalid_database_name'
 require 'mongo/error/invalid_document'
@@ -223,6 +189,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/session_not_materialized'
 require 'mongo/error/snapshot_session_invalid_server_version'
 require 'mongo/error/snapshot_session_transaction_prohibited'
 require 'mongo/error/operation_failure'
@@ -235,6 +202,7 @@ require 'mongo/error/failed_string_prep_validation'
 require 'mongo/error/unchangeable_collection_option'
 require 'mongo/error/unexpected_chunk_length'
 require 'mongo/error/unexpected_response'
+require 'mongo/error/missing_connection'
 require 'mongo/error/missing_file_chunk'
 require 'mongo/error/missing_password'
 require 'mongo/error/missing_resume_token'

data/lib/mongo/grid/stream/read.rb

@@ -79,13 +79,19 @@ module Mongo
             ensure_readable!
             info = file_info
             num_chunks = (info.length + info.chunk_size - 1) / info.chunk_size
+            num_read = 0
             if block_given?
               view.each_with_index.reduce(0) do |length_read, (doc, index)|
                 chunk = Grid::File::Chunk.new(doc)
                 validate!(index, num_chunks, chunk, length_read)
                 data = chunk.data.data
                 yield data
+                num_read += 1
                 length_read += data.size
+              end.tap do
+                if num_read < num_chunks
+                  raise Error::MissingFileChunk.new(num_chunks, num_read)
+                end
               end
             else
               view.to_enum