mongo 2.12.4 → 2.13.0.beta1

data/lib/mongo/bulk_write/ordered_combiner.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/result.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/result_combiner.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/transformable.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.
@@ -61,6 +61,7 @@ module Mongo
           Operation::LIMIT => 0,
         }.tap do |d|
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -73,6 +74,7 @@ module Mongo
           Operation::LIMIT => 1,
         }.tap do |d|
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -91,10 +93,9 @@ module Mongo
           Operation::Q => doc[:filter],
           Operation::U => doc[:replacement],
         }.tap do |d|
-          if doc[:upsert]
-            d['upsert'] = true
-          end
+          d['upsert'] = true if doc[:upsert]
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -107,11 +108,10 @@ module Mongo
           Operation::U => doc[:update],
           Operation::MULTI => true,
         }.tap do |d|
-          if doc[:upsert]
-            d['upsert'] = true
-          end
+          d['upsert'] = true if doc[:upsert]
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 
@@ -123,11 +123,10 @@ module Mongo
           Operation::Q => doc[:filter],
           Operation::U => doc[:update],
         }.tap do |d|
-          if doc[:upsert]
-            d['upsert'] = true
-          end
+          d['upsert'] = true if doc[:upsert]
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
+          d['hint'] = doc[:hint] if doc[:hint]
         end
       }
 

data/lib/mongo/bulk_write/unordered_combiner.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/validatable.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.
@@ -47,6 +47,10 @@ module Mongo
         if document.respond_to?(:keys) && document[:array_filters]
           @has_array_filters = true
         end
+
+        if document.respond_to?(:keys) && document[:hint]
+          @has_hint = true
+        end
       end
 
       private

data/lib/mongo/client.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.
@@ -57,6 +57,7 @@ module Mongo
       :auto_encryption_options,
       :cleanup,
       :compressors,
+      :direct_connection,
       :connect,
       :connect_timeout,
       :database,
@@ -205,7 +206,6 @@ module Mongo
     #   connection string is also provided, these options take precedence over any
     #   analogous options present in the URI string.
     #
-    #
     # @option options [ String, Symbol ] :app_name Application name that is
     #   printed to the mongod logs upon establishing a connection in server
     #   versions >= 3.4.
@@ -217,7 +217,11 @@ module Mongo
     #   compressors to use, in order of preference. The driver chooses the
     #   first compressor that is also supported by the server. Currently the
     #   driver only supports 'zlib'.
-    # @option options [ Symbol ] :connect The connection method to use. This
+    # @option options [ true | false ] :direct_connection Whether to connect
+    #   directly to the specified seed, bypassing topology discovery. Exactly
+    #   one seed must be provided.
+    # @option options [ Symbol ] :connect Deprecated - use :direct_connection
+    #   option instead of this option. The connection method to use. This
     #   forces the cluster to behave in the specified way instead of
     #   auto-discovering. One of :direct, :replica_set, :sharded
     # @option options [ Float ] :connect_timeout The timeout, in seconds, to
@@ -294,7 +298,7 @@ module Mongo
     #   will ignore it and will never scan seeds in the constructor.
     # @option options [ Proc ] :sdam_proc A Proc to invoke with the client
     #   as the argument prior to performing server discovery and monitoring.
-    #   Use this to set up SDAM event listeners to receive events dispatched
+    #   Use this to set up SDAM event listeners to receive events published
     #   during client construction.
     #
     #   Note: the client is not fully constructed when sdam_proc is invoked,
@@ -446,18 +450,7 @@ module Mongo
       # construction
       sdam_proc = options.delete(:sdam_proc)
 
-      # For gssapi service_name, the default option is given in a hash
-      # (one level down from the top level).
-      merged_options = default_options(options)
-      options.each do |k, v|
-        default_v = merged_options[k]
-        if Hash === default_v
-          v = default_v.merge(v)
-        end
-        merged_options[k] = v
-      end
-      options = merged_options
-
+      options = default_options(options).merge(options)
       @options = validate_new_options!(options)
 =begin WriteConcern object support
       if @options[:write_concern].is_a?(WriteConcern::Base)
@@ -467,7 +460,7 @@ module Mongo
       end
 =end
       @options.freeze
-      validate_options!
+      validate_options!(addresses)
       validate_authentication_options!
 
       @database = Database.new(self, @options[:database], @options)
@@ -616,7 +609,7 @@ module Mongo
     #
     # @return [ BSON::Document ] The user-defined read preference.
     #   The document may have the following fields:
-    #   - *:mode* -- read preference specified as a symbol; valid values are
+    #   - *:read* -- read preference specified as a symbol; valid values are
     #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
     #     and *:nearest*.
     #   - *:tag_sets* -- an array of hashes.
@@ -1023,10 +1016,28 @@ module Mongo
     # Validates all options after they are set on the client.
     # This method is intended to catch combinations of options which are
     # not allowed.
-    def validate_options!
+    def validate_options!(addresses = nil)
       if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
         raise ArgumentError, "If :write and :write_concern are both given, they must be identical: #{options.inspect}"
       end
+
+      if options[:direct_connection]
+        if options[:connect] && options[:connect].to_sym != :direct
+          raise ArgumentError, "Conflicting client options: direct_connection=true and connect=#{options[:connect]}"
+        end
+        # When a new client is created, we get the list of seed addresses
+        if addresses && addresses.length > 1
+          raise ArgumentError, "direct_connection=true cannot be used with multiple seeds"
+        end
+        # When a client is copied using #with, we have a cluster
+        if cluster && !cluster.topology.is_a?(Mongo::Cluster::Topology::Single)
+          raise ArgumentError, "direct_connection=true cannot be used with topologies other than Single (this client is #{cluster.topology.class.name.sub(/.*::/, '')})"
+        end
+      end
+
+      if options[:direct_connection] == false && options[:connect] && options[:connect].to_sym == :direct
+        raise ArgumentError, "Conflicting client options: direct_connection=false and connect=#{options[:connect]}"
+      end
     end
 
     # Validates all authentication-related options after they are set on the client
@@ -1054,11 +1065,11 @@ module Mongo
         raise Mongo::Auth::InvalidMechanism.new(auth_mech)
       end
 
-      if user.nil? && auth_mech != :mongodb_x509
+      if user.nil? && !%i(aws mongodb_x509).include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration, "Username is required for auth mechanism #{auth_mech}"
       end
 
-      if password.nil? && ![:gssapi, :mongodb_x509].include?(auth_mech)
+      if password.nil? && !%i(aws gssapi mongodb_x509).include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration, "Password is required for auth mechanism #{auth_mech}"
       end
 
@@ -1066,7 +1077,11 @@ module Mongo
         raise Mongo::Auth::InvalidConfiguration, 'Password is not supported for :mongodb_x509 auth mechanism'
       end
 
-      if [:gssapi, :mongodb_x509].include?(auth_mech)
+      if auth_mech == :aws && user && !password
+        raise Mongo::Auth::InvalidConfiguration, 'Username is provided but password is not provided for :aws auth mechanism'
+      end
+
+      if %i(aws gssapi mongodb_x509).include?(auth_mech)
         if !['$external', nil].include?(auth_source)
           raise Mongo::Auth::InvalidConfiguration, "#{auth_source} is an invalid auth source for #{auth_mech}; valid options are $external and nil"
         end
@@ -1077,7 +1092,7 @@ module Mongo
         end
       end
 
-      if mech_properties && auth_mech != :gssapi
+      if mech_properties && !%i(aws gssapi).include?(auth_mech)
         raise Mongo::Auth::InvalidConfiguration, ":mechanism_properties are not supported for auth mechanism #{auth_mech}"
       end
     end

data/lib/mongo/client_encryption.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.

data/lib/mongo/cluster.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.
@@ -76,6 +76,16 @@ module Mongo
     # @param [ Hash ] options Options. Client constructor forwards its
     #   options to Cluster constructor, although Cluster recognizes
     #   only a subset of the options recognized by Client.
+    #
+    # @option options [ true | false ] :direct_connection Whether to connect
+    #   directly to the specified seed, bypassing topology discovery. Exactly
+    #   one seed must be provided.
+    # @option options [ Symbol ] :connect Deprecated - use :direct_connection
+    #   option instead of this option. The connection method to use. This
+    #   forces the cluster to behave in the specified way instead of
+    #   auto-discovering. One of :direct, :replica_set, :sharded
+    # @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 ] :scan Whether to scan all seeds
     #   in constructor. The default in driver version 2.x is to do so;
     #   driver version 3.x will not scan seeds in constructor. Opt in to the
@@ -104,25 +114,39 @@ module Mongo
         raise ArgumentError, 'Seeds cannot be nil'
       end
 
+      options = options.dup
       if options[:monitoring_io] == false && !options.key?(:cleanup)
-        options = options.dup
         options[:cleanup] = false
       end
+      @options = options.freeze
 
-      seeds = seeds.uniq
-
+      # @update_lock covers @servers, @connecting, @connected, @topology and
+      # @sessions_supported. Generally instance variables that do not have a
+      # designated for them lock should only be modified under the update lock.
+      # Note that topology change is locked by @update_lock and not by
+      # @sdam_flow_lock.
+      @update_lock = Mutex.new
       @servers = []
       @monitoring = monitoring
       @event_listeners = Event::Listeners.new
-      @options = options.freeze
       @app_metadata = Server::AppMetadata.new(@options)
-      @update_lock = Mutex.new
-      @sdam_flow_lock = Mutex.new
-      @cluster_time = nil
       @cluster_time_lock = Mutex.new
+      @cluster_time = nil
       @srv_monitor_lock = Mutex.new
+      @srv_monitor = nil
       @server_selection_semaphore = Semaphore.new
       @topology = Topology.initial(self, monitoring, options)
+      # State change lock is similar to the sdam flow lock, but is designed
+      # to serialize state changes initated by consumers of Cluster
+      # (e.g. application connecting or disconnecting the cluster), so that
+      # e.g. an application calling disconnect-connect-disconnect rapidly
+      # does not put the cluster into an inconsistent state.
+      # Monitoring updates performed internally by the driver do not take
+      # the state change lock.
+      @state_change_lock = Mutex.new
+      # @sdam_flow_lock covers just the sdam flow. Note it does not apply
+      # to @topology replacements which are done under @update_lock.
+      @sdam_flow_lock = Mutex.new
       Session::SessionPool.create(self)
 
       # The opening topology is always unknown with no servers.
@@ -134,7 +158,7 @@ module Mongo
         Monitoring::Event::TopologyOpening.new(opening_topology)
       )
 
-      @seeds = seeds
+      @seeds = seeds = seeds.uniq
       servers = seeds.map do |seed|
         # Server opening events must be sent after topology change events.
         # Therefore separate server addition, done here before topoolgy change
@@ -335,7 +359,18 @@ module Mongo
     # @since 2.10.0
     # @api private
     def heartbeat_interval
-      options[:heartbeat_frequency] || Server::Monitor::HEARTBEAT_FREQUENCY
+      options[:heartbeat_frequency] || Server::Monitor::DEFAULT_HEARTBEAT_INTERVAL
+    end
+
+    # Whether the cluster object is in the process of connecting to its cluster.
+    #
+    # @return [ true|false ] Whether the cluster is connecting.
+    #
+    # @api private
+    def connecting?
+      @update_lock.synchronize do
+        !!@connecting
+      end
     end
 
     # Whether the cluster object is connected to its cluster.
@@ -345,7 +380,9 @@ module Mongo
     # @api private
     # @since 2.7.0
     def connected?
-      !!@connected
+      @update_lock.synchronize do
+        !!@connected
+      end
     end
 
     # Get a list of server candidates from the cluster that can have operations
@@ -370,7 +407,7 @@ module Mongo
     #
     # @since 2.0.6
     def addresses
-      servers_list.map(&:address).dup
+      servers_list.map(&:address)
     end
 
     # The logical session timeout value in minutes.
@@ -441,32 +478,36 @@ module Mongo
     #
     # @since 2.1.0
     def disconnect!
-      unless @connecting || @connected
-        return true
-      end
-      if options[:cleanup] != false
-        session_pool.end_sessions
-        @periodic_executor.stop!
-      end
-      @srv_monitor_lock.synchronize do
-        if @srv_monitor
-          @srv_monitor.stop!
+      @state_change_lock.synchronize do
+        unless connecting? || connected?
+          return true
         end
-      end
-      @servers.each do |server|
-        if server.connected?
-          server.disconnect!
-          publish_sdam_event(
-            Monitoring::SERVER_CLOSED,
-            Monitoring::Event::ServerClosed.new(server.address, topology)
-          )
+        if options[:cleanup] != false
+          session_pool.end_sessions
+          @periodic_executor.stop!
+        end
+        @srv_monitor_lock.synchronize do
+          if @srv_monitor
+            @srv_monitor.stop!
+          end
+        end
+        @servers.each do |server|
+          if server.connected?
+            server.disconnect!
+            publish_sdam_event(
+              Monitoring::SERVER_CLOSED,
+              Monitoring::Event::ServerClosed.new(server.address, topology)
+            )
+          end
+        end
+        publish_sdam_event(
+          Monitoring::TOPOLOGY_CLOSED,
+          Monitoring::Event::TopologyClosed.new(topology)
+        )
+        @update_lock.synchronize do
+          @connecting = @connected = false
         end
       end
-      publish_sdam_event(
-        Monitoring::TOPOLOGY_CLOSED,
-        Monitoring::Event::TopologyClosed.new(topology)
-      )
-      @connecting = @connected = false
       true
     end
 
@@ -481,19 +522,25 @@ module Mongo
     # @deprecated Use Client#reconnect to reconnect to the cluster instead of
     #   calling this method. This method does not send SDAM events.
     def reconnect!
-      @connecting = true
-      scan!
-      servers.each do |server|
-        server.reconnect!
-      end
-      @periodic_executor.restart!
-      @srv_monitor_lock.synchronize do
-        if @srv_monitor
-          @srv_monitor.run!
+      @state_change_lock.synchronize do
+        @update_lock.synchronize do
+          @connecting = true
+        end
+        scan!
+        servers.each do |server|
+          server.reconnect!
+        end
+        @periodic_executor.restart!
+        @srv_monitor_lock.synchronize do
+          if @srv_monitor
+            @srv_monitor.run!
+          end
+        end
+        @update_lock.synchronize do
+          @connecting = false
+          @connected = true
         end
       end
-      @connecting = false
-      @connected = true
     end
 
     # Force a scan of all known servers in the cluster.
@@ -736,7 +783,14 @@ module Mongo
       if !addresses.include?(address)
         server = Server.new(address, self, @monitoring, event_listeners, options.merge(
           monitor: false))
-        @update_lock.synchronize { @servers.push(server) }
+        @update_lock.synchronize do
+          # Need to recheck whether server is present in @servers, because
+          # the previous check was not under a lock.
+          # Since we are under the update lock here, we cannot call servers_list.
+          return if @servers.map(&:address).include?(address)
+
+          @servers.push(server)
+        end
         if add_options.nil? || add_options[:monitor] != false
           server.start_monitoring
         end
@@ -765,8 +819,16 @@ module Mongo
     # @since 2.0.0
     def remove(host, disconnect: true)
       address = Address.new(host)
-      removed_servers = @servers.select { |s| s.address == address }
-      @update_lock.synchronize { @servers = @servers - removed_servers }
+      removed_servers = []
+      @update_lock.synchronize do
+        @servers.delete_if do |server|
+          (server.address == address).tap do |delete|
+            if delete
+              removed_servers << server
+            end
+          end
+        end
+      end
       if disconnect != false
         removed_servers.each do |server|
           disconnect_server_if_connected(server)
@@ -781,8 +843,11 @@ module Mongo
 
     # @api private
     def update_topology(new_topology)
-      old_topology = topology
-      @topology = new_topology
+      old_topology = nil
+      @update_lock.synchronize do
+        old_topology = topology
+        @topology = new_topology
+      end
 
       # If new topology has data bearing servers, we know for sure whether
       # sessions are supported - update our cached value.
@@ -791,7 +856,10 @@ module Mongo
       # to try to determine session support accurately, falling back to the
       # last known value.
       if topology.data_bearing_servers?
-        @sessions_supported = !!topology.logical_session_timeout
+        sessions_supported = !!topology.logical_session_timeout
+        @update_lock.synchronize do
+          @sessions_supported = sessions_supported
+        end
       end
 
       publish_sdam_event(
@@ -802,7 +870,9 @@ module Mongo
 
     # @api private
     def servers_list
-      @update_lock.synchronize { @servers.dup }
+      @update_lock.synchronize do
+        @servers.dup
+      end
     end
 
     # @api private
@@ -842,7 +912,9 @@ module Mongo
       rescue Error::NoServerAvailable
         # We haven't been able to contact any servers - use last known
         # value for esssion support.
-        @sessions_supported || false
+        @update_lock.synchronize do
+          @sessions_supported || false
+        end
       end
     end