mongo 2.12.4 → 2.14.0.rc1

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.
@@ -19,11 +19,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 +36,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 +49,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/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.
@@ -27,6 +27,7 @@ module Mongo
     # produce a reply (in which case it is assumed to have succeeded).
     #
     # @since 2.0.0
+    # @api semiprivate
     class Result
       extend Forwardable
       include Enumerable
@@ -34,41 +35,49 @@ 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.
@@ -80,9 +89,14 @@ module Mongo
       #
       # @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)
+      def initialize(replies, connection_description = nil)
         if replies
           if replies.is_a?(Array)
             if replies.length != 1
@@ -96,12 +110,21 @@ module Mongo
             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::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?
@@ -117,6 +140,7 @@ module Mongo
       # @return [ true, false ] If the result is acknowledged.
       #
       # @since 2.0.0
+      # @api public
       def acknowledged?
         !!@replies
       end
@@ -131,6 +155,7 @@ module Mongo
       # @return [ Integer ] The cursor id.
       #
       # @since 2.0.0
+      # @api private
       def cursor_id
         acknowledged? ? replies.last.cursor_id : 0
       end
@@ -141,6 +166,7 @@ module Mongo
       # @return [ Nil ]
       #
       # @since 2.0.0
+      # @api private
       def namespace
         nil
       end
@@ -153,6 +179,7 @@ module Mongo
       # @return [ Array<BSON::Document> ] The documents.
       #
       # @since 2.0.0
+      # @api public
       def documents
         if acknowledged?
           replies.flat_map(&:documents)
@@ -170,9 +197,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
@@ -185,6 +213,7 @@ module Mongo
       # @return [ String ] The inspection.
       #
       # @since 2.0.0
+      # @api public
       def inspect
         "#<#{self.class.name}:0x#{object_id} documents=#{documents}>"
       end
@@ -197,6 +226,7 @@ module Mongo
       # @return [ Protocol::Message ] The first reply.
       #
       # @since 2.0.0
+      # @api private
       def reply
         if acknowledged?
           replies.first
@@ -213,6 +243,7 @@ module Mongo
       # @return [ Integer ] The number of documents returned.
       #
       # @since 2.0.0
+      # @api public
       def returned_count
         if acknowledged?
           reply.number_returned
@@ -233,6 +264,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)
@@ -250,6 +282,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.
@@ -273,6 +306,7 @@ module Mongo
       # @return [ Result ] The result if verification passed.
       #
       # @since 2.0.0
+      # @api private
       def validate!
         !successful? ? raise_operation_failure : self
       end
@@ -291,21 +325,34 @@ 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
       # 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.
       #
@@ -315,6 +362,7 @@ module Mongo
       # @return [ Integer ] The number of documents written.
       #
       # @since 2.0.0
+      # @api public
       def written_count
         if acknowledged?
           first_document[N] || 0
@@ -322,6 +370,8 @@ module Mongo
           0
         end
       end
+
+      # @api public
       alias :n :written_count
 
       # Get the operation time reported in the server response.
@@ -329,9 +379,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
@@ -341,13 +392,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
@@ -360,6 +412,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,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.
@@ -18,16 +18,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