mongo 2.5.3 → 2.6.0

data/lib/mongo/auth/user.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB Inc.
+# Copyright (C) 2014-2018 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -111,6 +111,10 @@ module Mongo
         @hashed_password ||= Digest::MD5.hexdigest("#{name}:mongo:#{password}").encode(BSON::UTF8)
       end
 
+      def sasl_prepped_hashed_password
+        @sasl_prepped_hashed_password ||= sasl_prepped_password.encode(BSON::UTF8)
+      end
+
       # Create the new user.
       #
       # @example Create a new user.
@@ -135,7 +139,7 @@ module Mongo
         @auth_source = options[:auth_source] || @database
         @name = options[:user]
         @password = options[:password] || options[:pwd]
-        @mechanism = options[:auth_mech] || :mongodb_cr
+        @mechanism = options[:auth_mech]
         @auth_mech_properties = options[:auth_mech_properties] || {}
         @roles = options[:roles] || []
         @client_key = options[:client_key]
@@ -150,11 +154,18 @@ module Mongo
       #
       # @since 2.0.0
       def spec
-        { pwd: hashed_password, roles: roles }
+        { pwd: password, roles: roles }
       end
 
       private
 
+      def sasl_prepped_password
+        StringPrep.prepare(password,
+                           StringPrep::Profiles::SASL::MAPPINGS,
+                           StringPrep::Profiles::SASL::PROHIBITED,
+                           normalize: true, bidi: true)
+      end
+
       # The client key for the user.
       #
       # @return [ String ] The client key for the user.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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-2017 MongoDB Inc.
+# Copyright (C) 2014-2018 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/conversation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014 MongoDB Inc.
+# Copyright (C) 2014-2018 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/bson.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -168,19 +168,19 @@ module Mongo
       }
     end
 
-    def execute_operation(name, values, server, operation_id, combiner, session, txn_num = nil)
+    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?
       begin
         if values.size > server.max_write_batch_size
-          split_execute(name, values, server, operation_id, combiner, session, txn_num)
+          split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
         else
           result = send(name, values, server, operation_id, session, txn_num)
-          combiner.combine!(result, values.size)
+          result_combiner.combine!(result, values.size)
         end
       rescue Error::MaxBSONSize, Error::MaxMessageSize => e
         raise e if values.size <= 1
-        split_execute(name, values, server, operation_id, combiner, session, txn_num)
+        split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
       end
     end
 
@@ -188,11 +188,11 @@ module Mongo
       @op_combiner ||= ordered? ? OrderedCombiner.new(requests) : UnorderedCombiner.new(requests)
     end
 
-    def split_execute(name, values, server, operation_id, combiner, session, txn_num)
-      execute_operation(name, values.shift(values.size / 2), server, operation_id, combiner, session, txn_num)
+    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)
 
       txn_num = session.next_txn_num if txn_num
-      execute_operation(name, values, server, operation_id, combiner, session, txn_num)
+      execute_operation(name, values, server, operation_id, result_combiner, session, txn_num)
     end
 
     def delete_one(documents, server, operation_id, session, txn_num)

data/lib/mongo/bulk_write/combineable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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/ordered_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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/result_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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,7 +22,7 @@ module Mongo
     # @since 2.1.0
     class ResultCombiner
 
-      # @return [ Integer ] count The count of documents in the entire batch.
+      # @return [ Integer ] count The number of documents in the entire batch.
       attr_reader :count
 
       # @return [ Hash ] results The results hash.
@@ -41,11 +41,11 @@ module Mongo
         @count = 0
       end
 
-      # Combines a result into the overall results.
+      # Adds a result to the overall results.
       #
       # @api private
       #
-      # @example Combine the result.
+      # @example Add the result.
       #   combiner.combine!(result, count)
       #
       # @param [ Operation::Result ] result The result to combine.

data/lib/mongo/bulk_write/transformable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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/unordered_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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/validatable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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/client.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -52,6 +52,7 @@ module Mongo
       :password,
       :platform,
       :read,
+      :read_concern,
       :read_retry_interval,
       :replica_set,
       :retry_writes,
@@ -94,7 +95,12 @@ module Mongo
     def_delegators :@database, :command, :collections
 
     # Delegate subscription to monitoring.
-    def_delegators :@monitoring, :subscribe, :unsubscribe
+    def_delegators :monitoring, :subscribe, :unsubscribe
+
+    # Delegate monitoring to cluster.
+    def_delegators :cluster, :monitoring
+
+    private :monitoring
 
     # Determine if this client is equivalent to another object.
     #
@@ -142,17 +148,23 @@ module Mongo
     # Instantiate a new driver client.
     #
     # @example Instantiate a single server or mongos client.
-    #   Mongo::Client.new([ '127.0.0.1:27017' ])
+    #   Mongo::Client.new(['127.0.0.1:27017'])
     #
     # @example Instantiate a client for a replica set.
-    #   Mongo::Client.new([ '127.0.0.1:27017', '127.0.0.1:27021' ])
+    #   Mongo::Client.new(['127.0.0.1:27017', '127.0.0.1:27021'])
+    #
+    # @example Directly connect to a mongod in a replica set
+    #   Mongo::Client.new(['127.0.0.1:27017'], :connect => :direct)
+    #   # without `:connect => :direct`, Mongo::Client will discover and
+    #   # connect to the replica set if given the address of a server in
+    #   # a replica set
     #
     # @param [ Array<String>, String ] addresses_or_uri The array of server addresses in the
     #   form of host:port or a MongoDB URI connection string.
     # @param [ Hash ] options The options to be used by the client.
     #
     # @option options [ Symbol ] :auth_mech The authentication mechanism to
-    #   use. One of :mongodb_cr, :mongodb_x509, :plain, :scram
+    #   use. One of :mongodb_cr, :mongodb_x509, :plain, :scram, :scram256
     # @option options [ String ] :auth_source The source to authenticate from.
     # @option options [ Symbol ] :connect The connection method to use. This
     #   forces the cluster to behave in the specified way instead of
@@ -177,13 +189,15 @@ module Mongo
     # @option options [ Float ] :connect_timeout The timeout, in seconds, to
     #   attempt a connection.
     # @option options [ Array<String> ] :compressors A list of potential compressors to use, in order of preference.
-    #  The driver chooses the first compressor that is also supported by the server. Currently the driver only
+    #   The driver chooses the first compressor that is also supported by the server. Currently the driver only
     #   supports 'zlib'.
-    # @option options [ Hash ] :read The read preference options. They consist of a
-    #   mode specified as a symbol, an array of hashes known as tag_sets,
-    #   and local_threshold.
-    #   :mode can be one of :secondary, :secondary_preferred, :primary,
-    #   :primary_preferred, :nearest.
+    # @option options [ Hash ] :read The read preference options. The hash
+    #   may have the following items:
+    #   - *:read* -- read preference specified as a symbol; valid values are
+    #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+    #     and *:nearest*.
+    #   - *:tag_sets* -- an array of hashes.
+    #   - *:local_threshold*.
     # @option options [ Symbol ] :replica_set The name of the replica set to
     #   connect to. Servers not in this replica set will be ignored.
     # @option options [ true, false ] :ssl Whether to use SSL.
@@ -224,6 +238,7 @@ module Mongo
     # @option options [ String ] :user The user name.
     # @option options [ Hash ] :write The write concern options. Can be :w =>
     #   Integer|String, :fsync => Boolean, :j => Boolean.
+    # @option options [ Hash ] :read_concern The read concern option.
     # @option options [ true, false ] :monitoring Initializes a client without
     #   any default monitoring if false is provided.
     # @option options [ Logger ] :logger A custom logger if desired.
@@ -241,12 +256,11 @@ module Mongo
     #   metadata printed to the mongod logs upon establishing a connection in server versions >= 3.4.
     # @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 [ true, false ] :retry_writes Retry writes once when connected to a replica set
-    #   or sharded cluster versions 3.6 and up.
+    # @option options [ true, false ] :retry_writes Retry writes once when
+    #   connected to a replica set or sharded cluster versions 3.6 and up.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)
-      @monitoring = Monitoring.new(options)
       if addresses_or_uri.is_a?(::String)
         create_from_uri(addresses_or_uri, validate_options!(options))
       else
@@ -267,14 +281,14 @@ module Mongo
       "#<Mongo::Client:0x#{object_id} cluster=#{cluster.addresses.join(', ')}>"
     end
 
-    # Get the server selector. It either uses the read preference defined in the client options
-    #   or defaults to a Primary server selector.
+    # Get the server selector. It either uses the read preference
+    # defined in the client options or defaults to a Primary server selector.
     #
     # @example Get the server selector.
     #   client.server_selector
     #
-    # @return [ Mongo::ServerSelector ] The server selector using the user-defined read preference
-    #  or a Primary server selector default.
+    # @return [ Mongo::ServerSelector ] The server selector using the
+    #  user-defined read preference or a Primary server selector default.
     #
     # @since 2.5.0
     def server_selector
@@ -333,6 +347,19 @@ module Mongo
       end
     end
 
+    # Get the read concern for this client.
+    #
+    # @example Get the client read concern.
+    #   client.read_concern
+    #
+    # @return [ Hash ] The read concern.
+    #
+    # @since 2.6.0
+    def read_concern
+      @read_concern ||= options[:read_concern]
+    end
+
+
     # Get the write concern for this client. If no option was provided, then a
     # default single server acknowledgement will be used.
     #
@@ -435,36 +462,79 @@ module Mongo
     #
     # @since 2.5.0
     def start_session(options = {})
-      cluster.send(:get_session, options.merge(implicit: false)) ||
+      cluster.send(:get_session, self, options.merge(implicit: false)) ||
         (raise Error::InvalidSession.new(Session::SESSIONS_NOT_SUPPORTED))
     end
 
+    # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline stage is supported
+    # in the aggregation framework. As of version 4.0, this stage allows users to request that
+    # notifications are sent for all changes that occur in the client's cluster.
+    #
+    # @example Get change notifications for the client's cluster.
+    #  client.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])
+    #
+    # @param [ Array<Hash> ] pipeline Optional additional filter operators.
+    # @param [ Hash ] options The change stream options.
+    #
+    # @option options [ String ] :full_document Allowed values: 'default', 'updateLookup'.
+    #   Defaults to 'default'. When set to 'updateLookup', the change notification for partial
+    #   updates will include both a delta describing the changes to the document, as well as a copy
+    #   of the entire document that was changed from some time after the change occurred.
+    # @option options [ BSON::Document, Hash ] :resume_after Specifies the logical starting point
+    #   for the new change stream.
+    # @option options [ Integer ] :max_await_time_ms The maximum amount of time for the server to
+    #   wait on new documents to satisfy a change stream query.
+    # @option options [ Integer ] :batch_size The number of documents to return per batch.
+    # @option options [ BSON::Document, Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
+    # @option options [ BSON::Timestamp ] :start_at_operation_time Only return
+    #   changes that occurred at or after the specified timestamp. Any command run
+    #   against the server will return a cluster time that can be used here.
+    #   Only recognized by server versions 4.0+.
+    #
+    # @note A change stream only allows 'majority' read concern.
+    # @note This helper method is preferable to running a raw aggregation with a $changeStream
+    #   stage, for the purpose of supporting resumability.
+    #
+    # @return [ ChangeStream ] The change stream object.
+    #
+    # @since 2.6.0
+    def watch(pipeline = [], options = {})
+      return use(Database::ADMIN).watch(pipeline, options) unless database.name == Database::ADMIN
+
+      Mongo::Collection::View::ChangeStream.new(
+        Mongo::Collection::View.new(self["#{Database::COMMAND}.aggregate"]),
+        pipeline,
+        Mongo::Collection::View::ChangeStream::CLUSTER,
+        options)
+    end
+
     private
 
     def get_session(options = {})
-      cluster.send(:get_session, options)
+      cluster.send(:get_session, self, options)
     end
 
     def with_session(options = {}, &block)
-      cluster.send(:with_session, options, &block)
+      cluster.send(:with_session, self, options, &block)
     end
 
     def create_from_addresses(addresses, opts = Options::Redacted.new)
       @options = Database::DEFAULT_OPTIONS.merge(opts).freeze
-      @cluster = Cluster.new(addresses, @monitoring, options)
+      @cluster = Cluster.new(addresses, Monitoring.new(options), options)
       @database = Database.new(self, options[:database], options)
     end
 
     def create_from_uri(connection_string, opts = Options::Redacted.new)
       uri = URI.get(connection_string, opts)
       @options = validate_options!(Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts))).freeze
-      @cluster = Cluster.new(uri.servers, @monitoring, options)
+      @cluster = Cluster.new(uri.servers, @cluster ? monitoring : Monitoring.new(options), options)
       @database = Database.new(self, options[:database], options)
     end
 
     def initialize_copy(original)
       @options = original.options.dup
-      @monitoring = Monitoring.new(@options)
+      @monitoring = @cluster ? monitoring : Monitoring.new(options)
       @database = nil
       @read_preference = nil
       @write_concern = nil
@@ -485,6 +555,7 @@ module Mongo
         key = k.to_sym
         if VALID_OPTIONS.include?(key)
           validate_max_min_pool_size!(key, opts)
+          validate_read!(key, opts)
           if key == :compressors
             compressors = valid_compressors(v)
             _options[key] = compressors unless compressors.empty?
@@ -517,5 +588,25 @@ module Mongo
       end
       true
     end
+
+    def validate_read!(option, opts)
+      if option == :read && opts.has_key?(:read)
+        read = opts[:read]
+        # We could check if read is a Hash, but this would fail
+        # for custom classes implementing key access ([]).
+        # Instead reject common cases of strings and symbols.
+        if read.is_a?(String) || read.is_a?(Symbol)
+          raise Error::InvalidReadOption.new(read, 'must be a hash')
+        end
+
+        if mode = read[:mode]
+          mode = mode.to_sym
+          unless Mongo::ServerSelector::PREFERENCES.include?(mode)
+            raise Error::InvalidReadOption.new(read, "mode #{mode} is not one of recognized modes")
+          end
+        end
+      end
+      true
+    end
   end
 end

data/lib/mongo/cluster.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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,8 +20,8 @@ require 'mongo/cluster/app_metadata'
 
 module Mongo
 
-  # Represents a group of servers on the server side, either as a single server, a
-  # replica set, or a single or multiple mongos.
+  # Represents a group of servers on the server side, either as a
+  # single server, a replica set, or a single or multiple mongos.
   #
   # @since 2.0.0
   class Cluster
@@ -161,9 +161,16 @@ module Mongo
     #
     # @note Cluster should never be directly instantiated outside of a Client.
     #
-    # @param [ Array<String> ] seeds The addresses of the configured servers.
+    # @note When connecting to a mongodb+srv:// URI, the client expands such a
+    #   URI into a list of servers and passes that list to the Cluster
+    #   constructor. When connecting to a standalone mongod, the Cluster
+    #   constructor receives the corresponding address as an array of one string.
+    #
+    # @param [ Array<String> ] seeds The addresses of the configured servers
     # @param [ Monitoring ] monitoring The monitoring.
-    # @param [ Hash ] options The options.
+    # @param [ Hash ] options Options. Client constructor forwards its
+    #   options to Cluster constructor, although Cluster recognizes
+    #   only a subset of the options recognized by Client.
     #
     # @since 2.0.0
     def initialize(seeds, monitoring, options = Options::Redacted.new)
@@ -448,7 +455,7 @@ module Mongo
     def self.create(client)
       cluster = Cluster.new(
         client.cluster.addresses.map(&:to_s),
-        client.instance_variable_get(:@monitoring).dup,
+        Monitoring.new,
         client.options
       )
       client.instance_variable_set(:@cluster, cluster)
@@ -505,15 +512,15 @@ module Mongo
 
     private
 
-    def get_session(options = {})
+    def get_session(client, options = {})
       return options[:session].validate!(self) if options[:session]
       if sessions_supported?
-        Session.new(@session_pool.checkout, self, { implicit: true }.merge(options))
+        Session.new(@session_pool.checkout, client, { implicit: true }.merge(options))
       end
     end
 
-    def with_session(options = {})
-      session = get_session(options)
+    def with_session(client, options = {})
+      session = get_session(client, options)
       yield(session)
     ensure
       session.end_session if (session && session.implicit?)