mongo 2.13.0 → 2.15.0.alpha

data/lib/mongo/cluster.rb

@@ -107,6 +107,11 @@ module Mongo
     #   for the server monitor to refresh its description via ismaster.
     # @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 +134,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,9 +206,6 @@ module Mongo
           @cursor_reaper, @socket_reaper,
         ], options)
 
-        ObjectSpace.define_finalizer(self, self.class.finalize(
-          {}, @periodic_executor, @session_pool))
-
         @periodic_executor.run!
       end
 
@@ -244,7 +248,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 +296,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 +459,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
@@ -950,13 +945,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/reapers/cursor_reaper.rb

@@ -130,16 +130,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/sdam_flow.rb

@@ -178,6 +178,7 @@ class Mongo::Cluster
         raise ArgumentError, "Unknown topology #{topology.class}"
       end
 
+      verify_invariants
       commit_changes
       disconnect_servers
     end
@@ -363,6 +364,9 @@ class Mongo::Cluster
           end
         end
       end
+
+      verify_invariants
+
       added_servers
     end
 
@@ -599,5 +603,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/single.rb

@@ -133,7 +133,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/collection.rb

@@ -223,6 +223,7 @@ module Mongo
     # @param [ Hash ] opts The options for the create 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.
     #
@@ -239,6 +240,11 @@ module Mongo
       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 +254,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,22 +270,33 @@ 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
-      raise ex unless ex.message =~ /ns not found/
-      false
+      # NamespaceNotFound
+      if ex.code == 26 || ex.code.nil? && ex.message =~ /ns not found/
+        false
+      else
+        raise
+      end
     end
 
     # Find documents in the collection.
@@ -400,7 +417,7 @@ module Mongo
       View::ChangeStream.new(View.new(self, {}, options), pipeline, nil, options)
     end
 
-    # Gets the number of matching documents in the collection.
+    # Gets an estimated number of matching documents in the collection.
     #
     # @example Get the count.
     #   collection.count(name: 1)
@@ -429,11 +446,13 @@ module Mongo
       View.new(self, filter || {}, options).count(options)
     end
 
-    # Gets the number of matching documents in the collection. Unlike the deprecated #count
-    # method, this will return the exact number of documents matching the filter rather than the estimate.
+    # Gets the number of documents matching the query. Unlike the deprecated
+    # #count method, this will return the exact number of documents matching
+    # the filter (or exact number of documents in the collection, if no filter
+    # is provided) rather than an estimate.
     #
-    # @example Get the number of documents in the collection.
-    #   collection_view.count_documents
+    # Use #estimated_document_count to retrieve an estimate of the number
+    # of documents in the collection using the collection metadata.
     #
     # @param [ Hash ] filter A filter for matching documents.
     # @param [ Hash ] options Options for the operation.
@@ -454,15 +473,16 @@ module Mongo
       View.new(self, filter, options).count_documents(options)
     end
 
-    # Gets an estimate of the count of documents in a collection using collection metadata.
+    # Gets an estimate of the number of documents in the collection using the
+    # collection metadata.
     #
-    # @example Get the number of documents in the collection.
-    #   collection_view.estimated_document_count
+    # Use #count_documents to retrieve the exact number of documents in the
+    # collection, or to count documents matching a filter.
     #
     # @param [ Hash ] options Options for the operation.
     #
-    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the command to
-    #   run.
+    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow
+    #   the command to run for on the server.
     # @option opts [ Hash ] :read The read preference options.
     #
     # @return [ Integer ] The document count.
@@ -536,12 +556,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 ],
@@ -552,8 +579,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
@@ -566,12 +593,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
@@ -854,5 +885,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

data/lib/mongo/collection/view.rb

@@ -120,27 +120,31 @@ module Mongo
       #   server can write temporary data to disk while executing the find
       #   operation. This option is only available on MongoDB server versions
       #   4.4 and newer.
-      # @option options :comment [ String ] Associate a comment with the query.
-      # @option options :batch_size [ Integer ] The number of docs to return in
-      #   each response from MongoDB.
-      # @option options :projection [ Hash ] The fields to include or exclude in
-      #   returned docs.
-      # @option options :hint [ Hash ] Override default index selection and force
-      #   MongoDB to use a specific index for the query.
-      # @option options :limit [ Integer ] Max number of docs to return.
-      # @option options :max_scan [ Integer ] Constrain the query to only scan the
-      #   specified number of docs. Use to prevent queries from running too long.
-      #   Deprecated as of MongoDB server version 4.0.
-      # @option options :read [ Symbol ] The read preference to use for the query.
-      #   If none is provided, the collection's default read preference is used.
-      # @option options :show_disk_loc [ true, false ] Return disk location info as
-      #   a field in each doc.
-      # @option options :skip [ Integer ] The number of documents to skip.
-      # @option options :snapshot [ true, false ] Prevents returning a doc more than
-      #   once. Deprecated as of MongoDB server version 4.0.
-      # @option options :sort [ Hash ] The key and direction pairs used to sort the
-      #   results.
+      # @option options [ Integer ] :batch_size The number of documents to
+      #   return in each response from MongoDB.
       # @option options [ Hash ] :collation The collation to use.
+      # @option options [ String ] :comment Associate a comment with the query.
+      # @option options [ Hash ] :explain Execute an explain with the provided
+      #   explain options (known options are :verbose and :verbosity) rather
+      #   than a find.
+      # @option options [ Hash ] :hint Override the default index selection and
+      #   force MongoDB to use a specific index for the query.
+      # @option options [ Integer ] :limit Max number of documents to return.
+      # @option options [ Integer ] :max_scan Constrain the query to only scan
+      #   the specified number of documents. Use to prevent queries from
+      #   running for too long. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :projection The fields to include or exclude
+      #   in the returned documents.
+      # @option options [ Hash ] :read The read preference to use for the
+      #   query. If none is provided, the collection's default read preference
+      #   is used.
+      # @option options [ true | false ] :show_disk_loc Return disk location
+      #   info as a field in each doc.
+      # @option options [ Integer ] :skip The number of documents to skip.
+      # @option options [ true | false ] :snapshot Prevents returning a
+      #   document more than once. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :sort The key and direction pairs used to sort
+      #   the results.
       #
       # @since 2.0.0
       def initialize(collection, filter = {}, options = {})

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

@@ -89,6 +89,16 @@ module Mongo
           self.class.new(view, pipeline, options.merge(explain: true)).first
         end
 
+        # Whether this aggregation will write its result to a database collection.
+        #
+        # @return [ Boolean ] Whether the aggregation will write its result
+        #   to a collection.
+        #
+        # @api private
+        def write?
+          pipeline.any? { |op| op.key?('$out') || op.key?(:$out) || op.key?('$merge') || op.key?(:$merge) }
+        end
+
         private
 
         def server_selector
@@ -114,10 +124,6 @@ module Mongo
           description.standalone? || description.mongos? || description.primary? || secondary_ok?
         end
 
-        def write?
-          pipeline.any? { |op| op.key?('$out') || op.key?(:$out) || op.key?('$merge') || op.key?(:$merge) }
-        end
-
         def secondary_ok?
           !write?
         end
@@ -128,7 +134,7 @@ module Mongo
             server = cluster.next_primary(nil, session)
           end
           validate_collation!(server)
-          initial_query_op(session).execute(server, client: client)
+          initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
         end
 
         def validate_collation!(server)
@@ -136,6 +142,21 @@ module Mongo
             raise Error::UnsupportedCollation.new
           end
         end
+
+        # Skip, sort, limit, projection are specified as pipeline stages
+        # rather than as options.
+        def cache_options
+          {
+            namespace: collection.namespace,
+            selector: pipeline,
+            read_concern: view.read_concern,
+            read_preference: view.read_preference,
+            collation: options[:collation],
+            # Aggregations can read documents from more than one collection,
+            # so they will be cleared on every write operation.
+            multi_collection: true,
+          }
+        end
       end
     end
   end