mongo 2.12.4 → 2.13.0.beta1

data/lib/mongo/auth/stringprep.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.
@@ -17,11 +17,12 @@ require 'mongo/auth/stringprep/profiles/sasl'
 
 module Mongo
   module Auth
-    # This namespace contains all behavior related to string preparation (RFC 3454). It's used to
-    # implement SCRAM-SHA-256 authentication, which is available in MongoDB server versions 4.0 and
-    # up.
+    # This namespace contains all behavior related to string preparation
+    # (RFC 3454). It's used to implement SCRAM-SHA-256 authentication,
+    # which is available in MongoDB server versions 4.0 and later.
     #
     # @since 2.6.0
+    # @api private
     module StringPrep
       extend self
 

data/lib/mongo/auth/stringprep/profiles/sasl.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.
@@ -21,6 +21,7 @@ module Mongo
         # @note Only available for Ruby versions 2.2.0 and up.
         #
         # @since 2.6.0
+        # @api private
         module SASL
           MAP_NON_ASCII_TO_SPACE = {
             0x00A0 => [0x0020],

data/lib/mongo/auth/stringprep/tables.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,6 +18,7 @@ module Mongo
       # Contains character tables defined by RFC 3454 (string preparation).
       #
       # @since 2.6.0
+      # @api private
       module Tables
         # Table A1 as defined by RFC 3454 (string preparation).
         #

data/lib/mongo/auth/stringprep/unicode_normalize/normalize.rb

@@ -20,6 +20,7 @@
 
 require 'mongo/auth/stringprep/unicode_normalize/tables'
 
+# @api private
 module UnicodeNormalize  # :nodoc:
   ## Constant for max hash capacity to avoid DoS attack
   MAX_HASH_LENGTH = 18000 # enough for all test cases, otherwise tests get slow

data/lib/mongo/auth/stringprep/unicode_normalize/tables.rb

@@ -3,6 +3,7 @@
 
 # automatically generated by template/unicode_norm_gen.tmpl
 
+# @api private
 module UnicodeNormalize  # :nodoc:
   accents = "" \
     "[\u0300-\u034E\u0350-\u036F\u0483-\u0487\u0591-\u05BD\u05BF\u05C1\u05C2\u05C4\u05C5\u05C7" \

data/lib/mongo/auth/user.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.
@@ -209,7 +209,7 @@ module Mongo
       # @api private
       def self.default_auth_source(options)
         case options[:auth_mech]
-        when :gssapi, :mongodb_x509
+        when :aws, :gssapi, :mongodb_x509
           '$external'
         when :plain
           options[:database] || '$external'

data/lib/mongo/auth/user/view.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/auth/x509.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.
@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/auth/x509/conversation'
-
 module Mongo
   module Auth
 
@@ -21,25 +19,18 @@ module Mongo
     #
     # @since 2.0.0
     # @api private
-    class X509
+    class X509 < Base
 
-      # The authentication mechinism string.
+      # The authentication mechanism string.
       #
       # @since 2.0.0
       MECHANISM = 'MONGODB-X509'.freeze
 
-      # @return [ Mongo::Auth::User ] The user to authenticate.
-      attr_reader :user
-
-      # Instantiate a new authenticator.
+      # Initializes the X.509 authenticator.
       #
-      # @example Create the authenticator.
-      #   Mongo::Auth::X509.new(user)
-      #
-      # @param [ Mongo::Auth::User ] user The user to authenticate.
-      #
-      # @since 2.0.0
-      def initialize(user)
+      # @param [ Auth::User ] user The user to authenticate.
+      # @param [ Mongo::Connection ] connection The connection to authenticate over.
+      def initialize(user, connection, **opts)
         # The only valid database for X.509 authentication is $external.
         if user.auth_source != '$external'
           user_name_msg = if user.name
@@ -50,26 +41,17 @@ module Mongo
           raise Auth::InvalidConfiguration, "User#{user_name_msg} specifies auth source '#{user.auth_source}', but the only valid auth source for X.509 is '$external'"
         end
 
-        @user = user
+        super
       end
 
-      # Log the user in on the given connection.
+      # Log the user in on the current connection.
       #
-      # @example Log the user in.
-      #   user.login(connection)
-      #
-      # @param [ Mongo::Connection ] connection The connection to log into.
-      #   on.
-      #
-      # @return [ Protocol::Message ] The authentication response.
-      #
-      # @since 2.0.0
-      def login(connection)
-        conversation = Conversation.new(user)
-        reply = connection.dispatch([ conversation.start(connection) ])
-        connection.update_cluster_time(Operation::Result.new(reply))
-        conversation.finalize(reply, connection)
+      # @return [ BSON::Document ] The document of the authentication response.
+      def login
+        converse_1_step(connection, conversation)
       end
     end
   end
 end
+
+require 'mongo/auth/x509/conversation'

data/lib/mongo/auth/x509/conversation.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.
@@ -20,37 +20,13 @@ module Mongo
       # client and server.
       #
       # @since 2.0.0
-      class Conversation
+      # @api private
+      class Conversation < ConversationBase
 
         # The login message.
         #
         # @since 2.0.0
-        LOGIN = { authenticate: 1 }.freeze
-
-        # @return [ Protocol::Message ] reply The current reply in the
-        #   conversation.
-        attr_reader :reply
-
-        # @return [ User ] user The user for the conversation.
-        attr_reader :user
-
-        # Finalize the X.509 conversation. This is meant to be iterated until
-        # the provided reply indicates the conversation is finished.
-        #
-        # @example Finalize the conversation.
-        #   conversation.finalize(reply)
-        #
-        # @param [ Protocol::Message ] reply The reply of the previous
-        #   message.
-        # @param [ Server::Connection ] connection The connection being
-        #   authenticated.
-        #
-        # @return [ Protocol::Query ] The next message to send.
-        #
-        # @since 2.0.0
-        def finalize(reply, connection)
-          validate!(reply, connection.server)
-        end
+        LOGIN = { authenticate: 1, mechanism: X509::MECHANISM }.freeze
 
         # Start the X.509 conversation. This returns the first message that
         # needs to be sent to the server.
@@ -62,8 +38,7 @@ module Mongo
         #
         # @since 2.0.0
         def start(connection)
-          login = LOGIN.merge(mechanism: X509::MECHANISM)
-          login[:user] = user.name if user.name
+          login = client_first_document
           if connection && connection.features.op_msg_enabled?
             selector = login
             # The only valid database for X.509 authentication is $external.
@@ -89,25 +64,23 @@ module Mongo
           end
         end
 
-        # Create the new conversation.
-        #
-        # @example Create the new conversation.
-        #   Conversation.new(user, "admin")
+        # Returns the hash to provide to the server in the handshake
+        # as value of the speculativeAuthenticate key.
         #
-        # @param [ Auth::User ] user The user to converse about.
+        # If the auth mechanism does not support speculative authentication,
+        # this method returns nil.
         #
-        # @since 2.0.0
-        def initialize(user)
-          @user = user
+        # @return [ Hash | nil ] Speculative authentication document.
+        def speculative_auth_document
+          client_first_document
         end
 
         private
 
-        def validate!(reply, server)
-          if reply.documents[0][Operation::Result::OK] != 1
-            raise Unauthorized.new(user, used_mechanism: MECHANISM, server: server)
+        def client_first_document
+          LOGIN.dup.tap do |payload|
+            payload[:user] = user.name if user.name
           end
-          @reply = reply
         end
       end
     end

data/lib/mongo/background_thread.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-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.
@@ -129,7 +129,16 @@ module Mongo
       # Some driver objects can be reconnected, for backwards compatibiilty
       # reasons. Clear the thread instance variable to support this cleanly.
       if @thread.alive?
-        log_warn("Failed to stop background thread in #{self} in #{(Time.now - start_time).to_i} seconds")
+        log_warn("Failed to stop the background thread in #{self} in #{(Time.now - start_time).to_i} seconds: #{@thread.inspect} (thread status: #{@thread.status})")
+        # On JRuby the thread may be stuck in aborting state
+        # seemingly indefinitely. If the thread is aborting, consider it dead
+        # for our purposes (we will create a new thread if needed, and
+        # the background thread monitor will not detect the aborting thread
+        # as being alive).
+        if @thread.status == 'aborting'
+          @thread = nil
+          @stop_requested = false
+        end
         false
       else
         @thread = nil

data/lib/mongo/bson.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/bulk_write.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.
@@ -62,24 +62,28 @@ module Mongo
           if single_statement?(operation)
             write_concern = write_concern(session)
             write_with_retry(session, write_concern) do |server, txn_num|
-              execute_operation(
+              server.with_connection do |connection|
+                execute_operation(
                   operation.keys.first,
                   operation.values.flatten,
-                  server,
+                  connection,
                   operation_id,
                   result_combiner,
                   session,
                   txn_num)
+              end
             end
           else
             nro_write_with_retry(session, write_concern) do |server|
-              execute_operation(
+              server.with_connection do |connection|
+                execute_operation(
                   operation.keys.first,
                   operation.values.flatten,
-                  server,
+                  connection,
                   operation_id,
                   result_combiner,
                   session)
+              end
             end
           end
         end
@@ -172,21 +176,28 @@ module Mongo
       }
     end
 
-    def execute_operation(name, values, server, operation_id, result_combiner, session, txn_num = nil)
-      raise Error::UnsupportedCollation.new if op_combiner.has_collation && !server.features.collation_enabled?
-      raise Error::UnsupportedArrayFilters.new if op_combiner.has_array_filters && !server.features.array_filters_enabled?
+    def execute_operation(name, values, connection, operation_id, result_combiner, session, txn_num = nil)
+      validate_collation!(connection)
+      validate_array_filters!(connection)
+      validate_hint!(connection)
+
       unpin_maybe(session) do
-        if values.size > server.max_write_batch_size
-          split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
+        if values.size > connection.description.max_write_batch_size
+          split_execute(name, values, connection, operation_id, result_combiner, session, txn_num)
         else
-          result = send(name, values, server, operation_id, session, txn_num)
-          result_combiner.combine!(result, values.size)
+          result = send(name, values, connection, operation_id, session, txn_num)
+
+          add_server_diagnostics(connection) do
+            add_error_labels(client, connection, session) do
+              result_combiner.combine!(result, values.size)
+            end
+          end
         end
       end
     rescue Error::MaxBSONSize, Error::MaxMessageSize => e
       raise e if values.size <= 1
       unpin_maybe(session) do
-        split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
+        split_execute(name, values, connection, operation_id, result_combiner, session, txn_num)
       end
     end
 
@@ -194,37 +205,61 @@ module Mongo
       @op_combiner ||= ordered? ? OrderedCombiner.new(requests) : UnorderedCombiner.new(requests)
     end
 
-    def split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
-      execute_operation(name, values.shift(values.size / 2), server, operation_id, result_combiner, session, txn_num)
+    def split_execute(name, values, connection, operation_id, result_combiner, session, txn_num)
+      execute_operation(name, values.shift(values.size / 2), connection, operation_id, result_combiner, session, txn_num)
 
       txn_num = session.next_txn_num if txn_num
-      execute_operation(name, values, server, operation_id, result_combiner, session, txn_num)
+      execute_operation(name, values, connection, operation_id, result_combiner, session, txn_num)
     end
 
-    def delete_one(documents, server, operation_id, session, txn_num)
+    def delete_one(documents, connection, operation_id, session, txn_num)
       spec = base_spec(operation_id, session).merge(:deletes => documents, :txn_num => txn_num)
-      Operation::Delete.new(spec).bulk_execute(server, client: client)
+      Operation::Delete.new(spec).bulk_execute(connection, client: client)
     end
 
-    def delete_many(documents, server, operation_id, session, txn_num)
+    def delete_many(documents, connection, operation_id, session, txn_num)
       spec = base_spec(operation_id, session).merge(:deletes => documents)
-      Operation::Delete.new(spec).bulk_execute(server, client: client)
+      Operation::Delete.new(spec).bulk_execute(connection, client: client)
     end
 
-    def insert_one(documents, server, operation_id, session, txn_num)
+    def insert_one(documents, connection, operation_id, session, txn_num)
       spec = base_spec(operation_id, session).merge(:documents => documents, :txn_num => txn_num)
-      Operation::Insert.new(spec).bulk_execute(server, client: client)
+      Operation::Insert.new(spec).bulk_execute(connection, client: client)
     end
 
-    def update_one(documents, server, operation_id, session, txn_num)
+    def update_one(documents, connection, operation_id, session, txn_num)
       spec = base_spec(operation_id, session).merge(:updates => documents, :txn_num => txn_num)
-      Operation::Update.new(spec).bulk_execute(server, client: client)
+      Operation::Update.new(spec).bulk_execute(connection, client: client)
     end
     alias :replace_one :update_one
 
-    def update_many(documents, server, operation_id, session, txn_num)
+    def update_many(documents, connection, operation_id, session, txn_num)
       spec = base_spec(operation_id, session).merge(:updates => documents)
-      Operation::Update.new(spec).bulk_execute(server, client: client)
+      Operation::Update.new(spec).bulk_execute(connection, client: client)
+    end
+
+    private
+
+    def validate_collation!(connection)
+      if op_combiner.has_collation? && !connection.features.collation_enabled?
+        raise Error::UnsupportedCollation.new
+      end
+    end
+
+    def validate_array_filters!(connection)
+      if op_combiner.has_array_filters? && !connection.features.array_filters_enabled?
+        raise Error::UnsupportedArrayFilters.new
+      end
+    end
+
+    def validate_hint!(connection)
+      if op_combiner.has_hint?
+        if 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
   end
 end

data/lib/mongo/bulk_write/combineable.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.
@@ -25,13 +25,6 @@ module Mongo
       # @return [ Array<Hash, BSON::Document> ] requests The provided requests.
       attr_reader :requests
 
-      # @return [ true, false ] has_collation Whether one or more operations has a collation defined.
-      attr_reader :has_collation
-
-      # @return [ true, false ] has_array_filters Whether one or more operations specifies an array
-      # filters option.
-      attr_reader :has_array_filters
-
       # Create the ordered combiner.
       #
       # @api private
@@ -46,6 +39,25 @@ module Mongo
         @requests = requests
         @has_collation = false
         @has_array_filters = false
+        @has_hint = false
+      end
+
+      # @return [ Boolean ] Whether one or more operation specifies the collation
+      #   option.
+      def has_collation?
+        @has_collation
+      end
+
+      # @return [ Boolean ] Whether one or more operation specifies the
+      #   array_filters option.
+      def has_array_filters?
+        @has_array_filters
+      end
+
+      # @return [ Boolean ] Whether one or more operation specifies the
+      #   hint option.
+      def has_hint?
+        @has_hint
       end
 
       private