mongo 2.11.2 → 2.13.0.beta1

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.

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.

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.

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.
@@ -204,7 +204,7 @@ module Mongo
         # @note This method is transitional and is provided for backwards compatibility.
         # It will be removed when md5 support is deprecated entirely.
         #
-        # @param [ String ] The bytes to use to update the digest.
+        # @param [ String ] bytes The bytes to use to update the digest.
         #
         # @return [ Digest::MD5 ] The md5 hash object.
         #
@@ -254,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/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.
@@ -418,7 +420,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

data/lib/mongo/grid/stream.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/stream/read.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/stream/write.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/id.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2019  MongoDB, Inc.
+# Copyright (C) 2016-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/index.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.
@@ -49,6 +49,7 @@ module Mongo
     # Specify a geoHaystack index.
     #
     # @since 2.0.0
+    # @deprecated
     GEOHAYSTACK = 'geoHaystack'.freeze
 
     # Encodes a text index.

data/lib/mongo/index/view.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.
@@ -120,6 +120,10 @@ module Mongo
       #   a geo index.
       # @option options [ Hash ] :partial_filter_expression  Specify a filter for a partial
       #   index.
+      # @option options [ String | Integer ] :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.
       #
       # @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.
@@ -128,7 +132,10 @@ module Mongo
       #
       # @since 2.0.0
       def create_one(keys, options = {})
-        create_many({ key: keys }.merge(options))
+        options = options.dup
+
+        create_options = { commit_quorum: options.delete(:commit_quorum) }
+        create_many({ key: keys }.merge(options), create_options)
       end
 
       # Creates multiple indexes on the collection.
@@ -139,11 +146,23 @@ module Mongo
       #     { key: { age: -1 }, background: true }
       #   ])
       #
+      # @example Create multiple indexes with options.
+      #   view.create_many(
+      #     { key: { name: 1 }, unique: true },
+      #     { key: { age: -1 }, background: true },
+      #     { commit_quorum: 'majority' }
+      #   )
+      #
       # @note On MongoDB 3.0.0 and higher, the indexes will be created in
       #   parallel on the server.
       #
       # @param [ Array<Hash> ] models The index specifications. Each model MUST
-      #   include a :key option.
+      #   include a :key option, except for the last item in the Array, which
+      #   may be a Hash specifying options relevant to the createIndexes operation.
+      #   The following options are accepted:
+      #   - 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.
       #
       # @return [ Result ] The result of the command.
       #
@@ -151,14 +170,42 @@ module Mongo
       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
+
+          # 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
+          # the server would accept the commitQuorum option and use it internally
+          # (see SERVER-47193). As a result, the drivers specifications require
+          # drivers to perform validation and raise an error when the commitQuorum
+          # option is passed to servers that don't support it.
+          description = server.with_connection { |connection| connection.description }
+          if description.max_wire_version < 9 && options[:commit_quorum]
+            raise Error::UnsupportedOption.commit_quorum_error
+          end
+
+          indexes = normalize_models(models, server)
+          indexes.each do |index|
+            if index[:bucketSize] || index['bucketSize']
+              client.log_warn("Haystack indexes (bucketSize index option) are deprecated as of MongoDB 4.4")
+            end
+          end
+
           spec = {
-                  indexes: normalize_models(models.flatten, server),
-                  db_name: database.name,
-                  coll_name: collection.name,
-                  session: session
-                 }
-          spec[:write_concern] = write_concern if server.features.collation_enabled?
-          Operation::CreateIndex.new(spec).execute(server)
+            indexes: indexes,
+            db_name: database.name,
+            coll_name: collection.name,
+            session: session,
+            commit_quorum: options[:commit_quorum]
+           }
+
+          spec[:write_concern] = write_concern if description.features.collation_enabled?
+
+          Operation::CreateIndex.new(spec).execute(server, client: client)
         end
       end
 
@@ -235,8 +282,8 @@ module Mongo
                    session: session
                  }
           server = next_primary(nil, session)
-          spec[:write_concern] = write_concern if server.features.collation_enabled?
-          Operation::DropIndex.new(spec).execute(server)
+          spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled?
+          Operation::DropIndex.new(spec).execute(server, client: client)
         end
       end
 
@@ -272,7 +319,7 @@ module Mongo
       end
 
       def send_initial_query(server, session)
-        initial_query_op(session).execute(server)
+        initial_query_op(session).execute(server, client: client)
       end
 
       def with_generated_names(models, server)
@@ -286,7 +333,7 @@ module Mongo
 
       def validate_collation!(model, server)
         if (model[:collation] || model[Operation::COLLATION]) &&
-            !server.features.collation_enabled?
+            !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation.new
         end
       end

data/lib/mongo/lint.rb

@@ -1,6 +1,16 @@
 module Mongo
+
   # @api private
   module Lint
+
+    # Raises LintError if +obj+ is not of type +cls+.
+    module_function def assert_type(obj, cls)
+      return unless enabled?
+      unless obj.is_a?(cls)
+        raise Error::LintError, "Expected #{obj} to be a #{cls}"
+      end
+    end
+
     def validate_underscore_read_preference(read_pref)
       return unless enabled?
       return if read_pref.nil?

data/lib/mongo/loggable.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/logger.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/monitoring.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/monitoring/cmap_log_subscriber.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/monitoring/command_log_subscriber.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.
@@ -54,8 +54,11 @@ module Mongo
       # @since 2.1.0
       def started(event)
         if logger.debug?
-          log_debug("#{prefix(event, connection_id: event.connection_id)} | " +
-            "STARTED | #{format_command(event.command)}")
+          _prefix = prefix(event,
+            connection_generation: event.connection_generation,
+            connection_id: event.connection_id,
+          )
+          log_debug("#{_prefix} | STARTED | #{format_command(event.command)}")
         end
       end
 
@@ -97,8 +100,12 @@ module Mongo
         end
       end
 
-      def prefix(event, connection_id: nil)
-        "[#{event.request_id}] #{event.address.to_s}#{connection_id && " ##{connection_id}"} | " +
+      def prefix(event, connection_generation: nil, connection_id: nil)
+        extra = [connection_generation, connection_id].compact.join(':')
+        if extra == ''
+          extra = nil
+        end
+        "[#{event.request_id}] #{event.address.to_s}#{extra && " ##{extra}"} | " +
           "#{event.database_name}.#{event.command_name}"
       end