mongo 2.20.1 → 2.21.0

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

@@ -38,7 +38,8 @@ module Mongo
         # @param [ Hash ] opts The options.
         #
         # @option opts [ Integer ] :max_time_ms The maximum amount of time to allow the command
-        #   to run in milliseconds.
+        #   to run in milliseconds. This option is deprecated, use
+        #   :timeout_ms instead.
         # @option opts [ Hash ] :projection The fields to include or exclude in the returned doc.
         # @option opts [ Hash ] :sort The key and direction pairs by which the result set
         #   will be sorted.
@@ -46,11 +47,15 @@ module Mongo
         # @option opts [ Session ] :session The session to use.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
         #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
+        # @option opts [ Object ] :comment A user-provided
         #   comment to attach to this command.
         #
         # @return [ BSON::Document, nil ] The document, if found.
@@ -80,7 +85,11 @@ module Mongo
               comment: opts[:comment],
             }.compact
 
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_4 = connection.server.description.server_version_gte?('4.4')
               if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
@@ -116,9 +125,13 @@ module Mongo
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
         #   See the server documentation for details.
         #
         # @return [ BSON::Document ] The document.
@@ -136,8 +149,9 @@ module Mongo
         # @param [ BSON::Document ] document The updates.
         # @param [ Hash ] opts The options.
         #
-        # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
-        #   to run in milliseconds.
+        # @option opts [ Integer ] :max_time_ms The maximum amount of time to allow the command
+        #   to run in milliseconds. This option is deprecated, use
+        #   :timeout_ms instead.
         # @option opts [ Hash ] :projection The fields to include or exclude in the returned doc.
         # @option opts [ Hash ] :sort The key and direction pairs by which the result set
         #   will be sorted.
@@ -149,13 +163,17 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
         # an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
         #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
+        # @option opts [ Object ] :comment A user-provided
         #   comment to attach to this command.
         #
         # @return [ BSON::Document | nil ] The document or nil if none is found.
@@ -188,7 +206,11 @@ module Mongo
               comment: opts[:comment]
             }.compact
 
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_4 = connection.server.description.server_version_gte?('4.4')
               if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
@@ -216,13 +238,17 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
         #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
+        # @option opts [ Object ] :comment A user-provided
         #   comment to attach to this command.
         #
         # @return [ Result ] The response from the database.
@@ -244,8 +270,11 @@ module Mongo
               hint: opts[:hint],
               collation: opts[:collation] || opts['collation'] || collation,
             }.compact
-
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             nro_write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_4 = connection.server.description.server_version_gte?('4.4')
               if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
@@ -274,15 +303,19 @@ module Mongo
         # @param [ Hash ] opts The options.
         #
         # @option opts [ Hash ] :collation The collation to use.
-        # @option opts [ Session ] :session The session to use.
+        # @option opts [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
+        # @option opts [ Session ] :session The session to use.
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
-        #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
-        #   comment to attach to this command.
         #
         # @return [ Result ] The response from the database.
         #
@@ -304,7 +337,11 @@ module Mongo
               collation: opts[:collation] || opts['collation'] || collation,
             }.compact
 
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_4 = connection.server.description.server_version_gte?('4.4')
               if !gte_4_4 && opts[:hint] && write_concern && !write_concern.acknowledged?
@@ -334,20 +371,24 @@ module Mongo
         # @param [ Hash ] replacement The replacement document.
         # @param [ Hash ] opts The options.
         #
-        # @option opts [ true, false ] :upsert Whether to upsert if the
-        #   document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
         # @option opts [ Hash ] :collation The collation to use.
-        # @option opts [ Session ] :session The session to use.
+        # @option opts [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
+        # @option opts [ Session ] :session The session to use.
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
         # @option opts [ Hash ] :write_concern The write concern options.
+        # @option opts [ true, false ] :upsert Whether to upsert if the
+        #   document doesn't exist.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
-        #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
-        #   comment to attach to this command.
         #
         # @return [ Result ] The response from the database.
         #
@@ -374,7 +415,11 @@ module Mongo
               update_doc['upsert'] = true
             end
 
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_2 = connection.server.description.server_version_gte?('4.2')
               if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
@@ -404,22 +449,26 @@ module Mongo
         # @param [ Hash | Array<Hash> ] spec The update document or pipeline.
         # @param [ Hash ] opts The options.
         #
-        # @option opts [ true, false ] :upsert Whether to upsert if the
-        #   document doesn't exist.
+        # @option opts [ Array ] :array_filters A set of filters specifying to
+        #   which array elements an update should apply.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
         # @option opts [ Hash ] :collation The collation to use.
-        # @option opts [ Array ] :array_filters A set of filters specifying to
-        #   which array elements an update should apply.
-        # @option opts [ Session ] :session The session to use.
+        # @option opts [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
+        # @option opts [ Session ] :session The session to use.
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
+        # @option opts [ true, false ] :upsert Whether to upsert if the
+        #   document doesn't exist.
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
-        #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
-        #   comment to attach to this command.
         #
         # @return [ Result ] The response from the database.
         #
@@ -447,7 +496,11 @@ module Mongo
               update_doc['upsert'] = true
             end
 
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             nro_write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_2 = connection.server.description.server_version_gte?('4.2')
               if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?
@@ -476,22 +529,26 @@ module Mongo
         # @param [ Hash | Array<Hash> ] spec The update document or pipeline.
         # @param [ Hash ] opts The options.
         #
-        # @option opts [ true, false ] :upsert Whether to upsert if the
-        #   document doesn't exist.
+        # @option opts [ Array ] :array_filters A set of filters specifying to
+        #   which array elements an update should apply.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
         # @option opts [ Hash ] :collation The collation to use.
-        # @option opts [ Array ] :array_filters A set of filters specifying to
-        #   which array elements an update should apply.
-        # @option opts [ Session ] :session The session to use.
+        # @option opts [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         # @option opts [ Hash | String ] :hint The index to use for this operation.
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
+        # @option opts [ Session ] :session The session to use.
+        # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+        #    Must be a non-negative integer. An explicit value of 0 means infinite.
+        #    The default value is unset which means the value is inherited from
+        #    the collection or the database or the client.
+        # @option opts [ true, false ] :upsert Whether to upsert if the
+        #   document doesn't exist.
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
-        # @option options [ Hash ] :let Mapping of variables to use in the command.
-        #   See the server documentation for details.
-        # @option options [ Object ] :comment A user-provided
-        #   comment to attach to this command.
         #
         # @return [ Result ] The response from the database.
         #
@@ -518,7 +575,11 @@ module Mongo
               update_doc['upsert'] = true
             end
 
-            context = Operation::Context.new(client: client, session: session)
+            context = Operation::Context.new(
+              client: client,
+              session: session,
+              operation_timeouts: operation_timeouts(opts)
+            )
             write_with_retry(write_concern, context: context) do |connection, txn_num, context|
               gte_4_2 = connection.server.description.server_version_gte?('4.2')
               if !gte_4_2 && opts[:hint] && write_concern && !write_concern.acknowledged?

data/lib/mongo/collection/view.rb

@@ -63,10 +63,10 @@ module Mongo
                      :client,
                      :cluster,
                      :database,
+                     :nro_write_with_retry,
                      :read_with_retry,
                      :read_with_retry_cursor,
                      :write_with_retry,
-                     :nro_write_with_retry,
                      :write_concern_with_session
 
       # Delegate to the cluster for the next primary.
@@ -74,6 +74,12 @@ module Mongo
 
       alias :selector :filter
 
+      # @return [ Integer | nil | The timeout_ms value that was passed as an
+      #   option to the view.
+      #
+      # @api private
+      attr_reader :operation_timeout_ms
+
       # Compare two +View+ objects.
       #
       # @example Compare the view with another object.
@@ -151,15 +157,26 @@ module Mongo
       #   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.
+      # @option options [ :cursor_lifetime | :iteration ] :timeout_mode How to interpret
+      #   :timeout_ms (whether it applies to the lifetime of the cursor, or per
+      #   iteration).
+      # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+      #    Must be a non-negative integer. An explicit value of 0 means infinite.
+      #    The default value is unset which means the value is inherited from
+      #    the collection or the database or the client.
       #
       # @since 2.0.0
       def initialize(collection, filter = {}, options = {})
         validate_doc!(filter)
-        @collection = collection
 
         filter = BSON::Document.new(filter)
         options = BSON::Document.new(options)
 
+        @collection = collection
+        @operation_timeout_ms = options.delete(:timeout_ms)
+
+        validate_timeout_mode!(options)
+
         # This is when users pass $query in filter and other modifiers
         # alongside?
         query = filter.delete(:$query)
@@ -171,6 +188,14 @@ module Mongo
         @options = Operation::Find::Builder::Modifiers.map_driver_options(modifiers).merge!(options).freeze
       end
 
+      # The timeout_ms value to use for this operation; either specified as an
+      # option to the view, or inherited from the collection.
+      #
+      # @return [ Integer | nil ] the timeout_ms for this operation
+      def timeout_ms
+        operation_timeout_ms || collection.timeout_ms
+      end
+
       # Get a human-readable string representation of +View+.
       #
       # @example Get the inspection.
@@ -196,6 +221,20 @@ module Mongo
         WriteConcern.get(options[:write_concern] || options[:write] || collection.write_concern)
       end
 
+      # @return [ Hash ] timeout_ms value set on the operation level (if any),
+      #   and/or timeout_ms that is set on collection/database/client level (if any).
+      #
+      # @api private
+      def operation_timeouts(opts = {})
+        {}.tap do |result|
+          if opts[:timeout_ms] || operation_timeout_ms
+            result[:operation_timeout_ms] = opts[:timeout_ms] || operation_timeout_ms
+          else
+            result[:inherited_timeout_ms] = collection.timeout_ms
+          end
+        end
+      end
+
       private
 
       def initialize_copy(other)
@@ -205,13 +244,14 @@ module Mongo
       end
 
       def new(options)
+        options = options.merge(timeout_ms: operation_timeout_ms) if operation_timeout_ms
         View.new(collection, filter, options)
       end
 
       def view; self; end
 
       def with_session(opts = {}, &block)
-        client.send(:with_session, @options.merge(opts), &block)
+        client.with_session(@options.merge(opts), &block)
       end
     end
   end