Merge

Author: schmidt-sebastian

firebase-firestore/src/main/java/com/google/firebase/firestore/bundle/BundleListener.java renamed to firebase-firestore/src/main/java/com/google/firebase/firestore/bundle/BundleCallback.java

@@ -19,8 +19,8 @@
 import com.google.firebase.firestore.model.DocumentKey;
 import com.google.firebase.firestore.model.MaybeDocument;
 
-/** Interface implemented by components that can apply changes from a bundle. */
-public interface BundleListener {
+/** Interface implemented by components that can apply changes from a bundle to local storage. */
+public interface BundleCallback {
   /**
    * Applies the documents from a bundle to the "ground-state" (remote) documents.
    *

firebase-firestore/src/main/java/com/google/firebase/firestore/bundle/BundleLoader.java

@@ -34,7 +34,7 @@
  * update while loading.
  */
 public class BundleLoader {
-  private final BundleListener bundleListener;
+  private final BundleCallback bundleCallback;
   private final BundleMetadata bundleMetadata;
   private final List<NamedQuery> queries;
   private final Map<DocumentKey, BundledDocumentMetadata> documentsMetadata;
@@ -43,8 +43,8 @@ public class BundleLoader {
   private long bytesLoaded;
   @Nullable private DocumentKey currentDocument;
 
-  public BundleLoader(BundleListener bundleListener, BundleMetadata bundleMetadata) {
-    this.bundleListener = bundleListener;
+  public BundleLoader(BundleCallback bundleCallback, BundleMetadata bundleMetadata) {
+    this.bundleCallback = bundleCallback;
     this.bundleMetadata = bundleMetadata;
     this.queries = new ArrayList<>();
     this.documents = emptyMaybeDocumentMap();
@@ -61,7 +61,7 @@ public BundleLoader(BundleListener bundleListener, BundleMetadata bundleMetadata
     Preconditions.checkArgument(
         !(bundleElement instanceof BundleMetadata), "Unexpected bundle metadata element.");
 
-    boolean updateProgress = false;
+    int beforeDocumentCount = documents.size();
 
     if (bundleElement instanceof NamedQuery) {
       queries.add((NamedQuery) bundleElement);
@@ -77,7 +77,6 @@ public BundleLoader(BundleListener bundleListener, BundleMetadata bundleMetadata
                     bundledDocumentMetadata.getKey(),
                     bundledDocumentMetadata.getReadTime(),
                     /* hasCommittedMutations= */ false));
-        updateProgress = true;
         currentDocument = null;
       }
     } else if (bundleElement instanceof BundleDocument) {
@@ -87,13 +86,12 @@ public BundleLoader(BundleListener bundleListener, BundleMetadata bundleMetadata
             "The document being added does not match the stored metadata.");
       }
       documents = documents.insert(bundleDocument.getKey(), bundleDocument.getDocument());
-      updateProgress = true;
       currentDocument = null;
     }
 
     bytesLoaded += byteSize;
 
-    return updateProgress
+    return beforeDocumentCount != documents.size()
         ? new LoadBundleTaskProgress(
             documents.size(),
             bundleMetadata.getTotalDocuments(),
@@ -117,14 +115,14 @@ public ImmutableSortedMap<DocumentKey, MaybeDocument> applyChanges() {
         documents.size());
 
     ImmutableSortedMap<DocumentKey, MaybeDocument> changes =
-        bundleListener.applyBundledDocuments(documents, bundleMetadata.getBundleId());
+        bundleCallback.applyBundledDocuments(documents, bundleMetadata.getBundleId());
 
     Map<String, ImmutableSortedSet<DocumentKey>> queryDocumentMap = getQueryDocumentMapping();
     for (NamedQuery namedQuery : queries) {
-      bundleListener.saveNamedQuery(namedQuery, queryDocumentMap.get(namedQuery.getName()));
+      bundleCallback.saveNamedQuery(namedQuery, queryDocumentMap.get(namedQuery.getName()));
     }
 
-    bundleListener.saveBundle(bundleMetadata);
+    bundleCallback.saveBundle(bundleMetadata);
 
     return changes;
   }

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

@@ -24,7 +24,7 @@
 import com.google.firebase.database.collection.ImmutableSortedMap;
 import com.google.firebase.database.collection.ImmutableSortedSet;
 import com.google.firebase.firestore.auth.User;
-import com.google.firebase.firestore.bundle.BundleListener;
+import com.google.firebase.firestore.bundle.BundleCallback;
 import com.google.firebase.firestore.bundle.BundleMetadata;
 import com.google.firebase.firestore.bundle.NamedQuery;
 import com.google.firebase.firestore.core.Query;
@@ -95,7 +95,7 @@
  * <p>The LocalStore must be able to efficiently execute queries against its local cache of the
  * documents, to provide the initial set of results before any remote changes have been received.
  */
-public final class LocalStore implements BundleListener {
+public final class LocalStore implements BundleCallback {
   /**
    * The maximum time to leave a resume token buffered without writing it out. This value is
    * arbitrary: it's long enough to avoid several writes (possibly indefinitely if updates come more

firebase-firestore/src/test/java/com/google/firebase/firestore/bundle/BundleLoaderTest.java

@@ -48,7 +48,7 @@
 public class BundleLoaderTest {
   private static final SnapshotVersion CREATE_TIME = new SnapshotVersion(Timestamp.now());
 
-  private final BundleListener bundleListener;
+  private final BundleCallback bundleCallback;
 
   private final Set<DocumentKey> lastDocuments;
   private final Map<String, ImmutableSortedSet<DocumentKey>> lastQueries;
@@ -59,8 +59,8 @@ public BundleLoaderTest() {
     lastQueries = new HashMap<>();
     lastBundles = new HashMap<>();
 
-    bundleListener =
-        new BundleListener() {
+    bundleCallback =
+        new BundleCallback() {
 
           @Override
           public ImmutableSortedMap<DocumentKey, MaybeDocument> applyBundledDocuments(
@@ -92,7 +92,7 @@ public void before() {
   @Test
   public void testLoadsDocuments() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 2));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 2));
 
     LoadBundleTaskProgress progress =
         bundleLoader.addElement(
@@ -130,7 +130,7 @@ public void testLoadsDocuments() {
   @Test
   public void testLoadsDeletedDocuments() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 1));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 1));
 
     LoadBundleTaskProgress progress =
         bundleLoader.addElement(
@@ -148,7 +148,7 @@ public void testLoadsDeletedDocuments() {
   @Test
   public void testAppliesDocumentChanges() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 1));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 1));
 
     bundleLoader.addElement(
         new BundledDocumentMetadata(
@@ -165,7 +165,7 @@ public void testAppliesDocumentChanges() {
   @Test
   public void testAppliesNamedQueries() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 2));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 2));
 
     bundleLoader.addElement(
         new BundledDocumentMetadata(
@@ -203,7 +203,7 @@ public void testAppliesNamedQueries() {
   @Test
   public void testVerifiesBundledDocumentMetadataSent() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 1));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 1));
 
     try {
       bundleLoader.addElement(new BundleDocument(doc("coll/doc1", 1, map())), /* byteSize= */ 10);
@@ -216,8 +216,7 @@ public void testVerifiesBundledDocumentMetadataSent() {
   @Test
   public void testVerifiesBundledDocumentMetadataMatches() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 1));
-
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 1));
     bundleLoader.addElement(
         new BundledDocumentMetadata(
             key("coll/doc1"), CREATE_TIME, /* exists= */ true, Collections.emptyList()),
@@ -234,7 +233,7 @@ public void testVerifiesBundledDocumentMetadataMatches() {
   @Test
   public void testVerifiesDocumentFollowsMetadata() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 0));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 0));
 
     bundleLoader.addElement(
         new BundledDocumentMetadata(
@@ -254,7 +253,7 @@ public void testVerifiesDocumentFollowsMetadata() {
   @Test
   public void testVerifiesDocumentCount() {
     BundleLoader bundleLoader =
-        new BundleLoader(bundleListener, createMetadata(/* documents= */ 2));
+        new BundleLoader(bundleCallback, createMetadata(/* documents= */ 2));
 
     bundleLoader.addElement(
         new BundledDocumentMetadata(