mongo 2.9.2 → 2.10.0.rc0

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

@@ -182,8 +182,15 @@ module Mongo
           end
 
           def view
-            @view ||= (opts = options.merge(read: read_preference) if read_preference
-                         fs.chunks_collection.find({ :files_id => file_id }, opts || options).sort(:n => 1))
+            @view ||= begin
+              opts = if read_preference
+                options.merge(read: read_preference)
+              else
+                options
+              end
+
+              fs.chunks_collection.find({ :files_id => file_id }, opts).sort(:n => 1)
+            end
           end
 
           def validate!(index, num_chunks, chunk, length_read)

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

@@ -50,14 +50,18 @@ module Mongo
           # @param [ FSBucket ] fs The GridFS bucket object.
           # @param [ Hash ] options The write stream options.
           #
-          # @option opts [ Object ] :file_id The file id. An ObjectId is generated otherwise.
+          # @option options [ Object ] :file_id The file id. An ObjectId
+          #   is generated if the file id is not provided.
           # @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.
           #
           # @since 2.1.0
           def initialize(fs, options)
@@ -65,7 +69,15 @@ module Mongo
             @length = 0
             @n = 0
             @file_id = options[:file_id] || BSON::ObjectId.new
-            @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
             @filename = @options[:filename]
             @open = true
           end
@@ -117,8 +129,11 @@ module Mongo
           #
           # @since 2.1.0
           def write_concern
-            @write_concern ||= @options[:write] ? WriteConcern.get(@options[:write]) :
+            @write_concern ||= if wco = @options[:write_concern] || @options[:write]
+              WriteConcern.get(wco)
+            else
               fs.write_concern
+            end
           end
 
           # Is the stream closed.
@@ -158,7 +173,8 @@ module Mongo
 
           def with_write_concern(collection)
             if write_concern.nil? || (collection.write_concern &&
-                collection.write_concern.options == write_concern.options)
+              collection.write_concern.options == write_concern.options)
+            then
               collection
             else
               collection.with(write: write_concern.options)

data/lib/mongo/index/view.rb

@@ -149,8 +149,8 @@ module Mongo
       #
       # @since 2.0.0
       def create_many(*models)
-        server = next_primary
         client.send(:with_session, @options) do |session|
+          server = next_primary(nil, session)
           spec = {
                   indexes: normalize_models(models.flatten, server),
                   db_name: database.name,
@@ -192,7 +192,7 @@ module Mongo
       # @since 2.0.0
       def each(&block)
         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)
         end
         if block_given?
@@ -234,7 +234,7 @@ module Mongo
                    index_name: name,
                    session: session
                  }
-          server = next_primary
+          server = next_primary(nil, session)
           spec[:write_concern] = write_concern if server.features.collation_enabled?
           Operation::DropIndex.new(spec).execute(server)
         end

data/lib/mongo/lint.rb

@@ -67,12 +67,19 @@ module Mongo
       end
       return if read_concern.empty?
       keys = read_concern.keys
-      if keys != [:level]
+      if read_concern.is_a?(BSON::Document)
+        # Permits indifferent access
+        allowed_keys = ['level']
+      else
+        # Does not permit indifferent access
+        allowed_keys = [:level]
+      end
+      if keys != allowed_keys
         raise Error::LintError, "Read concern has invalid keys: #{keys.inspect}"
       end
       level = read_concern[:level]
-      return if [:local, :majority, :snapshot].include?(level)
-      raise Error::LintError, "Read concern level is invalid: #{level.inspect}"
+      return if [:local, :available, :majority, :linearizable, :snapshot].include?(level)
+      raise Error::LintError, "Read concern level is invalid: value must be a symbol: #{level.inspect}"
     end
     module_function :validate_read_concern_option
 

data/lib/mongo/operation.rb

@@ -13,6 +13,7 @@ require 'mongo/operation/shared/sessions_supported'
 require 'mongo/operation/shared/causal_consistency_supported'
 require 'mongo/operation/shared/write'
 require 'mongo/operation/shared/idable'
+require 'mongo/operation/shared/unpinnable'
 require 'mongo/operation/shared/specifiable'
 require 'mongo/operation/shared/object_id_generator'
 require 'mongo/operation/shared/op_msg_or_command'
@@ -93,6 +94,7 @@ module Mongo
     # The cluster time field constant.
     #
     # @since 2.5.0
+    # @deprecated
     CLUSTER_TIME = '$clusterTime'.freeze
   end
 end

data/lib/mongo/operation/aggregate/result.rb

@@ -52,10 +52,19 @@ module Mongo
           cursor_document ? cursor_document[CURSOR_ID] : 0
         end
 
+        # Get the post batch resume token for the result
+        #
+        # @return [ BSON::Document | nil ] The post batch resume token
+        #
+        # @api private
+        def post_batch_resume_token
+          cursor_document ? cursor_document['postBatchResumeToken'] : nil
+        end
+
         # Get the documents for the aggregation result. This is either the
-        # first document's 'result' field, or if a cursor option was selected
-        # it is the 'firstBatch' field in the 'cursor' field of the first
-        # document returned.
+        # first document's 'result' field, or if a cursor option was selected, 
+        # it is the 'firstBatch' field in the 'cursor' field of the first 
+        # document returned. Otherwise, it is an explain document.
         #
         # @example Get the documents.
         #   result.documents
@@ -64,14 +73,18 @@ module Mongo
         #
         # @since 2.0.0
         def documents
-          reply.documents[0][RESULT] || explain_document ||
-              cursor_document[FIRST_BATCH]
+          docs = reply.documents[0][RESULT] 
+          docs ||= cursor_document[FIRST_BATCH] if cursor_document
+          docs ||= explain_document 
+          docs
         end
 
         private
 
+        # This should only be called on explain responses; it will never
+        # return a nil result and will only be meaningful on explain responses
         def explain_document
-          first_document[EXPLAIN] || first_document[EXPLAIN_LEGACY]
+          first_document[EXPLAIN] || first_document[EXPLAIN_LEGACY] || [first_document]
         end
 
         def cursor_document

data/lib/mongo/operation/collections_info.rb

@@ -50,7 +50,7 @@ module Mongo
       private
 
       def selector(server)
-        { :name => { '$not' => /system\.|\$/ } }
+        {}
       end
 
       def message(server)

data/lib/mongo/operation/get_more/result.rb

@@ -33,6 +33,15 @@ module Mongo
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
 
+        # Get the post batch resume token for the result
+        #
+        # @return [ BSON::Document | nil ] The post batch resume token
+        #
+        # @api private
+        def post_batch_resume_token
+          cursor_document ? cursor_document['postBatchResumeToken'] : nil
+        end
+
         # Get the documents in the result.
         #
         # @example Get the documents.

data/lib/mongo/operation/list_collections/command.rb

@@ -31,9 +31,7 @@ module Mongo
         private
 
         def selector(server)
-          (spec[SELECTOR] || {}).merge(
-              listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
-          )
+          (spec[SELECTOR] || {}).merge(listCollections: 1)
         end
 
         def message(server)

data/lib/mongo/operation/list_collections/op_msg.rb

@@ -28,8 +28,7 @@ module Mongo
         private
 
         def selector(server)
-          (spec[SELECTOR] || {}).merge(
-              listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }})
+          (spec[SELECTOR] || {}).merge(listCollections: 1)
         end
       end
     end

data/lib/mongo/operation/parallel_scan/command.rb

@@ -32,7 +32,10 @@ module Mongo
 
         def selector(server)
           sel = { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
-          sel[:readConcern] = read_concern if read_concern
+          if read_concern
+            sel[:readConcern] = Options::Mapper.transform_values_to_strings(
+              read_concern)
+          end
           sel[:maxTimeMS] = max_time_ms if max_time_ms
           update_selector_for_read_pref(sel, server)
           sel

data/lib/mongo/operation/parallel_scan/op_msg.rb

@@ -31,7 +31,10 @@ module Mongo
         def selector(server)
           sel = { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
           sel[:maxTimeMS] = max_time_ms if max_time_ms
-          sel[:readConcern] = read_concern if read_concern
+          if read_concern
+            sel[:readConcern] = Options::Mapper.transform_values_to_strings(
+              read_concern)
+          end
           sel
         end
       end

data/lib/mongo/operation/result.rb

@@ -268,15 +268,34 @@ module Mongo
         !successful? ? raise_operation_failure : self
       end
 
-      def raise_operation_failure
-        raise Error::OperationFailure.new(
+      # The exception instance (of the Error::OperationFailure class)
+      # that would be raised during processing of this result.
+      #
+      # This method should only be called when result is not successful.
+      #
+      # @return [ Error::OperationFailure ] The exception.
+      #
+      # @api private
+      def error
+        @error ||= Error::OperationFailure.new(
           parser.message,
           self,
           code: parser.code,
           code_name: parser.code_name,
+          write_concern_error: parser.write_concern_error?,
+          write_concern_error_code: parser.write_concern_error_code,
+          write_concern_error_code_name: parser.write_concern_error_code_name,
           labels: parser.labels,
           wtimeout: parser.wtimeout)
       end
+
+      # Raises a Mongo::OperationFailure exception corresponding to the
+      # error information in this result.
+      #
+      # @raise Error::OperationFailure
+      def raise_operation_failure
+        raise error
+      end
       private :raise_operation_failure
 
       # Get the number of documents written by the server.
@@ -313,11 +332,15 @@ module Mongo
       # @example Get the cluster time.
       #   result.cluster_time
       #
-      # @return [ BSON::Document ] The cluster time document.
+      # @return [ nil | ClusterTime ] The cluster time document.
+      #
+      # Changed in version 2.9.0: This attribute became an instance of
+      # ClusterTime, which is a subclass of BSON::Document.
+      # Previously it was an instance of BSON::Document.
       #
       # @since 2.5.0
       def cluster_time
-        first_document && first_document[CLUSTER_TIME]
+        first_document && ClusterTime[first_document['$clusterTime']]
       end
 
       # Gets the set of error labels associated with the result.

data/lib/mongo/operation/shared/executable.rb

@@ -20,10 +20,20 @@ module Mongo
     # @since 2.5.2
     module Executable
 
+      def do_execute(server)
+        unpin_maybe(session) do
+          add_error_labels do
+            get_result(server).tap do |result|
+              process_result(result, server)
+            end
+          end
+        end
+      end
+
       def execute(server)
-        result = get_result(server)
-        process_result(result, server)
-        result.validate!
+        do_execute(server).tap do |result|
+          validate_result(result)
+        end
       end
 
       private
@@ -39,10 +49,14 @@ module Mongo
       # Returns a Protocol::Message or nil
       def dispatch_message(server)
         server.with_connection do |connection|
-          connection.dispatch([ message(server) ], operation_id)
+          connection.dispatch([ build_message(server) ], operation_id)
         end
       end
 
+      def build_message(server)
+        message(server)
+      end
+
       def process_result(result, server)
         server.update_cluster_time(result)
 
@@ -52,7 +66,7 @@ module Mongo
           else
             # Max wire version needs to be checked prior to marking the
             # server unknown
-            disconnect_pool = server.description.max_wire_version < 8
+            disconnect_pool = !server.description.server_version_gte?('4.2')
           end
 
           server.unknown!

data/lib/mongo/operation/shared/executable_no_validate.rb

@@ -22,8 +22,7 @@ module Mongo
     module ExecutableNoValidate
 
       def execute(server)
-        result = get_result(server)
-        process_result(result, server)
+        do_execute(server)
       end
     end
   end

data/lib/mongo/operation/shared/executable_transaction_label.rb

@@ -22,15 +22,6 @@ module Mongo
     #
     # @api private
     module ExecutableTransactionLabel
-
-      def execute(server)
-        super
-      rescue Mongo::Error::SocketError => e
-        if session && session.in_transaction?
-          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL)
-        end
-        raise e
-      end
     end
   end
 end

data/lib/mongo/operation/shared/polymorphic_result.rb

@@ -27,8 +27,16 @@ module Mongo
 
       private
 
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        attr_accessor :result_class
+      end
+
       def result_class
-        begin
+        self.class.result_class ||= begin
           polymorphic_class(self.class.name, :Result)
         rescue NameError
           polymorphic_class(self.class.name.sub(/::[^:]*$/, ''), :Result)

data/lib/mongo/operation/shared/result/aggregatable.rb

@@ -34,7 +34,7 @@ module Mongo
         def aggregate_write_errors(count)
           return unless @replies
           @replies.reduce(nil) do |errors, reply|
-            if write_errors = reply.documents.first[Error::WRITE_ERRORS]
+            if write_errors = reply.documents.first['writeErrors']
               wes = write_errors.collect do |we|
                 we.merge!('index' => count + we['index'])
               end
@@ -56,7 +56,7 @@ module Mongo
         def aggregate_write_concern_errors(count)
           return unless @replies
           @replies.each_with_index.reduce(nil) do |errors, (reply, _)|
-            if write_concern_errors = reply.documents.first[Error::WRITE_CONCERN_ERRORS]
+            if write_concern_errors = reply.documents.first['writeConcernErrors']
               (errors || []) << write_concern_errors.reduce(nil) do |errs, wce|
                 wce.merge!('index' => count + wce['index'])
                 (errs || []) << write_concern_error

data/lib/mongo/operation/shared/sessions_supported.rb

@@ -62,7 +62,9 @@ module Mongo
         if !server.standalone?
           cc_doc = session.send(:causal_consistency_doc)
           if cc_doc
-            selector[:readConcern] = (selector[:readConcern] || read_concern || {}).merge(cc_doc)
+            rc_doc = (selector[:readConcern] || read_concern || {}).merge(cc_doc)
+            selector[:readConcern] = Options::Mapper.transform_values_to_strings(
+              rc_doc)
           end
         end
       end
@@ -73,12 +75,10 @@ module Mongo
 
       def apply_cluster_time!(selector, server)
         if !server.standalone?
-          cluster_time = [server.cluster_time, (session && session.cluster_time)].max_by do |doc|
-            (doc && doc[Cluster::CLUSTER_TIME]) || ZERO_TIMESTAMP
-          end
+          cluster_time = [server.cluster_time, session && session.cluster_time].compact.max
 
-          if cluster_time && (cluster_time[Cluster::CLUSTER_TIME] > ZERO_TIMESTAMP)
-            selector[CLUSTER_TIME] = cluster_time
+          if cluster_time
+            selector['$clusterTime'] = cluster_time
           end
         end
       end
@@ -123,46 +123,56 @@ module Mongo
         session.validate_read_preference!(selector) if read_command?(selector)
       end
 
-      def update_session_state!
-        session.update_state!
-      end
-
       def command(server)
         sel = selector(server).dup
         add_write_concern!(sel)
         sel[Protocol::Msg::DATABASE_IDENTIFIER] = db_name
-        sel['$readPreference'] = read.to_doc if read
+        unless server.standalone?
+          sel['$readPreference'] = read.to_doc if read
+        end
 
         if server.features.sessions_enabled?
           apply_cluster_time!(sel, server)
           if session && (acknowledged_write? || session.in_transaction?)
-            sel[:txnNumber] = BSON::Int64.new(txn_num) if txn_num
-            apply_session_id!(sel)
-            apply_start_transaction!(sel)
-            apply_causal_consistency!(sel, server)
-            apply_autocommit!(sel)
-            apply_txn_opts!(sel)
-            suppress_read_write_concern!(sel)
-            validate_read_preference!(sel)
-            update_session_state!
-            apply_txn_num!(sel)
+            apply_session_options(sel, server)
           end
         elsif session && session.explicit?
-          apply_cluster_time!(sel, server)
-          sel[:txnNumber] = BSON::Int64.new(txn_num) if txn_num
-          apply_session_id!(sel)
-          apply_start_transaction!(sel)
-          apply_causal_consistency!(sel, server)
-          apply_autocommit!(sel)
-          apply_txn_opts!(sel)
-          suppress_read_write_concern!(sel)
-          validate_read_preference!(sel)
-          update_session_state!
-          apply_txn_num!(sel)
+          apply_session_options(sel, server)
         end
 
         sel
       end
+
+      def apply_session_options(sel, server)
+        apply_cluster_time!(sel, server)
+        sel[:txnNumber] = BSON::Int64.new(txn_num) if txn_num
+        apply_session_id!(sel)
+        apply_start_transaction!(sel)
+        apply_causal_consistency!(sel, server)
+        apply_autocommit!(sel)
+        apply_txn_opts!(sel)
+        suppress_read_write_concern!(sel)
+        validate_read_preference!(sel)
+        apply_txn_num!(sel)
+        if session.recovery_token &&
+          (sel[:commitTransaction] || sel[:abortTransaction])
+        then
+          sel[:recoveryToken] = session.recovery_token
+        end
+      end
+
+      def build_message(server)
+        super.tap do |message|
+          if session
+            # Serialize the message to detect client-side problems,
+            # such as invalid BSON keys. The message will be serialized again
+            # later prior to being sent to the server.
+            message.serialize(BSON::ByteBuffer.new)
+
+            session.update_state!
+          end
+        end
+      end
     end
   end
 end