mongo 2.17.3 → 2.18.0.beta1

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

@@ -41,7 +41,8 @@ module Mongo
         # @option options [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
         # @option options [ Hash ] :collation The collation to use.
-        # @option options [ String ] :comment Associate a comment with the aggregation.
+        # @option options [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         # @option options [ String ] :hint The index to use for the aggregation.
         # @option options [ Hash ] :let Mapping of variables to use in the pipeline.
         #   See the server documentation for details.
@@ -127,7 +128,7 @@ module Mongo
         # @note Set profilingLevel to 2 and the comment will be logged in the profile
         #   collection along with the query.
         #
-        # @param [ String ] comment The comment to be associated with the query.
+        # @param [ Object ] comment The comment to be associated with the query.
         #
         # @return [ String, View ] Either the comment or a
         #   new +View+.
@@ -153,6 +154,8 @@ module Mongo
         # @option opts [ Hash ] :read The read preference options.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Mongo::Session ] :session The session to use for the operation.
+        # @option opts [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         #
         # @return [ Integer ] The document count.
         #
@@ -187,6 +190,7 @@ module Mongo
                 # For some reason collation was historically accepted as a
                 # string key. Note that this isn't documented as valid usage.
                 collation: opts[:collation] || opts['collation'] || collation,
+                comment: opts[:comment],
               ).execute(server, context: Operation::Context.new(client: client, session: session))
             end.n.to_i
           end
@@ -207,6 +211,9 @@ module Mongo
         #   command to run.
         # @option opts [ Hash ] :read The read preference options.
         # @option opts [ Hash ] :collation The collation to use.
+        # @option opts [ Mongo::Session ] :session The session to use for the operation.
+        # @option ops [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         #
         # @return [ Integer ] The document count.
         #
@@ -217,7 +224,7 @@ module Mongo
           pipeline << { :'$limit' => opts[:limit] } if opts[:limit]
           pipeline << { :'$group' => { _id: 1, n: { :'$sum' => 1 } } }
 
-          opts = opts.select { |k, _| [:hint, :max_time_ms, :read, :collation, :session].include?(k) }
+          opts = opts.select { |k, _| [:hint, :max_time_ms, :read, :collation, :session, :comment].include?(k) }
           opts[:collation] ||= collation
 
           first = aggregate(pipeline, opts).first
@@ -235,6 +242,8 @@ module Mongo
         # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the command to
         #   run.
         # @option opts [ Hash ] :read The read preference options.
+        # @option opts [ Object ] :comment A user-provided
+        #   comment to attach to this command.
         #
         # @return [ Integer ] The document count.
         #
@@ -256,35 +265,22 @@ module Mongo
           with_session(opts) do |session|
             read_with_retry(session, selector) do |server|
               context = Operation::Context.new(client: client, session: session)
-              if server.description.server_version_gte?('5.0')
-                pipeline = [
-                  {'$collStats' => {'count' => {}}},
-                  {'$group' => {'_id' => 1, 'n' => {'$sum' => '$count'}}},
-                ]
-                spec = Builder::Aggregation.new(
-                  pipeline,
-                  self,
-                  options.merge(session: session)
-                ).specification
-                result = Operation::Aggregate.new(spec).execute(server, context: context)
-                result.documents.first.fetch('n')
-              else
-                cmd = { count: collection.name }
-                cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
-                if read_concern
-                  cmd[:readConcern] = Options::Mapper.transform_values_to_strings(
-                    read_concern)
+              cmd = { count: collection.name }
+              cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
+              if read_concern
+                cmd[:readConcern] = Options::Mapper.transform_values_to_strings(
+                  read_concern)
                 end
                 result = Operation::Count.new(
                   selector: cmd,
                   db_name: database.name,
                   read: read_pref,
                   session: session,
+                  comment: opts[:comment],
                 ).execute(server, context: context)
                 result.n.to_i
               end
             end
-          end
         rescue Error::OperationFailure => exc
           if exc.code == 26
             # NamespaceNotFound
@@ -702,7 +698,7 @@ module Mongo
             context = Operation::Context.new(
               client: client,
               session: session,
-              service_id: result.connection_description.service_id,
+              connection_global_id: result.connection_global_id,
             )
             result = op.execute(server, context: context)
             Cursor.new(self, result, server, session: session)

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

@@ -50,6 +50,8 @@ module Mongo
         #   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 [ BSON::Document, nil ] The document, if found.
         #
@@ -61,9 +63,6 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -77,21 +76,30 @@ module Mongo
               bypassDocumentValidation: opts[:bypass_document_validation],
               hint: opts[:hint],
               collation: opts[:collation] || opts['collation'] || collation,
-              let: opts[:let]
+              let: opts[:let],
+              comment: opts[:comment],
             }.compact
 
-            write_with_retry(session, write_concern) do |server, txn_num|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::WriteCommand.new(
                 selector: cmd,
                 db_name: database.name,
                 write_concern: write_concern,
                 session: session,
                 txn_num: txn_num,
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+              ).execute_with_connection(connection, context: context)
             end
-          end.first['value']
+          end.first&.fetch('value', nil)
         end
 
+        # db['users'].bulk_write([{insert_one: {x: 1}}, {insert_one: {x: 2}}])
+
         # Finds a single document and replaces it.
         #
         # @example Find a document and replace it, returning the original.
@@ -149,8 +157,10 @@ module Mongo
         #   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 [ BSON::Document ] The document.
+        # @return [ BSON::Document | nil ] The document or nil if none is found.
         #
         # @since 2.0.0
         def find_one_and_update(document, opts = {})
@@ -160,9 +170,6 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -180,18 +187,25 @@ module Mongo
               hint: opts[:hint],
               collation: opts[:collation] || opts['collation'] || collation,
               let: opts[:let],
+              comment: opts[:comment]
             }.compact
 
-            write_with_retry(session, write_concern) do |server, txn_num|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::WriteCommand.new(
                 selector: cmd,
                 db_name: database.name,
                 write_concern: write_concern,
                 session: session,
                 txn_num: txn_num,
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+              ).execute_with_connection(connection, context: context)
             end
-          end.first['value']
+          end.first&.fetch('value', nil)
           value unless value.nil? || value.empty?
         end
 
@@ -210,6 +224,8 @@ module Mongo
         #   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.
         #
@@ -221,9 +237,6 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -234,7 +247,13 @@ module Mongo
               collation: opts[:collation] || opts['collation'] || collation,
             }.compact
 
-            nro_write_with_retry(session, write_concern) do |server|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::Delete.new(
                 deletes: [ delete_doc ],
                 db_name: collection.database.name,
@@ -243,7 +262,8 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 let: opts[:let],
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+                comment: opts[:comment],
+              ).execute_with_connection(connection, context: context)
             end
           end
         end
@@ -263,6 +283,8 @@ module Mongo
         #   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.
         #
@@ -274,9 +296,6 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -287,7 +306,13 @@ module Mongo
               collation: opts[:collation] || opts['collation'] || collation,
             }.compact
 
-            write_with_retry(session, write_concern) do |server, txn_num|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::Delete.new(
                 deletes: [ delete_doc ],
                 db_name: collection.database.name,
@@ -297,7 +322,8 @@ module Mongo
                 session: session,
                 txn_num: txn_num,
                 let: opts[:let],
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+                comment: opts[:comment],
+              ).execute_with_connection(connection, context: context)
             end
           end
         end
@@ -322,6 +348,8 @@ module Mongo
         #   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.
         #
@@ -333,9 +361,7 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
+            validate_replacement_documents!(replacement)
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -350,7 +376,13 @@ module Mongo
               update_doc['upsert'] = true
             end
 
-            write_with_retry(session, write_concern) do |server, txn_num|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::Update.new(
                 updates: [ update_doc ],
                 db_name: collection.database.name,
@@ -359,8 +391,9 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 txn_num: txn_num,
-                let: opts[:let]
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+                let: opts[:let],
+                comment: opts[:comment],
+              ).execute_with_connection(connection, context: context)
             end
           end
         end
@@ -387,6 +420,8 @@ module Mongo
         #   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.
         #
@@ -398,9 +433,7 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
+            validate_update_documents!(spec)
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -416,7 +449,13 @@ module Mongo
               update_doc['upsert'] = true
             end
 
-            nro_write_with_retry(session, write_concern) do |server|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::Update.new(
                 updates: [ update_doc ],
                 db_name: collection.database.name,
@@ -425,7 +464,8 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 let: opts[:let],
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+                comment: opts[:comment],
+              ).execute_with_connection(connection, context: context)
             end
           end
         end
@@ -452,6 +492,8 @@ module Mongo
         #   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.
         #
@@ -463,9 +505,7 @@ module Mongo
             else
               write_concern_with_session(session)
             end
-            if opts[:hint] && write_concern && !write_concern.acknowledged?
-              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
-            end
+            validate_update_documents!(spec)
 
             QueryCache.clear_namespace(collection.namespace)
 
@@ -480,7 +520,13 @@ module Mongo
               update_doc['upsert'] = true
             end
 
-            write_with_retry(session, write_concern) do |server, txn_num|
+            context = Operation::Context.new(client: client, session: session)
+            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?
+                raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+              end
+
               Operation::Update.new(
                 updates: [ update_doc ],
                 db_name: collection.database.name,
@@ -490,7 +536,54 @@ module Mongo
                 session: session,
                 txn_num: txn_num,
                 let: opts[:let],
-              ).execute(server, context: Operation::Context.new(client: client, session: session))
+                comment: opts[:comment],
+              ).execute_with_connection(connection, context: context)
+            end
+          end
+        end
+
+        private
+
+        # Checks the update documents to make sure they only have atomic modifiers.
+        # Note that as per the spec, we only have to examine the first element
+        # in the update document.
+        #
+        # @param [ Hash | Array<Hash> ] spec The update document or pipeline.
+        #
+        # @raise [ Error::InvalidUpdateDocument ] if the first key in the
+        #   document does not start with a $.
+        def validate_update_documents!(spec)
+          if update = spec.is_a?(Array) ? spec&.first : spec
+            if key = update.keys&.first
+              unless key.to_s.start_with?("$")
+                if Mongo.validate_update_replace
+                  raise Error::InvalidUpdateDocument.new(key: key)
+                else
+                  Error::InvalidUpdateDocument.warn(Logger.logger, key)
+                end
+              end
+            end
+          end
+        end
+
+        # Check the replacement documents to make sure they don't have atomic
+        # modifiers. Note that as per the spec, we only have to examine the
+        # first element in the replacement document.
+        #
+        # @param [ Hash | Array<Hash> ] spec The replacement document or pipeline.
+        #
+        # @raise [ Error::InvalidUpdateDocument ] if the first key in the
+        #   document does not start with a $.
+        def validate_replacement_documents!(spec)
+          if replace = spec.is_a?(Array) ? spec&.first : spec
+            if key = replace.keys&.first
+              if key.to_s.start_with?("$")
+                if Mongo.validate_update_replace
+                  raise Error::InvalidReplacementDocument.new(key: key)
+                else
+                  Error::InvalidReplacementDocument.warn(Logger.logger, key)
+                end
+              end
             end
           end
         end