mongo 2.11.0.rc0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7c88c591ffb30fe10134db69727372a4d1c3801a11dce59804ebe53d475d08f
-  data.tar.gz: 16ce4f803cd46df9e0bc6948048fc4c0ea5356d437fbf75b149d38cd872ccca1
+  metadata.gz: d27047092172489df2f36b02e09050990a7aae2685a055bf4a30d33a43b86325
+  data.tar.gz: 0f14e016a1dbae9ccda55d77927a773d58a10967b959b9480b052c2df9410386
 SHA512:
-  metadata.gz: eb30b7789af0a8816ce50e4b5c3be68e0b0a6f3a0b2da8d4c13a6f6bc8ad826b6a6b505e99df369ed49b24543baa28ff08db655ce3701c1fd2f13b55d4bb9374
-  data.tar.gz: 7490c21d89f2b2c88aaa69d8203973869c409c637c0a212cb2d3cd2783ca258cd6a2df6729375e39894303b39541fd0296faee7c691d1b3e4c3553f6c6169385
+  metadata.gz: 3cf2e4bfd5860003b7131c72fae1b58a0a56906a73d67e9e08c465cd5cf0b79f99af431e55597733f3baf9d68a9617cec47647d4bb7b9c8e84eedeeff96509b9
+  data.tar.gz: 190be385cbcfdae0293448281010b8d6c4ca785b37236fe57362921eaeb7cfdb5115dd0159e51622946b97170fa105a375fd0a73ceb4600b268e599aa687dcf1

data/Rakefile

@@ -29,6 +29,7 @@ namespace :spec do
   task :prepare do
     $: << File.join(File.dirname(__FILE__), 'spec')
 
+    require 'support/utils'
     require 'support/spec_setup'
     SpecSetup.new.run
   end
@@ -40,6 +41,7 @@ namespace :spec do
     # Since this task is usually used for troubleshooting of test suite
     # configuration, leave driver log level at the default of debug to
     # have connection diagnostics printed during handshakes and such.
+    require 'support/utils'
     require 'support/spec_config'
     require 'support/client_registry'
     SpecConfig.instance.print_summary

data/lib/mongo/auth.rb

@@ -109,9 +109,10 @@ module Mongo
       # @param [ Mongo::Auth::User ] user The unauthorized user.
       # @param [ String ] used_mechanism Auth mechanism actually used for
       #   authentication. This is a full string like SCRAM-SHA-256.
+      # @param [ String ] message The error message returned by the server.
       #
       # @since 2.0.0
-      def initialize(user, used_mechanism = nil)
+      def initialize(user, used_mechanism: nil, message: nil)
         specified_mechanism = if user.mechanism
           " (mechanism: #{user.mechanism})"
         else
@@ -122,7 +123,15 @@ module Mongo
         else
           ''
         end
-        msg = "User #{user.name}#{specified_mechanism} is not authorized to access #{user.database}#{used_mechanism}"
+        used_user = if user.mechanism == :mongodb_x509
+          'Client certificate'
+        else
+          "User #{user.name}"
+        end
+        msg = "#{used_user}#{specified_mechanism} is not authorized to access #{user.database} (auth source: #{user.auth_source})#{used_mechanism}"
+        if message
+          msg += ': ' + message
+        end
         super(msg)
       end
     end

data/lib/mongo/auth/cr/conversation.rb

@@ -131,7 +131,7 @@ module Mongo
 
         def validate!(reply)
           if reply.documents[0][Operation::Result::OK] != 1
-            raise Unauthorized.new(user, MECHANISM)
+            raise Unauthorized.new(user, used_mechanism: MECHANISM)
           end
           @nonce = reply.documents[0][Auth::NONCE]
           @reply = reply

data/lib/mongo/auth/ldap/conversation.rb

@@ -98,7 +98,7 @@ module Mongo
 
         def validate!(reply)
           if reply.documents[0][Operation::Result::OK] != 1
-            raise Unauthorized.new(user, MECHANISM)
+            raise Unauthorized.new(user, used_mechanism: MECHANISM)
           end
           @reply = reply
         end

data/lib/mongo/auth/scram/conversation.rb

@@ -519,7 +519,10 @@ module Mongo
 
         def validate!(reply)
           if reply.documents[0][Operation::Result::OK] != 1
-            raise Unauthorized.new(user, full_mechanism)
+            raise Unauthorized.new(user,
+              used_mechanism: full_mechanism,
+              message: reply.documents[0]['errmsg'],
+            )
           end
           @reply = reply
         end

data/lib/mongo/auth/user.rb

@@ -159,7 +159,7 @@ module Mongo
       # @since 2.0.0
       def initialize(options)
         @database = options[:database] || Database::ADMIN
-        @auth_source = options[:auth_source] || @database
+        @auth_source = options[:auth_source] || self.class.default_auth_source(options)
         @name = options[:user]
         @password = options[:password] || options[:pwd]
         @mechanism = options[:auth_mech]
@@ -205,6 +205,20 @@ module Mongo
       #
       # @return [ String ] The client key for the user.
       attr_reader :client_key
+
+      # Generate default auth source based on the URI and options
+      #
+      # @api private
+      def self.default_auth_source(options)
+        case options[:auth_mech]
+        when :gssapi, :mongodb_x509
+          '$external'
+        when :plain
+          options[:database] || '$external'
+        else
+          options[:database] || Database::ADMIN
+        end
+      end
     end
   end
 end

data/lib/mongo/auth/user/view.rb

@@ -37,6 +37,7 @@ module Mongo
         # @param [ Hash ] options The user options.
         #
         # @option options [ Session ] :session The session to use for the operation.
+        # @option options [ Hash ] :write_concern The write concern options.
         #
         # @return [ Result ] The command response.
         #
@@ -47,7 +48,8 @@ module Mongo
             Operation::CreateUser.new(
               user: user,
               db_name: database.name,
-              session: session
+              session: session,
+              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]),
             ).execute(next_primary(nil, session))
           end
         end
@@ -73,6 +75,7 @@ module Mongo
         # @param [ Hash ] options The options for the remove operation.
         #
         # @option options [ Session ] :session The session to use for the operation.
+        # @option options [ Hash ] :write_concern The write concern options.
         #
         # @return [ Result ] The command response.
         #
@@ -82,7 +85,8 @@ module Mongo
             Operation::RemoveUser.new(
               user_name: name,
               db_name: database.name,
-              session: session
+              session: session,
+              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]),
             ).execute(next_primary(nil, session))
           end
         end
@@ -96,6 +100,7 @@ module Mongo
         # @param [ Hash ] options The user options.
         #
         # @option options [ Session ] :session The session to use for the operation.
+        # @option options [ Hash ] :write_concern The write concern options.
         #
         # @return [ Result ] The response.
         #
@@ -106,7 +111,8 @@ module Mongo
             Operation::UpdateUser.new(
               user: user,
               db_name: database.name,
-              session: session
+              session: session,
+              write_concern: options[:write_concern] && WriteConcern.get(options[:write_concern]),
             ).execute(next_primary(nil, session))
           end
         end
@@ -121,7 +127,7 @@ module Mongo
         #
         # @option options [ Session ] :session The session to use for the operation.
         #
-        # @return [ Hash ] A document containing information on a particular user.
+        # @return [ Array ] An array wrapping a document containing information on a particular user.
         #
         # @since 2.1.0
         def info(name, options = {})

data/lib/mongo/auth/x509.rb

@@ -17,7 +17,7 @@ require 'mongo/auth/x509/conversation'
 module Mongo
   module Auth
 
-    # Defines behavior for x.509 authentication.
+    # Defines behavior for X.509 authentication.
     #
     # @since 2.0.0
     class X509
@@ -39,6 +39,16 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(user)
+        # The only valid database for X.509 authentication is $external.
+        if user.auth_source != '$external'
+          user_name_msg = if user.name
+            " #{user.name}"
+          else
+            ''
+          end
+          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
       end
 

data/lib/mongo/auth/x509/conversation.rb

@@ -16,7 +16,7 @@ module Mongo
   module Auth
     class X509
 
-      # Defines behavior around a single x.509 conversation between the
+      # Defines behavior around a single X.509 conversation between the
       # client and server.
       #
       # @since 2.0.0
@@ -34,7 +34,7 @@ module Mongo
         # @return [ User ] user The user for the conversation.
         attr_reader :user
 
-        # Finalize the x.509 conversation. This is meant to be iterated until
+        # Finalize the X.509 conversation. This is meant to be iterated until
         # the provided reply indicates the conversation is finished.
         #
         # @example Finalize the conversation.
@@ -50,7 +50,7 @@ module Mongo
           validate!(reply)
         end
 
-        # Start the x.509 conversation. This returns the first message that
+        # Start the X.509 conversation. This returns the first message that
         # needs to be sent to the server.
         #
         # @example Start the conversation.
@@ -58,7 +58,7 @@ module Mongo
         #
         # @param [ Mongo::Server::Connection ] connection The connection being authenticated.
         #
-        # @return [ Protocol::Query ] The first x.509 conversation message.
+        # @return [ Protocol::Query ] The first X.509 conversation message.
         #
         # @since 2.0.0
         def start(connection = nil)
@@ -66,7 +66,16 @@ module Mongo
           login[:user] = user.name if user.name
           if connection && connection.features.op_msg_enabled?
             selector = login
-            selector[Protocol::Msg::DATABASE_IDENTIFIER] = user.auth_source
+            # The only valid database for X.509 authentication is $external.
+            if user.auth_source != '$external'
+              user_name_msg = if user.name
+                " #{user.name}"
+              else
+                ''
+              end
+              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
+            selector[Protocol::Msg::DATABASE_IDENTIFIER] = '$external'
             cluster_time = connection.mongos? && connection.cluster_time
             selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time
             Protocol::Msg.new([], {}, selector)
@@ -96,7 +105,7 @@ module Mongo
 
         def validate!(reply)
           if reply.documents[0][Operation::Result::OK] != 1
-            raise Unauthorized.new(user, MECHANISM)
+            raise Unauthorized.new(user, used_mechanism: MECHANISM)
           end
           @reply = reply
         end

data/lib/mongo/background_thread.rb

@@ -30,6 +30,14 @@ module Mongo
     #
     # @api public for backwards compatibility only
     def run!
+      if @stop_requested && @thread
+        wait_for_stop
+        if @thread.alive?
+          log_warn("Starting a new background thread in #{self}, but the previous background thread is still running")
+          @thread = nil
+        end
+        @stop_requested = false
+      end
       if running?
         @thread
       else
@@ -81,6 +89,25 @@ module Mongo
       # the middle of an operation.
       @thread.kill
 
+      wait_for_stop
+    end
+
+    private
+
+    def start!
+      @thread = Thread.new do
+        catch(:done) do
+          until @stop_requested
+            do_work
+          end
+        end
+      end
+    end
+
+    # Waits for the thread to die, with a timeout.
+    #
+    # Returns true if the thread died, false otherwise.
+    def wait_for_stop
       # Wait for the thread to die. This is important in order to reliably
       # clean up resources like connections knowing that no background
       # thread will reconnect because it is still working.
@@ -106,23 +133,11 @@ module Mongo
         false
       else
         @thread = nil
+        @stop_requested = false
         true
       end
     end
 
-    private
-
-    # @return [ Thread ] The created Thread instance.
-    def start!
-      @thread = Thread.new do
-        catch(:done) do
-          until @stop_requested
-            do_work
-          end
-        end
-      end
-    end
-
     # Override this method to do the work in the background thread.
     def do_work
     end

data/lib/mongo/client.rb

@@ -363,7 +363,8 @@ module Mongo
     # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
     #   option.
     # @option options [ Hash ] :write_concern The write concern options.
-    #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+    #   Can be :w => Integer|String, :wtimeout => Integer (in milliseconds),
+    #   :j => Boolean, :fsync => Boolean.
     # @option options [ Integer ] :zlib_compression_level The Zlib compression level to use, if using compression.
     #   See Ruby's Zlib module for valid levels.
     # @option options [ Hash ] :resolv_options For internal driver use only.
@@ -371,11 +372,7 @@ module Mongo
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = nil)
-      if options
-        options = options.dup
-      else
-        options = {}
-      end
+      options = options ? options.dup : {}
 
       srv_uri = nil
       if addresses_or_uri.is_a?(::String)
@@ -401,18 +398,12 @@ module Mongo
         @srv_records = nil
       end
 
-      unless options[:retry_reads] == false
-        options[:retry_reads] = true
-      end
-      unless options[:retry_writes] == false
-        options[:retry_writes] = true
-      end
-
       # Special handling for sdam_proc as it is only used during client
       # construction
       sdam_proc = options.delete(:sdam_proc)
 
-      @options = validate_new_options!(Database::DEFAULT_OPTIONS.merge(options))
+      options = default_options(options).merge(options)
+      @options = validate_new_options!(options)
 =begin WriteConcern object support
       if @options[:write_concern].is_a?(WriteConcern::Base)
         # Cache the instance so that we do not needlessly reconstruct it.
@@ -814,6 +805,23 @@ module Mongo
 
     private
 
+    # Generate default client options based on the URI and options
+    # passed into the Client constructor.
+    def default_options(options)
+      Database::DEFAULT_OPTIONS.dup.tap do |default_options|
+        if options[:auth_mech] || options[:user]
+          default_options[:auth_source] = Auth::User.default_auth_source(options)
+        end
+
+        if options[:auth_mech] == :gssapi
+          default_options[:auth_mech_properties] = { service_name: 'mongodb' }
+        end
+
+        default_options[:retry_reads] = true
+        default_options[:retry_writes] = true
+      end
+    end
+
     # If options[:session] is set, validates that session and returns it.
     # If deployment supports sessions, creates a new session and returns it.
     # The session is implicit unless options[:implicit] is given.
@@ -914,7 +922,7 @@ module Mongo
         raise Mongo::Auth::InvalidConfiguration.new('password is not supported for mongodb_x509')
       end
 
-      if ![:external, nil].include?(auth_source) && [:gssapi, :mongodb_x509].include?(auth_mech)
+      if !['$external', nil].include?(auth_source) && [:gssapi, :mongodb_x509].include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration.new("#{auth_source} is an invalid auth source for #{auth_mech}; valid options are $external and nil")
       end
 

data/lib/mongo/collection/view/change_stream.rb

@@ -296,7 +296,11 @@ module Mongo
         end
 
         def change_doc
-          { fullDocument: ( @options[:full_document] || FULL_DOCUMENT_DEFAULT ) }.tap do |doc|
+          {}.tap do |doc|
+            if @options[:full_document]
+              doc[:fullDocument] = @options[:full_document]
+            end
+
             if resuming?
               # We have a resume token once we retrieved any documents.
               # However, if the first getMore fails and the user didn't pass

data/lib/mongo/collection/view/readable.rb

@@ -244,6 +244,9 @@ module Mongo
         #
         # @since 2.0.0
         def distinct(field_name, opts = {})
+          if field_name.nil?
+            raise ArgumentError, 'Field name for distinct operation must be not nil'
+          end
           cmd = { :distinct => collection.name,
                   :key => field_name.to_s,
                   :query => filter }
@@ -602,7 +605,7 @@ module Mongo
           cmd.execute(server).cursor_ids.map do |cursor_id|
             result = if server.features.find_command_enabled?
               Operation::GetMore.new({
-                :selector => {:getMore => cursor_id,
+                :selector => {:getMore => BSON::Int64.new(cursor_id),
                              :collection => collection.name},
                 :db_name => database.name,
                 :session => session,
@@ -610,7 +613,7 @@ module Mongo
              else
               Operation::GetMore.new({
                 :to_return => 0,
-                :cursor_id => cursor_id,
+                :cursor_id => BSON::Int64.new(cursor_id),
                 :db_name => database.name,
                 :coll_name => collection.name
               }).execute(server)