mongo 2.10.5 → 2.15.1

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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 +31,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,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -19,11 +22,13 @@ module Mongo
       # Defines custom behavior of results in a parallel scan.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The name of the cursors field in the result.
         #
         # @since 2.0.0
+        # @api private
         CURSORS = 'cursors'.freeze
 
         # Get all the cursor ids from the result.
@@ -34,6 +39,7 @@ module Mongo
         # @return [ Array<Integer> ] The cursor ids.
         #
         # @since 2.0.0
+        # @api private
         def cursor_ids
           documents.map {|doc| doc[CURSOR][CURSOR_ID]}
         end
@@ -46,6 +52,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
           reply.documents[0][CURSORS]
         end

data/lib/mongo/operation/parallel_scan.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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,15 +29,16 @@ module Mongo
         include Executable
         include Limited
         include ReadPreferenceSupported
+        include WriteConcernSupported
 
         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,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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 +29,7 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { :dropUser => user_name }
         end
       end

data/lib/mongo/operation/remove_user.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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/result.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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,9 +21,16 @@ 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
+    # @api semiprivate
     class Result
       extend Forwardable
       include Enumerable
@@ -28,58 +38,96 @@ module Mongo
       # The field name for the cursor document in an aggregation.
       #
       # @since 2.2.0
+      # @api private
       CURSOR = 'cursor'.freeze
 
       # The cursor id field in the cursor document.
       #
       # @since 2.2.0
+      # @api private
       CURSOR_ID = 'id'.freeze
 
       # The field name for the first batch of a cursor.
       #
       # @since 2.2.0
+      # @api private
       FIRST_BATCH = 'firstBatch'.freeze
 
       # The field name for the next batch of a cursor.
       #
       # @since 2.2.0
+      # @api private
       NEXT_BATCH = 'nextBatch'.freeze
 
       # The namespace field in the cursor document.
       #
       # @since 2.2.0
+      # @api private
       NAMESPACE = 'ns'.freeze
 
       # The number of documents updated in the write.
       #
       # @since 2.0.0
+      # @api private
       N = 'n'.freeze
 
       # The ok status field in the result.
       #
       # @since 2.0.0
+      # @api private
       OK = 'ok'.freeze
 
       # The result field constant.
       #
       # @since 2.2.0
+      # @api private
       RESULT = 'result'.freeze
 
       # 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.
+      #
+      # @api private
       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?
@@ -95,23 +143,11 @@ module Mongo
       # @return [ true, false ] If the result is acknowledged.
       #
       # @since 2.0.0
+      # @api public
       def acknowledged?
         !!@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.
@@ -122,6 +158,7 @@ module Mongo
       # @return [ Integer ] The cursor id.
       #
       # @since 2.0.0
+      # @api private
       def cursor_id
         acknowledged? ? replies.last.cursor_id : 0
       end
@@ -132,6 +169,7 @@ module Mongo
       # @return [ Nil ]
       #
       # @since 2.0.0
+      # @api private
       def namespace
         nil
       end
@@ -144,9 +182,10 @@ module Mongo
       # @return [ Array<BSON::Document> ] The documents.
       #
       # @since 2.0.0
+      # @api public
       def documents
         if acknowledged?
-          replies.flat_map{ |reply| reply.documents }
+          replies.flat_map(&:documents)
         else
           []
         end
@@ -161,9 +200,10 @@ module Mongo
       #
       # @return [ Enumerator ] The enumerator.
       #
-      # @since 2.0.0
-      #
       # @yieldparam [ BSON::Document ] Each document in the result.
+      #
+      # @since 2.0.0
+      # @api public
       def each(&block)
         documents.each(&block)
       end
@@ -176,18 +216,20 @@ module Mongo
       # @return [ String ] The inspection.
       #
       # @since 2.0.0
+      # @api public
       def inspect
         "#<#{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
+      # @api private
       def reply
         if acknowledged?
           replies.first
@@ -204,9 +246,10 @@ module Mongo
       # @return [ Integer ] The number of documents returned.
       #
       # @since 2.0.0
+      # @api public
       def returned_count
         if acknowledged?
-          multiple? ? aggregate_returned_count : reply.number_returned
+          reply.number_returned
         else
           0
         end
@@ -224,6 +267,7 @@ module Mongo
       # @return [ true, false ] If the command was successful.
       #
       # @since 2.0.0
+      # @api public
       def successful?
         return true if !acknowledged?
         if first_document.has_key?(OK)
@@ -241,6 +285,7 @@ module Mongo
       # @return [ true, false ] If the command returned ok.
       #
       # @since 2.1.0
+      # @api public
       def ok?
         # first_document[OK] is a float, and the server can return
         # ok as a BSON int32, BSON int64 or a BSON double.
@@ -264,6 +309,7 @@ module Mongo
       # @return [ Result ] The result if verification passed.
       #
       # @since 2.0.0
+      # @api private
       def validate!
         !successful? ? raise_operation_failure : self
       end
@@ -282,21 +328,36 @@ 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,
+          document: parser.document,
+          server_message: parser.server_message,
+        )
       end
 
       # Raises a Mongo::OperationFailure exception corresponding to the
       # error information in this result.
       #
       # @raise Error::OperationFailure
-      def raise_operation_failure
+      private def raise_operation_failure
         raise error
       end
-      private :raise_operation_failure
+
+      # @return [ TopologyVersion | nil ] The topology version.
+      #
+      # @api private
+      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.
       #
@@ -306,13 +367,16 @@ module Mongo
       # @return [ Integer ] The number of documents written.
       #
       # @since 2.0.0
+      # @api public
       def written_count
         if acknowledged?
-          multiple? ? aggregate_written_count : (first_document[N] || 0)
+          first_document[N] || 0
         else
           0
         end
       end
+
+      # @api public
       alias :n :written_count
 
       # Get the operation time reported in the server response.
@@ -320,9 +384,10 @@ module Mongo
       # @example Get the operation time.
       #   result.operation_time
       #
-      # @return [ Object ] The operation time value.
+      # @return [ Object | nil ] The operation time value.
       #
       # @since 2.5.0
+      # @api public
       def operation_time
         first_document && first_document[OPERATION_TIME]
       end
@@ -332,13 +397,14 @@ module Mongo
       # @example Get the cluster time.
       #   result.cluster_time
       #
-      # @return [ nil | ClusterTime ] The cluster time document.
+      # @return [ ClusterTime | nil ] The cluster time document.
       #
       # Changed in version 2.9.0: This attribute became an instance of
       # ClusterTime, which is a subclass of BSON::Document.
       # Previously it was an instance of BSON::Document.
       #
       # @since 2.5.0
+      # @api public
       def cluster_time
         first_document && ClusterTime[first_document['$clusterTime']]
       end
@@ -351,6 +417,7 @@ module Mongo
       # @return [ Array ] labels The set of labels.
       #
       # @since 2.7.0
+      # @api private
       def labels
         @labels ||= parser.labels
       end

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -18,16 +21,23 @@ module Mongo
     # Custom behavior for operations that support the bypassdocumentvalidation option.
     #
     # @since 2.5.2
+    # @api private
     module BypassDocumentValidation
 
       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

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -18,6 +21,7 @@ module Mongo
     # Custom behavior for operations that support causal consistency.
     #
     # @since 2.5.2
+    # @api private
     module CausalConsistencySupported
 
       private
@@ -33,8 +37,8 @@ module Mongo
       # In order for the override to work correctly the
       # CausalConsistencySupported module must be included after
       # SessionsSupported module in target classes.
-      def apply_causal_consistency!(selector, server)
-        apply_causal_consistency_if_possible(selector, server)
+      def apply_causal_consistency!(selector, connection)
+        apply_causal_consistency_if_possible(selector, connection)
       end
     end
   end

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -18,25 +21,32 @@ module Mongo
     # Shared executable behavior of operations.
     #
     # @since 2.5.2
+    # @api private
     module Executable
 
       include ResponseHandling
 
-      def do_execute(server)
+      def do_execute(connection, context, options = {})
         unpin_maybe(session) do
-          add_error_labels do
-            add_server_diagnostics(server) do
-              get_result(server).tap do |result|
-                process_result(result, server)
+          add_error_labels(connection, context) do
+            add_server_diagnostics(connection) do
+              get_result(connection, context, options).tap do |result|
+                process_result(result, connection)
               end
             end
           end
         end
       end
 
-      def execute(server)
-        do_execute(server).tap do |result|
-          validate_result(result, server)
+      def execute(connection, context:, options: {})
+        if Lint.enabled?
+          unless connection.is_a?(Mongo::Server::Connection)
+            raise Error::LintError, "Connection argument is of wrong type: #{connection}"
+          end
+        end
+
+        do_execute(connection, context, options).tap do |result|
+          validate_result(result, connection, context)
         end
       end
 
@@ -46,44 +56,60 @@ module Mongo
         Result
       end
 
-      def get_result(server)
-        result_class.new(dispatch_message(server))
+      def get_result(connection, context, options = {})
+        result_class.new(*dispatch_message(connection, context, options))
       end
 
-      # Returns a Protocol::Message or nil
-      def dispatch_message(server)
-        server.with_connection do |connection|
-          connection.dispatch([ build_message(server) ], operation_id)
-        end
+      # Returns a Protocol::Message or nil as reply.
+      def dispatch_message(connection, context, options = {})
+        message = build_message(connection, context)
+        message = message.maybe_encrypt(connection, context)
+        reply = connection.dispatch([ message ], context, options)
+        [reply, connection.description]
       end
 
-      def build_message(server)
-        message(server)
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      def build_message(connection, context)
+        msg = message(connection)
+        if server_api = context.server_api
+          msg = msg.maybe_add_server_api(server_api)
+        end
+        msg
       end
 
-      def process_result(result, server)
-        server.update_cluster_time(result)
+      def process_result(result, connection)
+        connection.server.update_cluster_time(result)
+
+        process_result_for_sdam(result, connection)
+
+        if session
+          session.process(result)
+        end
+
+        result
+      end
 
-        if result.not_master? || result.node_recovering?
+      def process_result_for_sdam(result, connection)
+        if (result.not_master? || result.node_recovering?) &&
+          connection.generation >= connection.server.pool.generation
+        then
           if result.node_shutting_down?
-            disconnect_pool = true
+            keep_pool = false
           else
-            # Max wire version needs to be checked prior to marking the
-            # server unknown
-            disconnect_pool = !server.description.server_version_gte?('4.2')
+            # Max wire version needs to be examined while the server is known
+            keep_pool = connection.description.server_version_gte?('4.2')
           end
 
-          server.unknown!
+          connection.server.unknown!(
+            keep_connection_pool: keep_pool,
+            generation: connection.generation,
+            topology_version: result.topology_version,
+          )
 
-          if disconnect_pool
-            server.pool.disconnect!
-          end
-
-          server.monitor.scan_semaphore.signal
+          connection.server.scan_semaphore.signal
         end
-
-        session.process(result) if session
-        result
       end
     end
   end

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
@@ -21,8 +24,8 @@ module Mongo
     # @api private
     module ExecutableNoValidate
 
-      def execute(server)
-        do_execute(server)
+      def execute(connection, context:)
+        do_execute(connection, context)
       end
     end
   end