mongo 2.4.3 → 2.5.0.beta

data/lib/mongo/protocol/insert.rb

@@ -63,16 +63,16 @@ module Mongo
       # @example Return the event payload.
       #   message.payload
       #
-      # @return [ Hash ] The event payload.
+      # @return [ BSON::Document ] The event payload.
       #
       # @since 2.1.0
       def payload
-        {
+        BSON::Document.new(
           command_name: 'insert',
           database_name: @database,
           command: upconverter.command,
           request_id: request_id
-        }
+        )
       end
 
       protected
@@ -87,9 +87,9 @@ module Mongo
 
       # The operation code required to specify an Insert message.
       # @return [Fixnum] the operation code.
-      def op_code
-        2002
-      end
+      #
+      # @since 2.5.0
+      OP_CODE = 2002
 
       # Available flags for an Insert message.
       FLAGS = [:continue_on_error]
@@ -169,6 +169,8 @@ module Mongo
           document
         end
       end
+
+      Registry.register(OP_CODE, self)
     end
   end
 end

data/lib/mongo/protocol/kill_cursors.rb

@@ -44,16 +44,16 @@ module Mongo
       # @example Return the event payload.
       #   message.payload
       #
-      # @return [ Hash ] The event payload.
+      # @return [ BSON::Document ] The event payload.
       #
       # @since 2.1.0
       def payload
-        {
+        BSON::Document.new(
           command_name: 'killCursors',
           database_name: @database,
           command: upconverter.command,
           request_id: request_id
-        }
+        )
       end
 
       protected
@@ -64,9 +64,9 @@ module Mongo
 
       # The operation code required to specify +KillCursors+ message.
       # @return [Fixnum] the operation code.
-      def op_code
-        2007
-      end
+      #
+      # @since 2.5.0
+      OP_CODE = 2007
 
       # Field representing Zero encoded as an Int32.
       field :zero, Zero
@@ -130,6 +130,8 @@ module Mongo
           document
         end
       end
+
+      Registry.register(OP_CODE, self)
     end
   end
 end

data/lib/mongo/protocol/message.rb

@@ -94,6 +94,27 @@ module Mongo
         false
       end
 
+      # Compress a message.
+      #
+      # @param [ String, Symbol ] compressor The compressor to use.
+      # @param [ Integer ] zlib_compression_level The zlib compression level to use.
+      #
+      # @return [ self ] Always returns self. Other message types should override this method.
+      #
+      # @since 2.5.0
+      def compress!(compressor, zlib_compression_level = nil)
+        self
+      end
+
+      # Inflate a message.
+      #
+      # @return [ self ] Always returns self. Other message types should override this method.
+      #
+      # @since 2.5.0
+      def inflate!
+        self
+      end
+
       # Serializes message into bytes that can be sent on the wire
       #
       # @param buffer [String] buffer where the message should be inserted
@@ -128,17 +149,17 @@ module Mongo
           raise Error::UnexpectedResponse.new(expected_response_to, response_to)
         end
 
+        message = Registry.get(_op_code).allocate
         buffer = BSON::ByteBuffer.new(io.read(length - 16))
-        message = allocate
 
-        fields.each do |field|
+        message.send(:fields).each do |field|
           if field[:multi]
             deserialize_array(message, buffer, field)
           else
             deserialize_field(message, buffer, field)
           end
         end
-        message
+        message.inflate!
       end
 
       # Tests for equality between two wire protocol messages
@@ -174,6 +195,13 @@ module Mongo
         end
       end
 
+      # Default number returned value for protocol messages.
+      #
+      # @return [ 0 ] This method must be overridden, otherwise, always returns 0.
+      #
+      # @since 2.5.0
+      def number_returned; 0; end
+
       private
 
       @@request_id = 0

data/lib/mongo/protocol/msg.rb

@@ -0,0 +1,172 @@
+# Copyright (C) 2017 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Protocol
+
+    # MongoDB Wire protocol Msg message (OP_MSG), a bi-directional wire protocol opcode.
+    #
+    # OP_MSG is only available in MongoDB 3.6 (maxWireVersion >= 6) and later.
+    #
+    # @api private
+    #
+    # @since 2.5.0
+    class Msg < Message
+      include Monitoring::Event::Secure
+
+      # The identifier for the database name to execute the command on.
+      #
+      # @since 2.5.0
+      DATABASE_IDENTIFIER = '$db'.freeze
+
+      # Creates a new OP_MSG protocol message
+      #
+      # @example Create a OP_MSG wire protocol message
+      #   Msg.new([:more_to_come], {}, { ismaster: 1 },
+      #           { type: 1, payload: { identifier: 'documents', sequence: [..] } })
+      #
+      # @param [ Array<Symbol> ] flags The flag bits. Current supported values are
+      #  :more_to_come and :checksum_present.
+      # @param [ Hash ] options The options. There are currently no supported options, this is a
+      #   place-holder for the future.
+      # @param [ BSON::Document, Hash ] global_args The global arguments, becomes a section of payload type 0.
+      # @param [ BSON::Document, Hash ] sections Zero or more sections, in the format
+      #   { type: 1, payload: { identifier: <String>, sequence: <Array<BSON::Document, Hash>> } } or
+      #   { type: 0, payload: <BSON::Document, Hash> }
+      #
+      # @option options [ true, false ] validating_keys Whether keys should be validated.
+      #
+      # @api private
+      #
+      # @since 2.5.0
+      def initialize(flags, options, global_args, *sections)
+        @flags = flags || [ :none ]
+        @options = options
+        @global_args = global_args
+        @sections = [ { type: 0, payload: global_args } ] + sections
+        @request_id = nil
+        super
+      end
+
+      # Whether the message expects a reply from the database.
+      #
+      # @example Does the message require a reply?
+      #   message.replyable?
+      #
+      # @return [ true, false ] If the message expects a reply.
+      #
+      # @since 2.5.0
+      def replyable?
+        @replyable ||= !flags.include?(:more_to_come)
+      end
+
+      # Return the event payload for monitoring.
+      #
+      # @example Return the event payload.
+      #   message.payload
+      #
+      # @return [ BSON::Document ] The event payload.
+      #
+      # @since 2.5.0
+      def payload
+        BSON::Document.new(
+          command_name: command.keys.first,
+          database_name: global_args[DATABASE_IDENTIFIER],
+          command: command,
+          request_id: request_id,
+          reply: sections[0]
+        )
+      end
+
+      # Serializes message into bytes that can be sent on the wire.
+      #
+      # @param [ BSON::ByteBuffer ] buffer where the message should be inserted.
+      # @param [ Integer ] max_bson_size The maximum bson object size.
+      #
+      # @return [ BSON::ByteBuffer ] buffer containing the serialized message.
+      #
+      # @since 2.5.0
+      def serialize(buffer = BSON::ByteBuffer.new, max_bson_size = nil)
+        super
+        add_check_sum(buffer)
+        buffer
+      end
+
+      # Compress this message.
+      #
+      # @param [ String, Symbol ] compressor The compressor to use.
+      # @param [ Integer ] zlib_compression_level The zlib compression level to use.
+      #
+      # @return [ Compressed, self ] A Protocol::Compressed message or self, depending on whether
+      #  this message can be compressed.
+      #
+      # @since 2.5.0
+      def compress!(compressor, zlib_compression_level = nil)
+        if compressor && compression_allowed?(command.keys.first)
+          Compressed.new(self, compressor, zlib_compression_level)
+        else
+          self
+        end
+      end
+
+      private
+
+      def command
+        @command ||= global_args.dup.tap do |cmd|
+          cmd.delete(DATABASE_IDENTIFIER)
+          sections.each do |section|
+            if section[:type] == 1
+              identifier = section[:payload][:identifier]
+              cmd[identifier] ||= []
+              cmd[identifier] += section[:payload][:sequence]
+            end
+          end
+        end
+      end
+
+      def add_check_sum(buffer)
+        if flags.include?(:checksum_present)
+          #buffer.put_int32(checksum)
+        end
+      end
+
+      def global_args
+        @global_args ||= (sections[0] || {})
+      end
+
+      # The operation code required to specify a OP_MSG message.
+      # @return [ Fixnum ] the operation code.
+      #
+      # @since 2.5.0
+      OP_CODE = 2013
+
+      # Available flags for a OP_MSG message.
+      FLAGS = Array.new(16).tap { |arr|
+        arr[0] = :checksum_present
+        arr[1] = :more_to_come
+      }
+
+      # @!attribute
+      # @return [Array<Symbol>] The flags for this message.
+      field :flags, BitVector.new(FLAGS)
+
+      # @!attribute
+      # @return [Hash] The sections of payload type 1 or 0.
+      field :sections, Sections
+      alias :documents :sections
+
+      Registry.register(OP_CODE, self)
+    end
+  end
+end

data/lib/mongo/protocol/query.rb

@@ -29,6 +29,7 @@ module Mongo
     #
     # @api semipublic
     class Query < Message
+      include Monitoring::Event::Secure
 
       # Creates a new Query message
       #
@@ -75,16 +76,16 @@ module Mongo
       # @example Return the event payload.
       #   message.payload
       #
-      # @return [ Hash ] The event payload.
+      # @return [ BSON::Document ] The event payload.
       #
       # @since 2.1.0
       def payload
-        {
+        BSON::Document.new(
           command_name: upconverter.command_name,
           database_name: @database,
           command: upconverter.command,
           request_id: request_id
-        }
+        )
       end
 
       # Query messages require replies from the database.
@@ -99,6 +100,23 @@ module Mongo
         true
       end
 
+      # Compress this message.
+      #
+      # @param [ String, Symbol ] compressor The compressor to use.
+      # @param [ Integer ] zlib_compression_level The zlib compression level to use.
+      #
+      # @return [ Compressed, self ] A Protocol::Compressed message or self, depending on whether
+      #  this message can be compressed.
+      #
+      # @since 2.5.0
+      def compress!(compressor, zlib_compression_level = nil)
+        if compressor && compression_allowed?(selector.keys.first)
+          Compressed.new(self, compressor, zlib_compression_level)
+        else
+          self
+        end
+      end
+
       protected
 
       attr_reader :upconverter
@@ -107,9 +125,9 @@ module Mongo
 
       # The operation code required to specify a Query message.
       # @return [Fixnum] the operation code.
-      def op_code
-        2004
-      end
+      #
+      # @since 2.5.0
+      OP_CODE = 2004
 
       def determine_limit
         [ @options[:limit] || @options[:batch_size], @options[:batch_size] || @options[:limit] ].min || 0
@@ -292,6 +310,8 @@ module Mongo
           document
         end
       end
+
+      Registry.register(OP_CODE, self)
     end
   end
 end

data/lib/mongo/protocol/registry.rb

@@ -0,0 +1,76 @@
+# Copyright (C) 2009-2017 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  module Protocol
+
+    # Provides a registry for looking up a message class based on op code.
+    #
+    # @since 2.5.0
+    module Registry
+      extend self
+
+      # A Mapping of all the op codes to their corresponding Ruby classes.
+      #
+      # @since 2.5.0
+      MAPPINGS = {}
+
+      # Get the class for the given op code and raise an error if it's not found.
+      #
+      # @example Get the type for the op code.
+      #   Mongo::Protocol::Registry.get(1)
+      #
+      # @return [ Class ] The corresponding Ruby class for the message type.
+      #
+      # @since 2.5.0
+      def get(op_code, message = nil)
+        if type = MAPPINGS[op_code]
+          type
+        else
+          handle_unsupported_op_code!(op_code)
+        end
+      end
+
+      # Register the Ruby type for the corresponding op code.
+      #
+      # @example Register the op code.
+      #   Mongo::Protocol::Registry.register(1, Reply)
+      #
+      # @param [ Fixnum ] op_code The op code.
+      # @param [ Class ] type The class the op code maps to.
+      #
+      # @return [ Class ] The class.
+      #
+      # @since 2.5.0
+      def register(op_code, type)
+        MAPPINGS.store(op_code, type)
+        define_type_reader(type)
+      end
+
+      private
+
+      def define_type_reader(type)
+        type.module_eval <<-MOD
+          def op_code; OP_CODE; end
+        MOD
+      end
+
+      def handle_unsupported_op_code!(op_code)
+        message = "Detected unknown message type with op code: #{op_code}."
+        raise Error::UnsupportedMessageType.new(message)
+      end
+    end
+  end
+end