SWIFT-1108 Add options for time series collections (#681)

Author: isabelatkinson

Sources/MongoSwift/Operations/CreateCollectionOperation.swift

@@ -21,6 +21,9 @@ public struct CreateCollectionOptions: Codable, CodingStrategyProvider {
     /// decoded using this strategy.
     public var dateCodingStrategy: DateCodingStrategy? = nil
 
+    /// Number of seconds after which old time series data should be deleted.
+    public var expireAfterSeconds: Int?
+
     /// Specify a default configuration for indexes created on this collection.
     public var indexOptionDefaults: BSONDocument?
 
@@ -37,6 +40,9 @@ public struct CreateCollectionOptions: Codable, CodingStrategyProvider {
     /// Specifies storage engine configuration for this collection.
     public var storageEngine: BSONDocument?
 
+    /// The options used for creating a time series collection. This feature is only available on MongoDB 5.0+.
+    public var timeseries: TimeseriesOptions?
+
     /// Specifies the `UUIDCodingStrategy` to use for BSON encoding/decoding operations performed by this collection.
     /// It is the responsibility of the user to ensure that any `UUID`s already stored in this collection can be
     /// decoded using this strategy.
@@ -63,7 +69,7 @@ public struct CreateCollectionOptions: Codable, CodingStrategyProvider {
 
     private enum CodingKeys: String, CodingKey {
         case capped, size, max, storageEngine, validator, validationLevel, validationAction,
-             indexOptionDefaults, viewOn, pipeline, collation, writeConcern
+             indexOptionDefaults, viewOn, pipeline, collation, writeConcern, timeseries, expireAfterSeconds
     }
 
     /// Convenience initializer allowing any/all parameters to be omitted or optional.
@@ -72,11 +78,13 @@ public struct CreateCollectionOptions: Codable, CodingStrategyProvider {
         collation: BSONDocument? = nil,
         dataCodingStrategy: DataCodingStrategy? = nil,
         dateCodingStrategy: DateCodingStrategy? = nil,
+        expireAfterSeconds: Int? = nil,
         indexOptionDefaults: BSONDocument? = nil,
         max: Int? = nil,
         pipeline: [BSONDocument]? = nil,
         size: Int? = nil,
         storageEngine: BSONDocument? = nil,
+        timeseries: TimeseriesOptions? = nil,
         uuidCodingStrategy: UUIDCodingStrategy? = nil,
         validationAction: String? = nil,
         validationLevel: String? = nil,
@@ -99,6 +107,45 @@ public struct CreateCollectionOptions: Codable, CodingStrategyProvider {
         self.validator = validator
         self.viewOn = viewOn
         self.writeConcern = writeConcern
+        self.timeseries = timeseries
+        self.expireAfterSeconds = expireAfterSeconds
+    }
+}
+
+/// The options to use when creating a time series collection.
+public struct TimeseriesOptions: Codable {
+    /// Name of the top-level field to be used for time. Inserted documents must have this field, and the field must
+    /// be of the BSON UTC datetime type.
+    public var timeField: String
+
+    /// Name of the top-level field describing the series. This field is used to group related data and may be of any
+    /// BSON type except array. This name must not be the same as the `timeField` or `_id`.
+    public var metaField: String?
+
+    /// The units used to describe the expected interval between subsequent measurements for a time series
+    /// collection. Defaults to `Granularity.seconds` if unset.
+    public var granularity: Granularity?
+
+    /// The units used to describe the expected interval between subsequent measurements for a time series collection.
+    public struct Granularity: RawRepresentable, Codable {
+        public static let seconds = Granularity("seconds")
+        public static let minutes = Granularity("minutes")
+        public static let hours = Granularity("hours")
+
+        /// For an unknown value. For forwards compatibility, no error will be thrown when an unknown value is
+        /// provided.
+        public static func other(_ value: String) -> Granularity {
+            Granularity(value)
+        }
+
+        public var rawValue: String
+
+        public init?(rawValue: String) { self.rawValue = rawValue }
+        internal init(_ value: String) { self.rawValue = value }
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case timeField, metaField, granularity
     }
 }
 

Sources/MongoSwiftSync/Exports.swift

@@ -1,4 +1,4 @@
-// Generated using Sourcery 1.3.4 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 1.6.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 // Re-export the BSON library
@@ -76,6 +76,7 @@
 @_exported import struct MongoSwift.ServerHeartbeatStartedEvent
 @_exported import struct MongoSwift.ServerHeartbeatSucceededEvent
 @_exported import struct MongoSwift.ServerOpeningEvent
+@_exported import struct MongoSwift.TimeseriesOptions
 @_exported import struct MongoSwift.TopologyClosedEvent
 @_exported import struct MongoSwift.TopologyDescription
 @_exported import struct MongoSwift.TopologyDescriptionChangedEvent

Tests/LinuxMain.swift

@@ -1,4 +1,4 @@
-// Generated using Sourcery 1.3.4 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 1.6.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 @testable import BSONTests
@@ -234,6 +234,7 @@ extension MongoDatabaseTests {
         ("testMongoDatabase", testMongoDatabase),
         ("testDropDatabase", testDropDatabase),
         ("testCreateCollection", testCreateCollection),
+        ("testCreateCollectionUnified", testCreateCollectionUnified),
         ("testListCollections", testListCollections),
         ("testListCollectionsBatchSize", testListCollectionsBatchSize),
         ("testAggregate", testAggregate),

Tests/MongoSwiftSyncTests/MongoDatabaseTests.swift

@@ -138,6 +138,16 @@ final class MongoDatabaseTests: MongoSwiftTestCase {
         expect(collectionInfo[1]).to(equal(expectedView))
     }
 
+    func testCreateCollectionUnified() throws {
+        let tests = try retrieveSpecTestFiles(
+            specName: "collection-management",
+            asType: UnifiedTestFile.self
+        ).map { $0.1 }
+
+        let runner = try UnifiedTestRunner()
+        try runner.runFiles(tests)
+    }
+
     func testListCollections() throws {
         let client = try MongoClient.makeTestClient()
         let monitor = client.addCommandMonitor()

Tests/MongoSwiftSyncTests/UnifiedTestRunner/HasListableProperties.swift

@@ -24,3 +24,4 @@ extension UpdateOptions: HasListableProperties {}
 extension ReplaceOneModelOptions: HasListableProperties {}
 extension ChangeStreamOptions: HasListableProperties {}
 extension ListCollectionsOptions: HasListableProperties {}
+extension CreateCollectionOptions: HasListableProperties {}

Tests/MongoSwiftSyncTests/UnifiedTestRunner/UnifiedDatabaseOperations.swift

@@ -7,14 +7,30 @@ struct UnifiedCreateCollection: UnifiedOperationProtocol {
     /// Optional identifier for a session entity to use.
     let session: String?
 
+    let options: CreateCollectionOptions
+
+    enum CodingKeys: String, CodingKey, CaseIterable {
+        case collection, session
+    }
+
+    init(from decoder: Decoder) throws {
+        self.options = try decoder.singleValueContainer().decode(CreateCollectionOptions.self)
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.collection = try container.decode(String.self, forKey: .collection)
+        self.session = try container.decodeIfPresent(String.self, forKey: .session)
+    }
+
     static var knownArguments: Set<String> {
-        ["collection", "session"]
+        Set(
+            CodingKeys.allCases.map { $0.rawValue } +
+                CreateCollectionOptions().propertyNames
+        )
     }
 
     func execute(on object: UnifiedOperation.Object, context: Context) throws -> UnifiedOperationResult {
         let db = try context.entities.getEntity(from: object).asDatabase()
         let session = try context.entities.resolveSession(id: self.session)
-        _ = try db.createCollection(self.collection, session: session)
+        _ = try db.createCollection(self.collection, options: self.options, session: session)
         return .none
     }
 }

Tests/Specs/collection-management/tests/README.rst

@@ -0,0 +1,7 @@
+===========================
+Collection Management Tests
+===========================
+
+This directory contains tests for collection management. They are implemented
+in the `Unified Test Format <../../unified-test-format/unified-test-format.rst>`__
+and require schema version 1.0.