mongo 2.23.0 → 2.24.0

data/lib/mongo/crypt/kms/master_key_document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -18,15 +17,13 @@
 module Mongo
   module Crypt
     module KMS
-
       # KMS master key document object contains KMS master key parameters
       # that are used for creation of data keys.
       #
       # @api private
       class MasterKeyDocument
-
         # Known KMS provider names.
-        KMS_PROVIDERS = %w(aws azure gcp kmip local).freeze
+        KMS_PROVIDERS = %w[aws azure gcp kmip local].freeze
 
         # Creates a master key document object form a parameters hash.
         #
@@ -38,19 +35,18 @@ module Mongo
         #
         # @raise [ ArgumentError ] If required options are missing or incorrectly.
         def initialize(kms_provider, options)
-          if options.nil?
-            raise ArgumentError.new('Key document options must not be nil')
-          end
+          raise ArgumentError.new('Key document options must not be nil') if options.nil?
+
           master_key = options.fetch(:master_key, {})
           @key_document = case kms_provider.to_s
-            when 'aws' then KMS::AWS::MasterKeyDocument.new(master_key)
-            when 'azure' then KMS::Azure::MasterKeyDocument.new(master_key)
-            when 'gcp' then KMS::GCP::MasterKeyDocument.new(master_key)
-            when 'kmip' then KMS::KMIP::MasterKeyDocument.new(master_key)
-            when 'local' then KMS::Local::MasterKeyDocument.new(master_key)
-            else
-              raise ArgumentError.new("KMS provider must be one of #{KMS_PROVIDERS}")
-          end
+                          when 'aws' then KMS::AWS::MasterKeyDocument.new(master_key)
+                          when 'azure' then KMS::Azure::MasterKeyDocument.new(master_key)
+                          when 'gcp' then KMS::GCP::MasterKeyDocument.new(master_key)
+                          when 'kmip' then KMS::KMIP::MasterKeyDocument.new(master_key)
+                          when 'local' then KMS::Local::MasterKeyDocument.new(master_key)
+                          else
+                            raise ArgumentError.new("KMS provider must be one of #{KMS_PROVIDERS}")
+                          end
         end
 
         # Convert master key document object to a BSON document in libmongocrypt format.

data/lib/mongo/crypt/kms.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -43,10 +42,11 @@ module Mongo
         def validate_param(key, opts, format_hint, required: true)
           value = opts.fetch(key)
           return nil if value.nil? && !required
+
           if value.nil?
             raise ArgumentError.new(
               "The #{key} option must be a String with at least one character; " \
-              "currently have nil"
+              'currently have nil'
             )
           end
           unless value.is_a?(String)
@@ -58,7 +58,7 @@ module Mongo
           if value.empty?
             raise ArgumentError.new(
               "The #{key} option must be a String with at least one character; " \
-              "it is currently an empty string"
+              'it is currently an empty string'
             )
           end
           value
@@ -68,8 +68,6 @@ module Mongo
               "The specified KMS provider options are invalid: #{opts}. " +
               format_hint
             )
-          else
-            nil
           end
         end
 
@@ -92,17 +90,17 @@ module Mongo
                 "Incorrect TLS options for #{provider}: TLS is required"
               )
             end
-            %i(
+            %i[
               ssl_verify_certificate
               ssl_verify_hostname
-            ).each do |opt|
-              if provider_opts[opt] == false
-                raise ArgumentError.new(
-                  "Incorrect TLS options for #{provider}: " +
-                  'Insecure TLS options prohibited, ' +
-                  "#{opt} cannot be set to false for KMS"
-                )
-              end
+            ].each do |opt|
+              next unless provider_opts[opt] == false
+
+              raise ArgumentError.new(
+                "Incorrect TLS options for #{provider}: " +
+                'Insecure TLS options prohibited, ' +
+                "#{opt} cannot be set to false for KMS"
+              )
             end
           end
           opts
@@ -113,8 +111,8 @@ module Mongo
   end
 end
 
-require "mongo/crypt/kms/credentials"
-require "mongo/crypt/kms/master_key_document"
+require 'mongo/crypt/kms/credentials'
+require 'mongo/crypt/kms/master_key_document'
 require 'mongo/crypt/kms/aws'
 require 'mongo/crypt/kms/azure'
 require 'mongo/crypt/kms/gcp'

data/lib/mongo/crypt/kms_context.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Crypt
-
     # Wraps a libmongocrypt mongocrypt_kms_ctx_t object. Contains information
     # about making an HTTP request to fetch information about a KMS
     # data key.

data/lib/mongo/crypt/rewrap_many_data_key_context.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Crypt
-
     # A Context object initialized specifically for the purpose of rewrapping
-    # data keys (decrypting and re-rencryting using a new KEK).
+    # data keys (decrypting and re-encrypting using a new KEK).
     #
     # @api private
     class RewrapManyDataKeyContext < Context
-
       # Create a new RewrapManyDataKeyContext object
       #
       # @param [ Mongo::Crypt::Handle ] mongocrypt a Handle that
@@ -36,9 +33,7 @@ module Mongo
       #   key document that contains master encryption key parameters.
       def initialize(mongocrypt, io, filter, master_key_document)
         super(mongocrypt, io)
-        if master_key_document
-          Binding.ctx_setopt_key_encryption_key(self, master_key_document.to_document)
-        end
+        Binding.ctx_setopt_key_encryption_key(self, master_key_document.to_document) if master_key_document
         Binding.ctx_rewrap_many_datakey_init(self, filter)
       end
     end

data/lib/mongo/crypt/rewrap_many_data_key_result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2022 MongoDB Inc.
 #
@@ -17,12 +16,11 @@
 
 module Mongo
   module Crypt
-    # Represent result of the rewrap many data ke operation.
+    # Represent result of the rewrap many data key operation.
     #
     # @api semiprivate
     class RewrapManyDataKeyResult
-
-      # @returns [ BulkWrite::Result ] the result of the bulk write operation
+      # @return [ BulkWrite::Result ] the result of the bulk write operation
       #   used to update the key vault collection with rewrapped data keys.
       attr_reader :bulk_write_result
 

data/lib/mongo/crypt/status.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 ## Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'ffi'
 
 module Mongo
   module Crypt
-
     # A wrapper around mongocrypt_status_t, representing the status of
     # a mongocrypt_t handle.
     #
@@ -39,9 +37,9 @@ module Mongo
         # FFI::AutoPointer uses a custom release strategy to automatically free
         # the pointer once this object goes out of scope
         @status = pointer || FFI::AutoPointer.new(
-                              Binding.mongocrypt_status_new,
-                              Binding.method(:mongocrypt_status_destroy)
-                            )
+          Binding.mongocrypt_status_new,
+          Binding.method(:mongocrypt_status_destroy)
+        )
       end
 
       # Initialize a Status object from an existing pointer to a
@@ -52,7 +50,7 @@ module Mongo
       #
       # @return [ Mongo::Crypt::Status ] A new Status object
       def self.from_pointer(pointer)
-        self.new(pointer: pointer)
+        new(pointer: pointer)
       end
 
       # Set a label, code, and message on the Status
@@ -63,10 +61,10 @@ module Mongo
       #
       # @return [ Mongo::Crypt::Status ] returns self
       def update(label, code, message)
-        unless [:ok, :error_client, :error_kms].include?(label)
+        unless %i[ok error_client error_kms].include?(label)
           raise ArgumentError.new(
             "#{label} is an invalid value for a Mongo::Crypt::Status label. " +
-            "Label must have one of the following values: :ok, :error_client, :error_kms"
+            'Label must have one of the following values: :ok, :error_client, :error_kms'
           )
         end
 
@@ -109,7 +107,7 @@ module Mongo
       # Returns the reference to the underlying mongocrypt_status_t
       # object
       #
-      # @return [ FFI::Pointer ] Pointer to the underlying mongocrypt_status_t oject
+      # @return [ FFI::Pointer ] Pointer to the underlying mongocrypt_status_t object
       def ref
         @status
       end
@@ -127,11 +125,11 @@ module Mongo
       def raise_crypt_error(kms: false)
         return if ok?
 
-        if kms || label == :error_kms
-          error = Error::KmsError.new(message, code: code)
-        else
-          error = Error::CryptError.new(message, code: code)
-        end
+        error = if kms || label == :error_kms
+                  Error::KmsError.new(message, code: code)
+                else
+                  Error::CryptError.new(message, code: code)
+                end
 
         raise error
       end

data/lib/mongo/crypt.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/csot_timeout_holder.rb

@@ -101,9 +101,10 @@ module Mongo
     end
 
     def check_no_override_inside_transaction!(opts, session)
-      return unless opts[:operation_timeout_ms] && session&.with_transaction_deadline
+      return unless opts[:operation_timeout_ms] && session&.inside_with_transaction?
 
-      raise ArgumentError, 'Cannot override timeout_ms inside with_transaction block'
+      raise Mongo::Error::InvalidTransactionOperation,
+            'timeoutMS cannot be overridden inside a withTransaction callback'
     end
 
     def calculate_deadline_from_timeout_ms(operation_timeout_ms)

data/lib/mongo/cursor/kill_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,14 +16,12 @@
 
 module Mongo
   class Cursor
-
     # This class contains the operation specification for KillCursors.
     #
     # Its purpose is to ensure we don't misspell attribute names accidentally.
     #
     # @api private
     class KillSpec
-
       def initialize(
         cursor_id:,
         coll_name:,
@@ -44,12 +41,12 @@ module Mongo
       end
 
       attr_reader :cursor_id,
-      :coll_name,
-      :db_name,
-      :connection_global_id,
-      :server_address,
-      :session,
-      :connection
+                  :coll_name,
+                  :db_name,
+                  :connection_global_id,
+                  :server_address,
+                  :session,
+                  :connection
 
       def ==(other)
         cursor_id == other.cursor_id &&
@@ -61,7 +58,7 @@ module Mongo
       end
 
       def eql?(other)
-        self.==(other)
+        self == other
       end
 
       def hash

data/lib/mongo/cursor.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -16,7 +15,6 @@
 # limitations under the License.
 
 module Mongo
-
   # Client-side representation of an iterator over a query result set on
   # the server.
   #
@@ -82,14 +80,14 @@ module Mongo
       @namespace = result.namespace
       @remaining = limit if limited?
       set_cursor_id(result)
-      if @cursor_id.nil?
-        raise ArgumentError, 'Cursor id must be present in the result'
-      end
+      raise ArgumentError, 'Cursor id must be present in the result' if @cursor_id.nil?
+
       @options = options
       @session = @options[:session]
       @connection_global_id = result.connection_global_id
       @context = @options[:context]&.with(connection_global_id: connection_global_id_for_context) || fresh_context
       @explicitly_closed = false
+      @get_more_network_error = false
       @lock = Mutex.new
       if server.load_balancer?
         # We need the connection in the cursor only in load balanced topology;
@@ -126,9 +124,8 @@ module Mongo
     #
     # @api private
     def self.finalize(kill_spec, cluster)
-      unless KillSpec === kill_spec
-        raise ArgumentError, "First argument must be a KillSpec: #{kill_spec.inspect}"
-      end
+      raise ArgumentError, "First argument must be a KillSpec: #{kill_spec.inspect}" unless kill_spec.is_a?(KillSpec)
+
       proc do
         cluster.schedule_kill_cursor(kill_spec)
       end
@@ -161,7 +158,6 @@ module Mongo
     #
     # @since 2.0.0
     def each
-
       # If we already iterated past the first batch (i.e., called get_more
       # at least once), the cursor on the server side has advanced past
       # the first batch and restarting iteration from the beginning by
@@ -184,9 +180,8 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
-          if explicitly_closed?
-            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
-          end
+          raise Error::InvalidCursorOperation, 'Cursor was explicitly closed' if explicitly_closed?
+
           yield document if document
         end
         self
@@ -195,9 +190,8 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
-          if explicitly_closed?
-            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
-          end
+          raise Error::InvalidCursorOperation, 'Cursor was explicitly closed' if explicitly_closed?
+
           documents << document if document
         end
         documents
@@ -235,16 +229,16 @@ module Mongo
         # On empty batches, we cache the batch resume token
         cache_batch_resume_token
 
-        unless closed?
+        if closed?
+          @fully_iterated = true
+          raise StopIteration
+        else
           if exhausted?
             close
             @fully_iterated = true
             raise StopIteration
           end
           @documents = get_more
-        else
-          @fully_iterated = true
-          raise StopIteration
         end
       else
         # cursor is closed here
@@ -252,20 +246,16 @@ module Mongo
       end
 
       # If there is at least one document, cache its _id
-      if @documents[0]
-        cache_resume_token(@documents[0])
-      end
+      cache_resume_token(@documents[0]) if @documents[0]
 
       # Cache the batch resume token if we are iterating
       # over the last document, or if the batch is empty
       if @documents.size <= 1
         cache_batch_resume_token
-        if closed?
-          @fully_iterated = true
-        end
+        @fully_iterated = true if closed?
       end
 
-      return @documents.shift
+      @documents.shift
     end
 
     # Get the batch size.
@@ -277,7 +267,7 @@ module Mongo
     #
     # @since 2.2.0
     def batch_size
-      value = @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
+      value = (@view.batch_size && @view.batch_size > 0) ? @view.batch_size : limit
       if value == 0
         nil
       else
@@ -308,19 +298,21 @@ module Mongo
       ctx = context ? context.refresh(timeout_ms: opts[:timeout_ms]) : fresh_context(opts)
 
       unregister
-      read_with_one_retry do
-        spec = {
-          coll_name: collection_name,
-          db_name: database.name,
-          cursor_ids: [id],
-        }
-        op = Operation::KillCursors.new(spec)
-        execute_operation(op, context: ctx)
+      unless @get_more_network_error
+        read_with_one_retry do
+          spec = {
+            coll_name: collection_name,
+            db_name: database.name,
+            cursor_ids: [ id ],
+          }
+          op = Operation::KillCursors.new(spec)
+          execute_operation(op, context: ctx)
+        end
       end
 
       nil
-    rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable
-      # Errors are swallowed since there is noting can be done by handling them.
+    rescue Error::OperationFailure::Family, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable, Error::ConnectionPerished
+      # Errors are swallowed since there is nothing can be done by handling them.
     ensure
       end_session
       @cursor_id = 0
@@ -369,19 +361,6 @@ module Mongo
       @cursor_id
     end
 
-    # Get the number of documents to return. Used on 3.0 and lower server
-    # versions.
-    #
-    # @example Get the number to return.
-    #   cursor.to_return
-    #
-    # @return [ Integer ] The number of documents to return.
-    #
-    # @since 2.2.0
-    def to_return
-      use_limit? ? @remaining : (batch_size || 0)
-    end
-
     # Execute a getMore command and return the batch of documents
     # obtained from the server.
     #
@@ -396,7 +375,21 @@ module Mongo
       # doing so may result in silent data loss, the driver no longer retries
       # getMore operations in any circumstance.
       # https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.md#qa
-      process(execute_operation(get_more_operation))
+      #
+      # However, overload errors (SystemOverloadedError + RetryableError) are
+      # retried with exponential backoff since the server never processed
+      # the request.
+      with_overload_retry(context: possibly_refreshed_context) do
+        process(execute_operation(get_more_operation))
+      end
+    rescue Error::SocketError, Error::SocketTimeoutError
+      @get_more_network_error = true
+      raise
+    rescue Error::OperationFailure => e
+      # When overload retries are exhausted on getMore, close the cursor
+      # so that killCursors is sent to the server.
+      close if e.label?('RetryableError') && e.label?('SystemOverloadedError')
+      raise
     end
 
     # @api private
@@ -417,6 +410,18 @@ module Mongo
       !!@fully_iterated
     end
 
+    # Refreshes the cursor's CSOT context so that the next getMore starts
+    # with a fresh timeout deadline. Used by tailable awaitData cursors to
+    # implement per-iteration timeout refresh as required by the CSOT spec.
+    # Only refreshes if this is a tailable awaitData cursor with an active timeout.
+    #
+    # @api private
+    def refresh_timeout!
+      return unless view.cursor_type == :tailable_await && context.timeout?
+
+      @context = @context.refresh(view: view)
+    end
+
     private
 
     def explicitly_closed?
@@ -427,7 +432,7 @@ module Mongo
 
     def batch_size_for_get_more
       if batch_size && use_limit?
-        [batch_size, @remaining].min
+        [ batch_size, @remaining ].min
       else
         batch_size
       end
@@ -438,9 +443,9 @@ module Mongo
     end
 
     def cache_resume_token(doc)
-      if doc[:_id] && doc[:_id].is_a?(Hash)
-        @resume_token = doc[:_id] && doc[:_id].dup.freeze
-      end
+      return unless doc[:_id] && doc[:_id].is_a?(Hash)
+
+      @resume_token = doc[:_id] && doc[:_id].dup.freeze
     end
 
     def cache_batch_resume_token
@@ -453,13 +458,10 @@ module Mongo
         db_name: database.name,
         coll_name: collection_name,
         cursor_id: id,
-        # 3.2+ servers use batch_size, 3.0- servers use to_return.
-        # TODO should to_return be calculated in the operation layer?
         batch_size: batch_size_for_get_more,
-        to_return: to_return
       }
-      if view.respond_to?(:options) && view.options.is_a?(Hash)
-        spec[:comment] = view.options[:comment] unless view.options[:comment].nil?
+      if view.respond_to?(:options) && view.options.is_a?(Hash) && !view.options[:comment].nil?
+        spec[:comment] = view.options[:comment]
       end
       Operation::GetMore.new(spec)
     end
@@ -484,9 +486,7 @@ module Mongo
       end
       @cursor_id = set_cursor_id(result)
 
-      if result.respond_to?(:post_batch_resume_token)
-        @post_batch_resume_token = result.post_batch_resume_token
-      end
+      @post_batch_resume_token = result.post_batch_resume_token if result.respond_to?(:post_batch_resume_token)
 
       end_session if closed?
 
@@ -527,6 +527,11 @@ module Mongo
     # @return [ Operation::Context ] the (possibly-refreshed) context.
     def possibly_refreshed_context
       return context if view.timeout_mode == :cursor_lifetime
+      # For tailable await cursors with CSOT, the timeout budget is shared across
+      # all getMore commands (cumulative). Only update the view reference; keep
+      # the same deadline so remaining time decreases across getMores.
+      return context.with(view: view) if view.cursor_type == :tailable_await
+
       context.refresh(view: view)
     end
 
@@ -580,7 +585,12 @@ module Mongo
       return if @connection.nil?
       return unless @connection.server.load_balancer?
 
-      @connection.connection_pool.check_in(@connection)
+      @connection.unpin
+      # Do not check in if the connection is still pinned by something
+      # else (e.g. a transaction).
+      unless @connection.pinned?
+        @connection.connection_pool.check_in(@connection)
+      end
       @connection = nil
     end
   end

data/lib/mongo/cursor_host.rb

@@ -31,7 +31,6 @@ module Mongo
     #   detected.
     #
     # @api private
-    # rubocop:disable Metrics
     def validate_timeout_mode!(options, forbid: [])
       forbid.each do |key|
         raise ArgumentError, "#{key} is not allowed here" if options.key?(key)
@@ -49,19 +48,19 @@ module Mongo
           if timeout_mode == :cursor_lifetime
             raise ArgumentError, 'tailable cursors only support `timeout_mode: :iteration`'
           end
-
-          # "Drivers MUST error if [the maxAwaitTimeMS] option is set,
-          # timeoutMS is set to a non-zero value, and maxAwaitTimeMS is
-          # greater than or equal to timeoutMS."
-          max_await_time_ms = options[:max_await_time_ms] || 0
-          if cursor_type == :tailable_await && max_await_time_ms >= timeout_ms
-            raise ArgumentError, ':max_await_time_ms must not be >= :timeout_ms'
-          end
         else
           # "For non-tailable cursors, the default value of timeoutMode
           # is CURSOR_LIFETIME."
           timeout_mode ||= :cursor_lifetime
         end
+
+        # "Drivers MUST error if [the maxAwaitTimeMS] option is set,
+        # timeoutMS is set to a non-zero value, and maxAwaitTimeMS is
+        # greater than or equal to timeoutMS."
+        max_await_time_ms = options[:max_await_time_ms] || 0
+        if max_await_time_ms.positive? && max_await_time_ms >= timeout_ms
+          raise ArgumentError, ':max_await_time_ms must not be >= :timeout_ms'
+        end
       elsif timeout_mode
         # "Drivers MUST error if timeoutMode is set and timeoutMS is not."
         raise ArgumentError, ':timeout_ms must be set if :timeout_mode is set'
@@ -77,6 +76,5 @@ module Mongo
       # if no timeout_mode was set initially.
       @timeout_mode = timeout_mode
     end
-    # rubocop:enable Metrics
   end
 end