format

Author: milaGGL

packages/firestore/src/remote/bloom_filter.ts

@@ -75,6 +75,10 @@ export class BloomFilter {
     this.bitCountInInteger = Integer.fromNumber(this.bitCount);
   }
 
+  isEmpty(): boolean {
+    return this.bitCount === 0;
+  }
+
   // Calculate the ith hash value based on the hashed 64bit integers,
   // and calculate its corresponding bit index in the bitmap to be checked.
   private getBitIndex(num1: Integer, num2: Integer, hashIndex: number): number {

packages/firestore/src/remote/remote_event.ts

@@ -44,8 +44,9 @@ export class RemoteEvent {
      */
     readonly targetChanges: Map<TargetId, TargetChange>,
     /**
-     * A set of targets that is known to be inconsistent. Listens for these
-     * targets should be re-established without resume tokens.
+     * A map of targets that is known to be inconsistent, and the purpose for
+     * re-listening. Listens for these targets should be re-established without
+     * resume tokens.
      */
     readonly targetMismatches: SortedMap<TargetId, TargetPurpose>,
     /**

packages/firestore/src/remote/remote_store.ts

@@ -611,7 +611,10 @@ function raiseWatchSnapshot(
     // Mark the target we send as being on behalf of an existence filter
     // mismatch, but don't actually retain that in listenTargets. This ensures
     // that we flag the first re-listen this way without impacting future
-    // listens of this target (that might happen e.g. on reconnect).
+    // listens of this target (that might happen e.g. on reconnect). The target
+    // purpose will be `ExistenceFilterMismatchBloom` if there is a bloom filter
+    // but it yield false positive result, otherwise, it will be set to
+    // `ExistenceFilterMismatch`.
     const requestTargetData = new TargetData(
       targetData.target,
       targetId,

packages/firestore/src/remote/serializer.ts

@@ -1008,7 +1008,7 @@ export function toListenRequestLabels(
   serializer: JsonProtoSerializer,
   targetData: TargetData
 ): ProtoApiClientObjectMap<string> | null {
-  const value = toLabel(serializer, targetData.purpose);
+  const value = toLabel(targetData.purpose);
   if (value == null) {
     return null;
   } else {
@@ -1018,10 +1018,7 @@ export function toListenRequestLabels(
   }
 }
 
-export function toLabel(
-  serializer: JsonProtoSerializer,
-  purpose: TargetPurpose
-): string | null {
+export function toLabel(purpose: TargetPurpose): string | null {
   switch (purpose) {
     case TargetPurpose.Listen:
       return null;

packages/firestore/src/remote/watch_change.ts

@@ -285,7 +285,7 @@ export class WatchChangeAggregator {
   private pendingDocumentTargetMapping = documentTargetMap();
 
   /**
-   * A list of targets with existence filter mismatches. These targets are
+   * A map of targets with existence filter mismatches. These targets are
    * known to be inconsistent and their listens needs to be re-established by
    * RemoteStore.
    */
@@ -430,15 +430,16 @@ export class WatchChangeAggregator {
         if (currentSize !== expectedCount) {
           // Apply bloom filter to identify and mark removed documents.
           const status = this.applyBloomFilter(watchChange, currentSize);
+
           if (status !== BloomFilterApplicationStatus.Success) {
             // If bloom filter application fails, we reset the mapping and
             // trigger re-run of the query.
             this.resetTarget(targetId);
+
             const purpose: TargetPurpose =
               status === BloomFilterApplicationStatus.FalsePositive
                 ? TargetPurpose.ExistenceFilterMismatchBloom
                 : TargetPurpose.ExistenceFilterMismatch;
-
             this.pendingTargetResets = this.pendingTargetResets.insert(
               targetId,
               purpose
@@ -469,10 +470,6 @@ export class WatchChangeAggregator {
       hashCount = 0
     } = unchangedNames;
 
-    if (bitmap.length === 0) {
-      return BloomFilterApplicationStatus.Skipped;
-    }
-
     let normalizedBitmap: Uint8Array;
     try {
       normalizedBitmap = normalizeByteString(bitmap).toUint8Array();
@@ -502,6 +499,10 @@ export class WatchChangeAggregator {
       return BloomFilterApplicationStatus.Skipped;
     }
 
+    if (bloomFilter.isEmpty()) {
+      return BloomFilterApplicationStatus.Skipped;
+    }
+
     const removedDocumentCount = this.filterRemovedDocuments(
       watchChange.targetId,
       bloomFilter

packages/firestore/test/unit/remote/remote_event.test.ts

@@ -459,6 +459,9 @@ describe('RemoteEvent', () => {
     event = aggregator.createRemoteEvent(version(3));
     expect(event.documentUpdates.size).to.equal(0);
     expect(event.targetMismatches.size).to.equal(1);
+    expect(event.targetMismatches.get(1)).to.equal(
+      TargetPurpose.ExistenceFilterMismatch
+    );
     expect(event.targetChanges.size).to.equal(1);
 
     const expected = updateMapping(
@@ -499,6 +502,9 @@ describe('RemoteEvent', () => {
     const event = aggregator.createRemoteEvent(version(3));
     expect(event.documentUpdates.size).to.equal(1);
     expect(event.targetMismatches.size).to.equal(1);
+    expect(event.targetMismatches.get(1)).to.equal(
+      TargetPurpose.ExistenceFilterMismatch
+    );
     expect(event.targetChanges.get(1)!.current).to.be.false;
   });
 

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -1104,7 +1104,7 @@ abstract class TestRunner {
           "Actual listen request doesn't have a 'goog-listen-tags'"
         );
         expect(labels['goog-listen-tags']).to.equal(
-          toLabel(this.serializer, expected.targetPurpose)
+          toLabel(expected.targetPurpose)
         );
       }