mongo 2.5.0.beta → 2.5.0

data/lib/mongo/cluster/{cursor_reaper.rb → reapers/cursor_reaper.rb}

@@ -15,11 +15,14 @@
 require 'set'
 
 module Mongo
+
   class Cluster
 
     # A manager that sends kill cursors operations at regular intervals to close
     # cursors that have been garbage collected without being exhausted.
     #
+    # @api private
+    #
     # @since 2.3.0
     class CursorReaper
       include Retryable
@@ -41,22 +44,8 @@ module Mongo
         @to_kill = {}
         @active_cursors = Set.new
         @mutex = Mutex.new
-        @thread = nil
       end
 
-      # Start the cursor reaper's thread.
-      #
-      # @example Start the cursor reaper's thread.
-      #   reaper.run!
-      #
-      # @api private
-      #
-      # @since 2.3.0
-      def run!
-        @thread && @thread.alive? ? @thread : start!
-      end
-      alias :restart! :run!
-
       # Schedule a kill cursors operation to be eventually executed.
       #
       # @example Schedule a kill cursors operation.
@@ -112,18 +101,6 @@ module Mongo
         end
       end
 
-      # Stop the cursor reaper's thread.
-      #
-      # @example Stop the cursor reaper's thread.
-      #   reaper.stop!
-      #
-      # @api private
-      #
-      # @since 2.3.0
-      def stop!
-        @thread.kill && @thread.stop?
-      end
-
       # Execute all pending kill cursors operations.
       #
       # @example Execute pending kill cursors operations.
@@ -158,17 +135,8 @@ module Mongo
           end
         end
       end
-
-      private
-
-      def start!
-        @thread = Thread.new(FREQUENCY) do |i|
-          loop do
-            sleep(i)
-            kill_cursors
-          end
-        end
-      end
+      alias :execute :kill_cursors
+      alias :flush :kill_cursors
     end
   end
 end

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

@@ -0,0 +1,59 @@
+# Copyright (C) 2014-2017 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
+
+    # A manager that calls a method on each of a cluster's pools to close stale
+    #  sockets.
+    #
+    # @api private
+    #
+    # @since 2.5.0
+    class SocketReaper
+
+      # Initialize the SocketReaper object.
+      #
+      # @example Initialize the socket reaper.
+      #   SocketReaper.new(cluster)
+      #
+      # @params [ Mongo::Cluster ] cluster The cluster whose pools' stale sockets
+      #  need to be reaped at regular intervals.
+      #
+      # @since 2.5.0
+      def initialize(cluster)
+        @cluster = cluster
+      end
+
+      # Execute the operation to close the pool's stale sockets.
+      #
+      # @example Close the stale sockets in each of the cluster's pools.
+      #   socket_reaper.execute
+      #
+      # @since 2.5.0
+      def execute
+        @cluster.servers.each do |server|
+          server.pool.close_stale_sockets!
+        end and true
+      end
+
+      # When the socket reaper is garbage-collected, there's no need to close stale sockets;
+      #   sockets will be closed anyway when the pools are garbage-collected.
+      #
+      # @since 2.5.0
+      def flush; end
+    end
+  end
+end

data/lib/mongo/collection.rb

@@ -174,7 +174,7 @@ module Mongo
     # @example Force the collection to be created.
     #   collection.create
     #
-    # @param [ Hash ] options The options for the create operation.
+    # @param [ Hash ] opts The options for the create operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
     #
@@ -206,7 +206,7 @@ module Mongo
     # @example Drop the collection.
     #   collection.drop
     #
-    # @param [ Hash ] options The options for the drop operation.
+    # @param [ Hash ] opts The options for the drop operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
     #
@@ -283,10 +283,12 @@ module Mongo
     # @option options [ Integer ] :max_time_ms The maximum amount of time in milliseconds to allow the
     #   aggregation to run.
     # @option options [ true, false ] :use_cursor Indicates whether the command will request that the server
-    #   provide results using a cursor.
+    #   provide results using a cursor. Note that as of server version 3.6, aggregations always provide results
+    #   using a cursor and this option is therefore not valid.
     # @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 [ String ] :comment Associate a comment with the aggregation.
     # @option options [ Session ] :session The session to use.
     #
     # @return [ Aggregation ] The aggregation object.
@@ -417,7 +419,7 @@ module Mongo
     # @since 2.0.0
     def insert_one(document, options = {})
       client.send(:with_session, options) do |session|
-        write_with_retry(session, Proc.new { next_primary }) do |server|
+        write_with_retry(session, write_concern) do |server, txn_num|
           Operation::Write::Insert.new(
               :documents => [ document ],
               :db_name => database.name,
@@ -426,8 +428,9 @@ module Mongo
               :bypass_document_validation => !!options[:bypass_document_validation],
               :options => options,
               :id_generator => client.options[:id_generator],
-              :session => session
-          ).execute(server)
+              :session => session,
+              :txn_num => txn_num
+           ).execute(server)
         end
       end
     end

data/lib/mongo/collection/view.rb

@@ -199,8 +199,8 @@ module Mongo
 
       def view; self; end
 
-      def with_session
-        client.send(:with_session, @options) do |session|
+      def with_session(opts = {})
+        client.send(:with_session, @options.merge(opts)) do |session|
           yield(session)
         end
       end

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

@@ -35,7 +35,8 @@ module Mongo
             :explain => 'explain',
             :bypass_document_validation => 'bypassDocumentValidation',
             :collation => 'collation',
-            :hint => 'hint'
+            :hint => 'hint',
+            :comment => 'comment'
           ).freeze
 
           def_delegators :@view, :collection, :database, :read, :write_concern

data/lib/mongo/collection/view/builder/find_command.rb

@@ -63,7 +63,7 @@ module Mongo
           #
           # @since 2.2.0
           def explain_specification
-            { selector: { explain: find_command }, db_name: database.name, read: read }
+            { selector: { explain: find_command }, db_name: database.name, read: read, session: @session }
           end
 
           # Create the find command builder.

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

@@ -51,7 +51,7 @@ module Mongo
         #
         # @param [ Collection::View ] view The collection view.
         # @param [ Array<Hash> ] pipeline The pipeline of operators to filter the change notifications.
-        # @param [ Hash ] opts The change stream options.
+        # @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
@@ -130,6 +130,19 @@ module Mongo
           @cursor.nil?
         end
 
+        # Get a formatted string for use in inspection.
+        #
+        # @example Inspect the change stream object.
+        #   stream.inspect
+        #
+        # @return [ String ] The change stream inspection.
+        #
+        # @since 2.5.0
+        def inspect
+          "#<Mongo::Collection::View:ChangeStream:0x#{object_id} filters=#{@change_stream_filters} " +
+            "options=#{@options} resume_token=#{@resume_token}>"
+        end
+
         private
 
         def cache_resume_token(doc)

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

@@ -41,10 +41,10 @@ module Mongo
         attr_reader :view
 
         # @return [ String ] map The map function.
-        attr_reader :map
+        attr_reader :map_function
 
         # @return [ String ] reduce The reduce function.
-        attr_reader :reduce
+        attr_reader :reduce_function
 
         # Delegate necessary operations to the view.
         def_delegators :view, :collection, :read, :cluster
@@ -66,9 +66,10 @@ module Mongo
         # @yieldparam [ Hash ] Each matching document.
         def each
           @cursor = nil
-          session = client.send(:get_session, view.options)
-          write_with_retry(session, Proc.new { server_selector.select_server(cluster, false) }) do |server|
+          session = client.send(:get_session, @options)
+          legacy_write_with_retry do |server|
             result = send_initial_query(server, session)
+            result = send_fetch_query(server, session) unless inline?
             @cursor = Cursor.new(view, result, server, session: session)
           end
           @cursor.each do |doc|
@@ -105,8 +106,8 @@ module Mongo
         # @since 2.0.0
         def initialize(view, map, reduce, options = {})
           @view = view
-          @map = map.freeze
-          @reduce = reduce.freeze
+          @map_function = map.freeze
+          @reduce_function = reduce.freeze
           @options = BSON::Document.new(options).freeze
         end
 
@@ -180,6 +181,23 @@ module Mongo
           configure(:verbose, value)
         end
 
+        # Execute the map reduce, without doing a fetch query to retrieve the results
+        #   if outputted to a collection.
+        #
+        # @example Execute the map reduce and get the raw result.
+        #   map_reduce.execute
+        #
+        # @return [ Mongo::Operation::Result ] The raw map reduce result
+        #
+        # @since 2.5.0
+        def execute
+          view.send(:with_session, @options) do |session|
+            legacy_write_with_retry do |server|
+              send_initial_query(server, session)
+            end
+          end
+        end
+
         private
 
         def server_selector
@@ -190,12 +208,12 @@ module Mongo
           out.nil? || out == { inline: 1 } || out == { INLINE => 1 }
         end
 
-        def map_reduce_spec(session)
-          Builder::MapReduce.new(map, reduce, view, options.merge(session: session)).specification
+        def map_reduce_spec(session = nil)
+          Builder::MapReduce.new(map_function, reduce_function, view, options.merge(session: session)).specification
         end
 
         def new(options)
-          MapReduce.new(view, map, reduce, options)
+          MapReduce.new(view, map_function, reduce_function, options)
         end
 
         def initial_query_op(session)
@@ -216,16 +234,15 @@ module Mongo
             server = cluster.next_primary(false)
           end
           validate_collation!(server)
-          result = initial_query_op(session).execute(server)
-          inline? ? result : send_fetch_query(server, session)
+          initial_query_op(session).execute(server)
         end
 
         def fetch_query_spec
-          Builder::MapReduce.new(map, reduce, view, options).query_specification
+          Builder::MapReduce.new(map_function, reduce_function, view, options).query_specification
         end
 
         def find_command_spec(session)
-          Builder::MapReduce.new(map, reduce, view, options.merge(session: session)).command_specification
+          Builder::MapReduce.new(map_function, reduce_function, view, options.merge(session: session)).command_specification
         end
 
         def fetch_query_op(server, session)

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

@@ -138,8 +138,8 @@ module Mongo
           read_with_retry do
             server = selector.select_server(cluster, false)
             apply_collation!(cmd, server, opts)
-            with_session do |session|
-              Operation::Commands::Command.new({
+            with_session(opts) do |session|
+              Operation::Commands::Count.new({
                                                    :selector => cmd,
                                                    :db_name => database.name,
                                                    :options => {:limit => -1},
@@ -178,8 +178,8 @@ module Mongo
           read_with_retry do
             server = selector.select_server(cluster, false)
             apply_collation!(cmd, server, opts)
-            with_session do |session|
-              Operation::Commands::Command.new({
+            with_session(opts) do |session|
+              Operation::Commands::Distinct.new({
                                                    :selector => cmd,
                                                    :db_name => database.name,
                                                    :options => {:limit => -1},
@@ -231,7 +231,7 @@ module Mongo
         #
         # @since 2.0.0
         def map_reduce(map, reduce, options = {})
-          MapReduce.new(self, map, reduce, options)
+          MapReduce.new(self, map, reduce, @options.merge(options))
         end
 
         # Set the max number of documents to scan.

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

@@ -46,14 +46,15 @@ module Mongo
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
           cmd[:writeConcern] = write_concern.options if write_concern
 
-          with_session do |session|
-            write_with_retry(session, Proc.new { next_primary }) do |server|
+          with_session(opts) do |session|
+            write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
-              Operation::Commands::Command.new({
-                                                :selector => cmd,
-                                                :db_name => database.name,
-                                                :session => session
-                                               }).execute(server)
+              Operation::Commands::Command.new(
+                  :selector => cmd,
+                  :db_name => database.name,
+                  :session => session,
+                  :txn_num => txn_num
+              ).execute(server)
             end
           end.first['value']
         end
@@ -99,7 +100,7 @@ module Mongo
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
-        # @options opts [ Array ] :array_filters A set of filters specifying to which array elements
+        # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
         # an update should apply.
         #
         # @return [ BSON::Document ] The document.
@@ -116,15 +117,16 @@ module Mongo
           cmd[:bypassDocumentValidation] = !!opts[:bypass_document_validation]
           cmd[:writeConcern] = write_concern.options if write_concern
 
-          value = with_session do |session|
-            write_with_retry(session, Proc.new { next_primary }) do |server|
+          value = with_session(opts) do |session|
+            write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
               apply_array_filters!(cmd, server, opts)
               Operation::Commands::Command.new(
-                                               :selector => cmd,
-                                               :db_name => database.name,
-                                               :session => session
-                                              ).execute(server)
+                  :selector => cmd,
+                  :db_name => database.name,
+                  :session => session,
+                  :txn_num => txn_num
+              ).execute(server)
             end
           end.first['value']
           value unless value.nil? || value.empty?
@@ -143,7 +145,19 @@ module Mongo
         #
         # @since 2.0.0
         def delete_many(opts = {})
-          remove(0, opts)
+          delete_doc = { Operation::Q => filter, Operation::LIMIT => 0 }
+          with_session(opts) do |session|
+            legacy_write_with_retry do |server|
+              apply_collation!(delete_doc, server, opts)
+              Operation::Write::Delete.new(
+                  :delete => delete_doc,
+                  :db_name => collection.database.name,
+                  :coll_name => collection.name,
+                  :write_concern => collection.write_concern,
+                  :session => session
+              ).execute(server)
+            end
+          end
         end
 
         # Remove a document from the collection.
@@ -159,7 +173,21 @@ module Mongo
         #
         # @since 2.0.0
         def delete_one(opts = {})
-          remove(1, opts)
+          delete_doc = { Operation::Q => filter, Operation::LIMIT => 1 }
+          write_concern = collection.write_concern
+          with_session(opts) do |session|
+            write_with_retry(session, write_concern) do |server, txn_num|
+              apply_collation!(delete_doc, server, opts)
+              Operation::Write::Delete.new(
+                  :delete => delete_doc,
+                  :db_name => collection.database.name,
+                  :coll_name => collection.name,
+                  :write_concern => write_concern,
+                  :session => session,
+                  :txn_num => txn_num
+              ).execute(server)
+            end
+          end
         end
 
         # Replaces a single document in the database with the new document.
@@ -178,7 +206,28 @@ module Mongo
         #
         # @since 2.0.0
         def replace_one(replacement, opts = {})
-          update(replacement, false, opts)
+          update_doc = { Operation::Q => filter,
+                         Operation::U => replacement,
+                         Operation::MULTI => false,
+                         Operation::UPSERT => !!opts[:upsert]
+                        }
+          write_concern = collection.write_concern
+          with_session(opts) do |session|
+            write_with_retry(session, write_concern) do |server, txn_num|
+              apply_collation!(update_doc, server, opts)
+              apply_array_filters!(update_doc, server, opts)
+
+              Operation::Write::Update.new(
+                  :update => update_doc,
+                  :db_name => collection.database.name,
+                  :coll_name => collection.name,
+                  :write_concern => write_concern,
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
+                  :session => session,
+                  :txn_num => txn_num
+              ).execute(server)
+            end
+          end
         end
 
         # Update documents in the collection.
@@ -199,7 +248,24 @@ module Mongo
         #
         # @since 2.0.0
         def update_many(spec, opts = {})
-          update(spec, true, opts)
+          update_doc = { Operation::Q => filter,
+                         Operation::U => spec,
+                         Operation::MULTI => true,
+                         Operation::UPSERT => !!opts[:upsert] }
+          with_session(opts) do |session|
+            legacy_write_with_retry do |server|
+              apply_collation!(update_doc, server, opts)
+              apply_array_filters!(update_doc, server, opts)
+              Operation::Write::Update.new(
+                  :update => update_doc,
+                  :db_name => collection.database.name,
+                  :coll_name => collection.name,
+                  :write_concern => collection.write_concern,
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
+                  :session => session
+              ).execute(server)
+            end
+          end
         end
 
         # Update a single document in the collection.
@@ -220,50 +286,31 @@ module Mongo
         #
         # @since 2.0.0
         def update_one(spec, opts = {})
-          update(spec, false, opts)
-        end
-
-        private
-
-        def remove(value, opts = {})
-          delete_doc = { Operation::Q => filter, Operation::LIMIT => value }
-
-          with_session do |session|
-            write_with_retry(session, Proc.new { next_primary }) do |server|
-              apply_collation!(delete_doc, server, opts)
-              Operation::Write::Delete.new(
-                :delete => delete_doc,
-                :db_name => collection.database.name,
-                :coll_name => collection.name,
-                :write_concern => collection.write_concern,
-                :session => session
-              ).execute(server)
-            end
-          end
-        end
-
-        def update(spec, multi, opts)
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
-                         Operation::MULTI => multi,
+                         Operation::MULTI => false,
                          Operation::UPSERT => !!opts[:upsert] }
-
-          with_session do |session|
-            write_with_retry(session, Proc.new { next_primary }) do |server|
+          write_concern = collection.write_concern
+          with_session(opts) do |session|
+            write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+
               Operation::Write::Update.new(
-                :update => update_doc,
-                :db_name => collection.database.name,
-                :coll_name => collection.name,
-                :write_concern => collection.write_concern,
-                :bypass_document_validation => !!opts[:bypass_document_validation],
-                :session => session
+                  :update => update_doc,
+                  :db_name => collection.database.name,
+                  :coll_name => collection.name,
+                  :write_concern => write_concern,
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
+                  :session => session,
+                  :txn_num => txn_num
               ).execute(server)
             end
           end
         end
 
+        private
+
         def apply_array_filters!(doc, server, opts = {})
           if filters = opts[:array_filters] || opts[ARRAY_FILTERS]
             validate_array_filters!(server, filters)