initial code

Author: milaGGL

firebase-firestore/src/main/java/com/google/firebase/firestore/core/SyncEngine.java

@@ -428,7 +428,7 @@ public void handleRejectedListen(int targetId, Status error) {
           new RemoteEvent(
               SnapshotVersion.NONE,
               /* targetChanges= */ Collections.emptyMap(),
-              /* targetMismatches= */ Collections.emptySet(),
+              /* targetMismatches= */ Collections.emptyMap(),
               documentUpdates,
               limboDocuments);
       handleRemoteEvent(event);

firebase-firestore/src/main/java/com/google/firebase/firestore/local/LocalStore.java

@@ -425,7 +425,7 @@ public ImmutableSortedMap<DocumentKey, Document> applyRemoteEvent(RemoteEvent re
             targetCache.addMatchingKeys(change.getAddedDocuments(), targetId);
 
             TargetData newTargetData = oldTargetData.withSequenceNumber(sequenceNumber);
-            if (remoteEvent.getTargetMismatches().contains(targetId)) {
+            if (remoteEvent.getTargetMismatches().containsKey(targetId)) {
               newTargetData =
                   newTargetData
                       .withResumeToken(ByteString.EMPTY, SnapshotVersion.NONE)

firebase-firestore/src/main/java/com/google/firebase/firestore/local/QueryPurpose.java

@@ -22,6 +22,11 @@ public enum QueryPurpose {
   /** The query was used to refill a query after an existence filter mismatch. */
   EXISTENCE_FILTER_MISMATCH,
 
+  /**
+   * The query target was used if the query is the result of a false positive in the bloom filter.
+   */
+  EXISTENCE_FILTER_MISMATCH_BLOOM,
+
   /** The query was used to resolve a limbo document. */
   LIMBO_RESOLUTION,
 }

firebase-firestore/src/main/java/com/google/firebase/firestore/remote/RemoteEvent.java

@@ -14,6 +14,7 @@
 
 package com.google.firebase.firestore.remote;
 
+import com.google.firebase.firestore.local.QueryPurpose;
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.MutableDocument;
 import com.google.firebase.firestore.model.SnapshotVersion;
@@ -27,14 +28,14 @@
 public final class RemoteEvent {
   private final SnapshotVersion snapshotVersion;
   private final Map<Integer, TargetChange> targetChanges;
-  private final Set<Integer> targetMismatches;
+  private final Map<Integer, QueryPurpose> targetMismatches;
   private final Map<DocumentKey, MutableDocument> documentUpdates;
   private final Set<DocumentKey> resolvedLimboDocuments;
 
   public RemoteEvent(
       SnapshotVersion snapshotVersion,
       Map<Integer, TargetChange> targetChanges,
-      Set<Integer> targetMismatches,
+      Map<Integer, QueryPurpose> targetMismatches,
       Map<DocumentKey, MutableDocument> documentUpdates,
       Set<DocumentKey> resolvedLimboDocuments) {
     this.snapshotVersion = snapshotVersion;
@@ -55,10 +56,10 @@ public Map<Integer, TargetChange> getTargetChanges() {
   }
 
   /**
-   * Returns 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.
    */
-  public Set<Integer> getTargetMismatches() {
+  public Map<Integer, QueryPurpose> getTargetMismatches() {
     return targetMismatches;
   }
 

firebase-firestore/src/main/java/com/google/firebase/firestore/remote/RemoteSerializer.java

@@ -124,7 +124,8 @@ public SnapshotVersion decodeVersion(com.google.protobuf.Timestamp proto) {
   // Names and Keys
 
   /**
-   * Encodes the given document key as a fully qualified name. This includes the databaseId from the
+   * Encodes the given document key as a fully qualified name. This includes the
+   * databaseId from the
    * constructor and the key path.
    */
   public String encodeKey(DocumentKey key) {
@@ -149,8 +150,10 @@ private String encodeQueryPath(ResourcePath path) {
   private ResourcePath decodeQueryPath(String name) {
     ResourcePath resource = decodeResourceName(name);
     if (resource.length() == 4) {
-      // In v1beta1 queries for collections at the root did not have a trailing "/documents". In v1
-      // all resource paths contain "/documents". Preserve the ability to read the v1 form for
+      // In v1beta1 queries for collections at the root did not have a trailing
+      // "/documents". In v1
+      // all resource paths contain "/documents". Preserve the ability to read the v1
+      // form for
       // compatibility with queries persisted in the local query cache.
       return ResourcePath.EMPTY;
     } else {
@@ -167,8 +170,10 @@ private String encodeResourceName(DatabaseId databaseId, ResourcePath path) {
   }
 
   /**
-   * Decodes a fully qualified resource name into a resource path and validates that there is a
-   * project and database encoded in the path. There are no guarantees that a local path is also
+   * Decodes a fully qualified resource name into a resource path and validates
+   * that there is a
+   * project and database encoded in the path. There are no guarantees that a
+   * local path is also
    * encoded in this resource name.
    */
   private ResourcePath decodeResourceName(String encoded) {
@@ -178,15 +183,19 @@ private ResourcePath decodeResourceName(String encoded) {
     return resource;
   }
 
-  /** Creates the prefix for a fully qualified resource path, without a local path on the end. */
+  /**
+   * Creates the prefix for a fully qualified resource path, without a local path
+   * on the end.
+   */
   private static ResourcePath encodedDatabaseId(DatabaseId databaseId) {
     return ResourcePath.fromSegments(
         Arrays.asList(
             "projects", databaseId.getProjectId(), "databases", databaseId.getDatabaseId()));
   }
 
   /**
-   * Decodes a fully qualified resource name into a resource path and validates that there is a
+   * Decodes a fully qualified resource name into a resource path and validates
+   * that there is a
    * project and database encoded in the path along with a local path.
    */
   private static ResourcePath extractLocalPathFromResourceName(ResourcePath resourceName) {
@@ -197,7 +206,10 @@ private static ResourcePath extractLocalPathFromResourceName(ResourcePath resour
     return resourceName.popFirst(5);
   }
 
-  /** Validates that a path has a prefix that looks like a valid encoded databaseId. */
+  /**
+   * Validates that a path has a prefix that looks like a valid encoded
+   * databaseId.
+   */
   private static boolean isValidResourceName(ResourcePath path) {
     // Resource names have at least 4 components (project ID, database ID)
     // and commonly the (root) resource type, e.g. documents
@@ -219,8 +231,7 @@ public String databaseName() {
   // Documents
 
   public com.google.firestore.v1.Document encodeDocument(DocumentKey key, ObjectValue value) {
-    com.google.firestore.v1.Document.Builder builder =
-        com.google.firestore.v1.Document.newBuilder();
+    com.google.firestore.v1.Document.Builder builder = com.google.firestore.v1.Document.newBuilder();
     builder.setName(encodeKey(key));
     builder.putAllFields(value.getFieldsMap());
     return builder.build();
@@ -289,10 +300,9 @@ public com.google.firestore.v1.Write encodeMutation(Mutation mutation) {
   }
 
   public Mutation decodeMutation(com.google.firestore.v1.Write mutation) {
-    Precondition precondition =
-        mutation.hasCurrentDocument()
-            ? decodePrecondition(mutation.getCurrentDocument())
-            : Precondition.NONE;
+    Precondition precondition = mutation.hasCurrentDocument()
+        ? decodePrecondition(mutation.getCurrentDocument())
+        : Precondition.NONE;
 
     List<FieldTransform> fieldTransforms = new ArrayList<>();
     for (DocumentTransform.FieldTransform fieldTransform : mutation.getUpdateTransformsList()) {
@@ -329,8 +339,7 @@ public Mutation decodeMutation(com.google.firestore.v1.Write mutation) {
 
   private com.google.firestore.v1.Precondition encodePrecondition(Precondition precondition) {
     hardAssert(!precondition.isNone(), "Can't serialize an empty precondition");
-    com.google.firestore.v1.Precondition.Builder builder =
-        com.google.firestore.v1.Precondition.newBuilder();
+    com.google.firestore.v1.Precondition.Builder builder = com.google.firestore.v1.Precondition.newBuilder();
     if (precondition.getUpdateTime() != null) {
       return builder.setUpdateTime(encodeVersion(precondition.getUpdateTime())).build();
     } else if (precondition.getExists() != null) {
@@ -390,8 +399,7 @@ private DocumentTransform.FieldTransform encodeFieldTransform(FieldTransform fie
           .setRemoveAllFromArray(ArrayValue.newBuilder().addAllValues(remove.getElements()))
           .build();
     } else if (transform instanceof NumericIncrementTransformOperation) {
-      NumericIncrementTransformOperation incrementOperation =
-          (NumericIncrementTransformOperation) transform;
+      NumericIncrementTransformOperation incrementOperation = (NumericIncrementTransformOperation) transform;
       return DocumentTransform.FieldTransform.newBuilder()
           .setFieldPath(fieldTransform.getFieldPath().canonicalString())
           .setIncrement(incrementOperation.getOperand())
@@ -405,8 +413,7 @@ private FieldTransform decodeFieldTransform(DocumentTransform.FieldTransform fie
     switch (fieldTransform.getTransformTypeCase()) {
       case SET_TO_SERVER_VALUE:
         hardAssert(
-            fieldTransform.getSetToServerValue()
-                == DocumentTransform.FieldTransform.ServerValue.REQUEST_TIME,
+            fieldTransform.getSetToServerValue() == DocumentTransform.FieldTransform.ServerValue.REQUEST_TIME,
             "Unknown transform setToServerValue: %s",
             fieldTransform.getSetToServerValue());
         return new FieldTransform(
@@ -433,9 +440,12 @@ private FieldTransform decodeFieldTransform(DocumentTransform.FieldTransform fie
 
   public MutationResult decodeMutationResult(
       com.google.firestore.v1.WriteResult proto, SnapshotVersion commitVersion) {
-    // NOTE: Deletes don't have an updateTime but the commit timestamp from the containing
-    // CommitResponse or WriteResponse indicates essentially that the delete happened no later than
-    // that. For our purposes we don't care exactly when the delete happened so long as we can tell
+    // NOTE: Deletes don't have an updateTime but the commit timestamp from the
+    // containing
+    // CommitResponse or WriteResponse indicates essentially that the delete
+    // happened no later than
+    // that. For our purposes we don't care exactly when the delete happened so long
+    // as we can tell
     // when an update on the watch stream is at or later than that change.
     SnapshotVersion version = decodeVersion(proto.getUpdateTime());
     if (SnapshotVersion.NONE.equals(version)) {
@@ -454,7 +464,8 @@ public MutationResult decodeMutationResult(
 
   @Nullable
   public Map<String, String> encodeListenRequestLabels(TargetData targetData) {
-    @Nullable String value = encodeLabel(targetData.getPurpose());
+    @Nullable
+    String value = encodeLabel(targetData.getPurpose());
     if (value == null) {
       return null;
     }
@@ -471,6 +482,8 @@ private String encodeLabel(QueryPurpose purpose) {
         return null;
       case EXISTENCE_FILTER_MISMATCH:
         return "existence-filter-mismatch";
+      case EXISTENCE_FILTER_MISMATCH_BLOOM:
+        return "existence-filter-mismatch-bloom";
       case LIMBO_RESOLUTION:
         return "limbo-document";
       default:
@@ -492,7 +505,8 @@ public Target encodeTarget(TargetData targetData) {
 
     if (targetData.getResumeToken().isEmpty()
         && targetData.getSnapshotVersion().compareTo(SnapshotVersion.NONE) > 0) {
-      // TODO(wuandy): Consider removing above check because it is most likely true. Right now, many
+      // TODO(wuandy): Consider removing above check because it is most likely true.
+      // Right now, many
       // tests depend on this behaviour though (leaving min() out of serialization).
       builder.setReadTime(encodeTimestamp(targetData.getSnapshotVersion().getTimestamp()));
     } else {
@@ -649,11 +663,11 @@ private StructuredQuery.Filter encodeFilters(List<Filter> filters) {
   private List<Filter> decodeFilters(StructuredQuery.Filter proto) {
     Filter result = decodeFilter(proto);
 
-    // Instead of a singletonList containing AND(F1, F2, ...), we can return a list containing F1,
+    // Instead of a singletonList containing AND(F1, F2, ...), we can return a list
+    // containing F1,
     // F2, ... to stay consistent with the older SDK versions.
     if (result instanceof com.google.firebase.firestore.core.CompositeFilter) {
-      com.google.firebase.firestore.core.CompositeFilter compositeFilter =
-          (com.google.firebase.firestore.core.CompositeFilter) result;
+      com.google.firebase.firestore.core.CompositeFilter compositeFilter = (com.google.firebase.firestore.core.CompositeFilter) result;
       if (compositeFilter.isFlatConjunction()) {
         return compositeFilter.getFilters();
       }
@@ -911,9 +925,8 @@ public WatchChange decodeWatchChange(ListenResponse protoChange) {
           default:
             throw new IllegalArgumentException("Unknown target change type");
         }
-        watchChange =
-            new WatchTargetChange(
-                changeType, targetChange.getTargetIdsList(), targetChange.getResumeToken(), cause);
+        watchChange = new WatchTargetChange(
+            changeType, targetChange.getTargetIdsList(), targetChange.getResumeToken(), cause);
         break;
       case DOCUMENT_CHANGE:
         DocumentChange docChange = protoChange.getDocumentChange();
@@ -934,8 +947,7 @@ public WatchChange decodeWatchChange(ListenResponse protoChange) {
         // Note that version might be unset in which case we use SnapshotVersion.NONE
         version = decodeVersion(docDelete.getReadTime());
         MutableDocument doc = MutableDocument.newNoDocument(key, version);
-        watchChange =
-            new WatchChange.DocumentChange(Collections.emptyList(), removed, doc.getKey(), doc);
+        watchChange = new WatchChange.DocumentChange(Collections.emptyList(), removed, doc.getKey(), doc);
         break;
       case DOCUMENT_REMOVE:
         DocumentRemove docRemove = protoChange.getDocumentRemove();
@@ -945,8 +957,7 @@ public WatchChange decodeWatchChange(ListenResponse protoChange) {
         break;
       case FILTER:
         com.google.firestore.v1.ExistenceFilter protoFilter = protoChange.getFilter();
-        ExistenceFilter filter =
-            new ExistenceFilter(protoFilter.getCount(), protoFilter.getUnchangedNames());
+        ExistenceFilter filter = new ExistenceFilter(protoFilter.getCount(), protoFilter.getUnchangedNames());
         int targetId = protoFilter.getTargetId();
         watchChange = new ExistenceFilterWatchChange(targetId, filter);
         break;
@@ -959,8 +970,10 @@ public WatchChange decodeWatchChange(ListenResponse protoChange) {
   }
 
   public SnapshotVersion decodeVersionFromListenResponse(ListenResponse watchChange) {
-    // We have only reached a consistent snapshot for the entire stream if there is a read_time set
-    // and it applies to all targets (i.e. the list of targets is empty). The backend is guaranteed
+    // We have only reached a consistent snapshot for the entire stream if there is
+    // a read_time set
+    // and it applies to all targets (i.e. the list of targets is empty). The
+    // backend is guaranteed
     // to send such responses.
     if (watchChange.getResponseTypeCase() != ResponseTypeCase.TARGET_CHANGE) {
       return SnapshotVersion.NONE;

firebase-firestore/src/main/java/com/google/firebase/firestore/remote/RemoteStore.java

@@ -547,7 +547,10 @@ private void raiseWatchSnapshot(SnapshotVersion snapshotVersion) {
 
     // Re-establish listens for the targets that have been invalidated by existence filter
     // mismatches.
-    for (int targetId : remoteEvent.getTargetMismatches()) {
+    for (Map.Entry<Integer, QueryPurpose> entry : remoteEvent.getTargetMismatches().entrySet()) {
+
+      int targetId = entry.getKey();
+
       TargetData targetData = this.listenTargets.get(targetId);
       // A watched target might have been removed already.
       if (targetData != null) {
@@ -569,7 +572,7 @@ private void raiseWatchSnapshot(SnapshotVersion snapshotVersion) {
                 targetData.getTarget(),
                 targetId,
                 targetData.getSequenceNumber(),
-                QueryPurpose.EXISTENCE_FILTER_MISMATCH);
+                /*QueryPurpose=*/ entry.getValue());
         this.sendWatchRequest(requestTargetData);
       }
     }

firebase-firestore/src/main/java/com/google/firebase/firestore/remote/WatchChangeAggregator.java

@@ -75,10 +75,10 @@ public interface TargetMetadataProvider {
   private Map<DocumentKey, Set<Integer>> pendingDocumentTargetMapping = new HashMap<>();
 
   /**
-   * A list of targets with existence filter mismatches. These targets are known to be inconsistent
+   * 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.
    */
-  private Set<Integer> pendingTargetResets = new HashSet<>();
+  private Map<Integer, QueryPurpose> pendingTargetResets = new HashMap<>();
 
   /** The log tag to use for this class. */
   private static final String LOG_TAG = "WatchChangeAggregator";
@@ -214,7 +214,7 @@ public void handleExistenceFilter(ExistenceFilterWatchChange watchChange) {
             // If bloom filter application fails, we reset the mapping and
             // trigger re-run of the query.
             resetTarget(targetId);
-            pendingTargetResets.add(targetId);
+            pendingTargetResets.put(targetId, QueryPurpose.EXISTENCE_FILTER_MISMATCH);
           }
         }
       }
@@ -341,14 +341,14 @@ public RemoteEvent createRemoteEvent(SnapshotVersion snapshotVersion) {
         new RemoteEvent(
             snapshotVersion,
             Collections.unmodifiableMap(targetChanges),
-            Collections.unmodifiableSet(pendingTargetResets),
+            Collections.unmodifiableMap(pendingTargetResets),
             Collections.unmodifiableMap(pendingDocumentUpdates),
             Collections.unmodifiableSet(resolvedLimboDocuments));
 
     // Re-initialize the current state to ensure that we do not modify the generated RemoteEvent.
     pendingDocumentUpdates = new HashMap<>();
     pendingDocumentTargetMapping = new HashMap<>();
-    pendingTargetResets = new HashSet<>();
+    pendingTargetResets = new HashMap<>();
 
     return remoteEvent;
   }