mongo 2.0.6 → 2.1.0

data/lib/mongo/protocol/insert.rb

@@ -49,31 +49,34 @@ module Mongo
       #
       #   Supported flags: +:continue_on_error+
       def initialize(database, collection, documents, options = {})
+        @database = database
         @namespace = "#{database}.#{collection}"
         @documents = documents
         @flags = options[:flags] || []
+        @upconverter = Upconverter.new(collection, documents, options)
       end
 
-      # The log message for a insert operation.
+      # Return the event payload for monitoring.
       #
-      # @example Get the log message.
-      #   insert.log_message
+      # @example Return the event payload.
+      #   message.payload
       #
-      # @return [ String ] The log message
+      # @return [ Hash ] The event payload.
       #
-      # @since 2.0.0
-      def log_message
-        fields = []
-        fields << ["%s |", "INSERT"]
-        fields << ["namespace=%s", namespace]
-        fields << ["documents=%s", documents.inspect]
-        fields << ["flags=%s", flags.inspect]
-        f, v = fields.transpose
-        f.join(" ") % v
+      # @since 2.1.0
+      def payload
+        {
+          command_name: 'insert',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify an Insert message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -94,6 +97,75 @@ module Mongo
       # @!attribute
       # @return [Array<Hash>] The documents to insert.
       field :documents, Document, true
+
+      # Converts legacy insert messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # Insert field constant.
+        #
+        # @since 2.1.0
+        INSERT = 'insert'.freeze
+
+        # Documents field constant.
+        #
+        # @since 2.1.0
+        DOCUMENTS = 'documents'.freeze
+
+        # Ordered field constant.
+        #
+        # @since 2.1.0
+        ORDERED = 'ordered'.freeze
+
+        # Write concern field constant.
+        #
+        # @since 2.1.0
+        WRITE_CONCERN = 'writeConcern'.freeze
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ Array<BSON::Document> ] documents The documents to insert.
+        attr_reader :documents
+
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', documents)
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Array<BSON::Document> ] documents The documents.
+        # @param [ Hash ] options The options.
+        #
+        # @since 2.1.0
+        def initialize(collection, documents, options)
+          @collection = collection
+          @documents = documents
+          @options = options
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          document = BSON::Document.new
+          document.store(INSERT, collection)
+          document.store(DOCUMENTS, documents)
+          document.store(ORDERED, options.fetch(:ordered, true))
+          document.merge!(WRITE_CONCERN => options[:write_concern].options) if options[:write_concern]
+          document
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/kill_cursors.rb

@@ -28,31 +28,37 @@ module Mongo
       # @example Kill the cursor on the server with id 1.
       #   KillCursors.new([1])
       #
-      # @param cursor_ids [Array<Fixnum>] The cursor ids to kill.
-      # @param options [Hash] The additional kill cursors options.
-      def initialize(cursor_ids, options = {})
+      # @param [ Mongo::Database ] collection The collection.
+      # @param [ Mongo::Database ] database The database.
+      # @param [ Array<Fixnum> ] cursor_ids The cursor ids to kill.
+      def initialize(collection, database, cursor_ids)
+        @database = database
         @cursor_ids = cursor_ids
         @id_count   = @cursor_ids.size
+        @upconverter = Upconverter.new(collection, cursor_ids)
       end
 
-      # The log message for a kill cursors operation.
+      # Return the event payload for monitoring.
       #
-      # @example Get the log message.
-      #   kill_cursors.log_message
+      # @example Return the event payload.
+      #   message.payload
       #
-      # @return [ String ] The log message
+      # @return [ Hash ] The event payload.
       #
-      # @since 2.0.0
-      def log_message
-        fields = []
-        fields << ["%s |", "KILLCURSORS"]
-        fields << ["cursor_ids=%s", cursor_ids.inspect]
-        f, v = fields.transpose
-        f.join(" ") % v
+      # @since 2.1.0
+      def payload
+        {
+          command_name: 'killCursors',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify +KillCursors+ message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -69,6 +75,45 @@ module Mongo
       # @!attribute
       # @return [Array<Fixnum>] Cursors to kill.
       field :cursor_ids, Int64, true
+
+      # Converts legacy insert 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 [ Array<Integer> ] cursor_ids The cursor ids.
+        attr_reader :cursor_ids
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', [ 1, 2, 3 ])
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Array<Integer> ] cursor_ids The cursor ids.
+        #
+        # @since 2.1.0
+        def initialize(collection, cursor_ids)
+          @collection = collection
+          @cursor_ids = cursor_ids
+        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(killCursors: collection, cursors: cursor_ids)
+        end
+      end
     end
   end
 end

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,33 +58,32 @@ module Mongo
       #   Supported flags: +:tailable_cursor+, +:slave_ok+, +:oplog_replay+,
       #   +:no_cursor_timeout+, +:await_data+, +:exhaust+, +:partial+
       def initialize(database, collection, selector, options = {})
-        @namespace   = "#{database}.#{collection}"
-        @selector    = selector
-        @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
 
-      # The log message for a query operation.
+      # Return the event payload for monitoring.
       #
-      # @example Get the log message.
-      #   query.log_message
+      # @example Return the event payload.
+      #   message.payload
       #
-      # @return [ String ] The log message
+      # @return [ Hash ] The event payload.
       #
-      # @since 2.0.0
-      def log_message
-        fields = []
-        fields << ["%s |", query_type]
-        fields << ["namespace=%s", namespace]
-        fields << ["selector=%s", formatted_selector]
-        fields << ["flags=%s", flags.inspect]
-        fields << ["limit=%s", limit.inspect]
-        fields << ["skip=%s", skip.inspect]
-        fields << ["project=%s", project.inspect]
-        f, v = fields.transpose
-        f.join(" ") % v
+      # @since 2.1.0
+      def payload
+        {
+          command_name: upconverter.command_name,
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       # Query messages require replies from the database.
@@ -107,21 +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 query_type
-        namespace.include?(Database::COMMAND) ? 'COMMAND' : 'QUERY'
-      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.
@@ -159,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

@@ -38,8 +38,24 @@ module Mongo
         flags.include?(:query_failure)
       end
 
+      # Return the event payload for monitoring.
+      #
+      # @example Return the event payload.
+      #   message.payload
+      #
+      # @return [ Hash ] The event payload.
+      #
+      # @since 2.1.0
+      def payload
+        { 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
@@ -79,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

@@ -74,7 +74,7 @@ module Mongo
         # @param value [String] The string to be serialized.
         # @return [String] Buffer with serialized value.
         def self.serialize(buffer, value)
-          buffer << value
+          buffer << value.force_encoding(BSON::BINARY)
           buffer << NULL
         end
       end