mongo 2.8.0 → 2.9.0.rc0

data/lib/mongo/error/pool_closed_error.rb

@@ -0,0 +1,43 @@
+# 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 Error
+
+    # Exception raised if an operation is attempted on a closed connection pool.
+    #
+    # @since 2.9.0
+    class PoolClosedError < Error
+
+      # @return [ Mongo::Address ] address The address of the server the
+      # pool's connections connect to.
+      #
+      # @since 2.9.0
+      attr_reader :address
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::PoolClosedError.new(address)
+      #
+      # @since 2.9.0
+      # @api private
+      def initialize(address)
+        @address = address
+
+        super("Attempted to use a connection pool which has been closed (for #{address})")
+      end
+    end
+  end
+end

data/lib/mongo/error/sdam_error_detection.rb

@@ -14,6 +14,9 @@ module Mongo
       # @api private
       NODE_RECOVERING_CODES = [11600, 11602, 13436, 189, 91].freeze
 
+      # @api private
+      NODE_SHUTTING_DOWN_CODES = [11600, 91].freeze
+
       # Whether the error is a "not master" error, or one of its variants.
       #
       # See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.
@@ -49,6 +52,21 @@ module Mongo
           false
         end
       end
+
+      # Whether the error is a "node is shutting down" type error.
+      #
+      # See https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.
+      #
+      # @return [ true | false ] Whether the error is a node is shutting down.
+      #
+      # @since 2.9.0
+      def node_shutting_down?
+        if code && NODE_SHUTTING_DOWN_CODES.include?(code)
+          true
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/mongo/grid/file/chunk.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'stringio'
-
 module Mongo
   module Grid
     class File

data/lib/mongo/grid/fs_bucket.rb

@@ -147,6 +147,7 @@ module Mongo
       #   size.
       # @option options [ String ] :write The write concern.
       # @option options [ String ] :read The read preference.
+      # @option options [ Session ] :session The session to use.
       #
       # @since 2.0.0
       def initialize(database, options = {})
@@ -207,17 +208,24 @@ module Mongo
       #   fs.open_download_stream(id)
       #
       # @param [ BSON::ObjectId, Object ] id The id of the file to read.
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ BSON::Document ] :file_info_doc For internal
+      #   driver use only. A BSON document to use as file information.
       #
       # @return [ Stream::Read ] The stream to read from.
       #
       # @yieldparam [ Hash ] The read stream.
       #
       # @since 2.1.0
-      def open_download_stream(id)
-        read_stream(id).tap do |stream|
+      def open_download_stream(id, options = nil)
+        read_stream(id, options).tap do |stream|
           if block_given?
-            yield stream
-            stream.close
+            begin
+              yield stream
+            ensure
+              stream.close
+            end
           end
         end
       end
@@ -283,16 +291,15 @@ module Mongo
           skip = revision
           sort = { 'uploadDate' => Mongo::Index::ASCENDING }
         end
-        file_doc = files_collection.find({ filename: filename} ,
-                                           projection: { _id: 1 },
+        file_info_doc = files_collection.find({ filename: filename} ,
                                            sort: sort,
                                            skip: skip,
                                            limit: -1).first
-        unless file_doc
+        unless file_info_doc
           raise Error::FileNotFound.new(filename, :filename) unless opts[:revision]
           raise Error::InvalidFileRevision.new(filename, opts[:revision])
         end
-        open_download_stream(file_doc[:_id], &block)
+        open_download_stream(file_info_doc[:_id], file_info_doc: file_info_doc, &block)
       end
 
       # Downloads the contents of the stored file specified by filename and by the
@@ -356,8 +363,11 @@ module Mongo
       def open_upload_stream(filename, opts = {})
         write_stream(filename, opts).tap do |stream|
           if block_given?
-            yield stream
-            stream.close
+            begin
+              yield stream
+            ensure
+              stream.close
+            end
           end
         end
       end
@@ -428,8 +438,12 @@ module Mongo
 
       private
 
-      def read_stream(id)
-        Stream.get(self, Stream::READ_MODE, { file_id: id }.merge!(options))
+      # @param [ Hash ] opts The options.
+      #
+      # @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 || {}))
       end
 
       def write_stream(filename, opts)

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

@@ -46,11 +46,15 @@ module Mongo
           # @param [ FSBucket ] fs The GridFS bucket object.
           # @param [ Hash ] options The read stream options.
           #
+          # @option options [ BSON::Document ] :file_info_doc For internal
+          #   driver use only. A BSON document to use as file information.
+          #
           # @since 2.1.0
           def initialize(fs, options)
             @fs = fs
             @options = options.dup
             @file_id = @options.delete(:file_id)
+            @options.freeze
             @open = true
           end
 
@@ -70,15 +74,19 @@ module Mongo
           # @since 2.1.0
           def each
             ensure_readable!
-            num_chunks = (file_info.length + file_info.chunk_size - 1) / file_info.chunk_size
-            view.each_with_index.reduce(0) do |length_read, (doc, index)|
-              chunk = Grid::File::Chunk.new(doc)
-              validate!(index, num_chunks, chunk, length_read)
-              data = chunk.data.data
-              yield data
-              length_read += data.size
-            end if block_given?
-            view.to_enum
+            info = file_info
+            num_chunks = (info.length + info.chunk_size - 1) / info.chunk_size
+            if block_given?
+              view.each_with_index.reduce(0) do |length_read, (doc, index)|
+                chunk = Grid::File::Chunk.new(doc)
+                validate!(index, num_chunks, chunk, length_read)
+                data = chunk.data.data
+                yield data
+                length_read += data.size
+              end
+            else
+              view.to_enum
+            end
           end
 
           # Read all file data.
@@ -97,18 +105,19 @@ module Mongo
 
           # Close the read stream.
           #
+          # If the stream is already closed, this method does nothing.
+          #
           # @example Close the stream.
           #   stream.close
           #
           # @return [ BSON::ObjectId, Object ] The file id.
           #
-          # @raise [ Error::ClosedStream ] If the stream is already closed.
-          #
           # @since 2.1.0
           def close
-            ensure_open!
-            view.close_query
-            @open = false
+            if @open
+              view.close_query
+              @open = false
+            end
             file_id
           end
 
@@ -136,18 +145,24 @@ module Mongo
             @read_preference ||= options[:read] || fs.read_preference
           end
 
-          # Get the files collection file information document for the file being read.
+          # Get the files collection file information document for the file
+          # being read.
           #
-          # @example Get the file info document.
-          #   stream.file_info
+          # @note The file information is cached in the stream. Subsequent
+          #   calls to file_info will return the same information that the
+          #   first call returned, and will not query the database again.
           #
-          # @return [ Hash ] The file info document.
+          # @return [ File::Info ] The file information object.
           #
           # @since 2.1.0
           def file_info
-            doc = fs.files_collection.find(_id: file_id).first
-            if doc
-              @file_info ||= File::Info.new(Options::Mapper.transform(doc, File::Info::MAPPINGS.invert))
+            @file_info ||= begin
+              doc = options[:file_info_doc] || fs.files_collection.find(_id: file_id).first
+              if doc
+                File::Info.new(Options::Mapper.transform(doc, File::Info::MAPPINGS.invert))
+              else
+                nil
+              end
             end
           end
 

data/lib/mongo/index/view.rb

@@ -21,6 +21,7 @@ module Mongo
     class View
       extend Forwardable
       include Enumerable
+      include Retryable
 
       # @return [ Collection ] collection The indexes collection.
       attr_reader :collection
@@ -190,14 +191,17 @@ module Mongo
       #
       # @since 2.0.0
       def each(&block)
-        server = next_primary(false)
         session = client.send(:get_session, @options)
-        result = send_initial_query(server, session)
-        cursor = Cursor.new(self, result, server, session: session)
-        cursor.each do |doc|
-          yield doc
-        end if block_given?
-        cursor.to_enum
+        cursor = read_with_retry_cursor(session, ServerSelector.get(mode: :primary), self) do |server|
+          send_initial_query(server, session)
+        end
+        if block_given?
+          cursor.each do |doc|
+            yield doc
+          end
+        else
+          cursor.to_enum
+        end
       end
 
       # Create the new index view.

data/lib/mongo/logger.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'logger'
-
 module Mongo
 
   # Provides ability to log messages.

data/lib/mongo/monitoring.rb

@@ -25,6 +25,11 @@ module Mongo
     # @since 2.1.0
     COMMAND = 'Command'.freeze
 
+    # The connection pool topic.
+    #
+    # @since 2.9.0
+    CONNECTION_POOL = 'ConnectionPool'.freeze
+
     # Server closed topic.
     #
     # @since 2.4.0
@@ -218,6 +223,9 @@ module Mongo
           end
         end
         subscribe(COMMAND, CommandLogSubscriber.new(options))
+        # CMAP events are not logged by default because this will create
+        # log entries for every operation performed by the driver.
+        #subscribe(CONNECTION_POOL, CmapLogSubscriber.new(options))
         subscribe(SERVER_OPENING, ServerOpeningLogSubscriber.new(options))
         subscribe(SERVER_CLOSED, ServerClosedLogSubscriber.new(options))
         subscribe(SERVER_DESCRIPTION_CHANGED, ServerDescriptionChangedLogSubscriber.new(options))
@@ -235,8 +243,24 @@ module Mongo
       options[:monitoring] != false
     end
 
+    # Publish an event.
+    #
+    # This method is used for event types which only have a single event
+    # in them.
+    #
+    # @param [ String ] topic The event topic.
+    # @param [ Event ] event The event to publish.
+    #
+    # @since 2.9.0
+    def published(topic, event)
+      subscribers_for(topic).each{ |subscriber| subscriber.published(event) }
+    end
+
     # Publish a started event.
     #
+    # This method is used for event types which have the started/succeeded/failed
+    # events in them, such as command and heartbeat events.
+    #
     # @example Publish a started event.
     #   monitoring.started(COMMAND, event)
     #
@@ -250,6 +274,9 @@ module Mongo
 
     # Publish a succeeded event.
     #
+    # This method is used for event types which have the started/succeeded/failed
+    # events in them, such as command and heartbeat events.
+    #
     # @example Publish a succeeded event.
     #   monitoring.succeeded(COMMAND, event)
     #
@@ -263,6 +290,9 @@ module Mongo
 
     # Publish a failed event.
     #
+    # This method is used for event types which have the started/succeeded/failed
+    # events in them, such as command and heartbeat events.
+    #
     # @example Publish a failed event.
     #   monitoring.failed(COMMAND, event)
     #
@@ -288,6 +318,7 @@ end
 require 'mongo/monitoring/event'
 require 'mongo/monitoring/publishable'
 require 'mongo/monitoring/command_log_subscriber'
+require 'mongo/monitoring/cmap_log_subscriber'
 require 'mongo/monitoring/sdam_log_subscriber'
 require 'mongo/monitoring/server_description_changed_log_subscriber'
 require 'mongo/monitoring/server_closed_log_subscriber'

data/lib/mongo/monitoring/cmap_log_subscriber.rb

@@ -0,0 +1,53 @@
+# 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 CMAP events and logs them.
+    #
+    # @since 2.9.0
+    class CmapLogSubscriber
+      include Loggable
+
+      # @return [ Hash ] options The options.
+      #
+      # @since 2.9.0
+      attr_reader :options
+
+      # Create the new log subscriber.
+      #
+      # @example Create the log subscriber.
+      #   CmapLogSubscriber.new
+      #
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ Logger ] :logger An optional custom logger.
+      #
+      # @since 2.9.0
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Handle a CMAP event.
+      #
+      # @param [ Event ] event The event.
+      #
+      # @since 2.9.0
+      def published(event)
+        log_debug("EVENT: #{event.summary}") if logger.debug?
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event.rb

@@ -17,6 +17,7 @@ require 'mongo/monitoring/event/secure'
 require 'mongo/monitoring/event/command_started'
 require 'mongo/monitoring/event/command_succeeded'
 require 'mongo/monitoring/event/command_failed'
+require 'mongo/monitoring/event/cmap'
 require 'mongo/monitoring/event/server_closed'
 require 'mongo/monitoring/event/server_description_changed'
 require 'mongo/monitoring/event/server_opening'