mongo 2.11.4 → 2.12.3

data/lib/mongo/grid/fs_bucket.rb

@@ -177,7 +177,7 @@ module Mongo
       #
       # @since 2.0.0
       def prefix
-        @options[:fs_name] || @options[:bucket_name]|| DEFAULT_ROOT
+        @options[:fs_name] || @options[:bucket_name] || DEFAULT_ROOT
       end
 
       # Remove a single file from the GridFS.
@@ -230,7 +230,8 @@ module Mongo
       #
       # @since 2.1.0
       def open_download_stream(id, options = nil)
-        read_stream(id, options).tap do |stream|
+        options = Hash[(options || {}).map { |k, v| [k.to_sym, v] }]
+        read_stream(id, **options).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -348,15 +349,15 @@ module Mongo
         download_to_stream(open_download_stream_by_name(filename, opts).file_id, io)
       end
 
-      # Opens an upload stream to GridFS to which the contents of a user file came be written.
+      # Opens an upload stream to GridFS to which the contents of a file or
+      # blob can be written.
       #
-      # @example Open a stream to which the contents of a file came be written.
-      #   fs.open_upload_stream('a-file.txt')
-      #
-      # @param [ String ] filename The filename of the file to upload.
+      # @param [ String ] filename The name of the file in GridFS.
       # @param [ Hash ] opts The options for the write stream.
       #
-      # @option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise.
+      # @option opts [ Object ] :file_id An optional unique file id.
+      #   A BSON::ObjectId is automatically generated if a file id is not
+      #   provided.
       # @option opts [ Integer ] :chunk_size Override the default chunk size.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
@@ -375,7 +376,8 @@ module Mongo
       #
       # @since 2.1.0
       def open_upload_stream(filename, opts = {})
-        write_stream(filename, opts).tap do |stream|
+        opts = Hash[opts.map { |k, v| [k.to_sym, v] }]
+        write_stream(filename, **opts).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -462,12 +464,12 @@ module Mongo
       #
       # @option opts [ BSON::Document ] :file_info_doc For internal
       #   driver use only. A BSON document to use as file information.
-      def read_stream(id, opts = nil)
-        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts || {}))
+      def read_stream(id, **opts)
+        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts))
       end
 
-      def write_stream(filename, opts)
-        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.merge!(options).merge!(opts))
+      def write_stream(filename, **opts)
+        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.update(options).update(opts))
       end
 
       def chunks_name

data/lib/mongo/grid/stream/write.rb

@@ -82,12 +82,12 @@ module Mongo
             @open = true
           end
 
-          # Write to the GridFS bucket from the source stream.
+          # Write to the GridFS bucket from the source stream or a string.
           #
           # @example Write to GridFS.
           #   stream.write(io)
           #
-          # @param [ IO ] io The source io stream to upload from.
+          # @param [ String | IO ] io The string or IO object to upload from.
           #
           # @return [ Stream::Write ] self The write stream itself.
           #
@@ -95,7 +95,13 @@ module Mongo
           def write(io)
             ensure_open!
             @indexes ||= ensure_indexes!
-            @length += io.size
+            @length += if io.respond_to?(:bytesize)
+              # String objects
+              io.bytesize
+            else
+              # IO objects
+              io.size
+            end
             chunks = File::Chunk.split(io, file_info, @n)
             @n += chunks.size
             chunks_collection.insert_many(chunks) unless chunks.empty?

data/lib/mongo/index/view.rb

@@ -158,7 +158,7 @@ module Mongo
                   session: session
                  }
           spec[:write_concern] = write_concern if server.features.collation_enabled?
-          Operation::CreateIndex.new(spec).execute(server)
+          Operation::CreateIndex.new(spec).execute(server, client: client)
         end
       end
 
@@ -236,7 +236,7 @@ module Mongo
                  }
           server = next_primary(nil, session)
           spec[:write_concern] = write_concern if server.features.collation_enabled?
-          Operation::DropIndex.new(spec).execute(server)
+          Operation::DropIndex.new(spec).execute(server, client: client)
         end
       end
 
@@ -272,7 +272,7 @@ module Mongo
       end
 
       def send_initial_query(server, session)
-        initial_query_op(session).execute(server)
+        initial_query_op(session).execute(server, client: client)
       end
 
       def with_generated_names(models, server)

data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb

@@ -57,7 +57,7 @@ module Mongo
           # Create the event.
           #
           # @param [ Address ] address
-          # @param [ Symbol ] symbol
+          # @param [ Symbol ] reason
           #
           # @since 2.9.0
           # @api private

data/lib/mongo/monitoring/event/command_started.rb

@@ -99,7 +99,12 @@ module Mongo
             address,
             payload[:request_id],
             operation_id,
-            payload[:command],
+            # All op_msg  payloads have a $db field. Legacy payloads do not
+            # have a $db field. To emulate op_msg when publishing command
+            # monitoring events for legacy servers, add $db to the payload,
+            # copying the database name. Note that the database name is also
+            # available as a top-level attribute on the command started event.
+            payload[:command].merge('$db' => payload[:database_name]),
             socket_object_id: socket_object_id,
             connection_id: connection_id,
           )

data/lib/mongo/operation/collections_info.rb

@@ -31,17 +31,20 @@ module Mongo
       # Execute the operation.
       #
       # @example
-      #   operation.execute(server)
+      #   operation.execute(server, client: nil)
       #
       # @param [ Mongo::Server ] server The server to send the operation to.
+      # @param [ Mongo::Client ] client The client that will be used to
+      #   perform auto-encryption if it is necessary to encrypt the command
+      #   being executed (optional).
       #
       # @return [ Mongo::Operation::CollectionsInfo::Result,
       #           Mongo::Operation::ListCollections::Result ] The operation result.
       #
       # @since 2.0.0
-      def execute(server)
+      def execute(server, client:)
         if server.features.list_collections_enabled?
-          return Operation::ListCollections.new(spec).execute(server)
+          return Operation::ListCollections.new(spec).execute(server, client: client)
         end
 
         super

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

@@ -36,7 +36,7 @@ module Mongo
         end
 
         def message(server)
-          section = {  type: 1, payload: { identifier: IDENTIFIER, sequence: send(IDENTIFIER) } }
+          section = Protocol::Msg::Section1.new(IDENTIFIER, send(IDENTIFIER))
           Protocol::Msg.new(flags, {}, command(server), section)
         end
       end

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

@@ -19,9 +19,12 @@ module Mongo
       # Execute the operation.
       #
       # @example
-      #   operation.execute(server)
+      #   operation.execute(server, client: nil)
       #
       # @param [ Mongo::Server ] server The server to send the operation to.
+      # @param [ Mongo::Client ] client The client that will be used to
+      #   perform auto-encryption if it is necessary to encrypt the command
+      #   being executed (optional).
       #
       # @return [ Mongo::Operation::Find::Result ] The operation result.
       #

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

@@ -19,9 +19,12 @@ module Mongo
       # Execute the operation.
       #
       # @example
-      #   operation.execute(server)
+      #   operation.execute(server, client: nil)
       #
       # @param [ Mongo::Server ] server The server to send the operation to.
+      # @param [ Mongo::Client ] client The client that will be used to
+      #   perform auto-encryption if it is necessary to encrypt the command
+      #   being executed (optional).
       #
       # @return [ Mongo::Operation::GetMore::Result ] The operation result.
       #

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

@@ -32,8 +32,9 @@ module Mongo
 
         private
 
-        def get_result(server)
-          Result.new(dispatch_message(server), @ids)
+        def get_result(server, client, options = {})
+          # This is a Mongo::Operation::Insert::Result
+          Result.new(*dispatch_message(server, client), @ids)
         end
 
         def selector(server)

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

@@ -30,8 +30,9 @@ module Mongo
 
         private
 
-        def get_result(server)
-          Result.new(dispatch_message(server), @ids)
+        def get_result(server, client, options = {})
+          # This is a Mongo::Operation::Insert::Result
+          Result.new(dispatch_message(server, client), @ids)
         end
 
         def selector

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

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(server)
+        def get_result(server, client, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(dispatch_message(server), @ids)
+          Result.new(dispatch_message(server, client), @ids)
         end
 
         def selector(server)
@@ -42,7 +42,7 @@ module Mongo
         end
 
         def message(server)
-          section = { type: 1, payload: { identifier: IDENTIFIER, sequence: send(IDENTIFIER) } }
+          section = Protocol::Msg::Section1.new(IDENTIFIER, send(IDENTIFIER))
           Protocol::Msg.new(flags, { validating_keys: true }, command(server), section)
         end
       end

data/lib/mongo/operation/result.rb

@@ -18,7 +18,13 @@ require 'mongo/operation/shared/result/use_legacy_error_parser'
 module Mongo
   module Operation
 
-    # Result wrapper for operations.
+    # Result wrapper for wire protocol replies.
+    #
+    # An operation has zero or one replies. The only operations producing zero
+    # replies are unacknowledged writes; all other operations produce one reply.
+    # This class provides an object that can be operated on (for example, to
+    # check whether an operation succeeded) even when the operation did not
+    # produce a reply (in which case it is assumed to have succeeded).
     #
     # @since 2.0.0
     class Result
@@ -67,17 +73,33 @@ module Mongo
 
       # Initialize a new result.
       #
-      # @example Instantiate the result.
-      #   Result.new(replies)
+      # For an unkacknowledged write, pass nil in replies.
       #
-      # @param [ Protocol::Reply ] replies The wire protocol replies.
+      # For all other operations, replies must be a Protocol::Message instance
+      # or an array containing a single Protocol::Message instance.
       #
-      # @since 2.0.0
+      # @param [ Protocol::Message | Array<Protocol::Message> | nil ] replies
+      #  The wire protocol replies.
+      #
+      # @api private
       def initialize(replies)
-        @replies = [ *replies ] if replies
+        if replies
+          if replies.is_a?(Array)
+            if replies.length != 1
+              raise ArgumentError, "Only one (or zero) reply is supported, given #{replies.length}"
+            end
+            reply = replies.first
+          else
+            reply = replies
+          end
+          unless reply.is_a?(Protocol::Message)
+            raise ArgumentError, "Argument must be a Message instance, but is a #{reply.class}: #{reply.inspect}"
+          end
+          @replies = [ reply ]
+        end
       end
 
-      # @return [ Array<Protocol::Reply> ] replies The wrapped wire protocol replies.
+      # @return [ Array<Protocol::Message> ] replies The wrapped wire protocol replies.
       attr_reader :replies
 
       # @api private
@@ -99,19 +121,6 @@ module Mongo
         !!@replies
       end
 
-      # Determine if this result is a collection of multiple replies from the
-      # server.
-      #
-      # @example Is the result for multiple replies?
-      #   result.multiple?
-      #
-      # @return [ true, false ] If the result is for multiple replies.
-      #
-      # @since 2.0.0
-      def multiple?
-        replies.size > 1
-      end
-
       # Get the cursor id if the response is acknowledged.
       #
       # @note Cursor ids of 0 indicate there is no cursor on the server.
@@ -146,7 +155,7 @@ module Mongo
       # @since 2.0.0
       def documents
         if acknowledged?
-          replies.flat_map{ |reply| reply.documents }
+          replies.flat_map(&:documents)
         else
           []
         end
@@ -180,12 +189,12 @@ module Mongo
         "#<#{self.class.name}:0x#{object_id} documents=#{documents}>"
       end
 
-      # Get the first reply from the result.
+      # Get the reply from the result.
       #
-      # @example Get the first reply.
-      #   result.reply
+      # Returns nil if there is no reply (i.e. the operation was an
+      # unacknowledged write).
       #
-      # @return [ Protocol::Reply ] The first reply.
+      # @return [ Protocol::Message ] The first reply.
       #
       # @since 2.0.0
       def reply
@@ -206,7 +215,7 @@ module Mongo
       # @since 2.0.0
       def returned_count
         if acknowledged?
-          multiple? ? aggregate_returned_count : reply.number_returned
+          reply.number_returned
         else
           0
         end
@@ -308,7 +317,7 @@ module Mongo
       # @since 2.0.0
       def written_count
         if acknowledged?
-          multiple? ? aggregate_written_count : (first_document[N] || 0)
+          first_document[N] || 0
         else
           0
         end

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

@@ -22,11 +22,11 @@ module Mongo
 
       include ResponseHandling
 
-      def do_execute(server)
+      def do_execute(server, client, options = {})
         unpin_maybe(session) do
           add_error_labels do
             add_server_diagnostics(server) do
-              get_result(server).tap do |result|
+              get_result(server, client, options).tap do |result|
                 process_result(result, server)
               end
             end
@@ -34,8 +34,8 @@ module Mongo
         end
       end
 
-      def execute(server)
-        do_execute(server).tap do |result|
+      def execute(server, client:, options: {})
+        do_execute(server, client, options).tap do |result|
           validate_result(result, server)
         end
       end
@@ -46,14 +46,16 @@ module Mongo
         Result
       end
 
-      def get_result(server)
-        result_class.new(dispatch_message(server))
+      def get_result(server, client, options = {})
+        result_class.new(dispatch_message(server, client, options))
       end
 
-      # Returns a Protocol::Message or nil
-      def dispatch_message(server)
+      # Returns a Protocol::Message or nil as reply.
+      def dispatch_message(server, client, options = {})
         server.with_connection do |connection|
-          connection.dispatch([ build_message(server) ], operation_id)
+          message = build_message(server)
+          message = message.maybe_encrypt(server, client)
+          connection.dispatch([ message ], operation_id, client, options)
         end
       end
 

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

@@ -21,8 +21,8 @@ module Mongo
     # @api private
     module ExecutableNoValidate
 
-      def execute(server)
-        do_execute(server)
+      def execute(server, client:)
+        do_execute(server, client)
       end
     end
   end

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

@@ -22,9 +22,9 @@ module Mongo
     module OpMsgOrCommand
       include PolymorphicLookup
 
-      def execute(server)
+      def execute(server, client:, options: {})
         operation = final_operation(server)
-        operation.execute(server)
+        operation.execute(server, client: client, options: options)
       end
 
       private

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

@@ -23,9 +23,9 @@ module Mongo
     module OpMsgOrFindCommand
       include PolymorphicLookup
 
-      def execute(server)
+      def execute(server, client:)
         operation = final_operation(server)
-        operation.execute(server)
+        operation.execute(server, client: client)
       end
 
       private