SWIFT-1385 Add support for the comment field to all helpers/options (#760)

Author: rchhaya

Sources/MongoSwift/AsyncAwait/MongoCollection+Indexes+AsyncAwait.swift

@@ -181,28 +181,36 @@ extension MongoCollection {
      * Retrieves a list of the indexes currently on this collection.
      *
      * - Parameters:
+     *   - options: Optional `ListIndexesOptions` to use for the command
      *   - session: Optional `ClientSession` to use when executing this command.
      *
      * - Returns: A `MongoCursor` over the `IndexModel`s.
      *
      * - Throws: `MongoError.LogicError` if the provided session is inactive.
      */
-    public func listIndexes(session: ClientSession? = nil) async throws -> MongoCursor<IndexModel> {
-        try await self.listIndexes(session: session).get()
+    public func listIndexes(
+        options: ListIndexesOptions? = nil,
+        session: ClientSession? = nil
+    ) async throws -> MongoCursor<IndexModel> {
+        try await self.listIndexes(options: options, session: session).get()
     }
 
     /**
      * Retrieves a list of names of the indexes currently on this collection.
      *
      * - Parameters:
+     *   - options: Optional `ListIndexesOptions` to use for the command
      *   - session: Optional `ClientSession` to use when executing this command.
      *
      * - Returns: A `MongoCursor` over the index names.
      *
      * - Throws: `MongoError.LogicError` if the provided session is inactive.
      */
-    public func listIndexNames(session: ClientSession? = nil) async throws -> [String] {
-        try await self.listIndexNames(session: session).get()
+    public func listIndexNames(
+        options: ListIndexesOptions? = nil,
+        session: ClientSession? = nil
+    ) async throws -> [String] {
+        try await self.listIndexNames(options: options, session: session).get()
     }
 }
 #endif

Sources/MongoSwift/ChangeStreamOptions.swift

@@ -26,6 +26,12 @@ public struct ChangeStreamOptions: Codable {
     /// - SeeAlso: https://docs.mongodb.com/manual/reference/command/aggregate
     public var collation: BSONDocument?
 
+    /// A comment to help trace the operation through the database profiler,
+    /// currentOp and logs. Can be any valid BSON type for server versions
+    /// 4.4 and above but older server versions only support string comments
+    /// (non-string types cause server-side errors). The default is to not send a value.
+    public var comment: BSON?
+
     /**
      * Indicates how the `fullDocument` field of a change stream document should be filled out by the server.
      * By default (indicated by a nil value for this option), the `fullDocument` field in the change stream document
@@ -66,6 +72,7 @@ public struct ChangeStreamOptions: Codable {
     public init(
         batchSize: Int? = nil,
         collation: BSONDocument? = nil,
+        comment: BSON? = nil,
         fullDocument: FullDocument? = nil,
         maxAwaitTimeMS: Int? = nil,
         resumeAfter: ResumeToken? = nil,
@@ -74,6 +81,7 @@ public struct ChangeStreamOptions: Codable {
     ) {
         self.batchSize = batchSize
         self.collation = collation
+        self.comment = comment
         self.fullDocument = fullDocument
         self.maxAwaitTimeMS = maxAwaitTimeMS
         self.resumeAfter = resumeAfter

Sources/MongoSwift/MongoCollection+BulkWrite.swift

@@ -165,7 +165,10 @@ public struct DeleteModelOptions: Codable {
     public var hint: IndexHint?
 
     /// Initializer allowing any/all options to be omitted or optional.
-    public init(collation: BSONDocument? = nil, hint: IndexHint? = nil) {
+    public init(
+        collation: BSONDocument? = nil,
+        hint: IndexHint? = nil
+    ) {
         self.collation = collation
         self.hint = hint
     }
@@ -175,13 +178,19 @@ public struct DeleteModelOptions: Codable {
 public struct ReplaceOneModelOptions: Codable {
     /// The collation to use.
     public var collation: BSONDocument?
+
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.2+.
     public var hint: IndexHint?
+
     /// When `true`, creates a new document if no document matches the query.
     public var upsert: Bool?
 
     /// Initializer allowing any/all options to be omitted or optional.
-    public init(collation: BSONDocument? = nil, hint: IndexHint? = nil, upsert: Bool? = nil) {
+    public init(
+        collation: BSONDocument? = nil,
+        hint: IndexHint? = nil,
+        upsert: Bool? = nil
+    ) {
         self.collation = collation
         self.hint = hint
         self.upsert = upsert
@@ -194,6 +203,7 @@ public struct UpdateModelOptions: Codable {
     public var arrayFilters: [BSONDocument]?
     /// The collation to use.
     public var collation: BSONDocument?
+
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.2+.
     public var hint: IndexHint?
     /// When `true`, creates a new document if no document matches the query.
@@ -307,6 +317,12 @@ public struct BulkWriteOptions: Codable {
     /// If `true`, allows the write to opt-out of document level validation.
     public var bypassDocumentValidation: Bool?
 
+    /// A comment to help trace the operation through the database profiler,
+    /// currentOp and logs. Can be any valid BSON type for server versions
+    /// 4.4 and above but older server versions only support string comments
+    /// (non-string types cause server-side errors). The default is to not send a value.
+    public var comment: BSON?
+
     /**
      * If `true` (the default), operations will be executed serially in order
      * and a write error will abort execution of the entire bulk write. If
@@ -320,8 +336,14 @@ public struct BulkWriteOptions: Codable {
     public var writeConcern: WriteConcern?
 
     /// Convenience initializer allowing any/all parameters to be omitted or optional
-    public init(bypassDocumentValidation: Bool? = nil, ordered: Bool? = nil, writeConcern: WriteConcern? = nil) {
+    public init(
+        bypassDocumentValidation: Bool? = nil,
+        comment: BSON? = nil,
+        ordered: Bool? = nil,
+        writeConcern: WriteConcern? = nil
+    ) {
         self.bypassDocumentValidation = bypassDocumentValidation
+        self.comment = comment
         self.ordered = ordered ?? true
         self.writeConcern = writeConcern
     }
@@ -333,18 +355,20 @@ public struct BulkWriteOptions: Codable {
         }
 
         self.bypassDocumentValidation = options.bypassDocumentValidation
+        self.comment = options.comment
         self.ordered = options.ordered
         self.writeConcern = options.writeConcern
     }
 
     private enum CodingKeys: String, CodingKey {
-        case bypassDocumentValidation, ordered, writeConcern
+        case bypassDocumentValidation, comment, ordered, writeConcern
     }
 
     // A manual implementation is required to enforce a default value for ordered without making it optional.
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         self.bypassDocumentValidation = try container.decodeIfPresent(Bool.self, forKey: .bypassDocumentValidation)
+        self.comment = try container.decodeIfPresent(BSON.self, forKey: .comment)
         self.ordered = try container.decodeIfPresent(Bool.self, forKey: .ordered) ?? true
         self.writeConcern = try container.decodeIfPresent(WriteConcern.self, forKey: .writeConcern)
     }

Sources/MongoSwift/MongoCollection+FindAndModify.swift

@@ -187,6 +187,12 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
     /// Specifies a collation to use.
     public var collation: BSONDocument?
 
+    /// A comment to help trace the operation through the database profiler,
+    /// currentOp and logs. Can be any valid BSON type for server versions
+    /// 4.4 and above but older server versions only support string comments
+    /// (non-string types cause server-side errors). The default is to not send a value.
+    public var comment: BSON?
+
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.4+.
     public var hint: IndexHint?
 
@@ -209,6 +215,7 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
     internal func toFindAndModifyOptions() throws -> FindAndModifyOptions {
         try FindAndModifyOptions(
             collation: self.collation,
+            comment: self.comment,
             hint: self.hint,
             letValue: self.let,
             maxTimeMS: self.maxTimeMS,
@@ -222,6 +229,7 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
     /// Convenience initializer allowing any/all parameters to be omitted/optional
     public init(
         collation: BSONDocument? = nil,
+        comment: BSON? = nil,
         hint: IndexHint? = nil,
         `let`: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
@@ -230,6 +238,7 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
         writeConcern: WriteConcern? = nil
     ) {
         self.collation = collation
+        self.comment = comment
         self.hint = hint
         self.let = `let`
         self.maxTimeMS = maxTimeMS
@@ -247,6 +256,12 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
     /// Specifies a collation to use.
     public var collation: BSONDocument?
 
+    /// A comment to help trace the operation through the database profiler,
+    /// currentOp and logs. Can be any valid BSON type for server versions
+    /// 4.4 and above but older server versions only support string comments
+    /// (non-string types cause server-side errors). The default is to not send a value.
+    public var comment: BSON?
+
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.4+.
     public var hint: IndexHint?
 
@@ -276,6 +291,7 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
         try FindAndModifyOptions(
             bypassDocumentValidation: self.bypassDocumentValidation,
             collation: self.collation,
+            comment: self.comment,
             hint: self.hint,
             letValue: self.let,
             maxTimeMS: self.maxTimeMS,
@@ -291,6 +307,7 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
     public init(
         bypassDocumentValidation: Bool? = nil,
         collation: BSONDocument? = nil,
+        comment: BSON? = nil,
         hint: IndexHint? = nil,
         `let`: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
@@ -302,6 +319,7 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
     ) {
         self.bypassDocumentValidation = bypassDocumentValidation
         self.collation = collation
+        self.comment = comment
         self.hint = hint
         self.let = `let`
         self.maxTimeMS = maxTimeMS
@@ -324,6 +342,12 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
     /// Specifies a collation to use.
     public var collation: BSONDocument?
 
+    /// A comment to help trace the operation through the database profiler,
+    /// currentOp and logs. Can be any valid BSON type for server versions
+    /// 4.4 and above but older server versions only support string comments
+    /// (non-string types cause server-side errors). The default is to not send a value.
+    public var comment: BSON?
+
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.4+.
     public var hint: IndexHint?
 
@@ -354,6 +378,7 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
             arrayFilters: self.arrayFilters,
             bypassDocumentValidation: self.bypassDocumentValidation,
             collation: self.collation,
+            comment: self.comment,
             hint: self.hint,
             letValue: self.let,
             maxTimeMS: self.maxTimeMS,
@@ -370,6 +395,7 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
         arrayFilters: [BSONDocument]? = nil,
         bypassDocumentValidation: Bool? = nil,
         collation: BSONDocument? = nil,
+        comment: BSON? = nil,
         hint: IndexHint? = nil,
         `let`: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
@@ -382,6 +408,7 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
         self.arrayFilters = arrayFilters
         self.bypassDocumentValidation = bypassDocumentValidation
         self.collation = collation
+        self.comment = comment
         self.hint = hint
         self.let = `let`
         self.maxTimeMS = maxTimeMS

Sources/MongoSwift/MongoCollection+Indexes.swift

@@ -415,6 +415,7 @@ extension MongoCollection {
      * Retrieves a list of the indexes currently on this collection.
      *
      * - Parameters:
+     *   - options: Optional `ListIndexesOptions` to use for the command
      *   - session: Optional `ClientSession` to use when executing this command
      *
      * - Warning:
@@ -428,8 +429,11 @@ extension MongoCollection {
      *    - `MongoError.LogicError` if the provided session is inactive.
      *    - `MongoError.LogicError` if this collection's parent client has already been closed.
      */
-    public func listIndexes(session: ClientSession? = nil) -> EventLoopFuture<MongoCursor<IndexModel>> {
-        let operation = ListIndexesOperation(collection: self, nameOnly: false)
+    public func listIndexes(
+        options: ListIndexesOptions? = nil,
+        session: ClientSession? = nil
+    ) -> EventLoopFuture<MongoCursor<IndexModel>> {
+        let operation = ListIndexesOperation(collection: self, nameOnly: false, options: options)
         return self._client.operationExecutor.execute(
             operation,
             client: self._client,
@@ -448,6 +452,7 @@ extension MongoCollection {
      * Retrieves a list of names of the indexes currently on this collection.
      *
      * - Parameters:
+     *   - options: Optional `ListIndexesOptions` to use for the command
      *   - session: Optional `ClientSession` to use when executing this command
      *
      * - Returns:
@@ -457,8 +462,11 @@ extension MongoCollection {
      *    - `MongoError.LogicError` if the provided session is inactive.
      *    - `MongoError.LogicError` if this collection's parent client has already been closed.
      */
-    public func listIndexNames(session: ClientSession? = nil) -> EventLoopFuture<[String]> {
-        let operation = ListIndexesOperation(collection: self, nameOnly: true)
+    public func listIndexNames(
+        options: ListIndexesOptions? = nil,
+        session: ClientSession? = nil
+    ) -> EventLoopFuture<[String]> {
+        let operation = ListIndexesOperation(collection: self, nameOnly: true, options: options)
         return self._client.operationExecutor.execute(
             operation,
             client: self._client,