mongo 2.1.0.beta → 2.2.0

data/lib/mongo/protocol/message.rb

@@ -42,6 +42,31 @@ module Mongo
     class Message
       include Serializers
 
+      # The batch size constant.
+      #
+      # @since 2.2.0
+      BATCH_SIZE = 'batchSize'.freeze
+
+      # The collection constant.
+      #
+      # @since 2.2.0
+      COLLECTION = 'collection'.freeze
+
+      # The limit constant.
+      #
+      # @since 2.2.0
+      LIMIT = 'limit'.freeze
+
+      # The ordered constant.
+      #
+      # @since 2.2.0
+      ORDERED = 'ordered'.freeze
+
+      # The q constant.
+      #
+      # @since 2.2.0
+      Q = 'q'.freeze
+
       # Returns the request id for the message
       #
       # @return [Fixnum] The request id for this message
@@ -64,13 +89,11 @@ module Mongo
       #
       # @param buffer [String] buffer where the message should be inserted
       # @return [String] buffer containing the serialized message
-      def serialize(buffer = ''.force_encoding('BINARY'), max_bson_size = nil)
-        start = buffer.bytesize
+      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil)
+        start = buffer.length
         serialize_header(buffer)
         serialize_fields(buffer, max_bson_size)
-        length = buffer.bytesize - start
-        buffer[start, 4] = Int32.serialize('', length)
-        buffer
+        buffer.replace_int32(start, buffer.length - start)
       end
 
       alias_method :to_s, :serialize
@@ -80,13 +103,14 @@ module Mongo
       # @param io [IO] Stream containing a message
       # @return [Message] Instance of a Message class
       def self.deserialize(io)
-        deserialize_header(io)
+        length = deserialize_header(BSON::ByteBuffer.new(io.read(16))).first
+        buffer = BSON::ByteBuffer.new(io.read(length - 16))
         message = allocate
         fields.each do |field|
           if field[:multi]
-            deserialize_array(message, io, field)
+            deserialize_array(message, buffer, field)
           else
-            deserialize_field(message, io, field)
+            deserialize_field(message, buffer, field)
           end
         end
         message
@@ -114,6 +138,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 +193,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 +205,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,144 @@ 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'
+        }.freeze
+
+        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'
+        }.freeze
+
+        # 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'
+        }.freeze
+
+        # Find command constant.
+        #
+        # @since 2.1.0
+        FIND = 'find'.freeze
+
+        # Filter attribute constant.
+        #
+        # @since 2.1.0
+        FILTER = 'filter'.freeze
+
+        # @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
+          document = BSON::Document.new
+          filter.each do |field, value|
+            document.store(field.to_s, value)
+          end
+          document
+        end
+
+        def find_command
+          document = BSON::Document.new
+          document.store(FIND, collection)
+          document.store(FILTER, filter[:$query] ? filter[:$query] : filter)
+          OPTION_MAPPINGS.each do |legacy, option|
+            document.store(option, options[legacy]) unless options[legacy].nil?
+          end
+          SPECIAL_FIELD_MAPPINGS.each do |special, normal|
+            document.store(normal, filter[special]) unless filter[special].nil?
+          end
+          FLAG_MAPPINGS.each do |legacy, flag|
+            document.store(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,93 @@ 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
+
+        # Next batch constant.
+        #
+        # @since 2.1.0
+        NEXT_BATCH = 'nextBatch'.freeze
+
+        # First batch constant.
+        #
+        # @since 2.1.0
+        FIRST_BATCH = 'firstBatch'.freeze
+
+        # Cursor field constant.
+        #
+        # @since 2.1.0
+        CURSOR = 'cursor'.freeze
+
+        # Id field constant.
+        #
+        # @since 2.1.0
+        ID = 'id'.freeze
+
+        # @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 ? NEXT_BATCH : FIRST_BATCH
+        end
+
+        def command?
+          !documents.empty? && documents.first.key?(Operation::Result::OK)
+        end
+
+        def find_command
+          document = BSON::Document.new
+          cursor_document = BSON::Document.new
+          cursor_document.store(ID, cursor_id)
+          cursor_document.store(batch_field, documents)
+          document.store(Operation::Result::OK, 1)
+          document.store(CURSOR, cursor_document)
+          document
+        end
+
+        def op_command
+          documents.first
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/serializers.rb

@@ -46,20 +46,22 @@ module Mongo
 
         # Serializes the header value into the buffer
         #
-        # @param buffer [String] Buffer to receive the serialized value.
-        # @param value [String] Header value to be serialized.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized value.
+        # @param value [ String ] Header value to be serialized.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
-          buffer << value.pack(HEADER_PACK)
+          buffer.put_bytes(value.pack(HEADER_PACK))
         end
 
         # Deserializes the header value from the IO stream
         #
-        # @param io [IO] IO stream containing the message header.
-        # @return [Array<Fixnum>] Array consisting of the deserialized
+        # @param [ String ] buffer Buffer containing the message header.
+        #
+        # @return [ Array<Fixnum> ] Array consisting of the deserialized
         #   length, request id, response id, and op code.
-        def self.deserialize(io)
-          io.read(16).unpack(HEADER_PACK)
+        def self.deserialize(buffer)
+          buffer.get_bytes(16).unpack(HEADER_PACK)
         end
       end
 
@@ -70,12 +72,12 @@ module Mongo
 
         # Serializes a C style string into the buffer
         #
-        # @param buffer [String] Buffer to receive the serialized CString.
-        # @param value [String] The string to be serialized.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized CString.
+        # @param value [ String ] The string to be serialized.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
-          buffer << value
-          buffer << NULL
+          buffer.put_cstring(value)
         end
       end
 
@@ -86,11 +88,12 @@ module Mongo
 
         # Serializes a 32-bit Zero into the buffer
         #
-        # @param buffer [String] Buffer to receive the serialized Zero.
-        # @param value [Fixnum] Ignored value.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized Zero.
+        # @param value [ Fixnum ] Ignored value.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
-          buffer << [ZERO].pack(INT32_PACK)
+          buffer.put_int32(ZERO)
         end
       end
 
@@ -101,19 +104,21 @@ module Mongo
 
         # Serializes a fixnum to a 4-byte 32-bit integer
         #
-        # @param buffer [String] Buffer to receive the serialized Int32.
-        # @param value [Fixnum] 32-bit integer to be serialized.
+        # @param buffer [ String ] Buffer to receive the serialized Int32.
+        # @param value [ Fixnum ] 32-bit integer to be serialized.
+        #
         # @return [String] Buffer with serialized value.
         def self.serialize(buffer, value)
-          buffer << [value].pack(INT32_PACK)
+          buffer.put_int32(value)
         end
 
         # Deserializes a 32-bit Fixnum from the IO stream
         #
-        # @param io [IO] IO stream containing the 32-bit integer
-        # @return [Fixnum] Deserialized Int32
-        def self.deserialize(io)
-          io.read(4).unpack(INT32_PACK).first
+        # @param [ String ] buffer Buffer containing the 32-bit integer
+        #
+        # @return [ Fixnum ] Deserialized Int32
+        def self.deserialize(buffer)
+          buffer.get_int32
         end
       end
 
@@ -124,19 +129,21 @@ module Mongo
 
         # Serializes a fixnum to an 8-byte 64-bit integer
         #
-        # @param buffer [String] Buffer to receive the serialized Int64.
-        # @param value [Fixnum] 64-bit integer to be serialized.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the serialized Int64.
+        # @param value [ Fixnum ] 64-bit integer to be serialized.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value)
-          buffer << [value].pack(INT64_PACK)
+          buffer.put_int64(value)
         end
 
         # Deserializes a 64-bit Fixnum from the IO stream
         #
-        # @param io [IO] IO stream containing the 64-bit integer.
+        # @param [ String ] buffer Buffer containing the 64-bit integer.
+        #
         # @return [Fixnum] Deserialized Int64.
-        def self.deserialize(io)
-          io.read(8).unpack(INT64_PACK).first
+        def self.deserialize(buffer)
+          buffer.get_int64
         end
       end
 
@@ -147,23 +154,25 @@ module Mongo
 
         # Serializes a document into the buffer
         #
-        # @param buffer [String] Buffer to receive the BSON encoded document.
-        # @param value [Hash] Document to serialize as BSON.
-        # @return [String] Buffer with serialized value.
+        # @param buffer [ String ] Buffer to receive the BSON encoded document.
+        # @param value [ Hash ] Document to serialize as BSON.
+        #
+        # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value, max_bson_size = nil)
-          start_size = buffer.size
+          start_size = buffer.length
           value.to_bson(buffer)
-          if max_bson_size && buffer.size - start_size > max_bson_size
+          if max_bson_size && buffer.length - start_size > max_bson_size
             raise Error::MaxBSONSize.new(max_bson_size)
           end
         end
 
         # Deserializes a document from the IO stream
         #
-        # @param io [IO] IO stream containing the BSON encoded document.
-        # @return [Hash] The decoded BSON document.
-        def self.deserialize(io)
-          BSON::Document.from_bson(io)
+        # @param [ String ] buffer Buffer containing the BSON encoded document.
+        #
+        # @return [ Hash ] The decoded BSON document.
+        def self.deserialize(buffer)
+          BSON::Document.from_bson(buffer)
         end
 
         # Whether there can be a size limit on this type after serialization.