mongo 2.1.0.beta → 2.1.0.rc0

data/lib/mongo/protocol/message.rb

@@ -114,6 +114,17 @@ module Mongo
         fields.map { |field| instance_variable_get(field[:name]) }.hash
       end
 
+      # Generates a request id for a message
+      #
+      # @return [Fixnum] a request id used for sending a message to the
+      #   server. The server will put this id in the response_to field of
+      #   a reply.
+      def set_request_id
+        @@id_lock.synchronize do
+          @request_id = @@request_id += 1
+        end
+      end
+
       private
 
       @@request_id = 0
@@ -158,17 +169,6 @@ module Mongo
         end
       end
 
-      # Generates a request id for a message
-      #
-      # @return [Fixnum] a request id used for sending a message to the
-      #   server. The server will put this id in the response_to field of
-      #   a reply.
-      def set_request_id
-        @@id_lock.synchronize do
-          @request_id = @@request_id += 1
-        end
-      end
-
       # Serializes the header of the message consisting of 4 32bit integers
       #
       # The integers represent a message length placeholder (calculation of
@@ -181,7 +181,7 @@ module Mongo
       # @param buffer [String] Buffer to receive the header
       # @return [String] Serialized header
       def serialize_header(buffer)
-        set_request_id
+        set_request_id unless @request_id
         Header.serialize(buffer, [0, request_id, 0, op_code])
       end
 

data/lib/mongo/protocol/query.rb

@@ -30,12 +30,6 @@ module Mongo
     # @api semipublic
     class Query < Message
 
-      # Constant for the max number of characters to print when inspecting
-      # a query field.
-      #
-      # @since 2.0.3
-      LOG_STRING_LIMIT = 250
-
       # Creates a new Query message
       #
       # @example Find all users named Tyler.
@@ -64,14 +58,15 @@ module Mongo
       #   Supported flags: +:tailable_cursor+, +:slave_ok+, +:oplog_replay+,
       #   +:no_cursor_timeout+, +:await_data+, +:exhaust+, +:partial+
       def initialize(database, collection, selector, options = {})
-        @database    = database
-        @namespace   = "#{database}.#{collection}"
-        @selector    = selector
-        @options     = options
-        @project     = options[:project]
-        @skip        = options[:skip]  || 0
-        @limit       = options[:limit] || 0
-        @flags       = options[:flags] || []
+        @database = database
+        @namespace = "#{database}.#{collection}"
+        @selector = selector
+        @options = options
+        @project = options[:project]
+        @limit = determine_limit
+        @skip = options[:skip]  || 0
+        @flags = options[:flags] || []
+        @upconverter = Upconverter.new(collection, selector, options, flags)
       end
 
       # Return the event payload for monitoring.
@@ -84,57 +79,13 @@ module Mongo
       # @since 2.1.0
       def payload
         {
-          command_name: command_name,
+          command_name: upconverter.command_name,
           database_name: @database,
-          command: arguments,
+          command: upconverter.command,
           request_id: request_id
         }
       end
 
-      # If the message a command?
-      #
-      # @example Is the message a command?
-      #   message.command?
-      #
-      # @return [ true, false ] If the message is a command.
-      #
-      # @since 2.1.0
-      def command?
-        namespace.include?(Database::COMMAND)
-      end
-
-      # Returns the name of the command.
-      #
-      # @example Get the command name.
-      #   message.command_name
-      #
-      # @return [ String ] The name of the command, or 'find' if a query.
-      #
-      # @since 2.1.0
-      def command_name
-        if command?
-          selector.keys.first
-        else
-          'find'
-        end
-      end
-
-      # Get the command arguments.
-      #
-      # @example Get the command arguments.
-      #   message.arguments
-      #
-      # @return [ Hash ] The command arguments.
-      #
-      # @since 2.1.0
-      def arguments
-        if command?
-          selector
-        else
-          { filter: selector }.merge(@options)
-        end
-      end
-
       # Query messages require replies from the database.
       #
       # @example Does the message require a reply?
@@ -149,17 +100,16 @@ module Mongo
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify a Query message.
       # @return [Fixnum] the operation code.
       def op_code
         2004
       end
 
-      def formatted_selector
-        ( (str = selector.inspect).length > LOG_STRING_LIMIT ) ?
-          "#{str[0..LOG_STRING_LIMIT]}..." : str
-      rescue ArgumentError
-        '<Unable to inspect selector>'
+      def determine_limit
+        [ @options[:limit] || @options[:batch_size], @options[:batch_size] || @options[:limit] ].min || 0
       end
 
       # Available flags for a Query message.
@@ -197,6 +147,130 @@ module Mongo
       # @!attribute
       # @return [Hash] The projection.
       field :project, Document
+
+      # Converts legacy query messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # Mappings of the options to the find command options.
+        #
+        # @since 2.1.0
+        OPTION_MAPPINGS = {
+          :project => :projection,
+          :skip => :skip,
+          :limit => :limit,
+          :batch_size => :batchSize
+        }
+
+        SPECIAL_FIELD_MAPPINGS = {
+          :$readPreference => :readPreference,
+          :$orderby => :sort,
+          :$hint => :hint,
+          :$comment => :comment,
+          :$returnKey => :returnKey,
+          :$snapshot => :snapshot,
+          :$maxScan => :maxScan,
+          :$max => :max,
+          :$min => :min,
+          :$maxTimeMS => :maxTimeMS,
+          :$showDiskLoc => :showRecordId,
+          :$explain => :explain
+        }
+
+        # Mapping of flags to find command options.
+        #
+        # @since 2.1.0
+        FLAG_MAPPINGS = {
+          :tailable_cursor => :tailable,
+          :oplog_replay => :oplogReplay,
+          :no_cursor_timeout => :noCursorTimeout,
+          :await_data => :awaitData,
+          :partial => :allowPartialResults
+        }
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ BSON::Document, Hash ] filter The query filter or command.
+        attr_reader :filter
+
+        # @return [ BSON::Document, Hash ] options The options.
+        attr_reader :options
+
+        # @return [ Array<Symbol> ] flags The flags.
+        attr_reader :flags
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', { name: 'test' }, { skip: 10 })
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ BSON::Document, Hash ] filter The filter or command.
+        # @param [ BSON::Document, Hash ] options The options.
+        # @param [ Array<Symbol> ] flags The flags.
+        #
+        # @since 2.1.0
+        def initialize(collection, filter, options, flags)
+          @collection = collection
+          @filter = filter
+          @options = options
+          @flags = flags
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          command? ? op_command : find_command
+        end
+
+        # Get the name of the command. If the collection is $cmd then it's the
+        # first key in the filter, otherwise it's a find.
+        #
+        # @example Get the command name.
+        #   upconverter.command_name
+        #
+        # @return [ String, Symbol ] The command name.
+        #
+        # @since 2.1.0
+        def command_name
+          command? ? filter.keys.first : 'find'
+        end
+
+        private
+
+        def command?
+          collection == Database::COMMAND
+        end
+
+        def op_command
+          BSON::Document.new(filter)
+        end
+
+        def find_command
+          document = BSON::Document.new
+          document[:find] = collection
+          document[:filter] = filter[:$query] ? filter[:$query] : filter
+          OPTION_MAPPINGS.each do |legacy, option|
+            document[option] = options[legacy] unless options[legacy].nil?
+          end
+          SPECIAL_FIELD_MAPPINGS.each do |special, normal|
+            document[normal] = filter[special] unless filter[special].nil?
+          end
+          FLAG_MAPPINGS.each do |legacy, flag|
+            document[flag] = true if flags.include?(legacy)
+          end
+          document
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/reply.rb

@@ -47,11 +47,15 @@ module Mongo
       #
       # @since 2.1.0
       def payload
-        { reply: documents, request_id: request_id }
+        { reply: upconverter.command, request_id: request_id }
       end
 
       private
 
+      def upconverter
+        @upconverter ||= Upconverter.new(documents, cursor_id, starting_from)
+      end
+
       # The operation code required to specify a Reply message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -91,6 +95,70 @@ module Mongo
       # @!attribute
       # @return [Array<Hash>] The documents in this Reply.
       field :documents, Document, :@number_returned
+
+      # Upconverts legacy replies to new op command replies.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # @return [ Array<BSON::Document> ] documents The documents.
+        attr_reader :documents
+
+        # @return [ Integer ] cursor_id The cursor id.
+        attr_reader :cursor_id
+
+        # @return [ Integer ] starting_from The starting point in the cursor.
+        attr_reader :starting_from
+
+        # Initialize the new upconverter.
+        #
+        # @example Create the upconverter.
+        #   Upconverter.new(docs, 1, 3)
+        #
+        # @param [ Array<BSON::Document> ] documents The documents.
+        # @param [ Integer ] cursor_id The cursor id.
+        # @param [ Integer ] starting_from The starting position.
+        #
+        # @since 2.1.0
+        def initialize(documents, cursor_id, starting_from)
+          @documents = documents
+          @cursor_id = cursor_id
+          @starting_from = starting_from
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The command.
+        #
+        # @since 2.1.0
+        def command
+          command? ? op_command : find_command
+        end
+
+        private
+
+        def batch_field
+          starting_from > 0 ? :nextBatch : :firstBatch
+        end
+
+        def command?
+          !documents.empty? && documents.first.key?('ok')
+        end
+
+        def find_command
+          BSON::Document.new(
+            ok: 1,
+            cursor: BSON::Document.new(id: cursor_id, batch_field => documents)
+          )
+        end
+
+        def op_command
+          documents.first
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/update.rb

@@ -53,10 +53,12 @@ module Mongo
       #   Supported flags: +:upsert+, +:multi_update+
       def initialize(database, collection, selector, update, options = {})
         @database    = database
+        @collection  = collection
         @namespace   = "#{database}.#{collection}"
         @selector    = selector
         @update      = update
         @flags       = options[:flags] || []
+        @upconverter = Upconverter.new(collection, selector, update, flags)
       end
 
       # Return the event payload for monitoring.
@@ -71,13 +73,15 @@ module Mongo
         {
           command_name: 'update',
           database_name: @database,
-          command: { filter: selector, update: update },
+          command: upconverter.command,
           request_id: request_id
         }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify an Update message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -105,6 +109,71 @@ module Mongo
       # @!attribute
       # @return [Hash] The update for this Delete message.
       field :update, Document
+
+      # Converts legacy update messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ Hash ] filter The filter.
+        attr_reader :filter
+
+        # @return [ Hash ] update The update.
+        attr_reader :update
+
+        # @return [ Array<Symbol> ] flags The flags.
+        attr_reader :flags
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new(
+        #     'users',
+        #     { name: 'test' },
+        #     { '$set' => { 'name' => 't' }},
+        #     []
+        #   )
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Hash ] filter The filter.
+        # @param [ Hash ] update The update.
+        # @param [ Array<Symbol> ] flags The flags.
+        #
+        # @since 2.1.0
+        def initialize(collection, filter, update, flags)
+          @collection = collection
+          @filter = filter
+          @update = update
+          @flags = flags
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          BSON::Document.new(
+            update: collection,
+            ordered: true,
+            updates: [
+              BSON::Document.new(
+                q: filter,
+                u: update,
+                multi: flags.include?(:multi_update),
+                upsert: flags.include?(:upsert),
+              )
+            ]
+          )
+        end
+      end
     end
   end
 end