mongo 2.5.3 → 2.6.0

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2017 MongoDB, Inc.
+# Copyright (C) 2017-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,32 +24,15 @@ module Mongo
 
           private
 
-          RETRY_MESSAGES = [
-            'not master',
-            '(43)' # cursor not found error code
-          ].freeze
-
           def read_with_one_retry
             yield
-          rescue => e
-            if retryable?(e)
+          rescue Mongo::Error => e
+            if e.change_stream_resumable?
               yield
             else
               raise(e)
             end
           end
-
-          def retryable?(error)
-             network_error?(error) || retryable_operation_failure?(error)
-          end
-
-          def network_error?(error)
-            [ Error::SocketError, Error::SocketTimeoutError].include?(error.class)
-          end
-
-          def retryable_operation_failure?(error)
-            error.is_a?(Error::OperationFailure) && RETRY_MESSAGES.any? { |m| error.message.include?(m) }
-          end
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -37,7 +37,7 @@ module Mongo
         def each
           @cursor = nil
           session = client.send(:get_session, @options)
-          read_with_retry do
+          read_with_retry(session) do
             server = server_selector.select_server(cluster)
             result = send_initial_query(server, session)
             @cursor = Cursor.new(view, result, server, session: session)

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -112,12 +112,12 @@ module Mongo
         # @example Get the number of documents in the collection.
         #   collection_view.count
         #
-        # @param [ Hash ] opts Options for the count command.
+        # @param [ Hash ] opts Options for the operation.
         #
         # @option opts :skip [ Integer ] The number of documents to skip.
         # @option opts :hint [ Hash ] Override default index selection and force
         #   MongoDB to use a specific index for the query.
-        # @option opts :limit [ Integer ] Max number of docs to return.
+        # @option opts :limit [ Integer ] Max number of docs to count.
         # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the
         #   command to run.
         # @option opts [ Hash ] :read The read preference options.
@@ -126,6 +126,12 @@ module Mongo
         # @return [ Integer ] The document count.
         #
         # @since 2.0.0
+        #
+        # @deprecated Use #count_documents or #estimated_document_count instead. However, note that
+        #   the following operators will need to be substituted when switching to #count_documents:
+        #     * $where should be replaced with $expr (only works on 3.6+)
+        #     * $near should be replaced with $geoWithin with $center
+        #     * $nearSphere should be replaced with $geoWithin with $centerSphere
         def count(opts = {})
           cmd = { :count => collection.name, :query => filter }
           cmd[:skip] = opts[:skip] if opts[:skip]
@@ -135,10 +141,10 @@ module Mongo
           cmd[:readConcern] = collection.read_concern if collection.read_concern
           read_pref = opts[:read] || read_preference
           selector = ServerSelector.get(read_pref || server_selector)
-          read_with_retry do
-            server = selector.select_server(cluster)
-            apply_collation!(cmd, server, opts)
-            with_session(opts) do |session|
+          with_session(opts) do |session|
+            read_with_retry(session) do
+              server = selector.select_server(cluster)
+              apply_collation!(cmd, server, opts)
               Operation::Count.new({
                                      :selector => cmd,
                                      :db_name => database.name,
@@ -146,10 +152,71 @@ module Mongo
                                      :read => read_pref,
                                      :session => session
                                     }).execute(server)
-            end.n.to_i
+              end.n.to_i
           end
         end
 
+        # Get a count of matching documents in the collection.
+        #
+        # @example Get the number of documents in the collection.
+        #   collection_view.count
+        #
+        # @param [ Hash ] opts Options for the operation.
+        #
+        # @option opts :skip [ Integer ] The number of documents to skip.
+        # @option opts :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
+        #   command to run.
+        # @option opts [ Hash ] :read The read preference options.
+        # @option opts [ Hash ] :collation The collation to use.
+        #
+        # @return [ Integer ] The document count.
+        #
+        # @since 2.6.0
+        def count_documents(opts = {})
+          pipeline = [:'$match' => filter]
+          pipeline << { :'$skip' => opts[:skip] } if opts[:skip]
+          pipeline << { :'$limit' => opts[:limit] } if opts[:limit]
+          pipeline << { :'$group' => { _id: nil, n: { :'$sum' => 1 } } }
+
+          opts.select! { |k, _| [:hint, :max_time_ms, :read, :collation].include?(k) }
+          aggregate(pipeline, opts).first['n'].to_i
+        end
+
+        # Gets an estimate of the count of documents in a collection using collection metadata.
+        #
+        # @example Get the number of documents in the collection.
+        #   collection_view.estimated_document_count
+        #
+        # @param [ Hash ] opts Options for the operation.
+        #
+        # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the command to
+        #   run.
+        # @option opts [ Hash ] :read The read preference options.
+        #
+        # @return [ Integer ] The document count.
+        #
+        # @since 2.6.0
+        def estimated_document_count(opts = {})
+          cmd = { count: collection.name }
+          cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
+          cmd[:readConcern] = collection.read_concern if collection.read_concern
+          read_pref = opts[:read] || read_preference
+          selector = ServerSelector.get(read_pref || server_selector)
+          with_session(opts) do |session|
+            read_with_retry(session) do
+              server = selector.select_server(cluster)
+              Operation::Count.new(
+                selector: cmd,
+                db_name: database.name,
+                read: read_pref,
+                session: session
+              ).execute(server)
+            end.n.to_i
+          end
+        end
 
         # Get a list of distinct values for a specific field.
         #
@@ -175,10 +242,10 @@ module Mongo
           cmd[:readConcern] = collection.read_concern if collection.read_concern
           read_pref = opts[:read] || read_preference
           selector = ServerSelector.get(read_pref || server_selector)
-          read_with_retry do
-            server = selector.select_server(cluster)
-            apply_collation!(cmd, server, opts)
-            with_session(opts) do |session|
+          with_session(opts) do |session|
+            read_with_retry(session) do
+              server = selector.select_server(cluster)
+              apply_collation!(cmd, server, opts)
               Operation::Distinct.new({
                                         :selector => cmd,
                                         :db_name => database.name,
@@ -470,38 +537,50 @@ module Mongo
         end
 
         def read_preference
-          @read_preference ||= (options[:read] || collection.read_preference)
+          if options[:session] && options[:session].in_transaction?
+            options[:session].send(:txn_read_pref) || collection.client.read_preference
+          else
+            @read_preference ||= (options[:read] || collection.read_preference)
+          end
         end
 
         def server_selector
-          @server_selector ||= ServerSelector.get(read_preference || collection.server_selector)
+          if options[:session] && options[:session].in_transaction?
+            ServerSelector.get(read_preference || client.server_selector)
+          else
+            @server_selector ||= ServerSelector.get(read_preference || collection.server_selector)
+          end
         end
 
         def parallel_scan(cursor_count, options = {})
-          session = client.send(:get_session, @options)
+          if options[:session]
+            session = client.send(:get_session, @options)
+          else
+            session = nil
+          end
           server = server_selector.select_server(cluster)
           cmd = Operation::ParallelScan.new({
                   :coll_name => collection.name,
                   :db_name => database.name,
                   :cursor_count => cursor_count,
                   :read_concern => collection.read_concern,
-                  :session => session
+                  :session => session,
                 }.merge!(options))
           cmd.execute(server).cursor_ids.map do |cursor_id|
             result = if server.features.find_command_enabled?
-                       Operation::GetMore.new({
-                         :selector => {:getMore => cursor_id,
-                                       :collection => collection.name},
-                         :db_name => database.name,
-                         :session => session
-                       }).execute(server)
-                     else
-                       Operation::GetMore.new({
-                         :to_return => 0,
-                         :cursor_id => cursor_id,
-                         :db_name => database.name,
-                         :coll_name => collection.name
-                     }).execute(server)
+              Operation::GetMore.new({
+                :selector => {:getMore => cursor_id,
+                             :collection => collection.name},
+                :db_name => database.name,
+                :session => session,
+              }).execute(server)
+             else
+              Operation::GetMore.new({
+                :to_return => 0,
+                :cursor_id => cursor_id,
+                :db_name => database.name,
+                :coll_name => collection.name
+              }).execute(server)
             end
             Cursor.new(self, result, server, session: session)
           end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ module Mongo
         #
         # @since 2.0.0
         def find_one_and_delete(opts = {})
-          cmd = { :findandmodify => collection.name, :query => filter, :remove => true }
+          cmd = { :findAndModify => collection.name, :query => filter, :remove => true }
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
@@ -107,7 +107,7 @@ module Mongo
         #
         # @since 2.0.0
         def find_one_and_update(document, opts = {})
-          cmd = { :findandmodify => collection.name, :query => filter }
+          cmd = { :findAndModify => collection.name, :query => filter }
           cmd[:update] = document
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort

data/lib/mongo/cursor.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -52,8 +52,8 @@ module Mongo
     # @param [ Server ] server The server this cursor is locked to.
     # @param [ Hash ] options The cursor options.
     #
-    # @option options [ true, false ] :disable_retry Whether to disable retrying on
-    #   error when sending getmores.
+    # @option options [ true, false ] :disable_retry Whether to disable
+    #   retrying on error when sending getMores.
     #
     # @since 2.0.0
     def initialize(view, result, server, options = {})
@@ -125,6 +125,46 @@ module Mongo
       end
     end
 
+    # Return one document from the query, if one is available.
+    #
+    # Retries once on a resumable error.
+    #
+    # This method will wait up to max_await_time_ms milliseconds
+    # for changes from the server, and if no changes are received
+    # it will return nil.
+    #
+    # @note This method is experimental and subject to change.
+    #
+    # @return [ BSON::Document | nil ] A document.
+    # @api private
+    def try_next
+      if @documents.nil?
+        @documents = process(@initial_result)
+        # the documents here can be an empty array, hence
+        # we may end up issuing a getMore in the first try_next call
+      end
+
+      if @documents.empty?
+        if more?
+          if exhausted?
+            kill_cursors
+            return nil
+          end
+
+          @documents = get_more
+        end
+      else
+        # cursor is closed here
+        # keep documents as an empty array
+      end
+
+      if @documents
+        return @documents.shift
+      end
+
+      nil
+    end
+
     # Get the batch size.
     #
     # @example Get the batch size.
@@ -198,7 +238,7 @@ module Mongo
       if @options[:disable_retry]
         process(get_more_operation.execute(@server))
       else
-        read_with_retry do
+        read_with_retry(@session) do
           process(get_more_operation.execute(@server))
         end
       end

data/lib/mongo/cursor/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/database.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -105,7 +105,7 @@ module Mongo
     end
     alias_method :collection, :[]
 
-    # Get all the names of the non system collections in the database.
+    # Get all the names of the non-system collections in the database.
     #
     # @example Get the collection names.
     #   database.collection_names
@@ -153,8 +153,10 @@ module Mongo
     #
     # @return [ Hash ] The result of the command execution.
     def command(operation, opts = {})
-      preference = ServerSelector.get(opts[:read] || ServerSelector::PRIMARY)
+      txn_read_pref = opts[:session] && opts[:session].in_transaction? && opts[:session].txn_read_pref
+      preference = ServerSelector.get(txn_read_pref || opts[:read] || ServerSelector::PRIMARY)
       server = preference.select_server(cluster)
+
       client.send(:with_session, opts) do |session|
         Operation::Command.new({
           :selector => operation.dup,
@@ -244,6 +246,47 @@ module Mongo
       Auth::User::View.new(self)
     end
 
+    # As of version 3.6 of the MongoDB server, a ``$changeStream`` pipeline stage is supported
+    # in the aggregation framework. As of version 4.0, this stage allows users to request that
+    # notifications are sent for all changes that occur in the client's database.
+    #
+    # @example Get change notifications for a given database..
+    #  database.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.
+    # @option options [ BSON::Timestamp ] :start_at_operation_time Only return
+    #   changes that occurred after the specified timestamp. Any command run
+    #   against the server will return a cluster time that can be used here.
+    #   Only recognized by server versions 4.0+.
+    #
+    # @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.6.0
+    def watch(pipeline = [], options = {})
+      Mongo::Collection::View::ChangeStream.new(
+        Mongo::Collection::View.new(collection("#{COMMAND}.aggregate")),
+        pipeline,
+        Mongo::Collection::View::ChangeStream::DATABASE,
+        options)
+    end
+
     # Create a database for the provided client, for use when we don't want the
     # client's original database instance to be the same.
     #