mongo 2.12.1 → 2.13.0

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.
@@ -82,12 +82,12 @@ module Mongo
             @open = true
           end
 
-          # Write to the GridFS bucket from the source stream.
+          # Write to the GridFS bucket from the source stream or a string.
           #
           # @example Write to GridFS.
           #   stream.write(io)
           #
-          # @param [ IO ] io The source io stream to upload from.
+          # @param [ String | IO ] io The string or IO object to upload from.
           #
           # @return [ Stream::Write ] self The write stream itself.
           #
@@ -95,7 +95,13 @@ module Mongo
           def write(io)
             ensure_open!
             @indexes ||= ensure_indexes!
-            @length += io.size
+            @length += if io.respond_to?(:bytesize)
+              # String objects
+              io.bytesize
+            else
+              # IO objects
+              io.size
+            end
             chunks = File::Chunk.split(io, file_info, @n)
             @n += chunks.size
             chunks_collection.insert_many(chunks) unless chunks.empty?

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,13 @@ module Mongo
       #   a geo index.
       # @option options [ Hash ] :partial_filter_expression  Specify a filter for a partial
       #   index.
+      # @option options [ Boolean ] :hidden When :hidden is true, this index will
+      #   exist on the collection but not be used by the query planner when
+      #   executing operations.
+      # @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 +135,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 +149,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 +173,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 +285,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 +336,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.
@@ -304,6 +304,44 @@ module Mongo
       subscribers_for(topic).each{ |subscriber| subscriber.failed(event) }
     end
 
+    # @api private
+    def publish_heartbeat(server, awaited: false)
+      if monitoring?
+        event = Event::ServerHeartbeatStarted.new(
+          server.address, awaited: awaited)
+        started(SERVER_HEARTBEAT, event)
+      end
+
+      # The duration we publish in heartbeat succeeded/failed events is
+      # the time spent on the entire heartbeat. This could include time
+      # to connect the socket (including TLS handshake), not just time
+      # spent on ismaster call itself.
+      # The spec at https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring-monitoring.rst
+      # requires that the duration exposed here start from "sending the
+      # message" (ismaster). This requirement does not make sense if,
+      # for example, we were never able to connect to the server at all
+      # and thus ismaster was never sent.
+      start_time = Time.now
+
+      begin
+        result = yield
+      rescue => exc
+        if monitoring?
+          event = Event::ServerHeartbeatFailed.new(
+            server.address, Time.now-start_time, exc, awaited: awaited)
+          failed(SERVER_HEARTBEAT, event)
+        end
+        raise
+      else
+        if monitoring?
+          event = Event::ServerHeartbeatSucceeded.new(
+            server.address, Time.now-start_time, awaited: awaited)
+          succeeded(SERVER_HEARTBEAT, event)
+        end
+        result
+      end
+    end
+
     private
 
     def initialize_copy(original)

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,12 @@ 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,
+            server_connection_id: event.server_connection_id,
+          )
+          log_debug("#{_prefix} | STARTED | #{format_command(event.command)}")
         end
       end
 
@@ -97,8 +101,19 @@ 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,
+        server_connection_id: nil
+      )
+        extra = [connection_generation, connection_id].compact.join(':')
+        if extra == ''
+          extra = nil
+        else
+          extra = "conn:#{extra}"
+        end
+        if server_connection_id
+          extra += " sconn:#{server_connection_id}"
+        end
+        "#{event.address.to_s} req:#{event.request_id}#{extra && " #{extra}"} | " +
           "#{event.database_name}.#{event.command_name}"
       end
 

data/lib/mongo/monitoring/event.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/event/cmap.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/event/cmap/base.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/event/cmap/connection_check_out_failed.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/event/cmap/connection_check_out_started.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/event/cmap/connection_checked_in.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/event/cmap/connection_checked_out.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/event/cmap/connection_closed.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/event/cmap/connection_created.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/event/cmap/connection_ready.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/event/cmap/pool_cleared.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/event/cmap/pool_closed.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/event/cmap/pool_created.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/event/command_failed.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.
@@ -75,6 +75,17 @@ module Mongo
           @duration = duration
         end
 
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @api experimental
+        def summary
+          "#<#{short_class_name} address=#{address} #{database_name}.#{command_name}>"
+        end
+
         # Create the event from a wire protocol message payload.
         #
         # @example Create the event.

data/lib/mongo/monitoring/event/command_started.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.
@@ -45,12 +45,18 @@ 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.
         #
         # @api private
         attr_reader :connection_id
 
+        # @api private
+        attr_reader :server_connection_id
+
         # Create the new event.
         #
         # @example Create the event.
@@ -65,7 +71,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, server_connection_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -75,6 +82,37 @@ module Mongo
           @command = redacted(command_name, command)
           @socket_object_id = socket_object_id
           @connection_id = connection_id
+          @connection_generation = connection_generation
+          @server_connection_id = server_connection_id
+        end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @api experimental
+        def summary
+          "#<#{short_class_name} address=#{address} #{database_name}.#{command_name} command=#{command_summary}>"
+        end
+
+        # Returns the command, formatted as a string, with automatically added
+        # keys elided ($clusterTime, lsid, signature).
+        #
+        # @return [ String ] The command summary.
+        private def command_summary
+          command = self.command
+          remove_keys = %w($clusterTime lsid signature)
+          if remove_keys.any? { |k| command.key?(k) }
+            command = Hash[command.reject { |k, v| remove_keys.include?(k) }]
+            suffix = ' ...'
+          else
+            suffix = ''
+          end
+          command.map do |k, v|
+            "#{k}=#{v.inspect}"
+          end.join(' ') + suffix
         end
 
         # Create the event from a wire protocol message payload.
@@ -91,7 +129,8 @@ 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,
+          server_connection_id: nil
         )
           new(
             payload[:command_name],
@@ -107,6 +146,8 @@ module Mongo
             payload[:command].merge('$db' => payload[:database_name]),
             socket_object_id: socket_object_id,
             connection_id: connection_id,
+            connection_generation: connection_generation,
+            server_connection_id: server_connection_id,
           )
         end