mongo 2.12.1 → 2.13.0

data/lib/mongo/error/parser.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 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.
@@ -112,6 +112,15 @@ module Mongo
         !!write_concern_error_document
       end
 
+      # Returns the write concern error document as it was reported by the
+      # server, if any.
+      #
+      # @return [ Hash | nil ] Write concern error as reported to the server.
+      # @api experimental
+      def write_concern_error_document
+        document['writeConcernError']
+      end
+
       # @return [ Integer | nil ] The error code for the write concern error,
       #   if a write concern error is present and has a code.
       #
@@ -130,12 +139,14 @@ module Mongo
         write_concern_error_document && write_concern_error_document['codeName']
       end
 
-      private
-
-      def write_concern_error_document
-        document['writeConcernError']
+      # @return [ Array<String> | nil ] The error labels associated with this
+      # write concern error, if there is a write concern error present.
+      def write_concern_error_labels
+        write_concern_error_document && write_concern_error_document['errorLabels']
       end
 
+      private
+
       def parse!
         @message = ""
         parse_single(@message, ERR)

data/lib/mongo/error/pool_closed_error.rb

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

data/lib/mongo/error/raise_original_error.rb

@@ -0,0 +1,29 @@
+# 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
+
+    # This is a special marker exception class used internally in the
+    # retryable reads/writes implementation. Its purpose is to bypass
+    # note addition when raising the exception from the first read/write
+    # attempt.
+    #
+    # @note This class must not derive from Error.
+    #
+    # @api private
+    class RaiseOriginalError < Exception
+    end
+  end
+end

data/lib/mongo/error/session_ended.rb

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

data/lib/mongo/error/sessions_not_supported.rb

@@ -0,0 +1,35 @@
+# 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
+
+    # This exception is raised when a session is attempted to be used and the
+    # deployment does not support sessions.
+    #
+    # @note The subclassing of InvalidSession only exists for backwards
+    #   compatibility and will be removed in driver version 3.0.
+    class SessionsNotSupported < InvalidSession
+
+      # Create the new exception.
+      #
+      # @param [ String ] message The error message.
+      #
+      # @api private
+      def initialize(message)
+        super(message)
+      end
+    end
+  end
+end

data/lib/mongo/error/socket_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 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/error/socket_timeout_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 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/error/unchangeable_collection_option.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/error/unexpected_chunk_length.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/error/unexpected_response.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/error/unknown_payload_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-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/unsupported_array_filters.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -19,7 +19,12 @@ module Mongo
     # selected does not support array filters.
     #
     # @since 2.5.0
-    class UnsupportedArrayFilters < Error
+    #
+    # @deprecated RUBY-2260 In driver version 3.0, this error class will be 
+    #   replaced with UnsupportedOption. To handle this error, catch
+    #   Mongo::Error::UnsupportedOption, which will prevent any breaking changes
+    #   in your application when upgrading to version 3.0 of the driver.
+    class UnsupportedArrayFilters < UnsupportedOption
 
       # The default error message describing that array filters are not supported.
       #

data/lib/mongo/error/unsupported_collation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -19,7 +19,12 @@ module Mongo
     # support collations.
     #
     # @since 2.4.0
-    class UnsupportedCollation < Error
+    #
+    # @deprecated RUBY-2260 In driver version 3.0, this error class will be 
+    #   replaced with UnsupportedOption. To handle this error, catch
+    #   Mongo::Error::UnsupportedOption, which will prevent any breaking changes
+    #   in your application when upgrading to version 3.0 of the driver.
+    class UnsupportedCollation < UnsupportedOption
 
       # The default error message describing that collations is not supported.
       #

data/lib/mongo/error/unsupported_features.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/error/unsupported_message_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/error/unsupported_option.rb

@@ -0,0 +1,99 @@
+# 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
+      # @api private
+      #
+      # 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.
+      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"
+
+      # @api private
+      #
+      # The error message provided when the user passes the hint option to
+      # an unacknowledged write operation.
+      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 }"
+
+      # @api private
+      #
+      # 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.
+      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"
+
+      # @api private
+      #
+      # 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.
+      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.
+      #
+      # @param [ Hash ] options
+      #
+      # @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.
+      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.
+      #
+      # @param [ Hash ] options
+      #
+      # @return [ Mongo::Error::UnsupportedOption ] An error with a default
+      #   error message.
+      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.
+      def self.commit_quorum_error
+        new(COMMIT_QUORUM_MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/write_retryable.rb

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/base.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# 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.
@@ -31,6 +31,12 @@ module Mongo
       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-2019 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-2019 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-2019 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/grid.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/grid/file.rb

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

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -151,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
@@ -167,6 +168,7 @@ 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? }

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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/grid/fs_bucket.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 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.
@@ -70,6 +70,8 @@ module Mongo
       # @param [ Hash ] selector The selector to use in the find.
       # @param [ Hash ] options The options for the find.
       #
+      # @option options [ true, false ] :allow_disk_use Whether the server can
+      #   write temporary data to disk while executing the find operation.
       # @option options [ Integer ] :batch_size The number of documents returned in each batch
       #   of results from MongoDB.
       # @option options [ Integer ] :limit The max number of docs to return from the query.
@@ -177,7 +179,7 @@ module Mongo
       #
       # @since 2.0.0
       def prefix
-        @options[:fs_name] || @options[:bucket_name]|| DEFAULT_ROOT
+        @options[:fs_name] || @options[:bucket_name] || DEFAULT_ROOT
       end
 
       # Remove a single file from the GridFS.
@@ -230,7 +232,8 @@ module Mongo
       #
       # @since 2.1.0
       def open_download_stream(id, options = nil)
-        read_stream(id, options).tap do |stream|
+        options = Utils.shallow_symbolize_keys(options || {})
+        read_stream(id, **options).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -348,15 +351,15 @@ module Mongo
         download_to_stream(open_download_stream_by_name(filename, opts).file_id, io)
       end
 
-      # Opens an upload stream to GridFS to which the contents of a user file came be written.
+      # Opens an upload stream to GridFS to which the contents of a file or
+      # blob can be written.
       #
-      # @example Open a stream to which the contents of a file came be written.
-      #   fs.open_upload_stream('a-file.txt')
-      #
-      # @param [ String ] filename The filename of the file to upload.
+      # @param [ String ] filename The name of the file in GridFS.
       # @param [ Hash ] opts The options for the write stream.
       #
-      # @option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise.
+      # @option opts [ Object ] :file_id An optional unique file id.
+      #   A BSON::ObjectId is automatically generated if a file id is not
+      #   provided.
       # @option opts [ Integer ] :chunk_size Override the default chunk size.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
@@ -375,7 +378,8 @@ module Mongo
       #
       # @since 2.1.0
       def open_upload_stream(filename, opts = {})
-        write_stream(filename, opts).tap do |stream|
+        opts = Utils.shallow_symbolize_keys(opts)
+        write_stream(filename, **opts).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -418,7 +422,10 @@ module Mongo
         open_upload_stream(filename, opts) do |stream|
           begin
             stream.write(io)
-          rescue IOError
+          # IOError and SystemCallError are for errors reading the io.
+          # Error::SocketError and Error::SocketTimeoutError are for
+          # writing to MongoDB.
+          rescue IOError, SystemCallError, Error::SocketError, Error::SocketTimeoutError
             begin
               stream.abort
             rescue Error::OperationFailure
@@ -462,12 +469,12 @@ module Mongo
       #
       # @option opts [ BSON::Document ] :file_info_doc For internal
       #   driver use only. A BSON document to use as file information.
-      def read_stream(id, opts = nil)
-        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts || {}))
+      def read_stream(id, **opts)
+        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts))
       end
 
-      def write_stream(filename, opts)
-        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.merge!(options).merge!(opts))
+      def write_stream(filename, **opts)
+        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.update(options).update(opts))
       end
 
       def chunks_name