mongo 2.13.0.beta1 → 2.14.0

data/lib/mongo/error/unsupported_option.rb

@@ -17,39 +17,39 @@ module Mongo
 
     # 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.
+      #
+      # @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"
 
-      # @api private
-      #
       # 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 }"
 
-      # @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.
+      #
+      # @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"
 
-      # @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.
+      #
+      # @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 " \
@@ -57,14 +57,14 @@ module Mongo
 
       # 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.
+      #
+      # @api private
       def self.hint_error(**options)
         unacknowledged_write = options[:unacknowledged_write] || false
 
@@ -79,10 +79,10 @@ module Mongo
 
       # Raise an error about an unsupported allow_disk_use option.
       #
-      # @param [ Hash ] options
-      #
       # @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
@@ -91,6 +91,8 @@ module Mongo
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.commit_quorum_error
         new(COMMIT_QUORUM_MESSAGE)
       end

data/lib/mongo/event/base.rb

@@ -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/grid/file.rb

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

@@ -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/fs_bucket.rb

@@ -179,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.
@@ -232,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
@@ -350,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.
@@ -377,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
@@ -467,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

data/lib/mongo/grid/stream/write.rb

@@ -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/index/view.rb

@@ -120,6 +120,9 @@ 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

data/lib/mongo/lint.rb

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

data/lib/mongo/logger.rb

@@ -21,7 +21,7 @@ module Mongo
 
     class << self
 
-      # Get the wrapped logger. If none was set will return a default debug
+      # Get the wrapped logger. If none was set will return a default info
       # level logger.
       #
       # @example Get the wrapped logger.
@@ -75,8 +75,8 @@ module Mongo
       private
 
       def default_logger
-        logger = ::Logger.new($stdout)
-        logger.level = ::Logger::DEBUG
+        logger = ::Logger.new(STDOUT)
+        logger.level = ::Logger::INFO
         logger
       end
     end

data/lib/mongo/monitoring.rb

@@ -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/command_log_subscriber.rb

@@ -57,6 +57,7 @@ module Mongo
           _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
@@ -100,12 +101,19 @@ module Mongo
         end
       end
 
-      def prefix(event, connection_generation: nil, connection_id: nil)
+      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
-        "[#{event.request_id}] #{event.address.to_s}#{extra && " ##{extra}"} | " +
+        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/command_failed.rb

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

@@ -54,6 +54,9 @@ module Mongo
         # @api private
         attr_reader :connection_id
 
+        # @api private
+        attr_reader :server_connection_id
+
         # Create the new event.
         #
         # @example Create the event.
@@ -69,7 +72,7 @@ module Mongo
         # @api private
         def initialize(command_name, database_name, address, request_id,
           operation_id, command, socket_object_id: nil, connection_id: nil,
-          connection_generation: nil
+          connection_generation: nil, server_connection_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -80,6 +83,36 @@ module Mongo
           @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.
@@ -96,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, connection_generation: nil
+          socket_object_id: nil, connection_id: nil, connection_generation: nil,
+          server_connection_id: nil
         )
           new(
             payload[:command_name],
@@ -113,6 +147,7 @@ module Mongo
             socket_object_id: socket_object_id,
             connection_id: connection_id,
             connection_generation: connection_generation,
+            server_connection_id: server_connection_id,
           )
         end
 

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

@@ -67,6 +67,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.