SWIFT-772: Add 'allowDiskUse' option to find command

Author: nbbeeken

Sources/MongoSwift/Operations/AggregateOperation.swift

@@ -3,7 +3,7 @@ import Foundation
 
 /// Options to use when executing an `aggregate` command on a `MongoCollection`.
 public struct AggregateOptions: Codable {
-    /// Enables writing to temporary files. When set to true, aggregation stages
+    /// Enables the server to write to temporary files. When set to true, the aggregate operation
     /// can write data to the _tmp subdirectory in the dbPath directory.
     public var allowDiskUse: Bool?
 

Sources/MongoSwift/Operations/FindOperation.swift

@@ -32,6 +32,10 @@ public enum CursorType {
 
 /// Options to use when executing a `find` command on a `MongoCollection`.
 public struct FindOptions: Codable {
+    /// Enables the server to write to temporary files. When set to true, the find operation
+    /// can write data to the _tmp subdirectory in the dbPath directory.
+    public var allowDiskUse: Bool?
+
     /// Get partial results from a mongos if some shards are down (instead of throwing an error).
     public var allowPartialResults: Bool?
 
@@ -130,6 +134,7 @@ public struct FindOptions: Codable {
 
     /// Convenience initializer allowing any/all parameters to be omitted or optional.
     public init(
+        allowDiskUse: Bool? = nil,
         allowPartialResults: Bool? = nil,
         batchSize: Int32? = nil,
         collation: Document? = nil,
@@ -150,6 +155,7 @@ public struct FindOptions: Codable {
         skip: Int64? = nil,
         sort: Document? = nil
     ) {
+        self.allowDiskUse = allowDiskUse
         self.allowPartialResults = allowPartialResults
         self.batchSize = batchSize
         self.collation = collation
@@ -191,9 +197,9 @@ public struct FindOptions: Codable {
 
     // Encode everything except `self.readPreference`, because this is sent to libmongoc separately
     private enum CodingKeys: String, CodingKey {
-        case allowPartialResults, awaitData, batchSize, collation, comment, hint, limit, max, maxAwaitTimeMS,
-            maxTimeMS, min, noCursorTimeout, projection, readConcern, returnKey, showRecordId, tailable, skip,
-            sort
+        case allowDiskUse, allowPartialResults, awaitData, batchSize, collation, comment, hint, limit, max,
+            maxAwaitTimeMS, maxTimeMS, min, noCursorTimeout, projection, readConcern, returnKey, showRecordId,
+            tailable, skip, sort
     }
 }
 

Tests/LinuxMain.swift

@@ -227,6 +227,12 @@ extension MongoCollection_IndexTests {
     ]
 }
 
+extension MongoCrudV2Tests {
+    static var allTests = [
+        ("testFindOptionsAllowDiskUse", testFindOptionsAllowDiskUse),
+    ]
+}
+
 extension MongoCursorTests {
     static var allTests = [
         ("testNonTailableCursor", testNonTailableCursor),
@@ -399,6 +405,7 @@ XCTMain([
     testCase(MongoCollectionTests.allTests),
     testCase(MongoCollection_BulkWriteTests.allTests),
     testCase(MongoCollection_IndexTests.allTests),
+    testCase(MongoCrudV2Tests.allTests),
     testCase(MongoCursorTests.allTests),
     testCase(MongoDatabaseTests.allTests),
     testCase(OptionsTests.allTests),

Tests/MongoSwiftSyncTests/CrudV2Tests.swift

@@ -0,0 +1,47 @@
+import Foundation
+import MongoSwiftSync
+import Nimble
+import TestsCommon
+import XCTest
+
+// TODO: remove with SWIFT-780
+/// A place for CrudV2 Tests until the swift crud v2 runner is shipped
+final class MongoCrudV2Tests: MongoSwiftTestCase {
+    func testFindOptionsAllowDiskUse() throws {
+        try self.withTestNamespace { client, _, coll in
+            guard try client.serverVersion() >= ServerVersion(major: 4, minor: 3, patch: 5) else {
+                print("Skipping test; MongoDB 4.3.5+ feature")
+                return
+            }
+
+            let monitor = client.addCommandMonitor()
+            try coll.insertOne(["dog": "notCat"])
+
+            try monitor.captureEvents {
+                let optionAllowDiskUseNil = FindOptions()
+                expect(try coll.find(["dog": "notCat"], options: optionAllowDiskUseNil)).toNot(throwError())
+
+                let optionAllowDiskUseFalse = FindOptions(allowDiskUse: false)
+                expect(try coll.find(["dog": "notCat"], options: optionAllowDiskUseFalse)).toNot(throwError())
+
+                let optionAllowDiskUseTrue = FindOptions(allowDiskUse: true)
+                expect(try coll.find(["dog": "notCat"], options: optionAllowDiskUseTrue)).toNot(throwError())
+            }
+
+            let events = monitor.commandStartedEvents()
+            expect(events).to(haveCount(3))
+
+            let eventAllowDiskUseNil = events[0]
+            expect(eventAllowDiskUseNil.command["find"]).toNot(beNil())
+            expect(eventAllowDiskUseNil.command["allowDiskUse"]).to(beNil())
+
+            let eventAllowDiskUseFalse = events[1]
+            expect(eventAllowDiskUseFalse.command["find"]).toNot(beNil())
+            expect(eventAllowDiskUseFalse.command["allowDiskUse"]?.boolValue).to(beFalse())
+
+            let eventAllowDiskUseTrue = events[2]
+            expect(eventAllowDiskUseTrue.command["find"]).toNot(beNil())
+            expect(eventAllowDiskUseTrue.command["allowDiskUse"]?.boolValue).to(beTrue())
+        }
+    }
+}