mongo 2.9.2 → 2.10.0.rc0

data/lib/mongo/database/view.rb

@@ -24,6 +24,8 @@ module Mongo
       include Retryable
 
       def_delegators :@database, :cluster, :read_preference, :client
+      # @api private
+      def_delegators :@database, :server_selector, :read_concern
       def_delegators :cluster, :next_primary
 
       # @return [ Integer ] batch_size The size of the batch of results
@@ -38,8 +40,8 @@ module Mongo
 
       # Get all the names of the non-system collections in the database.
       #
-      # @example Get the collection names.
-      #   database.collection_names
+      # @note The set of returned collection names depends on the version of
+      #   MongoDB server that fulfills the request.
       #
       # @param [ Hash ] options Options for the listCollections command.
       #
@@ -52,21 +54,27 @@ module Mongo
       def collection_names(options = {})
         @batch_size = options[:batch_size]
         session = client.send(:get_session, options)
-        cursor = read_with_retry_cursor(session, ServerSelector.get(mode: :primary), self) do |server|
+        cursor = read_with_retry_cursor(session, ServerSelector.primary, self) do |server|
           send_initial_query(server, session, name_only: true)
         end
         cursor.map do |info|
           if cursor.server.features.list_collections_enabled?
-            info[Database::NAME]
+            info['name']
           else
-            (info[Database::NAME] &&
-              info[Database::NAME].sub("#{@database.name}.", ''))
+            (info['name'] &&
+              info['name'].sub("#{@database.name}.", ''))
           end
+        end.reject do |name|
+          name.start_with?('system.') || name.include?('$')
         end
       end
 
       # Get info on all the collections in the database.
       #
+      # @note The set of collections returned, and the schema of the
+      #   information hash per collection, depends on the MongoDB server
+      #   version that fulfills the request.
+      #
       # @example Get info on each collection.
       #   database.list_collections
       #
@@ -75,7 +83,7 @@ module Mongo
       # @since 2.0.5
       def list_collections
         session = client.send(:get_session)
-        collections_info(session, ServerSelector.get(mode: :primary))
+        collections_info(session, ServerSelector.primary)
       end
 
       # Create the new database view.
@@ -93,18 +101,53 @@ module Mongo
         @collection = @database[Database::COMMAND]
       end
 
+      # @api private
+      attr_reader :database
+
+      # Execute an aggregation on the database view.
+      #
+      # @example Aggregate documents.
+      #   view.aggregate([
+      #     { "$listLocalSessions" => {} }
+      #   ])
+      #
+      # @param [ Array<Hash> ] pipeline The aggregation pipeline.
+      # @param [ Hash ] options The aggregation options.
+      #
+      # @return [ Aggregation ] The aggregation object.
+      #
+      # @since 2.10.0
+      # @api private
+      def aggregate(pipeline, options = {})
+        Collection::View::Aggregation.new(self, pipeline, options)
+      end
+
       private
 
       def collections_info(session, server_selector, options = {}, &block)
+        description = nil
         cursor = read_with_retry_cursor(session, server_selector, self) do |server|
+          # TODO take description from the connection used to send the query
+          # once https://jira.mongodb.org/browse/RUBY-1601 is fixed.
+          description = server.description
           send_initial_query(server, session, options)
         end
-        if block_given?
-          cursor.each do |doc|
-            yield doc
+        # On 3.0+ servers, we get just the collection names.
+        # On 2.6 server, we get collection names prefixed with the database
+        # name. We need to filter system collections out here because
+        # in the caller we don't know which server version executed the
+        # command and thus what the proper filtering logic should be
+        # (it is valid for collection names to have dots, thus filtering out
+        # collections named system.* here for 2.6 servers would actually
+        # filter out collections in the system database).
+        if description.server_version_gte?('3.0')
+          cursor.reject do |doc|
+            doc['name'].start_with?('system.') || doc['name'].include?('$')
           end
         else
-          cursor.to_enum
+          docs = cursor.reject do |doc|
+            doc['name'].start_with?("#{database.name}.system") || doc['name'].include?('$')
+          end
         end
       end
 

data/lib/mongo/error.rb

@@ -41,16 +41,19 @@ module Mongo
     # The constant for the writeErrors array.
     #
     # @since 2.0.0
+    # @deprecated
     WRITE_ERRORS = 'writeErrors'.freeze
 
     # The constant for a write concern error.
     #
     # @since 2.0.0
+    # @deprecated
     WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
 
     # The constant for write concern errors.
     #
     # @since 2.1.0
+    # @deprecated
     WRITE_CONCERN_ERRORS = 'writeConcernErrors'.freeze
 
     # Constant for an unknown error.
@@ -85,17 +88,19 @@ module Mongo
     # manually retried by the user.
     #
     # @since 2.6.0
+    # @deprecated
     UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL = 'UnknownTransactionCommitResult'.freeze
 
     # Error label describing errors that will likely not occur if a transaction is manually retried
     # from the start.
     #
     # @since 2.6.0
+    # @deprecated
     TRANSIENT_TRANSACTION_ERROR_LABEL = 'TransientTransactionError'.freeze
 
     def initialize(msg = nil)
-      @labels ||= []
-      super(msg)
+      super
+      @labels = []
     end
 
     # Does the error have the given label?
@@ -124,8 +129,12 @@ module Mongo
       @labels.dup
     end
 
-    private
-
+    # Adds the specified label to the error instance, if the label is not
+    # already in the set of labels.
+    #
+    # @param [ String ] label The label to add.
+    #
+    # @api private
     def add_label(label)
       @labels << label unless label?(label)
     end

data/lib/mongo/error/invalid_write_concern.rb

@@ -26,8 +26,8 @@ module Mongo
       #   Mongo::Error::InvalidWriteConcern.new
       #
       # @since 2.2.0
-      def initialize
-        super('Invalid write concern options. If w is an Integer, it must be greater than or equal to 0. ' +
+      def initialize(msg = nil)
+        super(msg || 'Invalid write concern options. If w is an Integer, it must be greater than or equal to 0. ' +
               'If w is 0, it cannot be combined with a true value for fsync or j (journal).')
       end
     end

data/lib/mongo/error/operation_failure.rb

@@ -70,11 +70,13 @@ module Mongo
 
       def_delegators :@result, :operation_time
 
-      # @return [ Integer ] code The error code parsed from the document.
+      # @return [ Integer ] The error code parsed from the document.
+      #
       # @since 2.6.0
       attr_reader :code
 
-      # @return [ String ] code_name The error code name parsed from the document.
+      # @return [ String ] The error code name parsed from the document.
+      #
       # @since 2.6.0
       attr_reader :code_name
 
@@ -141,8 +143,9 @@ module Mongo
       # @since 2.6.0
       def change_stream_resumable?
         if @result && @result.is_a?(Mongo::Operation::GetMore::Result)
-          change_stream_resumable_message? ||
-          change_stream_resumable_code?
+          !change_stream_not_resumable_label? &&
+          (change_stream_resumable_message? ||
+          change_stream_resumable_code?)
         else
           false
         end
@@ -162,6 +165,39 @@ module Mongo
       end
       private :change_stream_resumable_code?
 
+      def change_stream_not_resumable_label?
+        if labels
+          labels.include? 'NonResumableChangeStreamError'
+        else
+          false
+        end
+      end
+      private :change_stream_not_resumable_label?
+
+      # @return [ true | false ] Whether the failure includes a write
+      #   concern error. A failure may have a top level error and a write
+      #   concern error or either one of the two.
+      #
+      # @since 2.10.0
+      # @api experimental
+      def write_concern_error?
+        @write_concern_error
+      end
+
+      # @return [ Integer | nil ] The error code for the write concern error,
+      #   if a write concern error is present and has a code.
+      #
+      # @since 2.10.0
+      # @api experimental
+      attr_reader :write_concern_error_code
+
+      # @return [ String | nil ] The code name for the write concern error,
+      #   if a write concern error is present and has a code name.
+      #
+      # @since 2.10.0
+      # @api experimental
+      attr_reader :write_concern_error_code_name
+
       # Create the operation failure.
       #
       # @example Create the error object
@@ -172,22 +208,31 @@ module Mongo
       #
       # @param [ String ] message The error message.
       # @param [ Operation::Result ] result The result object.
-      # @param [ Hash ] options Additional parameters
+      # @param [ Hash ] options Additional parameters.
       #
-      # @option options [ Integer ] :code Error code
-      # @option options [ String ] :code_name Error code name
+      # @option options [ Integer ] :code Error code.
+      # @option options [ String ] :code_name Error code name.
+      # @option options [ true | false ] :write_concern_error Whether the
+      #   write concern error is present.
+      # @option options [ Integer ] :write_concern_error_code Error code for
+      #   write concern error, if any.
+      # @option options [ String ] :write_concern_error_code_name Error code
+      #   name for write concern error, if any.
       # @option options [ Array<String> ] :labels The set of labels associated
-      #   with the error
-      # @option options [ true | false ] :wtimeout Whether the error is a wtimeout
+      #   with the error.
+      # @option options [ true | false ] :wtimeout Whether the error is a wtimeout.
       #
       # @since 2.5.0, options added in 2.6.0
       def initialize(message = nil, result = nil, options = {})
+        super(message)
         @result = result
         @code = options[:code]
         @code_name = options[:code_name]
-        @labels = options[:labels]
+        @write_concern_error = !!options[:write_concern_error]
+        @write_concern_error_code = options[:write_concern_error_code]
+        @write_concern_error_code_name = options[:write_concern_error_code_name]
+        @labels = options[:labels] || []
         @wtimeout = !!options[:wtimeout]
-        super(message)
       end
 
       # Whether the error is a write concern timeout.
@@ -198,6 +243,15 @@ module Mongo
       def wtimeout?
         @wtimeout
       end
+
+      # Whether the error is MaxTimeMSExpired.
+      #
+      # @return [ true | false ] Whether the error is MaxTimeMSExpired.
+      #
+      # @since 2.10.0
+      def max_time_ms_expired?
+        code == 50 # MaxTimeMSExpired
+      end
     end
   end
 end

data/lib/mongo/error/parser.rb

@@ -102,16 +102,49 @@ module Mongo
         parse!
       end
 
+      # @return [ true | false ] Whether the document includes a write
+      #   concern error. A failure may have a top level error and a write
+      #   concern error or either one of the two.
+      #
+      # @since 2.10.0
+      # @api experimental
+      def write_concern_error?
+        !!write_concern_error_document
+      end
+
+      # @return [ Integer | nil ] The error code for the write concern error,
+      #   if a write concern error is present and has a code.
+      #
+      # @since 2.10.0
+      # @api experimental
+      def write_concern_error_code
+        write_concern_error_document && write_concern_error_document['code']
+      end
+
+      # @return [ String | nil ] The code name for the write concern error,
+      #   if a write concern error is present and has a code name.
+      #
+      # @since 2.10.0
+      # @api experimental
+      def write_concern_error_code_name
+        write_concern_error_document && write_concern_error_document['codeName']
+      end
+
       private
 
+      def write_concern_error_document
+        document['writeConcernError']
+      end
+
       def parse!
         @message = ""
         parse_single(@message, ERR)
         parse_single(@message, ERROR)
         parse_single(@message, ERRMSG)
-        parse_multiple(@message, WRITE_ERRORS)
-        parse_single(@message, ERRMSG,
-                     document[WRITE_CONCERN_ERROR]) if document[WRITE_CONCERN_ERROR]
+        parse_multiple(@message, 'writeErrors')
+        if write_concern_error_document
+          parse_single(@message, ERRMSG, write_concern_error_document)
+        end
         parse_flag(@message)
         parse_code
         parse_labels
@@ -160,7 +193,7 @@ module Mongo
         # In practice this should never be an issue as a write concern
         # can only fail after the operation succeeds on the primary.
         if @code.nil? && @code_name.nil?
-          if subdoc = document[WRITE_CONCERN_ERROR]
+          if subdoc = write_concern_error_document
             @code = subdoc['code']
             @code_name = subdoc['codeName']
           end
@@ -169,7 +202,7 @@ module Mongo
         if @code.nil? && @code_name.nil?
           # If we have writeErrors, and all of their codes are the same,
           # use that code. Otherwise don't set the code
-          if write_errors = document[WRITE_ERRORS]
+          if write_errors = document['writeErrors']
             codes = write_errors.map { |e| e['code'] }.compact
             if codes.uniq.length == 1
               @code = codes.first
@@ -185,9 +218,9 @@ module Mongo
       end
 
       def parse_wtimeout
-        @wtimeout = document[WRITE_CONCERN_ERROR] &&
-          document[WRITE_CONCERN_ERROR]['errInfo'] &&
-          document[WRITE_CONCERN_ERROR]['errInfo']['wtimeout']
+        @wtimeout = write_concern_error_document &&
+          write_concern_error_document['errInfo'] &&
+          write_concern_error_document['errInfo']['wtimeout']
       end
     end
   end

data/lib/mongo/grid/fs_bucket.rb

@@ -145,14 +145,25 @@ module Mongo
       #   collections.
       # @option options [ Integer ] :chunk_size Override the default chunk
       #   size.
-      # @option options [ String ] :write The write concern.
       # @option options [ String ] :read The read preference.
       # @option options [ Session ] :session The session to use.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
       #
       # @since 2.0.0
       def initialize(database, options = {})
         @database = database
-        @options = options
+        @options = options.dup
+=begin WriteConcern object support
+        if @options[:write_concern].is_a?(WriteConcern::Base)
+          # Cache the instance so that we do not needlessly reconstruct it.
+          @write_concern = @options[:write_concern]
+          @options[:write_concern] = @write_concern.options
+        end
+=end
+        @options.freeze
         @chunks_collection = database[chunks_name]
         @files_collection = database[files_name]
       end
@@ -347,13 +358,16 @@ module Mongo
       #
       # @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 ] :write The write concern.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
       # @option opts [ String ] :content_type The content type of the file.
       #   Deprecated, please use the metadata document instead.
       # @option opts [ Array<String> ] :aliases A list of aliases.
       #   Deprecated, please use the metadata document instead.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
       #
       # @return [ Stream::Write ] The write stream.
       #
@@ -386,13 +400,16 @@ module Mongo
       #
       # @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 ] :write The write concern.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
       # @option opts [ String ] :content_type The content type of the file. Deprecated, please
       #   use the metadata document instead.
       # @option opts [ Array<String> ] :aliases A list of aliases. Deprecated, please use the
       #   metadata document instead.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
       #
       # @return [ BSON::ObjectId ] The ObjectId file id.
       #
@@ -432,8 +449,11 @@ module Mongo
       #
       # @since 2.1.0
       def write_concern
-        @write_concern ||= @options[:write] ? WriteConcern.get(@options[:write]) :
-            database.write_concern
+        @write_concern ||= if wco = @options[:write_concern] || @options[:write]
+          WriteConcern.get(wco)
+        else
+          database.write_concern
+        end
       end
 
       private