mongo 2.4.3 → 2.5.0.beta

data/lib/mongo/collection/view.rb

@@ -17,6 +17,7 @@ require 'mongo/collection/view/immutable'
 require 'mongo/collection/view/iterable'
 require 'mongo/collection/view/explainable'
 require 'mongo/collection/view/aggregation'
+require 'mongo/collection/view/change_stream'
 require 'mongo/collection/view/map_reduce'
 require 'mongo/collection/view/readable'
 require 'mongo/collection/view/writable'
@@ -59,8 +60,7 @@ module Mongo
       def_delegators :collection,
                      :client,
                      :cluster,
-                     :database,
-                     :read_preference
+                     :database
 
       # Delegate to the cluster for the next primary.
       def_delegators :cluster, :next_primary
@@ -198,6 +198,12 @@ module Mongo
       end
 
       def view; self; end
+
+      def with_session
+        client.send(:with_session, @options) do |session|
+          yield(session)
+        end
+      end
     end
   end
 end

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

@@ -37,7 +37,7 @@ module Mongo
         def_delegators :view, :collection, :read, :cluster
 
         # Delegate necessary operations to the collection.
-        def_delegators :collection, :database
+        def_delegators :collection, :database, :client
 
         # The reroute message.
         #
@@ -90,16 +90,20 @@ module Mongo
 
         private
 
-        def aggregate_spec
-          Builder::Aggregation.new(pipeline, view, options).specification
+        def server_selector
+          @view.send(:server_selector)
+        end
+
+        def aggregate_spec(session)
+          Builder::Aggregation.new(pipeline, view, options.merge(session: session)).specification
         end
 
         def new(options)
           Aggregation.new(view, pipeline, options)
         end
 
-        def initial_query_op
-          Operation::Commands::Aggregate.new(aggregate_spec)
+        def initial_query_op(session)
+          Operation::Commands::Aggregate.new(aggregate_spec(session))
         end
 
         def valid_server?(server)
@@ -110,13 +114,13 @@ module Mongo
           pipeline.none? { |op| op.key?('$out') || op.key?(:$out) }
         end
 
-        def send_initial_query(server)
+        def send_initial_query(server, session)
           unless valid_server?(server)
             log_warn(REROUTE)
             server = cluster.next_primary(false)
           end
           validate_collation!(server)
-          initial_query_op.execute(server)
+          initial_query_op(session).execute(server)
         end
 
         def validate_collation!(server)

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

@@ -29,6 +29,9 @@ module Mongo
           MAPPINGS = BSON::Document.new(
             :allow_disk_use => 'allowDiskUse',
             :max_time_ms => 'maxTimeMS',
+            # This is intentional; max_await_time_ms is an alias for maxTimeMS used on getmore
+            # commands for change streams.
+            :max_await_time_ms => 'maxTimeMS',
             :explain => 'explain',
             :bypass_document_validation => 'bypassDocumentValidation',
             :collation => 'collation',
@@ -74,7 +77,8 @@ module Mongo
             spec = {
                     selector: aggregation_command,
                     db_name: database.name,
-                    read: read
+                    read: read,
+                    session: @options[:session]
                    }
             write? ? spec.merge!(write_concern: write_concern) : spec
           end

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

@@ -48,7 +48,6 @@ module Mongo
             no_cursor_timeout: 'noCursorTimeout',
             await_data: 'awaitData',
             allow_partial_results: 'allowPartialResults',
-            read_concern: 'readConcern',
             collation: 'collation'
           ).freeze
 
@@ -73,10 +72,12 @@ module Mongo
           #   FindCommandBuilder.new(view)
           #
           # @param [ Collection::View ] view The collection view.
+          # @param [ Session ] session The session.
           #
           # @since 2.2.2
-          def initialize(view)
+          def initialize(view, session)
             @view = view
+            @session = session
           end
 
           # Get the specification to pass to the find command operation.
@@ -88,13 +89,14 @@ module Mongo
           #
           # @since 2.2.0
           def specification
-            { selector: find_command, db_name: database.name, read: read }
+            { selector: find_command, db_name: database.name, read: read, session: @session }
           end
 
           private
 
           def find_command
             document = BSON::Document.new('find' => collection.name, 'filter' => filter)
+            document[:readConcern] = collection.read_concern if collection.read_concern
             command = Options::Mapper.transform_documents(convert_flags(options), MAPPINGS, document)
             convert_limit_and_batch_size(command)
             command

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

@@ -81,7 +81,8 @@ module Mongo
             {
               selector: find_command,
               db_name: query_database,
-              read: read
+              read: read,
+              session: options[:session]
             }
           end
 
@@ -109,7 +110,8 @@ module Mongo
             spec = {
               selector: map_reduce_command,
               db_name: database.name,
-              read: read
+              read: read,
+              session: options[:session]
             }
             write?(spec) ? spec.merge!(write_concern: write_concern) : spec
           end
@@ -138,7 +140,7 @@ module Mongo
               :out => { inline: 1 }
             )
             command[:readConcern] = collection.read_concern if collection.read_concern
-            command.merge!(view.options)
+            command.merge!(view_options)
             command.merge!(Options::Mapper.transform_documents(options, MAPPINGS))
             command
           end
@@ -152,6 +154,12 @@ module Mongo
               options[:out][OUT_ACTIONS.find { |action| options[:out][action] }]
             end || options[:out]
           end
+
+          def view_options
+            @view_options ||= (opts = view.options.dup
+                               opts.delete(:session)
+                               opts)
+          end
         end
       end
     end

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

@@ -68,7 +68,7 @@ module Mongo
           end
 
           def read_pref_formatted
-            @read_formatted ||= read.to_mongos
+            @read_formatted ||= ServerSelector.get(read).to_mongos if read
           end
 
           def special_filter

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

@@ -0,0 +1,160 @@
+# Copyright (C) 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.
+
+require 'mongo/collection/view/change_stream/retryable'
+
+module Mongo
+  class Collection
+    class View
+
+      # Provides behaviour around a `$changeStream` pipeline stage in the
+      # aggregation framework. Specifying this stage allows users to request that
+      # notifications are sent for all changes to a particular collection or database.
+      #
+      # @note Only available in server versions 3.6 and higher.
+      # @note ChangeStreams do not work properly with JRuby because of the issue documented
+      #  here: https://github.com/jruby/jruby/issues/4212
+      #  Namely, JRuby eagerly evaluates #next on an Enumerator in a background green thread.
+      #  So calling #next on the change stream will cause getmores to be called in a loop in the background.
+      #
+      #
+      # @since 2.5.0
+      class ChangeStream < Aggregation
+        include Retryable
+
+        # @return [ String ] The fullDocument option default value.
+        #
+        # @since 2.5.0
+        FULL_DOCUMENT_DEFAULT = 'default'.freeze
+
+        # @return [ BSON::Document ] The change stream options.
+        #
+        # @since 2.5.0
+        attr_reader :options
+
+        # Initialize the change stream for the provided collection view, pipeline
+        # and options.
+        #
+        # @example Create the new change stream view.
+        #   ChangeStream.new(view, pipeline, options)
+        #
+        # @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.
+        #
+        # @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.
+        #
+        # @since 2.5.0
+        def initialize(view, pipeline, options = {})
+          @view = view
+          @change_stream_filters = pipeline && pipeline.dup
+          @options = options && options.dup.freeze
+          @resume_token = @options[:resume_after]
+          read_with_one_retry { create_cursor! }
+        end
+
+        # Iterate through documents returned by the change stream.
+        #
+        # @example Iterate through the stream of documents.
+        #   stream.each do |document|
+        #     p document
+        #   end
+        #
+        # @return [ Enumerator ] The enumerator.
+        #
+        # @since 2.5.0
+        #
+        # @yieldparam [ BSON::Document ] Each change stream document.
+        def each
+          raise StopIteration.new if closed?
+          begin
+            @cursor.each do |doc|
+              cache_resume_token(doc)
+              yield doc
+            end if block_given?
+            @cursor.to_enum
+          rescue => e
+            close
+            if retryable?(e)
+              create_cursor!
+              retry
+            end
+            raise
+          end
+        end
+
+        # Close the change stream.
+        #
+        # @example Close the change stream.
+        #   stream.close
+        #
+        # @return [ nil ] nil.
+        #
+        # @since 2.5.0
+        def close
+          unless closed?
+            begin; @cursor.send(:kill_cursors); rescue; end
+            @cursor = nil
+          end
+        end
+
+        # Is the change stream closed?
+        #
+        # @example Determine whether the change stream is closed.
+        #   stream.closed?
+        #
+        # @return [ true, false ] If the change stream is closed.
+        #
+        # @since 2.5.0
+        def closed?
+          @cursor.nil?
+        end
+
+        private
+
+        def cache_resume_token(doc)
+          unless @resume_token = (doc[:_id] && doc[:_id].dup)
+            raise Error::MissingResumeToken.new
+          end
+        end
+
+        def create_cursor!
+          session = client.send(:get_session, @options)
+          server = server_selector.select_server(cluster, false)
+          result = send_initial_query(server, session)
+          @cursor = Cursor.new(view, result, server, disable_retry: true, session: session)
+        end
+
+        def pipeline
+          change_doc = { fullDocument: ( @options[:full_document] || FULL_DOCUMENT_DEFAULT ) }
+          change_doc[:resumeAfter] = @resume_token if @resume_token
+          [{ '$changeStream' => change_doc }] + @change_stream_filters
+        end
+
+        def send_initial_query(server, session)
+          initial_query_op(session).execute(server)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# Copyright (C) 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 Collection
+    class View
+      class ChangeStream < Aggregation
+
+        # Behavior around resuming a change stream.
+        #
+        # @since 2.5.0
+        module Retryable
+
+          private
+
+          RETRY_MESSAGES = [
+            'not master',
+            '(43)' # cursor not found error code
+          ].freeze
+
+          def read_with_one_retry
+            yield
+          rescue => e
+            if retryable?(e)
+              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
+  end
+end

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

@@ -36,10 +36,11 @@ module Mongo
         # @yieldparam [ Hash ] Each matching document.
         def each
           @cursor = nil
+          session = client.send(:get_session, @options)
           read_with_retry do
-            server = read.select_server(cluster, false)
-            result = send_initial_query(server)
-            @cursor = Cursor.new(view, result, server)
+            server = server_selector.select_server(cluster, false)
+            result = send_initial_query(server, session)
+            @cursor = Cursor.new(view, result, server, session: session)
           end
           @cursor.each do |doc|
             yield doc
@@ -60,25 +61,25 @@ module Mongo
 
         private
 
-        def initial_query_op(server)
+        def initial_query_op(server, session)
           if server.features.find_command_enabled?
-            initial_command_op
+            initial_command_op(session)
           else
             Operation::Read::Query.new(Builder::OpQuery.new(self).specification)
           end
         end
 
-        def initial_command_op
+        def initial_command_op(session)
           if explained?
-            Operation::Commands::Command.new(Builder::FindCommand.new(self).explain_specification)
+            Operation::Commands::Explain.new(Builder::FindCommand.new(self, session).explain_specification)
           else
-            Operation::Commands::Find.new(Builder::FindCommand.new(self).specification)
+            Operation::Commands::Find.new(Builder::FindCommand.new(self, session).specification)
           end
         end
 
-        def send_initial_query(server)
+        def send_initial_query(server, session = nil)
           validate_collation!(server, collation)
-          initial_query_op(server).execute(server)
+          initial_query_op(server, session).execute(server)
         end
       end
     end