RubyGems - mongo - Versions diffs - 2.12.4 → 2.13.0.beta1 - Mend

mongo 2.12.4 → 2.13.0.beta1

Files changed (817) hide show

data/lib/mongo/id.rb CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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,13 +170,41 @@ 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?
+            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,7 +282,7 @@ module Mongo
                    session: session
                  }
           server = next_primary(nil, session)
-          spec[:write_concern] = write_concern if server.features.collation_enabled?
+          spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled?
           Operation::DropIndex.new(spec).execute(server, client: client)
         end
       end
@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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 CHANGED

@@ -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

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

@@ -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/event/cmap.rb CHANGED

@@ -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/event/cmap/base.rb CHANGED

@@ -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/event/cmap/connection_check_out_failed.rb CHANGED

@@ -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/event/cmap/connection_check_out_started.rb CHANGED

@@ -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/event/cmap/connection_checked_in.rb CHANGED

@@ -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/event/cmap/connection_checked_out.rb CHANGED

@@ -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/event/cmap/connection_closed.rb CHANGED

@@ -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/event/cmap/connection_created.rb CHANGED

@@ -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/event/cmap/connection_ready.rb CHANGED

@@ -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/event/cmap/pool_cleared.rb CHANGED

@@ -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/event/cmap/pool_closed.rb CHANGED

@@ -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/event/cmap/pool_created.rb CHANGED

@@ -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/event/command_failed.rb CHANGED

@@ -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/event/command_started.rb CHANGED

@@ -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.
@@ -45,6 +45,9 @@ module Mongo
         # @api private
         attr_reader :socket_object_id
+        # @api private
+        attr_reader :connection_generation
         # @return [ Integer ] The ID for the connection over which the command
         #   is sent.
         #
@@ -65,7 +68,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def initialize(command_name, database_name, address, request_id,
-          operation_id, command, socket_object_id: nil, connection_id: nil
+          operation_id, command, socket_object_id: nil, connection_id: nil,
+          connection_generation: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -75,6 +79,7 @@ module Mongo
           @command = redacted(command_name, command)
           @socket_object_id = socket_object_id
           @connection_id = connection_id
+          @connection_generation = connection_generation
         end
         # Create the event from a wire protocol message payload.
@@ -91,7 +96,7 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload,
-          socket_object_id: nil, connection_id: nil
+          socket_object_id: nil, connection_id: nil, connection_generation: nil
         )
           new(
             payload[:command_name],
@@ -107,6 +112,7 @@ module Mongo
             payload[:command].merge('$db' => payload[:database_name]),
             socket_object_id: socket_object_id,
             connection_id: connection_id,
+            connection_generation: connection_generation,
           )
         end

data/lib/mongo/monitoring/event/command_succeeded.rb CHANGED

@@ -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/event/secure.rb CHANGED

@@ -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.
@@ -50,7 +50,13 @@ module Mongo
         #
         # @since 2.1.0
         def redacted(command_name, document)
-          REDACTED_COMMANDS.include?(command_name.to_s) ? BSON::Document.new : document
+          if REDACTED_COMMANDS.include?(command_name.to_s) &&
+            !%w(1 true yes).include?(ENV['MONGO_RUBY_DRIVER_UNREDACT_EVENTS']&.downcase)
+          then
+            BSON::Document.new
+          else
+            document
+          end
         end
         # Is compression allowed for a given command message.

data/lib/mongo/monitoring/event/server_closed.rb CHANGED

@@ -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/monitoring/event/server_description_changed.rb CHANGED

@@ -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/monitoring/event/server_heartbeat_failed.rb CHANGED

@@ -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/monitoring/event/server_heartbeat_started.rb CHANGED

@@ -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/monitoring/event/server_heartbeat_succeeded.rb CHANGED

@@ -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/monitoring/event/server_opening.rb CHANGED

@@ -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/monitoring/event/topology_changed.rb CHANGED

@@ -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/monitoring/event/topology_closed.rb CHANGED

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