SWIFT-1553: Always report wallTime in the change stream event output (#762)

Author: rchhaya

Sources/MongoSwift/ChangeStreamEvent.swift

@@ -1,3 +1,6 @@
+import Foundation
+import SwiftBSON
+
 /// An `UpdateDescription` containing fields that will be present in the change stream document for
 /// operations of type `update`.
 public struct UpdateDescription: Codable {
@@ -115,6 +118,10 @@ public struct ChangeStreamEvent<T: Codable>: Codable {
     /// type`update`.
     public let updateDescription: UpdateDescription?
 
+    /// The wall time from the `mongod` that the change event originated from.
+    /// Only present for server versions 6.0 and above.
+    public let wallTime: Date?
+
     /**
      * Always present for operations of type `insert` and `replace`. Also present for operations of type `update` if
      * the user has specified `.updateLookup` for the `fullDocument` option in the `ChangeStreamOptions` used to create
@@ -129,7 +136,7 @@ public struct ChangeStreamEvent<T: Codable>: Codable {
     public let fullDocument: T?
 
     private enum CodingKeys: String, CodingKey {
-        case operationType, _id, ns, to, documentKey, updateDescription, fullDocument
+        case operationType, _id, ns, to, documentKey, updateDescription, wallTime, fullDocument
     }
 
     // Custom decode method to work around the fact that `invalidate` events do not have an `ns` field in the raw
@@ -156,6 +163,7 @@ public struct ChangeStreamEvent<T: Codable>: Codable {
         }
 
         self.documentKey = try container.decodeIfPresent(BSONDocument.self, forKey: .documentKey)
+        self.wallTime = try container.decodeIfPresent(Date.self, forKey: .wallTime)
         self.updateDescription = try container.decodeIfPresent(UpdateDescription.self, forKey: .updateDescription)
         self.fullDocument = try container.decodeIfPresent(T.self, forKey: .fullDocument)
     }

Tests/MongoSwiftSyncTests/UnifiedTestRunner/ExpectedEventsForClient.swift

@@ -18,8 +18,13 @@ struct ExpectedEventsForClient: Decodable {
     /// (excluding ignored events).
     let events: [ExpectedEvent]
 
+    /// Specifies how the `events` array is matched against observed events.  If false, observed events after all
+    /// specified events have matched MUST cause a test failure; if true, observed events after all specified events
+    /// have been matched MUST NOT cause a test failure. Defaults to false.
+    let ignoreExtraEvents: Bool
+
     enum CodingKeys: String, CodingKey {
-        case client, eventType, events
+        case client, eventType, events, ignoreExtraEvents
     }
 
     init(from decoder: Decoder) throws {
@@ -34,6 +39,7 @@ struct ExpectedEventsForClient: Decodable {
             // TODO: SWIFT-1321 actually parse these out.
             self.events = []
         }
+        self.ignoreExtraEvents = try container.decodeIfPresent(Bool.self, forKey: .ignoreExtraEvents) ?? false
     }
 }
 
@@ -77,8 +83,12 @@ enum ExpectedEvent: Decodable {
         /// Name of the database the command is run against.
         let databaseName: String?
 
-        /// Specifies whether the serviceId field of the event is set.
+        /// Specifies whether the `serviceId` field of the event is set.
         let hasServiceId: Bool?
+
+        /// Specifies whether the `serviceConnectionId` field of an event is set.
+        // TODO: SWIFT-1262: update unified test runner to use this value.
+        let hasServerConnectionId: Bool?
     }
 
     /// Represents expectations for a CommandSucceededEvent.
@@ -91,6 +101,10 @@ enum ExpectedEvent: Decodable {
 
         /// Specifies whether the serviceId field of the event is set.
         let hasServiceId: Bool?
+
+        /// Specifies whether the `serviceConnectionId` field of an event is set.
+        // TODO: SWIFT-1262: update unified test runner to use this value.
+        let hasServerConnectionId: Bool?
     }
 
     /// Represents expectations for a CommandStartedEvent.
@@ -100,5 +114,9 @@ enum ExpectedEvent: Decodable {
 
         /// Specifies whether the serviceId field of the event is set.
         let hasServiceId: Bool?
+
+        /// Specifies whether the `serviceConnectionId` field of an event is set.
+        // TODO: SWIFT-1262: update unified test runner to use this value.
+        let hasServerConnectionId: Bool?
     }
 }

Tests/MongoSwiftSyncTests/UnifiedTestRunner/Matching.swift

@@ -309,12 +309,18 @@ enum SpecialOperator {
 }
 
 /// Determines if the events in `actual` match the events in `expected`.
-func matchesEvents(expected: [ExpectedEvent], actual: [CommandEvent], context: Context) throws {
-    guard actual.count == expected.count else {
+func matchesEvents(
+    expected: [ExpectedEvent],
+    actual: [CommandEvent],
+    context: Context,
+    ignoreExtraEvents: Bool
+) throws {
+    // Ensure correct amount of events present (or more than enough if ignorable)
+    guard (actual.count == expected.count) || (ignoreExtraEvents && actual.count >= expected.count) else {
         throw NonMatchingError(expected: expected, actual: actual, context: context)
     }
 
-    for i in 0..<actual.count {
+    for i in 0..<expected.count {
         try context.withPushedElt(String(i)) {
             let expectedEvent = expected[i]
             let actualEvent = actual[i]

Tests/MongoSwiftSyncTests/UnifiedTestRunner/UnifiedTestRunner.swift

@@ -38,7 +38,7 @@ struct UnifiedTestRunner {
     let serverParameters: BSONDocument
 
     static let minSchemaVersion = SchemaVersion(rawValue: "1.0.0")!
-    static let maxSchemaVersion = SchemaVersion(rawValue: "1.5.0")!
+    static let maxSchemaVersion = SchemaVersion(rawValue: "1.7.0")!
 
     init() throws {
         switch MongoSwiftTestCase.topologyType {
@@ -219,7 +219,8 @@ struct UnifiedTestRunner {
                                 try matchesEvents(
                                     expected: expectedEventList.events,
                                     actual: actualEvents,
-                                    context: context
+                                    context: context,
+                                    ignoreExtraEvents: expectedEventList.ignoreExtraEvents
                                 )
                             }
                         }