mongo 2.4.3 → 2.5.0.beta

data/lib/mongo/operation/write/command/update.rb

@@ -27,6 +27,7 @@ module Mongo
         #       :bar => 1 }},
         #       :multi  => true,
         #       :upsert => false
+        #       :array_filters => []
         #     }],
         #     :db_name => 'test',
         #     :coll_name => 'test_coll',
@@ -42,17 +43,31 @@ module Mongo
 
           private
 
-          # The query selector for this update command operation.
-          #
-          # @return [ Hash ] The selector describing this update operation.
+          IDENTIFIER = 'updates'.freeze
+
           def selector
             { update: coll_name,
-              updates: updates,
-              ordered: ordered?
-            }.tap do |cmd|
-              cmd.merge!(writeConcern: write_concern.options) if write_concern
-              cmd.merge!(:bypassDocumentValidation => true) if bypass_document_validation
-              cmd.merge!(:collation => collation) if collation
+              updates: updates
+            }.merge(command_options)
+          end
+
+          def op_msg(server)
+            global_args = { update: coll_name,
+                            Protocol::Msg::DATABASE_IDENTIFIER => db_name
+                          }.merge!(command_options)
+            add_cluster_time!(global_args, server)
+            session.add_id!(global_args) if session
+
+            section = { type: 1, payload: { identifier: IDENTIFIER, sequence: updates } }
+            flags = unacknowledged_write? ? [:more_to_come] : [:none]
+            Protocol::Msg.new(flags, {}, global_args, section)
+          end
+
+          def message(server)
+            if server.features.op_msg_enabled?
+              op_msg(server)
+            else
+              Protocol::Query.new(db_name, Database::COMMAND, selector, options)
             end
           end
         end

data/lib/mongo/operation/write/command/writable.rb

@@ -23,6 +23,7 @@ module Mongo
         # @since 2.0.0
         module Writable
           include Limited
+          include UsesCommandOpMsg
 
           # Execute the operation.
           #
@@ -42,13 +43,25 @@ module Mongo
 
           private
 
+          def command_options
+            opts = { ordered: ordered? }
+            opts[:writeConcern] = write_concern.options if write_concern
+            opts[:collation] = collation if collation
+            opts[:bypassDocumentValidation] = true if bypass_document_validation
+            opts
+          end
+
           # The wire protocol message for this write operation.
           #
           # @return [ Mongo::Protocol::Query ] Wire protocol message.
           #
           # @since 2.0.0
           def message(server)
-            Protocol::Query.new(db_name, Database::COMMAND, selector, options)
+            if server.features.op_msg_enabled?
+              command_op_msg(server, selector, options)
+            else
+              Protocol::Query.new(db_name, Database::COMMAND, selector, options)
+            end
           end
         end
       end

data/lib/mongo/operation/write/insert.rb

@@ -52,7 +52,10 @@ module Mongo
 
         def execute_write_command(server)
           command_spec = spec.merge(:documents => ensure_ids(documents))
-          Result.new(Command::Insert.new(command_spec).execute(server), @ids).validate!
+          result = Result.new(Command::Insert.new(command_spec).execute(server), @ids)
+          server.update_cluster_time(result)
+          session.process(result) if session
+          result.validate!
         end
 
         def execute_message(server)

data/lib/mongo/operation/write/insert/result.rb

@@ -35,12 +35,12 @@ module Mongo
           # @example Instantiate the result.
           #   Result.new(replies, inserted_ids)
           #
-          # @param [ Protocol::Reply ] replies The wire protocol replies.
+          # @param [ Protocol::Message ] replies The wire protocol replies.
           # @param [ Array<Object> ] ids The ids of the inserted documents.
           #
           # @since 2.0.0
           def initialize(replies, ids)
-            @replies = replies.is_a?(Protocol::Reply) ? [ replies ] : replies
+            @replies = [ *replies ] if replies
             @inserted_ids = ids
           end
 

data/lib/mongo/operation/write/update.rb

@@ -31,12 +31,13 @@ module Mongo
       #         :u => { :$set => { :bar => 1 }},
       #         :multi  => true,
       #         :upsert => false
+      #         :array_filters => []
       #       },
       #     :db_name => 'test',
       #     :coll_name => 'test_coll',
       #     :write_concern => write_concern
       #   })
-      #
+
       # Initialization:
       #   param [ Hash ] spec The specifications for the update.
       #
@@ -63,6 +64,10 @@ module Mongo
           Command::Update.new(s)
         end
 
+        def has_array_filters?
+          update[Operation::ARRAY_FILTERS]
+        end
+
         def has_collation?
           update[:collation] || update[Operation::COLLATION]
         end
@@ -71,6 +76,7 @@ module Mongo
           flags = []
           flags << :multi_update if update[Operation::MULTI]
           flags << :upsert if update[Operation::UPSERT]
+
           Protocol::Update.new(
             db_name,
             coll_name,

data/lib/mongo/operation/write/write_command_enabled.rb

@@ -34,16 +34,30 @@ module Mongo
         #
         # @since 2.1.0
         def execute(server)
-          if !server.features.write_command_enabled? || unacknowledged_write?
+          if unacknowledged_write?
             raise Error::UnsupportedCollation.new(Error::UnsupportedCollation::UNACKNOWLEDGED_WRITES_MESSAGE) if has_collation?
+            raise Error::UnsupportedArrayFilters.new(Error::UnsupportedArrayFilters::UNACKNOWLEDGED_WRITES_MESSAGE) if has_array_filters?
+          end
+
+          if !server.features.write_command_enabled? # version < 2.4
             execute_message(server)
-          else
+          elsif server.features.op_msg_enabled? # version 3.6
             execute_write_command(server)
+          else # server version is 2.6 through 3.4
+            if unacknowledged_write?
+              execute_message(server)
+            else
+              execute_write_command(server)
+            end
           end
         end
 
         private
 
+        def has_array_filters?
+          false
+        end
+
         def has_collation?
           false
         end
@@ -54,7 +68,10 @@ module Mongo
 
         def execute_write_command(server)
           result_class = self.class.const_defined?(:Result, false) ? self.class::Result : Result
-          result_class.new(write_command_op.execute(server)).validate!
+          result = result_class.new(write_command_op.execute(server))
+          server.update_cluster_time(result)
+          session.process(result) if session
+          result.validate!
         end
       end
     end

data/lib/mongo/protocol.rb

@@ -1,15 +1,18 @@
 # Wire Protocol Base
 require 'mongo/protocol/serializers'
+require 'mongo/protocol/registry'
 require 'mongo/protocol/bit_vector'
 require 'mongo/protocol/message'
 
 # Client Requests
+require 'mongo/protocol/compressed'
 require 'mongo/protocol/delete'
 require 'mongo/protocol/get_more'
 require 'mongo/protocol/insert'
 require 'mongo/protocol/kill_cursors'
 require 'mongo/protocol/query'
 require 'mongo/protocol/update'
+require 'mongo/protocol/msg'
 
 # Server Responses
 require 'mongo/protocol/reply'

data/lib/mongo/protocol/bit_vector.rb

@@ -28,7 +28,7 @@ module Mongo
         def initialize(layout)
           @masks = {}
           layout.each_with_index do |field, index|
-            @masks[field] = 2**index
+            @masks[field] = 2**index if field
           end
         end
 
@@ -40,7 +40,7 @@ module Mongo
         # @return [ String ] Buffer that received the serialized vector
         def serialize(buffer, value, validating_keys = BSON::Config.validating_keys?)
           bits = 0
-          value.each { |flag| bits |= @masks[flag] }
+          value.each { |flag| bits |= (@masks[flag] || 0) }
           buffer.put_int32(bits)
         end
 

data/lib/mongo/protocol/compressed.rb

@@ -0,0 +1,135 @@
+# 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.
+
+require 'zlib'
+
+module Mongo
+  module Protocol
+
+    # MongoDB Wire protocol Compressed message.
+    #
+    # This is a bi-directional message that compresses another opcode.
+    #
+    # @api semipublic
+    #
+    # @since 2.5.0
+    class Compressed < Message
+
+      # The byte signaling that the message has been compressed with Zlib.
+      #
+      # @since 2.5.0
+      ZLIB_BYTE = 2.chr.force_encoding(BSON::BINARY).freeze
+
+      # The Zlib compressor identifier.
+      #
+      # @since 2.5.0
+      ZLIB = 'zlib'.freeze
+
+      # The compressor identifier to byte map.
+      #
+      # @since 2.5.0
+      COMPRESSOR_ID_MAP = { ZLIB => ZLIB_BYTE }.freeze
+
+      # Creates a new OP_COMPRESSED message.
+      #
+      # @example Create an OP_COMPRESSED message.
+      #   Compressed.new(original_message, 'zlib')
+      #
+      # @param [ Mongo::Protocol::Message ] message The original message.
+      # @param [ String, Symbol ] compressor The compression algorithm to use.
+      # @param [ Integer ] level The zlib compression level to use. -1 and nil imply default.
+      #
+      # @since 2.5.0
+      def initialize(message, compressor, zlib_compression_level = nil)
+        @original_message = message
+        @original_op_code = message.op_code
+        @uncompressed_size = 0
+        @compressor_id = COMPRESSOR_ID_MAP[compressor]
+        @compressed_message = ''
+        @zlib_compression_level = zlib_compression_level if zlib_compression_level && zlib_compression_level != -1
+        @request_id = message.set_request_id
+      end
+
+      # Inflate an OP_COMRESSED message and return the original message.
+      #
+      # @example Inflate a compressed message.
+      #  message.inflate!
+      #
+      # @return [ Protocol::Message ] The inflated message.
+      #
+      # @since 2.5.0
+      def inflate!
+        message = Registry.get(@original_op_code).allocate
+        uncompressed_message = Zlib::Inflate.inflate(@compressed_message)
+
+        buf = BSON::ByteBuffer.new(uncompressed_message)
+
+        message.send(:fields).each do |field|
+          if field[:multi]
+            Message.deserialize_array(message, buf, field)
+          else
+            Message.deserialize_field(message, buf, field)
+          end
+        end
+        message
+      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?
+        @original_message.replyable?
+      end
+
+      private
+
+      # The operation code for a +Compressed+ message.
+      # @return [ Fixnum ] the operation code.
+      #
+      # @since 2.5.0
+      OP_CODE = 2012
+
+      # @!attribute
+      # Field representing the original message's op code as an Int32.
+      field :original_op_code, Int32
+
+      # @!attribute
+      # @return [ Fixnum ] The size of the original message, excluding header as an Int32.
+      field :uncompressed_size, Int32
+
+      # @!attribute
+      # @return [ String ] The id of the compressor as a single byte.
+      field :compressor_id, Byte
+
+      # @!attribute
+      # @return [ String ] The actual compressed message bytes.
+      field :compressed_message, Bytes
+
+      def serialize_fields(buffer, max_bson_size)
+        buf = BSON::ByteBuffer.new
+        @original_message.send(:serialize_fields, buf, max_bson_size)
+        @uncompressed_size = buf.length
+        @compressed_message = Zlib::Deflate.deflate(buf.to_s, @zlib_compression_level).force_encoding(BSON::BINARY)
+        super
+      end
+
+      Registry.register(OP_CODE, self)
+    end
+  end
+end

data/lib/mongo/protocol/delete.rb

@@ -54,16 +54,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: 'delete',
           database_name: @database,
           command: upconverter.command,
           request_id: request_id
-        }
+        )
       end
 
       protected
@@ -74,9 +74,9 @@ module Mongo
 
       # The operation code required to specify a Delete message.
       # @return [Fixnum] the operation code.
-      def op_code
-        2006
-      end
+      #
+      # @since 2.5.0
+      OP_CODE = 2006
 
       # Available flags for a Delete message.
       FLAGS = [:single_remove]
@@ -162,6 +162,8 @@ module Mongo
           end
         end
       end
+
+      Registry.register(OP_CODE, self)
     end
   end
 end

data/lib/mongo/protocol/get_more.rb

@@ -50,16 +50,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: 'getMore',
           database_name: @database,
           command: upconverter.command,
           request_id: request_id
-        }
+        )
       end
 
       # Get more messages require replies from the database.
@@ -82,9 +82,9 @@ module Mongo
 
       # The operation code required to specify a GetMore message.
       # @return [Fixnum] the operation code.
-      def op_code
-        2005
-      end
+      #
+      # @since 2.5.0
+      OP_CODE = 2005
 
       # Field representing Zero encoded as an Int32
       field :zero, Zero
@@ -154,6 +154,8 @@ module Mongo
           document
         end
       end
+
+      Registry.register(OP_CODE, self)
     end
   end
 end