Update LocalStore tests.

Author: ehsannas

packages/firestore/test/unit/local/local_store.test.ts

@@ -241,24 +241,19 @@ class LocalStoreTester {
 
   afterAcknowledgingMutation(options: {
     documentVersion: TestSnapshotVersion;
-    transformResult?: api.Value;
+    transformResults?: api.Value[];
   }): LocalStoreTester {
     this.prepareNextStep();
 
     this.promiseChain = this.promiseChain
       .then(() => {
         const batch = this.batches.shift()!;
-        expect(batch.mutations.length).to.equal(
-          1,
-          'Acknowledging more than one mutation not supported.'
-        );
         const ver = version(options.documentVersion);
-        const mutationResults = [
-          new MutationResult(
-            ver,
-            options.transformResult ? [options.transformResult] : []
-          )
-        ];
+        const mutationResults = options.transformResults
+          ? options.transformResults.map(
+              value => new MutationResult(ver, [value])
+            )
+          : [new MutationResult(ver, [])];
         const write = MutationBatchResult.from(batch, ver, mutationResults);
 
         return localStoreAcknowledgeBatch(this.localStore, write);
@@ -801,7 +796,7 @@ function genericLocalStoreTests(
     return expectLocalStore()
       .after(deleteMutation('foo/bar'))
       .toReturnRemoved('foo/bar')
-      .toContain(deletedDoc('foo/bar', 0))
+      .toContain(deletedDoc('foo/bar', 0).setHasLocalMutations())
       .afterAcknowledgingMutation({ documentVersion: 1 })
       .toReturnRemoved('foo/bar')
       .toNotContainIfEager(deletedDoc('foo/bar', 1).setHasCommittedMutations())
@@ -819,7 +814,7 @@ function genericLocalStoreTests(
         .toContain(doc('foo/bar', 1, { it: 'base' }))
         .after(deleteMutation('foo/bar'))
         .toReturnRemoved('foo/bar')
-        .toContain(deletedDoc('foo/bar', 0))
+        .toContain(deletedDoc('foo/bar', 0).setHasLocalMutations())
         // remove the mutation so only the mutation is pinning the doc
         .afterReleasingTarget(2)
         .afterAcknowledgingMutation({ documentVersion: 2 })
@@ -839,10 +834,10 @@ function genericLocalStoreTests(
         .toReturnTargetId(2)
         .after(deleteMutation('foo/bar'))
         .toReturnRemoved('foo/bar')
-        .toContain(deletedDoc('foo/bar', 0))
+        .toContain(deletedDoc('foo/bar', 0).setHasLocalMutations())
         .after(docUpdateRemoteEvent(doc('foo/bar', 1, { it: 'base' }), [2]))
         .toReturnRemoved('foo/bar')
-        .toContain(deletedDoc('foo/bar', 0))
+        .toContain(deletedDoc('foo/bar', 0).setHasLocalMutations())
         // Don't need to keep doc pinned anymore
         .afterReleasingTarget(2)
         .afterAcknowledgingMutation({ documentVersion: 2 })
@@ -948,10 +943,10 @@ function genericLocalStoreTests(
     return expectLocalStore()
       .after(deleteMutation('foo/bar'))
       .toReturnRemoved('foo/bar')
-      .toContain(deletedDoc('foo/bar', 0))
+      .toContain(deletedDoc('foo/bar', 0).setHasLocalMutations())
       .after(patchMutation('foo/bar', { foo: 'bar' }))
       .toReturnRemoved('foo/bar')
-      .toContain(deletedDoc('foo/bar', 0))
+      .toContain(deletedDoc('foo/bar', 0).setHasLocalMutations())
       .afterAcknowledgingMutation({ documentVersion: 2 }) // delete mutation
       .toReturnRemoved('foo/bar')
       .toContain(deletedDoc('foo/bar', 2).setHasCommittedMutations())
@@ -1007,15 +1002,15 @@ function genericLocalStoreTests(
           .after(deleteMutation('foo/baz'))
           .toContain(doc('foo/bar', 1, { foo: 'bar' }).setHasLocalMutations())
           .toContain(doc('foo/bah', 0, { foo: 'bah' }).setHasLocalMutations())
-          .toContain(deletedDoc('foo/baz', 0))
+          .toContain(deletedDoc('foo/baz', 0).setHasLocalMutations())
           .afterAcknowledgingMutation({ documentVersion: 3 })
           .toNotContain('foo/bar')
           .toContain(doc('foo/bah', 0, { foo: 'bah' }).setHasLocalMutations())
-          .toContain(deletedDoc('foo/baz', 0))
+          .toContain(deletedDoc('foo/baz', 0).setHasLocalMutations())
           .afterAcknowledgingMutation({ documentVersion: 4 })
           .toNotContain('foo/bar')
           .toNotContain('foo/bah')
-          .toContain(deletedDoc('foo/baz', 0))
+          .toContain(deletedDoc('foo/baz', 0).setHasLocalMutations())
           .afterAcknowledgingMutation({ documentVersion: 5 })
           .toNotContain('foo/bar')
           .toNotContain('foo/bah')
@@ -1041,15 +1036,15 @@ function genericLocalStoreTests(
         .after(deleteMutation('foo/baz'))
         .toContain(doc('foo/bar', 1, { foo: 'bar' }).setHasLocalMutations())
         .toContain(doc('foo/bah', 0, { foo: 'bah' }).setHasLocalMutations())
-        .toContain(deletedDoc('foo/baz', 0))
+        .toContain(deletedDoc('foo/baz', 0).setHasLocalMutations())
         .afterRejectingMutation() // patch mutation
         .toNotContain('foo/bar')
         .toContain(doc('foo/bah', 0, { foo: 'bah' }).setHasLocalMutations())
-        .toContain(deletedDoc('foo/baz', 0))
+        .toContain(deletedDoc('foo/baz', 0).setHasLocalMutations())
         .afterRejectingMutation() // set mutation
         .toNotContain('foo/bar')
         .toNotContain('foo/bah')
-        .toContain(deletedDoc('foo/baz', 0))
+        .toContain(deletedDoc('foo/baz', 0).setHasLocalMutations())
         .afterRejectingMutation() // delete mutation
         .toNotContain('foo/bar')
         .toNotContain('foo/bah')
@@ -1181,36 +1176,40 @@ function genericLocalStoreTests(
     const firstQuery = query('foo');
     const secondQuery = query('foo', filter('matches', '==', true));
 
-    return expectLocalStore()
-      .afterAllocatingQuery(firstQuery)
-      .toReturnTargetId(2)
-      .after(
-        docAddedRemoteEvent(
-          [
-            doc('foo/bar', 10, { matches: true }),
-            doc('foo/baz', 20, { matches: true })
-          ],
-          [2]
+    return (
+      expectLocalStore()
+        .afterAllocatingQuery(firstQuery)
+        .toReturnTargetId(2)
+        .after(
+          docAddedRemoteEvent(
+            [
+              doc('foo/bar', 10, { matches: true }),
+              doc('foo/baz', 20, { matches: true })
+            ],
+            [2]
+          )
         )
-      )
-      .toReturnChanged(
-        doc('foo/bar', 10, { matches: true }),
-        doc('foo/baz', 20, { matches: true })
-      )
-      .after(setMutation('foo/bonk', { matches: true }))
-      .toReturnChanged(
-        doc('foo/bonk', 0, { matches: true }).setHasLocalMutations()
-      )
-      .afterAllocatingQuery(secondQuery)
-      .toReturnTargetId(4)
-      .afterExecutingQuery(secondQuery)
-      .toReturnChanged(
-        doc('foo/bar', 10, { matches: true }),
-        doc('foo/baz', 20, { matches: true }),
-        doc('foo/bonk', 0, { matches: true }).setHasLocalMutations()
-      )
-      .toHaveRead({ documentsByCollection: 2, mutationsByCollection: 1 })
-      .finish();
+        .toReturnChanged(
+          doc('foo/bar', 10, { matches: true }),
+          doc('foo/baz', 20, { matches: true })
+        )
+        .after(setMutation('foo/bonk', { matches: true }))
+        .toReturnChanged(
+          doc('foo/bonk', 0, { matches: true }).setHasLocalMutations()
+        )
+        .afterAllocatingQuery(secondQuery)
+        .toReturnTargetId(4)
+        .afterExecutingQuery(secondQuery)
+        .toReturnChanged(
+          doc('foo/bar', 10, { matches: true }),
+          doc('foo/baz', 20, { matches: true }),
+          doc('foo/bonk', 0, { matches: true }).setHasLocalMutations()
+        )
+        // TODO(overlays): implement overlaysReadByKey and overlaysReadByCollection
+        // No mutations are read because only overlay is needed.
+        .toHaveRead({ documentsByCollection: 2, mutationsByCollection: 0 })
+        .finish()
+    );
   });
 
   // eslint-disable-next-line no-restricted-properties
@@ -1340,7 +1339,7 @@ function genericLocalStoreTests(
         .toContain(doc('foo/bar', 1, { sum: 1 }).setHasLocalMutations())
         .afterAcknowledgingMutation({
           documentVersion: 2,
-          transformResult: { integerValue: 1 }
+          transformResults: [{ integerValue: 1 }]
         })
         .toReturnChanged(
           doc('foo/bar', 2, { sum: 1 }).setHasCommittedMutations()
@@ -1385,13 +1384,13 @@ function genericLocalStoreTests(
         .toContain(doc('foo/bar', 2, { sum: 3 }).setHasLocalMutations())
         .afterAcknowledgingMutation({
           documentVersion: 3,
-          transformResult: { integerValue: 1 }
+          transformResults: [{ integerValue: 1 }]
         })
         .toReturnChanged(doc('foo/bar', 3, { sum: 3 }).setHasLocalMutations())
         .toContain(doc('foo/bar', 3, { sum: 3 }).setHasLocalMutations())
         .afterAcknowledgingMutation({
           documentVersion: 4,
-          transformResult: { integerValue: 1339 }
+          transformResults: [{ integerValue: 1339 }]
         })
         .toReturnChanged(
           doc('foo/bar', 4, { sum: 1339 }).setHasCommittedMutations()
@@ -1452,9 +1451,28 @@ function genericLocalStoreTests(
         .toReturnChanged(
           doc('foo/bar', 2, {
             sum: 1,
-            arrayUnion: ['bar', 'foo']
+            arrayUnion: ['foo']
           }).setHasLocalMutations()
         )
+        .afterAcknowledgingMutation({
+          documentVersion: 3,
+          transformResults: [
+            { integerValue: 1338 },
+            {
+              arrayValue: {
+                values: [{ stringValue: 'bar' }, { stringValue: 'foo' }]
+              }
+            }
+          ]
+        })
+        .toReturnChanged(
+          doc('foo/bar', 3, {
+            sum: 1338,
+            arrayUnion: ['bar', 'foo']
+          })
+            .setReadTime(SnapshotVersion.fromTimestamp(new Timestamp(0, 3000)))
+            .setHasCommittedMutations()
+        )
         .finish()
     );
   });