mongo 2.11.2 → 2.13.0.beta1

data/lib/mongo/operation/shared/write_concern_supported.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,14 +22,14 @@ module Mongo
 
       private
 
-      def write_concern_supported?(server); true; end
+      def write_concern_supported?(connection); true; end
 
-      def command(server)
-        add_write_concern!(super, server)
+      def command(connection)
+        add_write_concern!(super, connection)
       end
 
-      def add_write_concern!(sel, server)
-        if write_concern && write_concern_supported?(server)
+      def add_write_concern!(sel, connection)
+        if write_concern && write_concern_supported?(connection)
           sel[:writeConcern] = write_concern.options
         end
         sel

data/lib/mongo/operation/update.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,14 +32,14 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { update: coll_name,
             updates: send(IDENTIFIER),
             ordered: ordered? }
         end
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, command(server), options)
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -34,7 +34,7 @@ module Mongo
           send(IDENTIFIER).first
         end
 
-        def message(server)
+        def message(connection)
           flags = []
           flags << :multi_update if selector[Operation::MULTI]
           flags << :upsert if selector[Operation::UPSERT]

data/lib/mongo/operation/update/legacy/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,15 +29,15 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { update: coll_name,
             Protocol::Msg::DATABASE_IDENTIFIER => db_name,
             ordered: ordered? }
         end
 
-        def message(server)
-          section = { type: 1, payload: { identifier: IDENTIFIER, sequence: send(IDENTIFIER) } }
-          Protocol::Msg.new(flags, {}, command(server), section)
+        def message(connection)
+          section = Protocol::Msg::Section1.new(IDENTIFIER, send(IDENTIFIER))
+          Protocol::Msg.new(flags, {}, command(connection), section)
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -88,7 +88,7 @@ module Mongo
         end
 
         def bulk_result
-          BulkResult.new(@replies)
+          BulkResult.new(@replies, connection_description)
         end
 
         private

data/lib/mongo/operation/update_user.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/operation/update_user/command.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,12 +29,12 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :updateUser => user.name }.merge(user.spec)
         end
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, command(server), options)
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end

data/lib/mongo/operation/update_user/op_msg.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :updateUser => user.name }.merge(user.spec)
         end
       end

data/lib/mongo/operation/users_info.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/operation/users_info/command.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -30,12 +30,12 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :usersInfo => user_name }
         end
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, command(server), options(server))
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end

data/lib/mongo/operation/users_info/op_msg.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :usersInfo => user_name }
         end
       end

data/lib/mongo/operation/users_info/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/options.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/options/mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/options/redacted.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/bit_vector.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -47,9 +47,10 @@ module Mongo
         # Deserializes vector by decoding the symbol according to its mask
         #
         # @param [ String ] buffer Buffer containing the vector to be deserialized.
+        # @param [ Hash ] options This method does not currently accept any options.
         #
         # @return [ Array<Symbol> ] Flags contained in the vector
-        def deserialize(buffer)
+        def deserialize(buffer, options = {})
           vector = buffer.get_int32
           flags = []
           @masks.each do |flag, mask|

data/lib/mongo/protocol/compressed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -60,15 +60,13 @@ module Mongo
         @request_id = message.request_id
       end
 
-      # Inflate an OP_COMRESSED message and return the original message.
-      #
-      # @example Inflate a compressed message.
-      #  message.inflate!
+      # Inflates an OP_COMRESSED message and returns the original message.
       #
       # @return [ Protocol::Message ] The inflated message.
       #
       # @since 2.5.0
-      def inflate!
+      # @api private
+      def maybe_inflate
         message = Registry.get(@original_op_code).allocate
         uncompressed_message = Zlib::Inflate.inflate(@compressed_message)
 
@@ -81,6 +79,9 @@ module Mongo
             Message.deserialize_field(message, buf, field)
           end
         end
+        if message.is_a?(Msg)
+          message.fix_after_deserialization
+        end
         message
       end
 

data/lib/mongo/protocol/delete.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/get_more.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/insert.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -46,8 +46,10 @@ module Mongo
       # @param options [Hash] Additional options for the insertion.
       #
       # @option options :flags [Array] The flags for the insertion message.
-      #
       #   Supported flags: +:continue_on_error+
+      # @option options [ true, false ] validating_keys Whether keys should be
+      #   validated for being valid document keys (i.e. not begin with $ and
+      #   not contain dots).
       def initialize(database, collection, documents, options = {})
         @database = database
         @namespace = "#{database}.#{collection}"

data/lib/mongo/protocol/kill_cursors.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/protocol/message.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -95,27 +95,84 @@ module Mongo
         false
       end
 
-      # Compress a message.
+      # Compress the message, if supported by the wire protocol used and if
+      # the command being sent permits compression. Otherwise returns self.
       #
       # @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.
+      # @return [ self ] Always returns self. Other message types should
+      #   override this method.
       #
       # @since 2.5.0
-      def compress!(compressor, zlib_compression_level = nil)
+      # @api private
+      def maybe_compress(compressor, zlib_compression_level = nil)
         self
       end
 
-      # Inflate a message.
+      # Compress the message, if the command being sent permits compression.
+      # Otherwise returns self.
       #
-      # @return [ self ] Always returns self. Other message types should override this method.
+      # @param [ String ] command_name Command name extracted from the message.
+      # @param [ String | Symbol ] compressor The compressor to use.
+      # @param [ Integer ] zlib_compression_level Zlib compression level to use.
+      #
+      # @return [ Message ] A Protocol::Compressed message or self,
+      #  depending on whether this message can be compressed.
+      #
+      # @since 2.5.0
+      private def compress_if_possible(command_name, compressor, zlib_compression_level)
+        if compressor && compression_allowed?(command_name)
+          Compressed.new(self, compressor, zlib_compression_level)
+        else
+          self
+        end
+      end
+
+      # Inflate a message if it is compressed.
+      #
+      # @return [ Protocol::Message ] Always returns self. Subclasses should
+      #   override this method as necessary.
       #
       # @since 2.5.0
-      def inflate!
+      # @api private
+      def maybe_inflate
+        self
+      end
+
+      def maybe_decrypt(client)
+        # TODO determine if we should be decrypting data coming from pre-4.2
+        # servers, potentially using legacy wire protocols. If so we need
+        # to implement decryption for those wire protocols as our current
+        # encryption/decryption code is OP_MSG-specific.
+        self
+      end
+
+      def maybe_encrypt(server, client)
+        # Do nothing if the Message subclass has not implemented this method
         self
       end
 
+      private def merge_sections
+        cmd = if @sections.length > 1
+          cmd = @sections.detect { |section| section[:type] == 0 }[:payload]
+          identifier = @sections.detect { |section| section[:type] == 1}[:payload][:identifier]
+          cmd.merge(identifier.to_sym =>
+            @sections.select { |section| section[:type] == 1 }.
+              map { |section| section[:payload][:sequence] }.
+              inject([]) { |arr, documents| arr + documents }
+          )
+        elsif @sections.first[:payload]
+          @sections.first[:payload]
+        else
+          @sections.first
+        end
+        if cmd.nil?
+          raise "The command should never be nil here"
+        end
+        cmd
+      end
+
       # Serializes message into bytes that can be sent on the wire
       #
       # @param buffer [String] buffer where the message should be inserted
@@ -129,13 +186,22 @@ module Mongo
 
       alias_method :to_s, :serialize
 
-      # Deserializes messages from an IO stream
+      # Deserializes messages from an IO stream.
+      #
+      # This method returns decompressed messages (i.e. if the message on the
+      # wire was OP_COMPRESSED, this method would typically return the OP_MSG
+      # message that is the result of decompression).
       #
       # @param [ Integer ] max_message_size The max message size.
       # @param [ IO ] io Stream containing a message
+      # @param [ Hash ] options
+      #
+      # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
+      #   this message using BSON types instead of native Ruby types wherever
+      #   possible.
       #
       # @return [ Message ] Instance of a Message class
-      def self.deserialize(io, max_message_size = MAX_MESSAGE_SIZE, expected_response_to = nil)
+      def self.deserialize(io, max_message_size = MAX_MESSAGE_SIZE, expected_response_to = nil, options = {})
         length, _request_id, response_to, _op_code = deserialize_header(BSON::ByteBuffer.new(io.read(16)))
 
         # Protection from potential DOS man-in-the-middle attacks. See
@@ -155,12 +221,15 @@ module Mongo
 
         message.send(:fields).each do |field|
           if field[:multi]
-            deserialize_array(message, buffer, field)
+            deserialize_array(message, buffer, field, options)
           else
-            deserialize_field(message, buffer, field)
+            deserialize_field(message, buffer, field, options)
           end
         end
-        message.inflate!
+        if message.is_a?(Msg)
+          message.fix_after_deserialization
+        end
+        message.maybe_inflate
       end
 
       # Tests for equality between two wire protocol messages
@@ -299,11 +368,16 @@ module Mongo
       # @param message [Message] Message to contain the deserialized array.
       # @param io [IO] Stream containing the array to deserialize.
       # @param field [Hash] Hash representing a field.
+      # @param options [ Hash ]
+      #
+      # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
+      #   each of the elements in this array using BSON types wherever possible.
+      #
       # @return [Message] Message with deserialized array.
-      def self.deserialize_array(message, io, field)
+      def self.deserialize_array(message, io, field, options)
         elements = []
         count = message.instance_variable_get(field[:multi])
-        count.times { elements << field[:type].deserialize(io) }
+        count.times { elements << field[:type].deserialize(io, options) }
         message.instance_variable_set(field[:name], elements)
       end
 
@@ -312,11 +386,16 @@ module Mongo
       # @param message [Message] Message to contain the deserialized field.
       # @param io [IO] Stream containing the field to deserialize.
       # @param field [Hash] Hash representing a field.
+      # @param options [ Hash ]
+      #
+      # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
+      #   this field using BSON types wherever possible.
+      #
       # @return [Message] Message with deserialized field.
-      def self.deserialize_field(message, io, field)
+      def self.deserialize_field(message, io, field, options)
         message.instance_variable_set(
           field[:name],
-          field[:type].deserialize(io)
+          field[:type].deserialize(io, options)
         )
       end