mongo 2.13.2 → 2.15.0

data/lib/mongo/client_encryption.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -104,9 +107,14 @@ module Mongo
     #   to not start the periodic executor. If :monitoring_io is false,
     #   :cleanup automatically defaults to false as well.
     # @option options [ Float ] :heartbeat_frequency The interval, in seconds,
-    #   for the server monitor to refresh its description via ismaster.
+    #   for the server monitor to refresh its description via hello.
     # @option options [ Hash ] :resolv_options For internal driver use only.
     #   Options to pass through to Resolv::DNS constructor for SRV lookups.
+    # @option options [ Hash ] :server_api The requested server API version.
+    #   This hash can have the following items:
+    #   - *:version* -- string
+    #   - *:strict* -- boolean
+    #   - *:deprecation_errors* -- boolean
     #
     # @since 2.0.0
     def initialize(seeds, monitoring, options = Options::Redacted.new)
@@ -129,7 +137,9 @@ module Mongo
       @servers = []
       @monitoring = monitoring
       @event_listeners = Event::Listeners.new
-      @app_metadata = Server::AppMetadata.new(@options)
+      @app_metadata = Server::AppMetadata.new(@options.merge(purpose: :application))
+      @monitor_app_metadata = Server::Monitor::AppMetadata.new(@options.merge(purpose: :monitor))
+      @push_monitor_app_metadata = Server::Monitor::AppMetadata.new(@options.merge(purpose: :push_monitor))
       @cluster_time_lock = Mutex.new
       @cluster_time = nil
       @srv_monitor_lock = Mutex.new
@@ -199,14 +209,11 @@ module Mongo
           @cursor_reaper, @socket_reaper,
         ], options)
 
-        ObjectSpace.define_finalizer(self, self.class.finalize(
-          {}, @periodic_executor, @session_pool))
-
         @periodic_executor.run!
       end
 
       # Need to record start time prior to starting monitoring
-      start_time = Time.now
+      start_monotime = Utils.monotonic_time
 
       servers.each do |server|
         server.start_monitoring
@@ -222,7 +229,7 @@ module Mongo
         if server_selection_timeout < 3
           server_selection_timeout = 3
         end
-        deadline = start_time + server_selection_timeout
+        deadline = start_monotime + server_selection_timeout
         # Wait for the first scan of each server to complete, for
         # backwards compatibility.
         # If any servers are discovered during this SDAM round we are going to
@@ -233,10 +240,10 @@ module Mongo
           servers = @sdam_flow_lock.synchronize do
             servers_list.dup
           end
-          if servers.all? { |server| server.last_scan && server.last_scan >= start_time }
+          if servers.all? { |server| server.last_scan_monotime && server.last_scan_monotime >= start_monotime }
             break
           end
-          if (time_remaining = deadline - Time.now) <= 0
+          if (time_remaining = deadline - Utils.monotonic_time) <= 0
             break
           end
           log_debug("Waiting for up to #{'%.2f' % time_remaining} seconds for servers to be scanned: #{summary}")
@@ -244,7 +251,11 @@ module Mongo
           # the servers list above and the wait call below, we should not
           # wait for the full remaining time - wait for up to 1 second, then
           # recheck the state.
-          server_selection_semaphore.wait([time_remaining, 1].min)
+          begin
+            server_selection_semaphore.wait([time_remaining, 1].min)
+          rescue ::Timeout::Error
+            # nothing
+          end
         end
       end
 
@@ -288,6 +299,12 @@ module Mongo
     # @since 2.4.0
     attr_reader :app_metadata
 
+    # @api private
+    attr_reader :monitor_app_metadata
+
+    # @api private
+    attr_reader :push_monitor_app_metadata
+
     # @return [ Array<String> ] The addresses of seed servers. Contains
     #   addresses that were given to Cluster when it was instantiated, not
     #   current addresses that the cluster is using as a result of SDAM.
@@ -445,25 +462,6 @@ module Mongo
     # @api private
     attr_reader :server_selection_semaphore
 
-    # Finalize the cluster for garbage collection.
-    #
-    # @example Finalize the cluster.
-    #   Cluster.finalize(pools)
-    #
-    # @param [ Hash<Address, Server::ConnectionPool> ] pools Ignored.
-    # @param [ PeriodicExecutor ] periodic_executor The periodic executor.
-    # @param [ SessionPool ] session_pool The session pool.
-    #
-    # @return [ Proc ] The Finalizer.
-    #
-    # @since 2.2.0
-    def self.finalize(pools, periodic_executor, session_pool)
-      proc do
-        session_pool.end_sessions
-        periodic_executor.stop!
-      end
-    end
-
     # Closes the cluster.
     #
     # @note Applications should call Client#close to disconnect from
@@ -600,7 +598,7 @@ module Mongo
     #   existing connection pool (required when handling not master errors
     #   on 4.2+ servers).
     # @option aptions [ true | false ] :awaited Whether the updated description
-    #   was a result of processing an awaited ismaster.
+    #   was a result of processing an awaited hello.
     #
     # @api private
     def run_sdam_flow(previous_desc, updated_desc, options = {})
@@ -767,7 +765,7 @@ module Mongo
     end
 
     # Add a server to the cluster with the provided address. Useful in
-    # auto-discovery of new servers when an existing server executes an ismaster
+    # auto-discovery of new servers when an existing server executes a hello
     # and potentially non-configured servers were included.
     #
     # @example Add the server for the address to the cluster.
@@ -950,13 +948,9 @@ module Mongo
         # Start SRV monitor
         @srv_monitor_lock.synchronize do
           unless @srv_monitor
-            monitor_options = options.merge(
-              timeout: options[:connect_timeout] || Server::CONNECT_TIMEOUT)
-            @srv_monitor = _srv_monitor = Srv::Monitor.new(self, monitor_options)
-            finalizer = lambda do
-              _srv_monitor.stop!
-            end
-            ObjectSpace.define_finalizer(self, finalizer)
+            monitor_options = Utils.shallow_symbolize_keys(options.merge(
+              timeout: options[:connect_timeout] || Server::CONNECT_TIMEOUT))
+            @srv_monitor = _srv_monitor = Srv::Monitor.new(self, **monitor_options)
           end
           @srv_monitor.run!
         end

data/lib/mongo/cluster/periodic_executor.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -130,16 +133,20 @@ module Mongo
         end
 
         to_kill_copy.each do |server, op_specs|
+          options = {
+            server_api: server.options[:server_api],
+          }
+          context = Operation::Context.new(options: options)
           op_specs.each do |op_spec|
             if server.features.find_command_enabled?
               Cursor::Builder::KillCursorsCommand.update_cursors(op_spec, active_cursors_copy.to_a)
               if Cursor::Builder::KillCursorsCommand.get_cursors_list(op_spec).size > 0
-                Operation::KillCursors.new(op_spec).execute(server, client: nil)
+                Operation::KillCursors.new(op_spec).execute(server, context: context)
               end
             else
               Cursor::Builder::OpKillCursors.update_cursors(op_spec, active_cursors_copy.to_a)
               if Cursor::Builder::OpKillCursors.get_cursors_list(op_spec).size > 0
-                Operation::KillCursors.new(op_spec).execute(server, client: nil)
+                Operation::KillCursors.new(op_spec).execute(server, context: context)
               end
             end
           end

data/lib/mongo/cluster/reapers/socket_reaper.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/sdam_flow.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -178,6 +181,7 @@ class Mongo::Cluster
         raise ArgumentError, "Unknown topology #{topology.class}"
       end
 
+      verify_invariants
       commit_changes
       disconnect_servers
     end
@@ -363,6 +367,9 @@ class Mongo::Cluster
           end
         end
       end
+
+      verify_invariants
+
       added_servers
     end
 
@@ -599,5 +606,15 @@ class Mongo::Cluster
 
       @previous_server_descriptions != server_descriptions
     end
+
+    def verify_invariants
+      if Mongo::Lint.enabled?
+        if cluster.topology.single?
+          if cluster.servers_list.length > 1
+            raise Mongo::Error::LintError, "Trying to create a single topology with multiple servers: #{cluster.servers_list}"
+          end
+        end
+      end
+    end
   end
 end

data/lib/mongo/cluster/topology.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/topology/base.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/topology/no_replica_set_options.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/topology/replica_set_no_primary.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/topology/replica_set_with_primary.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/topology/sharded.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster/topology/single.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -133,7 +136,7 @@ module Mongo
 
         def validate_options(options, cluster)
           if cluster.servers_list.length > 1
-            raise ArgumentError, 'Cannot instantiate a single topology with more than one server in the cluster'
+            raise ArgumentError, "Cannot instantiate a single topology with more than one server in the cluster: #{cluster.servers_list.map(&:address).map(&:seed).join(', ')}"
           end
 
           super(options, cluster)

data/lib/mongo/cluster/topology/unknown.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/cluster_time.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/collection.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -55,6 +58,12 @@ module Mongo
     # @since 2.1.0
     CHANGEABLE_OPTIONS = [ :read, :read_concern, :write, :write_concern ].freeze
 
+    # Options that can be used for creating a time-series collection.
+    TIME_SERIES_OPTIONS = {
+      :time_series => :timeseries,
+      :expire_after => :expireAfterSeconds
+    }
+
     # Check if a collection is equal to another object. Will check the name and
     # the database for equality.
     #
@@ -84,6 +93,11 @@ module Mongo
     #   option.
     # @option options [ Hash ] :write_concern The write concern options.
     #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+    # @option options [ Hash ] :time_series Create a time-series collection.
+    #   See https://docs.mongodb.com/manual/core/timeseries-collections/ for more
+    #   information about time-series collection.
+    # @option options [ Integer ] :expire_after Number indicating
+    #   after how many seconds old time-series data should be deleted.
     #
     # @since 2.0.0
     def initialize(database, name, options = {})
@@ -222,7 +236,11 @@ module Mongo
     #
     # @param [ Hash ] opts The options for the create operation.
     #
-    # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
+    # @option opts [ Hash ] :time_series Create a time-series collection.
+    # @option opts [ Integer ] :expire_after Number indicating
+    #   after how many seconds old time-series data should be deleted.
     #
     # @return [ Result ] The result of the command.
     #
@@ -235,10 +253,22 @@ module Mongo
       options = Hash[self.options.reject do |key, value|
         %w(read read_preference).include?(key.to_s)
       end]
+      options.update(Utils.slice_hash(opts, *TIME_SERIES_OPTIONS.keys))
+      # Converting Ruby spelled time series options to server style.
+      TIME_SERIES_OPTIONS.each do |ruby_key, server_key|
+        if options.key?(ruby_key)
+          options[server_key] = options.delete(ruby_key)
+        end
+      end
       operation = { :create => name }.merge(options)
       operation.delete(:write)
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          self.write_concern
+        end
         server = next_primary(nil, session)
         if (options[:collation] || options[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation
@@ -248,8 +278,8 @@ module Mongo
                                 selector: operation,
                                 db_name: database.name,
                                 write_concern: write_concern,
-                                session: session
-                                }).execute(server, client: client)
+                                session: session,
+                                }).execute(server, context: Operation::Context.new(client: client, session: session))
       end
     end
 
@@ -264,18 +294,25 @@ module Mongo
     # @param [ Hash ] opts The options for the drop operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
     def drop(opts = {})
       client.send(:with_session, opts) do |session|
+        temp_write_concern = write_concern
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          temp_write_concern
+        end
         Operation::Drop.new({
                               selector: { :drop => name },
                               db_name: database.name,
                               write_concern: write_concern,
-                              session: session
-                              }).execute(next_primary(nil, session), client: client)
+                              session: session,
+                              }).execute(next_primary(nil, session), context: Operation::Context.new(client: client, session: session))
       end
     rescue Error::OperationFailure => ex
       # NamespaceNotFound
@@ -305,11 +342,12 @@ module Mongo
     #   results if some shards are down.
     # @option options [ Integer ] :batch_size The number of documents returned in each batch
     #   of results from MongoDB.
+    # @option options [ Hash ] :collation The collation to use.
     # @option options [ String ] :comment Associate a comment with the query.
     # @option options [ :tailable, :tailable_await ] :cursor_type The type of cursor to use.
     # @option options [ Integer ] :limit The max number of docs to return from the query.
-    # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the query
-    #   to run in milliseconds.
+    # @option options [ Integer ] :max_time_ms
+    #   The maximum amount of time to allow the query to run, in milliseconds.
     # @option options [ Hash ] :modifiers A document containing meta-operators modifying the
     #   output or behavior of a query.
     # @option options [ true, false ] :no_cursor_timeout The server normally times out idle
@@ -319,11 +357,10 @@ module Mongo
     #   should not set.
     # @option options [ Hash ] :projection The fields to include or exclude from each doc
     #   in the result set.
+    # @option options [ Session ] :session The session to use.
     # @option options [ Integer ] :skip The number of docs to skip before returning results.
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
-    # @option options [ Hash ] :collation The collation to use.
-    # @option options [ Session ] :session The session to use.
     #
     # @return [ CollectionView ] The collection view.
     #
@@ -444,14 +481,14 @@ module Mongo
     # @param [ Hash ] filter A filter for matching documents.
     # @param [ Hash ] options Options for the operation.
     #
-    # @option opts :skip [ Integer ] The number of documents to skip.
-    # @option opts :hint [ Hash ] Override default index selection and force
+    # @option options :skip [ Integer ] The number of documents to skip.
+    # @option options :hint [ Hash ] Override default index selection and force
     #   MongoDB to use a specific index for the query. Requires server version 3.6+.
-    # @option opts :limit [ Integer ] Max number of docs to count.
-    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the
+    # @option options :limit [ Integer ] Max number of docs to count.
+    # @option options :max_time_ms [ Integer ] The maximum amount of time to allow the
     #   command to run.
-    # @option opts [ Hash ] :read The read preference options.
-    # @option opts [ Hash ] :collation The collation to use.
+    # @option options :read [ Hash ] The read preference options.
+    # @option options :collation [ Hash ] The collation to use.
     #
     # @return [ Integer ] The document count.
     #
@@ -543,12 +580,19 @@ module Mongo
     #
     # @since 2.0.0
     def insert_one(document, opts = {})
+      QueryCache.clear_namespace(namespace)
+
       client.send(:with_session, opts) do |session|
         write_concern = if opts[:write_concern]
           WriteConcern.get(opts[:write_concern])
         else
           write_concern_with_session(session)
         end
+
+        if document.nil?
+          raise ArgumentError, "Document to be inserted cannot be nil"
+        end
+
         write_with_retry(session, write_concern) do |server, txn_num|
           Operation::Insert.new(
             :documents => [ document ],
@@ -559,8 +603,8 @@ module Mongo
             :options => opts,
             :id_generator => client.options[:id_generator],
             :session => session,
-            :txn_num => txn_num
-          ).execute(server, client: client)
+            :txn_num => txn_num,
+          ).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
     end
@@ -573,12 +617,16 @@ module Mongo
     # @param [ Array<Hash> ] documents The documents to insert.
     # @param [ Hash ] options The insert options.
     #
+    # @option options [ true | false ] :ordered Whether the operations
+    #   should be executed in order.
     # @option options [ Session ] :session The session to use for the operation.
     #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
     def insert_many(documents, options = {})
+      QueryCache.clear_namespace(namespace)
+
       inserts = documents.map{ |doc| { :insert_one => doc }}
       bulk_write(inserts, options)
     end
@@ -861,5 +909,14 @@ module Mongo
     def namespace
       "#{database.name}.#{name}"
     end
+
+    # Whether the collection is a system collection.
+    #
+    # @return [ Boolean ] Whether the system is a system collection.
+    #
+    # @api private
+    def system_collection?
+      name.start_with?('system.')
+    end
   end
 end