mongo 2.17.2 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcc9a0fe9a28483f4237193871e81741d79878d2620a1620285ace2ab1cc84e9
-  data.tar.gz: 73692e39fb1d28041c38086571874cc285454c14425f666fbd242924fd5cac5f
+  metadata.gz: 664d381d4746fb4ff6282069f909a91a58f497220bae57656c265f52c5d99040
+  data.tar.gz: 85fa7fbf071c3e8fc4c1beb2215b3297a3af560130204dbd0f916adb272987f7
 SHA512:
-  metadata.gz: be915ceb9516a15b7f1317e43a20e578758f2b4c6da718ebcaa20b5ec4deedafe1d4ae0354875a89a0e2ca48c40c40ef76206cd6aa7c61e78d77876d780f9c5a
-  data.tar.gz: 1d50c87d9072259331b5b28076c2527bdce00425bc2965641aaf13e5d1238db5ffe17f5bc398c6eb944e5487acf99eb037d25fb359eea6871a1082b0f0ca8a66
+  metadata.gz: 2dcf66e773da4e2bdaf0a22d15a06eadbc5ab2bccffc29f012e2ae863e8148b597550ee680dc2556b40408f4c759b78b159b678cf494cf619c0975044d72d662
+  data.tar.gz: c120607792132931a54511db0a4ef62653393138e9da3fcf0ca0f0a85fde3aefe6b04782fd09125b0fe3085e50c66b1cd2f6e0c4743ae40e7094dc8e7892587a

data/README.md

@@ -7,21 +7,17 @@ The officially supported Ruby driver for [MongoDB](https://www.mongodb.org/).
 
 The Ruby driver supports Ruby 2.5-3.0 and JRuby 9.2.
 
-
-Documentation
--------------
+## Documentation
 
 High level documentation and usage examples are located
 [here](http://docs.mongodb.org/ecosystem/drivers/ruby/).
 
 API documentation for the most recent release can be found
-[here](https://docs.mongodb.com/ruby-driver/current/api/).
+[here](https://mongodb.com/docs/ruby-driver/current/api/).
 To build API documentation for the master branch, check out the
 repository locally and run `rake docs`.
 
-
-Support
--------
+## Support
 
 Commercial support for the driver is available through the
 [MongoDB Support Portal](https://support.mongodb.com/).
@@ -29,17 +25,15 @@ Commercial support for the driver is available through the
 For questions, discussions or general technical support, please visit the
 [MongoDB Community Forum](https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/ruby-driver).
 
-Please see [Technical Support](https://docs.mongodb.com/manual/support/) page
+Please see [Technical Support](https://mongodb.com/docs/manual/support/) page
 in the documentation for other support resources.
 
-
-Bugs & Feature Requests
------------------------
+## Bugs & Feature Requests
 
 To report a bug in the driver or request a feature specific to the Ruby driver:
 
 1. Visit [our issue tracker](https://jira.mongodb.org/) and login
-(or create an account if you do not have one already).
+   (or create an account if you do not have one already).
 2. Navigate to the [RUBY project](https://jira.mongodb.org/browse/RUBY).
 3. Click 'Create Issue' and fill out all of the applicable form fields.
 
@@ -60,54 +54,44 @@ is publicly visible.
 - Provide any sensitive data or server logs.
 - Report potential security issues publicly (see 'Security Issues' below).
 
-
-Security Issues
----------------
+## Security Issues
 
 If you have identified a potential security-related issue in the Ruby driver
 (or any other MongoDB product), please report it by following the
 [instructions here](http://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
 
-
-Product Feature Requests
-------------------------
+## Product Feature Requests
 
 To request a feature which is not specific to the Ruby driver, or which
 affects more than the driver alone (for example, a feature which requires
 MongoDB server support), please submit your idea through the
 [MongoDB Feedback Forum](https://feedback.mongodb.com/forums/924286-drivers).
 
-
-Running Tests
--------------
+## Running Tests
 
 Please refer to [spec/README.md](spec/README.md) for instructions on how
 to run the driver's test suite.
 
-
-Release History
----------------
+## Release History
 
 Full release notes and release history are available [on the GitHub releases
 page](https://github.com/mongodb/mongo-ruby-driver/releases).
 
+## License
 
-License
--------
-
- Copyright (C) 2009-2020 MongoDB, Inc.
+Copyright (C) 2009-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
+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
+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.
+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.
 
 [rubygems-img]: https://badge.fury.io/rb/mongo.svg
 [rubygems-url]: http://badge.fury.io/rb/mongo

data/lib/mongo/auth/base.rb

@@ -112,7 +112,12 @@ module Mongo
         reply = connection.dispatch([msg], context)
         reply_document = reply.documents.first
         validate_reply!(connection, conversation, reply_document)
-        result = Operation::Result.new(reply, connection.description)
+        connection_global_id = if connection.respond_to?(:global_id)
+          connection.global_id
+        else
+          nil
+        end
+        result = Operation::Result.new(reply, connection.description, connection_global_id)
         connection.update_cluster_time(result)
         reply_document
       end
@@ -126,10 +131,12 @@ module Mongo
             code_name: doc[:codeName],
             message: doc[:errmsg],
           )
+
           raise Unauthorized.new(user,
             used_mechanism: self.class.const_get(:MECHANISM),
             message: message,
             server: connection.server,
+            code: doc[:code]
           )
         end
       end

data/lib/mongo/auth.rb

@@ -30,6 +30,9 @@ require 'mongo/auth/ldap'
 require 'mongo/auth/scram'
 require 'mongo/auth/scram256'
 require 'mongo/auth/x509'
+require 'mongo/error/read_write_retryable'
+require 'mongo/error/labelable'
+
 
 module Mongo
 
@@ -127,6 +130,11 @@ module Mongo
     #
     # @since 2.0.0
     class Unauthorized < Mongo::Error::AuthError
+      include Error::ReadWriteRetryable
+      include Error::Labelable
+
+      # @return [ Integer ] The error code.
+      attr_reader :code
 
       # Instantiate the new error.
       #
@@ -139,11 +147,14 @@ module Mongo
       # @param [ String ] message The error message returned by the server.
       # @param [ Server ] server The server instance that authentication
       #   was attempted against.
+      # @param [ Integer ] The error code.
       #
       # @since 2.0.0
       def initialize(user, used_mechanism: nil, message: nil,
-        server: nil
+        server: nil, code: nil
       )
+        @code = code
+
         configured_bits = []
         used_bits = [
           "auth source: #{user.auth_source}",

data/lib/mongo/bulk_write/result.rb

@@ -23,6 +23,11 @@ module Mongo
     # @since 2.0.6
     class Result
 
+      # @return [ Boolean ] Is the result acknowledged?
+      def acknowledged?
+        @acknowledged
+      end
+
       # Constant for number removed.
       #
       # @since 2.1.0
@@ -94,10 +99,14 @@ module Mongo
       #   Result.new({ 'n_inserted' => 10 })
       #
       # @param [ BSON::Document, Hash ] results The results document.
+      # @param [ Boolean ] acknowledged Is the result acknowledged?
       #
       # @since 2.1.0
-      def initialize(results)
+      #
+      # @api private
+      def initialize(results, acknowledged)
         @results = results
+        @acknowledged = acknowledged
       end
 
       # Returns the number of documents inserted.

data/lib/mongo/bulk_write/result_combiner.rb

@@ -70,20 +70,18 @@ module Mongo
         end
         combine_errors!(result)
         @count += count
+        @acknowledged = result.acknowledged?
       end
 
       # Get the final result.
       #
       # @api private
       #
-      # @example Get the final result.
-      #   combinator.result
-      #
       # @return [ BulkWrite::Result ] The final result.
       #
       # @since 2.1.0
       def result
-        BulkWrite::Result.new(results).validate!
+        BulkWrite::Result.new(results, @acknowledged).validate!
       end
 
       private

data/lib/mongo/bulk_write.rb

@@ -59,37 +59,34 @@ module Mongo
       operation_id = Monitoring.next_operation_id
       result_combiner = ResultCombiner.new
       operations = op_combiner.combine
+      validate_requests!
 
       client.send(:with_session, @options) do |session|
         context = Operation::Context.new(client: client, session: session)
         operations.each do |operation|
           if single_statement?(operation)
             write_concern = write_concern(session)
-            write_with_retry(session, write_concern) do |server, txn_num|
-              server.with_connection(service_id: context.service_id) do |connection|
-                execute_operation(
-                  operation.keys.first,
-                  operation.values.flatten,
-                  connection,
-                  context,
-                  operation_id,
-                  result_combiner,
-                  session,
-                  txn_num)
-              end
+            write_with_retry(write_concern, context: context) do |connection, txn_num, context|
+              execute_operation(
+                operation.keys.first,
+                operation.values.flatten,
+                connection,
+                context,
+                operation_id,
+                result_combiner,
+                session,
+                txn_num)
             end
           else
-            nro_write_with_retry(session, write_concern) do |server|
-              server.with_connection(service_id: context.service_id) do |connection|
-                execute_operation(
-                  operation.keys.first,
-                  operation.values.flatten,
-                  connection,
-                  context,
-                  operation_id,
-                  result_combiner,
-                  session)
-              end
+            nro_write_with_retry(write_concern, context: context) do |connection, txn_num, context|
+              execute_operation(
+                operation.keys.first,
+                operation.values.flatten,
+                connection,
+                context,
+                operation_id,
+                result_combiner,
+                session)
             end
           end
         end
@@ -118,7 +115,7 @@ module Mongo
     #   )
     #
     # @param [ Mongo::Collection ] collection The collection.
-    # @param [ Array<Hash, BSON::Document> ] requests The requests.
+    # @param [ Array<Hash, BSON::Document> ] requests The requests, cannot be empty.
     # @param [ Hash, BSON::Document ] options The options.
     #
     # @since 2.1.0
@@ -179,7 +176,9 @@ module Mongo
         :max_time_ms => options[:max_time_ms],
         :options => options,
         :id_generator => client.options[:id_generator],
-        :session => session
+        :session => session,
+        :comment => options[:comment],
+        :let => options[:let],
       }
     end
 
@@ -188,7 +187,7 @@ module Mongo
       validate_array_filters!(connection)
       validate_hint!(connection)
 
-      unpin_maybe(session) do
+      unpin_maybe(session, connection) do
         if values.size > connection.description.max_write_batch_size
           split_execute(name, values, connection, context, operation_id, result_combiner, session, txn_num)
         else
@@ -210,7 +209,7 @@ module Mongo
     # 3.6+ servers being able to split less.
     rescue Error::MaxBSONSize, Error::MaxMessageSize => e
       raise e if values.size <= 1
-      unpin_maybe(session) do
+      unpin_maybe(session, connection) do
         split_execute(name, values, connection, context, operation_id, result_combiner, session, txn_num)
       end
     end
@@ -222,7 +221,7 @@ module Mongo
     def split_execute(name, values, connection, context, operation_id, result_combiner, session, txn_num)
       execute_operation(name, values.shift(values.size / 2), connection, context, operation_id, result_combiner, session, txn_num)
 
-      txn_num = session.next_txn_num if txn_num
+      txn_num = session.next_txn_num if txn_num && !session.in_transaction?
       execute_operation(name, values, connection, context, operation_id, result_combiner, session, txn_num)
     end
 
@@ -278,12 +277,99 @@ module Mongo
 
     def validate_hint!(connection)
       if op_combiner.has_hint?
-        if write_concern && !write_concern.acknowledged?
+        if !can_hint?(connection) && write_concern && !write_concern.acknowledged?
           raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
         elsif !connection.features.update_delete_option_validation_enabled?
           raise Error::UnsupportedOption.hint_error
         end
       end
     end
+
+    # Loop through the requests and check if each operation is allowed to send
+    # a hint for each operation on the given server version.
+    #
+    # For the following operations, the client can send a hint for servers >= 4.2
+    # and for the rest, the client can only send it for 4.4+:
+    #   - updateOne
+    #   - updateMany
+    #   - replaceOne
+    #
+    # @param [ Connection ] connection The connection object.
+    #
+    # @return [ true | false ] Whether the request is able to send hints for
+    #   the current server version.
+    def can_hint?(connection)
+      gte_4_2 = connection.server.description.server_version_gte?('4.2')
+      gte_4_4 = connection.server.description.server_version_gte?('4.4')
+      op_combiner.requests.all? do |req|
+        op = req.keys.first
+        if req[op].keys.include?(:hint)
+          if [:update_one, :update_many, :replace_one].include?(op)
+            gte_4_2
+          else
+            gte_4_4
+          end
+        else
+          true
+        end
+      end
+    end
+
+    # Perform the request document validation required by driver specifications.
+    # This method validates the first key of each update request document to be
+    # an operator (i.e. start with $) and the first key of each replacement
+    # document to not be an operator (i.e. not start with $). The request document
+    # may be invalid without this method flagging it as such (for example an
+    # update or replacement document containing some keys which are operators
+    # and some which are not), in which case the driver expects the server to
+    # fail the operation with an error.
+    #
+    # Raise an ArgumentError if requests is empty.
+    #
+    # @raise [ Error::InvalidUpdateDocument, Error::InvalidReplacementDocument,
+    #   ArgumentError ]
+    #   if the document is invalid.
+    def validate_requests!
+      if @requests.empty?
+        raise ArgumentError, "Bulk write requests cannot be empty"
+      end
+      @requests.each do |req|
+        if op = req.keys.first
+          if [:update_one, :update_many].include?(op)
+            if doc = maybe_first(req.dig(op, :update))
+              if key = doc.keys&.first
+                unless key.to_s.start_with?("$")
+                  if Mongo.validate_update_replace
+                    raise Error::InvalidUpdateDocument.new(key: key)
+                  else
+                    Error::InvalidUpdateDocument.warn(Logger.logger, key)
+                  end
+                end
+              end
+            end
+          elsif op == :replace_one
+            if key = req.dig(op, :replacement)&.keys&.first
+              if key.to_s.start_with?("$")
+                if Mongo.validate_update_replace
+                  raise Error::InvalidReplacementDocument.new(key: key)
+                else
+                  Error::InvalidReplacementDocument.warn(Logger.logger, key)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # If the given object is an array return the first element, otherwise
+    # return the given object.
+    #
+    # @param [ Object ] obj The given object.
+    #
+    # @return [ Object ] The first element of the array or the given object.
+    def maybe_first(obj)
+      obj.is_a?(Array) ? obj.first : obj
+    end
   end
 end