mongo 2.11.2 → 2.13.0.beta1

data/lib/mongo/operation/kill_cursors.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/kill_cursors/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.
@@ -28,8 +28,8 @@ module Mongo
 
         private
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, selector(server), options)
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, selector(connection), options(connection))
         end
       end
     end

data/lib/mongo/operation/kill_cursors/legacy.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.
@@ -27,7 +27,7 @@ module Mongo
 
         private
 
-        def message(server)
+        def message(connection)
           Protocol::KillCursors.new(coll_name, db_name, cursor_ids)
         end
       end

data/lib/mongo/operation/kill_cursors/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.

data/lib/mongo/operation/list_collections.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/list_collections/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)
           (spec[SELECTOR] || {}).merge(listCollections: 1)
         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/list_collections/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)
           (spec[SELECTOR] || {}).merge(listCollections: 1)
         end
       end

data/lib/mongo/operation/list_collections/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/map_reduce.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/map_reduce/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.
@@ -31,8 +31,8 @@ module Mongo
 
         private
 
-        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/map_reduce/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.

data/lib/mongo/operation/map_reduce/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/op_msg_base.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.
@@ -22,8 +22,8 @@ module Mongo
 
       private
 
-      def message(server)
-        Protocol::Msg.new(flags, options, command(server))
+      def message(connection)
+        Protocol::Msg.new(flags, options(connection), command(connection))
       end
     end
   end

data/lib/mongo/operation/parallel_scan.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/parallel_scan/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,19 +30,19 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           sel = { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
           if read_concern
             sel[:readConcern] = Options::Mapper.transform_values_to_strings(
               read_concern)
           end
           sel[:maxTimeMS] = max_time_ms if max_time_ms
-          update_selector_for_read_pref(sel, server)
+          update_selector_for_read_pref(sel, connection)
           sel
         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/parallel_scan/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.
@@ -28,7 +28,7 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           sel = { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
           sel[:maxTimeMS] = max_time_ms if max_time_ms
           if read_concern

data/lib/mongo/operation/parallel_scan/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/remove_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/remove_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.
@@ -30,12 +30,12 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :dropUser => 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/remove_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)
           { :dropUser => user_name }
         end
       end

data/lib/mongo/operation/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.
@@ -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,19 +73,47 @@ 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
-      def initialize(replies)
-        @replies = [ *replies ] if replies
+      # @param [ Protocol::Message | Array<Protocol::Message> | nil ] replies
+      #  The wire protocol replies.
+      # @param [ Server::Description | nil ] connection_description
+      #   Server description of the server that performed the operation that
+      #   this result is for. This parameter is allowed to be nil for
+      #   compatibility with existing mongo_kerberos library, but should
+      #   always be not nil in the driver proper.
+      #
+      # @api private
+      def initialize(replies, connection_description = nil)
+        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 ]
+          @connection_description = connection_description
+        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
 
+      # @return [ Server::Description ] Server description of the server that
+      #   the operation was performed on that this result is for.
+      #
+      # @api private
+      attr_reader :connection_description
+
       # @api private
       def_delegators :parser,
         :not_master?, :node_recovering?, :node_shutting_down?
@@ -99,19 +133,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 +167,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 +201,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 +227,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
@@ -282,11 +303,14 @@ module Mongo
           self,
           code: parser.code,
           code_name: parser.code_name,
-          write_concern_error: parser.write_concern_error?,
+          write_concern_error_document: parser.write_concern_error_document,
           write_concern_error_code: parser.write_concern_error_code,
           write_concern_error_code_name: parser.write_concern_error_code_name,
+          write_concern_error_labels: parser.write_concern_error_labels,
           labels: parser.labels,
-          wtimeout: parser.wtimeout)
+          wtimeout: parser.wtimeout,
+          connection_description: connection_description,
+        )
       end
 
       # Raises a Mongo::OperationFailure exception corresponding to the
@@ -298,6 +322,15 @@ module Mongo
       end
       private :raise_operation_failure
 
+      # @return [ TopologyVersion | nil ] The topology version.
+      def topology_version
+        unless defined?(@topology_version)
+          @topology_version = first_document['topologyVersion'] &&
+            TopologyVersion.new(first_document['topologyVersion'])
+        end
+        @topology_version
+      end
+
       # Get the number of documents written by the server.
       #
       # @example Get the number of documents written.
@@ -308,7 +341,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/bypass_document_validation.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.
@@ -22,12 +22,18 @@ module Mongo
 
       private
 
-      def command(server)
+      def command(connection)
+        if Lint.enabled?
+          unless connection.is_a?(Server::Connection)
+            raise Error::LintError, "Connection is not a Connection instance: #{connection}"
+          end
+        end
+
         sel = super
-        add_bypass_document_validation(sel, server)
+        add_bypass_document_validation(sel)
       end
 
-      def add_bypass_document_validation(sel, server)
+      def add_bypass_document_validation(sel)
         return sel unless bypass_document_validation
         sel.merge(bypassDocumentValidation: true)
       end