mongo 2.10.5 → 2.11.0.rc0

data/lib/mongo/error/notable.rb

@@ -18,7 +18,7 @@ module Mongo
     # A module encapsulating note tracking functionality, since currently
     # the driver does not have a single exception hierarchy root.
     #
-    # @since 2.10.1
+    # @since 2.11.0
     # @api private
     module Notable
 
@@ -27,7 +27,7 @@ module Mongo
       #
       # @return [ Array<String> ] Additional information strings.
       #
-      # @since 2.10.1
+      # @since 2.11.0
       # @api public
       def notes
         if @notes

data/lib/mongo/error/operation_failure.rb

@@ -80,15 +80,15 @@ module Mongo
       # @since 2.6.0
       attr_reader :code_name
 
-      # Whether the error is a retryable error according to the legacy
-      # read retry logic.
+      # Whether the error is a retryable error according to the legacy read retry
+      # logic.
       #
       # @return [ true, false ]
       #
       # @since 2.1.1
       # @deprecated
       def retryable?
-        write_retryable? || RETRY_MESSAGES.any?{ |m| message.include?(m) }
+        RETRY_MESSAGES.any?{ |m| message.include?(m) }
       end
 
       # Whether the error is a retryable error according to the modern retryable

data/lib/mongo/error/pool_closed_error.rb

@@ -26,17 +26,24 @@ module Mongo
       # @since 2.9.0
       attr_reader :address
 
+      # @return [ Mongo::Server::ConnectionPool ] pool The pool that is closed.
+      #
+      # @since 2.11.0
+      # @api experimental
+      attr_reader :pool
+
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
-      #   Mongo::Error::PoolClosedError.new(address)
+      #   Mongo::Error::PoolClosedError.new(address, pool)
       #
       # @since 2.9.0
       # @api private
-      def initialize(address)
+      def initialize(address, pool)
         @address = address
-
-        super("Attempted to use a connection pool which has been closed (for #{address})")
+        @pool = pool
+        super("Attempted to use a connection pool which has been closed (for #{address} " +
+            "with pool 0x#{pool.object_id})")
       end
     end
   end

data/lib/mongo/event.rb

@@ -36,6 +36,7 @@ module Mongo
     # When a server is to be removed from a cluster.
     #
     # @since 2.0.6
+    # @deprecated Will be removed in 3.0
     DESCRIPTION_CHANGED = 'description_changed'.freeze
   end
 end
@@ -44,4 +45,3 @@ require 'mongo/event/base'
 require 'mongo/event/listeners'
 require 'mongo/event/publisher'
 require 'mongo/event/subscriber'
-require 'mongo/event/description_changed'

data/lib/mongo/grid/file.rb

@@ -104,11 +104,6 @@ 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,7 +151,6 @@ 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
@@ -168,7 +167,6 @@ 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

@@ -177,7 +177,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.
@@ -230,8 +230,7 @@ module Mongo
       #
       # @since 2.1.0
       def open_download_stream(id, options = nil)
-        options = Hash[(options || {}).map { |k, v| [k.to_sym, v] }]
-        read_stream(id, **options).tap do |stream|
+        read_stream(id, options).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -349,15 +348,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 file or
-      # blob can be written.
+      # Opens an upload stream to GridFS to which the contents of a user file came be written.
       #
-      # @param [ String ] filename The name of the file in GridFS.
+      # @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 [ Hash ] opts The options for the write stream.
       #
-      # @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 [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise.
       # @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.
@@ -376,8 +375,7 @@ module Mongo
       #
       # @since 2.1.0
       def open_upload_stream(filename, opts = {})
-        opts = Hash[opts.map { |k, v| [k.to_sym, v] }]
-        write_stream(filename, **opts).tap do |stream|
+        write_stream(filename, opts).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -464,12 +462,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)
-        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts))
+      def read_stream(id, opts = nil)
+        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 }.update(options).update(opts))
+      def write_stream(filename, opts)
+        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.merge!(options).merge!(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 or a string.
+          # Write to the GridFS bucket from the source stream.
           #
           # @example Write to GridFS.
           #   stream.write(io)
           #
-          # @param [ String | IO ] io The string or IO object to upload from.
+          # @param [ IO ] io The source io stream to upload from.
           #
           # @return [ Stream::Write ] self The write stream itself.
           #
@@ -95,13 +95,7 @@ module Mongo
           def write(io)
             ensure_open!
             @indexes ||= ensure_indexes!
-            @length += if io.respond_to?(:bytesize)
-              # String objects
-              io.bytesize
-            else
-              # IO objects
-              io.size
-            end
+            @length += io.size
             chunks = File::Chunk.split(io, file_info, @n)
             @n += chunks.size
             chunks_collection.insert_many(chunks) unless chunks.empty?

data/lib/mongo/loggable.rb

@@ -99,7 +99,11 @@ module Mongo
     private
 
     def format_message(message)
-      format("%s | %s".freeze, PREFIX, message)
+      format("%s | %s".freeze, _mongo_log_prefix, message)
+    end
+
+    def _mongo_log_prefix
+      (options && options[:log_prefix]) || PREFIX
     end
   end
 end

data/lib/mongo/monitoring.rb

@@ -326,3 +326,4 @@ require 'mongo/monitoring/server_opening_log_subscriber'
 require 'mongo/monitoring/topology_changed_log_subscriber'
 require 'mongo/monitoring/topology_opening_log_subscriber'
 require 'mongo/monitoring/topology_closed_log_subscriber'
+require 'mongo/monitoring/unified_sdam_log_subscriber'

data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb

@@ -35,6 +35,13 @@ module Mongo
           # @since 2.9.0
           TIMEOUT = :timeout
 
+          # @return [ Symbol ] CONNECTION_ERROR Indicates that the connection
+          #   check out failed due to an error encountered while setting up a
+          #   new connection.
+          #
+          # @since 2.10.0
+          CONNECTION_ERROR = :connection_error
+
           # @return [ Mongo::Address ] address The address of the server the
           #   connection would have connected to.
           #

data/lib/mongo/monitoring/event/cmap/connection_checked_in.rb

@@ -32,16 +32,24 @@ module Mongo
           # @since 2.9.0
           attr_reader :connection_id
 
+          # @return [ Mongo::Server::ConnectionPool ] pool The pool that the connection
+          # was checked in to.
+          #
+          # @since 2.11.0
+          # @api experimental
+          attr_reader :pool
+
           # Create the event.
           #
           # @example Create the event.
-          #   ConnectionCheckedIn.new(address, id)
+          #   ConnectionCheckedIn.new(address, id, pool)
           #
           # @since 2.9.0
           # @api private
-          def initialize(address, id)
+          def initialize(address, id, pool)
             @address = address
             @connection_id = id
+            @pool = pool
           end
 
           # Returns a concise yet useful summary of the event.
@@ -54,7 +62,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} connection_id=#{connection_id}>"
+                "address=#{address} connection_id=#{connection_id} pool=0x#{pool.object_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/connection_checked_out.rb

@@ -33,16 +33,24 @@ module Mongo
           # @since 2.9.0
           attr_reader :connection_id
 
+          # @return [ Mongo::Server::ConnectionPool ] pool The pool that the connection
+          # was checked out from.
+          #
+          # @since 2.11.0
+          # @api experimental
+          attr_reader :pool
+
           # Create the event.
           #
           # @example Create the event.
-          #   ConnectionCheckedOut.new(address, id)
+          #   ConnectionCheckedOut.new(address, id, pool)
           #
           # @since 2.9.0
           # @api private
-          def initialize(address, id)
+          def initialize(address, id, pool)
             @address = address
             @connection_id = id
+            @pool = pool
           end
 
           # Returns a concise yet useful summary of the event.
@@ -55,7 +63,7 @@ module Mongo
           # @api experimental
           def summary
             "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
-                "address=#{address} connection_id=#{connection_id}>"
+                "address=#{address} connection_id=#{connection_id} pool=0x#{pool.object_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/pool_closed.rb

@@ -28,15 +28,22 @@ module Mongo
           # @since 2.9.0
           attr_reader :address
 
+          # @return [ Mongo::Server::ConnectionPool ] pool The pool that was closed.
+          #
+          # @since 2.11.0
+          # @api experimental
+          attr_reader :pool
+
           # Create the event.
           #
           # @example Create the event.
-          #   PoolClosed.new(address)
+          #   PoolClosed.new(address, pool)
           #
           # @since 2.9.0
           # @api private
-          def initialize(address)
+          def initialize(address, pool)
             @address = address
+            @pool = pool
           end
 
           # Returns a concise yet useful summary of the event.
@@ -48,7 +55,8 @@ module Mongo
           # @since 2.9.0
           # @api experimental
           def summary
-            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} address=#{address}>"
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} pool=0x#{pool.object_id}>"
           end
         end
       end

data/lib/mongo/monitoring/event/cmap/pool_created.rb

@@ -33,16 +33,24 @@ module Mongo
           # @since 2.9.0
           attr_reader :options
 
+          # @return [ Mongo::Server::ConnectionPool ] pool The pool that was just
+          # created.
+          #
+          # @since 2.11.0
+          # @api experimental
+          attr_reader :pool
+
           # Create the event.
           #
           # @example Create the event.
-          #   PoolCreated.new(address, options)
+          #   PoolCreated.new(address, options, pool)
           #
           # @since 2.9.0
           # @api private
-          def initialize(address, options)
+          def initialize(address, options, pool)
             @address = address
             @options = options.dup.freeze
+            @pool = pool
           end
 
           # Returns a concise yet useful summary of the event.
@@ -54,7 +62,8 @@ module Mongo
           # @since 2.9.0
           # @api experimental
           def summary
-            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} address=#{address} options=#{options}>"
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} options=#{options} pool=0x#{pool.object_id}>"
           end
         end
       end

data/lib/mongo/monitoring/unified_sdam_log_subscriber.rb

@@ -0,0 +1,62 @@
+# Copyright (C) 2019 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 Monitoring
+
+    # Subscribes to SDAM events and logs them.
+    #
+    # @since 2.11.0
+    # @api experimental
+    class UnifiedSdamLogSubscriber
+      include Loggable
+
+      # @return [ Hash ] options The options.
+      #
+      # @since 2.11.0
+      attr_reader :options
+
+      # Create the new log subscriber.
+      #
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ Logger ] :logger An optional custom logger.
+      #
+      # @since 2.11.0
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Handle an event.
+      #
+      # @param [ Event ] event The event.
+      #
+      # @since 2.11.0
+      def published(event)
+        log_debug("EVENT: #{event.summary}") if logger.debug?
+      end
+
+      alias :succeeded :published
+
+      def subscribe(client)
+        client.subscribe(Mongo::Monitoring::TOPOLOGY_OPENING, self)
+        client.subscribe(Mongo::Monitoring::SERVER_OPENING, self)
+        client.subscribe(Mongo::Monitoring::SERVER_DESCRIPTION_CHANGED, self)
+        client.subscribe(Mongo::Monitoring::TOPOLOGY_CHANGED, self)
+        client.subscribe(Mongo::Monitoring::SERVER_CLOSED, self)
+        client.subscribe(Mongo::Monitoring::TOPOLOGY_CLOSED, self)
+      end
+    end
+  end
+end