mongo 2.13.0.beta1 → 2.13.0.rc1

data/lib/mongo/error.rb

@@ -210,6 +210,7 @@ require 'mongo/error/need_primary_server'
 require 'mongo/error/no_server_available'
 require 'mongo/error/no_srv_records'
 require 'mongo/error/session_ended'
+require 'mongo/error/sessions_not_supported'
 require 'mongo/error/pool_closed_error'
 require 'mongo/error/raise_original_error'
 require 'mongo/error/socket_error'

data/lib/mongo/error/invalid_session.rb

@@ -15,7 +15,8 @@
 module Mongo
   class Error
 
-    # This exception is raised when a session is attempted to be used and it is invalid.
+    # This exception is raised when a session is attempted to be used and it
+    # is invalid.
     #
     # @since 2.5.0
     class InvalidSession < Error

data/lib/mongo/error/operation_failure.rb

@@ -166,6 +166,12 @@ module Mongo
       # @since 2.6.0
       def change_stream_resumable?
         if @result && @result.is_a?(Mongo::Operation::GetMore::Result)
+          # CursorNotFound exceptions are always resumable because the server
+          # is not aware of the cursor id, and thus cannot determine if
+          # the cursor is a change stream and cannot add the
+          # ResumableChangeStreamError label.
+          return true if code == 43
+
           # Connection description is not populated for unacknowledged writes.
           if connection_description.max_wire_version >= 9
             label?('ResumableChangeStreamError')

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

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

@@ -50,7 +50,7 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          "#<#{short_class_name}" +
           " address=#{address} topology=#{topology.summary}>"
         end
       end

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

@@ -35,6 +35,13 @@ module Mongo
         #   description.
         attr_reader :new_description
 
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        #
+        # @api experimental
+        def awaited?
+          @awaited
+        end
+
         # Create the event.
         #
         # @example Create the event.
@@ -44,13 +51,19 @@ module Mongo
         # @param [ Integer ] topology The topology.
         # @param [ Server::Description ] previous_description The previous description.
         # @param [ Server::Description ] new_description The new description.
+        # @param [ true | false ] awaited Whether the server description was
+        #   a result of processing an awaited ismaster response.
         #
         # @since 2.4.0
-        def initialize(address, topology, previous_description, new_description)
+        # @api private
+        def initialize(address, topology, previous_description, new_description,
+          awaited: false
+        )
           @address = address
           @topology = topology
           @previous_description = previous_description
           @new_description = new_description
+          @awaited = !!awaited
         end
 
         # Returns a concise yet useful summary of the event.
@@ -62,10 +75,20 @@ module Mongo
         # @since 2.7.0
         # @api experimental
         def summary
-          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
-          " address=#{address} topology=#{topology.summary}" +
+          "#<#{short_class_name}" +
+          " address=#{address}" +
           # TODO Add summaries to descriptions and use them here
-          " prev=#{previous_description.inspect} new=#{new_description.inspect}>"
+          " prev=#{previous_description.server_type.upcase} new=#{new_description.server_type.upcase}#{awaited_indicator}>"
+        end
+
+        private
+
+        def awaited_indicator
+          if awaited?
+            ' [awaited]'
+          else
+            ''
+          end
         end
       end
     end