Held Write Ack Removal Spec Tests (#2018)

Author: schmidt-sebastian

Firestore/Example/Tests/SpecTests/FSTSpecTests.mm

@@ -174,18 +174,19 @@ - (SnapshotVersion)parseVersion:(NSNumber *_Nullable)version {
   return testutil::Version(version.longLongValue);
 }
 
-- (FSTDocumentViewChange *)parseChange:(NSArray *)change ofType:(FSTDocumentViewChangeType)type {
-  BOOL hasMutations = NO;
-  for (NSUInteger i = 3; i < change.count; ++i) {
-    if ([change[i] isEqual:@"local"]) {
-      hasMutations = YES;
-    }
-  }
-  NSNumber *version = change[1];
-  XCTAssert([change[0] isKindOfClass:[NSString class]]);
-  FSTDocument *doc =
-      FSTTestDoc(util::MakeString((NSString *)change[0]), version.longLongValue, change[2],
-                 hasMutations ? FSTDocumentStateLocalMutations : FSTDocumentStateSynced);
+- (FSTDocumentViewChange *)parseChange:(NSDictionary *)jsonDoc
+                                ofType:(FSTDocumentViewChangeType)type {
+  NSNumber *version = jsonDoc[@"version"];
+  NSDictionary *options = jsonDoc[@"options"];
+  FSTDocumentState documentState = [options[@"hasLocalMutations"] isEqualToNumber:@YES]
+                                       ? FSTDocumentStateLocalMutations
+                                       : ([options[@"hasCommittedMutations"] isEqualToNumber:@YES]
+                                              ? FSTDocumentStateCommittedMutations
+                                              : FSTDocumentStateSynced);
+
+  XCTAssert([jsonDoc[@"key"] isKindOfClass:[NSString class]]);
+  FSTDocument *doc = FSTTestDoc(util::MakeString((NSString *)jsonDoc[@"key"]),
+                                version.longLongValue, jsonDoc[@"value"], documentState);
   return [FSTDocumentViewChange changeWithDocument:doc type:type];
 }
 
@@ -270,11 +271,12 @@ - (void)doWatchEntity:(NSDictionary *)watchEntity {
       [self doWatchEntity:watchSpec];
     }
   } else if (watchEntity[@"doc"]) {
-    NSArray *docSpec = watchEntity[@"doc"];
-    FSTDocumentKey *key = FSTTestDocKey(docSpec[0]);
-    FSTObjectValue *_Nullable value =
-        [docSpec[2] isKindOfClass:[NSNull class]] ? nil : FSTTestObjectValue(docSpec[2]);
-    SnapshotVersion version = [self parseVersion:docSpec[1]];
+    NSDictionary *docSpec = watchEntity[@"doc"];
+    FSTDocumentKey *key = FSTTestDocKey(docSpec[@"key"]);
+    FSTObjectValue *_Nullable value = [docSpec[@"value"] isKindOfClass:[NSNull class]]
+                                          ? nil
+                                          : FSTTestObjectValue(docSpec[@"value"]);
+    SnapshotVersion version = [self parseVersion:docSpec[@"version"]];
     FSTMaybeDocument *doc = value ? [FSTDocument documentWithData:value
                                                               key:key
                                                           version:std::move(version)
@@ -493,22 +495,22 @@ - (void)validateEvent:(FSTQueryEvent *)actual matches:(NSDictionary *)expected {
   } else {
     NSMutableArray *expectedChanges = [NSMutableArray array];
     NSMutableArray *removed = expected[@"removed"];
-    for (NSArray *changeSpec in removed) {
+    for (NSDictionary *changeSpec in removed) {
       [expectedChanges
           addObject:[self parseChange:changeSpec ofType:FSTDocumentViewChangeTypeRemoved]];
     }
     NSMutableArray *added = expected[@"added"];
-    for (NSArray *changeSpec in added) {
+    for (NSDictionary *changeSpec in added) {
       [expectedChanges
           addObject:[self parseChange:changeSpec ofType:FSTDocumentViewChangeTypeAdded]];
     }
     NSMutableArray *modified = expected[@"modified"];
-    for (NSArray *changeSpec in modified) {
+    for (NSDictionary *changeSpec in modified) {
       [expectedChanges
           addObject:[self parseChange:changeSpec ofType:FSTDocumentViewChangeTypeModified]];
     }
     NSMutableArray *metadata = expected[@"metadata"];
-    for (NSArray *changeSpec in metadata) {
+    for (NSDictionary *changeSpec in metadata) {
       [expectedChanges
           addObject:[self parseChange:changeSpec ofType:FSTDocumentViewChangeTypeMetadata]];
     }

Firestore/Example/Tests/SpecTests/json/collection_spec_test.json

@@ -38,13 +38,17 @@
       {
         "watchEntity": {
           "docs": [
-            [
-              "collection/key",
-              1000,
-              {
+            {
+              "key": "collection/key",
+              "version": 1000,
+              "value": {
                 "foo": "bar"
+              },
+              "options": {
+                "hasLocalMutations": false,
+                "hasCommittedMutations": false
               }
-            ]
+            }
           ],
           "targets": [
             2
@@ -61,7 +65,8 @@
       },
       {
         "watchSnapshot": {
-          "version": 1001
+          "version": 1001,
+          "targetIds": []
         },
         "expect": [
           {
@@ -71,13 +76,17 @@
               "orderBys": []
             },
             "added": [
-              [
-                "collection/key",
-                1000,
-                {
+              {
+                "key": "collection/key",
+                "version": 1000,
+                "value": {
                   "foo": "bar"
+                },
+                "options": {
+                  "hasLocalMutations": false,
+                  "hasCommittedMutations": false
                 }
-              ]
+              }
             ],
             "errorCode": 0,
             "fromCache": false,
@@ -133,14 +142,17 @@
               "orderBys": []
             },
             "added": [
-              [
-                "collection/key",
-                0,
-                {
+              {
+                "key": "collection/key",
+                "version": 0,
+                "value": {
                   "foo": "bar"
                 },
-                "local"
-              ]
+                "options": {
+                  "hasLocalMutations": true,
+                  "hasCommittedMutations": false
+                }
+              }
             ],
             "errorCode": 0,
             "fromCache": true,