mongo 2.4.1 → 2.14.0

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

@@ -0,0 +1,65 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    class ParallelScan
+
+      # 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.
+        #
+        # @example Get the cursor ids.
+        #   result.cursor_ids
+        #
+        # @return [ Array<Integer> ] The cursor ids.
+        #
+        # @since 2.0.0
+        # @api private
+        def cursor_ids
+          documents.map {|doc| doc[CURSOR][CURSOR_ID]}
+        end
+
+        # Get the documents from parallel scan.
+        #
+        # @example Get the documents.
+        #   result.documents
+        #
+        # @return [ Array<BSON::Document> ] The documents.
+        #
+        # @since 2.0.0
+        # @api public
+        def documents
+          reply.documents[0][CURSORS]
+        end
+
+        private
+
+        def first
+          @first ||= reply.documents[0] || {}
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/parallel_scan.rb

@@ -0,0 +1,32 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/operation/parallel_scan/command'
+require 'mongo/operation/parallel_scan/op_msg'
+require 'mongo/operation/parallel_scan/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB parallelscan operation.
+    #
+    # @api private
+    #
+    # @since 2.0.0
+    class ParallelScan
+      include Specifiable
+      include OpMsgOrCommand
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    class RemoveUser
+
+      # A MongoDB removeuser operation sent as a command message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class Command
+        include Specifiable
+        include Executable
+        include Limited
+        include ReadPreferenceSupported
+        include WriteConcernSupported
+
+        private
+
+        def selector(connection)
+          { :dropUser => user_name }
+        end
+
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+    class RemoveUser
+
+      # A MongoDB removeuser operation sent as an op message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class OpMsg < OpMsgBase
+        include ExecutableTransactionLabel
+
+        private
+
+        def selector(connection)
+          { :dropUser => user_name }
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/remove_user.rb

@@ -0,0 +1,31 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/operation/remove_user/command'
+require 'mongo/operation/remove_user/op_msg'
+
+module Mongo
+  module Operation
+
+    # A MongoDB removeuser operation.
+    #
+    # @api private
+    #
+    # @since 2.0.0
+    class RemoveUser
+      include Specifiable
+      include OpMsgOrCommand
+    end
+  end
+end

data/lib/mongo/operation/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 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.
@@ -12,12 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/shared/result/aggregatable'
+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
@@ -25,46 +35,100 @@ 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
 
-      # @return [ Array<Protocol::Reply> ] replies The wrapped wire protocol replies.
+      # Initialize a new result.
+      #
+      # For an unkacknowledged write, pass nil in replies.
+      #
+      # For all other operations, replies must be a Protocol::Message instance
+      # or an array containing a single Protocol::Message instance.
+      #
+      # @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::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?
+
       # Is the result acknowledged?
       #
       # @note On MongoDB 2.6 and higher all writes are acknowledged since the
@@ -76,23 +140,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.
@@ -103,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
@@ -113,6 +166,7 @@ module Mongo
       # @return [ Nil ]
       #
       # @since 2.0.0
+      # @api private
       def namespace
         nil
       end
@@ -125,9 +179,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
@@ -142,23 +197,12 @@ module Mongo
       #
       # @return [ Enumerator ] The enumerator.
       #
-      # @since 2.0.0
-      #
       # @yieldparam [ BSON::Document ] Each document in the result.
-      def each(&block)
-        documents.each(&block)
-      end
-
-      # Initialize a new result.
-      #
-      # @example Instantiate the result.
-      #   Result.new(replies)
-      #
-      # @param [ Protocol::Reply ] replies The wire protocol replies.
       #
       # @since 2.0.0
-      def initialize(replies)
-        @replies = replies.is_a?(Protocol::Reply) ? [ replies ] : replies
+      # @api public
+      def each(&block)
+        documents.each(&block)
       end
 
       # Get the pretty formatted inspection of the result.
@@ -169,18 +213,20 @@ module Mongo
       # @return [ String ] The inspection.
       #
       # @since 2.0.0
+      # @api public
       def inspect
-        "#<Mongo::Operation::Result:#{object_id} documents=#{documents}>"
+        "#<#{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
@@ -197,9 +243,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
@@ -217,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)
@@ -234,7 +282,13 @@ 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.
+        # The number 1 is exactly representable in a float, hence
+        # 1.0 == 1 is going to perform correctly all of the time
+        # (until the server returns something other than 1 for success, that is)
         first_document[OK] == 1
       end
 
@@ -252,8 +306,52 @@ module Mongo
       # @return [ Result ] The result if verification passed.
       #
       # @since 2.0.0
+      # @api private
       def validate!
-        !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
+        !successful? ? raise_operation_failure : self
+      end
+
+      # The exception instance (of the Error::OperationFailure class)
+      # that would be raised during processing of this result.
+      #
+      # This method should only be called when result is not successful.
+      #
+      # @return [ Error::OperationFailure ] The exception.
+      #
+      # @api private
+      def error
+        @error ||= Error::OperationFailure.new(
+          parser.message,
+          self,
+          code: parser.code,
+          code_name: parser.code_name,
+          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,
+          connection_description: connection_description,
+        )
+      end
+
+      # Raises a Mongo::OperationFailure exception corresponding to the
+      # error information in this result.
+      #
+      # @raise Error::OperationFailure
+      private def raise_operation_failure
+        raise error
+      end
+
+      # @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.
@@ -264,15 +362,68 @@ 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.
+      #
+      # @example Get the operation time.
+      #   result.operation_time
+      #
+      # @return [ Object | nil ] The operation time value.
+      #
+      # @since 2.5.0
+      # @api public
+      def operation_time
+        first_document && first_document[OPERATION_TIME]
+      end
+
+      # Get the cluster time reported in the server response.
+      #
+      # @example Get the cluster time.
+      #   result.cluster_time
+      #
+      # @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
+
+      # Gets the set of error labels associated with the result.
+      #
+      # @example Get the labels.
+      #   result.labels
+      #
+      # @return [ Array ] labels The set of labels.
+      #
+      # @since 2.7.0
+      # @api private
+      def labels
+        @labels ||= parser.labels
+      end
+
+      # Whether the operation failed with a write concern error.
+      #
+      # @api private
+      def write_concern_error?
+        !!(first_document && first_document['writeConcernError'])
+      end
+
       private
 
       def aggregate_returned_count

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

@@ -0,0 +1,43 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+
+    # Custom behavior for operations that support the bypassdocumentvalidation option.
+    #
+    # @since 2.5.2
+    # @api private
+    module BypassDocumentValidation
+
+      private
+
+      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)
+      end
+
+      def add_bypass_document_validation(sel)
+        return sel unless bypass_document_validation
+        sel.merge(bypassDocumentValidation: true)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Operation
+
+    # Custom behavior for operations that support causal consistency.
+    #
+    # @since 2.5.2
+    # @api private
+    module CausalConsistencySupported
+
+      private
+
+      # Adds causal consistency document to the selector, if one can be
+      # constructed.
+      #
+      # This method overrides the causal consistency addition logic of
+      # SessionsSupported and is meant to be used with operations classified
+      # as "read operations accepting a read concern", as these are defined
+      # in the causal consistency spec.
+      #
+      # 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, connection)
+        apply_causal_consistency_if_possible(selector, connection)
+      end
+    end
+  end
+end