mongo 2.4.3 → 2.5.0.beta

data/lib/mongo/cluster.rb

@@ -48,6 +48,11 @@ module Mongo
     # @since 2.4.0
     IDLE_WRITE_PERIOD_SECONDS = 10
 
+    # The cluster time key in responses from mongos servers.
+    #
+    # @since 2.5.0
+    CLUSTER_TIME = 'clusterTime'.freeze
+
     # @return [ Hash ] The options hash.
     attr_reader :options
 
@@ -63,6 +68,11 @@ module Mongo
     # @since 2.4.0
     attr_reader :app_metadata
 
+    # @return [ BSON::Document ] The latest cluster time seen.
+    #
+    # @since 2.5.0
+    attr_reader :cluster_time
+
     def_delegators :topology, :replica_set?, :replica_set_name, :sharded?,
                    :single?, :unknown?, :member_discovered
     def_delegators :@cursor_reaper, :register_cursor, :schedule_kill_cursor, :unregister_cursor
@@ -155,9 +165,11 @@ module Mongo
       @monitoring = monitoring
       @event_listeners = Event::Listeners.new
       @options = options.freeze
-      @app_metadata ||= AppMetadata.new(self)
+      @app_metadata = AppMetadata.new(self)
       @update_lock = Mutex.new
       @pool_lock = Mutex.new
+      @cluster_time = nil
+      @cluster_time_lock = Mutex.new
       @topology = Topology.initial(seeds, monitoring, options)
 
       publish_sdam_event(
@@ -442,6 +454,43 @@ module Mongo
       addresses_list
     end
 
+    # The logical session timeout value in minutes.
+    #
+    # @example Get the logical session timeout in minutes.
+    #   cluster.logical_session_timeout
+    #
+    # @return [ Integer, nil ] The logical session timeout.
+    #
+    # @since 2.5.0
+    def logical_session_timeout
+      servers.inject(nil) do |min, server|
+        break unless timeout = server.logical_session_timeout
+        [timeout, (min || timeout)].min
+      end
+    end
+
+    # Update the max cluster time seen in a response.
+    #
+    # @example Update the cluster time.
+    #   cluster.update_cluster_time(result)
+    #
+    # @param [ Operation::Result ] The operation result containing the cluster time.
+    #
+    # @return [ Object ] The cluster time.
+    #
+    # @since 2.5.0
+    def update_cluster_time(result)
+      if cluster_time_doc = result.cluster_time
+        @cluster_time_lock.synchronize do
+          if @cluster_time.nil?
+            @cluster_time = cluster_time_doc
+          else
+            @cluster_time = cluster_time_doc if cluster_time_doc[CLUSTER_TIME] > @cluster_time[CLUSTER_TIME]
+          end
+        end
+      end
+    end
+
     private
 
     def direct_connection?(address)
@@ -457,19 +506,11 @@ module Mongo
     end
 
     def servers_list
-      @update_lock.synchronize do
-        @servers.reduce([]) do |servers, server|
-          servers << server
-        end
-      end
+      @update_lock.synchronize { @servers.dup }
     end
 
     def addresses_list
-      @update_lock.synchronize do
-        @addresses.reduce([]) do |addresses, address|
-          addresses << address
-        end
-      end
+      @update_lock.synchronize { @addresses.dup }
     end
   end
 end

data/lib/mongo/cluster/app_metadata.rb

@@ -54,6 +54,7 @@ module Mongo
       def initialize(cluster)
         @app_name = cluster.options[:app_name]
         @platform = cluster.options[:platform]
+        @compressors = cluster.options[:compressors] || []
       end
 
       # Get the bytes of the ismaster message including this metadata.
@@ -89,6 +90,10 @@ module Mongo
       end
 
       def serialize
+        Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1).serialize
+      end
+
+      def document
         client_document = full_client_document
         while client_document.to_bson.to_s.size > MAX_DOCUMENT_SIZE do
           if client_document[:os][:name] || client_document[:os][:architecture]
@@ -101,8 +106,9 @@ module Mongo
           end
         end
         document = Server::Monitor::Connection::ISMASTER
-        document = document.merge(client: client_document) if client_document
-        Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1).serialize
+        document = document.merge(compression: @compressors)
+        document[:client] = client_document
+        document
       end
 
       def driver_doc

data/lib/mongo/cluster/cursor_reaper.rb

@@ -22,7 +22,6 @@ module Mongo
     #
     # @since 2.3.0
     class CursorReaper
-      extend Forwardable
       include Retryable
 
       # The default time interval for the cursor reaper to send pending kill cursors operations.

data/lib/mongo/cluster/topology.rb

@@ -51,7 +51,7 @@ module Mongo
         if options.has_key?(:connect)
           OPTIONS.fetch(options[:connect].to_sym).new(options, monitoring, seeds)
         elsif options.has_key?(:replica_set)
-          ReplicaSet.new(options, monitoring, options)
+          ReplicaSet.new(options, monitoring, seeds)
         else
           Unknown.new(options, monitoring, seeds)
         end

data/lib/mongo/collection.rb

@@ -100,16 +100,28 @@ module Mongo
       @read_concern ||= options[:read_concern]
     end
 
+    # Get the server selector on this collection.
+    #
+    # @example Get the server selector.
+    #   collection.server_selector
+    #
+    # @return [ Mongo::ServerSelector ] The server selector.
+    #
+    # @since 2.0.0
+    def server_selector
+     @server_selector ||= ServerSelector.get(read_preference || database.server_selector)
+    end
+
     # Get the read preference on this collection.
     #
     # @example Get the read preference.
     #   collection.read_preference
     #
-    # @return [ Mongo::ServerSelector ] The read preference.
+    # @return [ Hash ] The read preference.
     #
     # @since 2.0.0
     def read_preference
-      @read_preference ||= ServerSelector.get(options[:read] || database.read_preference)
+      @read_preference ||= options[:read] || database.read_preference
     end
 
     # Get the write concern on this collection.
@@ -162,21 +174,28 @@ module Mongo
     # @example Force the collection to be created.
     #   collection.create
     #
+    # @param [ Hash ] options The options for the create operation.
+    #
+    # @option options [ Session ] :session The session to use for the operation.
+    #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
-    def create
+    def create(opts = {})
       operation = { :create => name }.merge(options)
       operation.delete(:write)
       server = next_primary
       if (options[:collation] || options[Operation::COLLATION]) && !server.features.collation_enabled?
         raise Error::UnsupportedCollation.new
       end
-      Operation::Commands::Create.new({
-                                        selector: operation,
-                                        db_name: database.name,
-                                        write_concern: write_concern
-                                      }).execute(server)
+      client.send(:with_session, opts) do |session|
+        Operation::Commands::Create.new({
+                                          selector: operation,
+                                          db_name: database.name,
+                                          write_concern: write_concern,
+                                          session: session
+                                        }).execute(server)
+      end
     end
 
     # Drop the collection. Will also drop all indexes associated with the
@@ -187,16 +206,22 @@ module Mongo
     # @example Drop the collection.
     #   collection.drop
     #
+    # @param [ Hash ] options The options for the drop operation.
+    #
+    # @option options [ Session ] :session The session to use for the operation.
+    #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
-    def drop
-      Operation::Commands::Drop.new({
-                                      selector: { :drop => name },
-                                      db_name: database.name,
-                                      write_concern: write_concern
-                                    }).execute(next_primary)
-
+    def drop(opts = {})
+      client.send(:with_session, opts) do |session|
+        Operation::Commands::Drop.new({
+                                        selector: { :drop => name },
+                                        db_name: database.name,
+                                        write_concern: write_concern,
+                                        session: session
+                                      }).execute(next_primary)
+      end
     rescue Error::OperationFailure => ex
       raise ex unless ex.message =~ /ns not found/
       false
@@ -235,6 +260,7 @@ module Mongo
     # @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.
     #
@@ -261,6 +287,7 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Aggregation ] The aggregation object.
     #
@@ -269,6 +296,39 @@ module Mongo
       View.new(self, {}).aggregate(pipeline, options)
     end
 
+    # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline stage is supported
+    # in the aggregation framework. This stage allows users to request that notifications are sent for
+    # all changes to a particular collection.
+    #
+    # @example Get change notifications for a given collection.
+    #   collection.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.
+    #
+    # @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.5.0
+    def watch(pipeline = [], options = {})
+      View::ChangeStream.new(View.new(self, {}, options), pipeline, options)
+    end
+
     # Get a count of matching documents in the collection.
     #
     # @example Get the count.
@@ -283,6 +343,7 @@ module Mongo
     # @option options [ Integer ] :skip The number of documents to skip before counting.
     # @option options [ Hash ] :read The read preference options.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Integer ] The document count.
     #
@@ -303,6 +364,7 @@ module Mongo
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command to run.
     # @option options [ Hash ] :read The read preference options.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Array<Object> ] The list of distinct values.
     #
@@ -319,6 +381,8 @@ module Mongo
     #
     # @param [ Hash ] options Options for getting a list of all indexes.
     #
+    # @option options [ Session ] :session The session to use.
+    #
     # @return [ View::Index ] The index view.
     #
     # @since 2.0.0
@@ -346,20 +410,25 @@ module Mongo
     # @param [ Hash ] document The document to insert.
     # @param [ Hash ] options The insert options.
     #
+    # @option options [ Session ] :session The session to use for the operation.
+    #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
     def insert_one(document, options = {})
-      write_with_retry do
-        Operation::Write::Insert.new(
-          :documents => [ document ],
-          :db_name => database.name,
-          :coll_name => name,
-          :write_concern => write_concern,
-          :bypass_document_validation => !!options[:bypass_document_validation],
-          :options => options,
-          :id_generator => client.options[:id_generator]
-        ).execute(next_primary)
+      client.send(:with_session, options) do |session|
+        write_with_retry(session, Proc.new { next_primary }) do |server|
+          Operation::Write::Insert.new(
+              :documents => [ document ],
+              :db_name => database.name,
+              :coll_name => name,
+              :write_concern => write_concern,
+              :bypass_document_validation => !!options[:bypass_document_validation],
+              :options => options,
+              :id_generator => client.options[:id_generator],
+              :session => session
+          ).execute(server)
+        end
       end
     end
 
@@ -371,6 +440,8 @@ module Mongo
     # @param [ Array<Hash> ] documents The documents to insert.
     # @param [ Hash ] options The insert options.
     #
+    # @option options [ Session ] :session The session to use for the operation.
+    #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
@@ -393,6 +464,7 @@ module Mongo
     #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
+    # @option options [ Session ] :session The session to use for the set of operations.
     #
     # @return [ BulkWrite::Result ] The result of the operation.
     #
@@ -410,6 +482,7 @@ module Mongo
     # @param [ Hash ] options The options.
     #
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -427,6 +500,7 @@ module Mongo
     # @param [ Hash ] options The options.
     #
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -449,12 +523,13 @@ module Mongo
     #
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
     #   to run in milliseconds.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Array<Cursor> ] An array of cursors.
     #
     # @since 2.1
     def parallel_scan(cursor_count, options = {})
-      find.send(:parallel_scan, cursor_count, options)
+      find({}, options).send(:parallel_scan, cursor_count, options)
     end
 
     # Replaces a single document in the collection with the new document.
@@ -471,6 +546,7 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -493,6 +569,9 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Array ] :array_filters A set of filters specifying to which array elements
+    #   an update should apply.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -515,6 +594,9 @@ module Mongo
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Array ] :array_filters A set of filters specifying to which array elements
+    #   an update should apply.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -540,12 +622,13 @@ module Mongo
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
     # @since 2.1.0
     def find_one_and_delete(filter, options = {})
-      find(filter, options).find_one_and_delete
+      find(filter, options).find_one_and_delete(options)
     end
 
     # Finds a single document via findAndModify and updates it, returning the original doc unless
@@ -573,6 +656,9 @@ module Mongo
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Array ] :array_filters A set of filters specifying to which array elements
+    #   an update should apply.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ BSON::Document ] The document.
     #
@@ -606,6 +692,7 @@ module Mongo
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
+    # @option options [ Session ] :session The session to use.
     #
     # @return [ BSON::Document ] The document.
     #