mongo 2.15.0 → 2.18.1

data/lib/mongo/error/read_write_retryable.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2022 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 Error
+
+    # A module encapsulating functionality to indicate whether errors are
+    # retryable.
+    #
+    # @note Although methods of this module are part of the public API,
+    #   the fact that these methods are defined on this module and not on
+    #   the classes which include this module is not part of the public API.
+    #
+    # @api semipublic
+    module ReadWriteRetryable
+
+      # Error codes and code names that should result in a failing write
+      # being retried.
+      #
+      # @api private
+      WRITE_RETRY_ERRORS = [
+        {:code_name => 'HostUnreachable', :code => 6},
+        {:code_name => 'HostNotFound', :code => 7},
+        {:code_name => 'NetworkTimeout', :code => 89},
+        {:code_name => 'ShutdownInProgress', :code => 91},
+        {:code_name => 'PrimarySteppedDown', :code => 189},
+        {:code_name => 'ExceededTimeLimit', :code => 262},
+        {:code_name => 'SocketException', :code => 9001},
+        {:code_name => 'NotMaster', :code => 10107},
+        {:code_name => 'InterruptedAtShutdown', :code => 11600},
+        {:code_name => 'InterruptedDueToReplStateChange', :code => 11602},
+        {:code_name => 'NotPrimaryNoSecondaryOk', :code => 13435},
+        {:code_name => 'NotMasterOrSecondary', :code => 13436},
+      ].freeze
+
+      # These are magic error messages that could indicate a master change.
+      #
+      # @api private
+      WRITE_RETRY_MESSAGES = [
+        'not master',
+        'node is recovering',
+      ].freeze
+
+      # These are magic error messages that could indicate a cluster
+      # reconfiguration behind a mongos.
+      #
+      # @api private
+      RETRY_MESSAGES = WRITE_RETRY_MESSAGES + [
+        'transport error',
+        'socket exception',
+        "can't connect",
+        'connect failed',
+        'error querying',
+        'could not get last error',
+        'connection attempt failed',
+        'interrupted at shutdown',
+        'unknown replica set',
+        'dbclient error communicating with server'
+      ].freeze
+
+      # Whether the error is a retryable error according to the legacy
+      # read retry logic.
+      #
+      # @return [ true, false ]
+      #
+      # @deprecated
+      def retryable?
+        write_retryable? ||
+        code.nil? && RETRY_MESSAGES.any?{ |m| message.include?(m) }
+      end
+
+      # Whether the error is a retryable error according to the modern retryable
+      # reads and retryable writes specifications.
+      #
+      # This method is also used by the legacy retryable write logic to determine
+      # whether an error is a retryable one.
+      #
+      # @return [ true, false ]
+      def write_retryable?
+        write_retryable_code? ||
+        code.nil? && WRITE_RETRY_MESSAGES.any? { |m| message.include?(m) }
+      end
+
+      private def write_retryable_code?
+        if code
+          WRITE_RETRY_ERRORS.any? { |e| e[:code] == code }
+        else
+          # return false rather than nil
+          false
+        end
+      end
+    end
+  end
+end

data/lib/mongo/error/session_not_materialized.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2022 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 Error
+
+    # This exception is raised when a session is attempted to be used but
+    # it was never materialized.
+    class SessionNotMaterialized < InvalidSession
+      def initialize
+        super("The session was not materialized and cannot be used. Use start_session or with_session in order to start a session that will be materialized.")
+      end
+    end
+  end
+end

data/lib/mongo/error/snapshot_session_invalid_server_version.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2021 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 Error
+
+    # Exception raised if an operation using a snapshot session is
+    # directed to a pre-5.0 server.
+    class SnapshotSessionInvalidServerVersion < Error
+
+      # Instantiate the new exception.
+      def initialize
+        super("Snapshot reads require MongoDB 5.0 or later")
+      end
+    end
+  end
+end

data/lib/mongo/error/snapshot_session_transaction_prohibited.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2021 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 Error
+
+    # Exception raised if a transaction is attempted on a snapshot session.
+    class SnapshotSessionTransactionProhibited < Error
+
+      # Instantiate the new exception.
+      def initialize
+        super("Transactions are not supported in snapshot sessions")
+      end
+    end
+  end
+end

data/lib/mongo/error.rb

@@ -16,6 +16,7 @@
 # limitations under the License.
 
 require 'mongo/error/notable'
+require 'mongo/error/labelable'
 
 module Mongo
   # Base error class for all Mongo related errors.
@@ -23,6 +24,7 @@ module Mongo
   # @since 2.0.0
   class Error < StandardError
     include Notable
+    include Labelable
 
     # The error code field.
     #
@@ -109,24 +111,9 @@ module Mongo
 
     def initialize(msg = nil)
       super
-      @labels = []
       @write_concern_error_labels = []
     end
 
-    # Does the error have the given label?
-    #
-    # @example
-    #   error.label?(label)
-    #
-    # @param [ String ] label The label to check if the error has.
-    #
-    # @return [ true, false ] Whether the error has the given label.
-    #
-    # @since 2.6.0
-    def label?(label)
-      @labels.include?(label)
-    end
-
     # Does the write concern error have the given label?
     #
     # @param [ String ] label The label to check for the presence of.
@@ -136,38 +123,17 @@ module Mongo
       @write_concern_error_labels.include?(label)
     end
 
-    # Gets the set of labels associated with the error.
-    #
-    # @example
-    #   error.labels
-    #
-    # @return [ Array ] The set of labels.
-    #
-    # @since 2.7.0
-    def labels
-      @labels.dup
-    end
-
     # The set of error labels associated with the write concern error.
     #
     # @return [ Array<String> ] The list of error labels.
     def write_concern_error_labels
       @write_concern_error_labels.dup
     end
-
-    # Adds the specified label to the error instance, if the label is not
-    # already in the set of labels.
-    #
-    # @param [ String ] label The label to add.
-    #
-    # @api private
-    def add_label(label)
-      @labels << label unless label?(label)
-    end
   end
 end
 
 require 'mongo/error/auth_error'
+require 'mongo/error/bad_load_balancer_target'
 require 'mongo/error/sdam_error_detection'
 require 'mongo/error/parser'
 require 'mongo/error/write_retryable'
@@ -185,6 +151,7 @@ require 'mongo/error/invalid_address'
 require 'mongo/error/invalid_bulk_operation'
 require 'mongo/error/invalid_bulk_operation_type'
 require 'mongo/error/invalid_collection_name'
+require 'mongo/error/invalid_config_option'
 require 'mongo/error/invalid_cursor_operation'
 require 'mongo/error/invalid_database_name'
 require 'mongo/error/invalid_document'
@@ -217,10 +184,14 @@ require 'mongo/error/mismatched_domain'
 require 'mongo/error/mongocryptd_spawn_error'
 require 'mongo/error/multi_index_drop'
 require 'mongo/error/need_primary_server'
+require 'mongo/error/no_service_connection_available'
 require 'mongo/error/no_server_available'
 require 'mongo/error/no_srv_records'
 require 'mongo/error/session_ended'
 require 'mongo/error/sessions_not_supported'
+require 'mongo/error/session_not_materialized'
+require 'mongo/error/snapshot_session_invalid_server_version'
+require 'mongo/error/snapshot_session_transaction_prohibited'
 require 'mongo/error/operation_failure'
 require 'mongo/error/pool_closed_error'
 require 'mongo/error/raise_original_error'
@@ -231,10 +202,12 @@ require 'mongo/error/failed_string_prep_validation'
 require 'mongo/error/unchangeable_collection_option'
 require 'mongo/error/unexpected_chunk_length'
 require 'mongo/error/unexpected_response'
+require 'mongo/error/missing_connection'
 require 'mongo/error/missing_file_chunk'
 require 'mongo/error/missing_password'
 require 'mongo/error/missing_resume_token'
 require 'mongo/error/missing_scram_server_signature'
+require 'mongo/error/missing_service_id'
 require 'mongo/error/server_api_conflict'
 require 'mongo/error/server_api_not_supported'
 require 'mongo/error/unknown_payload_type'

data/lib/mongo/grid/fs_bucket.rb

@@ -508,8 +508,27 @@ module Mongo
 
       def ensure_indexes!
         if files_collection.find({}, limit: 1, projection: { _id: 1 }).first.nil?
-          chunks_collection.indexes.create_one(FSBucket::CHUNKS_INDEX, :unique => true)
-          files_collection.indexes.create_one(FSBucket::FILES_INDEX)
+          create_index_if_missing!(files_collection, FSBucket::FILES_INDEX)
+        end
+
+        if chunks_collection.find({}, limit: 1, projection: { _id: 1 }).first.nil?
+          create_index_if_missing!(chunks_collection, FSBucket::CHUNKS_INDEX, :unique => true)
+        end
+      end
+
+      def create_index_if_missing!(collection, index_spec, options = {})
+        indexes_view = collection.indexes
+        begin
+          if indexes_view.get(index_spec).nil?
+            indexes_view.create_one(index_spec, options)
+          end
+        rescue Mongo::Error::OperationFailure => e
+          # proceed with index creation if a NamespaceNotFound error is thrown
+          if e.code == 26
+            indexes_view.create_one(index_spec, options)
+          else
+            raise
+          end
         end
       end
     end

data/lib/mongo/grid/stream/read.rb

@@ -79,13 +79,19 @@ module Mongo
             ensure_readable!
             info = file_info
             num_chunks = (info.length + info.chunk_size - 1) / info.chunk_size
+            num_read = 0
             if block_given?
               view.each_with_index.reduce(0) do |length_read, (doc, index)|
                 chunk = Grid::File::Chunk.new(doc)
                 validate!(index, num_chunks, chunk, length_read)
                 data = chunk.data.data
                 yield data
+                num_read += 1
                 length_read += data.size
+              end.tap do
+                if num_read < num_chunks
+                  raise Error::MissingFileChunk.new(num_chunks, num_read)
+                end
               end
             else
               view.to_enum

data/lib/mongo/id.rb

@@ -16,9 +16,10 @@
 # limitations under the License.
 
 module Mongo
-  # This module abstracts the functionality for generating sequential unique integer IDs for
-  # instances of the class. It defines the method #next_id on the class that includes it. The
-  # implementation ensures that the IDs will be unique even when called from multiple threads.
+  # This module abstracts the functionality for generating sequential
+  # unique integer IDs for instances of the class. It defines the method
+  # #next_id on the class that includes it. The implementation ensures that
+  # the IDs will be unique even when called from multiple threads.
   #
   # @example Include the Id module.
   #   class Foo
@@ -29,8 +30,9 @@ module Mongo
   #   foo.next_id # => 1
   #   foo.next_id # => 2
   #
-  # Classes which include Id should _not_ access `@@id` or `@@id_lock` directly; instead, they
-  # should call `#next_id` in `#initialize` and save the result in the instance being created.
+  # Classes which include Id should _not_ access `@@id` or `@@id_lock`
+  # directly; instead, they should call `#next_id` in `#initialize` and save
+  # the result in the instance being created.
   #
   # @example Save the ID in the instance of the including class.
   #   class Bar

data/lib/mongo/index/view.rb

@@ -69,7 +69,9 @@ module Mongo
         :unique => :unique,
         :version => :v,
         :weights => :weights,
-        :collation => :collation
+        :collation => :collation,
+        :comment => :comment,
+        :wildcard_projection => :wildcardProjection,
       }.freeze
 
       # Drop an index by its name.
@@ -78,13 +80,17 @@ module Mongo
       #   view.drop_one('name_1')
       #
       # @param [ String ] name The name of the index.
+      # @param [ Hash ] options Options for this operation.
+      #
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
       # @return [ Result ] The response.
       #
       # @since 2.0.0
-      def drop_one(name)
+      def drop_one(name, options = {})
         raise Error::MultiIndexDrop.new if name == Index::ALL
-        drop_by_name(name)
+        drop_by_name(name, comment: options[:comment])
       end
 
       # Drop all indexes on the collection.
@@ -92,11 +98,16 @@ module Mongo
       # @example Drop all indexes on the collection.
       #   view.drop_all
       #
+      # @param [ Hash ] options Options for this operation.
+      #
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
+      #
       # @return [ Result ] The response.
       #
       # @since 2.0.0
-      def drop_all
-        drop_by_name(Index::ALL)
+      def drop_all(options = {})
+        drop_by_name(Index::ALL, comment: options[:comment])
       end
 
       # Creates an index on the collection.
@@ -129,8 +140,13 @@ module Mongo
       # @option options [ String | Integer ] :commit_quorum Specify how many
       #   data-bearing members of a replica set, including the primary, must
       #   complete the index builds successfully before the primary marks
-      #   the indexes as ready.
+      #   the indexes as ready. Potential values are:
+      #   - an integer from 0 to the number of members of the replica set
+      #   - "majority" indicating that a majority of data bearing nodes must vote
+      #   - "votingMembers" which means that all voting data bearing nodes must vote
       # @option options [ Session ] :session The session to use for the operation.
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
       # @note Note that the options listed may be subset of those available.
       # See the MongoDB documentation for a full list of supported options by server version.
@@ -145,7 +161,7 @@ module Mongo
         if session = @options[:session]
           create_options[:session] = session
         end
-        %i(commit_quorum session).each do |key|
+        %i(commit_quorum session comment).each do |key|
           if value = options.delete(key)
             create_options[key] = value
           end
@@ -177,8 +193,12 @@ module Mongo
       #   The following options are accepted:
       #   - commit_quorum: Specify how many data-bearing members of a replica set,
       #     including the primary, must complete the index builds successfully
-      #     before the primary marks the indexes as ready.
+      #     before the primary marks the indexes as ready. Potential values are:
+      #     - an integer from 0 to the number of members of the replica set
+      #     - "majority" indicating that a majority of data bearing nodes must vote
+      #     - "votingMembers" which means that all voting data bearing nodes must vote
       #   - session: The session to use.
+      #   - comment: A user-provided comment to attach to this command.
       #
       # @return [ Result ] The result of the command.
       #
@@ -193,17 +213,6 @@ module Mongo
         client.send(:with_session, @options.merge(options)) do |session|
           server = next_primary(nil, session)
 
-          # While server versions 3.4 and newer generally perform option
-          # validation, there was a bug on server versions 4.2.0 - 4.2.5 where
-          # the server would accept the commitQuorum option and use it internally
-          # (see SERVER-47193). As a result, the drivers specifications require
-          # drivers to perform validation and raise an error when the commitQuorum
-          # option is passed to servers that don't support it.
-          description = server.with_connection { |connection| connection.description }
-          if description.max_wire_version < 9 && options[:commit_quorum]
-            raise Error::UnsupportedOption.commit_quorum_error
-          end
-
           indexes = normalize_models(models, server)
           indexes.each do |index|
             if index[:bucketSize] || index['bucketSize']
@@ -216,10 +225,10 @@ module Mongo
             db_name: database.name,
             coll_name: collection.name,
             session: session,
-            commit_quorum: options[:commit_quorum]
-           }
-
-          spec[:write_concern] = write_concern if description.features.collation_enabled?
+            commit_quorum: options[:commit_quorum],
+            write_concern: write_concern,
+            comment: options[:comment],
+          }
 
           Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
@@ -289,16 +298,17 @@ module Mongo
 
       private
 
-      def drop_by_name(name)
+      def drop_by_name(name, comment: nil)
         client.send(:with_session, @options) do |session|
           spec = {
-                   db_name: database.name,
-                   coll_name: collection.name,
-                   index_name: name,
-                   session: session
-                 }
+            db_name: database.name,
+            coll_name: collection.name,
+            index_name: name,
+            session: session,
+            write_concern: write_concern,
+          }
+          spec[:comment] = comment unless comment.nil?
           server = next_primary(nil, session)
-          spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled?
           Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
@@ -329,30 +339,17 @@ module Mongo
       end
 
       def normalize_models(models, server)
-        with_generated_names(models, server).map do |model|
-          Options::Mapper.transform(model, OPTIONS)
+        models.map do |model|
+          # Transform options first which gives us a mutable hash
+          Options::Mapper.transform(model, OPTIONS).tap do |model|
+            model[:name] ||= index_name(model.fetch(:key))
+          end
         end
       end
 
       def send_initial_query(server, session)
         initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
       end
-
-      def with_generated_names(models, server)
-        models.dup.each do |model|
-          validate_collation!(model, server)
-          unless model[:name]
-            model[:name] = index_name(model[:key])
-          end
-        end
-      end
-
-      def validate_collation!(model, server)
-        if (model[:collation] || model[Operation::COLLATION]) &&
-            !server.with_connection { |connection| connection.features }.collation_enabled?
-          raise Error::UnsupportedCollation.new
-        end
-      end
     end
   end
 end

data/lib/mongo/monitoring/event/cmap/pool_cleared.rb

@@ -31,15 +31,18 @@ module Mongo
           # @since 2.9.0
           attr_reader :address
 
+          # @return [ nil | Object ] The service id, if any.
+          attr_reader :service_id
+
           # Create the event.
           #
-          # @example Create the event.
-          #   PoolCleared.new(address)
+          # @param [ Address ] address
+          # @param [ Object ] service_id The service id, if any.
           #
-          # @since 2.9.0
           # @api private
-          def initialize(address)
+          def initialize(address, service_id: nil)
             @address = address
+            @service_id = service_id
           end
 
           # Returns a concise yet useful summary of the event.

data/lib/mongo/monitoring/event/command_failed.rb

@@ -53,6 +53,9 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ Integer ] server_connection_id The server connection id.
+        attr_reader :server_connection_id
+
         # @return [ nil | Object ] The service id, if any.
         attr_reader :service_id
 
@@ -81,18 +84,19 @@ module Mongo
         # @api private
         def initialize(command_name, database_name, address,
           request_id, operation_id, message, failure, duration,
-          started_event:, service_id: nil
+          started_event:, server_connection_id: nil, service_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address
           @request_id = request_id
           @operation_id = operation_id
+          @service_id = service_id
           @message = message
           @started_event = started_event
           @failure = redacted(command_name, failure)
           @duration = duration
-          @service_id = service_id
+          @server_connection_id = server_connection_id
         end
 
         # Returns a concise yet useful summary of the event.
@@ -126,7 +130,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload, message,
-          failure, duration, started_event:, service_id: nil
+          failure, duration, started_event:, server_connection_id: nil,
+          service_id: nil
         )
           new(
             payload[:command_name],
@@ -138,6 +143,7 @@ module Mongo
             failure,
             duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         end

data/lib/mongo/monitoring/event/command_started.rb

@@ -60,7 +60,7 @@ module Mongo
         # @api private
         attr_reader :connection_id
 
-        # @api private
+        # @return [ Integer ] server_connection_id The server connection id.
         attr_reader :server_connection_id
 
         # @return [ true | false ] Whether the event contains sensitive data.
@@ -78,6 +78,7 @@ module Mongo
         # @param [ Integer ] request_id The request id.
         # @param [ Integer ] operation_id The operation id.
         # @param [ BSON::Document ] command The command arguments.
+        # @param [ Object ] service_id The service id, if any.
         #
         # @since 2.1.0
         # @api private
@@ -140,6 +141,7 @@ module Mongo
         # @param [ Server::Address ] address The server address.
         # @param [ Integer ] operation_id The operation id.
         # @param [ Hash ] payload The message payload.
+        # @param [ Object ] service_id The service id, if any.
         #
         # @return [ CommandStarted ] The event.
         #