mongo 2.4.1 → 2.14.0

data/lib/mongo/error/unsupported_message_type.rb

@@ -0,0 +1,23 @@
+# 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.
+# 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 trying to get a message type from the registry that doesn't exist.
+    #
+    # @since 2.5.0
+    class UnsupportedMessageType < Error; end
+  end
+end

data/lib/mongo/error/unsupported_option.rb

@@ -0,0 +1,101 @@
+# 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 unsupported option is specified for an operation.
+    class UnsupportedOption < Error
+      # The error message provided when the user passes the hint option to
+      # a write operation against a server that does not support the hint
+      # option and does not provide option validation.
+      #
+      # @api private
+      HINT_MESSAGE = "The MongoDB server handling this request does not support " \
+        "the hint option on this command. The hint option is supported on update " \
+        "commands on MongoDB server versions 4.2 and later and on findAndModify " \
+        "and delete commands on MongoDB server versions 4.4 and later"
+
+      # The error message provided when the user passes the hint option to
+      # an unacknowledged write operation.
+      #
+      # @api private
+      UNACKNOWLEDGED_HINT_MESSAGE = "The hint option cannot be specified on " \
+        "an unacknowledged write operation. Remove the hint option or perform " \
+        "this operation with a write concern of at least { w: 1 }"
+
+      # The error message provided when the user passes the allow_disk_use
+      # option to a find operation against a server that does not support the
+      # allow_disk_use operation and does not provide option validation.
+      #
+      # @api private
+      ALLOW_DISK_USE_MESSAGE = "The MongoDB server handling this request does " \
+        "not support the allow_disk_use option on this command. The " \
+        "allow_disk_use option is supported on find commands on MongoDB " \
+        "server versions 4.4 and later"
+
+      # The error message provided when the user passes the commit_quorum option
+      # to a createIndexes operation against a server that does not support
+      # that option.
+      #
+      # @api private
+      COMMIT_QUORUM_MESSAGE = "The MongoDB server handling this request does " \
+        "not support the commit_quorum option on this command. The commit_quorum " \
+        "option is supported on createIndexes commands on MongoDB server versions " \
+        "4.4 and later"
+
+      # Raise an error about an unsupported hint option.
+      #
+      # @option options [ Boolean ] unacknowledged_write Whether this error
+      #   pertains to a hint option passed to an unacknowledged write. Defaults
+      #   to false.
+      #
+      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
+      #   error message.
+      #
+      # @api private
+      def self.hint_error(**options)
+        unacknowledged_write = options[:unacknowledged_write] || false
+
+        error_message = if unacknowledged_write
+          UNACKNOWLEDGED_HINT_MESSAGE
+        else
+          HINT_MESSAGE
+        end
+
+        new(error_message)
+      end
+
+      # Raise an error about an unsupported allow_disk_use option.
+      #
+      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
+      #   error message.
+      #
+      # @api private
+      def self.allow_disk_use_error
+        new(ALLOW_DISK_USE_MESSAGE)
+      end
+
+      # Raise an error about an unsupported commit_quorum option.
+      #
+      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
+      #   error message.
+      #
+      # @api private
+      def self.commit_quorum_error
+        new(COMMIT_QUORUM_MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/write_retryable.rb

@@ -0,0 +1,27 @@
+# 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.
+# 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 signifying the error is always write retryable.
+    #
+    # @since 2.6.0
+    module WriteRetryable
+      def write_retryable?
+        true
+      end
+    end
+  end
+end

data/lib/mongo/error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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.
@@ -12,11 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/error/notable'
+
 module Mongo
   # Base error class for all Mongo related errors.
   #
   # @since 2.0.0
   class Error < StandardError
+    include Notable
 
     # The error code field.
     #
@@ -41,16 +44,19 @@ module Mongo
     # The constant for the writeErrors array.
     #
     # @since 2.0.0
+    # @deprecated
     WRITE_ERRORS = 'writeErrors'.freeze
 
     # The constant for a write concern error.
     #
     # @since 2.0.0
+    # @deprecated
     WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
 
     # The constant for write concern errors.
     #
     # @since 2.1.0
+    # @deprecated
     WRITE_CONCERN_ERRORS = 'writeConcernErrors'.freeze
 
     # Constant for an unknown error.
@@ -67,40 +73,163 @@ module Mongo
     #
     # @since 2.2.3
     CURSOR_NOT_FOUND = 'Cursor not found.'
+
+    # Can the change stream on which this error occurred be resumed,
+    # provided the operation that triggered this error was a getMore?
+    #
+    # @example Is the error resumable for the change stream?
+    #   error.change_stream_resumable?
+    #
+    # @return [ true, false ] Whether the error is resumable.
+    #
+    # @since 2.6.0
+    def change_stream_resumable?
+      false
+    end
+
+    # Error label describing commitTransaction errors that may or may not occur again if a commit is
+    # manually retried by the user.
+    #
+    # @since 2.6.0
+    # @deprecated
+    UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL = 'UnknownTransactionCommitResult'.freeze
+
+    # Error label describing errors that will likely not occur if a transaction is manually retried
+    # from the start.
+    #
+    # @since 2.6.0
+    # @deprecated
+    TRANSIENT_TRANSACTION_ERROR_LABEL = 'TransientTransactionError'.freeze
+
+    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.
+    #
+    # @return [ Boolean ] Whether the write concern error has the given label.
+    def write_concern_error_label?(label)
+      @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
 
+require 'mongo/error/auth_error'
+require 'mongo/error/sdam_error_detection'
 require 'mongo/error/parser'
+require 'mongo/error/write_retryable'
+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/connection_perished'
+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/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'
 require 'mongo/error/invalid_file_revision'
+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
+require 'mongo/error/invalid_server_auth_host'
 require 'mongo/error/invalid_server_preference'
+require 'mongo/error/invalid_session'
 require 'mongo/error/invalid_signature'
+require 'mongo/error/invalid_transaction_operation'
+require 'mongo/error/invalid_txt_record'
 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'
+require 'mongo/error/no_srv_records'
+require 'mongo/error/session_ended'
+require 'mongo/error/sessions_not_supported'
+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'
 require 'mongo/error/unchangeable_collection_option'
 require 'mongo/error/unexpected_chunk_length'
 require 'mongo/error/unexpected_response'
 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/unknown_payload_type'
+require 'mongo/error/unsupported_option'
+require 'mongo/error/unsupported_array_filters'
 require 'mongo/error/unsupported_collation'
 require 'mongo/error/unsupported_features'
+require 'mongo/error/unsupported_message_type'

data/lib/mongo/event/base.rb

@@ -0,0 +1,42 @@
+# 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.
+# 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
+  module Event
+
+    # Base class for all events.
+    #
+    # @since 2.6.0
+    class Base
+      # Returns a concise yet useful summary of the event.
+      # Meant to be overridden in derived classes.
+      #
+      # @return [ String ] String summary of the event.
+      #
+      # @note This method is experimental and subject to change.
+      #
+      # @since 2.7.0
+      # @api experimental
+      def summary
+        "#<#{self.class}>"
+      end
+
+      private
+
+      def short_class_name
+        self.class.name.sub(/^Mongo::Monitoring::Event::/, '')
+      end
+    end
+  end
+end

data/lib/mongo/event/listeners.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# 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.

data/lib/mongo/event/publisher.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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/event/subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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/event.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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.
@@ -12,37 +12,36 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/event/listeners'
-require 'mongo/event/publisher'
-require 'mongo/event/subscriber'
-require 'mongo/event/primary_elected'
-require 'mongo/event/member_discovered'
-require 'mongo/event/description_changed'
-require 'mongo/event/standalone_discovered'
-
 module Mongo
   module Event
 
     # When a standalone is discovered.
     #
     # @since 2.0.6
+    # @deprecated Will be removed in 3.0
     STANDALONE_DISCOVERED = 'standalone_discovered'.freeze
 
     # When a server is elected primary.
     #
     # @since 2.0.0
-    #
-    # @deprecated. Will be removed in 3.0
+    # @deprecated Will be removed in 3.0
     PRIMARY_ELECTED = 'primary_elected'.freeze
 
     # When a server is discovered to be a member of a topology.
     #
     # @since 2.4.0
+    # @deprecated Will be removed in 3.0
     MEMBER_DISCOVERED = 'member_discovered'.freeze
 
     # When a server is to be removed from a cluster.
     #
     # @since 2.0.6
+    # @deprecated Will be removed in 3.0
     DESCRIPTION_CHANGED = 'description_changed'.freeze
   end
 end
+
+require 'mongo/event/base'
+require 'mongo/event/listeners'
+require 'mongo/event/publisher'
+require 'mongo/event/subscriber'

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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.
@@ -12,13 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'stringio'
-
 module Mongo
   module Grid
     class File
 
-      # Encapsulates behaviour around GridFS chunks of file data.
+      # Encapsulates behavior around GridFS chunks of file data.
       #
       # @since 2.0.0
       class Chunk
@@ -153,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
@@ -169,15 +168,16 @@ 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? }
             parts.map.with_index do |bytes, n|
-              file_info.md5.update(bytes)
+              file_info.update_md5(bytes)
               Chunk.new(
                 data: BSON::Binary.new(bytes),
                 files_id: file_info.id,
-                n: n + offset,
+                n: n + offset
               )
             end
           end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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.
@@ -16,7 +16,7 @@ module Mongo
   module Grid
     class File
 
-      # Encapsulates behaviour around GridFS files collection file document.
+      # Encapsulates behavior around GridFS files collection file document.
       #
       # @since 2.0.0
       #
@@ -134,8 +134,14 @@ module Mongo
         #
         # @since 2.0.0
         def initialize(document)
+          @client_md5 = Digest::MD5.new unless document[:disable_md5] == true
+          # document contains a mix of user options and keys added
+          # internally by the driver, like session.
+          # Remove the keys that driver adds but keep user options.
+          document = document.reject do |key, value|
+            key.to_s == 'session'
+          end
           @document = default_document.merge(Options::Mapper.transform(document, MAPPINGS))
-          @client_md5 = Digest::MD5.new
         end
 
         # Get a readable inspection for the object.
@@ -184,10 +190,31 @@ module Mongo
         # @return [ String ] The md5 hash as a string.
         #
         # @since 2.0.0
+        #
+        # @deprecated as of 2.6.0
         def md5
           document[:md5] || @client_md5
         end
 
+        # Update the md5 hash if there is one.
+        #
+        # @example Update the md5 hash.
+        #   file_info.update_md5(bytes)
+        #
+        # @note This method is transitional and is provided for backwards compatibility.
+        # It will be removed when md5 support is deprecated entirely.
+        #
+        # @param [ String ] bytes The bytes to use to update the digest.
+        #
+        # @return [ Digest::MD5 ] The md5 hash object.
+        #
+        # @since 2.6.0
+        #
+        # @deprecated as of 2.6.0
+        def update_md5(bytes)
+          md5.update(bytes) if md5
+        end
+
         # Convert the file information document to BSON for storage.
         #
         # @note If no md5 exists in the file information document (it was loaded
@@ -203,7 +230,9 @@ module Mongo
         #
         # @since 2.0.0
         def to_bson(buffer = BSON::ByteBuffer.new, validating_keys = BSON::Config.validating_keys?)
-          document[:md5] ||= @client_md5.hexdigest
+          if @client_md5 && !document[:md5]
+            document[:md5] = @client_md5.hexdigest
+          end
           document.to_bson(buffer)
         end
 
@@ -225,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

data/lib/mongo/grid/file.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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 +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) }