mongo 2.10.5 → 2.11.0.rc0

data/lib/mongo/cluster/sdam_flow.rb

@@ -28,7 +28,7 @@ class Mongo::Cluster
     def initialize(cluster, previous_desc, updated_desc)
       @cluster = cluster
       @topology = cluster.topology
-      @previous_desc = previous_desc
+      @original_desc = @previous_desc = previous_desc
       @updated_desc = updated_desc
     end
 
@@ -48,6 +48,7 @@ class Mongo::Cluster
 
     attr_reader :previous_desc
     attr_reader :updated_desc
+    attr_reader :original_desc
 
     def_delegators :topology, :replica_set_name
 
@@ -57,9 +58,11 @@ class Mongo::Cluster
       servers_list.each do |server|
         if server.address == updated_desc.address
           changed = server.description != updated_desc
-          # Always update server description, so that fields like
-          # last_update_time reflect the last ismaster response
+          # Always update server description, so that fields that do not
+          # affect description equality comparisons but are part of the
+          # description are updated.
           server.update_description(updated_desc)
+          server.update_last_scan
           # But return if there was a content difference between
           # descriptions, and if there wasn't we'll skip the remainder of
           # sdam flow
@@ -411,6 +414,7 @@ class Mongo::Cluster
       # not all processed together.
 
       publish_description_change_event
+      start_pool_if_data_bearing
 
       topology_changed_event_published = false
       if topology.object_id != cluster.topology.object_id || @need_topology_changed_event
@@ -447,6 +451,18 @@ class Mongo::Cluster
       cluster.update_topology(topology)
     end
 
+    # If the server being processed is identified as data bearing, creates the
+    # server's connection pool so it can start populating
+    def start_pool_if_data_bearing
+      return if !updated_desc.data_bearing?
+
+      servers_list.each do |server|
+        if server.address == @updated_desc.address
+          server.pool
+        end
+      end
+    end
+
     # Checks if the cluster has a primary, and if not, transitions the topology
     # to ReplicaSetNoPrimary. Topology must be ReplicaSetWithPrimary when
     # invoking this method.
@@ -477,5 +493,12 @@ class Mongo::Cluster
       end
       false
     end
+
+    # Returns whether the server whose description this flow processed
+    # was not previously unknown, and is now. Used to decide, in particular,
+    # whether to clear the server's connection pool.
+    def became_unknown?
+      updated_desc.unknown? && !original_desc.unknown?
+    end
   end
 end

data/lib/mongo/cluster/srv_monitor.rb

@@ -0,0 +1,127 @@
+# Copyright (C) 2019 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
+#
+#   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.
+
+module Mongo
+  class Cluster
+
+    # Periodically retrieves SRV records for the cluster's SRV URI, and
+    # sets the cluster's server list to the SRV lookup result.
+    #
+    # If an error is encountered during SRV lookup or an SRV record is invalid
+    # or disallowed for security reasons, a warning is logged and monitoring
+    # continues.
+    #
+    # @api private
+    class SrvMonitor
+      include Loggable
+      include BackgroundThread
+
+      MIN_SCAN_INTERVAL = 60
+
+      DEFAULT_TIMEOUT = 10
+
+      # Creates the SRV monitor.
+      #
+      # @param [ Cluster ] cluster The cluster.
+      # @param [ Hash ] options The cluster options.
+      #
+      # @option options [ Float ] :timeout The timeout to use for DNS lookups.
+      # @option options [ URI::SRVProtocol ] :srv_uri The SRV URI to monitor.
+      # @option options [ Hash ] :resolv_options For internal driver use only.
+      #   Options to pass through to Resolv::DNS constructor for SRV lookups.
+      def initialize(cluster, options = nil)
+        options = if options
+          options.dup
+        else
+          {}
+        end
+        @cluster = cluster
+        @resolver = Srv::Resolver.new(options)
+        unless @srv_uri = options.delete(:srv_uri)
+          raise ArgumentError, 'SRV URI is required'
+        end
+        @options = options.freeze
+        @last_result = @srv_uri.srv_result
+        @stop_semaphore = Semaphore.new
+      end
+
+      attr_reader :options
+
+      attr_reader :cluster
+
+      # @return [ Srv::Result ] Last known SRV lookup result. Used for
+      #   determining intervals between SRV lookups, which depend on SRV DNS
+      #   records' TTL values.
+      attr_reader :last_result
+
+      def start!
+        super
+        ObjectSpace.define_finalizer(self, self.class.finalize(@thread))
+      end
+
+      private
+
+      def do_work
+        scan!
+        @stop_semaphore.wait(scan_interval)
+      end
+
+      def scan!
+        old_hosts = last_result.address_strs
+
+        begin
+          last_result = Timeout.timeout(timeout) do
+            @resolver.get_records(@srv_uri.query_hostname)
+          end
+        rescue Resolv::ResolvTimeout => e
+          log_warn("SRV monitor: timed out trying to resolve hostname #{@srv_uri.query_hostname}: #{e.class}: #{e}")
+          return
+        rescue Timeout::Error
+          log_warn("SRV monitor: timed out trying to resolve hostname #{@srv_uri.query_hostname} (timeout=#{timeout})")
+          return
+        rescue Resolv::ResolvError => e
+          log_warn("SRV monitor: unable to resolve hostname #{@srv_uri.query_hostname}: #{e.class}: #{e}")
+          return
+        end
+
+        if last_result.empty?
+          log_warn("SRV monitor: hostname #{@srv_uri.query_hostname} resolved to zero records")
+          return
+        end
+
+        @cluster.set_server_list(last_result.address_strs)
+      end
+
+      def self.finalize(thread)
+        Proc.new do
+          thread.kill
+        end
+      end
+
+      def scan_interval
+        if last_result.empty?
+          [cluster.heartbeat_interval, MIN_SCAN_INTERVAL].min
+        elsif last_result.min_ttl.nil?
+          MIN_SCAN_INTERVAL
+        else
+          [last_result.min_ttl, MIN_SCAN_INTERVAL].max
+        end
+      end
+
+      def timeout
+        options[:timeout] || DEFAULT_TIMEOUT
+      end
+    end
+  end
+end

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

@@ -185,9 +185,7 @@ module Mongo
           pipeline << { :'$limit' => opts[:limit] } if opts[:limit]
           pipeline << { :'$group' => { _id: 1, n: { :'$sum' => 1 } } }
 
-          opts = opts.select { |k, _| [:hint, :max_time_ms, :read, :collation, :session].include?(k) }
-          opts[:collation] ||= collation
-
+          opts.select! { |k, _| [:hint, :max_time_ms, :read, :collation, :session].include?(k) }
           first = aggregate(pipeline, opts).first
           return 0 unless first
           first['n'].to_i
@@ -604,7 +602,7 @@ module Mongo
           cmd.execute(server).cursor_ids.map do |cursor_id|
             result = if server.features.find_command_enabled?
               Operation::GetMore.new({
-                :selector => {:getMore => BSON::Int64.new(cursor_id),
+                :selector => {:getMore => cursor_id,
                              :collection => collection.name},
                 :db_name => database.name,
                 :session => session,
@@ -612,7 +610,7 @@ module Mongo
              else
               Operation::GetMore.new({
                 :to_return => 0,
-                :cursor_id => BSON::Int64.new(cursor_id),
+                :cursor_id => cursor_id,
                 :db_name => database.name,
                 :coll_name => collection.name
               }).execute(server)

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

@@ -232,7 +232,7 @@ module Mongo
                          Operation::U => replacement,
                         }
           if opts[:upsert]
-            update_doc['upsert'] = true
+            update_doc[:upsert] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
@@ -279,7 +279,7 @@ module Mongo
                          Operation::MULTI => true,
                          }
           if opts[:upsert]
-            update_doc['upsert'] = true
+            update_doc[:upsert] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
@@ -323,7 +323,7 @@ module Mongo
                          Operation::U => spec,
                          }
           if opts[:upsert]
-            update_doc['upsert'] = true
+            update_doc[:upsert] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)

data/lib/mongo/cursor/builder/get_more_command.rb

@@ -57,10 +57,7 @@ module Mongo
         private
 
         def get_more_command
-          command = {
-            :getMore => BSON::Int64.new(cursor.id),
-            :collection => collection_name,
-          }
+          command = { :getMore => cursor.id, :collection => collection_name }
           command[:batchSize] = batch_size.abs if batch_size && batch_size != 0
           # If the max_await_time_ms option is set, then we set maxTimeMS on
           # the get more command.

data/lib/mongo/cursor/builder/kill_cursors_command.rb

@@ -54,10 +54,7 @@ module Mongo
         private
 
         def kill_cursors_command
-          {
-            killCursors: collection_name,
-            cursors: [ BSON::Int64.new(cursor.id) ],
-          }
+          { :killCursors => collection_name, :cursors => [ cursor.id ] }
         end
 
         class << self
@@ -68,19 +65,11 @@ module Mongo
           #   KillCursorsCommand.update_cursors(spec, ids)
           #
           # @return [ Hash ] The specification.
-          # @return [ Array<Integer> ] The ids to update with.
+          # @return [ Array ] The ids to update with.
           #
           # @since 2.3.0
           def update_cursors(spec, ids)
-            # Ruby 2.5+ can & BSON::Int64 instances.
-            # Ruby 2.4 and earlier cannot.
-            # Convert stored ids to Ruby integers for compatibility with
-            # older Rubies.
-            ids = get_cursors_list(spec) & ids
-            ids = ids.map do |cursor_id|
-              BSON::Int64.new(cursor_id)
-            end
-            spec[:selector].merge!(cursors: ids)
+            spec[:selector].merge!(cursors: spec[:selector][:cursors] & ids)
           end
 
           # Get the list of cursor ids from a spec generated by this Builder.
@@ -88,18 +77,11 @@ module Mongo
           # @example Get the list of cursor ids.
           #   KillCursorsCommand.cursors(spec)
           #
-          # @return [ Array<Integer> ] The cursor ids.
+          # @return [ Hash ] The specification.
           #
           # @since 2.3.0
           def get_cursors_list(spec)
-            spec[:selector][:cursors].map do |value|
-              if value.respond_to?(:value)
-                # bson-ruby >= 4.6.0
-                value = value.value
-              else
-                value = value.instance_variable_get('@integer')
-              end
-            end
+            spec[:selector][:cursors]
           end
         end
       end

data/lib/mongo/cursor/builder/op_get_more.rb

@@ -50,9 +50,9 @@ module Mongo
         def specification
           {
             :to_return => to_return,
-            :cursor_id => BSON::Int64.new(cursor.id),
+            :cursor_id => cursor.id,
             :db_name   => database.name,
-            :coll_name => collection_name,
+            :coll_name => collection_name
           }
         end
       end

data/lib/mongo/cursor/builder/op_kill_cursors.rb

@@ -48,11 +48,7 @@ module Mongo
         #
         # @since 2.2.0
         def specification
-          {
-            coll_name: collection_name,
-            db_name: database.name,
-            cursor_ids: [ BSON::Int64.new(cursor.id) ],
-          }
+          { :coll_name => collection_name, :db_name => database.name, :cursor_ids => [ cursor.id ] }
         end
 
         class << self
@@ -63,19 +59,11 @@ module Mongo
           #   OpKillCursors.update_cursors(spec, ids)
           #
           # @return [ Hash ] The specification.
-          # @return [ Array<Integer> ] The ids to update with.
+          # @return [ Array ] The ids to update with.
           #
           # @since 2.3.0
           def update_cursors(spec, ids)
-            # Ruby 2.5+ can & BSON::Int64 instances.
-            # Ruby 2.4 and earlier cannot.
-            # Convert stored ids to Ruby integers for compatibility with
-            # older Rubies.
-            ids = get_cursors_list(spec) & ids
-            ids = ids.map do |cursor_id|
-              BSON::Int64.new(cursor_id)
-            end
-            spec.merge!(cursor_ids: ids)
+            spec.merge!(cursor_ids: spec[:cursor_ids] & ids)
           end
 
           # Get the list of cursor ids from a spec generated by this Builder.
@@ -83,18 +71,11 @@ module Mongo
           # @example Get the list of cursor ids.
           #   OpKillCursors.cursors(spec)
           #
-          # @return [ Array<Integer> ] The cursor ids.
+          # @return [ Hash ] The specification.
           #
           # @since 2.3.0
           def get_cursors_list(spec)
-            spec[:cursor_ids].map do |value|
-              if value.respond_to?(:value)
-                # bson-ruby >= 4.6.0
-                value.value
-              else
-                value.instance_variable_get('@integer')
-              end
-            end
+            spec[:cursor_ids]
           end
         end
       end

data/lib/mongo/error.rb

@@ -155,6 +155,7 @@ require 'mongo/error/connection_check_out_timeout'
 require 'mongo/error/extra_file_chunk'
 require 'mongo/error/file_not_found'
 require 'mongo/error/operation_failure'
+require 'mongo/error/invalid_address'
 require 'mongo/error/invalid_bulk_operation'
 require 'mongo/error/invalid_bulk_operation_type'
 require 'mongo/error/invalid_collection_name'

data/lib/mongo/error/auth_error.rb

@@ -21,7 +21,7 @@ module Mongo
     # backwards compatibility reasons. It is subject to
     # change in future major versions of the driver.
     #
-    # @since 2.10.1
+    # @since 2.11.0
     class AuthError < RuntimeError
       include Notable
     end

data/lib/mongo/error/connection_check_out_timeout.rb

@@ -33,16 +33,15 @@ module Mongo
 
       # Instantiate the new exception.
       #
-      # @param [ Address ] address
-      # @param [ Float ] wait_timeout
+      # @option options [ Address ] :address
       #
-      # @since 2.9.0
       # @api private
-      def initialize(address, wait_timeout)
-        @address = address
-
-        super("Timed out when attempting to check out a connection from pool with address " +
-                "#{address} after #{wait_timeout} sec")
+      def initialize(msg, options)
+        super(msg)
+        @address = options[:address]
+        unless @address
+          raise ArgumentError, 'Address argument is required'
+        end
       end
     end
   end

data/lib/mongo/error/invalid_address.rb

@@ -0,0 +1,24 @@
+# Copyright (C) 2019 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
+#
+#   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.
+
+module Mongo
+  class Error
+
+    # Raised when validation of addresses in URIs and SRV records fails.
+    #
+    # @since 2.11.0
+    class InvalidAddress < Error
+    end
+  end
+end