Swift-1384 Support 'let' option for multiple CRUD commands (#715)

Author: nspektor

.swift-version

@@ -1 +1 @@
-5.5.1
+5.5.2

.swiftformat

@@ -43,3 +43,6 @@
 
 # creates non-compiling code on Swift 5.1
 --disable preferKeyPath
+
+# swift version 5.1.5 requires backticks in argument lists. 
+--disable redundantBackticks

Sources/MongoSwift/MongoCollection+FindAndModify.swift

@@ -190,6 +190,10 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.4+.
     public var hint: IndexHint?
 
+    /// Variables that can be accessed within the operation using the double
+    /// dollar sign prefix in the form `$$<variable_name>`. This option is only available on MongoDB 5.0+.
+    public var `let`: BSONDocument?
+
     /// The maximum amount of time to allow the query to run.
     public var maxTimeMS: Int?
 
@@ -206,6 +210,8 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
         try FindAndModifyOptions(
             collation: self.collation,
             hint: self.hint,
+            // swiftlint:disable:next colon
+            `let`: self.let,
             maxTimeMS: self.maxTimeMS,
             projection: self.projection,
             remove: true,
@@ -218,13 +224,15 @@ public struct FindOneAndDeleteOptions: FindAndModifyOptionsConvertible, Decodabl
     public init(
         collation: BSONDocument? = nil,
         hint: IndexHint? = nil,
+        `let`: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
         projection: BSONDocument? = nil,
         sort: BSONDocument? = nil,
         writeConcern: WriteConcern? = nil
     ) {
         self.collation = collation
         self.hint = hint
+        self.let = `let`
         self.maxTimeMS = maxTimeMS
         self.projection = projection
         self.sort = sort
@@ -243,6 +251,10 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.4+.
     public var hint: IndexHint?
 
+    /// Variables that can be accessed within the operation using the double
+    /// dollar sign prefix in the form `$$<variable_name>`. This option is only available on MongoDB 5.0+.
+    public var `let`: BSONDocument?
+
     /// The maximum amount of time to allow the query to run.
     public var maxTimeMS: Int?
 
@@ -266,6 +278,8 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
             bypassDocumentValidation: self.bypassDocumentValidation,
             collation: self.collation,
             hint: self.hint,
+            // swiftlint:disable:next colon
+            `let`: self.let,
             maxTimeMS: self.maxTimeMS,
             projection: self.projection,
             returnDocument: self.returnDocument,
@@ -280,6 +294,7 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
         bypassDocumentValidation: Bool? = nil,
         collation: BSONDocument? = nil,
         hint: IndexHint? = nil,
+        `let`: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
         projection: BSONDocument? = nil,
         returnDocument: ReturnDocument? = nil,
@@ -290,6 +305,7 @@ public struct FindOneAndReplaceOptions: FindAndModifyOptionsConvertible, Decodab
         self.bypassDocumentValidation = bypassDocumentValidation
         self.collation = collation
         self.hint = hint
+        self.let = `let`
         self.maxTimeMS = maxTimeMS
         self.projection = projection
         self.returnDocument = returnDocument
@@ -313,6 +329,10 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
     /// A document or string that specifies the index to use to support the query. Only supported in server 4.4+.
     public var hint: IndexHint?
 
+    /// Variables that can be accessed within the operation using the double
+    /// dollar sign prefix in the form `$$<variable_name>`. This option is only available on MongoDB 5.0+.
+    public var `let`: BSONDocument?
+
     /// The maximum amount of time to allow the query to run.
     public var maxTimeMS: Int?
 
@@ -337,6 +357,8 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
             bypassDocumentValidation: self.bypassDocumentValidation,
             collation: self.collation,
             hint: self.hint,
+            // swiftlint:disable:next colon
+            `let`: self.let,
             maxTimeMS: self.maxTimeMS,
             projection: self.projection,
             returnDocument: self.returnDocument,
@@ -352,6 +374,7 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
         bypassDocumentValidation: Bool? = nil,
         collation: BSONDocument? = nil,
         hint: IndexHint? = nil,
+        `let`: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
         projection: BSONDocument? = nil,
         returnDocument: ReturnDocument? = nil,
@@ -363,6 +386,7 @@ public struct FindOneAndUpdateOptions: FindAndModifyOptionsConvertible, Decodabl
         self.bypassDocumentValidation = bypassDocumentValidation
         self.collation = collation
         self.hint = hint
+        self.let = `let`
         self.maxTimeMS = maxTimeMS
         self.projection = projection
         self.returnDocument = returnDocument

Sources/MongoSwift/Operations/FindAndModifyOperation.swift

@@ -23,6 +23,7 @@ internal class FindAndModifyOptions {
         bypassDocumentValidation: Bool? = nil,
         collation: BSONDocument?,
         hint: IndexHint? = nil,
+        `let`: BSONDocument? = nil,
         maxTimeMS: Int?,
         projection: BSONDocument?,
         remove: Bool? = nil,
@@ -88,6 +89,9 @@ internal class FindAndModifyOptions {
             case let .indexSpec(doc): extra["hint"] = .document(doc)
             }
         }
+        if let lt = `let` {
+            extra["let"] = .document(lt)
+        }
 
         // note: mongoc_find_and_modify_opts_set_max_time_ms() takes in a
         // uint32_t, but it should be a positive 64-bit integer, so we

Sources/MongoSwift/Operations/FindOperation.swift

@@ -88,6 +88,10 @@ public struct FindOptions: Codable {
     /// A hint for the index to use.
     public var hint: IndexHint?
 
+    /// Variables that can be accessed within the operation using the double
+    /// dollar sign prefix in the form `$$<variable_name>`. This option is only available on MongoDB 5.0+.
+    public var `let`: BSONDocument?
+
     /// The maximum number of documents to return.
     public var limit: Int?
 
@@ -147,6 +151,7 @@ public struct FindOptions: Codable {
         comment: String? = nil,
         cursorType: MongoCursorType? = nil,
         hint: IndexHint? = nil,
+        `let`: BSONDocument? = nil,
         limit: Int? = nil,
         max: BSONDocument? = nil,
         maxAwaitTimeMS: Int? = nil,
@@ -168,6 +173,7 @@ public struct FindOptions: Codable {
         self.comment = comment
         self.cursorType = cursorType
         self.hint = hint
+        self.let = `let`
         self.limit = limit
         self.max = max
         self.maxAwaitTimeMS = maxAwaitTimeMS
@@ -188,6 +194,7 @@ public struct FindOptions: Codable {
         self.collation = findOneOptions.collation
         self.comment = findOneOptions.comment
         self.hint = findOneOptions.hint
+        self.let = findOneOptions.let
         self.max = findOneOptions.max
         self.maxTimeMS = findOneOptions.maxTimeMS
         self.min = findOneOptions.min
@@ -203,7 +210,7 @@ public struct FindOptions: Codable {
 
     // Encode everything except `self.readPreference`, because this is sent to libmongoc separately
     internal enum CodingKeys: String, CodingKey, CaseIterable {
-        case allowDiskUse, allowPartialResults, awaitData, batchSize, collation, comment, hint, limit, max,
+        case allowDiskUse, allowPartialResults, awaitData, batchSize, collation, comment, hint, `let`, limit, max,
              maxAwaitTimeMS, maxTimeMS, min, noCursorTimeout, projection, readConcern, returnKey,
              showRecordID = "showRecordId", tailable, skip, sort
     }
@@ -223,6 +230,10 @@ public struct FindOneOptions: Codable {
     /// A hint for the index to use.
     public var hint: IndexHint?
 
+    /// Variables that can be accessed within the operation using the double
+    /// dollar sign prefix in the form `$$<variable_name>`. This option is only available on MongoDB 5.0+.
+    public var `let`: BSONDocument?
+
     /// The exclusive upper bound for a specific index.
     public var max: BSONDocument?
 
@@ -260,6 +271,7 @@ public struct FindOneOptions: Codable {
         collation: BSONDocument? = nil,
         comment: String? = nil,
         hint: IndexHint? = nil,
+        `let`: BSONDocument? = nil,
         max: BSONDocument? = nil,
         maxTimeMS: Int? = nil,
         min: BSONDocument? = nil,
@@ -275,6 +287,7 @@ public struct FindOneOptions: Codable {
         self.collation = collation
         self.comment = comment
         self.hint = hint
+        self.let = `let`
         self.max = max
         self.maxTimeMS = maxTimeMS
         self.min = min

Tests/MongoSwiftSyncTests/CrudTests.swift

@@ -75,9 +75,18 @@ final class CrudTests: MongoSwiftTestCase {
     }
 
     func testCrudUnified() throws {
+        let skipFiles: [String] = [
+            // Skipping because we use bulk-write for these commands and can't pass extra options
+            // TODO: SWIFT-1429 unskip
+            "deleteOne-let.json",
+            "deleteMany-let.json",
+            "updateOne-let.json",
+            "updateMany-let.json"
+        ]
         let files = try retrieveSpecTestFiles(
             specName: "crud",
             subdirectory: "unified",
+            excludeFiles: skipFiles,
             asType: UnifiedTestFile.self
         )
         let runner = try UnifiedTestRunner()