Rename sync -> consistent

Author: schmidt-sebastian

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

@@ -80,7 +80,7 @@ public void onViewSnapshot(ViewSnapshot newSnapshot) {
               documentChanges,
               newSnapshot.isFromCache(),
               newSnapshot.getMutatedKeys(),
-              newSnapshot.isSynced(),
+              newSnapshot.isConsistentWithBackend(),
               newSnapshot.didSyncStateChange(),
               /* excludesMetadataChanges= */ true);
     }
@@ -159,7 +159,7 @@ private void raiseInitialEvent(ViewSnapshot snapshot) {
             snapshot.getDocuments(),
             snapshot.getMutatedKeys(),
             snapshot.isFromCache(),
-            snapshot.isSynced(),
+            snapshot.isConsistentWithBackend(),
             snapshot.excludesMetadataChanges());
     raisedInitialEvent = true;
     listener.onEvent(snapshot, null);

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

@@ -296,7 +296,8 @@ public ViewChange applyChanges(DocumentChanges docChanges, TargetChange targetCh
         });
     applyTargetChange(targetChange);
     List<LimboDocumentChange> limboDocumentChanges = updateLimboDocuments();
-    boolean synced = limboDocuments.size() == 0 && current;
+    boolean consistentWithBackend = limboDocuments.size() == 0;
+    boolean synced = consistentWithBackend && current;
     SyncState newSyncState = synced ? SyncState.SYNCED : SyncState.LOCAL;
     boolean syncStatedChanged = newSyncState != syncState;
     syncState = newSyncState;
@@ -311,7 +312,7 @@ public ViewChange applyChanges(DocumentChanges docChanges, TargetChange targetCh
               viewChanges,
               fromCache,
               docChanges.mutatedKeys,
-              synced,
+              consistentWithBackend,
               syncStatedChanged,
               /* excludesMetadataChanges= */ false);
     }

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

@@ -37,7 +37,7 @@ public enum SyncState {
   private final List<DocumentViewChange> changes;
   private final boolean isFromCache;
   private final ImmutableSortedSet<DocumentKey> mutatedKeys;
-  private final boolean synced;
+  private final boolean consistentWithBackend;
   private final boolean didSyncStateChange;
   private boolean excludesMetadataChanges;
 
@@ -48,7 +48,7 @@ public ViewSnapshot(
       List<DocumentViewChange> changes,
       boolean isFromCache,
       ImmutableSortedSet<DocumentKey> mutatedKeys,
-      boolean synced,
+      boolean consistentWithBackend,
       boolean didSyncStateChange,
       boolean excludesMetadataChanges) {
     this.query = query;
@@ -57,7 +57,7 @@ public ViewSnapshot(
     this.changes = changes;
     this.isFromCache = isFromCache;
     this.mutatedKeys = mutatedKeys;
-    this.synced = synced;
+    this.consistentWithBackend = consistentWithBackend;
     this.didSyncStateChange = didSyncStateChange;
     this.excludesMetadataChanges = excludesMetadataChanges;
   }
@@ -68,7 +68,7 @@ public static ViewSnapshot fromInitialDocuments(
       DocumentSet documents,
       ImmutableSortedSet<DocumentKey> mutatedKeys,
       boolean fromCache,
-      boolean synced,
+      boolean consistentWithBackend,
       boolean excludesMetadataChanges) {
     List<DocumentViewChange> viewChanges = new ArrayList<>();
     for (Document doc : documents) {
@@ -81,7 +81,7 @@ public static ViewSnapshot fromInitialDocuments(
         viewChanges,
         fromCache,
         mutatedKeys,
-        synced,
+        consistentWithBackend,
         /* didSyncStateChange= */ true,
         excludesMetadataChanges);
   }
@@ -91,11 +91,11 @@ public Query getQuery() {
   }
 
   /**
-   * Returns whether the view was synced with the backend at the time the snapshot was raised. A
-   * synced view is marked CURRENT and contains no Limbo documents.
+   * Returns whether the documents in the view matched the backend's result set at the time the
+   * snapshot was raised. A synced view contains no Limbo documents.
    */
-  public boolean isSynced() {
-    return synced;
+  public boolean isConsistentWithBackend() {
+    return consistentWithBackend;
   }
 
   public DocumentSet getDocuments() {
@@ -144,7 +144,7 @@ public final boolean equals(Object o) {
     if (isFromCache != that.isFromCache) {
       return false;
     }
-    if (synced != that.synced) {
+    if (consistentWithBackend != that.consistentWithBackend) {
       return false;
     }
     if (didSyncStateChange != that.didSyncStateChange) {
@@ -176,7 +176,7 @@ public int hashCode() {
     result = 31 * result + changes.hashCode();
     result = 31 * result + mutatedKeys.hashCode();
     result = 31 * result + (isFromCache ? 1 : 0);
-    result = 31 * result + (synced ? 1 : 0);
+    result = 31 * result + (consistentWithBackend ? 1 : 0);
     result = 31 * result + (didSyncStateChange ? 1 : 0);
     result = 31 * result + (excludesMetadataChanges ? 1 : 0);
     return result;
@@ -196,8 +196,8 @@ public String toString() {
         + isFromCache
         + ", mutatedKeys="
         + mutatedKeys.size()
-        + ", synced="
-        + synced
+        + ", consistentWithBackend="
+        + consistentWithBackend
         + ", didSyncStateChange="
         + didSyncStateChange
         + ", excludesMetadataChanges="

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

@@ -205,7 +205,7 @@ com.google.firebase.firestore.proto.Target encodeQueryData(QueryData queryData)
     result
         .setTargetId(queryData.getTargetId())
         .setLastListenSequenceNumber(queryData.getSequenceNumber())
-        .setSynced(queryData.isSynced())
+        .setConsistent(queryData.isConsistentWithLocalViews())
         .setSnapshotVersion(rpcSerializer.encodeVersion(queryData.getSnapshotVersion()))
         .setResumeToken(queryData.getResumeToken());
 
@@ -224,7 +224,7 @@ QueryData decodeQueryData(com.google.firebase.firestore.proto.Target target) {
     SnapshotVersion version = rpcSerializer.decodeVersion(target.getSnapshotVersion());
     ByteString resumeToken = target.getResumeToken();
     long sequenceNumber = target.getLastListenSequenceNumber();
-    boolean synced = target.getSynced();
+    boolean consistent = target.getConsistent();
 
     Query query;
     switch (target.getTargetTypeCase()) {
@@ -241,6 +241,6 @@ QueryData decodeQueryData(com.google.firebase.firestore.proto.Target target) {
     }
 
     return new QueryData(
-        query, targetId, sequenceNumber, synced, QueryPurpose.LISTEN, version, resumeToken);
+        query, targetId, sequenceNumber, consistent, QueryPurpose.LISTEN, version, resumeToken);
   }
 }

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

@@ -363,7 +363,7 @@ public ImmutableSortedMap<DocumentKey, MaybeDocument> applyRemoteEvent(RemoteEve
                       remoteEvent.getSnapshotVersion(),
                       resumeToken,
                       sequenceNumber,
-                      oldQueryData.isSynced());
+                      /* consistentWithLocalViews */ false);
               targetIds.put(boxedTargetId, queryData);
 
               if (shouldPersistQueryData(oldQueryData, queryData, change)) {
@@ -491,7 +491,7 @@ public void notifyLocalViewChanges(List<LocalViewChanges> viewChanges) {
                     queryData.getSnapshotVersion(),
                     queryData.getResumeToken(),
                     queryData.getSequenceNumber(),
-                    viewChange.isSynced());
+                    viewChange.isConsistentWithBackend());
             targetIds.put(targetId, updatedQueryData);
           }
         });
@@ -573,7 +573,8 @@ public void releaseQuery(Query query) {
             // conditions and rationale) we need to persist the token now because there will no
             // longer be an in-memory version to fall back on.
             needsUpdate = true;
-          } else if (cachedQueryData.isSynced() != queryData.isSynced()) {
+          } else if (cachedQueryData.isConsistentWithLocalViews()
+              != queryData.isConsistentWithLocalViews()) {
             needsUpdate = true;
           }
 
@@ -608,7 +609,7 @@ public void markNeedsRefill(int targetId) {
             queryData.getSnapshotVersion(),
             queryData.getResumeToken(),
             queryData.getSequenceNumber(),
-            /* synced= */ false);
+            /* consistentWithLocalViews= */ false);
     targetIds.put(targetId, updatedQueryData);
   }
 

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

@@ -49,22 +49,23 @@ public static LocalViewChanges fromViewSnapshot(int targetId, ViewSnapshot snaps
       }
     }
 
-    return new LocalViewChanges(targetId, snapshot.isSynced(), addedKeys, removedKeys);
+    return new LocalViewChanges(
+        targetId, snapshot.isConsistentWithBackend(), addedKeys, removedKeys);
   }
 
   private final int targetId;
-  private final boolean synced;
+  private final boolean consistentWithBackend;
 
   private final ImmutableSortedSet<DocumentKey> added;
   private final ImmutableSortedSet<DocumentKey> removed;
 
   public LocalViewChanges(
       int targetId,
-      boolean synced,
+      boolean consistentWithBackend,
       ImmutableSortedSet<DocumentKey> added,
       ImmutableSortedSet<DocumentKey> removed) {
     this.targetId = targetId;
-    this.synced = synced;
+    this.consistentWithBackend = consistentWithBackend;
     this.added = added;
     this.removed = removed;
   }
@@ -74,8 +75,8 @@ public int getTargetId() {
   }
 
   /** Returns whether the local query view is in sync with the backend. * */
-  public boolean isSynced() {
-    return synced;
+  public boolean isConsistentWithBackend() {
+    return consistentWithBackend;
   }
 
   public ImmutableSortedSet<DocumentKey> getAdded() {

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

@@ -140,7 +140,7 @@ public void removeTarget(QueryData queryData) {
             queryData.getSnapshotVersion(),
             queryData.getResumeToken(),
             getCurrentSequenceNumber(),
-            queryData.isSynced());
+            queryData.isConsistentWithLocalViews());
     persistence.getQueryCache().updateQueryData(updated);
   }
 

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

@@ -26,7 +26,7 @@ public final class QueryData {
   private final Query query;
   private final int targetId;
   private final long sequenceNumber;
-  private final boolean synced;
+  private final boolean consistentWithLocalViews;
   private final QueryPurpose purpose;
   private final SnapshotVersion snapshotVersion;
   private final ByteString resumeToken;
@@ -38,7 +38,8 @@ public final class QueryData {
    * @param targetId The target to which the query corresponds, assigned by the LocalStore for user
    *     queries or the SyncEngine for limbo queries.
    * @param sequenceNumber The sequence number, denoting the last time this query was used.
-   * @param synced Whether the query's local state is in sync with the backend.
+   * @param consistentWithLocalViews Whether the query's local result set is in consistent with the
+   *     backend's.
    * @param purpose The purpose of the query.
    * @param snapshotVersion The latest snapshot version seen for this target.
    * @param resumeToken An opaque, server-assigned token that allows watching a query to be resumed
@@ -50,14 +51,14 @@ public QueryData(
       Query query,
       int targetId,
       long sequenceNumber,
-      boolean synced,
+      boolean consistentWithLocalViews,
       QueryPurpose purpose,
       SnapshotVersion snapshotVersion,
       ByteString resumeToken) {
     this.query = checkNotNull(query);
     this.targetId = targetId;
     this.sequenceNumber = sequenceNumber;
-    this.synced = synced;
+    this.consistentWithLocalViews = consistentWithLocalViews;
     this.purpose = purpose;
     this.snapshotVersion = checkNotNull(snapshotVersion);
     this.resumeToken = checkNotNull(resumeToken);
@@ -69,7 +70,7 @@ public QueryData(Query query, int targetId, long sequenceNumber, QueryPurpose pu
         query,
         targetId,
         sequenceNumber,
-        /* synced= */ false,
+        /* consistentWithLocalViews= */ false,
         purpose,
         SnapshotVersion.NONE,
         WatchStream.EMPTY_RESUME_TOKEN);
@@ -99,9 +100,9 @@ public ByteString getResumeToken() {
     return resumeToken;
   }
 
-  /** Whether the query's local state is in sync with the backend. */
-  public boolean isSynced() {
-    return synced;
+  /** Whether the query's local result set is consistent with the backend. */
+  public boolean isConsistentWithLocalViews() {
+    return consistentWithLocalViews;
   }
 
   @Override
@@ -117,7 +118,7 @@ public boolean equals(Object o) {
     return query.equals(queryData.query)
         && targetId == queryData.targetId
         && sequenceNumber == queryData.sequenceNumber
-        && synced == queryData.synced
+        && consistentWithLocalViews == queryData.consistentWithLocalViews
         && purpose.equals(queryData.purpose)
         && snapshotVersion.equals(queryData.snapshotVersion)
         && resumeToken.equals(queryData.resumeToken);
@@ -128,7 +129,7 @@ public int hashCode() {
     int result = query.hashCode();
     result = 31 * result + targetId;
     result = 31 * result + (int) sequenceNumber;
-    result = 31 * result + (synced ? 1 : 0);
+    result = 31 * result + (consistentWithLocalViews ? 1 : 0);
     result = 31 * result + purpose.hashCode();
     result = 31 * result + snapshotVersion.hashCode();
     result = 31 * result + resumeToken.hashCode();
@@ -144,8 +145,8 @@ public String toString() {
         + targetId
         + ", sequenceNumber="
         + sequenceNumber
-        + ", isSynced="
-        + synced
+        + ", consistentWithLocalViews="
+        + consistentWithLocalViews
         + ", purpose="
         + purpose
         + ", snapshotVersion="
@@ -163,8 +164,14 @@ public QueryData copy(
       SnapshotVersion snapshotVersion,
       ByteString resumeToken,
       long sequenceNumber,
-      boolean synced) {
+      boolean consistentWithLocalViews) {
     return new QueryData(
-        query, targetId, sequenceNumber, synced, purpose, snapshotVersion, resumeToken);
+        query,
+        targetId,
+        sequenceNumber,
+        consistentWithLocalViews,
+        purpose,
+        snapshotVersion,
+        resumeToken);
   }
 }

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

@@ -172,7 +172,7 @@ public void removeTarget(QueryData queryData) {
             queryData.getSnapshotVersion(),
             queryData.getResumeToken(),
             getCurrentSequenceNumber(),
-            queryData.isSynced());
+            queryData.isConsistentWithLocalViews());
     persistence.getQueryCache().updateQueryData(updated);
   }
 

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

@@ -509,7 +509,7 @@ private void raiseWatchSnapshot(SnapshotVersion snapshotVersion) {
                   snapshotVersion,
                   targetChange.getResumeToken(),
                   queryData.getSequenceNumber(),
-                  queryData.isSynced()));
+                  queryData.isConsistentWithLocalViews()));
         }
       }
     }
@@ -527,7 +527,7 @@ private void raiseWatchSnapshot(SnapshotVersion snapshotVersion) {
                 queryData.getSnapshotVersion(),
                 ByteString.EMPTY,
                 queryData.getSequenceNumber(),
-                queryData.isSynced()));
+                queryData.isConsistentWithLocalViews()));
 
         // Cause a hard reset by unwatching and rewatching immediately, but deliberately don't send
         // a resume token so that we get a full update.

firebase-firestore/src/proto/google/firebase/firestore/proto/target.proto

@@ -79,10 +79,11 @@ message Target {
     google.firestore.v1.Target.DocumentsTarget documents = 6;
   }
 
-  // Whether the locally cached query data and the query's document are in sync
-  // with the backend. A query is synced if we have received CURRENT, there are
-  // no Limbo documents and the query does not need to be refilled from cache.
-  bool synced = 7;
+  // Whether the set of locally cached query results is consistent with the
+  // backend's results. A query state is consistent if the corresponding views
+  // contain no Limbo documents and the query does not need to be refilled from
+  // cache.
+  bool consistent = 7;
 }
 
 // Global state tracked across all Targets, tracked separately to avoid the

firebase-firestore/src/roboUtil/java/com/google/firebase/firestore/TestUtil.java

@@ -129,7 +129,7 @@ public static QuerySnapshot querySnapshot(
             documentChanges,
             isFromCache,
             mutatedKeys,
-            /* synced= */ true,
+            /* consistentWithBackend= */ true,
             /* didSyncStateChange= */ true,
             /* excludesMetadataChanges= */ false);
     return new QuerySnapshot(query(path), viewSnapshot, FIRESTORE);