mongo 2.13.0 → 2.15.0.alpha

data/lib/mongo/error/parser.rb

@@ -42,28 +42,53 @@ module Mongo
     # Class for parsing the various forms that errors can come in from MongoDB
     # command responses.
     #
+    # The errors can be reported by the server in a number of ways:
+    # - {ok:0} response indicates failure. In newer servers, code, codeName
+    #   and errmsg fields should be set. In older servers some may not be set.
+    # - {ok:1} response with a write concern error (writeConcernError top-level
+    #   field). This indicates that the node responding successfully executed
+    #   the request, but not enough other nodes successfully executed the
+    #   request to satisfy the write concern.
+    # - {ok:1} response with writeErrors top-level field. This can be obtained
+    #   in a bulk write but also in a non-bulk write. In a non-bulk write
+    #   there should be exactly one error in the writeErrors list.
+    #   The case of multiple errors is handled by BulkWrite::Result.
+    # - {ok:1} response with writeConcernErrors top-level field. This can
+    #   only be obtained in a bulk write and is handled by BulkWrite::Result,
+    #   not by this class.
+    #
+    # Note that writeErrors do not have codeName fields - they just provide
+    # codes and messages. writeConcernErrors may similarly not provide code
+    # names.
+    #
     # @since 2.0.0
+    # @api private
     class Parser
       include SdamErrorDetection
 
-      # @return [ BSON::Document ] document The returned document.
+      # @return [ BSON::Document ] The returned document.
       attr_reader :document
 
-      # @return [ String ] message The error message parsed from the document.
+      # @return [ String ] The full error message to be used in the
+      #   raised exception.
       attr_reader :message
 
-      # @return [ Array<Protocol::Message> ] replies The message replies.
+      # @return [ String ] The server-returned error message
+      #   parsed from the response.
+      attr_reader :server_message
+
+      # @return [ Array<Protocol::Message> ] The message replies.
       attr_reader :replies
 
-      # @return [ Integer ] code The error code parsed from the document.
+      # @return [ Integer ] The error code parsed from the document.
       # @since 2.6.0
       attr_reader :code
 
-      # @return [ String ] code_name The error code name parsed from the document.
+      # @return [ String ] The error code name parsed from the document.
       # @since 2.6.0
       attr_reader :code_name
 
-      # @return [ Array<String> ] labels The set of labels associated with the error.
+      # @return [ Array<String> ] The set of labels associated with the error.
       # @since 2.7.0
       attr_reader :labels
 
@@ -145,33 +170,61 @@ module Mongo
         write_concern_error_document && write_concern_error_document['errorLabels']
       end
 
+      class << self
+        def build_message(code: nil, code_name: nil, message: nil)
+          if code_name && code
+            "[#{code}:#{code_name}]: #{message}"
+          elsif code_name
+            # This surely should never happen, if there's a code name
+            # there ought to also be the code provided.
+            # Handle this case for completeness.
+            "[#{code_name}]: #{message}"
+          elsif code
+            "[#{code}]: #{message}"
+          else
+            message
+          end
+        end
+      end
+
       private
 
       def parse!
+        if document['ok'] != 1 && document['writeErrors']
+          raise ArgumentError, "writeErrors should only be given in successful responses"
+        end
+
         @message = ""
-        parse_single(@message, ERR)
-        parse_single(@message, ERROR)
-        parse_single(@message, ERRMSG)
+        parse_single(@message, '$err')
+        parse_single(@message, 'err')
+        parse_single(@message, 'errmsg')
         parse_multiple(@message, 'writeErrors')
         if write_concern_error_document
-          parse_single(@message, ERRMSG, write_concern_error_document)
+          parse_single(@message, 'errmsg', write_concern_error_document)
         end
         parse_flag(@message)
         parse_code
         parse_labels
         parse_wtimeout
+
+        @server_message = @message
+        @message = self.class.build_message(
+          code: code,
+          code_name: code_name,
+          message: @message,
+        )
       end
 
       def parse_single(message, key, doc = document)
         if error = doc[key]
-          append(message ,"#{error} (#{doc[CODE]})")
+          append(message, error)
         end
       end
 
       def parse_multiple(message, key)
         if errors = document[key]
           errors.each do |error|
-            parse_single(message, ERRMSG, error)
+            parse_single(message, 'errmsg', error)
           end
         end
       end

data/lib/mongo/error/server_api_conflict.rb

@@ -0,0 +1,23 @@
+# 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 when a Client has :server_api configured and an
+    # operation attempts to specify any of server API version parameters.
+    class ServerApiConflict < Error
+    end
+  end
+end

data/lib/mongo/error/server_api_not_supported.rb

@@ -0,0 +1,24 @@
+# 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 when a Client has :server_api configured and an
+    # operation is executed against a pre-3.6 MongoDB server using a legacy
+    # wire protocol message that does not permit sending API parameters.
+    class ServerApiNotSupported < Error
+    end
+  end
+end

data/lib/mongo/error/server_certificate_revoked.rb

@@ -0,0 +1,22 @@
+# Copyright (C) 2020 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
+
+    # Server certificate has been revoked (determined via OCSP).
+    class ServerCertificateRevoked < Error
+    end
+  end
+end

data/lib/mongo/error/unmet_dependency.rb

@@ -0,0 +1,21 @@
+# Copyright (C) 2020 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
+
+    # Raised if an optional dependency of the driver is not met.
+    class UnmetDependency < Error; end
+  end
+end

data/lib/mongo/error/unsupported_option.rb

@@ -17,39 +17,39 @@ module Mongo
 
     # Raised if an unsupported option is specified for an operation.
     class UnsupportedOption < Error
-      # @api private
-      #
       # The error message provided when the user passes the hint option to
       # a write operation against a server that does not support the hint
       # option and does not provide option validation.
+      #
+      # @api private
       HINT_MESSAGE = "The MongoDB server handling this request does not support " \
         "the hint option on this command. The hint option is supported on update " \
         "commands on MongoDB server versions 4.2 and later and on findAndModify " \
         "and delete commands on MongoDB server versions 4.4 and later"
 
-      # @api private
-      #
       # The error message provided when the user passes the hint option to
       # an unacknowledged write operation.
+      #
+      # @api private
       UNACKNOWLEDGED_HINT_MESSAGE = "The hint option cannot be specified on " \
         "an unacknowledged write operation. Remove the hint option or perform " \
         "this operation with a write concern of at least { w: 1 }"
 
-      # @api private
-      #
       # The error message provided when the user passes the allow_disk_use
       # option to a find operation against a server that does not support the
       # allow_disk_use operation and does not provide option validation.
+      #
+      # @api private
       ALLOW_DISK_USE_MESSAGE = "The MongoDB server handling this request does " \
         "not support the allow_disk_use option on this command. The " \
         "allow_disk_use option is supported on find commands on MongoDB " \
         "server versions 4.4 and later"
 
-      # @api private
-      #
       # The error message provided when the user passes the commit_quorum option
       # to a createIndexes operation against a server that does not support
       # that option.
+      #
+      # @api private
       COMMIT_QUORUM_MESSAGE = "The MongoDB server handling this request does " \
         "not support the commit_quorum option on this command. The commit_quorum " \
         "option is supported on createIndexes commands on MongoDB server versions " \
@@ -57,14 +57,14 @@ module Mongo
 
       # Raise an error about an unsupported hint option.
       #
-      # @param [ Hash ] options
-      #
       # @option options [ Boolean ] unacknowledged_write Whether this error
       #   pertains to a hint option passed to an unacknowledged write. Defaults
       #   to false.
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.hint_error(**options)
         unacknowledged_write = options[:unacknowledged_write] || false
 
@@ -79,10 +79,10 @@ module Mongo
 
       # Raise an error about an unsupported allow_disk_use option.
       #
-      # @param [ Hash ] options
-      #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.allow_disk_use_error
         new(ALLOW_DISK_USE_MESSAGE)
       end
@@ -91,6 +91,8 @@ module Mongo
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.commit_quorum_error
         new(COMMIT_QUORUM_MESSAGE)
       end

data/lib/mongo/grid/fs_bucket.rb

@@ -36,6 +36,43 @@ module Mongo
       # @since 2.1.0
       FILES_INDEX = { filename: 1, uploadDate: 1 }.freeze
 
+      # Create the GridFS.
+      #
+      # @example Create the GridFS.
+      #   Grid::FSBucket.new(database)
+      #
+      # @param [ Database ] database The database the files reside in.
+      # @param [ Hash ] options The GridFS options.
+      #
+      # @option options [ String ] :bucket_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ Integer ] :chunk_size Override the default chunk
+      #   size.
+      # @option options [ String ] :fs_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ String ] :read The read preference.
+      # @option options [ Session ] :session The session to use.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+      #
+      # @since 2.0.0
+      def initialize(database, options = {})
+        @database = database
+        @options = options.dup
+=begin WriteConcern object support
+        if @options[:write_concern].is_a?(WriteConcern::Base)
+          # Cache the instance so that we do not needlessly reconstruct it.
+          @write_concern = @options[:write_concern]
+          @options[:write_concern] = @write_concern.options
+        end
+=end
+        @options.freeze
+        @chunks_collection = database[chunks_name]
+        @files_collection = database[files_name]
+      end
+
       # @return [ Collection ] chunks_collection The chunks collection.
       #
       # @since 2.0.0
@@ -133,43 +170,6 @@ module Mongo
         file.id
       end
 
-      # Create the GridFS.
-      #
-      # @example Create the GridFS.
-      #   Grid::FSBucket.new(database)
-      #
-      # @param [ Database ] database The database the files reside in.
-      # @param [ Hash ] options The GridFS options.
-      #
-      # @option options [ String ] :fs_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ String ] :bucket_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ Integer ] :chunk_size Override the default chunk
-      #   size.
-      # @option options [ String ] :read The read preference.
-      # @option options [ Session ] :session The session to use.
-      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
-      #   option.
-      # @option options [ Hash ] :write_concern The write concern options.
-      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
-      #
-      # @since 2.0.0
-      def initialize(database, options = {})
-        @database = database
-        @options = options.dup
-=begin WriteConcern object support
-        if @options[:write_concern].is_a?(WriteConcern::Base)
-          # Cache the instance so that we do not needlessly reconstruct it.
-          @write_concern = @options[:write_concern]
-          @options[:write_concern] = @write_concern.options
-        end
-=end
-        @options.freeze
-        @chunks_collection = database[chunks_name]
-        @files_collection = database[files_name]
-      end
-
       # Get the prefix for the GridFS
       #
       # @example Get the prefix.

data/lib/mongo/index/view.rb

@@ -127,6 +127,7 @@ module Mongo
       #   data-bearing members of a replica set, including the primary, must
       #   complete the index builds successfully before the primary marks
       #   the indexes as ready.
+      # @option options [ Session ] :session The session to use for the operation.
       #
       # @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.
@@ -137,7 +138,15 @@ module Mongo
       def create_one(keys, options = {})
         options = options.dup
 
-        create_options = { commit_quorum: options.delete(:commit_quorum) }
+        create_options = {}
+        if session = @options[:session]
+          create_options[:session] = session
+        end
+        %i(commit_quorum session).each do |key|
+          if value = options.delete(key)
+            create_options[key] = value
+          end
+        end
         create_many({ key: keys }.merge(options), create_options)
       end
 
@@ -166,19 +175,20 @@ module Mongo
       #   - 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.
+      #   - session: The session to use.
       #
       # @return [ Result ] The result of the command.
       #
       # @since 2.0.0
       def create_many(*models)
-        client.send(:with_session, @options) do |session|
-          server = next_primary(nil, session)
+        models = models.flatten
+        options = {}
+        if models && !models.last.key?(:key)
+          options = models.pop
+        end
 
-          models = models.flatten
-          options = {}
-          if models && !models.last.key?(:key)
-            options = models.pop
-          end
+        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
@@ -208,7 +218,7 @@ module Mongo
 
           spec[:write_concern] = write_concern if description.features.collation_enabled?
 
-          Operation::CreateIndex.new(spec).execute(server, client: client)
+          Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
 
@@ -286,7 +296,7 @@ module Mongo
                  }
           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, client: client)
+          Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
 
@@ -322,7 +332,7 @@ module Mongo
       end
 
       def send_initial_query(server, session)
-        initial_query_op(session).execute(server, client: client)
+        initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
       end
 
       def with_generated_names(models, server)